refactor: migrate SmartTransactionController to @metamask/messenger

Author: mikesposito

package.json

@@ -38,17 +38,21 @@
     "test": "jest && attw --pack",
     "test:watch": "jest --watchAll"
   },
+  "resolutions": {
+    "@metamask/polling-controller": "npm:@metamask-previews/[email protected]"
+  },
   "dependencies": {
     "@babel/runtime": "^7.24.1",
     "@ethereumjs/tx": "^5.2.1",
     "@ethereumjs/util": "^9.0.2",
     "@ethersproject/bytes": "^5.7.0",
     "@ethersproject/keccak256": "^5.8.0",
     "@ethersproject/transactions": "^5.7.0",
-    "@metamask/base-controller": "^8.3.0",
+    "@metamask/base-controller": "^8.4.0",
     "@metamask/controller-utils": "^11.0.0",
     "@metamask/eth-json-rpc-provider": "^4.1.6",
     "@metamask/eth-query": "^4.0.0",
+    "@metamask/messenger": "^0.3.0",
     "@metamask/polling-controller": "^14.0.0",
     "bignumber.js": "^9.0.1",
     "fast-json-patch": "^3.1.0",

src/SmartTransactionsController.test.ts

@@ -1,9 +1,16 @@
-import { deriveStateFromMetadata, Messenger } from '@metamask/base-controller';
+import { deriveStateFromMetadata } from '@metamask/base-controller/next';
 import {
   NetworkType,
   convertHexToDecimal,
   ChainId,
 } from '@metamask/controller-utils';
+import {
+  Messenger,
+  MessengerActions,
+  MessengerEvents,
+  MockAnyNamespace,
+  MOCK_ANY_NAMESPACE,
+} from '@metamask/messenger';
 import {
   type NetworkControllerGetNetworkClientByIdAction,
   type NetworkControllerGetStateAction,
@@ -37,6 +44,7 @@ import {
   DEFAULT_INTERVAL,
   SmartTransactionsController,
   getDefaultSmartTransactionsControllerState,
+  type SmartTransactionsControllerMessenger,
 } from './SmartTransactionsController';
 import type {
   SmartTransactionsControllerActions,
@@ -46,6 +54,12 @@ import type { SmartTransaction, UnsignedTransaction, Hex } from './types';
 import { SmartTransactionStatuses, ClientId } from './types';
 import * as utils from './utils';
 
+type AllActions = MessengerActions<SmartTransactionsControllerMessenger>;
+
+type AllEvents = MessengerEvents<SmartTransactionsControllerMessenger>;
+
+type RootMessenger = Messenger<MockAnyNamespace, AllActions, AllEvents>;
+
 jest.mock('@metamask/eth-query', () => {
   const EthQuery = jest.requireActual('@metamask/eth-query');
   return class FakeEthQuery extends EthQuery {
@@ -2540,7 +2554,7 @@ describe('SmartTransactionsController', () => {
           deriveStateFromMetadata(
             controller.state,
             controller.metadata,
-            'anonymous',
+            'includeInDebugSnapshot',
           ),
         ).toMatchInlineSnapshot(`
           {
@@ -2717,17 +2731,10 @@ async function withController<ReturnValue>(
     updateTransaction = jest.fn(),
   } = rest;
 
-  const controllerMessenger = new Messenger<
-    | SmartTransactionsControllerActions
-    | NetworkControllerGetNetworkClientByIdAction
-    | NetworkControllerGetStateAction
-    | TransactionControllerGetNonceLockAction
-    | TransactionControllerConfirmExternalTransactionAction
-    | TransactionControllerGetTransactionsAction
-    | TransactionControllerUpdateTransactionAction,
-    SmartTransactionsControllerEvents | NetworkControllerStateChangeEvent
-  >();
-  controllerMessenger.registerActionHandler(
+  const rootMessenger: RootMessenger = new Messenger({
+    namespace: MOCK_ANY_NAMESPACE,
+  });
+  rootMessenger.registerActionHandler(
     'NetworkController:getNetworkClientById',
     jest.fn().mockImplementation((networkClientId) => {
       switch (networkClientId) {
@@ -2750,7 +2757,7 @@ async function withController<ReturnValue>(
       }
     }),
   );
-  controllerMessenger.registerActionHandler(
+  rootMessenger.registerActionHandler(
     'NetworkController:getState',
     jest.fn().mockReturnValue({
       selectedNetworkClientId: NetworkType.mainnet,
@@ -2788,34 +2795,43 @@ async function withController<ReturnValue>(
       },
     }),
   );
-  controllerMessenger.registerActionHandler(
+  rootMessenger.registerActionHandler(
     'TransactionController:getNonceLock',
     getNonceLock,
   );
-  controllerMessenger.registerActionHandler(
+  rootMessenger.registerActionHandler(
     'TransactionController:confirmExternalTransaction',
     confirmExternalTransaction,
   );
-  controllerMessenger.registerActionHandler(
+  rootMessenger.registerActionHandler(
     'TransactionController:getTransactions',
     getTransactions,
   );
-  controllerMessenger.registerActionHandler(
+  rootMessenger.registerActionHandler(
     'TransactionController:updateTransaction',
     updateTransaction,
   );
 
-  const messenger = controllerMessenger.getRestricted({
-    name: 'SmartTransactionsController',
-    allowedActions: [
+  const messenger = new Messenger<
+    'SmartTransactionsController',
+    AllActions,
+    AllEvents,
+    RootMessenger
+  >({
+    namespace: 'SmartTransactionsController',
+    parent: rootMessenger,
+  });
+  rootMessenger.delegate({
+    messenger,
+    actions: [
       'NetworkController:getNetworkClientById',
       'NetworkController:getState',
       'TransactionController:getNonceLock',
       'TransactionController:confirmExternalTransaction',
       'TransactionController:getTransactions',
       'TransactionController:updateTransaction',
     ],
-    allowedEvents: ['NetworkController:stateChange'],
+    events: ['NetworkController:stateChange'],
   });
 
   const controller = new SmartTransactionsController({
@@ -2834,7 +2850,7 @@ async function withController<ReturnValue>(
   });
 
   function triggerNetworStateChange(state: NetworkState) {
-    controllerMessenger.publish('NetworkController:stateChange', state, []);
+    rootMessenger.publish('NetworkController:stateChange', state, []);
   }
 
   triggerNetworStateChange({

src/SmartTransactionsController.ts

@@ -2,9 +2,8 @@ import { hexlify } from '@ethersproject/bytes';
 import type {
   ControllerGetStateAction,
   ControllerStateChangeEvent,
-  RestrictedMessenger,
   StateMetadata,
-} from '@metamask/base-controller';
+} from '@metamask/base-controller/next';
 import {
   query,
   safelyExecute,
@@ -13,6 +12,7 @@ import {
   type TraceCallback,
 } from '@metamask/controller-utils';
 import EthQuery from '@metamask/eth-query';
+import type { Messenger } from '@metamask/messenger';
 import type {
   NetworkClientId,
   NetworkControllerGetNetworkClientByIdAction,
@@ -82,7 +82,7 @@ const controllerMetadata: StateMetadata<SmartTransactionsControllerState> = {
   smartTransactionsState: {
     includeInStateLogs: true,
     persist: false,
-    anonymous: true,
+    includeInDebugSnapshot: true,
     usedInUi: true,
   },
 };
@@ -187,12 +187,10 @@ type AllowedEvents = NetworkControllerStateChangeEvent;
 /**
  * The messenger of the {@link SmartTransactionsController}.
  */
-export type SmartTransactionsControllerMessenger = RestrictedMessenger<
+export type SmartTransactionsControllerMessenger = Messenger<
   typeof controllerName,
   SmartTransactionsControllerActions | AllowedActions,
-  SmartTransactionsControllerEvents | AllowedEvents,
-  AllowedActions['type'],
-  AllowedEvents['type']
+  SmartTransactionsControllerEvents | AllowedEvents
 >;
 
 type SmartTransactionsControllerOptions = {
@@ -294,13 +292,13 @@ export class SmartTransactionsController extends StaticIntervalPollingController
 
     this.initializeSmartTransactionsForChainId();
 
-    this.messagingSystem.subscribe(
+    this.messenger.subscribe(
       'NetworkController:stateChange',
       ({ selectedNetworkClientId }) => {
         const {
           configuration: { chainId },
           provider,
-        } = this.messagingSystem.call(
+        } = this.messenger.call(
           'NetworkController:getNetworkClientById',
           selectedNetworkClientId,
         );
@@ -311,9 +309,8 @@ export class SmartTransactionsController extends StaticIntervalPollingController
       },
     );
 
-    this.messagingSystem.subscribe(
-      `${controllerName}:stateChange`,
-      (currentState) => this.checkPoll(currentState),
+    this.messenger.subscribe(`${controllerName}:stateChange`, (currentState) =>
+      this.checkPoll(currentState),
     );
   }
 
@@ -430,7 +427,7 @@ export class SmartTransactionsController extends StaticIntervalPollingController
     let ethQuery = this.#ethQuery;
     let chainId = this.#chainId;
     if (networkClientId) {
-      const { configuration, provider } = this.messagingSystem.call(
+      const { configuration, provider } = this.messenger.call(
         'NetworkController:getNetworkClientById',
         networkClientId,
       );
@@ -565,7 +562,7 @@ export class SmartTransactionsController extends StaticIntervalPollingController
 
     // We have to emit this event here, because then a txHash is returned to the TransactionController once it's available
     // and the #doesTransactionNeedConfirmation function will work properly, since it will find the txHash in the regular transactions list.
-    this.messagingSystem.publish(
+    this.messenger.publish(
       `SmartTransactionsController:smartTransaction`,
       nextSmartTransaction,
     );
@@ -580,9 +577,9 @@ export class SmartTransactionsController extends StaticIntervalPollingController
       markRegularTransactionAsFailed({
         smartTransaction: nextSmartTransaction,
         getRegularTransactions: () =>
-          this.messagingSystem.call('TransactionController:getTransactions'),
+          this.messenger.call('TransactionController:getTransactions'),
         updateTransaction: (transactionMeta: TransactionMeta, note: string) =>
-          this.messagingSystem.call(
+          this.messenger.call(
             'TransactionController:updateTransaction',
             transactionMeta,
             note,
@@ -650,7 +647,7 @@ export class SmartTransactionsController extends StaticIntervalPollingController
     if (!txHash) {
       return true;
     }
-    const transactions = this.messagingSystem.call(
+    const transactions = this.messenger.call(
       'TransactionController:getTransactions',
     );
     const foundTransaction = transactions?.find((tx) => {
@@ -733,7 +730,7 @@ export class SmartTransactionsController extends StaticIntervalPollingController
             : originalTxMeta;
 
         if (this.#doesTransactionNeedConfirmation(txHash)) {
-          this.messagingSystem.call(
+          this.messenger.call(
             'TransactionController:confirmExternalTransaction',
             // TODO: Replace 'as' assertion with correct typing for `txMeta`
             txMeta as TransactionMeta,
@@ -763,7 +760,7 @@ export class SmartTransactionsController extends StaticIntervalPollingController
       });
       console.error('confirm error', error);
     } finally {
-      this.messagingSystem.publish(
+      this.messenger.publish(
         `SmartTransactionsController:smartTransactionConfirmationDone`,
         smartTransaction,
       );
@@ -829,7 +826,7 @@ export class SmartTransactionsController extends StaticIntervalPollingController
     transaction: UnsignedTransaction,
     networkClientId: NetworkClientId,
   ): Promise<UnsignedTransaction> {
-    const nonceLock = await this.messagingSystem.call(
+    const nonceLock = await this.messenger.call(
       'TransactionController:getNonceLock',
       transaction.from,
       networkClientId,
@@ -861,8 +858,7 @@ export class SmartTransactionsController extends StaticIntervalPollingController
   ): Promise<Fees> {
     const selectedNetworkClientId =
       networkClientId ??
-      this.messagingSystem.call('NetworkController:getState')
-        .selectedNetworkClientId;
+      this.messenger.call('NetworkController:getState').selectedNetworkClientId;
     const chainId = this.#getChainId({
       networkClientId: selectedNetworkClientId,
     });
@@ -942,8 +938,7 @@ export class SmartTransactionsController extends StaticIntervalPollingController
   }) {
     const selectedNetworkClientId =
       networkClientId ??
-      this.messagingSystem.call('NetworkController:getState')
-        .selectedNetworkClientId;
+      this.messenger.call('NetworkController:getState').selectedNetworkClientId;
     const chainId = this.#getChainId({
       networkClientId: selectedNetworkClientId,
     });
@@ -985,7 +980,7 @@ export class SmartTransactionsController extends StaticIntervalPollingController
     // This should only happen for Swaps. Non-swaps transactions should already have a nonce
     if (requiresNonce) {
       try {
-        nonceLock = await this.messagingSystem.call(
+        nonceLock = await this.messenger.call(
           'TransactionController:getNonceLock',
           txParams.from,
           selectedNetworkClientId,
@@ -1041,7 +1036,7 @@ export class SmartTransactionsController extends StaticIntervalPollingController
     networkClientId,
   }: { networkClientId?: NetworkClientId } = {}): Hex {
     if (networkClientId) {
-      return this.messagingSystem.call(
+      return this.messenger.call(
         'NetworkController:getNetworkClientById',
         networkClientId,
       ).configuration.chainId;
@@ -1051,7 +1046,7 @@ export class SmartTransactionsController extends StaticIntervalPollingController
   }
 
   #getChainIds(): Hex[] {
-    const { networkConfigurationsByChainId } = this.messagingSystem.call(
+    const { networkConfigurationsByChainId } = this.messenger.call(
       'NetworkController:getState',
     );
     return Object.keys(networkConfigurationsByChainId).filter(
@@ -1061,7 +1056,7 @@ export class SmartTransactionsController extends StaticIntervalPollingController
   }
 
   #getNetworkClientId({ chainId }: { chainId: string }): string {
-    const { networkConfigurationsByChainId } = this.messagingSystem.call(
+    const { networkConfigurationsByChainId } = this.messenger.call(
       'NetworkController:getState',
     );
     return networkConfigurationsByChainId[chainId as Hex].rpcEndpoints[
@@ -1075,7 +1070,7 @@ export class SmartTransactionsController extends StaticIntervalPollingController
     networkClientId?: NetworkClientId;
   } = {}): EthQuery {
     if (networkClientId) {
-      const { provider } = this.messagingSystem.call(
+      const { provider } = this.messenger.call(
         'NetworkController:getNetworkClientById',
         networkClientId,
       );

tsconfig.json

@@ -3,7 +3,7 @@
     "esModuleInterop": true,
     "lib": ["DOM", "ES2020"],
     "module": "CommonJS",
-    "moduleResolution": "node",
+    "moduleResolution": "Node16",
     "noEmit": true,
     "noErrorTruncation": true,
     "resolveJsonModule": true,