Class Serializable`Abstract`

This class serves as a base class for all serializable types. It facilitates composable serialization of complex types and enables the serialization of instances to their BCS (Binary Canonical Serialization) representation.

Index

Constructors

Methods

bcsToBytes bcsToHex serialize toString toStringWithoutPrefix

Constructors

constructor

new Serializable(): Serializable
Returns Serializable

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.
- 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.
- Defined in src/bcs/serializer.ts:40

`Abstract`serialize

serialize(serializer): void
Parameters
- serializer: Serializer
Returns void
- Defined in src/bcs/serializer.ts:22

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.
- 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.
- Defined in src/bcs/serializer.ts:49