Class Bool

Hierarchy

Serializable
- Bool

Implements

TransactionArgument

Index

Constructors

Properties

Methods

bcsToBytes bcsToHex serialize serializeForEntryFunction serializeForScriptFunction deserialize

Constructors

constructor

new Bool(value): Bool
Parameters
- value: boolean
Returns Bool
Overrides Serializable.constructor
- Defined in src/bcs/serializable/movePrimitives.ts:20

Properties

`Readonly` value

value: boolean

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
Implementation of TransactionArgument.bcsToBytes
Inherited from Serializable.bcsToBytes
- Defined in src/bcs/serializer.ts:27

bcsToHex

bcsToHex(): Hex
Helper function to get a value's BCS-serialized bytes as a Hex instance.

Returns Hex
a Hex instance with the BCS-serialized bytes loaded into its underlying Uint8Array
Implementation of TransactionArgument.bcsToHex
Inherited from Serializable.bcsToHex
- Defined in src/bcs/serializer.ts:37

serialize

serialize(serializer): void
Serialize an argument to BCS-serialized bytes.
Parameters
- serializer: Serializer
Returns void
Implementation of TransactionArgument.serialize
Overrides Serializable.serialize
- Defined in src/bcs/serializable/movePrimitives.ts:26

serializeForEntryFunction

serializeForEntryFunction(serializer): void
Serialize an argument as a type-agnostic, fixed byte sequence. The byte sequence contains the number of the following bytes followed by the BCS-serialized bytes for a typed argument.
Parameters
- serializer: Serializer
Returns void
Implementation of TransactionArgument.serializeForEntryFunction
- Defined in src/bcs/serializable/movePrimitives.ts:30

serializeForScriptFunction

serializeForScriptFunction(serializer): void
Serialize an argument to BCS-serialized bytes as a type aware byte sequence. The byte sequence contains an enum variant index followed by the BCS-serialized bytes for a typed argument.
Parameters
- serializer: Serializer
Returns void
Implementation of TransactionArgument.serializeForScriptFunction
- Defined in src/bcs/serializable/movePrimitives.ts:35

`Static` deserialize

deserialize(deserializer): Bool
Parameters
- deserializer: Deserializer
Returns Bool
- Defined in src/bcs/serializable/movePrimitives.ts:40

Generated using TypeDoc