feat(STX-331): replace legacy STX swaps flags with smart transaction …

…flags from remote config API

app/scripts/controller-init/messengers/smart-transactions-controller-messenger.ts

@@ -1,55 +1,46 @@
-import { Messenger } from '@metamask/messenger';
-import type {
-  TransactionControllerConfirmExternalTransactionAction,
-  TransactionControllerGetNonceLockAction,
-  TransactionControllerGetTransactionsAction,
-  TransactionControllerUpdateTransactionAction,
-} from '@metamask/transaction-controller';
 import {
-  NetworkControllerGetNetworkClientByIdAction,
-  NetworkControllerGetStateAction,
-  NetworkControllerStateChangeEvent,
-} from '@metamask/network-controller';
+  Messenger,
+  MessengerActions,
+  MessengerEvents,
+} from '@metamask/messenger';
+import { SmartTransactionsControllerMessenger } from '@metamask/smart-transactions-controller';
 import { MetaMetricsControllerTrackEventAction } from '../../controllers/metametrics-controller';
 import { RootMessenger } from '../../lib/messenger';
 
-type MessengerActions =
-  | NetworkControllerGetNetworkClientByIdAction
-  | NetworkControllerGetStateAction
-  | TransactionControllerGetNonceLockAction
-  | TransactionControllerGetTransactionsAction
-  | TransactionControllerUpdateTransactionAction
-  | TransactionControllerConfirmExternalTransactionAction;
-
-type MessengerEvents = NetworkControllerStateChangeEvent;
-
-export type SmartTransactionsControllerMessenger = ReturnType<
-  typeof getSmartTransactionsControllerMessenger
->;
-
+/**
+ * Get the messenger for the smart transactions controller. This is scoped to the
+ * actions and events that the smart transactions controller is allowed to handle.
+ *
+ * @param rootMessenger - The root messenger.
+ * @returns The SmartTransactionsControllerMessenger.
+ */
 export function getSmartTransactionsControllerMessenger(
-  messenger: RootMessenger<MessengerActions, MessengerEvents>,
-) {
+  rootMessenger: RootMessenger,
+): SmartTransactionsControllerMessenger {
   const controllerMessenger = new Messenger<
     'SmartTransactionsController',
-    MessengerActions,
-    MessengerEvents,
-    typeof messenger
+    MessengerActions<SmartTransactionsControllerMessenger>,
+    MessengerEvents<SmartTransactionsControllerMessenger>,
+    RootMessenger
   >({
     namespace: 'SmartTransactionsController',
-    parent: messenger,
+    parent: rootMessenger,
   });
-  messenger.delegate({
+  rootMessenger.delegate({
     messenger: controllerMessenger,
     actions: [
+      'ErrorReportingService:captureException',
       'NetworkController:getNetworkClientById',
       'NetworkController:getState',
+      'RemoteFeatureFlagController:getState',
       'TransactionController:getNonceLock',
-      'TransactionController:confirmExternalTransaction',
       'TransactionController:getTransactions',
       'TransactionController:updateTransaction',
     ],
-    events: ['NetworkController:stateChange'],
+    events: [
+      'NetworkController:stateChange',
+      'RemoteFeatureFlagController:stateChange',
+    ],
   });
   return controllerMessenger;
 }

app/scripts/controller-init/smart-transactions/smart-transactions-controller-init.test.ts

@@ -20,7 +20,7 @@
 import {
   getSmartTransactionsControllerInitMessenger,
   SmartTransactionsControllerInitMessenger,
   SmartTransactionsControllerMessenger,
 } from '../messengers/smart-transactions-controller-messenger';
 import { ControllerFlatState } from '../controller-list';
 import type {
@@ -35,10 +35,7 @@
 type MockAccountsController = Pick<AccountsController, 'getSelectedAccount'>;
 type MockTransactionController = Pick<
   TransactionController,
-  | 'getNonceLock'
-  | 'confirmExternalTransaction'
-  | 'getTransactions'
-  | 'updateTransaction'
+  'getNonceLock' | 'getTransactions' | 'updateTransaction'
 >;
 
 type TestInitRequest = ControllerInitRequest<
@@ -96,7 +93,6 @@
 
     const transactionController: MockTransactionController = {
       getNonceLock: jest.fn().mockResolvedValue({ releaseLock: jest.fn() }),
-      confirmExternalTransaction: jest.fn(),
       getTransactions: jest.fn().mockReturnValue([]),
       updateTransaction: jest.fn(),
     };
@@ -324,63 +320,6 @@
     expect(listener).toHaveBeenCalledWith(testPayload);
   });
 
-  describe('getFeatureFlags', () => {
-    it('returns feature flags from state', () => {
-      const { fullRequest } = buildInitRequest();
-      SmartTransactionsControllerInit(fullRequest);
-
-      const constructorCall =
-        smartTransactionsControllerClassMock.mock.calls[0][0];
-      const { getFeatureFlags } = constructorCall;
-
-      const result = getFeatureFlags();
-
-      expect(fullRequest.getUIState).toHaveBeenCalled();
-      expect(result).toHaveProperty('smartTransactions');
-      expect(result.smartTransactions).toHaveProperty('extensionActive');
-      expect(result.smartTransactions).toHaveProperty('mobileActive');
-      expect(result.smartTransactions).toHaveProperty('expectedDeadline');
-      expect(result.smartTransactions).toHaveProperty('maxDeadline');
-      expect(result.smartTransactions).toHaveProperty(
-        'extensionReturnTxHashAsap',
-      );
-    });
-
-    it('returns default feature flags when getFeatureFlagsByChainId returns null', () => {
-      // To test the null case, we need to make getStateUI return a state
-      // that would cause getFeatureFlagsByChainId to return null
-      const { fullRequest } = buildInitRequest({
-        getUIState: jest.fn().mockReturnValue({
-          preferences: {},
-          selectedNetworkClientId: 'mainnet',
-          networkConfigurationsByChainId: {
-            '0x1': {
-              chainId: '0x1',
-              rpcEndpoints: [
-                {
-                  networkClientId: 'mainnet',
-                  url: 'https://mainnet.infura.io/v3/abc',
-                },
-              ],
-            },
-          },
-          // No swapsState to test null case
-        }),
-      });
-
-      SmartTransactionsControllerInit(fullRequest);
-
-      const constructorCall =
-        smartTransactionsControllerClassMock.mock.calls[0][0];
-      const { getFeatureFlags } = constructorCall;
-
-      const result = getFeatureFlags();
-
-      // When getFeatureFlagsByChainId returns null, the result should be null
-      expect(result).toBeNull();
-    });
-  });
-
   describe('getMetaMetricsProps', () => {
     it('returns correct meta metrics properties', async () => {
       const { fullRequest } = buildInitRequest();

app/scripts/controller-init/smart-transactions/smart-transactions-controller-init.ts

@@ -1,19 +1,13 @@
 import {
   SmartTransactionsController,
+  SmartTransactionsControllerMessenger,
   ClientId,
 } from '@metamask/smart-transactions-controller';
 import type { Hex } from '@metamask/utils';
 import type { TraceCallback } from '@metamask/controller-utils';
 import { getAllowedSmartTransactionsChainIds } from '../../../../shared/constants/smartTransactions';
-import { getFeatureFlagsByChainId } from '../../../../shared/modules/selectors';
-import { type ProviderConfigState } from '../../../../shared/modules/selectors/networks';
-import { type FeatureFlagsMetaMaskState } from '../../../../shared/modules/selectors/feature-flags';
-import type { FeatureFlags } from '../../lib/smart-transaction/smart-transactions';
 import { ControllerInitFunction, ControllerInitRequest } from '../types';
-import {
-  SmartTransactionsControllerInitMessenger,
-  SmartTransactionsControllerMessenger,
-} from '../messengers/smart-transactions-controller-messenger';
+import { SmartTransactionsControllerInitMessenger } from '../messengers/smart-transactions-controller-messenger';
 // This import is only used for the type.
 // eslint-disable-next-line import/no-restricted-paths
 import type { MetaMaskReduxState } from '../../../../ui/store/store';
@@ -46,7 +40,7 @@
     trace,
   } = request as SmartTransactionsControllerInitRequest;
 
   const smartTransactionsController = new SmartTransactionsController({
     supportedChainIds: getAllowedSmartTransactionsChainIds() as Hex[],
     clientId: ClientId.Extension,
     trackMetaMetricsEvent: initMessenger.call.bind(
@@ -57,12 +51,6 @@
     >[0]['trackMetaMetricsEvent'],
     state: persistedState.SmartTransactionsController,
     messenger: controllerMessenger,
-    getFeatureFlags: () => {
-      const state = { metamask: getUIState() };
-      return getFeatureFlagsByChainId(
-        state as unknown as ProviderConfigState & FeatureFlagsMetaMaskState,
-      ) as unknown as FeatureFlags;
-    },
     getMetaMetricsProps: async () => {
       const metamask = getUIState();
       const { internalAccounts } = metamask;