fix: discard duplicate accounts on unlock

app/scripts/controllers/mmi-controller.test.ts

@@ -177,7 +177,6 @@ describe('MMIController', function () {
       state: {
         keyrings: [],
         isUnlocked: true,
-        keyringsMetadata: [],
       },
       encryptor: {
         encrypt(_, object) {

app/scripts/controllers/preferences-controller.test.ts

@@ -153,12 +153,10 @@ describe('preferences controller', () => {
             {
               type: 'HD Key Tree',
               accounts: [firstAddress, secondAddress],
-            },
-          ],
-          keyringsMetadata: [
-            {
-              id: '01JKDGGBRE3DGZA7N1PZJSQK4W',
-              name: '',
+              metadata: {
+                id: '01JKDGGBRE3DGZA7N1PZJSQK4W',
+                name: '',
+              },
             },
           ],
         },
@@ -204,12 +202,10 @@ describe('preferences controller', () => {
             {
               type: 'HD Key Tree',
               accounts: [firstAddress, secondAddress],
-            },
-          ],
-          keyringsMetadata: [
-            {
-              id: '01JKDGGBRE3DGZA7N1PZJSQK4W',
-              name: '',
+              metadata: {
+                id: '01JKDGGBRE3DGZA7N1PZJSQK4W',
+                name: '',
+              },
             },
           ],
         },
@@ -261,12 +257,10 @@ describe('preferences controller', () => {
             {
               type: 'HD Key Tree',
               accounts: [firstAddress, secondAddress],
-            },
-          ],
-          keyringsMetadata: [
-            {
-              id: '01JKDGGBRE3DGZA7N1PZJSQK4W',
-              name: '',
+              metadata: {
+                id: '01JKDGGBRE3DGZA7N1PZJSQK4W',
+                name: '',
+              },
             },
           ],
         },
@@ -302,12 +296,10 @@ describe('preferences controller', () => {
             {
               type: 'HD Key Tree',
               accounts: [firstAddress, secondAddress],
-            },
-          ],
-          keyringsMetadata: [
-            {
-              id: '01JKDGGBRE3DGZA7N1PZJSQK4W',
-              name: '',
+              metadata: {
+                id: '01JKDGGBRE3DGZA7N1PZJSQK4W',
+                name: '',
+              },
             },
           ],
         },
@@ -512,12 +504,10 @@ describe('preferences controller', () => {
             {
               type: 'HD Key Tree',
               accounts: [firstAddress, secondAddress],
-            },
-          ],
-          keyringsMetadata: [
-            {
-              id: '01JKDGGBRE3DGZA7N1PZJSQK4W',
-              name: '',
+              metadata: {
+                id: '01JKDGGBRE3DGZA7N1PZJSQK4W',
+                name: '',
+              },
             },
           ],
         },

app/scripts/metamask-controller.actions.test.js

@@ -211,18 +211,19 @@ describe('MetaMaskController', function () {
       const result2 = metamaskController.keyringController.state;
 
       // On restore, a new keyring metadata is generated.
-      expect(result1.keyringsMetadata[0].id).toBe(mockULIDs[0]);
-      expect(result2).toStrictEqual(
-        expect.objectContaining({
-          ...result1,
-          keyringsMetadata: [
-            {
+      expect(result1.keyrings[0].metadata.id).toBe(mockULIDs[0]);
+      expect(result2).toStrictEqual({
+        ...result1,
+        keyrings: [
+          {
+            ...result1.keyrings[0],
+            metadata: {
+              ...result1.keyrings[0].metadata,
               id: mockULIDs[1],
-              name: '',
             },
-          ],
-        }),
-      );
+          },
+        ],
+      });
     });
   });
 

app/scripts/metamask-controller.js

@@ -7055,8 +7055,8 @@ export default class MetamaskController extends EventEmitter {
             .map((keyring, index) => {
               if (keyring.type === KeyringTypes.hd) {
                 return {
-                  id: state.keyringsMetadata[index].id,
-                  name: state.keyringsMetadata[index].name,
+                  id: keyring.metadata.id,
+                  name: keyring.metadata.name,
                   type: 'mnemonic',
                   primary: index === 0,
                 };

app/scripts/metamask-controller.test.js

@@ -3992,10 +3992,9 @@ describe('MetaMaskController', () => {
           metamaskController.keyringController.state.keyrings;
 
         const newlyAddedKeyringId =
-          metamaskController.keyringController.state.keyringsMetadata[
-            metamaskController.keyringController.state.keyringsMetadata.length -
-              2 // -1 for the snap keyring, -1 for the newly added keyring
-          ].id;
+          metamaskController.keyringController.state.keyrings[
+            metamaskController.keyringController.state.keyrings.length - 2 // -1 for the snap keyring, -1 for the newly added keyring
+          ].metadata.id;
 
         const newSRP = Buffer.from(
           await metamaskController.getSeedPhrase(password, newlyAddedKeyringId),

lavamoat/browserify/beta/policy.json

@@ -1678,8 +1678,7 @@
     },
     "@metamask/keyring-controller": {
       "globals": {
-        "console.error": true,
-        "console.log": true
+        "console.error": true
       },
       "packages": {
         "@ethereumjs/tx>@ethereumjs/util": true,
@@ -1691,6 +1690,7 @@
         "@metamask/utils": true,
         "@metamask/name-controller>async-mutex": true,
         "@metamask/keyring-controller>ethereumjs-wallet": true,
+        "lodash": true,
         "@metamask/keyring-controller>ulid": true
       }
     },

lavamoat/browserify/flask/policy.json

@@ -1678,8 +1678,7 @@
     },
     "@metamask/keyring-controller": {
       "globals": {
-        "console.error": true,
-        "console.log": true
+        "console.error": true
       },
       "packages": {
         "@ethereumjs/tx>@ethereumjs/util": true,
@@ -1691,6 +1690,7 @@
         "@metamask/utils": true,
         "@metamask/name-controller>async-mutex": true,
         "@metamask/keyring-controller>ethereumjs-wallet": true,
+        "lodash": true,
         "@metamask/keyring-controller>ulid": true
       }
     },

lavamoat/browserify/main/policy.json

@@ -1678,8 +1678,7 @@
     },
     "@metamask/keyring-controller": {
       "globals": {
-        "console.error": true,
-        "console.log": true
+        "console.error": true
       },
       "packages": {
         "@ethereumjs/tx>@ethereumjs/util": true,
@@ -1691,6 +1690,7 @@
         "@metamask/utils": true,
         "@metamask/name-controller>async-mutex": true,
         "@metamask/keyring-controller>ethereumjs-wallet": true,
+        "lodash": true,
         "@metamask/keyring-controller>ulid": true
       }
     },

lavamoat/browserify/mmi/policy.json

@@ -1809,8 +1809,7 @@
     },
     "@metamask/keyring-controller": {
       "globals": {
-        "console.error": true,
-        "console.log": true
+        "console.error": true
       },
       "packages": {
         "@ethereumjs/tx>@ethereumjs/util": true,
@@ -1822,6 +1821,7 @@
         "@metamask/utils": true,
         "@metamask/name-controller>async-mutex": true,
         "@metamask/keyring-controller>ethereumjs-wallet": true,
+        "lodash": true,
         "@metamask/keyring-controller>ulid": true
       }
     },

package.json

@@ -229,7 +229,9 @@
     "gridplus-sdk/elliptic": "^6.6.1",
     "@ethereumjs/tx": "patch:@ethereumjs/tx@npm%3A5.4.0#~/.yarn/patches/@ethereumjs-tx-npm-5.4.0-0c4a0f973e.patch",
     "@keystonehq/metamask-airgapped-keyring": "patch:@keystonehq/metamask-airgapped-keyring@npm%3A0.15.2#~/.yarn/patches/@keystonehq-metamask-airgapped-keyring-npm-0.15.2-94dd4b40d7.patch",
-    "@trezor/connect-web": "~9.4.7"
+    "@trezor/connect-web": "~9.4.7",
+    "@metamask/keyring-controller": "npm:@metamask-previews/[email protected]",
+    "@metamask/accounts-controller": "npm:@metamask-previews/[email protected]"
   },
   "dependencies": {
     "@babel/runtime": "patch:@babel/runtime@npm%3A7.25.9#~/.yarn/patches/@babel-runtime-npm-7.25.9-fe8c62510a.patch",

shared/lib/keyring.ts

@@ -1,18 +1,13 @@
-import {
-  KeyringObject,
-  KeyringMetadata,
-  KeyringTypes,
-} from '@metamask/keyring-controller';
+import { KeyringObject, KeyringTypes } from '@metamask/keyring-controller';
 import { isEqualCaseInsensitive } from '../modules/string-utils';
 
 // TODO: This kind of logic should be inside the `KeyringController` (using `KeyringSelector` query, or make `addNewKeyring` returns it keyring ID alongside
 
 export function findKeyringId(
   keyrings: KeyringObject[],
-  keyringsMetadata: KeyringMetadata[],
   selector: { address?: string; type?: KeyringTypes },
 ): string {
-  const keyringIndex = keyrings.findIndex((keyring) => {
+  const keyring = keyrings.find((keyring) => {
     if (selector.address && selector.type) {
       return (
         keyring.accounts.some((account) =>
@@ -31,17 +26,16 @@
 
     throw new Error('Must provide either address or type selector');
   });
-  if (keyringIndex === -1) {
+  if (!keyring) {
     throw new Error('Could not find keyring with specified criteria');
   }
 
-  return keyringsMetadata[keyringIndex].id;
+  return keyring.metadata.id;
 }
 
 export function findKeyringIdByAddress(
   keyrings: KeyringObject[],
-  keyringsMetadata: KeyringMetadata[],
   address: string,
 ): string {
-  return findKeyringId(keyrings, keyringsMetadata, { address });
+  return findKeyringId(keyrings, { address });
 }

test/data/mock-send-state.json

@@ -262,29 +262,27 @@
         "accounts": [
           "0x0dcd5d886577d5081b0c52e242ef29e70be3e7bc",
           "0xec1adf982415d2ef5ec55899b9bfb8bc0f29251b"
-        ]
+        ],
+        "metadata": {
+          "id": "01JKAF3DSGM3AB87EM9N0K41AJ",
+          "name": ""
+        }
       },
       {
         "type": "Ledger Hardware",
-        "accounts": ["0xc42edfcc21ed14dda456aa0756c153f7985d8813"]
+        "accounts": ["0xc42edfcc21ed14dda456aa0756c153f7985d8813"],
+        "metadata": {
+          "id": "01JKAF3KP7VPAG0YXEDTDRB6ZV",
+          "name": ""
+        }
       },
       {
         "type": "Simple Key Pair",
-        "accounts": ["0xeb9e64b93097bc15f01f13eae97015c57ab64823"]
-      }
-    ],
-    "keyringsMetadata": [
-      {
-        "id": "01JKAF3DSGM3AB87EM9N0K41AJ",
-        "name": ""
-      },
-      {
-        "id": "01JKAF3KP7VPAG0YXEDTDRB6ZV",
-        "name": ""
-      },
-      {
-        "id": "01JKAF3PJ247KAM6C03G5Q0NP8",
-        "name": ""
+        "accounts": ["0xeb9e64b93097bc15f01f13eae97015c57ab64823"],
+        "metadata": {
+          "id": "01JKAF3PJ247KAM6C03G5Q0NP8",
+          "name": ""
+        }
       }
     ],
     "identities": {

test/data/mock-state.json

@@ -622,45 +622,43 @@
         "accounts": [
           "0x0dcd5d886577d5081b0c52e242ef29e70be3e7bc",
           "0xec1adf982415d2ef5ec55899b9bfb8bc0f29251b"
-        ]
+        ],
+        "metadata": {
+          "id": "01JKAF3DSGM3AB87EM9N0K41AJ",
+          "name": ""
+        }
       },
       {
         "type": "Ledger Hardware",
-        "accounts": ["0xc42edfcc21ed14dda456aa0756c153f7985d8813"]
+        "accounts": ["0xc42edfcc21ed14dda456aa0756c153f7985d8813"],
+        "metadata": {
+          "id": "01JKAF3KP7VPAG0YXEDTDRB6ZV",
+          "name": ""
+        }
       },
       {
         "type": "Simple Key Pair",
-        "accounts": ["0xeb9e64b93097bc15f01f13eae97015c57ab64823"]
+        "accounts": ["0xeb9e64b93097bc15f01f13eae97015c57ab64823"],
+        "metadata": {
+          "id": "01JKAF3PJ247KAM6C03G5Q0NP8",
+          "name": ""
+        }
       },
       {
         "type": "Snap Keyring",
-        "accounts": ["0xb552685e3d2790efd64a175b00d51f02cdafee5d"]
+        "accounts": ["0xb552685e3d2790efd64a175b00d51f02cdafee5d"],
+        "metadata": {
+          "id": "01JKAF3SSWRQK818R830GE8PHX",
+          "name": ""
+        }
       },
       {
         "type": "Custody test",
-        "accounts": ["0xca8f1F0245530118D0cf14a06b01Daf8f76Cf281"]
-      }
-    ],
-    "keyringsMetadata": [
-      {
-        "id": "01JKAF3DSGM3AB87EM9N0K41AJ",
-        "name": ""
-      },
-      {
-        "id": "01JKAF3KP7VPAG0YXEDTDRB6ZV",
-        "name": ""
-      },
-      {
-        "id": "01JKAF3PJ247KAM6C03G5Q0NP8",
-        "name": ""
-      },
-      {
-        "id": "01JKAF3SSWRQK818R830GE8PHX",
-        "name": ""
-      },
-      {
-        "id": "01JKAF3WYGWF7JX6PC4YYVSK2Q",
-        "name": ""
+        "accounts": ["0xca8f1F0245530118D0cf14a06b01Daf8f76Cf281"],
+        "metadata": {
+          "id": "01JKAF3WYGWF7JX6PC4YYVSK2Q",
+          "name": ""
+        }
       }
     ],
     "identities": {

test/e2e/tests/metrics/state-snapshots/errors-after-init-opt-in-background-state.json

@@ -125,7 +125,6 @@
   "KeyringController": {
     "isUnlocked": true,
     "keyrings": "object",
-    "keyringsMetadata": "object",
     "vault": "string",
     "encryptionKey": "string",
     "encryptionSalt": "string"