Class Plain

A Cipher that does not encrypt data.

This cipher is useful for debugging and sending messages that you would prefer everyone to be able to see (e.g., for auditing purposes).

Hierarchy

Cipher
- Plain

Index

Constructors

Properties

epoch kind publicKey

Methods

decrypt decryptCallData decryptCallResult decryptEncoded encrypt encryptCallData encryptEncode encryptEnvelope

Constructors

constructor

new Plain(): Plain
Returns Plain
Inherited from Cipher.constructor

Properties

`Readonly` epoch

epoch: undefined = undefined

`Readonly` kind

kind: Kind = Kind.Plain

`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:155

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:148

encryptCallData

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

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

Generated using TypeDoc