Class TransactionInnerPayloadV1

Represents any transaction payload that can be submitted to the Aptos chain for execution.

This is specifically required for orderless transactions, but can be used for any transaction payload.

Hierarchy (view full)

TransactionInnerPayload
- TransactionInnerPayloadV1

Index

Implementation - BCS

bcsToBytes bcsToHex

Implementation - Transactions

serialize deserialize

Constructors

Methods

toString toStringWithoutPrefix load

Properties

executable extra_config

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

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

Implementation - Transactions

serialize

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

`Static`deserialize

deserialize(deserializer): TransactionInnerPayload
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 TransactionInnerPayload
Inherited from TransactionInnerPayload.deserialize
- Defined in src/transactions/instances/transactionPayload.ts:533

Constructors

constructor

new TransactionInnerPayloadV1(executable, extra_config): TransactionInnerPayloadV1
Parameters
- executable: TransactionExecutable
- extra_config: TransactionExtraConfig
Returns TransactionInnerPayloadV1
Overrides TransactionInnerPayload.constructor
- Defined in src/transactions/instances/transactionPayload.ts:549

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

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

`Static`load

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

Properties

executable

executable: TransactionExecutable

extra_config

extra_config: TransactionExtraConfig