refactor: migrate {Approval,Transaction,Network,GasFee,AssetsContract,Nft,Tokens}Controller messengers (#6386)

## 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 `ApprovalController`, `TransactionController`,
`GasFeeController`, `NetworkController`, `AssetsContractController`,
`TokensController` and `NftController` classes to the new
`@metamask/messenger` comm system along with their tests, as opposed to
the one exported from `@metamask/base-controller`.

The three packages are being migrated together because the
`TransactionControllerIntegration.test.ts` file ties them together.

## 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 major controllers to the new @metamask/messenger with updated
state metadata and tests, adds StaticIntervalPollingControllerNext, and
updates package configs and changelogs (breaking).
> 
> - **Messaging/Controllers (BREAKING)**:
> - Migrate `ApprovalController`, `TransactionController`,
`NetworkController`, `GasFeeController`, `AssetsContractController`,
`NftController`, `TokensController` from `RestrictedMessenger` to new
`@metamask/messenger`.
> - Replace `@metamask/base-controller` APIs with
`@metamask/base-controller/next` where applicable; update state metadata
keys (`anonymous` -> `includeInDebugSnapshot`).
> - Update controller messenger types, action/event registrations
(`this.messenger.registerActionHandler/subscribe/publish/call`).
> - Refactor tests to use root and namespaced messengers with delegated
actions/events.
> - **Gas Fee/Pooling**:
> - Add `StaticIntervalPollingControllerNext`; `GasFeeController` now
extends it.
>   - Export `GasFeeMessenger` type.
> - **Configs/Deps**:
> - Add `@metamask/messenger` dependency and TS project references
across affected packages; adjust imports to `/next` variants.
> - Update README controller dependency graph to include `messenger`
links.
> - **Changelogs**:
> - Note BREAKING changes for the controllers above; document new export
in gas-fee-controller.
> - **Misc**:
>   - Minor eslint threshold tweak; yarn.lock updates.
> 
> <sup>Written by [Cursor
Bugbot](https://cursor.com/dashboard?tab=bugbot) for commit
c2dee6e. 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

@@ -166,8 +166,10 @@ linkStyle default opacity:0.5
   app_metadata_controller --> base_controller;
   app_metadata_controller --> messenger;
   approval_controller --> base_controller;
+  approval_controller --> messenger;
   assets_controllers --> base_controller;
   assets_controllers --> controller_utils;
+  assets_controllers --> messenger;
   assets_controllers --> polling_controller;
   assets_controllers --> account_tree_controller;
   assets_controllers --> accounts_controller;
@@ -275,6 +277,7 @@ linkStyle default opacity:0.5
   network_controller --> eth_json_rpc_middleware;
   network_controller --> eth_json_rpc_provider;
   network_controller --> json_rpc_engine;
+  network_controller --> messenger;
   network_controller --> error_reporting_service;
   network_enablement_controller --> base_controller;
   network_enablement_controller --> controller_utils;
@@ -333,6 +336,7 @@ linkStyle default opacity:0.5
   token_search_discovery_controller --> base_controller;
   transaction_controller --> base_controller;
   transaction_controller --> controller_utils;
+  transaction_controller --> messenger;
   transaction_controller --> accounts_controller;
   transaction_controller --> approval_controller;
   transaction_controller --> eth_block_tracker;

eslint-warning-thresholds.json

@@ -68,7 +68,7 @@
   },
   "packages/assets-controllers/src/TokensController.test.ts": {
     "import-x/namespace": 1,
-    "import-x/order": 4,
+    "import-x/order": 3,
     "jest/no-conditional-in-test": 2
   },
   "packages/assets-controllers/src/TokensController.ts": {

packages/approval-controller/CHANGELOG.md

@@ -7,6 +7,11 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+### Changed
+
+- **BREAKING:** Use new `Messenger` from `@metamask/messenger` ([#6386](https://github.com/MetaMask/core/pull/6386))
+  - Previously, `ApprovalController` accepted a `RestrictedMessenger` instance from `@metamask/base-controller`.
+
 ## [7.2.1]
 
 ### Changed

packages/approval-controller/package.json

@@ -48,6 +48,7 @@
   },
   "dependencies": {
     "@metamask/base-controller": "^8.4.2",
+    "@metamask/messenger": "^0.3.0",
     "@metamask/rpc-errors": "^7.0.2",
     "@metamask/utils": "^11.8.1",
     "nanoid": "^3.3.8"

packages/approval-controller/src/ApprovalController.test.ts

@@ -1,6 +1,13 @@
 /* eslint-disable jest/expect-expect */
 
-import { deriveStateFromMetadata, Messenger } from '@metamask/base-controller';
+import { deriveStateFromMetadata } from '@metamask/base-controller/next';
+import {
+  MOCK_ANY_NAMESPACE,
+  Messenger,
+  type MessengerActions,
+  type MessengerEvents,
+  type MockAnyNamespace,
+} from '@metamask/messenger';
 import { errorCodes, JsonRpcError } from '@metamask/rpc-errors';
 import { nanoid } from 'nanoid';
 
@@ -9,6 +16,7 @@ import type {
   AddApprovalOptions,
   ApprovalControllerActions,
   ApprovalControllerEvents,
+  ApprovalControllerMessenger,
   ErrorOptions,
   StartFlowOptions,
   SuccessOptions,
@@ -28,6 +36,12 @@ import {
 
 jest.mock('nanoid');
 
+type AllActions = MessengerActions<ApprovalControllerMessenger>;
+
+type AllEvents = MessengerEvents<ApprovalControllerMessenger>;
+
+type RootMessenger = Messenger<MockAnyNamespace, AllActions, AllEvents>;
+
 const nanoidMock = jest.mocked(nanoid);
 
 const PENDING_APPROVALS_STORE_KEY = 'pendingApprovals';
@@ -223,20 +237,26 @@ function getError(message: string, code?: number) {
 }
 
 /**
- * Constructs a restricted messenger.
+ * Constructs a controller messenger.
  *
- * @returns A restricted messenger.
+ * @returns A controller messenger.
  */
-function getRestrictedMessenger() {
-  const messenger = new Messenger<
-    ApprovalControllerActions,
-    ApprovalControllerEvents
-  >();
-  return messenger.getRestricted({
-    name: 'ApprovalController',
-    allowedActions: [],
-    allowedEvents: [],
+function getMessengers() {
+  const rootMessenger: RootMessenger = new Messenger({
+    namespace: MOCK_ANY_NAMESPACE,
   });
+  return {
+    rootMessenger,
+    approvalControllerMessenger: new Messenger<
+      typeof controllerName,
+      ApprovalControllerActions,
+      ApprovalControllerEvents,
+      typeof rootMessenger
+    >({
+      namespace: controllerName,
+      parent: rootMessenger,
+    }),
+  };
 }
 
 describe('approval controller', () => {
@@ -250,7 +270,7 @@ describe('approval controller', () => {
     showApprovalRequest = jest.fn();
 
     approvalController = new ApprovalController({
-      messenger: getRestrictedMessenger(),
+      messenger: getMessengers().approvalControllerMessenger,
       showApprovalRequest,
     });
   });
@@ -445,7 +465,7 @@ describe('approval controller', () => {
 
     it('does not throw on origin and type collision if type excluded', () => {
       approvalController = new ApprovalController({
-        messenger: getRestrictedMessenger(),
+        messenger: getMessengers().approvalControllerMessenger,
         showApprovalRequest,
         typesExcludedFromRateLimiting: ['myType'],
       });
@@ -638,7 +658,7 @@ describe('approval controller', () => {
 
     it('gets the count when specifying origin and type with type excluded from rate limiting', () => {
       approvalController = new ApprovalController({
-        messenger: getRestrictedMessenger(),
+        messenger: getMessengers().approvalControllerMessenger,
         showApprovalRequest,
         typesExcludedFromRateLimiting: [TYPE],
       });
@@ -678,7 +698,7 @@ describe('approval controller', () => {
 
     it('gets the total approval count with type excluded from rate limiting', () => {
       approvalController = new ApprovalController({
-        messenger: getRestrictedMessenger(),
+        messenger: getMessengers().approvalControllerMessenger,
         showApprovalRequest,
         typesExcludedFromRateLimiting: ['type0'],
       });
@@ -1269,23 +1289,16 @@ describe('approval controller', () => {
 
   describe('actions', () => {
     it('addApprovalRequest: shouldShowRequest = true', async () => {
-      const messenger = new Messenger<
-        ApprovalControllerActions,
-        ApprovalControllerEvents
-      >();
+      const { rootMessenger, approvalControllerMessenger } = getMessengers();
 
       approvalController = new ApprovalController({
-        messenger: messenger.getRestricted({
-          name: controllerName,
-          allowedActions: [],
-          allowedEvents: [],
-        }),
+        messenger: approvalControllerMessenger,
         showApprovalRequest,
       });
 
       // TODO: Either fix this lint violation or explain why it's necessary to ignore.
       // eslint-disable-next-line @typescript-eslint/no-floating-promises
-      messenger.call(
+      rootMessenger.call(
         'ApprovalController:addRequest',
         { id: 'foo', origin: 'bar.baz', type: TYPE },
         true,
@@ -1295,23 +1308,16 @@ describe('approval controller', () => {
     });
 
     it('addApprovalRequest: shouldShowRequest = false', async () => {
-      const messenger = new Messenger<
-        ApprovalControllerActions,
-        ApprovalControllerEvents
-      >();
+      const { rootMessenger, approvalControllerMessenger } = getMessengers();
 
       approvalController = new ApprovalController({
-        messenger: messenger.getRestricted({
-          name: controllerName,
-          allowedActions: [],
-          allowedEvents: [],
-        }),
+        messenger: approvalControllerMessenger,
         showApprovalRequest,
       });
 
       // TODO: Either fix this lint violation or explain why it's necessary to ignore.
       // eslint-disable-next-line @typescript-eslint/no-floating-promises
-      messenger.call(
+      rootMessenger.call(
         'ApprovalController:addRequest',
         { id: 'foo', origin: 'bar.baz', type: TYPE },
         false,
@@ -1321,17 +1327,10 @@ describe('approval controller', () => {
     });
 
     it('updateRequestState', () => {
-      const messenger = new Messenger<
-        ApprovalControllerActions,
-        ApprovalControllerEvents
-      >();
+      const { approvalControllerMessenger } = getMessengers();
 
       approvalController = new ApprovalController({
-        messenger: messenger.getRestricted({
-          name: controllerName,
-          allowedActions: [],
-          allowedEvents: [],
-        }),
+        messenger: approvalControllerMessenger,
         showApprovalRequest,
       });
 
@@ -1344,10 +1343,13 @@ describe('approval controller', () => {
         requestState: { foo: 'bar' },
       });
 
-      messenger.call('ApprovalController:updateRequestState', {
-        id: 'foo',
-        requestState: { foo: 'foobar' },
-      });
+      approvalControllerMessenger.call(
+        'ApprovalController:updateRequestState',
+        {
+          id: 'foo',
+          requestState: { foo: 'foobar' },
+        },
+      );
 
       expect(approvalController.get('foo')?.requestState).toStrictEqual({
         foo: 'foobar',
@@ -1719,7 +1721,7 @@ describe('approval controller', () => {
         deriveStateFromMetadata(
           approvalController.state,
           approvalController.metadata,
-          'anonymous',
+          'includeInDebugSnapshot',
         ),
       ).toMatchInlineSnapshot(`
         Object {

packages/approval-controller/src/ApprovalController.ts

@@ -1,9 +1,12 @@
-import type { ControllerGetStateAction } from '@metamask/base-controller';
+import type {
+  ControllerGetStateAction,
+  StateMetadata,
+} from '@metamask/base-controller/next';
 import {
   BaseController,
   type ControllerStateChangeEvent,
-  type RestrictedMessenger,
-} from '@metamask/base-controller';
+} from '@metamask/base-controller/next';
+import type { Messenger } from '@metamask/messenger';
 import type { JsonRpcError, DataWithOptionalCause } from '@metamask/rpc-errors';
 import { rpcErrors } from '@metamask/rpc-errors';
 import type { Json, OptionalField } from '@metamask/utils';
@@ -26,23 +29,23 @@ export const APPROVAL_TYPE_RESULT_SUCCESS = 'result_success';
 
 const controllerName = 'ApprovalController';
 
-const stateMetadata = {
+const stateMetadata: StateMetadata<ApprovalControllerState> = {
   pendingApprovals: {
     includeInStateLogs: true,
     persist: false,
-    anonymous: true,
+    includeInDebugSnapshot: true,
     usedInUi: true,
   },
   pendingApprovalCount: {
     includeInStateLogs: true,
     persist: false,
-    anonymous: false,
+    includeInDebugSnapshot: false,
     usedInUi: true,
   },
   approvalFlows: {
     includeInStateLogs: true,
     persist: false,
-    anonymous: false,
+    includeInDebugSnapshot: false,
     usedInUi: true,
   },
 };
@@ -134,12 +137,10 @@ export type ApprovalControllerState = {
   approvalFlows: ApprovalFlowState[];
 };
 
-export type ApprovalControllerMessenger = RestrictedMessenger<
+export type ApprovalControllerMessenger = Messenger<
   typeof controllerName,
   ApprovalControllerActions,
-  ApprovalControllerEvents,
-  never,
-  never
+  ApprovalControllerEvents
 >;
 
 // Option Types
@@ -413,12 +414,12 @@ export class ApprovalController extends BaseController<
    * actions.
    */
   private registerMessageHandlers(): void {
-    this.messagingSystem.registerActionHandler(
+    this.messenger.registerActionHandler(
       `${controllerName}:clearRequests` as const,
       this.clear.bind(this),
     );
 
-    this.messagingSystem.registerActionHandler(
+    this.messenger.registerActionHandler(
       `${controllerName}:addRequest` as const,
       (opts: AddApprovalOptions, shouldShowRequest: boolean) => {
         if (shouldShowRequest) {
@@ -428,47 +429,47 @@ export class ApprovalController extends BaseController<
       },
     );
 
-    this.messagingSystem.registerActionHandler(
+    this.messenger.registerActionHandler(
       `${controllerName}:hasRequest` as const,
       this.has.bind(this),
     );
 
-    this.messagingSystem.registerActionHandler(
+    this.messenger.registerActionHandler(
       `${controllerName}:acceptRequest` as const,
       this.accept.bind(this),
     );
 
-    this.messagingSystem.registerActionHandler(
+    this.messenger.registerActionHandler(
       `${controllerName}:rejectRequest` as const,
       this.reject.bind(this),
     );
 
-    this.messagingSystem.registerActionHandler(
+    this.messenger.registerActionHandler(
       `${controllerName}:updateRequestState` as const,
       this.updateRequestState.bind(this),
     );
 
-    this.messagingSystem.registerActionHandler(
+    this.messenger.registerActionHandler(
       `${controllerName}:startFlow` as const,
       this.startFlow.bind(this),
     );
 
-    this.messagingSystem.registerActionHandler(
+    this.messenger.registerActionHandler(
       `${controllerName}:endFlow` as const,
       this.endFlow.bind(this),
     );
 
-    this.messagingSystem.registerActionHandler(
+    this.messenger.registerActionHandler(
       `${controllerName}:setFlowLoadingText` as const,
       this.setFlowLoadingText.bind(this),
     );
 
-    this.messagingSystem.registerActionHandler(
+    this.messenger.registerActionHandler(
       `${controllerName}:showSuccess` as const,
       this.success.bind(this),
     );
 
-    this.messagingSystem.registerActionHandler(
+    this.messenger.registerActionHandler(
       `${controllerName}:showError` as const,
       this.error.bind(this),
     );