feat: Keep PreferencesController in sync with keyring state

The `PreferencesController` now listens for `KeyringController` state changes, and updates its own state in response to account removals or additions. New accounts are added to the `identities` state and given default labels. Removed accounts are removed from the `identities` state, and the `selectedAddress` is updated if it was removed. The dependency between these two packages has been flipped; the `@metamask/preferences-controller` package now depends upon `@metamask/keyring-controller` rather than the other away around, so that the `KeyringController` state type and state change event can be accessed. The dependency the other way was just to get the types for the four `PreferencesController` methods that are passed into the `KeyringController` constructor. These types were easily inlined, and these methods will soon be removed anyway. A `getDefaultKeyringState` export was added to the `@metamask/keyring-controller` package to make it easier to write the necessary `PreferencesController` tests. Closes #3794
MetaMask · Jan 19, 2024 · 4aaebce · 4aaebce
1 parent d5c5163
commit 4aaebce
Show file tree

Hide file tree

Showing 10 changed files with 315 additions and 66 deletions.
diff --git a/packages/keyring-controller/package.json b/packages/keyring-controller/package.json
@@ -47,7 +47,6 @@
     "@keystonehq/bc-ur-registry-eth": "^0.9.0",
     "@metamask/auto-changelog": "^3.4.4",
     "@metamask/eth-sig-util": "^7.0.1",
-    "@metamask/preferences-controller": "^6.0.0",
     "@metamask/scure-bip39": "^2.1.1",
     "@types/jest": "^27.4.1",
     "deepmerge": "^4.2.2",
@@ -60,9 +59,6 @@
     "typescript": "~4.8.4",
     "uuid": "^8.3.2"
   },
-  "peerDependencies": {
-    "@metamask/preferences-controller": "^6.0.0"
-  },
   "engines": {
     "node": ">=16.0.0"
   },

diff --git a/packages/keyring-controller/src/KeyringController.ts b/packages/keyring-controller/src/KeyringController.ts
@@ -14,7 +14,6 @@ import type {
   PersonalMessageParams,
   TypedMessageParams,
 } from '@metamask/message-manager';
-import type { PreferencesController } from '@metamask/preferences-controller';
 import type { Eip1024EncryptedData, Hex, Keyring, Json } from '@metamask/utils';
 import { assertIsStrictHexString, hasProperty } from '@metamask/utils';
 import { Mutex } from 'async-mutex';
@@ -172,10 +171,10 @@ export type KeyringControllerMessenger = RestrictedControllerMessenger<
 >;
 
 export type KeyringControllerOptions = {
-  syncIdentities: PreferencesController['syncIdentities'];
-  updateIdentities: PreferencesController['updateIdentities'];
-  setSelectedAddress: PreferencesController['setSelectedAddress'];
-  setAccountLabel?: PreferencesController['setAccountLabel'];
+  syncIdentities: (addresses: string[]) => string;
+  updateIdentities: (addresses: string[]) => void;
+  setSelectedAddress: (selectedAddress: string) => void;
+  setAccountLabel?: (address: string, label: string) => void;
   keyringBuilders?: { (): Keyring<Json>; type: string }[];
   messenger: KeyringControllerMessenger;
   state?: { vault?: string };
@@ -221,9 +220,11 @@ export enum SignTypedDataVersion {
   V4 = 'V4',
 }
 
-const defaultState: KeyringControllerState = {
-  isUnlocked: false,
-  keyrings: [],
+export const getDefaultKeyringState = (): KeyringControllerState => {
+  return {
+    isUnlocked: false,
+    keyrings: [],
+  };
 };
 
 /**
@@ -261,13 +262,13 @@ export class KeyringController extends BaseController<
 > {
   private readonly mutex = new Mutex();
 
-  private readonly syncIdentities: PreferencesController['syncIdentities'];
+  private readonly syncIdentities: (addresses: string[]) => string;
 
-  private readonly updateIdentities: PreferencesController['updateIdentities'];
+  private readonly updateIdentities: (addresses: string[]) => void;
 
-  private readonly setSelectedAddress: PreferencesController['setSelectedAddress'];
+  private readonly setSelectedAddress: (selectedAddress: string) => void;
 
-  private readonly setAccountLabel?: PreferencesController['setAccountLabel'];
+  private readonly setAccountLabel?: (address: string, label: string) => void;
 
   #keyring: EthKeyringController;
 
@@ -311,7 +312,7 @@ export class KeyringController extends BaseController<
       },
       messenger,
       state: {
-        ...defaultState,
+        ...getDefaultKeyringState(),
         ...state,
       },
     });

diff --git a/packages/keyring-controller/tsconfig.build.json b/packages/keyring-controller/tsconfig.build.json
@@ -11,9 +11,6 @@
     },
     {
       "path": "../message-manager/tsconfig.build.json"
-    },
-    {
-      "path": "../preferences-controller/tsconfig.build.json"
     }
   ],
   "include": ["../../types", "./src"]

diff --git a/packages/keyring-controller/tsconfig.json b/packages/keyring-controller/tsconfig.json
@@ -9,9 +9,6 @@
     },
     {
       "path": "../message-manager"
-    },
-    {
-      "path": "../preferences-controller"
     }
   ],
   "include": ["../../types", "./src", "./tests"]

diff --git a/packages/preferences-controller/package.json b/packages/preferences-controller/package.json
@@ -36,14 +36,19 @@
   },
   "devDependencies": {
     "@metamask/auto-changelog": "^3.4.4",
+    "@metamask/keyring-controller": "^12.0.0",
     "@types/jest": "^27.4.1",
     "deepmerge": "^4.2.2",
     "jest": "^27.5.1",
+    "lodash": "^4.17.21",
     "ts-jest": "^27.1.4",
     "typedoc": "^0.24.8",
     "typedoc-plugin-missing-exports": "^2.0.0",
     "typescript": "~4.8.4"
   },
+  "peerDependencies": {
+    "@metamask/keyring-controller": "^12.0.0"
+  },
   "engines": {
     "node": ">=16.0.0"
   },
-Original file line number
+Diff line change
@@ Expand Up / @@ -11,9 +11,6 @@ @@
         },
         {
           "path": "../message-manager/tsconfig.build.json"
-        },
-        {
-          "path": "../preferences-controller/tsconfig.build.json"
         }
       ],
       "include": ["../../types", "./src"]
@@ Expand Down @@