Support keyring metadata in KeyringController

eslint-warning-thresholds.json

@@ -242,13 +242,12 @@
     "n/no-unsupported-features/node-builtins": 1
   },
   "packages/keyring-controller/src/KeyringController.test.ts": {
-    "import-x/namespace": 16,
+    "import-x/namespace": 14,
     "jest/no-conditional-in-test": 8
   },
   "packages/keyring-controller/src/KeyringController.ts": {
     "@typescript-eslint/no-unsafe-enum-comparison": 5,
-    "@typescript-eslint/no-unused-vars": 2,
-    "jsdoc/tag-lines": 1
+    "@typescript-eslint/no-unused-vars": 2
   },
   "packages/keyring-controller/tests/mocks/mockKeyring.ts": {
     "@typescript-eslint/prefer-readonly": 1

packages/accounts-controller/src/AccountsController.test.ts

@@ -22,7 +22,7 @@
 import type { SnapControllerState } from '@metamask/snaps-controllers';
 import { SnapStatus } from '@metamask/snaps-utils';
 import type { CaipChainId } from '@metamask/utils';
 import * as uuid from 'uuid';
 import type { V4Options } from 'uuid';
 
 import type {
@@ -540,6 +540,12 @@
             accounts: [mockAccount.address],
           },
         ],
+        keyringsMetadata: [
+          {
+            id: 'mock-id',
+            name: 'mock-name',
+          },
+        ],
       };
 
       messenger.publish(
@@ -564,7 +570,7 @@
 
       messenger.publish(
         'KeyringController:stateChange',
-        { isUnlocked: true, keyrings: [] },
+        { isUnlocked: true, keyrings: [], keyringsMetadata: [] },
         [],
       );
 
@@ -582,6 +588,13 @@
           {
             accounts: [mockAccount.address, mockAccount2.address],
             type: KeyringTypes.hd,
+            id: '123',
+          },
+        ],
+        keyringsMetadata: [
+          {
+            id: 'mock-id',
+            name: 'mock-name',
           },
         ],
       };
@@ -620,6 +633,12 @@
               accounts: [mockAccount.address, mockAccount2.address],
             },
           ],
+          keyringsMetadata: [
+            {
+              id: 'mock-id',
+              name: 'mock-name',
+            },
+          ],
         };
         const { accountsController } = setupAccountsController({
           initialState: {
@@ -677,6 +696,16 @@
               accounts: [mockAccount3.address, mockAccount4.address],
             },
           ],
+          keyringsMetadata: [
+            {
+              id: 'mock-id',
+              name: 'mock-name',
+            },
+            {
+              id: 'mock-id2',
+              name: 'mock-name2',
+            },
+          ],
         };
 
         const { accountsController } = setupAccountsController({
@@ -744,6 +773,16 @@
               accounts: [mockAccount3.address, mockAccount4.address],
             },
           ],
+          keyringsMetadata: [
+            {
+              id: 'mock-id',
+              name: 'mock-name',
+            },
+            {
+              id: 'mock-id2',
+              name: 'mock-name2',
+            },
+          ],
         };
 
         const { accountsController } = setupAccountsController({
@@ -790,6 +829,12 @@
               ],
             },
           ],
+          keyringsMetadata: [
+            {
+              id: 'mock-id',
+              name: 'mock-name',
+            },
+          ],
         };
         const { accountsController } = setupAccountsController({
           initialState: {
@@ -852,6 +897,12 @@
               ],
             },
           ],
+          keyringsMetadata: [
+            {
+              id: 'mock-id',
+              name: 'mock-name',
+            },
+          ],
         };
         const { accountsController } = setupAccountsController({
           initialState: {
@@ -912,6 +963,16 @@
               accounts: [mockAccount3.address],
             },
           ],
+          keyringsMetadata: [
+            {
+              id: 'mock-id',
+              name: 'mock-name',
+            },
+            {
+              id: 'mock-id2',
+              name: 'mock-name2',
+            },
+          ],
         };
 
         const { accountsController } = setupAccountsController({
@@ -948,6 +1009,12 @@
               accounts: [mockAccount.address, mockAccount2.address],
             },
           ],
+          keyringsMetadata: [
+            {
+              id: 'mock-id',
+              name: 'mock-name',
+            },
+          ],
         };
         const { accountsController } = setupAccountsController({
           initialState: {
@@ -1003,6 +1070,12 @@
               accounts: [mockAccount.address, mockAccount2.address],
             },
           ],
+          keyringsMetadata: [
+            {
+              id: 'mock-id',
+              name: 'mock-name',
+            },
+          ],
         };
 
         messenger.publish(
@@ -1034,6 +1107,12 @@
               accounts: [mockAccount2.address],
             },
           ],
+          keyringsMetadata: [
+            {
+              id: 'mock-id',
+              name: 'mock-name',
+            },
+          ],
         };
         const { accountsController } = setupAccountsController({
           initialState: {
@@ -1075,6 +1154,12 @@
               accounts: [mockAccount.address, mockAccount2.address],
             },
           ],
+          keyringsMetadata: [
+            {
+              id: 'mock-id',
+              name: 'mock-name',
+            },
+          ],
         };
         const { accountsController } = setupAccountsController({
           initialState: {
@@ -1135,6 +1220,12 @@
               accounts: [mockAccount.address, mockAccount2.address],
             },
           ],
+          keyringsMetadata: [
+            {
+              id: 'mock-id',
+              name: 'mock-name',
+            },
+          ],
         };
         const { accountsController } = setupAccountsController({
           initialState: {
@@ -1208,6 +1299,12 @@
               ],
             },
           ],
+          keyringsMetadata: [
+            {
+              id: 'mock-id',
+              name: 'mock-name',
+            },
+          ],
         };
         const { accountsController } = setupAccountsController({
           initialState: {
@@ -1278,6 +1375,12 @@
               accounts: [mockAccount.address, mockAccount2.address],
             },
           ],
+          keyringsMetadata: [
+            {
+              id: 'mock-id',
+              name: 'mock-name',
+            },
+          ],
         };
         messenger.publish(
           'KeyringController:stateChange',
@@ -1322,6 +1425,12 @@
             accounts: [mockReinitialisedAccount.address],
           },
         ],
+        keyringsMetadata: [
+          {
+            id: 'mock-id',
+            name: 'mock-name',
+          },
+        ],
       };
       const { accountsController } = setupAccountsController({
         initialState: {
@@ -1418,6 +1527,12 @@
               ],
             },
           ],
+          keyringsMetadata: [
+            {
+              id: 'mock-id',
+              name: 'mock-name',
+            },
+          ],
         };
         messenger.publish(
           'KeyringController:stateChange',
@@ -2694,6 +2809,16 @@
             accounts: simpleAddressess,
           },
         ],
+        keyringsMetadata: [
+          {
+            id: 'mock-id',
+            name: 'mock-name',
+          },
+          {
+            id: 'mock-id2',
+            name: 'mock-name2',
+          },
+        ],
       };
     };
 

packages/keyring-controller/jest.config.js

@@ -17,10 +17,10 @@ module.exports = merge(baseConfig, {
   // An object that configures minimum threshold enforcement for coverage results
   coverageThreshold: {
     global: {
-      branches: 94.26,
+      branches: 93.56,
       functions: 100,
-      lines: 98.96,
-      statements: 98.98,
+      lines: 98.73,
+      statements: 98.74,
     },
   },
 

packages/keyring-controller/package.json

@@ -60,7 +60,8 @@
     "@metamask/utils": "^11.1.0",
     "async-mutex": "^0.5.0",
     "ethereumjs-wallet": "^1.0.1",
-    "immer": "^9.0.6"
+    "immer": "^9.0.6",
+    "ulid": "^2.3.0"
   },
   "devDependencies": {
     "@ethereumjs/common": "^3.2.0",
@@ -89,6 +90,10 @@
     "registry": "https://registry.npmjs.org/"
   },
   "lavamoat": {
-    "allowScripts": {}
+    "allowScripts": {
+      "@lavamoat/preinstall-always-fail": false,
+      "ethereumjs-wallet>ethereum-cryptography>keccak": false,
+      "ethereumjs-wallet>ethereum-cryptography>secp256k1": false
+    }
   }
 }