@metamask-previews/keyring-controller 21.0.4-preview-28cd3de3 → 21.0.4-preview-f603e07

package/CHANGELOG.md

@@ -9,6 +9,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ### Changed
 
+- Don't emit `: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))
 
 ## [21.0.4]

package/dist/KeyringController.cjs

@@ -49,6 +49,7 @@ const utils_1 = require("@metamask/utils");
 const async_mutex_1 = require("async-mutex");
 const ethereumjs_wallet_1 = __importStar(require("ethereumjs-wallet"));
 // When generating a ULID within the same millisecond, monotonicFactory provides some guarantees regarding sort order.
+const lodash_1 = require("lodash");
 const ulid_1 = require("ulid");
 const constants_1 = require("./constants.cjs");
 const name = 'KeyringController';
@@ -893,8 +894,9 @@ class KeyringController extends base_controller_1.BaseController {
         createIfMissing: false,
     }) {
         __classPrivateFieldGet(this, _KeyringController_instances, "m", _KeyringController_assertIsUnlocked).call(this);
-        return __classPrivateFieldGet(this, _KeyringController_instances, "m", _KeyringController_persistOrRollback).call(this, async () => {
+        return __classPrivateFieldGet(this, _KeyringController_instances, "m", _KeyringController_withRollback).call(this, async () => {
             let keyring;
+            let forceUpdate = false;
             if ('address' in selector) {
                 keyring = (await this.getKeyringForAccount(selector.address));
             }
@@ -902,6 +904,8 @@ class KeyringController extends base_controller_1.BaseController {
                 keyring = this.getKeyringsByType(selector.type)[selector.index || 0];
                 if (!keyring && options.createIfMissing) {
                     keyring = (await __classPrivateFieldGet(this, _KeyringController_instances, "m", _KeyringController_newKeyring).call(this, selector.type, options.createWithData));
+                    // This is a new keyring, so we force the vault update in that case.
+                    forceUpdate = true;
                 }
             }
             else if ('id' in selector) {
@@ -910,6 +914,7 @@ class KeyringController extends base_controller_1.BaseController {
             if (!keyring) {
                 throw new Error(constants_1.KeyringControllerError.KeyringNotFound);
             }
+            const oldKeyringState = await keyring.serialize();
             const result = await operation({
                 keyring,
                 metadata: __classPrivateFieldGet(this, _KeyringController_instances, "m", _KeyringController_getKeyringMetadata).call(this, keyring),
@@ -921,6 +926,10 @@ class KeyringController extends base_controller_1.BaseController {
                 // as a way to get a reference to a keyring instance.
                 throw new Error(constants_1.KeyringControllerError.UnsafeDirectKeyringAccess);
             }
+            if (forceUpdate || !(0, lodash_1.isEqual)(oldKeyringState, await keyring.serialize())) {
+                // Keyring has been updated, we need to update the vault.
+                await __classPrivateFieldGet(this, _KeyringController_instances, "m", _KeyringController_updateVault).call(this);
+            }
             return result;
         });
     }