Class StructTag

Represents a structured tag that includes an address, module name, name, and type arguments. This class is used to define and manage structured data types within the SDK.

Hierarchy (view full)

Constructors

constructor

Methods

bcsToBytes bcsToHex serialize toString toStringWithoutPrefix deserialize

Properties

address moduleName name typeArgs

Constructors

constructor

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.

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.

serialize

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.

toStringWithoutPrefix

Staticdeserialize

Properties

Readonlyaddress

address: AccountAddress

The address associated with the struct tag.

ReadonlymoduleName

moduleName: Identifier

The name of the module that contains the struct.

Readonlyname

name: Identifier

The name of the struct.

ReadonlytypeArgs

typeArgs: TypeTag[]

An array of type arguments associated with the struct.

Settings

Member Visibility

On This Page

Constructors
Methods
Properties