Class TransactionPayloadEncryptedPayload

EncryptedPayload::Encrypted as a TransactionPayload. BCS: variant tag (5) | inner tag (0) | Ciphertext | TransactionExtraConfig | 32-byte payload_hash | u64 epoch | Option<ClaimedEntryFunction>.

Hierarchy (View Summary)

TransactionPayload
- TransactionPayloadEncryptedPayload

Index

Implementation - BCS

bcsToBytes bcsToHex

Implementation - Transactions

serialize deserialize

Constructors

Methods

toString toStringWithoutPrefix load

Properties

ciphertext claimedEntryFunction? encryptionEpoch extraConfig payloadHash

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

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:422

`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:123

Constructors

constructor

new TransactionPayloadEncryptedPayload(
    ciphertext: Ciphertext,
    extraConfig: TransactionExtraConfig,
    payloadHash: Uint8Array,
    encryptionEpoch: bigint,
    claimedEntryFunction?: ClaimedEntryFunction,
): TransactionPayloadEncryptedPayload
Parameters
- ciphertext: Ciphertext
- extraConfig: TransactionExtraConfig
- payloadHash: Uint8Array
- encryptionEpoch: bigint
- OptionalclaimedEntryFunction: ClaimedEntryFunction
Returns TransactionPayloadEncryptedPayload
Overrides TransactionPayload.constructor
- Defined in src/transactions/instances/transactionPayload.ts:404

Methods

toString

toString(): string
Returns the hex string representation of the Serializable value with the 0x prefix.

Returns string
the hex format as a string prefixed by 0x.
Inherited from TransactionPayload.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 TransactionPayload.toStringWithoutPrefix
- Defined in src/bcs/serializer.ts:67

`Static`load

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

Properties

`Readonly`ciphertext

ciphertext: Ciphertext

`Optional` `Readonly`claimedEntryFunction

claimedEntryFunction?: ClaimedEntryFunction

`Readonly`encryptionEpoch

encryptionEpoch: bigint

Epoch hint matching the node's per-epoch encryption key (see aptos-core EncryptedInner).

`Readonly`extraConfig

extraConfig: TransactionExtraConfig

`Readonly`payloadHash

payloadHash: Uint8Array