Class SymmetricKey

This class serves as a base class for all serializable types. It facilitates composable serialization of complex types and enables the serialization of instances to their BCS (Binary Canonical Serialization) representation.

Hierarchy (View Summary)

Serializable
- SymmetricKey

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 SymmetricKey(key?: Uint8Array<ArrayBufferLike>): SymmetricKey
Parameters
- Optionalkey: Uint8Array<ArrayBufferLike>
Returns SymmetricKey
Overrides Serializable.constructor
- Defined in src/core/crypto/encryption/symmetric.ts:89

Methods

encrypt

encrypt(msg: Serializable): SymmetricCiphertext
Parameters
- msg: Serializable
Returns SymmetricCiphertext
- Defined in src/core/crypto/encryption/symmetric.ts:101

serialize

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

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): SymmetricKey
Parameters
- deserializer: Deserializer
Returns SymmetricKey
- Defined in src/core/crypto/encryption/symmetric.ts:114

Properties

key

key: Uint8Array