@metamask-previews/keyring-controller 25.2.0-preview-866755774 → 25.2.0-preview-6b4f746

package/CHANGELOG.md

@@ -10,6 +10,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 ### Added
 
 - Expose `KeyringController:signTransaction` method through `KeyringController` messenger ([#8408](https://github.com/MetaMask/core/pull/8408))
+- Persist vault when keyring state changes during unlock ([#8415](https://github.com/MetaMask/core/pull/8415))
+  - If a keyring's serialized state differs after deserialization (e.g. a migration ran, or metadata was missing), the vault is now re-persisted so the change is not lost on the next unlock.
 - Added `KeyringV2` support ([#8390](https://github.com/MetaMask/core/pull/8390))
   - The controller now maintains a list of `KeyringV2` instance in memory alongside previous `Keyring` instance.
   - This new keyring interface is more generic and will become the new standard to interact with keyring (creating accounts, executing logic that involves accounts like signing, etc...).

package/dist/KeyringController.cjs

@@ -907,7 +907,7 @@ class KeyringController extends base_controller_1.BaseController {
      * @returns Promise resolving when the operation completes.
      */
     async submitEncryptionKey(encryptionKey, encryptionSalt) {
-        const { newMetadata } = await __classPrivateFieldGet(this, _KeyringController_instances, "m", _KeyringController_withRollback).call(this, async () => {
+        const { hasChanged } = await __classPrivateFieldGet(this, _KeyringController_instances, "m", _KeyringController_withRollback).call(this, async () => {
             const result = await __classPrivateFieldGet(this, _KeyringController_instances, "m", _KeyringController_unlockKeyrings).call(this, {
                 encryptionKey,
                 encryptionSalt,
@@ -919,7 +919,7 @@ class KeyringController extends base_controller_1.BaseController {
             // if new metadata has been generated during login, we
             // can attempt to upgrade the vault.
             await __classPrivateFieldGet(this, _KeyringController_instances, "m", _KeyringController_withRollback).call(this, async () => {
-                if (newMetadata) {
+                if (hasChanged) {
                     await __classPrivateFieldGet(this, _KeyringController_instances, "m", _KeyringController_updateVault).call(this);
                 }
             });
@@ -950,17 +950,17 @@ class KeyringController extends base_controller_1.BaseController {
      * @returns Promise resolving when the operation completes.
      */
     async submitPassword(password) {
-        const { newMetadata } = await __classPrivateFieldGet(this, _KeyringController_instances, "m", _KeyringController_withRollback).call(this, async () => {
+        const { hasChanged } = await __classPrivateFieldGet(this, _KeyringController_instances, "m", _KeyringController_withRollback).call(this, async () => {
             const result = await __classPrivateFieldGet(this, _KeyringController_instances, "m", _KeyringController_unlockKeyrings).call(this, { password });
             __classPrivateFieldGet(this, _KeyringController_instances, "m", _KeyringController_setUnlocked).call(this);
             return result;
         });
         try {
             // If there are stronger encryption params available, or
-            // if new metadata has been generated during login, we
+            // if the keyring state has changed during deserialization, we
             // can attempt to upgrade the vault.
             await __classPrivateFieldGet(this, _KeyringController_instances, "m", _KeyringController_withRollback).call(this, async () => {
-                if (newMetadata || __classPrivateFieldGet(this, _KeyringController_instances, "m", _KeyringController_isNewEncryptionAvailable).call(this)) {
+                if (hasChanged || __classPrivateFieldGet(this, _KeyringController_instances, "m", _KeyringController_isNewEncryptionAvailable).call(this)) {
                     await __classPrivateFieldGet(this, _KeyringController_instances, "m", _KeyringController_deriveAndSetEncryptionKey).call(this, password, {
                         // If the vault is being upgraded, we want to ignore the metadata
                         // that is already in the vault, so we can effectively
@@ -1448,18 +1448,18 @@ async function _KeyringController_getSessionState() {
 async function _KeyringController_restoreSerializedKeyrings(serializedKeyrings) {
     await __classPrivateFieldGet(this, _KeyringController_instances, "m", _KeyringController_clearKeyrings).call(this);
     const keyrings = [];
-    let newMetadata = false;
+    let hasChanged = false;
     for (const serializedKeyring of serializedKeyrings) {
         const result = await __classPrivateFieldGet(this, _KeyringController_instances, "m", _KeyringController_restoreKeyring).call(this, serializedKeyring);
         if (result) {
             const { keyring, metadata } = result;
             keyrings.push({ keyring, metadata });
-            if (result.newMetadata) {
-                newMetadata = true;
+            if (result.hasChanged) {
+                hasChanged = true;
             }
         }
     }
-    return { keyrings, newMetadata };
+    return { keyrings, hasChanged };
 }, _KeyringController_unlockKeyrings = 
 /**
  * Unlock Keyrings, decrypting the vault and deserializing all
@@ -1489,14 +1489,14 @@ async function _KeyringController_unlockKeyrings(credentials) {
         if (!isSerializedKeyringsArray(vault)) {
             throw new errors_1.KeyringControllerError(constants_1.KeyringControllerErrorMessage.VaultDataError);
         }
-        const { keyrings, newMetadata } = await __classPrivateFieldGet(this, _KeyringController_instances, "m", _KeyringController_restoreSerializedKeyrings).call(this, vault);
+        const { keyrings, hasChanged } = await __classPrivateFieldGet(this, _KeyringController_instances, "m", _KeyringController_restoreSerializedKeyrings).call(this, vault);
         const updatedKeyrings = await __classPrivateFieldGet(this, _KeyringController_instances, "m", _KeyringController_getUpdatedKeyrings).call(this);
         this.update((state) => {
             state.keyrings = updatedKeyrings;
             state.encryptionKey = encryptionKey;
             state.encryptionSalt = __classPrivateFieldGet(this, _KeyringController_encryptionKey, "f")?.salt;
         });
-        return { keyrings, newMetadata };
+        return { keyrings, hasChanged };
     });
 }, _KeyringController_updateVault = function _KeyringController_updateVault() {
     return __classPrivateFieldGet(this, _KeyringController_instances, "m", _KeyringController_withVaultLock).call(this, async () => {
@@ -1663,15 +1663,19 @@ async function _KeyringController_restoreKeyring(serialized) {
     __classPrivateFieldGet(this, _KeyringController_instances, "m", _KeyringController_assertControllerMutexIsLocked).call(this);
     try {
         const { type, data, metadata: serializedMetadata } = serialized;
-        let newMetadata = false;
+        // Track if we need to trigger a vault update.
+        let hasChanged = false;
+        // If metadata is missing, assume the data is from an installation before we had
+        // keyring metadata.
         let metadata = serializedMetadata;
-        // If metadata is missing, assume the data is from an installation before
-        // we had keyring metadata.
         if (!metadata) {
-            newMetadata = true;
+            hasChanged = true;
             metadata = getDefaultKeyringMetadata();
         }
+        const oldState = JSON.stringify(data);
         const { keyring, keyringV2 } = await __classPrivateFieldGet(this, _KeyringController_instances, "m", _KeyringController_createKeyring).call(this, type, data, metadata);
+        const newState = JSON.stringify(await keyring.serialize());
+        hasChanged || (hasChanged = oldState !== newState);
         await __classPrivateFieldGet(this, _KeyringController_instances, "m", _KeyringController_assertNoDuplicateAccounts).call(this, [keyring]);
         // The keyring is added to the keyrings array only if it's successfully restored
         // and the metadata is successfully added to the controller
@@ -1680,7 +1684,7 @@ async function _KeyringController_restoreKeyring(serialized) {
             keyringV2,
             metadata,
         });
-        return { keyring, keyringV2, metadata, newMetadata };
+        return { keyring, keyringV2, metadata, hasChanged };
     }
     catch (error) {
         console.error(error);
@@ -1740,7 +1744,7 @@ async function _KeyringController_persistOrRollback(callback) {
         const callbackResult = await callback({ releaseLock });
         const newState = JSON.stringify(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)) {
+        if (oldState !== newState) {
             await __classPrivateFieldGet(this, _KeyringController_instances, "m", _KeyringController_updateVault).call(this);
         }
         return callbackResult;