@metamask-previews/keyring-controller 21.0.4-preview-19ee5ff2 → 21.0.4-preview-b84ab30f

package/CHANGELOG.md

@@ -9,12 +9,9 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ### Changed
 
+- Prevent emitting `:stateChange` from `withKeyring` unnecessarily ([#5732](https://github.com/MetaMask/core/pull/5732))
 - Bump `@metamask/base-controller` from ^8.0.0 to ^8.0.1 ([#5722](https://github.com/MetaMask/core/pull/5722))
 
-### Fixed
-
-- The vault encryption upgrade fails grecefully during login ([#5740](https://github.com/MetaMask/core/pull/5740))
-
 ## [21.0.4]
 
 ### 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_keyringsMetadata, _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_restoreSerializedKeyrings, _KeyringController_unlockKeyrings, _KeyringController_updateVault, _KeyringController_upgradeVaultEncryptionParams, _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_keyringsMetadata, _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_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");
@@ -48,6 +48,7 @@ const eth_simple_keyring_1 = __importDefault(require("@metamask/eth-simple-keyri
 const utils_1 = require("@metamask/utils");
 const async_mutex_1 = require("async-mutex");
 const ethereumjs_wallet_1 = __importStar(require("ethereumjs-wallet"));
+const lodash_1 = require("lodash");
 // When generating a ULID within the same millisecond, monotonicFactory provides some guarantees regarding sort order.
 const ulid_1 = require("ulid");
 const constants_1 = require("./constants.cjs");
@@ -553,8 +554,11 @@ class KeyringController extends base_controller_1.BaseController {
      * operation completes.
      */
     async persistAllKeyrings() {
-        __classPrivateFieldGet(this, _KeyringController_instances, "m", _KeyringController_assertIsUnlocked).call(this);
-        return __classPrivateFieldGet(this, _KeyringController_instances, "m", _KeyringController_persistOrRollback).call(this, async () => true);
+        return __classPrivateFieldGet(this, _KeyringController_instances, "m", _KeyringController_withRollback).call(this, async () => {
+            __classPrivateFieldGet(this, _KeyringController_instances, "m", _KeyringController_assertIsUnlocked).call(this);
+            await __classPrivateFieldGet(this, _KeyringController_instances, "m", _KeyringController_updateVault).call(this);
+            return true;
+        });
     }
     /**
      * Imports an account with the specified import strategy.
@@ -874,20 +878,10 @@ class KeyringController extends base_controller_1.BaseController {
      * @returns Promise resolving when the operation completes.
      */
     async submitPassword(password) {
-        await __classPrivateFieldGet(this, _KeyringController_instances, "m", _KeyringController_withRollback).call(this, async () => {
+        return __classPrivateFieldGet(this, _KeyringController_instances, "m", _KeyringController_withRollback).call(this, async () => {
             __classPrivateFieldSet(this, _KeyringController_keyrings, await __classPrivateFieldGet(this, _KeyringController_instances, "m", _KeyringController_unlockKeyrings).call(this, password), "f");
             __classPrivateFieldGet(this, _KeyringController_instances, "m", _KeyringController_setUnlocked).call(this);
         });
-        try {
-            // If there are stronger encryption params available, we
-            // can attempt to upgrade the vault encryption params.
-            await __classPrivateFieldGet(this, _KeyringController_instances, "m", _KeyringController_withRollback).call(this, async () => __classPrivateFieldGet(this, _KeyringController_instances, "m", _KeyringController_upgradeVaultEncryptionParams).call(this));
-        }
-        catch (error) {
-            // We don't want to throw an error if the upgrade fails
-            // since the controller is already unlocked.
-            console.error('Failed to upgrade vault encryption params:', error);
-        }
     }
     /**
      * Verifies the that the seed phrase restores the current keychain's accounts.
@@ -1294,6 +1288,19 @@ async function _KeyringController_getSerializedKeyrings({ includeUnsupported } =
         serializedKeyrings.push(...__classPrivateFieldGet(this, _KeyringController_unsupportedKeyrings, "f"));
     }
     return serializedKeyrings;
+}, _KeyringController_getSessionState = 
+/**
+ * Get a snapshot of session data held by class variables.
+ *
+ * @returns An object with serialized keyrings, keyrings metadata,
+ * and the user password.
+ */
+async function _KeyringController_getSessionState() {
+    return {
+        keyrings: await __classPrivateFieldGet(this, _KeyringController_instances, "m", _KeyringController_getSerializedKeyrings).call(this),
+        keyringsMetadata: __classPrivateFieldGet(this, _KeyringController_keyringsMetadata, "f").slice(),
+        password: __classPrivateFieldGet(this, _KeyringController_password, "f"),
+    };
 }, _KeyringController_restoreSerializedKeyrings = 
 /**
  * Restore a serialized keyrings array.
@@ -1316,7 +1323,7 @@ async function _KeyringController_restoreSerializedKeyrings(serializedKeyrings)
  * @returns A promise resolving to the deserialized keyrings array.
  */
 async function _KeyringController_unlockKeyrings(password, encryptionKey, encryptionSalt) {
-    return __classPrivateFieldGet(this, _KeyringController_instances, "m", _KeyringController_withVaultLock).call(this, async () => {
+    return __classPrivateFieldGet(this, _KeyringController_instances, "m", _KeyringController_withVaultLock).call(this, async ({ releaseLock }) => {
         const encryptedVault = this.state.vault;
         if (!encryptedVault) {
             throw new Error(constants_1.KeyringControllerError.VaultError);
@@ -1375,6 +1382,16 @@ async function _KeyringController_unlockKeyrings(password, encryptionKey, encryp
                 state.encryptionSalt = updatedState.encryptionSalt;
             }
         });
+        if (__classPrivateFieldGet(this, _KeyringController_password, "f") &&
+            (!__classPrivateFieldGet(this, _KeyringController_cacheEncryptionKey, "f") || !encryptionKey) &&
+            __classPrivateFieldGet(this, _KeyringController_encryptor, "f").isVaultUpdated &&
+            !__classPrivateFieldGet(this, _KeyringController_encryptor, "f").isVaultUpdated(encryptedVault)) {
+            // The lock needs to be released before persisting the keyrings
+            // to avoid deadlock
+            releaseLock();
+            // Re-encrypt the vault with safer method if one is available
+            await __classPrivateFieldGet(this, _KeyringController_instances, "m", _KeyringController_updateVault).call(this);
+        }
         return __classPrivateFieldGet(this, _KeyringController_keyrings, "f");
     });
 }, _KeyringController_updateVault = function _KeyringController_updateVault() {
@@ -1433,20 +1450,6 @@ async function _KeyringController_unlockKeyrings(password, encryptionKey, encryp
         });
         return true;
     });
-}, _KeyringController_upgradeVaultEncryptionParams = 
-/**
- * Upgrade the vault encryption parameters if needed.
- *
- * @returns A promise resolving to `void`.
- */
-async function _KeyringController_upgradeVaultEncryptionParams() {
-    const { vault } = this.state;
-    if (vault &&
-        __classPrivateFieldGet(this, _KeyringController_password, "f") &&
-        __classPrivateFieldGet(this, _KeyringController_encryptor, "f").isVaultUpdated &&
-        !__classPrivateFieldGet(this, _KeyringController_encryptor, "f").isVaultUpdated(vault)) {
-        await __classPrivateFieldGet(this, _KeyringController_instances, "m", _KeyringController_updateVault).call(this);
-    }
 }, _KeyringController_getAccountsFromKeyrings = 
 /**
  * Retrieves all the accounts from keyrings instances
@@ -1658,7 +1661,7 @@ async function _KeyringController_assertNoDuplicateAccounts() {
 }, _KeyringController_persistOrRollback = 
 /**
  * Execute the given function after acquiring the controller lock
- * and save the keyrings to state after it, or rollback to their
+ * and save the vault to state after it (only if needed), or rollback to their
  * previous state in case of error.
  *
  * @param callback - The function to execute.
@@ -1666,9 +1669,13 @@ async function _KeyringController_assertNoDuplicateAccounts() {
  */
 async function _KeyringController_persistOrRollback(callback) {
     return __classPrivateFieldGet(this, _KeyringController_instances, "m", _KeyringController_withRollback).call(this, async ({ releaseLock }) => {
+        const oldState = await __classPrivateFieldGet(this, _KeyringController_instances, "m", _KeyringController_getSessionState).call(this);
         const callbackResult = await callback({ releaseLock });
-        // State is committed only if the operation is successful
-        await __classPrivateFieldGet(this, _KeyringController_instances, "m", _KeyringController_updateVault).call(this);
+        const newState = await __classPrivateFieldGet(this, _KeyringController_instances, "m", _KeyringController_getSessionState).call(this);
+        // State is committed only if the operation is successful and need to trigger a vault update.
+        if (!(0, lodash_1.isEqual)(oldState, newState)) {
+            await __classPrivateFieldGet(this, _KeyringController_instances, "m", _KeyringController_updateVault).call(this);
+        }
         return callbackResult;
     });
 }, _KeyringController_withRollback =