Class TransactionPayloadEntryFunction

Represents a transaction payload entry function that can be serialized and deserialized.

Hierarchy (View Summary)

TransactionPayload
- TransactionPayloadEntryFunction

Index

Implementation - BCS

bcsToBytes bcsToHex

Implementation - Transactions

serialize deserialize

Constructors

Methods

toString toStringWithoutPrefix load

Properties

Implementation - BCS

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

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

Implementation - Transactions

serialize

serialize(serializer: Serializer): void
Serialize a Transaction Payload
Parameters
- serializer: Serializer
Returns void
Overrides TransactionPayload.serialize
- Defined in src/transactions/instances/transactionPayload.ts:180

`Static`deserialize

deserialize(deserializer: Deserializer): TransactionPayload
Deserializes a multisig transaction payload from the provided deserializer. This function enables the reconstruction of a MultiSigTransactionPayload object from its serialized form.
Parameters
- deserializer: Deserializer
  The deserializer instance used to read the serialized data.
Returns TransactionPayload
Inherited from TransactionPayload.deserialize
- Defined in src/transactions/instances/transactionPayload.ts:96

Constructors

constructor

new TransactionPayloadEntryFunction(
entryFunction: EntryFunction,
): TransactionPayloadEntryFunction
Parameters
- entryFunction: EntryFunction
Returns TransactionPayloadEntryFunction
Overrides TransactionPayload.constructor
- Defined in src/transactions/instances/transactionPayload.ts:175

Methods

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

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

`Static`load

load(deserializer: Deserializer): TransactionPayloadEntryFunction
Parameters
- deserializer: Deserializer
Returns TransactionPayloadEntryFunction
- Defined in src/transactions/instances/transactionPayload.ts:185

Properties

`Readonly`entryFunction

entryFunction: EntryFunction