decryptWithXChaCha20Poly1305 - API reference

API reference › @evolu/common › Crypto › decryptWithXChaCha20Poly1305

function decryptWithXChaCha20Poly1305(
  ciphertext: Uint8Array<ArrayBufferLike> &
    Brand<"XChaCha20Poly1305Ciphertext">,
  nonce: Uint8Array<ArrayBufferLike> & Brand<"Entropy"> & Brand<"Length24">,
  encryptionKey: Uint8Array<ArrayBufferLike> &
    Brand<"Entropy"> &
    Brand<"Length32"> &
    Brand<"EncryptionKey">,
): Result<Uint8Array<ArrayBufferLike>, DecryptWithXChaCha20Poly1305Error>;

Defined in: packages/common/src/Crypto.ts:211

Decrypts ciphertext with XChaCha20-Poly1305.

Requires the same nonce that was used during encryption. Returns a Result that may contain a decryption error if the ciphertext was tampered with or the wrong key/nonce was used.

Example

const result = decryptWithXChaCha20Poly1305(ciphertext, nonce, encryptionKey);
if (!result.ok) {
  // Handle decryption error
  return result;
}
const plaintext = result.value;