Class TransactionHash

Represents a transaction hash, which can either be associated with a Deploy or a TransactionV1.

Hierarchy

Hash
- TransactionHash

Index

Constructors

`Private` constructor

new TransactionHash(deploy?: Hash, transactionV1?: Hash): TransactionHash
Constructs a new TransactionHash instance, which can hold either a Deploy hash or a TransactionV1 hash.
Parameters
- Optional deploy: Hash
  
  The hash of the deploy transaction, if applicable.
- Optional transactionV1: Hash
  
  The hash of the version 1 transaction, if applicable.
Returns TransactionHash
Overrides Hash.constructor
- Defined in src/types/Transaction.ts:111

Properties

`Optional` deploy

deploy?: Hash

The hash associated with the deploy transaction, if applicable. This will contain the hash of the Deploy transaction.

`Optional` transactionV1

transactionV1?: Hash

The hash associated with the version 1 transaction, if applicable. This will contain the hash of the TransactionV1.

`Static` ByteHashLen

ByteHashLen: number = 32

The fixed length of the hash in bytes.

`Static` StringHashLen

StringHashLen: number = 64

The fixed length of the hash string representation in hexadecimal characters.

Methods

equals

equals(other: Hash): boolean
Checks if the current transaction hash is equal to another hash.

Returns
True if the hashes are equal, otherwise false.
Parameters
- other: Hash
  
  The hash to compare with.
Returns boolean
Overrides Hash.equals
- Defined in src/types/Transaction.ts:176

getHash

getHash(): undefined | Hash
Returns the hash (either deploy or transactionV1). This method is useful when you want to get the hash regardless of type.

Returns undefined | Hash
- Defined in src/types/Transaction.ts:143

toBytes

toBytes(): Uint8Array
Converts the TransactionHash to a byte array representation.

Returns
The byte array of the deploy or transactionV1 hash, or an empty byte array if neither is available.

Returns Uint8Array
Overrides Hash.toBytes
- Defined in src/types/Transaction.ts:159

toHex

toHex(): string
Converts the TransactionHash to a hexadecimal string representation.

Returns
The hexadecimal string of the deploy or transactionV1 hash, or an empty string if neither is available.

Returns string
Overrides Hash.toHex
- Defined in src/types/Transaction.ts:151

toJSON

toJSON(): string
Converts the TransactionHash to a JSON string (hex format).

Returns
The hexadecimal string representation of the hash.

Returns string
Overrides Hash.toJSON
- Defined in src/types/Transaction.ts:167

`Static` createHashArray

createHashArray(byteArray: Uint8Array): Hash[]
Creates an array of Hash instances from a byte array.

Returns
An array of Hash instances created from the byte array.

Throws
Error if the byte array length is not a multiple of the hash length.
Parameters
- byteArray: Uint8Array
  
  The byte array containing multiple hash values.
Returns Hash[]
Inherited from Hash.createHashArray
- Defined in src/types/key/Hash.ts:118

`Static` fromBuffer

fromBuffer(buffer: Buffer): Hash
Creates a Hash instance from a Buffer.

Returns
A new Hash instance.

Throws
Error if the buffer length is less than the required hash length.
Parameters
- buffer: Buffer
  
  The Buffer containing the hash bytes.
Returns Hash
Inherited from Hash.fromBuffer
- Defined in src/types/key/Hash.ts:105

`Static` fromBytes

fromBytes(source: Uint8Array): IResultWithBytes<Hash>
Creates a Hash instance from a byte array.

Returns
A result object containing the new Hash instance and the remaining bytes.

Throws
Error if the byte array length does not match the expected hash length.
Parameters
- source: Uint8Array
  
  The byte array representing the hash.
Returns IResultWithBytes<Hash>
Inherited from Hash.fromBytes
- Defined in src/types/key/Hash.ts:87

`Static` fromDeployHash

fromDeployHash(hash: Hash): TransactionHash
Creates a TransactionHash from a Deploy hash.

Returns
A new TransactionHash instance with the deploy hash.
Parameters
- hash: Hash
  
  The Deploy hash instance.
Returns TransactionHash
- Defined in src/types/Transaction.ts:127

`Static` fromHex

fromHex(source: string): Hash
Creates a Hash instance from a hexadecimal string.

Returns
A new Hash instance.

Throws
Error if the string length does not match the expected hash length.
Parameters
- source: string
  
  The hexadecimal string representation of the hash.
Returns Hash
Inherited from Hash.fromHex
- Defined in src/types/key/Hash.ts:38

`Static` fromJSON

fromJSON(json: string): Hash
Creates a Hash instance from its JSON representation.

Returns
A new Hash instance.
Parameters
- json: string
  
  The JSON string representation of the hash.
Returns Hash
Inherited from Hash.fromJSON
- Defined in src/types/key/Hash.ts:77

`Static` fromTransactionHash

fromTransactionHash(hash: Hash): TransactionHash
Creates a TransactionHash from a TransactionV1 hash.

Returns
A new TransactionHash instance with the transactionV1 hash.
Parameters
- hash: Hash
  
  The TransactionV1 hash instance.
Returns TransactionHash
- Defined in src/types/Transaction.ts:136

Class TransactionHash

Hierarchy

Index

Constructors

Properties

Methods

Constructors

Private constructor

Parameters

Optional deploy: Hash

Optional transactionV1: Hash

Returns TransactionHash

Properties

Optional deploy

Optional transactionV1

Static ByteHashLen

Static StringHashLen

Methods

equals

Returns

Parameters

other: Hash

Returns boolean

getHash

Returns undefined | Hash

toBytes

Returns

Returns Uint8Array

toHex

Returns

Returns string

toJSON

Returns

Returns string

Static createHashArray

Returns

Throws

Parameters

byteArray: Uint8Array

Returns Hash[]

Static fromBuffer

Returns

Throws

Parameters

buffer: Buffer

Returns Hash

Static fromBytes

Returns

Throws

Parameters

source: Uint8Array

Returns IResultWithBytes<Hash>

Static fromDeployHash

Returns

Parameters

hash: Hash

Returns TransactionHash

Static fromHex

Returns

Throws

Parameters

source: string

Returns Hash

Static fromJSON

Returns

Parameters

json: string

Returns Hash

Static fromTransactionHash

Returns

Parameters

hash: Hash

Returns TransactionHash

Settings

Member Visibility

Theme

`Private` constructor

`Optional` deploy: Hash

`Optional` transactionV1: Hash

`Optional` deploy

`Optional` transactionV1

`Static` ByteHashLen

`Static` StringHashLen

`Static` createHashArray

`Static` fromBuffer

`Static` fromBytes

`Static` fromDeployHash

`Static` fromHex

`Static` fromJSON

`Static` fromTransactionHash