Class X25519DeoxysII

A Cipher that derives a shared secret using X25519 and then uses DeoxysII for encrypting using that secret.

This is the default cipher.

Hierarchy (View Summary)

Cipher
- X25519DeoxysII

Index

Constructors

Properties

ephemeralKey epoch kind publicKey secretKey

Methods

decrypt decryptCall decryptResult encrypt encryptCall encryptResult ephemeral fromSecretKey

Constructors

constructor

new X25519DeoxysII(
    keypair: BoxKeyPair,
    peerPublicKey: Uint8Array,
    epoch?: number,
): X25519DeoxysII
Parameters
- keypair: BoxKeyPair
- peerPublicKey: Uint8Array
- Optionalepoch: number
Returns X25519DeoxysII
Overrides Cipher.constructor
- Defined in clients/js/src/cipher.ts:242

Properties

`Readonly`ephemeralKey

ephemeralKey: Uint8Array

`Readonly`epoch

epoch: number | undefined

`Readonly`kind

kind: X25519DeoxysII = CipherKind.X25519DeoxysII

`Readonly`publicKey

publicKey: Uint8Array

secretKey

secretKey: Uint8Array

Methods

decrypt

decrypt(nonce: Uint8Array, ciphertext: Uint8Array): Uint8Array
Parameters
- nonce: Uint8Array
- ciphertext: Uint8Array
Returns Uint8Array
Overrides Cipher.decrypt
- Defined in clients/js/src/cipher.ts:277

decryptCall

decryptCall(envelopeBytes: BytesLike): BytesLike
Parameters
- envelopeBytes: BytesLike
Returns BytesLike
Inherited from Cipher.decryptCall
- Defined in clients/js/src/cipher.ts:132

decryptResult

decryptResult(callResult: BytesLike): BytesLike
Decrypts the data contained within a hex-encoded serialized envelope.
Parameters
- callResult: BytesLike
Returns BytesLike
Inherited from Cipher.decryptResult
- Defined in clients/js/src/cipher.ts:178

encrypt

encrypt(
plaintext: Uint8Array,
nonce?: Uint8Array,
): { ciphertext: Uint8Array; nonce: Uint8Array }
Parameters
- plaintext: Uint8Array
- nonce: Uint8Array = ...
Returns { ciphertext: Uint8Array; nonce: Uint8Array }
Overrides Cipher.encrypt
- Defined in clients/js/src/cipher.ts:266

encryptCall

encryptCall(
calldata?: BytesLike | null,
nonce?: Uint8Array<ArrayBufferLike>,
): BytesLike
Encrypts the plaintext and encodes it for sending.
Parameters
- Optionalcalldata: BytesLike | null
- Optionalnonce: Uint8Array<ArrayBufferLike>
Returns BytesLike
Inherited from Cipher.encryptCall
- Defined in clients/js/src/cipher.ts:102

encryptResult

encryptResult(
    ok?: Uint8Array<ArrayBufferLike>,
    innerFail?: string,
    outerFail?: string,
): Uint8Array
Parameters
- Optionalok: Uint8Array<ArrayBufferLike>
- OptionalinnerFail: string
- OptionalouterFail: string
Returns Uint8Array
Inherited from Cipher.encryptResult
- Defined in clients/js/src/cipher.ts:142

`Static`ephemeral

ephemeral(peerPublicKey: BytesLike, epoch?: number): X25519DeoxysII
Creates a new cipher using an ephemeral keypair stored in memory.
Parameters
- peerPublicKey: BytesLike
- Optionalepoch: number
Returns X25519DeoxysII
- Defined in clients/js/src/cipher.ts:226

`Static`fromSecretKey

fromSecretKey(
    secretKey: BytesLike,
    peerPublicKey: BytesLike,
    epoch?: number,
): X25519DeoxysII
Parameters
- secretKey: BytesLike
- peerPublicKey: BytesLike
- Optionalepoch: number
Returns X25519DeoxysII
- Defined in clients/js/src/cipher.ts:233