refactor: migrate NameController to @metamask/messenger

Author: cryptodev-2s

packages/name-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` ([#6541](https://github.com/MetaMask/core/pull/6541))
+  - Previously, `NameController` accepted a `RestrictedMessenger` instance from `@metamask/base-controller`.
+
 ### Added
 
 - Add two new controller state metadata properties: `includeInStateLogs` and `usedInUi` ([#6473](https://github.com/MetaMask/core/pull/6473))

packages/name-controller/package.json

@@ -50,6 +50,7 @@
   "dependencies": {
     "@metamask/base-controller": "^8.4.0",
     "@metamask/controller-utils": "^11.14.0",
+    "@metamask/messenger": "^0.3.0",
     "@metamask/utils": "^11.8.1",
     "async-mutex": "^0.5.0"
   },

packages/name-controller/src/NameController.test.ts

@@ -1,4 +1,4 @@
-import { deriveStateFromMetadata } from '@metamask/base-controller';
+import { deriveStateFromMetadata } from '@metamask/base-controller/next';
 
 import type {
   SetNameRequest,
@@ -2765,7 +2765,7 @@ describe('NameController', () => {
         deriveStateFromMetadata(
           controller.state,
           controller.metadata,
-          'anonymous',
+          'includeInDebugSnapshot',
         ),
       ).toMatchInlineSnapshot(`Object {}`);
     });

packages/name-controller/src/NameController.ts

@@ -1,10 +1,10 @@
 import type {
   ControllerGetStateAction,
   ControllerStateChangeEvent,
-  RestrictedMessenger,
-} from '@metamask/base-controller';
-import { BaseController } from '@metamask/base-controller';
+} from '@metamask/base-controller/next';
+import { BaseController } from '@metamask/base-controller/next';
 import { isSafeDynamicKey } from '@metamask/controller-utils';
+import type { Messenger } from '@metamask/messenger';
 
 import type {
   NameProvider,
@@ -44,13 +44,13 @@ const stateMetadata = {
   names: {
     includeInStateLogs: true,
     persist: true,
-    anonymous: false,
+    includeInDebugSnapshot: false,
     usedInUi: true,
   },
   nameSources: {
     includeInStateLogs: true,
     persist: true,
-    anonymous: false,
+    includeInDebugSnapshot: false,
     usedInUi: true,
   },
 };
@@ -99,12 +99,10 @@ export type NameControllerActions = GetNameState;
 
 export type NameControllerEvents = NameStateChange;
 
-export type NameControllerMessenger = RestrictedMessenger<
+export type NameControllerMessenger = Messenger<
   typeof controllerName,
   NameControllerActions,
-  NameControllerEvents,
-  never,
-  never
+  NameControllerEvents
 >;
 
 export type NameControllerOptions = {

packages/name-controller/tsconfig.build.json

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

packages/name-controller/tsconfig.json

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

yarn.lock

@@ -3989,6 +3989,7 @@ __metadata:
     "@metamask/auto-changelog": "npm:^3.4.4"
     "@metamask/base-controller": "npm:^8.4.0"
     "@metamask/controller-utils": "npm:^11.14.0"
+    "@metamask/messenger": "npm:^0.3.0"
     "@metamask/utils": "npm:^11.8.1"
     "@types/jest": "npm:^27.4.1"
     async-mutex: "npm:^0.5.0"