@metamask-previews/keyring-controller 21.0.6-preview-8a04e037 → 21.0.6-preview-aa280426

package/CHANGELOG.md

@@ -7,6 +7,16 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+### Changed
+
+- **BREAKING** `keyringsMetadata` has been removed from the controller state ([#5725](https://github.com/MetaMask/core/pull/5725))
+  - The metadata is now stored in each keyring object in the `state.keyrings` array.
+  - When updating to this version, we recommend removing the `keyringsMetadata` state and all state referencing a keyring ID with a migration. New metadata will be generated for each keyring automatically after the update.
+
+### Fixed
+
+- Keyrings with duplicate accounts are skipped as unsupported on unlock ([#5775](https://github.com/MetaMask/core/pull/5775))
+
 ## [21.0.6]
 
 ### Changed

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_getSessionState, _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_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;
 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");
@@ -122,7 +122,6 @@ const getDefaultKeyringState = () => {
     return {
         isUnlocked: false,
         keyrings: [],
-        keyringsMetadata: [],
     };
 };
 exports.getDefaultKeyringState = getDefaultKeyringState;
@@ -185,16 +184,19 @@ function isSerializedKeyringsArray(array) {
  *
  * Is used for adding the current keyrings to the state object.
  *
- * @param keyring - The keyring to display.
+ * @param keyringWithMetadata - The keyring and its metadata.
+ * @param keyringWithMetadata.keyring - The keyring to display.
+ * @param keyringWithMetadata.metadata - The metadata of the keyring.
  * @returns A keyring display object, with type and accounts properties.
  */
-async function displayForKeyring(keyring) {
+async function displayForKeyring({ keyring, metadata, }) {
     const accounts = await keyring.getAccounts();
     return {
         type: keyring.type,
         // Cast to `string[]` here is safe here because `accounts` has no nullish
         // values, and `normalize` returns `string` unless given a nullish value
         accounts: accounts.map(normalize),
+        metadata,
     };
 }
 /**
@@ -254,7 +256,6 @@ class KeyringController extends base_controller_1.BaseController {
                 vault: { persist: true, anonymous: false },
                 isUnlocked: { persist: false, anonymous: true },
                 keyrings: { persist: false, anonymous: false },
-                keyringsMetadata: { persist: true, anonymous: false },
                 encryptionKey: { persist: false, anonymous: false },
                 encryptionSalt: { persist: false, anonymous: false },
             },
@@ -272,7 +273,6 @@ class KeyringController extends base_controller_1.BaseController {
         _KeyringController_cacheEncryptionKey.set(this, void 0);
         _KeyringController_keyrings.set(this, void 0);
         _KeyringController_unsupportedKeyrings.set(this, void 0);
-        _KeyringController_keyringsMetadata.set(this, void 0);
         _KeyringController_password.set(this, void 0);
         _KeyringController_qrKeyringStateListener.set(this, void 0);
         __classPrivateFieldSet(this, _KeyringController_keyringBuilders, keyringBuilders
@@ -280,7 +280,6 @@ class KeyringController extends base_controller_1.BaseController {
             : defaultKeyringBuilders, "f");
         __classPrivateFieldSet(this, _KeyringController_encryptor, encryptor, "f");
         __classPrivateFieldSet(this, _KeyringController_keyrings, [], "f");
-        __classPrivateFieldSet(this, _KeyringController_keyringsMetadata, state?.keyringsMetadata?.slice() ?? [], "f");
         __classPrivateFieldSet(this, _KeyringController_unsupportedKeyrings, [], "f");
         // This option allows the controller to cache an exported key
         // for use in decrypting and encrypting data without password
@@ -513,7 +512,7 @@ class KeyringController extends base_controller_1.BaseController {
     async getKeyringForAccount(account) {
         __classPrivateFieldGet(this, _KeyringController_instances, "m", _KeyringController_assertIsUnlocked).call(this);
         const address = normalize(account);
-        const candidates = await Promise.all(__classPrivateFieldGet(this, _KeyringController_keyrings, "f").map(async (keyring) => {
+        const candidates = await Promise.all(__classPrivateFieldGet(this, _KeyringController_keyrings, "f").map(async ({ keyring }) => {
             return Promise.all([keyring, keyring.getAccounts()]);
         }));
         const winners = candidates.filter((candidate) => {
@@ -544,7 +543,9 @@ class KeyringController extends base_controller_1.BaseController {
      */
     getKeyringsByType(type) {
         __classPrivateFieldGet(this, _KeyringController_instances, "m", _KeyringController_assertIsUnlocked).call(this);
-        return __classPrivateFieldGet(this, _KeyringController_keyrings, "f").filter((keyring) => keyring.type === type);
+        return __classPrivateFieldGet(this, _KeyringController_keyrings, "f")
+            .filter(({ keyring }) => keyring.type === type)
+            .map(({ keyring }) => keyring);
     }
     /**
      * Persist all serialized keyrings in the vault.
@@ -865,10 +866,25 @@ class KeyringController extends base_controller_1.BaseController {
      * @returns Promise resolving when the operation completes.
      */
     async submitEncryptionKey(encryptionKey, encryptionSalt) {
-        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, undefined, encryptionKey, encryptionSalt), "f");
+        const { newMetadata } = await __classPrivateFieldGet(this, _KeyringController_instances, "m", _KeyringController_withRollback).call(this, async () => {
+            const result = await __classPrivateFieldGet(this, _KeyringController_instances, "m", _KeyringController_unlockKeyrings).call(this, undefined, encryptionKey, encryptionSalt);
             __classPrivateFieldGet(this, _KeyringController_instances, "m", _KeyringController_setUnlocked).call(this);
+            return result;
         });
+        try {
+            // 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) {
+                    await __classPrivateFieldGet(this, _KeyringController_instances, "m", _KeyringController_updateVault).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 update vault during login:', error);
+        }
     }
     /**
      * Attempts to decrypt the current vault and load its keyrings,
@@ -878,19 +894,25 @@ 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 () => {
-            __classPrivateFieldSet(this, _KeyringController_keyrings, await __classPrivateFieldGet(this, _KeyringController_instances, "m", _KeyringController_unlockKeyrings).call(this, password), "f");
+        const { newMetadata } = 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, we
+            // If there are stronger encryption params available, or
+            // 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 () => __classPrivateFieldGet(this, _KeyringController_instances, "m", _KeyringController_upgradeVaultEncryptionParams).call(this));
+            await __classPrivateFieldGet(this, _KeyringController_instances, "m", _KeyringController_withRollback).call(this, async () => {
+                if (newMetadata || __classPrivateFieldGet(this, _KeyringController_instances, "m", _KeyringController_isNewEncryptionAvailable).call(this)) {
+                    await __classPrivateFieldGet(this, _KeyringController_instances, "m", _KeyringController_updateVault).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);
+            console.error('Failed to update vault during login:', error);
         }
     }
     /**
@@ -1137,7 +1159,7 @@ class KeyringController extends base_controller_1.BaseController {
     }
 }
 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_keyringsMetadata = 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_qrKeyringStateListener = 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));
@@ -1154,17 +1176,19 @@ _KeyringController_controllerOperationMutex = new WeakMap(), _KeyringController_
     this.messagingSystem.registerActionHandler(`${name}:addNewAccount`, this.addNewAccount.bind(this));
     this.messagingSystem.registerActionHandler(`${name}:withKeyring`, this.withKeyring.bind(this));
 }, _KeyringController_getKeyringById = function _KeyringController_getKeyringById(keyringId) {
-    const index = this.state.keyringsMetadata.findIndex((metadata) => metadata.id === keyringId);
-    return __classPrivateFieldGet(this, _KeyringController_keyrings, "f")[index];
+    return __classPrivateFieldGet(this, _KeyringController_keyrings, "f").find(({ metadata }) => metadata.id === keyringId)
+        ?.keyring;
 }, _KeyringController_getKeyringByIdOrDefault = function _KeyringController_getKeyringByIdOrDefault(keyringId) {
     if (!keyringId) {
-        return __classPrivateFieldGet(this, _KeyringController_keyrings, "f")[0];
+        return __classPrivateFieldGet(this, _KeyringController_keyrings, "f")[0]?.keyring;
     }
     return __classPrivateFieldGet(this, _KeyringController_instances, "m", _KeyringController_getKeyringById).call(this, keyringId);
 }, _KeyringController_getKeyringMetadata = function _KeyringController_getKeyringMetadata(keyring) {
-    const index = __classPrivateFieldGet(this, _KeyringController_keyrings, "f").findIndex((keyringCandidate) => keyringCandidate === keyring);
-    (0, utils_1.assert)(index !== -1, constants_1.KeyringControllerError.KeyringNotFound);
-    return __classPrivateFieldGet(this, _KeyringController_keyringsMetadata, "f")[index];
+    const keyringWithMetadata = __classPrivateFieldGet(this, _KeyringController_keyrings, "f").find((candidate) => candidate.keyring === keyring);
+    if (!keyringWithMetadata) {
+        throw new Error(constants_1.KeyringControllerError.KeyringNotFound);
+    }
+    return keyringWithMetadata.metadata;
 }, _KeyringController_getKeyringBuilderForType = function _KeyringController_getKeyringBuilderForType(type) {
     return __classPrivateFieldGet(this, _KeyringController_keyringBuilders, "f").find((keyringBuilder) => keyringBuilder.type === type);
 }, _KeyringController_addQRKeyring = 
@@ -1217,7 +1241,6 @@ async function _KeyringController_createNewVaultWithKeyring(password, keyring) {
     });
     __classPrivateFieldSet(this, _KeyringController_password, password, "f");
     await __classPrivateFieldGet(this, _KeyringController_instances, "m", _KeyringController_clearKeyrings).call(this);
-    __classPrivateFieldSet(this, _KeyringController_keyringsMetadata, [], "f");
     await __classPrivateFieldGet(this, _KeyringController_instances, "m", _KeyringController_createKeyringWithFirstAccount).call(this, keyring.type, keyring.opts);
     __classPrivateFieldGet(this, _KeyringController_instances, "m", _KeyringController_setUnlocked).call(this);
 }, _KeyringController_verifySeedPhrase = 
@@ -1287,12 +1310,12 @@ async function _KeyringController_getUpdatedKeyrings() {
 async function _KeyringController_getSerializedKeyrings({ includeUnsupported } = {
     includeUnsupported: true,
 }) {
-    const serializedKeyrings = await Promise.all(__classPrivateFieldGet(this, _KeyringController_keyrings, "f").map(async (keyring) => {
-        const [type, data] = await Promise.all([
-            keyring.type,
-            keyring.serialize(),
-        ]);
-        return { type, data };
+    const serializedKeyrings = await Promise.all(__classPrivateFieldGet(this, _KeyringController_keyrings, "f").map(async ({ keyring, metadata }) => {
+        return {
+            type: keyring.type,
+            data: await keyring.serialize(),
+            metadata,
+        };
     }));
     if (includeUnsupported) {
         serializedKeyrings.push(...__classPrivateFieldGet(this, _KeyringController_unsupportedKeyrings, "f"));
@@ -1308,7 +1331,6 @@ async function _KeyringController_getSerializedKeyrings({ includeUnsupported } =
 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 = 
@@ -1316,12 +1338,23 @@ async function _KeyringController_getSessionState() {
  * Restore a serialized keyrings array.
  *
  * @param serializedKeyrings - The serialized keyrings array.
+ * @returns The restored keyrings.
  */
 async function _KeyringController_restoreSerializedKeyrings(serializedKeyrings) {
     await __classPrivateFieldGet(this, _KeyringController_instances, "m", _KeyringController_clearKeyrings).call(this);
+    const keyrings = [];
+    let newMetadata = false;
     for (const serializedKeyring of serializedKeyrings) {
-        await __classPrivateFieldGet(this, _KeyringController_instances, "m", _KeyringController_restoreKeyring).call(this, serializedKeyring);
+        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;
+            }
+        }
     }
+    return { keyrings, newMetadata };
 }, _KeyringController_unlockKeyrings = 
 /**
  * Unlock Keyrings, decrypting the vault and deserializing all
@@ -1378,12 +1411,7 @@ async function _KeyringController_unlockKeyrings(password, encryptionKey, encryp
         if (!isSerializedKeyringsArray(vault)) {
             throw new Error(constants_1.KeyringControllerError.VaultDataError);
         }
-        await __classPrivateFieldGet(this, _KeyringController_instances, "m", _KeyringController_restoreSerializedKeyrings).call(this, vault);
-        // The keyrings array and the keyringsMetadata array should
-        // always have the same length while the controller is unlocked.
-        if (__classPrivateFieldGet(this, _KeyringController_keyrings, "f").length !== __classPrivateFieldGet(this, _KeyringController_keyringsMetadata, "f").length) {
-            throw new Error(constants_1.KeyringControllerError.KeyringMetadataLengthMismatch);
-        }
+        const { keyrings, newMetadata } = 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;
@@ -1392,7 +1420,7 @@ async function _KeyringController_unlockKeyrings(password, encryptionKey, encryp
                 state.encryptionSalt = updatedState.encryptionSalt;
             }
         });
-        return __classPrivateFieldGet(this, _KeyringController_keyrings, "f");
+        return { keyrings, newMetadata };
     });
 }, _KeyringController_updateVault = function _KeyringController_updateVault() {
     return __classPrivateFieldGet(this, _KeyringController_instances, "m", _KeyringController_withVaultLock).call(this, async () => {
@@ -1436,13 +1464,9 @@ async function _KeyringController_unlockKeyrings(password, encryptionKey, encryp
             throw new Error(constants_1.KeyringControllerError.MissingVaultData);
         }
         const updatedKeyrings = await __classPrivateFieldGet(this, _KeyringController_instances, "m", _KeyringController_getUpdatedKeyrings).call(this);
-        if (updatedKeyrings.length !== __classPrivateFieldGet(this, _KeyringController_keyringsMetadata, "f").length) {
-            throw new Error(constants_1.KeyringControllerError.KeyringMetadataLengthMismatch);
-        }
         this.update((state) => {
             state.vault = updatedState.vault;
             state.keyrings = updatedKeyrings;
-            state.keyringsMetadata = __classPrivateFieldGet(this, _KeyringController_keyringsMetadata, "f").slice();
             if (updatedState.encryptionKey) {
                 state.encryptionKey = updatedState.encryptionKey;
                 state.encryptionSalt = JSON.parse(updatedState.vault).salt;
@@ -1450,31 +1474,23 @@ 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() {
-    __classPrivateFieldGet(this, _KeyringController_instances, "m", _KeyringController_assertControllerMutexIsLocked).call(this);
+}, _KeyringController_isNewEncryptionAvailable = function _KeyringController_isNewEncryptionAvailable() {
     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);
+    if (!vault || !__classPrivateFieldGet(this, _KeyringController_password, "f") || !__classPrivateFieldGet(this, _KeyringController_encryptor, "f").isVaultUpdated) {
+        return false;
     }
+    return !__classPrivateFieldGet(this, _KeyringController_encryptor, "f").isVaultUpdated(vault);
 }, _KeyringController_getAccountsFromKeyrings = 
 /**
  * Retrieves all the accounts from keyrings instances
  * that are currently in memory.
  *
+ * @param additionalKeyrings - Additional keyrings to include in the search.
  * @returns A promise resolving to an array of accounts.
  */
-async function _KeyringController_getAccountsFromKeyrings() {
-    const keyrings = __classPrivateFieldGet(this, _KeyringController_keyrings, "f");
-    const keyringArrays = await Promise.all(keyrings.map(async (keyring) => keyring.getAccounts()));
+async function _KeyringController_getAccountsFromKeyrings(additionalKeyrings = []) {
+    const keyrings = __classPrivateFieldGet(this, _KeyringController_keyrings, "f").map(({ keyring }) => keyring);
+    const keyringArrays = await Promise.all([...keyrings, ...additionalKeyrings].map(async (keyring) => keyring.getAccounts()));
     const addresses = keyringArrays.reduce((res, arr) => {
         return res.concat(arr);
     }, []);
@@ -1514,11 +1530,7 @@ async function _KeyringController_createKeyringWithFirstAccount(type, opts) {
  */
 async function _KeyringController_newKeyring(type, data) {
     const keyring = await __classPrivateFieldGet(this, _KeyringController_instances, "m", _KeyringController_createKeyring).call(this, type, data);
-    if (__classPrivateFieldGet(this, _KeyringController_keyrings, "f").length !== __classPrivateFieldGet(this, _KeyringController_keyringsMetadata, "f").length) {
-        throw new Error('Keyring metadata missing');
-    }
-    __classPrivateFieldGet(this, _KeyringController_keyrings, "f").push(keyring);
-    __classPrivateFieldGet(this, _KeyringController_keyringsMetadata, "f").push(getDefaultKeyringMetadata());
+    __classPrivateFieldGet(this, _KeyringController_keyrings, "f").push({ keyring, metadata: getDefaultKeyringMetadata() });
     return keyring;
 }, _KeyringController_createKeyring = 
 /**
@@ -1575,7 +1587,7 @@ async function _KeyringController_createKeyring(type, data) {
  */
 async function _KeyringController_clearKeyrings() {
     __classPrivateFieldGet(this, _KeyringController_instances, "m", _KeyringController_assertControllerMutexIsLocked).call(this);
-    for (const keyring of __classPrivateFieldGet(this, _KeyringController_keyrings, "f")) {
+    for (const { keyring } of __classPrivateFieldGet(this, _KeyringController_keyrings, "f")) {
         await __classPrivateFieldGet(this, _KeyringController_instances, "m", _KeyringController_destroyKeyring).call(this, keyring);
     }
     __classPrivateFieldSet(this, _KeyringController_keyrings, [], "f");
@@ -1591,18 +1603,24 @@ async function _KeyringController_clearKeyrings() {
 async function _KeyringController_restoreKeyring(serialized) {
     __classPrivateFieldGet(this, _KeyringController_instances, "m", _KeyringController_assertControllerMutexIsLocked).call(this);
     try {
-        const { type, data } = serialized;
+        const { type, data, metadata: serializedMetadata } = serialized;
+        let newMetadata = false;
+        let metadata = serializedMetadata;
         const keyring = await __classPrivateFieldGet(this, _KeyringController_instances, "m", _KeyringController_createKeyring).call(this, type, data);
+        await __classPrivateFieldGet(this, _KeyringController_instances, "m", _KeyringController_assertNoDuplicateAccounts).call(this, [keyring]);
         // If metadata is missing, assume the data is from an installation before
         // we had keyring metadata.
-        if (__classPrivateFieldGet(this, _KeyringController_keyringsMetadata, "f").length <= __classPrivateFieldGet(this, _KeyringController_keyrings, "f").length) {
-            console.log(`Adding missing metadata for '${type}' keyring`);
-            __classPrivateFieldGet(this, _KeyringController_keyringsMetadata, "f").push(getDefaultKeyringMetadata());
+        if (!metadata) {
+            newMetadata = true;
+            metadata = getDefaultKeyringMetadata();
         }
         // The keyring is added to the keyrings array only if it's successfully restored
         // and the metadata is successfully added to the controller
-        __classPrivateFieldGet(this, _KeyringController_keyrings, "f").push(keyring);
-        return keyring;
+        __classPrivateFieldGet(this, _KeyringController_keyrings, "f").push({
+            keyring,
+            metadata,
+        });
+        return { keyring, metadata, newMetadata };
     }
     catch (error) {
         console.error(error);
@@ -1631,30 +1649,28 @@ async function _KeyringController_destroyKeyring(keyring) {
 async function _KeyringController_removeEmptyKeyrings() {
     __classPrivateFieldGet(this, _KeyringController_instances, "m", _KeyringController_assertControllerMutexIsLocked).call(this);
     const validKeyrings = [];
-    const validKeyringMetadata = [];
     // Since getAccounts returns a Promise
     // We need to wait to hear back form each keyring
     // in order to decide which ones are now valid (accounts.length > 0)
-    await Promise.all(__classPrivateFieldGet(this, _KeyringController_keyrings, "f").map(async (keyring, index) => {
+    await Promise.all(__classPrivateFieldGet(this, _KeyringController_keyrings, "f").map(async ({ keyring, metadata }) => {
         const accounts = await keyring.getAccounts();
         if (accounts.length > 0) {
-            validKeyrings.push(keyring);
-            validKeyringMetadata.push(__classPrivateFieldGet(this, _KeyringController_keyringsMetadata, "f")[index]);
+            validKeyrings.push({ keyring, metadata });
         }
         else {
             await __classPrivateFieldGet(this, _KeyringController_instances, "m", _KeyringController_destroyKeyring).call(this, keyring);
         }
     }));
     __classPrivateFieldSet(this, _KeyringController_keyrings, validKeyrings, "f");
-    __classPrivateFieldSet(this, _KeyringController_keyringsMetadata, validKeyringMetadata, "f");
 }, _KeyringController_assertNoDuplicateAccounts = 
 /**
  * Assert that there are no duplicate accounts in the keyrings.
  *
+ * @param additionalKeyrings - Additional keyrings to include in the check.
  * @throws If there are duplicate accounts.
  */
-async function _KeyringController_assertNoDuplicateAccounts() {
-    const accounts = await __classPrivateFieldGet(this, _KeyringController_instances, "m", _KeyringController_getAccountsFromKeyrings).call(this);
+async function _KeyringController_assertNoDuplicateAccounts(additionalKeyrings = []) {
+    const accounts = await __classPrivateFieldGet(this, _KeyringController_instances, "m", _KeyringController_getAccountsFromKeyrings).call(this, additionalKeyrings);
     if (new Set(accounts).size !== accounts.length) {
         throw new Error(constants_1.KeyringControllerError.DuplicatedAccount);
     }
@@ -1662,11 +1678,6 @@ async function _KeyringController_assertNoDuplicateAccounts() {
     __classPrivateFieldGet(this, _KeyringController_instances, "m", _KeyringController_assertControllerMutexIsLocked).call(this);
     this.update((state) => {
         state.isUnlocked = true;
-        // If new keyringsMetadata was generated during the unlock operation,
-        // we'll have to update the state with the new array
-        if (__classPrivateFieldGet(this, _KeyringController_keyringsMetadata, "f").length > state.keyringsMetadata.length) {
-            state.keyringsMetadata = __classPrivateFieldGet(this, _KeyringController_keyringsMetadata, "f").slice();
-        }
     });
     this.messagingSystem.publish(`${name}:unlock`);
 }, _KeyringController_assertIsUnlocked = function _KeyringController_assertIsUnlocked() {
@@ -1705,13 +1716,11 @@ async function _KeyringController_withRollback(callback) {
     return __classPrivateFieldGet(this, _KeyringController_instances, "m", _KeyringController_withControllerLock).call(this, async ({ releaseLock }) => {
         const currentSerializedKeyrings = await __classPrivateFieldGet(this, _KeyringController_instances, "m", _KeyringController_getSerializedKeyrings).call(this);
         const currentPassword = __classPrivateFieldGet(this, _KeyringController_password, "f");
-        const currentKeyringsMetadata = __classPrivateFieldGet(this, _KeyringController_keyringsMetadata, "f").slice();
         try {
             return await callback({ releaseLock });
         }
         catch (e) {
             // Keyrings and password are restored to their previous state
-            __classPrivateFieldSet(this, _KeyringController_keyringsMetadata, currentKeyringsMetadata, "f");
             __classPrivateFieldSet(this, _KeyringController_password, currentPassword, "f");
             await __classPrivateFieldGet(this, _KeyringController_instances, "m", _KeyringController_restoreSerializedKeyrings).call(this, currentSerializedKeyrings);
             throw e;