Class CipherAbstract

constructor

• new Cipher(): Cipher

• Returns Cipher

Abstract epoch

Abstract kind

Abstract publicKey

Abstract decrypt

• decrypt(nonce, ciphertext): Promise<Uint8Array>

• Parameters

  • nonce: Uint8Array

  • ciphertext: Uint8Array

  Returns Promise<Uint8Array>

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>

decryptCallResult

• decryptCallResult(res): Promise<Uint8Array>

• Decrypts the data contained within a result envelope.

  Parameters

  • res: CallResult

  Returns Promise<Uint8Array>

decryptEncoded

• decryptEncoded(callResult): Promise<string>

• Decrypts the data contained within a hex-encoded serialized envelope.

  Parameters

  • callResult: BytesLike

  Returns Promise<string>

Abstract encrypt

• encrypt(plaintext): Promise<{
      ciphertext: Uint8Array;
      nonce: Uint8Array;
  }>

• Parameters

  • plaintext: Uint8Array

  Returns Promise<{
      ciphertext: Uint8Array;
      nonce: Uint8Array;
  }>

encryptEncode

• encryptEncode(plaintext?): Promise<string>

• Encrypts the plaintext and encodes it for sending.

  Parameters

  • Optional plaintext: BytesLike

  Returns Promise<string>

encryptEnvelope

• encryptEnvelope(plaintext?): Promise<undefined | Envelope>

• Encrypts the plaintext and formats it into an envelope.

  Parameters

  • Optional plaintext: BytesLike

  Returns Promise<undefined | Envelope>