refactor: migrate EarnController to @metamask/messenger (#6445)

## 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 `EarnController` 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 `EarnController` from `RestrictedMessenger` to
`@metamask/messenger`, updates state metadata keys, and aligns tests,
configs, and docs.
> 
> - **EarnController**:
> - Migrate messaging from `RestrictedMessenger` to
`@metamask/messenger` with new typed `Messenger` and `delegate` usage;
replace `messagingSystem` calls with `messenger.call/subscribe`.
>   - Update imports to `@metamask/base-controller/next`.
> - Rename metadata key `anonymous` to `includeInDebugSnapshot` and
adjust values.
> - **Tests** (`packages/earn-controller/src/EarnController.test.ts`):
> - Switch to `@metamask/messenger` root and namespaced messengers;
update types; adjust `deriveStateFromMetadata` selector to
`includeInDebugSnapshot`.
> - **Package/Config**:
>   - Add dependency `@metamask/messenger` and TS project references.
> - **Docs**:
> - Update dependency graph in `README.md` to link `earn_controller` →
`messenger` and add `eip_7702_internal_rpc_middleware` →
`controller_utils`.
> - **Changelog**:
> - Note breaking changes: new `Messenger` requirement and metadata key
rename.
> 
> <sup>Written by [Cursor
Bugbot](https://cursor.com/dashboard?tab=bugbot) for commit
ba9bcec. This will update automatically
on new commits. Configure
[here](https://cursor.com/dashboard?tab=bugbot).</sup>
<!-- /CURSOR_SUMMARY -->

---------

Co-authored-by: Mark Stacey <markjstacey@gmail.com>

Author: mikesposito

README.md

@@ -220,6 +220,7 @@ linkStyle default opacity:0.5
   delegation_controller --> keyring_controller;
   earn_controller --> base_controller;
   earn_controller --> controller_utils;
+  earn_controller --> messenger;
   earn_controller --> account_tree_controller;
   earn_controller --> network_controller;
   earn_controller --> transaction_controller;

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

packages/earn-controller/package.json

@@ -52,6 +52,7 @@
     "@metamask/base-controller": "^8.4.2",
     "@metamask/controller-utils": "^11.14.1",
     "@metamask/keyring-api": "^21.0.0",
+    "@metamask/messenger": "^0.3.0",
     "@metamask/stake-sdk": "^3.2.1",
     "reselect": "^5.1.1"
   },

packages/earn-controller/src/EarnController.test.ts

@@ -1,7 +1,14 @@
 /* eslint-disable jest/no-conditional-in-test */
-import { Messenger, deriveStateFromMetadata } from '@metamask/base-controller';
+import { deriveStateFromMetadata } from '@metamask/base-controller/next';
 import { toHex } from '@metamask/controller-utils';
 import type { InternalAccount } from '@metamask/keyring-internal-api';
+import {
+  MOCK_ANY_NAMESPACE,
+  Messenger,
+  type MessengerActions,
+  type MessengerEvents,
+  type MockAnyNamespace,
+} from '@metamask/messenger';
 import { getDefaultNetworkControllerState } from '@metamask/network-controller';
 import {
   EarnSdk,
@@ -17,10 +24,6 @@ import {
   EarnController,
   type EarnControllerState,
   type EarnControllerMessenger,
-  type EarnControllerEvents,
-  type EarnControllerActions,
-  type AllowedActions,
-  type AllowedEvents,
   DEFAULT_POOLED_STAKING_CHAIN_STATE,
 } from './EarnController';
 import type { TransactionMeta } from '../../transaction-controller/src';
@@ -29,6 +32,16 @@ import {
   TransactionType,
 } from '../../transaction-controller/src';
 
+type AllEarnControllerActions = MessengerActions<EarnControllerMessenger>;
+
+type AllEarnControllerEvents = MessengerEvents<EarnControllerMessenger>;
+
+type RootMessenger = Messenger<
+  MockAnyNamespace,
+  AllEarnControllerActions,
+  AllEarnControllerEvents
+>;
+
 jest.mock('@metamask/stake-sdk', () => ({
   EarnSdk: {
     create: jest.fn().mockImplementation(() => ({
@@ -81,39 +94,45 @@ jest.mock('@metamask/stake-sdk', () => ({
 }));
 
 /**
- * Builds a new instance of the Messenger class for the EarnController.
+ * Builds a new instance of the root messenger.
  *
- * @returns A new instance of the Messenger class for the EarnController.
+ * @returns A new instance of the root messenger.
  */
-function buildMessenger() {
-  return new Messenger<
-    EarnControllerActions | AllowedActions,
-    EarnControllerEvents | AllowedEvents
-  >();
+function buildMessenger(): RootMessenger {
+  return new Messenger({ namespace: MOCK_ANY_NAMESPACE });
 }
 
 /**
- * Constructs the messenger which is restricted to relevant EarnController
- * actions and events.
+ * Constructs the messenger for EarnController.
  *
- * @param rootMessenger - The root messenger to restrict.
+ * @param rootMessenger - The root messenger to set as parent.
  * @returns The restricted messenger.
  */
 function getEarnControllerMessenger(
   rootMessenger = buildMessenger(),
 ): EarnControllerMessenger {
-  return rootMessenger.getRestricted({
-    name: 'EarnController',
-    allowedActions: [
+  const earnControllerMessenger = new Messenger<
+    'EarnController',
+    AllEarnControllerActions,
+    AllEarnControllerEvents,
+    RootMessenger
+  >({
+    namespace: 'EarnController',
+    parent: rootMessenger,
+  });
+  rootMessenger.delegate({
+    messenger: earnControllerMessenger,
+    actions: [
       'NetworkController:getNetworkClientById',
       'AccountTreeController:getAccountsFromSelectedAccountGroup',
     ],
-    allowedEvents: [
+    events: [
       'NetworkController:networkDidChange',
       'AccountTreeController:selectedAccountGroupChange',
       'TransactionController:transactionConfirmed',
     ],
   });
+  return earnControllerMessenger;
 }
 
 const mockAccount1Address = '0x1234';
@@ -1461,10 +1480,7 @@ describe('EarnController', () => {
 
     describe('On transaction confirmed', () => {
       let controller: EarnController;
-      let messenger: Messenger<
-        EarnControllerActions | AllowedActions,
-        EarnControllerEvents | AllowedEvents
-      >;
+      let messenger: RootMessenger;
 
       beforeEach(async () => {
         const earnController = await setupController();
@@ -2575,7 +2591,7 @@ describe('EarnController', () => {
         deriveStateFromMetadata(
           controller.state,
           controller.metadata,
-          'anonymous',
+          'includeInDebugSnapshot',
         ),
       ).toMatchInlineSnapshot(`
         Object {

packages/earn-controller/src/EarnController.ts

@@ -6,13 +6,13 @@ import type {
 import type {
   ControllerGetStateAction,
   ControllerStateChangeEvent,
-  RestrictedMessenger,
   StateMetadata,
-} from '@metamask/base-controller';
-import { BaseController } from '@metamask/base-controller';
+} from '@metamask/base-controller/next';
+import { BaseController } from '@metamask/base-controller/next';
 import { convertHexToDecimal, toHex } from '@metamask/controller-utils';
 import { isEvmAccountType } from '@metamask/keyring-api';
 import type { InternalAccount } from '@metamask/keyring-internal-api';
+import type { Messenger } from '@metamask/messenger';
 import type {
   NetworkControllerGetNetworkClientByIdAction,
   NetworkControllerNetworkDidChangeEvent,
@@ -117,19 +117,19 @@ const earnControllerMetadata: StateMetadata<EarnControllerState> = {
   pooled_staking: {
     includeInStateLogs: true,
     persist: true,
-    anonymous: false,
+    includeInDebugSnapshot: false,
     usedInUi: true,
   },
   lending: {
     includeInStateLogs: true,
     persist: true,
-    anonymous: false,
+    includeInDebugSnapshot: false,
     usedInUi: true,
   },
   lastUpdated: {
     includeInStateLogs: true,
     persist: false,
-    anonymous: true,
+    includeInDebugSnapshot: true,
     usedInUi: false,
   },
 };
@@ -273,12 +273,10 @@ export type AllowedEvents =
  * The messenger which is restricted to actions and events accessed by
  * EarnController.
  */
-export type EarnControllerMessenger = RestrictedMessenger<
+export type EarnControllerMessenger = Messenger<
   typeof controllerName,
   EarnControllerActions | AllowedActions,
-  EarnControllerEvents | AllowedEvents,
-  AllowedActions['type'],
-  AllowedEvents['type']
+  EarnControllerEvents | AllowedEvents
 >;
 
 // === CONTROLLER DEFINITION ===
@@ -344,7 +342,7 @@ export class EarnController extends BaseController<
     this.refreshLendingData().catch(console.error);
 
     // Listen for network changes
-    this.messagingSystem.subscribe(
+    this.messenger.subscribe(
       'NetworkController:networkDidChange',
       (networkControllerState: NetworkState) => {
         this.#selectedNetworkClientId =
@@ -365,7 +363,7 @@ export class EarnController extends BaseController<
     );
 
     // Listen for account group changes
-    this.messagingSystem.subscribe(
+    this.messenger.subscribe(
       'AccountTreeController:selectedAccountGroupChange',
       () => {
         const address = this.#getSelectedEvmAccountAddress();
@@ -379,7 +377,7 @@ export class EarnController extends BaseController<
     );
 
     // Listen for confirmed staking transactions
-    this.messagingSystem.subscribe(
+    this.messenger.subscribe(
       'TransactionController:transactionConfirmed',
       (transactionMeta: TransactionMeta) => {
         /**
@@ -419,7 +417,7 @@ export class EarnController extends BaseController<
    * @param networkClientId - The network client id to initialize the Earn SDK for.
    */
   async #initializeSDK(networkClientId: string) {
-    const networkClient = this.messagingSystem.call(
+    const networkClient = this.messenger.call(
       'NetworkController:getNetworkClientById',
       networkClientId,
     );
@@ -460,7 +458,7 @@ export class EarnController extends BaseController<
    * @returns The EVM account or undefined if no EVM account is found.
    */
   #getSelectedEvmAccount(): InternalAccount | undefined {
-    return this.messagingSystem
+    return this.messenger
       .call('AccountTreeController:getAccountsFromSelectedAccountGroup')
       .find((account: InternalAccount) => isEvmAccountType(account.type));
   }

packages/earn-controller/tsconfig.build.json

@@ -17,6 +17,9 @@
     },
     {
       "path": "../account-tree-controller/tsconfig.build.json"
+    },
+    {
+      "path": "../messenger/tsconfig.build.json"
     }
   ],
   "include": ["../../types", "./src"]

packages/earn-controller/tsconfig.json

@@ -16,6 +16,9 @@
     },
     {
       "path": "../account-tree-controller"
+    },
+    {
+      "path": "../messenger"
     }
   ]
 }

yarn.lock

@@ -3256,6 +3256,7 @@ __metadata:
     "@metamask/base-controller": "npm:^8.4.2"
     "@metamask/controller-utils": "npm:^11.14.1"
     "@metamask/keyring-api": "npm:^21.0.0"
+    "@metamask/messenger": "npm:^0.3.0"
     "@metamask/network-controller": "npm:^24.3.1"
     "@metamask/stake-sdk": "npm:^3.2.1"
     "@metamask/transaction-controller": "npm:^60.10.0"