Class Identifier

Represents an Identifier that can be serialized and deserialized. This class is used to denote the module "name" in "ModuleId" and the "function name" in "EntryFunction".

Hierarchy (view full)

Serializable
- Identifier

Index

Constructors

Methods

bcsToBytes bcsToHex serialize toString toStringWithoutPrefix deserialize

Properties

Constructors

constructor

new Identifier(identifier): Identifier
Creates an instance of the class with a specified identifier.
Parameters
- identifier: string
  The unique identifier for the instance.
Returns Identifier
Overrides Serializable.constructor
- Defined in src/transactions/instances/identifier.ts:22

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 identifier of the current instance using the provided serializer.
Parameters
- serializer: Serializer
  The serializer instance used to perform the serialization.
Returns void
Overrides Serializable.serialize
- Defined in src/transactions/instances/identifier.ts:32

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): Identifier
Deserializes an identifier from the provided deserializer. This function is useful for reconstructing an Identifier object from a serialized format.
Parameters
- deserializer: Deserializer
  The deserializer instance used to read the serialized data.
Returns Identifier
- Defined in src/transactions/instances/identifier.ts:42

Properties

identifier

identifier: string