refactor: migrate DelegationController to @metamask/messenger (#6459)

## 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 `DelegationController` to the new `@metamask/messenger`
message bus, 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 `DelegationController` to `@metamask/messenger`, updates
controller/test imports to `@metamask/base-controller/next`, and renames
metadata `anonymous` to `includeInDebugSnapshot`.
> 
> - **DelegationController**:
> - Switch to `@metamask/messenger` (`messenger.call`,
controller-specific messenger) and update types to `Messenger`.
> - Import `BaseController`/`StateMetadata` from
`@metamask/base-controller/next`.
>   - Rename metadata key `anonymous` -> `includeInDebugSnapshot`.
> - Replace internal calls from `messagingSystem.call` to
`messenger.call`.
> - **Tests**:
> - Rework messenger mocks to use `@metamask/messenger` with
namespacing/delegation.
>   - Update `deriveStateFromMetadata` import and metadata key usage.
> - **Package/Config**:
>   - Add dependency `@metamask/messenger` and TS project references.
> - Update changelog with BREAKING changes (new messenger, metadata key
rename).
> - **Docs**:
> - Update README dependency graph (add `delegation_controller -->
messenger`, add `eip_7702_internal_rpc_middleware -->
controller_utils`).
> 
> <sup>Written by [Cursor
Bugbot](https://cursor.com/dashboard?tab=bugbot) for commit
a3979fb. This will update automatically
on new commits. Configure
[here](https://cursor.com/dashboard?tab=bugbot).</sup>
<!-- /CURSOR_SUMMARY -->

Author: mikesposito

README.md

@@ -215,6 +215,7 @@ linkStyle default opacity:0.5
   core_backend --> accounts_controller;
   core_backend --> keyring_controller;
   delegation_controller --> base_controller;
+  delegation_controller --> messenger;
   delegation_controller --> accounts_controller;
   delegation_controller --> keyring_controller;
   earn_controller --> base_controller;

packages/delegation-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` ([#6459](https://github.com/MetaMask/core/pull/6459))
+  - Previously, `DelegationController` accepted a `RestrictedMessenger` instance from `@metamask/base-controller`.
+- **BREAKING:** Metadata property `anonymous` renamed to `includeInDebugSnapshot` ([#6459](https://github.com/MetaMask/core/pull/6459))
+
 ## [0.8.1]
 
 ### Changed

packages/delegation-controller/package.json

@@ -48,6 +48,7 @@
   },
   "dependencies": {
     "@metamask/base-controller": "^8.4.2",
+    "@metamask/messenger": "^0.3.0",
     "@metamask/utils": "^11.8.1"
   },
   "devDependencies": {

packages/delegation-controller/src/DelegationController.test.ts

@@ -1,24 +1,39 @@
-import type { AccountsControllerGetSelectedAccountAction } from '@metamask/accounts-controller';
-import { deriveStateFromMetadata, Messenger } from '@metamask/base-controller';
+import { deriveStateFromMetadata } from '@metamask/base-controller/next';
+import { SignTypedDataVersion } from '@metamask/keyring-controller';
 import {
-  type KeyringControllerSignTypedMessageAction,
-  SignTypedDataVersion,
-} from '@metamask/keyring-controller';
+  Messenger,
+  MOCK_ANY_NAMESPACE,
+  type MessengerActions,
+  type MessengerEvents,
+  type MockAnyNamespace,
+} from '@metamask/messenger';
 import { hexToNumber } from '@metamask/utils';
 
 import { ROOT_AUTHORITY } from './constants';
 import { controllerName, DelegationController } from './DelegationController';
 import type {
   Address,
   Delegation,
-  DelegationControllerEvents,
+  DelegationControllerMessenger,
   DelegationControllerState,
   DelegationEntry,
   DeleGatorEnvironment,
   Hex,
 } from './types';
 import { toDelegationStruct } from './utils';
 
+type AllDelegationControllerActions =
+  MessengerActions<DelegationControllerMessenger>;
+
+type AllDelegationControllerEvents =
+  MessengerEvents<DelegationControllerMessenger>;
+
+type RootMessenger = Messenger<
+  MockAnyNamespace,
+  AllDelegationControllerActions,
+  AllDelegationControllerEvents
+>;
+
 const FROM_MOCK = '0x2234567890123456789012345678901234567890' as Address;
 const SIGNATURE_HASH_MOCK = '0x123ABC';
 
@@ -60,11 +75,9 @@ class TestDelegationController extends DelegationController {
  * @returns The mock messenger instance plus individual mock functions for each action.
  */
 function createMessengerMock() {
-  const messenger = new Messenger<
-    | KeyringControllerSignTypedMessageAction
-    | AccountsControllerGetSelectedAccountAction,
-    DelegationControllerEvents
-  >();
+  const messenger: RootMessenger = new Messenger({
+    namespace: MOCK_ANY_NAMESPACE,
+  });
 
   const accountsControllerGetSelectedAccountMock = jest.fn();
   const keyringControllerSignTypedMessageMock = jest.fn();
@@ -84,19 +97,27 @@ function createMessengerMock() {
     keyringControllerSignTypedMessageMock,
   );
 
-  const restrictedMessenger = messenger.getRestricted({
-    name: `${controllerName}`,
-    allowedActions: [
+  const delegationControllerMessenger = new Messenger<
+    'DelegationController',
+    AllDelegationControllerActions,
+    AllDelegationControllerEvents,
+    RootMessenger
+  >({
+    namespace: controllerName,
+    parent: messenger,
+  });
+  messenger.delegate({
+    messenger: delegationControllerMessenger,
+    actions: [
       'AccountsController:getSelectedAccount',
       'KeyringController:signTypedMessage',
     ],
-    allowedEvents: [],
   });
 
   return {
     accountsControllerGetSelectedAccountMock,
     keyringControllerSignTypedMessageMock,
-    messenger: restrictedMessenger,
+    messenger: delegationControllerMessenger,
   };
 }
 
@@ -679,7 +700,7 @@ describe(`${controllerName}`, () => {
         deriveStateFromMetadata(
           controller.state,
           controller.metadata,
-          'anonymous',
+          'includeInDebugSnapshot',
         ),
       ).toMatchInlineSnapshot(`Object {}`);
     });

packages/delegation-controller/src/DelegationController.ts

@@ -1,5 +1,5 @@
-import type { StateMetadata } from '@metamask/base-controller';
-import { BaseController } from '@metamask/base-controller';
+import type { StateMetadata } from '@metamask/base-controller/next';
+import { BaseController } from '@metamask/base-controller/next';
 import { SignTypedDataVersion } from '@metamask/keyring-controller';
 import { hexToNumber } from '@metamask/utils';
 
@@ -23,7 +23,7 @@ const delegationControllerMetadata = {
   delegations: {
     includeInStateLogs: false,
     persist: true,
-    anonymous: false,
+    includeInDebugSnapshot: false,
     usedInUi: false,
   },
 } satisfies StateMetadata<DelegationControllerState>;
@@ -115,7 +115,7 @@ export class DelegationController extends BaseController<
 
     // TODO:: Replace with `SignatureController:newUnsignedTypedMessage`.
     // Waiting on confirmations team to implement this.
-    const signature: string = await this.messagingSystem.call(
+    const signature: string = await this.messenger.call(
       'KeyringController:signTypedMessage',
       data,
       SignTypedDataVersion.V4,
@@ -154,7 +154,7 @@ export class DelegationController extends BaseController<
    * @returns A list of delegation entries that match the filter.
    */
   list(filter?: DelegationFilter) {
-    const account = this.messagingSystem.call(
+    const account = this.messenger.call(
       'AccountsController:getSelectedAccount',
     );
     const requester = account.address as Address;

packages/delegation-controller/src/types.ts

@@ -2,9 +2,9 @@ import type { AccountsControllerGetSelectedAccountAction } from '@metamask/accou
 import type {
   ControllerGetStateAction,
   ControllerStateChangeEvent,
-  RestrictedMessenger,
-} from '@metamask/base-controller';
+} from '@metamask/base-controller/next';
 import type { KeyringControllerSignTypedMessageAction } from '@metamask/keyring-controller';
+import type { Messenger } from '@metamask/messenger';
 
 import type {
   controllerName,
@@ -149,10 +149,8 @@ type AllowedActions =
 
 type AllowedEvents = never;
 
-export type DelegationControllerMessenger = RestrictedMessenger<
+export type DelegationControllerMessenger = Messenger<
   typeof controllerName,
   DelegationControllerActions | AllowedActions,
-  DelegationControllerEvents | AllowedEvents,
-  AllowedActions['type'],
-  AllowedEvents['type']
+  DelegationControllerEvents | AllowedEvents
 >;

packages/delegation-controller/tsconfig.build.json

@@ -8,7 +8,8 @@
   "references": [
     { "path": "../base-controller/tsconfig.build.json" },
     { "path": "../keyring-controller/tsconfig.build.json" },
-    { "path": "../accounts-controller/tsconfig.build.json" }
+    { "path": "../accounts-controller/tsconfig.build.json" },
+    { "path": "../messenger/tsconfig.build.json" }
   ],
   "include": ["../../types", "./src"]
 }

packages/delegation-controller/tsconfig.json

@@ -6,7 +6,8 @@
   "references": [
     { "path": "../base-controller" },
     { "path": "../keyring-controller" },
-    { "path": "../accounts-controller" }
+    { "path": "../accounts-controller" },
+    { "path": "../messenger" }
   ],
   "include": ["../../types", "./src"]
 }

yarn.lock

@@ -3211,6 +3211,7 @@ __metadata:
     "@metamask/auto-changelog": "npm:^3.4.4"
     "@metamask/base-controller": "npm:^8.4.2"
     "@metamask/keyring-controller": "npm:^23.2.0"
+    "@metamask/messenger": "npm:^0.3.0"
     "@metamask/utils": "npm:^11.8.1"
     "@ts-bridge/cli": "npm:^0.6.1"
     "@types/jest": "npm:^27.4.1"