From 87bd00ebb691243a63866d413dcdee219c00a867 Mon Sep 17 00:00:00 2001 From: Florian Duros Date: Thu, 12 Sep 2024 17:34:49 +0200 Subject: [PATCH] Update `recovery-key.ts` doc --- src/crypto-api/recovery-key.ts | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/src/crypto-api/recovery-key.ts b/src/crypto-api/recovery-key.ts index ded9178fe4f..4b27b5a8ef8 100644 --- a/src/crypto-api/recovery-key.ts +++ b/src/crypto-api/recovery-key.ts @@ -22,7 +22,7 @@ const OLM_RECOVERY_KEY_PREFIX = [0x8b, 0x01]; const KEY_SIZE = 32; /** - * Encode a recovery key using base58 encoding. + * Encode a recovery key using the Matrix {@link https://spec.matrix.org/v1.11/appendices/#cryptographic-key-representation | Cryptographic key representation} * @param key */ export function encodeRecoveryKey(key: ArrayLike): string | undefined { @@ -41,7 +41,7 @@ export function encodeRecoveryKey(key: ArrayLike): string | undefined { } /** - * Decode a recovery key from base58 encoding. + * Decode a recovery key encoded with the Matrix {@link https://spec.matrix.org/v1.11/appendices/#cryptographic-key-representation | Cryptographic key representation} encoding. * @param recoveryKey */ export function decodeRecoveryKey(recoveryKey: string): Uint8Array {