feat: disable enforced simulations (#33802)

## **Description**

Support disabling enforced simulations via a new simulation settings
modal.

Specifically:

- Add `enableEnforcedSimulations` and
`enableEnforcedSimulationsForTransactions` to `AppStateController`.
- Add `applyTransactionContainersExisting` utility method to apply
transaction containers to an existing transaction.
- Add `SimulationSettingsModal` component to configure enforced
simulation settings.
- Add `useIsEnforcedSimulationsSupported` hook to determine if settings
should be displayed.
- Check `AppStateController` state in `EnforceSimulationHook`.

[![Open in GitHub
Codespaces](https://github.com/codespaces/badge.svg)](https://codespaces.new/MetaMask/metamask-extension/pull/33802?quickstart=1)

## **Related issues**

Fixes:
[#5173](MetaMask/MetaMask-planning#5173)

## **Manual testing steps**

## **Screenshots/Recordings**

### **Before**

### **After**

<img width="393" alt="Modal"
src="https://github.com/user-attachments/assets/fc5b8703-c853-4a9e-8d67-9b31337ed68d"
/>

## **Pre-merge author checklist**

- [x] I've followed [MetaMask Contributor
Docs](https://github.com/MetaMask/contributor-docs) and [MetaMask
Extension Coding
Standards](https://github.com/MetaMask/metamask-extension/blob/main/.github/guidelines/CODING_GUIDELINES.md).
- [x] I've completed the PR template to the best of my ability
- [x] I’ve included tests if applicable
- [x] I’ve documented my code using [JSDoc](https://jsdoc.app/) format
if applicable
- [x] I’ve applied the right labels on the PR (see [labeling
guidelines](https://github.com/MetaMask/metamask-extension/blob/main/.github/guidelines/LABELING_GUIDELINES.md)).
Not required for external contributors.

## **Pre-merge reviewer checklist**

- [ ] I've manually tested the PR (e.g. pull and build branch, run the
app, test code being changed).
- [ ] I confirm that this PR addresses all acceptance criteria described
in the ticket it closes and includes the necessary testing evidence such
as recordings and or screenshots.

Author: matthewwalsh0

app/_locales/en/messages.json

@@ -60,6 +60,8 @@ export const SENTRY_BACKGROUND_STATE = {
     onboardingDate: false,
     currentExtensionPopupId: false,
     defaultHomeActiveTabName: true,
+    enableEnforcedSimulations: true,
+    enableEnforcedSimulationsForTransactions: false,
     fullScreenGasPollTokens: true,
     // TODO: Fix in https://github.com/MetaMask/metamask-extension/issues/31860
     // eslint-disable-next-line @typescript-eslint/naming-convention

app/_locales/en_GB/messages.json

@@ -12,6 +12,7 @@ import {
 } from '@metamask/network-controller';
 import {
   TransactionControllerEstimateGasAction,
+  TransactionControllerGetStateAction,
   TransactionControllerMessenger,
   TransactionControllerPostTransactionBalanceUpdatedEvent,
   TransactionControllerTransactionApprovedEvent,
@@ -35,6 +36,7 @@ import {
   SwapsControllerSetApproveTxIdAction,
   SwapsControllerSetTradeTxIdAction,
 } from '../../controllers/swaps/swaps.types';
+import { AppStateControllerGetStateAction } from '../../controllers/app-state-controller';
 import {
   InstitutionalSnapControllerPublishHookAction,
   InstitutionalSnapControllerBeforeCheckPendingTransactionHookAction,
@@ -44,6 +46,7 @@ type MessengerActions =
   | ApprovalControllerActions
   | AccountsControllerGetSelectedAccountAction
   | AccountsControllerGetStateAction
+  | AppStateControllerGetStateAction
   | DelegationControllerSignDelegationAction
   | InstitutionalSnapControllerPublishHookAction
   | InstitutionalSnapControllerBeforeCheckPendingTransactionHookAction
@@ -55,7 +58,8 @@ type MessengerActions =
   | RemoteFeatureFlagControllerGetStateAction
   | SwapsControllerSetApproveTxIdAction
   | SwapsControllerSetTradeTxIdAction
-  | TransactionControllerEstimateGasAction;
+  | TransactionControllerEstimateGasAction
+  | TransactionControllerGetStateAction;
 
 type MessengerEvents =
   | TransactionControllerTransactionApprovedEvent
@@ -117,6 +121,7 @@ export function getTransactionControllerInitMessenger(
       'ApprovalController:endFlow',
       'ApprovalController:startFlow',
       'ApprovalController:updateRequestState',
+      'AppStateController:getState',
       'DelegationController:signDelegation',
       'InstitutionalSnapController:beforeCheckPendingTransactionHook',
       'InstitutionalSnapController:publishHook',
@@ -127,6 +132,7 @@ export function getTransactionControllerInitMessenger(
       'SwapsController:setApproveTxId',
       'SwapsController:setTradeTxId',
       'TransactionController:estimateGas',
+      'TransactionController:getState',
     ],
   });
 }

app/scripts/constants/sentry-state.ts

@@ -45,6 +45,8 @@ const extensionMock = {
   },
 } as unknown as jest.Mocked<Browser>;
 
+const TRANSACTION_ID_MOCK = '123-456';
+
 describe('AppStateController', () => {
   describe('setOutdatedBrowserWarningLastShown', () => {
     it('sets the last shown time', async () => {
@@ -610,6 +612,46 @@ describe('AppStateController', () => {
       });
     });
   });
+
+  describe('setEnableEnforcedSimulations', () => {
+    it('updates the enableEnforcedSimulations state', async () => {
+      await withController(({ controller }) => {
+        controller.setEnableEnforcedSimulations(false);
+        expect(controller.state.enableEnforcedSimulations).toBe(false);
+
+        controller.setEnableEnforcedSimulations(true);
+        expect(controller.state.enableEnforcedSimulations).toBe(true);
+      });
+    });
+  });
+
+  describe('setEnableEnforcedSimulationsForTransaction', () => {
+    it('updates the enableEnforcedSimulationsForTransactions state', async () => {
+      await withController(({ controller }) => {
+        controller.setEnableEnforcedSimulationsForTransaction(
+          TRANSACTION_ID_MOCK,
+          true,
+        );
+
+        expect(
+          controller.state.enableEnforcedSimulationsForTransactions,
+        ).toStrictEqual({
+          [TRANSACTION_ID_MOCK]: true,
+        });
+
+        controller.setEnableEnforcedSimulationsForTransaction(
+          TRANSACTION_ID_MOCK,
+          false,
+        );
+
+        expect(
+          controller.state.enableEnforcedSimulationsForTransactions,
+        ).toStrictEqual({
+          [TRANSACTION_ID_MOCK]: false,
+        });
+      });
+    });
+  });
 });
 
 type WithControllerOptions = {

app/scripts/controller-init/messengers/transaction-controller-messenger.ts

@@ -90,6 +90,8 @@ export type AppStateControllerState = {
   isUpdateAvailable: boolean;
   updateModalLastDismissedAt: number | null;
   lastUpdatedAt: number | null;
+  enableEnforcedSimulations: boolean;
+  enableEnforcedSimulationsForTransactions: Record<string, boolean>;
 };
 
 const controllerName = 'AppStateController';
@@ -209,6 +211,8 @@ const getDefaultAppStateControllerState = (): AppStateControllerState => ({
   isUpdateAvailable: false,
   updateModalLastDismissedAt: null,
   lastUpdatedAt: null,
+  enableEnforcedSimulations: true,
+  enableEnforcedSimulationsForTransactions: {},
   ...getInitialStateOverrides(),
 });
 
@@ -386,6 +390,14 @@ const controllerMetadata = {
     persist: true,
     anonymous: true,
   },
+  enableEnforcedSimulations: {
+    persist: true,
+    anonymous: true,
+  },
+  enableEnforcedSimulationsForTransactions: {
+    persist: false,
+    anonymous: true,
+  },
 };
 
 export class AppStateController extends BaseController<
@@ -1121,4 +1133,19 @@ export class AppStateController extends BaseController<
       state.throttledOrigins[origin] = throttledOriginState;
     });
   }
+
+  setEnableEnforcedSimulations(enabled: boolean): void {
+    this.update((state) => {
+      state.enableEnforcedSimulations = enabled;
+    });
+  }
+
+  setEnableEnforcedSimulationsForTransaction(
+    transactionId: string,
+    enabled: boolean,
+  ): void {
+    this.update((state) => {
+      state.enableEnforcedSimulationsForTransactions[transactionId] = enabled;
+    });
+  }
 }

app/scripts/controllers/app-state-controller.test.ts

@@ -106,7 +106,7 @@ function generateDelegation({
   return delegation;
 }
 
-export function generateCalldata({
+function generateCalldata({
   transaction,
   delegation,
 }: {

app/scripts/controllers/app-state-controller.ts

@@ -1,29 +1,40 @@
 import {
   TransactionContainerType,
   TransactionControllerEstimateGasAction,
+  TransactionControllerGetStateAction,
   TransactionMeta,
 } from '@metamask/transaction-controller';
 import { cloneDeep } from 'lodash';
 import { Messenger } from '@metamask/base-controller';
 import { TransactionControllerInitMessenger } from '../../../controller-init/messengers/transaction-controller-messenger';
-import { applyTransactionContainers } from './util';
+import {
+  applyTransactionContainers,
+  applyTransactionContainersExisting,
+} from './util';
 import { enforceSimulations } from './enforced-simulations';
 
 jest.mock('./enforced-simulations');
 
-const TRANSACTION_META_MOCK = { txParams: {} } as TransactionMeta;
-const CHAIN_ID_MOCK = '0x123' as const;
+const TRANSACTION_ID_MOCK = '123-456';
 const ESTIMATE_GAS_MOCK = '0x456' as const;
+const NEW_DATA_MOCK = '0x789' as const;
+
+const TRANSACTION_META_MOCK = {
+  id: TRANSACTION_ID_MOCK,
+  txParams: {},
+} as TransactionMeta;
 
 describe('Container Utils', () => {
   const enforceSimulationsMock = jest.mocked(enforceSimulations);
+  const getTransactionControllerStateMock = jest.fn();
   let messenger: TransactionControllerInitMessenger;
 
   beforeEach(() => {
     jest.resetAllMocks();
 
     const baseMessenger = new Messenger<
-      TransactionControllerEstimateGasAction,
+      | TransactionControllerEstimateGasAction
+      | TransactionControllerGetStateAction,
       never
     >();
 
@@ -32,17 +43,29 @@ describe('Container Utils', () => {
       async () => ({ gas: ESTIMATE_GAS_MOCK, simulationFails: { debug: {} } }),
     );
 
+    baseMessenger.registerActionHandler(
+      'TransactionController:getState',
+      getTransactionControllerStateMock,
+    );
+
     messenger = baseMessenger.getRestricted({
       name: 'TransactionControllerInitMessenger',
-      allowedActions: ['TransactionController:estimateGas'],
+      allowedActions: [
+        'TransactionController:estimateGas',
+        'TransactionController:getState',
+      ],
       allowedEvents: [],
     });
 
     enforceSimulationsMock.mockResolvedValue({
       updateTransaction: (tx) => {
-        tx.chainId = CHAIN_ID_MOCK;
+        tx.txParams.data = NEW_DATA_MOCK;
       },
     });
+
+    getTransactionControllerStateMock.mockReturnValue({
+      transactions: [],
+    });
   });
 
   describe('applyTransactionContainers', () => {
@@ -57,7 +80,7 @@ describe('Container Utils', () => {
       const transactionToUpdate = cloneDeep(TRANSACTION_META_MOCK);
       updateTransaction(transactionToUpdate);
 
-      expect(transactionToUpdate.chainId).toBe(CHAIN_ID_MOCK);
+      expect(transactionToUpdate.txParams.data).toBe(NEW_DATA_MOCK);
     });
 
     it('updates gas if not approved', async () => {
@@ -90,4 +113,45 @@ describe('Container Utils', () => {
       ]);
     });
   });
+
+  describe('applyTransactionContainersExisting', () => {
+    it('throws if transaction not found', async () => {
+      const updateEditableParams = jest.fn();
+
+      await expect(
+        applyTransactionContainersExisting({
+          containerTypes: [TransactionContainerType.EnforcedSimulations],
+          transactionId: TRANSACTION_ID_MOCK,
+          messenger,
+          updateEditableParams,
+        }),
+      ).rejects.toThrow(
+        `Transaction with ID ${TRANSACTION_ID_MOCK} not found.`,
+      );
+    });
+
+    it('calls updateEditableParams with new parameters', async () => {
+      getTransactionControllerStateMock.mockReturnValue({
+        transactions: [TRANSACTION_META_MOCK],
+      });
+
+      const updateEditableParams = jest.fn();
+
+      await applyTransactionContainersExisting({
+        containerTypes: [TransactionContainerType.EnforcedSimulations],
+        transactionId: TRANSACTION_ID_MOCK,
+        messenger,
+        updateEditableParams,
+      });
+
+      expect(updateEditableParams).toHaveBeenCalledWith(
+        TRANSACTION_ID_MOCK,
+        expect.objectContaining({
+          containerTypes: [TransactionContainerType.EnforcedSimulations],
+          data: NEW_DATA_MOCK,
+          gas: ESTIMATE_GAS_MOCK,
+        }),
+      );
+    });
+  });
 });