refactor: migrate MultichainAccountService to @metamask/messenger

Author: cryptodev-2s

packages/multichain-account-service/CHANGELOG.md

@@ -13,6 +13,11 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
   - Add `multichainAccountGroupCreated` event emitted from wallet level when new groups are created.
   - Add `multichainAccountGroupUpdated` event emitted from wallet level when groups are synchronized.
 
+### Changed
+
+- **BREAKING:** Use new `Messenger` from `@metamask/messenger` ([#6544](https://github.com/MetaMask/core/pull/6544))
+  - Previously, `MultichainAccountService` accepted a `RestrictedMessenger` instance from `@metamask/base-controller`.
+
 ## [0.7.0]
 
 ### Added

packages/multichain-account-service/package.json

@@ -53,6 +53,7 @@
     "@metamask/keyring-internal-api": "^8.1.0",
     "@metamask/keyring-snap-client": "^7.0.0",
     "@metamask/keyring-utils": "^3.1.0",
+    "@metamask/messenger": "^0.2.0",
     "@metamask/snaps-sdk": "^9.0.0",
     "@metamask/snaps-utils": "^11.0.0",
     "@metamask/superstruct": "^3.1.0",

packages/multichain-account-service/src/MultichainAccountService.test.ts

@@ -1,6 +1,5 @@
 /* eslint-disable jsdoc/require-jsdoc */
 
-import type { Messenger } from '@metamask/base-controller';
 import type { KeyringAccount } from '@metamask/keyring-api';
 import { EthAccountType, SolAccountType } from '@metamask/keyring-api';
 import { KeyringTypes, type KeyringObject } from '@metamask/keyring-controller';
@@ -27,14 +26,9 @@ import {
   makeMockAccountProvider,
   mockAsInternalAccount,
   setupAccountProvider,
+  type RootMessenger,
 } from './tests';
-import type {
-  AllowedActions,
-  AllowedEvents,
-  MultichainAccountServiceActions,
-  MultichainAccountServiceEvents,
-  MultichainAccountServiceMessenger,
-} from './types';
+import type { MultichainAccountServiceMessenger } from './types';
 
 // Mock providers.
 jest.mock('./providers/EvmAccountProvider', () => {
@@ -84,18 +78,12 @@ function setup({
   keyrings = [MOCK_HD_KEYRING_1, MOCK_HD_KEYRING_2],
   accounts,
 }: {
-  messenger?: Messenger<
-    MultichainAccountServiceActions | AllowedActions,
-    MultichainAccountServiceEvents | AllowedEvents
-  >;
+  messenger?: RootMessenger;
   keyrings?: KeyringObject[];
   accounts?: KeyringAccount[];
 } = {}): {
   service: MultichainAccountService;
-  messenger: Messenger<
-    MultichainAccountServiceActions | AllowedActions,
-    MultichainAccountServiceEvents | AllowedEvents
-  >;
+  messenger: RootMessenger;
   mocks: Mocks;
 } {
   const mocks: Mocks = {

packages/multichain-account-service/src/providers/EvmAccountProvider.test.ts

@@ -1,4 +1,3 @@
-import type { Messenger } from '@metamask/base-controller';
 import { type KeyringMetadata } from '@metamask/keyring-controller';
 import type {
   EthKeyring,
@@ -17,13 +16,8 @@ import {
   MOCK_HD_ACCOUNT_2,
   MOCK_HD_KEYRING_1,
   MockAccountBuilder,
+  type RootMessenger,
 } from '../tests';
-import type {
-  AllowedActions,
-  AllowedEvents,
-  MultichainAccountServiceActions,
-  MultichainAccountServiceEvents,
-} from '../types';
 
 class MockEthKeyring implements EthKeyring {
   readonly type = 'MockEthKeyring';
@@ -90,17 +84,11 @@ function setup({
   messenger = getRootMessenger(),
   accounts = [],
 }: {
-  messenger?: Messenger<
-    MultichainAccountServiceActions | AllowedActions,
-    MultichainAccountServiceEvents | AllowedEvents
-  >;
+  messenger?: RootMessenger;
   accounts?: InternalAccount[];
 } = {}): {
   provider: EvmAccountProvider;
-  messenger: Messenger<
-    MultichainAccountServiceActions | AllowedActions,
-    MultichainAccountServiceEvents | AllowedEvents
-  >;
+  messenger: RootMessenger;
   keyring: MockEthKeyring;
   mocks: {
     getAccountByAddress: jest.Mock;

packages/multichain-account-service/src/providers/SolAccountProvider.test.ts

@@ -1,11 +1,11 @@
 import { isBip44Account } from '@metamask/account-api';
-import type { Messenger } from '@metamask/base-controller';
 import type { SnapKeyring } from '@metamask/eth-snap-keyring';
 import type { KeyringMetadata } from '@metamask/keyring-controller';
 import type {
   EthKeyring,
   InternalAccount,
 } from '@metamask/keyring-internal-api';
+import type { Messenger } from '@metamask/messenger';
 
 import { AccountProviderWrapper } from './AccountProviderWrapper';
 import { SolAccountProvider } from './SolAccountProvider';
@@ -17,13 +17,8 @@ import {
   MOCK_SOL_ACCOUNT_1,
   MOCK_SOL_DISCOVERED_ACCOUNT_1,
   MockAccountBuilder,
+  type RootMessenger,
 } from '../tests';
-import type {
-  AllowedActions,
-  AllowedEvents,
-  MultichainAccountServiceActions,
-  MultichainAccountServiceEvents,
-} from '../types';
 
 class MockSolanaKeyring {
   readonly type = 'MockSolanaKeyring';
@@ -94,17 +89,11 @@ function setup({
   messenger = getRootMessenger(),
   accounts = [],
 }: {
-  messenger?: Messenger<
-    MultichainAccountServiceActions | AllowedActions,
-    MultichainAccountServiceEvents | AllowedEvents
-  >;
+  messenger?: RootMessenger;
   accounts?: InternalAccount[];
 } = {}): {
   provider: AccountProviderWrapper;
-  messenger: Messenger<
-    MultichainAccountServiceActions | AllowedActions,
-    MultichainAccountServiceEvents | AllowedEvents
-  >;
+  messenger: RootMessenger;
   keyring: MockSolanaKeyring;
   mocks: {
     handleRequest: jest.Mock;

packages/multichain-account-service/src/tests/messenger.ts

@@ -1,42 +1,57 @@
-import { Messenger } from '@metamask/base-controller';
+import {
+  Messenger,
+  MOCK_ANY_NAMESPACE,
+  type MessengerActions,
+  type MessengerEvents,
+  type MockAnyNamespace,
+} from '@metamask/messenger';
 
-import type {
-  AllowedActions,
-  AllowedEvents,
-  MultichainAccountServiceActions,
-  MultichainAccountServiceEvents,
-  MultichainAccountServiceMessenger,
-} from '../types';
+import type { MultichainAccountServiceMessenger } from '../types';
+
+type AllMultichainAccountServiceActions =
+  MessengerActions<MultichainAccountServiceMessenger>;
+
+type AllMultichainAccountServiceEvents =
+  MessengerEvents<MultichainAccountServiceMessenger>;
+
+export type RootMessenger = Messenger<
+  MockAnyNamespace,
+  AllMultichainAccountServiceActions,
+  AllMultichainAccountServiceEvents
+>;
 
 /**
- * Creates a new root messenger instance for testing.
+ * Creates and returns a root messenger for testing
  *
- * @returns A new Messenger instance.
+ * @returns A messenger instance
  */
-export function getRootMessenger() {
-  return new Messenger<
-    MultichainAccountServiceActions | AllowedActions,
-    MultichainAccountServiceEvents | AllowedEvents
-  >();
+export function getRootMessenger(): RootMessenger {
+  return new Messenger({
+    namespace: MOCK_ANY_NAMESPACE,
+  });
 }
 
 /**
  * Retrieves a restricted messenger for the MultichainAccountService.
  *
- * @param messenger - The root messenger instance. Defaults to a new Messenger created by getRootMessenger().
+ * @param rootMessenger - The root messenger instance. Defaults to a new Messenger created by getRootMessenger().
  * @returns The restricted messenger for the MultichainAccountService.
  */
 export function getMultichainAccountServiceMessenger(
-  messenger: ReturnType<typeof getRootMessenger>,
+  rootMessenger: RootMessenger,
 ): MultichainAccountServiceMessenger {
-  return messenger.getRestricted({
-    name: 'MultichainAccountService',
-    allowedEvents: [
-      'KeyringController:stateChange',
-      'AccountsController:accountAdded',
-      'AccountsController:accountRemoved',
-    ],
-    allowedActions: [
+  const messenger = new Messenger<
+    'MultichainAccountService',
+    AllMultichainAccountServiceActions,
+    AllMultichainAccountServiceEvents,
+    RootMessenger
+  >({
+    namespace: 'MultichainAccountService',
+    parent: rootMessenger,
+  });
+  rootMessenger.delegate({
+    messenger,
+    actions: [
       'AccountsController:getAccount',
       'AccountsController:getAccountByAddress',
       'AccountsController:listMultichainAccounts',
@@ -46,5 +61,11 @@ export function getMultichainAccountServiceMessenger(
       'NetworkController:findNetworkClientIdByChainId',
       'NetworkController:getNetworkClientById',
     ],
+    events: [
+      'KeyringController:stateChange',
+      'AccountsController:accountAdded',
+      'AccountsController:accountRemoved',
+    ],
   });
+  return messenger;
 }

packages/multichain-account-service/src/types.ts

@@ -9,13 +9,13 @@ import type {
   AccountsControllerGetAccountByAddressAction,
   AccountsControllerListMultichainAccountsAction,
 } from '@metamask/accounts-controller';
-import type { RestrictedMessenger } from '@metamask/base-controller';
 import type { KeyringAccount } from '@metamask/keyring-api';
 import type {
   KeyringControllerGetStateAction,
   KeyringControllerStateChangeEvent,
   KeyringControllerWithKeyringAction,
 } from '@metamask/keyring-controller';
+import type { Messenger } from '@metamask/messenger';
 import type {
   NetworkControllerFindNetworkClientIdByChainIdAction,
   NetworkControllerGetNetworkClientByIdAction,
@@ -115,7 +115,7 @@ export type MultichainAccountServiceEvents =
  * All actions registered by other modules that {@link MultichainAccountService}
  * calls.
  */
-export type AllowedActions =
+type AllowedActions =
   | AccountsControllerListMultichainAccountsAction
   | AccountsControllerGetAccountAction
   | AccountsControllerGetAccountByAddressAction
@@ -129,7 +129,7 @@ export type AllowedActions =
  * All events published by other modules that {@link MultichainAccountService}
  * subscribes to.
  */
-export type AllowedEvents =
+type AllowedEvents =
   | KeyringControllerStateChangeEvent
   | AccountsControllerAccountAddedEvent
   | AccountsControllerAccountRemovedEvent;
@@ -138,10 +138,8 @@ export type AllowedEvents =
  * The messenger restricted to actions and events that
  * {@link MultichainAccountService} needs to access.
  */
-export type MultichainAccountServiceMessenger = RestrictedMessenger<
+export type MultichainAccountServiceMessenger = Messenger<
   'MultichainAccountService',
   MultichainAccountServiceActions | AllowedActions,
-  MultichainAccountServiceEvents | AllowedEvents,
-  AllowedActions['type'],
-  AllowedEvents['type']
+  MultichainAccountServiceEvents | AllowedEvents
 >;

yarn.lock

@@ -3829,6 +3829,7 @@ __metadata:
     "@metamask/keyring-internal-api": "npm:^8.1.0"
     "@metamask/keyring-snap-client": "npm:^7.0.0"
     "@metamask/keyring-utils": "npm:^3.1.0"
+    "@metamask/messenger": "npm:^0.2.0"
     "@metamask/providers": "npm:^22.1.0"
     "@metamask/snaps-controllers": "npm:^14.0.1"
     "@metamask/snaps-sdk": "npm:^9.0.0"