Class ModuleId

Represents a ModuleId that can be serialized and deserialized. A ModuleId consists of a module address (e.g., "0x1") and a module name (e.g., "coin").

Hierarchy (view full)

Serializable
- ModuleId

Index

Constructors

Methods

bcsToBytes bcsToHex serialize toString toStringWithoutPrefix deserialize fromStr

Properties

Constructors

constructor

new ModuleId(address, name): ModuleId
Initializes a new instance of the module with the specified account address and name.
Parameters
- address: AccountAddress
  The account address, e.g., "0x1".
- name: Identifier
  The module name under the specified address, e.g., "coin".
Returns ModuleId
Overrides Serializable.constructor
- Defined in src/transactions/instances/moduleId.ts:25

Methods

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:29

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:40

serialize

serialize(serializer): void
Serializes the address and name properties using the provided serializer. This function is essential for converting the object's data 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/moduleId.ts:51

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:57

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:49

`Static`deserialize

deserialize(deserializer): ModuleId
Deserializes a ModuleId from the provided deserializer. This function retrieves the account address and identifier to construct a ModuleId instance.
Parameters
- deserializer: Deserializer
  The deserializer instance used to read the data.
Returns ModuleId
- Defined in src/transactions/instances/moduleId.ts:62

`Static`fromStr

fromStr(moduleId): ModuleId
Converts a string literal in the format "account_address::module_name" to a ModuleId.
Parameters
- moduleId: `${string}::${string}`
  A string literal representing the module identifier.
Returns ModuleId
ModuleId - The corresponding ModuleId object.

Throws
Error if the provided moduleId is not in the correct format.
- Defined in src/transactions/instances/moduleId.ts:37

Properties

`Readonly`address

address: AccountAddress

`Readonly`name

name: Identifier