Class EncryptionKey

Corresponds to the Rust type aptos_batch_encryption::shared::encryption_key::EncryptionKey.

Deserialize from hex (API) -> bytes -> BCS -> EncryptionKey.

Hierarchy (View Summary)

Serializable
- EncryptionKey

Index

Implementation - BCS

bcsToBytes bcsToHex

Constructors

Methods

encrypt serialize toString toStringWithoutPrefix deserialize

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

Constructors

constructor

new EncryptionKey(
sigMpkG2: WeierstrassPoint<Fp2>,
tauG2: WeierstrassPoint<Fp2>,
): EncryptionKey
Parameters
- sigMpkG2: WeierstrassPoint<Fp2>
- tauG2: WeierstrassPoint<Fp2>
Returns EncryptionKey
Overrides Serializable.constructor
- Defined in src/core/crypto/encryption/ciphertext.ts:131

Methods

encrypt

encrypt(plaintext: Serializable, associatedData: Serializable): Ciphertext
Encrypts a plaintext with associated data, producing a Ciphertext. Matches Rust: Id::from_verifying_key_and_ad(vk, associated_data) then CTEncrypt. The ciphertext Id must equal hash(vk || BCS(associated_data)) with ID_HASH_DST so the node can verify.
Parameters
- plaintext: Serializable
- associatedData: Serializable
Returns Ciphertext
- Defined in src/core/crypto/encryption/ciphertext.ts:183

serialize

serialize(serializer: Serializer): void
Parameters
- serializer: Serializer
Returns void
Overrides Serializable.serialize
- Defined in src/core/crypto/encryption/ciphertext.ts:137

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

`Static`deserialize

deserialize(deserializer: Deserializer): EncryptionKey
Parameters
- deserializer: Deserializer
Returns EncryptionKey
- Defined in src/core/crypto/encryption/ciphertext.ts:142

Properties

sigMpkG2

sigMpkG2: WeierstrassPoint<Fp2>

tauG2

tauG2: WeierstrassPoint<Fp2>