@aptos-labs/ts-sdk - v5.1.4
    Preparing search index...

    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 Summary)

    Index

    Implementation - BCS

    Implementation - Transactions

    Methods

    Properties

    Implementation - BCS

    • 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.

    • 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.

    Implementation - Transactions

    • 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

    • 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.

      Error if the provided moduleId is not in the correct format.

    Methods

    • Returns the hex string representation of the Serializable value with the 0x prefix.

      Returns string

      the hex formatas a string prefixed by 0x.

    Properties