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

Cipher
- X25519DeoxysII

Index

Constructors

Properties

epoch kind publicKey

Methods

decrypt decryptCallData decryptCallResult decryptEncoded encrypt encryptCallData encryptEncode encryptEnvelope ephemeral fromSecretKey

Constructors

constructor

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

Properties

`Readonly` epoch

epoch: undefined | number

`Readonly` kind

kind: Kind = Kind.X25519DeoxysII

`Readonly` publicKey

publicKey: Uint8Array

Methods

decrypt

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

decryptCallData

decryptCallData(nonce, ciphertext): Promise<Uint8Array>
Decrypts the data contained within call

This is useful for creating tools, and also decoding previously-sent transactions that have used the same encryption key.
Parameters
- nonce: Uint8Array
- ciphertext: Uint8Array
Returns Promise<Uint8Array>
Inherited from Cipher.decryptCallData
- Defined in clients/js/src/cipher.ts:88

decryptCallResult

decryptCallResult(res): Promise<Uint8Array>
Decrypts the data contained within a result envelope.
Parameters
- res: CallResult
Returns Promise<Uint8Array>
Inherited from Cipher.decryptCallResult
- Defined in clients/js/src/cipher.ts:118

decryptEncoded

decryptEncoded(callResult): Promise<string>
Decrypts the data contained within a hex-encoded serialized envelope.
Parameters
- callResult: BytesLike
Returns Promise<string>
Inherited from Cipher.decryptEncoded
- Defined in clients/js/src/cipher.ts:111

encrypt

encrypt(plaintext): Promise<{
ciphertext: Uint8Array;
nonce: Uint8Array;
}>
Parameters
- plaintext: Uint8Array
Returns Promise<{
ciphertext: Uint8Array;
nonce: Uint8Array;
}>
Overrides Cipher.encrypt
- Defined in clients/js/src/cipher.ts:220

`Protected` encryptCallData

encryptCallData(plaintext): Promise<AeadEnvelope>
Parameters
- plaintext: Uint8Array
Returns Promise<AeadEnvelope>
Inherited from Cipher.encryptCallData
- Defined in clients/js/src/cipher.ts:72

encryptEncode

encryptEncode(plaintext?): Promise<string>
Encrypts the plaintext and encodes it for sending.
Parameters
- Optional plaintext: BytesLike
Returns Promise<string>
Inherited from Cipher.encryptEncode
- Defined in clients/js/src/cipher.ts:50

encryptEnvelope

encryptEnvelope(plaintext?): Promise<undefined | Envelope>
Encrypts the plaintext and formats it into an envelope.
Parameters
- Optional plaintext: BytesLike
Returns Promise<undefined | Envelope>
Inherited from Cipher.encryptEnvelope
- Defined in clients/js/src/cipher.ts:56

`Static` ephemeral

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

`Static` fromSecretKey

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

Generated using TypeDoc