refactor: migrate KeyringController to @metamask/messenger (#6370)

## Explanation

<!--
Thanks for your contribution! Take a moment to answer these questions so
that reviewers have the information they need to properly understand
your changes:

* What is the current state of things and why does it need to change?
* What is the solution your changes offer and how does it work?
* Are there any changes whose purpose might not obvious to those
unfamiliar with the domain?
* If your primary goal was to update one package but you found you had
to update another one along the way, why did you do so?
* If you had to upgrade a dependency, why did you do so?
-->
This PR migrates the `KeyringController` controller class to the new
`@metamask/messenger` comm system, as opposed to the one exported from
`@metamask/base-controller`.

## References

<!--
Are there any issues that this pull request is tied to?
Are there other links that reviewers should consult to understand these
changes better?
Are there client or consumer pull requests to adopt any breaking
changes?

For example:

* Fixes #12345
* Related to #67890
-->
* Related to #5626

## Checklist

- [ ] I've updated the test suite for new or updated code as appropriate
- [ ] I've updated documentation (JSDoc, Markdown, etc.) for new or
updated code as appropriate
- [ ] I've communicated my changes to consumers by [updating changelogs
for packages I've
changed](https://github.com/MetaMask/core/tree/main/docs/contributing.md#updating-changelogs),
highlighting breaking changes as necessary
- [ ] I've prepared draft pull requests for clients and consumer
packages to resolve any breaking changes

<!-- CURSOR_SUMMARY -->
---

> [!NOTE]
> Migrates `KeyringController` to `@metamask/messenger`, updates
metadata flag and tests, and adds new messenger dependency/config refs.
> 
> - **Keyring Controller**:
> - Migrates messaging from `RestrictedMessenger`
(`@metamask/base-controller`) to `Messenger` (`@metamask/messenger`);
switches to `BaseController` from `@metamask/base-controller/next`.
> - Replaces `messagingSystem.publish/registerActionHandler` with
`messenger.publish/registerActionHandler` and updates
`KeyringControllerMessenger` type.
> - Renames metadata key `anonymous` to `includeInDebugSnapshot` and
updates calls to `deriveStateFromMetadata`.
> - **Tests**:
> - Refactors to build a root `Messenger` and namespaced controller
messenger; updates expectations for metadata snapshots and messaging
APIs.
> - **Repo/Config**:
> - Adds dependency `@metamask/messenger` and TypeScript project
references; updates README dependency graph to show `keyring_controller
--> messenger` and `eip_7702_internal_rpc_middleware -->
controller_utils`.
> - **Changelog**:
> - Notes BREAKING changes: switch to `@metamask/messenger` and metadata
flag rename.
> 
> <sup>Written by [Cursor
Bugbot](https://cursor.com/dashboard?tab=bugbot) for commit
7ad33d9. This will update automatically
on new commits. Configure
[here](https://cursor.com/dashboard?tab=bugbot).</sup>
<!-- /CURSOR_SUMMARY -->

Author: mikesposito

README.md

@@ -253,6 +253,7 @@ linkStyle default opacity:0.5
   gator_permissions_controller --> messenger;
   json_rpc_middleware_stream --> json_rpc_engine;
   keyring_controller --> base_controller;
+  keyring_controller --> messenger;
   logging_controller --> base_controller;
   logging_controller --> controller_utils;
   message_manager --> base_controller;

packages/keyring-controller/CHANGELOG.md

@@ -7,6 +7,12 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+### Changed
+
+- **BREAKING:** Use new `Messenger` from `@metamask/messenger` ([#6370](https://github.com/MetaMask/core/pull/6370))
+  - Previously, `KeyringController` accepted a `RestrictedMessenger` instance from `@metamask/base-controller`.
+- **BREAKING:** Metadata property `anonymous` renamed to `includeInDebugSnapshot` ([#6370](https://github.com/MetaMask/core/pull/6370))
+
 ## [23.2.0]
 
 ### Added

packages/keyring-controller/package.json

@@ -55,6 +55,7 @@
     "@metamask/eth-simple-keyring": "^11.0.0",
     "@metamask/keyring-api": "^21.0.0",
     "@metamask/keyring-internal-api": "^9.0.0",
+    "@metamask/messenger": "^0.3.0",
     "@metamask/utils": "^11.8.1",
     "async-mutex": "^0.5.0",
     "ethereumjs-wallet": "^1.0.1",

packages/keyring-controller/src/KeyringController.test.ts

@@ -1,7 +1,7 @@
 import { Chain, Common, Hardfork } from '@ethereumjs/common';
 import type { TypedTxData } from '@ethereumjs/tx';
 import { TransactionFactory } from '@ethereumjs/tx';
-import { Messenger, deriveStateFromMetadata } from '@metamask/base-controller';
+import { deriveStateFromMetadata } from '@metamask/base-controller/next';
 import { HdKeyring } from '@metamask/eth-hd-keyring';
 import {
   normalize,
@@ -14,6 +14,13 @@ import {
 import SimpleKeyring from '@metamask/eth-simple-keyring';
 import type { EthKeyring } from '@metamask/keyring-internal-api';
 import type { KeyringClass } from '@metamask/keyring-utils';
+import {
+  MOCK_ANY_NAMESPACE,
+  Messenger,
+  type MessengerActions,
+  type MessengerEvents,
+  type MockAnyNamespace,
+} from '@metamask/messenger';
 import { wordlist } from '@metamask/scure-bip39/dist/wordlists/english';
 import { bytesToHex, isValidHexAddress, type Hex } from '@metamask/utils';
 import sinon from 'sinon';
@@ -44,6 +51,16 @@ import { MockKeyring } from '../tests/mocks/mockKeyring';
 import MockShallowKeyring from '../tests/mocks/mockShallowKeyring';
 import { buildMockTransaction } from '../tests/mocks/mockTransaction';
 
+type AllKeyringControllerActions = MessengerActions<KeyringControllerMessenger>;
+
+type AllKeyringControllerEvents = MessengerEvents<KeyringControllerMessenger>;
+
+type RootMessenger = Messenger<
+  MockAnyNamespace,
+  AllKeyringControllerActions,
+  AllKeyringControllerEvents
+>;
+
 jest.mock('uuid', () => {
   return {
     ...jest.requireActual('uuid'),
@@ -4272,7 +4289,7 @@ describe('KeyringController', () => {
             deriveStateFromMetadata(
               controller.state,
               controller.metadata,
-              'anonymous',
+              'includeInDebugSnapshot',
             ),
           ).toMatchInlineSnapshot(`
             Object {
@@ -4356,7 +4373,7 @@ type WithControllerCallback<ReturnValue> = ({
   controller: KeyringController;
   encryptor: MockEncryptor;
   initialState: KeyringControllerState;
-  messenger: KeyringControllerMessenger;
+  messenger: RootMessenger;
 }) => Promise<ReturnValue> | ReturnValue;
 
 type WithControllerOptions = Partial<KeyringControllerOptions> & {
@@ -4387,27 +4404,28 @@ function stubKeyringClassWithAccount(
 }
 
 /**
- * Build a messenger that includes all events used by the keyring
- * controller.
+ * Build a root messenger.
  *
- * @returns The messenger.
+ * @returns The root messenger.
  */
-function buildMessenger() {
-  return new Messenger<KeyringControllerActions, KeyringControllerEvents>();
+function buildRootMessenger(): RootMessenger {
+  return new Messenger({ namespace: MOCK_ANY_NAMESPACE });
 }
 
 /**
- * Build a restricted messenger for the keyring controller.
+ * Build a messenger for the keyring controller.
  *
- * @param messenger - A messenger.
+ * @param messenger - An optional root messenger to use as the base for the
+ * controller messenger
  * @returns The keyring controller restricted messenger.
  */
-function buildKeyringControllerMessenger(messenger = buildMessenger()) {
-  return messenger.getRestricted({
-    name: 'KeyringController',
-    allowedActions: [],
-    allowedEvents: [],
-  });
+function buildKeyringControllerMessenger(messenger = buildRootMessenger()) {
+  return new Messenger<
+    'KeyringController',
+    KeyringControllerActions,
+    KeyringControllerEvents,
+    typeof messenger
+  >({ namespace: 'KeyringController', parent: messenger });
 }
 
 /**
@@ -4425,10 +4443,11 @@ async function withController<ReturnValue>(
 ): Promise<ReturnValue> {
   const [{ ...rest }, fn] = args.length === 2 ? args : [{}, args[0]];
   const encryptor = new MockEncryptor();
-  const messenger = buildKeyringControllerMessenger();
+  const messenger = buildRootMessenger();
+  const keyringControllerMessenger = buildKeyringControllerMessenger(messenger);
   const controller = new KeyringController({
     encryptor,
-    messenger,
+    messenger: keyringControllerMessenger,
     ...rest,
   });
   if (!rest.skipVaultCreation) {

packages/keyring-controller/src/KeyringController.ts

@@ -1,7 +1,6 @@
 import type { TypedTransaction, TypedTxData } from '@ethereumjs/tx';
 import { isValidPrivate, getBinarySize } from '@ethereumjs/util';
-import type { RestrictedMessenger } from '@metamask/base-controller';
-import { BaseController } from '@metamask/base-controller';
+import { BaseController } from '@metamask/base-controller/next';
 import * as encryptorUtils from '@metamask/browser-passworder';
 import { HdKeyring } from '@metamask/eth-hd-keyring';
 import { normalize as ethNormalize } from '@metamask/eth-sig-util';
@@ -15,6 +14,7 @@ import type {
 } from '@metamask/keyring-api';
 import type { EthKeyring } from '@metamask/keyring-internal-api';
 import type { KeyringClass } from '@metamask/keyring-utils';
+import type { Messenger } from '@metamask/messenger';
 import type { Eip1024EncryptedData, Hex, Json } from '@metamask/utils';
 import {
   add0x,
@@ -246,12 +246,10 @@ export type KeyringControllerEvents =
   | KeyringControllerUnlockEvent
   | KeyringControllerAccountRemovedEvent;
 
-export type KeyringControllerMessenger = RestrictedMessenger<
+export type KeyringControllerMessenger = Messenger<
   typeof name,
   KeyringControllerActions,
-  KeyringControllerEvents,
-  never,
-  never
+  KeyringControllerEvents
 >;
 
 export type KeyringControllerOptions = {
@@ -694,31 +692,31 @@ export class KeyringController extends BaseController<
         vault: {
           includeInStateLogs: false,
           persist: true,
-          anonymous: false,
+          includeInDebugSnapshot: false,
           usedInUi: false,
         },
         isUnlocked: {
           includeInStateLogs: true,
           persist: false,
-          anonymous: true,
+          includeInDebugSnapshot: true,
           usedInUi: true,
         },
         keyrings: {
           includeInStateLogs: true,
           persist: false,
-          anonymous: false,
+          includeInDebugSnapshot: false,
           usedInUi: true,
         },
         encryptionKey: {
           includeInStateLogs: false,
           persist: false,
-          anonymous: false,
+          includeInDebugSnapshot: false,
           usedInUi: false,
         },
         encryptionSalt: {
           includeInStateLogs: false,
           persist: false,
-          anonymous: false,
+          includeInDebugSnapshot: false,
           usedInUi: false,
         },
       },
@@ -1191,7 +1189,7 @@ export class KeyringController extends BaseController<
       }
     });
 
-    this.messagingSystem.publish(`${name}:accountRemoved`, address);
+    this.messenger.publish(`${name}:accountRemoved`, address);
   }
 
   /**
@@ -1213,7 +1211,7 @@ export class KeyringController extends BaseController<
         delete state.encryptionSalt;
       });
 
-      this.messagingSystem.publish(`${name}:lock`);
+      this.messenger.publish(`${name}:lock`);
     });
   }
 
@@ -1709,96 +1707,96 @@ export class KeyringController extends BaseController<
   }
 
   /**
-   * Constructor helper for registering this controller's messaging system
+   * Constructor helper for registering this controller's messeger
    * actions.
    */
   #registerMessageHandlers() {
-    this.messagingSystem.registerActionHandler(
+    this.messenger.registerActionHandler(
       `${name}:signMessage`,
       this.signMessage.bind(this),
     );
 
-    this.messagingSystem.registerActionHandler(
+    this.messenger.registerActionHandler(
       `${name}:signEip7702Authorization`,
       this.signEip7702Authorization.bind(this),
     );
 
-    this.messagingSystem.registerActionHandler(
+    this.messenger.registerActionHandler(
       `${name}:signPersonalMessage`,
       this.signPersonalMessage.bind(this),
     );
 
-    this.messagingSystem.registerActionHandler(
+    this.messenger.registerActionHandler(
       `${name}:signTypedMessage`,
       this.signTypedMessage.bind(this),
     );
 
-    this.messagingSystem.registerActionHandler(
+    this.messenger.registerActionHandler(
       `${name}:decryptMessage`,
       this.decryptMessage.bind(this),
     );
 
-    this.messagingSystem.registerActionHandler(
+    this.messenger.registerActionHandler(
       `${name}:getEncryptionPublicKey`,
       this.getEncryptionPublicKey.bind(this),
     );
 
-    this.messagingSystem.registerActionHandler(
+    this.messenger.registerActionHandler(
       `${name}:getAccounts`,
       this.getAccounts.bind(this),
     );
 
-    this.messagingSystem.registerActionHandler(
+    this.messenger.registerActionHandler(
       `${name}:getKeyringsByType`,
       this.getKeyringsByType.bind(this),
     );
 
-    this.messagingSystem.registerActionHandler(
+    this.messenger.registerActionHandler(
       `${name}:getKeyringForAccount`,
       this.getKeyringForAccount.bind(this),
     );
 
-    this.messagingSystem.registerActionHandler(
+    this.messenger.registerActionHandler(
       `${name}:persistAllKeyrings`,
       this.persistAllKeyrings.bind(this),
     );
 
-    this.messagingSystem.registerActionHandler(
+    this.messenger.registerActionHandler(
       `${name}:prepareUserOperation`,
       this.prepareUserOperation.bind(this),
     );
 
-    this.messagingSystem.registerActionHandler(
+    this.messenger.registerActionHandler(
       `${name}:patchUserOperation`,
       this.patchUserOperation.bind(this),
     );
 
-    this.messagingSystem.registerActionHandler(
+    this.messenger.registerActionHandler(
       `${name}:signUserOperation`,
       this.signUserOperation.bind(this),
     );
 
-    this.messagingSystem.registerActionHandler(
+    this.messenger.registerActionHandler(
       `${name}:addNewAccount`,
       this.addNewAccount.bind(this),
     );
 
-    this.messagingSystem.registerActionHandler(
+    this.messenger.registerActionHandler(
       `${name}:withKeyring`,
       this.withKeyring.bind(this),
     );
 
-    this.messagingSystem.registerActionHandler(
+    this.messenger.registerActionHandler(
       `${name}:addNewKeyring`,
       this.addNewKeyring.bind(this),
     );
 
-    this.messagingSystem.registerActionHandler(
+    this.messenger.registerActionHandler(
       `${name}:createNewVaultAndKeychain`,
       this.createNewVaultAndKeychain.bind(this),
     );
 
-    this.messagingSystem.registerActionHandler(
+    this.messenger.registerActionHandler(
       `${name}:createNewVaultAndRestore`,
       this.createNewVaultAndRestore.bind(this),
     );
@@ -2472,7 +2470,7 @@ export class KeyringController extends BaseController<
     this.update((state) => {
       state.isUnlocked = true;
     });
-    this.messagingSystem.publish(`${name}:unlock`);
+    this.messenger.publish(`${name}:unlock`);
   }
 
   /**

packages/keyring-controller/tsconfig.build.json

@@ -11,6 +11,9 @@
     },
     {
       "path": "../message-manager/tsconfig.build.json"
+    },
+    {
+      "path": "../messenger/tsconfig.build.json"
     }
   ],
   "include": ["../../types", "./src"]

packages/keyring-controller/tsconfig.json

@@ -9,6 +9,9 @@
     },
     {
       "path": "../message-manager"
+    },
+    {
+      "path": "../messenger"
     }
   ],
   "include": ["../../types", "./src", "./tests"]

yarn.lock

@@ -3937,6 +3937,7 @@ __metadata:
     "@metamask/keyring-api": "npm:^21.0.0"
     "@metamask/keyring-internal-api": "npm:^9.0.0"
     "@metamask/keyring-utils": "npm:^3.1.0"
+    "@metamask/messenger": "npm:^0.3.0"
     "@metamask/scure-bip39": "npm:^2.1.1"
     "@metamask/utils": "npm:^11.8.1"
     "@types/jest": "npm:^27.4.1"