Skip to content

Commit

Permalink
Update recovery-key.ts doc
Browse files Browse the repository at this point in the history
  • Loading branch information
florianduros committed Sep 12, 2024
1 parent 6d41c43 commit 87bd00e
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions src/crypto-api/recovery-key.ts
Original file line number Diff line number Diff line change
Expand Up @@ -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<number>): string | undefined {
Expand All @@ -41,7 +41,7 @@ export function encodeRecoveryKey(key: ArrayLike<number>): 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 {
Expand Down

0 comments on commit 87bd00e

Please sign in to comment.