Class ChainId

Represents a ChainId that can be serialized and deserialized.

Hierarchy (View Summary)

Serializable
- ChainId

Index

Implementation - BCS

bcsToBytes bcsToHex

Implementation - Transactions

constructor serialize deserialize

Methods

toString toStringWithoutPrefix

Properties

Implementation - BCS

bcsToBytes

bcsToBytes(): Uint8Array
Serializes a Serializable value to its BCS representation. This function is the TypeScript SDK equivalent of bcs::to_bytes in Move.

Returns Uint8Array
the BCS representation of the Serializable instance as a byte buffer.
Inherited from Serializable.bcsToBytes
- Defined in src/bcs/serializer.ts:45

bcsToHex

bcsToHex(): Hex
Converts the BCS-serialized bytes of a value into a Hex instance. This function provides a Hex representation of the BCS-serialized data for easier handling and manipulation.

Returns Hex
A Hex instance with the BCS-serialized bytes loaded into its underlying Uint8Array.
Inherited from Serializable.bcsToHex
- Defined in src/bcs/serializer.ts:58

Implementation - Transactions

constructor

new ChainId(chainId: number): ChainId
Initializes a new instance of the class with the specified chain ID.
Parameters
- chainId: number
  The ID of the blockchain network to be used.
Returns ChainId
Overrides Serializable.constructor
- Defined in src/transactions/instances/chainId.ts:24

serialize

serialize(serializer: Serializer): void
Serializes the current object using the provided serializer. This function helps in converting the object into a format suitable for transmission or storage.
Parameters
- serializer: Serializer
  The serializer instance used to perform the serialization.
Returns void
Overrides Serializable.serialize
- Defined in src/transactions/instances/chainId.ts:37

`Static`deserialize

deserialize(deserializer: Deserializer): ChainId
Deserializes a ChainId from the provided deserializer. This function allows you to reconstruct a ChainId object from serialized data.
Parameters
- deserializer: Deserializer
  The deserializer instance used to read the serialized data.
Returns ChainId
- Defined in src/transactions/instances/chainId.ts:49

Methods

toString

toString(): string
Returns the hex string representation of the Serializable value with the 0x prefix.

Returns string
the hex formatas a string prefixed by 0x.
Inherited from Serializable.toString
- Defined in src/bcs/serializer.ts:75

toStringWithoutPrefix

toStringWithoutPrefix(): string
Returns the hex string representation of the Serializable value without the 0x prefix.

Returns string
the hex format as a string without 0x prefix.
Inherited from Serializable.toStringWithoutPrefix
- Defined in src/bcs/serializer.ts:67

Properties

`Readonly`chainId

chainId: number