@metamask-previews/keyring-controller 22.0.2-preview-c6e5eb7 → 22.0.2-preview-d7c00b1

package/CHANGELOG.md

@@ -7,6 +7,14 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+### Added
+
+- Add method `exportEncryptionKey` ([#5984](https://github.com/MetaMask/core/pull/5984))
+
+### Changed
+
+- Make salt optional with method `submitEncryptionKey` ([#5984](https://github.com/MetaMask/core/pull/5984))
+
 ## [22.0.2]
 
 ### Fixed

package/dist/KeyringController.cjs

@@ -36,7 +36,7 @@ var __classPrivateFieldGet = (this && this.__classPrivateFieldGet) || function (
 var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
-var _KeyringController_instances, _KeyringController_controllerOperationMutex, _KeyringController_vaultOperationMutex, _KeyringController_keyringBuilders, _KeyringController_encryptor, _KeyringController_cacheEncryptionKey, _KeyringController_keyrings, _KeyringController_unsupportedKeyrings, _KeyringController_password, _KeyringController_qrKeyringStateListener, _KeyringController_registerMessageHandlers, _KeyringController_getKeyringById, _KeyringController_getKeyringByIdOrDefault, _KeyringController_getKeyringMetadata, _KeyringController_getKeyringBuilderForType, _KeyringController_addQRKeyring, _KeyringController_subscribeToQRKeyringEvents, _KeyringController_unsubscribeFromQRKeyringsEvents, _KeyringController_createNewVaultWithKeyring, _KeyringController_verifySeedPhrase, _KeyringController_getUpdatedKeyrings, _KeyringController_getSerializedKeyrings, _KeyringController_getSessionState, _KeyringController_restoreSerializedKeyrings, _KeyringController_unlockKeyrings, _KeyringController_updateVault, _KeyringController_isNewEncryptionAvailable, _KeyringController_getAccountsFromKeyrings, _KeyringController_createKeyringWithFirstAccount, _KeyringController_newKeyring, _KeyringController_createKeyring, _KeyringController_clearKeyrings, _KeyringController_restoreKeyring, _KeyringController_destroyKeyring, _KeyringController_removeEmptyKeyrings, _KeyringController_assertNoDuplicateAccounts, _KeyringController_setUnlocked, _KeyringController_assertIsUnlocked, _KeyringController_persistOrRollback, _KeyringController_withRollback, _KeyringController_assertControllerMutexIsLocked, _KeyringController_withControllerLock, _KeyringController_withVaultLock;
+var _KeyringController_instances, _KeyringController_controllerOperationMutex, _KeyringController_vaultOperationMutex, _KeyringController_keyringBuilders, _KeyringController_encryptor, _KeyringController_cacheEncryptionKey, _KeyringController_keyrings, _KeyringController_unsupportedKeyrings, _KeyringController_password, _KeyringController_registerMessageHandlers, _KeyringController_getKeyringById, _KeyringController_getKeyringByIdOrDefault, _KeyringController_getKeyringMetadata, _KeyringController_getKeyringBuilderForType, _KeyringController_createNewVaultWithKeyring, _KeyringController_verifySeedPhrase, _KeyringController_getUpdatedKeyrings, _KeyringController_getSerializedKeyrings, _KeyringController_getSessionState, _KeyringController_restoreSerializedKeyrings, _KeyringController_unlockKeyrings, _KeyringController_updateVault, _KeyringController_isNewEncryptionAvailable, _KeyringController_getAccountsFromKeyrings, _KeyringController_createKeyringWithFirstAccount, _KeyringController_newKeyring, _KeyringController_createKeyring, _KeyringController_clearKeyrings, _KeyringController_restoreKeyring, _KeyringController_destroyKeyring, _KeyringController_removeEmptyKeyrings, _KeyringController_assertNoDuplicateAccounts, _KeyringController_setUnlocked, _KeyringController_assertIsUnlocked, _KeyringController_persistOrRollback, _KeyringController_withRollback, _KeyringController_assertControllerMutexIsLocked, _KeyringController_withControllerLock, _KeyringController_withVaultLock;
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.KeyringController = exports.getDefaultKeyringState = exports.keyringBuilderFactory = exports.SignTypedDataVersion = exports.AccountImportStrategy = exports.isCustodyKeyring = exports.KeyringTypes = void 0;
 const util_1 = require("@ethereumjs/util");
@@ -168,6 +168,17 @@ function assertIsValidPassword(password) {
         throw new Error(constants_1.KeyringControllerError.InvalidEmptyPassword);
     }
 }
+/**
+ * Assert that the provided encryption key is a valid non-empty string.
+ *
+ * @param encryptionKey - The encryption key to check.
+ * @throws If the encryption key is not a valid string.
+ */
+function assertIsEncryptionKeySet(encryptionKey) {
+    if (!encryptionKey) {
+        throw new Error(constants_1.KeyringControllerError.EncryptionKeyNotSet);
+    }
+}
 /**
  * Checks if the provided value is a serialized keyrings array.
  *
@@ -274,7 +285,6 @@ class KeyringController extends base_controller_1.BaseController {
         _KeyringController_keyrings.set(this, void 0);
         _KeyringController_unsupportedKeyrings.set(this, void 0);
         _KeyringController_password.set(this, void 0);
-        _KeyringController_qrKeyringStateListener.set(this, void 0);
         __classPrivateFieldSet(this, _KeyringController_keyringBuilders, keyringBuilders
             ? keyringBuilders.concat(defaultKeyringBuilders)
             : defaultKeyringBuilders, "f");
@@ -399,9 +409,6 @@ class KeyringController extends base_controller_1.BaseController {
      */
     async addNewKeyring(type, opts) {
         __classPrivateFieldGet(this, _KeyringController_instances, "m", _KeyringController_assertIsUnlocked).call(this);
-        if (type === KeyringTypes.qr) {
-            return __classPrivateFieldGet(this, _KeyringController_instances, "m", _KeyringController_getKeyringMetadata).call(this, await this.getOrAddQRKeyring());
-        }
         return __classPrivateFieldGet(this, _KeyringController_instances, "m", _KeyringController_getKeyringMetadata).call(this, await __classPrivateFieldGet(this, _KeyringController_instances, "m", _KeyringController_persistOrRollback).call(this, async () => __classPrivateFieldGet(this, _KeyringController_instances, "m", _KeyringController_newKeyring).call(this, type, opts)));
     }
     /**
@@ -660,7 +667,6 @@ class KeyringController extends base_controller_1.BaseController {
     async setLocked() {
         __classPrivateFieldGet(this, _KeyringController_instances, "m", _KeyringController_assertIsUnlocked).call(this);
         return __classPrivateFieldGet(this, _KeyringController_instances, "m", _KeyringController_withRollback).call(this, async () => {
-            __classPrivateFieldGet(this, _KeyringController_instances, "m", _KeyringController_unsubscribeFromQRKeyringsEvents).call(this);
             __classPrivateFieldSet(this, _KeyringController_password, undefined, "f");
             await __classPrivateFieldGet(this, _KeyringController_instances, "m", _KeyringController_clearKeyrings).call(this);
             this.update((state) => {
@@ -843,6 +849,10 @@ class KeyringController extends base_controller_1.BaseController {
      */
     changePassword(password) {
         __classPrivateFieldGet(this, _KeyringController_instances, "m", _KeyringController_assertIsUnlocked).call(this);
+        // If the password is the same, do nothing.
+        if (__classPrivateFieldGet(this, _KeyringController_password, "f") === password) {
+            return Promise.resolve();
+        }
         return __classPrivateFieldGet(this, _KeyringController_instances, "m", _KeyringController_persistOrRollback).call(this, async () => {
             assertIsValidPassword(password);
             __classPrivateFieldSet(this, _KeyringController_password, password, "f");
@@ -858,11 +868,12 @@ class KeyringController extends base_controller_1.BaseController {
         });
     }
     /**
-     * Attempts to decrypt the current vault and load its keyrings,
-     * using the given encryption key and salt.
+     * Attempts to decrypt the current vault and load its keyrings, using the
+     * given encryption key and salt. The optional salt can be used to check for
+     * consistency with the vault salt.
      *
      * @param encryptionKey - Key to unlock the keychain.
-     * @param encryptionSalt - Salt to unlock the keychain.
+     * @param encryptionSalt - Optional salt to unlock the keychain.
      * @returns Promise resolving when the operation completes.
      */
     async submitEncryptionKey(encryptionKey, encryptionSalt) {
@@ -886,6 +897,19 @@ class KeyringController extends base_controller_1.BaseController {
             console.error('Failed to update vault during login:', error);
         }
     }
+    /**
+     * Exports the vault encryption key.
+     *
+     * @returns The vault encryption key.
+     */
+    async exportEncryptionKey() {
+        __classPrivateFieldGet(this, _KeyringController_instances, "m", _KeyringController_assertIsUnlocked).call(this);
+        return await __classPrivateFieldGet(this, _KeyringController_instances, "m", _KeyringController_withControllerLock).call(this, async () => {
+            const { encryptionKey } = this.state;
+            assertIsEncryptionKeySet(encryptionKey);
+            return encryptionKey;
+        });
+    }
     /**
      * Attempts to decrypt the current vault and load its keyrings,
      * using the given password.
@@ -960,206 +984,14 @@ class KeyringController extends base_controller_1.BaseController {
             return result;
         });
     }
-    // QR Hardware related methods
-    /**
-     * Get QR Hardware keyring.
-     *
-     * @returns The QR Keyring if defined, otherwise undefined
-     * @deprecated Use `withKeyring` instead.
-     */
-    getQRKeyring() {
-        __classPrivateFieldGet(this, _KeyringController_instances, "m", _KeyringController_assertIsUnlocked).call(this);
-        // QRKeyring is not yet compatible with Keyring type from @metamask/utils
-        return this.getKeyringsByType(KeyringTypes.qr)[0];
-    }
-    /**
-     * Get QR hardware keyring. If it doesn't exist, add it.
-     *
-     * @returns The added keyring
-     * @deprecated Use `addNewKeyring` and `withKeyring` instead.
-     */
-    async getOrAddQRKeyring() {
-        __classPrivateFieldGet(this, _KeyringController_instances, "m", _KeyringController_assertIsUnlocked).call(this);
-        return (this.getQRKeyring() ||
-            (await __classPrivateFieldGet(this, _KeyringController_instances, "m", _KeyringController_persistOrRollback).call(this, async () => __classPrivateFieldGet(this, _KeyringController_instances, "m", _KeyringController_addQRKeyring).call(this))));
-    }
-    /**
-     * Restore QR keyring from serialized data.
-     *
-     * @param serialized - Serialized data to restore the keyring from.
-     * @returns Promise resolving when the operation completes.
-     * @deprecated Use `withKeyring` instead.
-     */
-    // TODO: Replace `any` with type
-    // eslint-disable-next-line @typescript-eslint/no-explicit-any
-    async restoreQRKeyring(serialized) {
-        __classPrivateFieldGet(this, _KeyringController_instances, "m", _KeyringController_assertIsUnlocked).call(this);
-        return __classPrivateFieldGet(this, _KeyringController_instances, "m", _KeyringController_persistOrRollback).call(this, async () => {
-            const keyring = this.getQRKeyring() || (await __classPrivateFieldGet(this, _KeyringController_instances, "m", _KeyringController_addQRKeyring).call(this));
-            keyring.deserialize(serialized);
-        });
-    }
-    /**
-     * Reset QR keyring state.
-     *
-     * @returns Promise resolving when the operation completes.
-     * @deprecated Use `withKeyring` instead.
-     */
-    async resetQRKeyringState() {
-        __classPrivateFieldGet(this, _KeyringController_instances, "m", _KeyringController_assertIsUnlocked).call(this);
-        (await this.getOrAddQRKeyring()).resetStore();
-    }
-    /**
-     * Get QR keyring state.
-     *
-     * @returns Promise resolving to the keyring state.
-     * @deprecated Use `withKeyring` or subscribe to `"KeyringController:qrKeyringStateChange"`
-     * instead.
-     */
-    async getQRKeyringState() {
-        __classPrivateFieldGet(this, _KeyringController_instances, "m", _KeyringController_assertIsUnlocked).call(this);
-        return (await this.getOrAddQRKeyring()).getMemStore();
-    }
-    /**
-     * Submit QR hardware wallet public HDKey.
-     *
-     * @param cryptoHDKey - The key to submit.
-     * @returns Promise resolving when the operation completes.
-     * @deprecated Use `withKeyring` instead.
-     */
-    async submitQRCryptoHDKey(cryptoHDKey) {
-        __classPrivateFieldGet(this, _KeyringController_instances, "m", _KeyringController_assertIsUnlocked).call(this);
-        (await this.getOrAddQRKeyring()).submitCryptoHDKey(cryptoHDKey);
-    }
-    /**
-     * Submit QR hardware wallet account.
-     *
-     * @param cryptoAccount - The account to submit.
-     * @returns Promise resolving when the operation completes.
-     * @deprecated Use `withKeyring` instead.
-     */
-    async submitQRCryptoAccount(cryptoAccount) {
-        __classPrivateFieldGet(this, _KeyringController_instances, "m", _KeyringController_assertIsUnlocked).call(this);
-        (await this.getOrAddQRKeyring()).submitCryptoAccount(cryptoAccount);
-    }
-    /**
-     * Submit QR hardware wallet signature.
-     *
-     * @param requestId - The request ID.
-     * @param ethSignature - The signature to submit.
-     * @returns Promise resolving when the operation completes.
-     * @deprecated Use `withKeyring` instead.
-     */
-    async submitQRSignature(requestId, ethSignature) {
-        __classPrivateFieldGet(this, _KeyringController_instances, "m", _KeyringController_assertIsUnlocked).call(this);
-        (await this.getOrAddQRKeyring()).submitSignature(requestId, ethSignature);
-    }
-    /**
-     * Cancel QR sign request.
-     *
-     * @returns Promise resolving when the operation completes.
-     * @deprecated Use `withKeyring` instead.
-     */
-    async cancelQRSignRequest() {
-        __classPrivateFieldGet(this, _KeyringController_instances, "m", _KeyringController_assertIsUnlocked).call(this);
-        (await this.getOrAddQRKeyring()).cancelSignRequest();
-    }
-    /**
-     * Cancels qr keyring sync.
-     *
-     * @returns Promise resolving when the operation completes.
-     * @deprecated Use `withKeyring` instead.
-     */
-    async cancelQRSynchronization() {
-        __classPrivateFieldGet(this, _KeyringController_instances, "m", _KeyringController_assertIsUnlocked).call(this);
-        (await this.getOrAddQRKeyring()).cancelSync();
-    }
-    /**
-     * Connect to QR hardware wallet.
-     *
-     * @param page - The page to connect to.
-     * @returns Promise resolving to the connected accounts.
-     * @deprecated Use of this method is discouraged as it creates a dangling promise
-     * internal to the `QRKeyring`, which can lead to unpredictable deadlocks. Please use
-     * `withKeyring` instead.
-     */
-    async connectQRHardware(page) {
-        __classPrivateFieldGet(this, _KeyringController_instances, "m", _KeyringController_assertIsUnlocked).call(this);
-        return __classPrivateFieldGet(this, _KeyringController_instances, "m", _KeyringController_persistOrRollback).call(this, async () => {
-            try {
-                const keyring = this.getQRKeyring() || (await __classPrivateFieldGet(this, _KeyringController_instances, "m", _KeyringController_addQRKeyring).call(this));
-                let accounts;
-                switch (page) {
-                    case -1:
-                        accounts = await keyring.getPreviousPage();
-                        break;
-                    case 1:
-                        accounts = await keyring.getNextPage();
-                        break;
-                    default:
-                        accounts = await keyring.getFirstPage();
-                }
-                // TODO: Replace `any` with type
-                // eslint-disable-next-line @typescript-eslint/no-explicit-any
-                return accounts.map((account) => {
-                    return {
-                        ...account,
-                        balance: '0x0',
-                    };
-                });
-            }
-            catch (e) {
-                // TODO: Add test case for when keyring throws
-                /* istanbul ignore next */
-                // TODO: Either fix this lint violation or explain why it's necessary to ignore.
-                // eslint-disable-next-line @typescript-eslint/restrict-template-expressions
-                throw new Error(`Unspecified error when connect QR Hardware, ${e}`);
-            }
-        });
-    }
-    /**
-     * Unlock a QR hardware wallet account.
-     *
-     * @param index - The index of the account to unlock.
-     * @returns Promise resolving when the operation completes.
-     * @deprecated Use `withKeyring` instead.
-     */
-    async unlockQRHardwareWalletAccount(index) {
-        __classPrivateFieldGet(this, _KeyringController_instances, "m", _KeyringController_assertIsUnlocked).call(this);
-        return __classPrivateFieldGet(this, _KeyringController_instances, "m", _KeyringController_persistOrRollback).call(this, async () => {
-            const keyring = this.getQRKeyring() || (await __classPrivateFieldGet(this, _KeyringController_instances, "m", _KeyringController_addQRKeyring).call(this));
-            keyring.setAccountToUnlock(index);
-            await keyring.addAccounts(1);
-        });
-    }
     async getAccountKeyringType(account) {
         __classPrivateFieldGet(this, _KeyringController_instances, "m", _KeyringController_assertIsUnlocked).call(this);
         const keyring = (await this.getKeyringForAccount(account));
         return keyring.type;
     }
-    /**
-     * Forget the QR hardware wallet.
-     *
-     * @returns Promise resolving to the removed accounts and the remaining accounts.
-     * @deprecated Use `withKeyring` instead.
-     */
-    async forgetQRDevice() {
-        __classPrivateFieldGet(this, _KeyringController_instances, "m", _KeyringController_assertIsUnlocked).call(this);
-        return __classPrivateFieldGet(this, _KeyringController_instances, "m", _KeyringController_persistOrRollback).call(this, async () => {
-            const keyring = this.getQRKeyring();
-            if (!keyring) {
-                return { removedAccounts: [], remainingAccounts: [] };
-            }
-            const allAccounts = (await __classPrivateFieldGet(this, _KeyringController_instances, "m", _KeyringController_getAccountsFromKeyrings).call(this));
-            keyring.forgetDevice();
-            const remainingAccounts = (await __classPrivateFieldGet(this, _KeyringController_instances, "m", _KeyringController_getAccountsFromKeyrings).call(this));
-            const removedAccounts = allAccounts.filter((address) => !remainingAccounts.includes(address));
-            return { removedAccounts, remainingAccounts };
-        });
-    }
 }
 exports.KeyringController = KeyringController;
-_KeyringController_controllerOperationMutex = new WeakMap(), _KeyringController_vaultOperationMutex = new WeakMap(), _KeyringController_keyringBuilders = new WeakMap(), _KeyringController_encryptor = new WeakMap(), _KeyringController_cacheEncryptionKey = new WeakMap(), _KeyringController_keyrings = new WeakMap(), _KeyringController_unsupportedKeyrings = new WeakMap(), _KeyringController_password = new WeakMap(), _KeyringController_qrKeyringStateListener = new WeakMap(), _KeyringController_instances = new WeakSet(), _KeyringController_registerMessageHandlers = function _KeyringController_registerMessageHandlers() {
+_KeyringController_controllerOperationMutex = new WeakMap(), _KeyringController_vaultOperationMutex = new WeakMap(), _KeyringController_keyringBuilders = new WeakMap(), _KeyringController_encryptor = new WeakMap(), _KeyringController_cacheEncryptionKey = new WeakMap(), _KeyringController_keyrings = new WeakMap(), _KeyringController_unsupportedKeyrings = new WeakMap(), _KeyringController_password = new WeakMap(), _KeyringController_instances = new WeakSet(), _KeyringController_registerMessageHandlers = function _KeyringController_registerMessageHandlers() {
     this.messagingSystem.registerActionHandler(`${name}:signMessage`, this.signMessage.bind(this));
     this.messagingSystem.registerActionHandler(`${name}:signEip7702Authorization`, this.signEip7702Authorization.bind(this));
     this.messagingSystem.registerActionHandler(`${name}:signPersonalMessage`, this.signPersonalMessage.bind(this));
@@ -1191,30 +1023,6 @@ _KeyringController_controllerOperationMutex = new WeakMap(), _KeyringController_
     return keyringWithMetadata.metadata;
 }, _KeyringController_getKeyringBuilderForType = function _KeyringController_getKeyringBuilderForType(type) {
     return __classPrivateFieldGet(this, _KeyringController_keyringBuilders, "f").find((keyringBuilder) => keyringBuilder.type === type);
-}, _KeyringController_addQRKeyring = 
-/**
- * Add qr hardware keyring.
- *
- * @returns The added keyring
- * @throws If a QRKeyring builder is not provided
- * when initializing the controller
- */
-async function _KeyringController_addQRKeyring() {
-    __classPrivateFieldGet(this, _KeyringController_instances, "m", _KeyringController_assertControllerMutexIsLocked).call(this);
-    // QRKeyring is not yet compatible with Keyring type from @metamask/utils
-    return (await __classPrivateFieldGet(this, _KeyringController_instances, "m", _KeyringController_newKeyring).call(this, KeyringTypes.qr));
-}, _KeyringController_subscribeToQRKeyringEvents = function _KeyringController_subscribeToQRKeyringEvents(qrKeyring) {
-    __classPrivateFieldSet(this, _KeyringController_qrKeyringStateListener, (state) => {
-        this.messagingSystem.publish(`${name}:qrKeyringStateChange`, state);
-    }, "f");
-    qrKeyring.getMemStore().subscribe(__classPrivateFieldGet(this, _KeyringController_qrKeyringStateListener, "f"));
-}, _KeyringController_unsubscribeFromQRKeyringsEvents = function _KeyringController_unsubscribeFromQRKeyringsEvents() {
-    const qrKeyrings = this.getKeyringsByType(KeyringTypes.qr);
-    qrKeyrings.forEach((qrKeyring) => {
-        if (__classPrivateFieldGet(this, _KeyringController_qrKeyringStateListener, "f")) {
-            qrKeyring.getMemStore().unsubscribe(__classPrivateFieldGet(this, _KeyringController_qrKeyringStateListener, "f"));
-        }
-    });
 }, _KeyringController_createNewVaultWithKeyring = 
 /**
  * Create new vault with an initial keyring
@@ -1384,9 +1192,12 @@ async function _KeyringController_unlockKeyrings(password, encryptionKey, encryp
             }
             else {
                 const parsedEncryptedVault = JSON.parse(encryptedVault);
-                if (encryptionSalt !== parsedEncryptedVault.salt) {
+                if (encryptionSalt && encryptionSalt !== parsedEncryptedVault.salt) {
                     throw new Error(constants_1.KeyringControllerError.ExpiredCredentials);
                 }
+                else {
+                    encryptionSalt = parsedEncryptedVault.salt;
+                }
                 if (typeof encryptionKey !== 'string') {
                     throw new TypeError(constants_1.KeyringControllerError.WrongPasswordType);
                 }
@@ -1395,9 +1206,6 @@ async function _KeyringController_unlockKeyrings(password, encryptionKey, encryp
                 // This call is required on the first call because encryptionKey
                 // is not yet inside the memStore
                 updatedState.encryptionKey = encryptionKey;
-                // we can safely assume that encryptionSalt is defined here
-                // because we compare it with the salt from the vault
-                // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
                 updatedState.encryptionSalt = encryptionSalt;
             }
         }
@@ -1574,11 +1382,6 @@ async function _KeyringController_createKeyring(type, data) {
         await keyring.generateRandomMnemonic();
         await keyring.addAccounts(1);
     }
-    if (type === KeyringTypes.qr) {
-        // In case of a QR keyring type, we need to subscribe
-        // to its events after creating it
-        __classPrivateFieldGet(this, _KeyringController_instances, "m", _KeyringController_subscribeToQRKeyringEvents).call(this, keyring);
-    }
     return keyring;
 }, _KeyringController_clearKeyrings = 
 /**