From 30a26813ec4bbc19e715ff0cd24b59240096928b Mon Sep 17 00:00:00 2001 From: Richard van der Hoff <1389908+richvdh@users.noreply.github.com> Date: Sat, 13 Jul 2024 11:19:14 +0100 Subject: [PATCH] Deprecate `CreateSecretStorageOpts.getKeyBackupPassphrase` (#4313) it doesn't work in rust crypto, and we have no plans to fix it (https://github.com/element-hq/element-web/issues/27455) --- src/crypto-api/index.ts | 9 +++++++-- 1 file changed, 7 insertions(+), 2 deletions(-) diff --git a/src/crypto-api/index.ts b/src/crypto-api/index.ts index 2522fb1efdc..b3a05172a1b 100644 --- a/src/crypto-api/index.ts +++ b/src/crypto-api/index.ts @@ -854,9 +854,14 @@ export interface CreateSecretStorageOpts { setupNewSecretStorage?: boolean; /** - * Function called to get the user's - * current key backup passphrase. Should return a promise that resolves with a Uint8Array + * Function called to get the user's current key backup passphrase. + * + * Should return a promise that resolves with a Uint8Array * containing the key, or rejects if the key cannot be obtained. + * + * Only used when the client has existing key backup, but no secret storage. + * + * @deprecated Not used by the Rust crypto stack. */ getKeyBackupPassphrase?: () => Promise; }