Class DecryptedPlaintext

BCS-serializable DecryptedPlaintext. Built client-side before encrypting; its BCS hash becomes payload_hash. Matches Rust: DecryptedPlaintext { executable, decryption_nonce: [u8; 16] }.

Hierarchy (View Summary)

Serializable
- DecryptedPlaintext

Index

Implementation - BCS

bcsToBytes bcsToHex

Constructors

Methods

hash serialize toString toStringWithoutPrefix deserialize

Properties

decryptionNonce executable

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 Serializable.bcsToBytes
- Defined in packages/ts-sdk/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 Serializable.bcsToHex
- Defined in packages/ts-sdk/src/bcs/serializer.ts:58

Constructors

constructor

new DecryptedPlaintext(
executable: TransactionExecutable,
decryptionNonce: Uint8Array,
): DecryptedPlaintext
Parameters
- executable: TransactionExecutable
- decryptionNonce: Uint8Array
Returns DecryptedPlaintext
Overrides Serializable.constructor
- Defined in packages/ts-sdk/src/transactions/instances/encryptedPayload.ts:65

Methods

hash

hash(): Uint8Array
Domain-separated BCS crypto hash (BCSCryptoHash in aptos-core): SHA3-256( SHA3-256("APTOS::DecryptedPlaintext") || BCS(self) ).

Returns Uint8Array
- Defined in packages/ts-sdk/src/transactions/instances/encryptedPayload.ts:89

serialize

serialize(serializer: Serializer): void
Parameters
- serializer: Serializer
Returns void
Overrides Serializable.serialize
- Defined in packages/ts-sdk/src/transactions/instances/encryptedPayload.ts:74

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 Serializable.toString
- Defined in packages/ts-sdk/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 Serializable.toStringWithoutPrefix
- Defined in packages/ts-sdk/src/bcs/serializer.ts:67

`Static`deserialize

deserialize(deserializer: Deserializer): DecryptedPlaintext
Parameters
- deserializer: Deserializer
Returns DecryptedPlaintext
- Defined in packages/ts-sdk/src/transactions/instances/encryptedPayload.ts:79

Properties

decryptionNonce

decryptionNonce: Uint8Array

executable

executable: TransactionExecutable