fix: type-4 transaction simulation (#5552)

Simulate type-4 transactions using a code override in order to verify
the impact of any included `data`.

Relates to:
[#4506](MetaMask/MetaMask-planning#4506)

See `CHANGELOG.md`.

- [ ] I've updated the test suite for new or updated code as appropriate
- [ ] I've updated documentation (JSDoc, Markdown, etc.) for new or
updated code as appropriate
- [ ] I've highlighted breaking changes using the "BREAKING" category
above as appropriate
- [ ] I've prepared draft pull requests for clients and consumer
packages to resolve any breaking changes

Author: matthewwalsh0

packages/transaction-controller/src/TransactionController.test.ts

@@ -76,7 +76,7 @@ import {
   WalletDevice,
 } from './types';
 import { addTransactionBatch } from './utils/batch';
-import { getDelegationAddress } from './utils/eip7702';
+import { DELEGATION_PREFIX, getDelegationAddress } from './utils/eip7702';
 import { addGasBuffer, estimateGas, updateGas } from './utils/gas';
 import { updateGasFees } from './utils/gas-fees';
 import { getGasFeeFlow } from './utils/gas-flow';
@@ -2061,6 +2061,33 @@ describe('TransactionController', () => {
         expect(getSimulationDataMock).toHaveBeenCalledTimes(0);
         expect(controller.state.transactions[0].simulationData).toBeUndefined();
       });
+
+      it('with sender code if type 4', async () => {
+        getSimulationDataMock.mockResolvedValueOnce(SIMULATION_DATA_MOCK);
+
+        const { controller } = setupController();
+
+        await controller.addTransaction(
+          {
+            from: ACCOUNT_MOCK,
+            to: ACCOUNT_MOCK,
+            authorizationList: [
+              {
+                address: ACCOUNT_2_MOCK,
+              },
+            ],
+          },
+          {
+            networkClientId: NETWORK_CLIENT_ID_MOCK,
+          },
+        );
+
+        await flushPromises();
+
+        expect(getSimulationDataMock).toHaveBeenCalledWith(expect.any(Object), {
+          senderCode: DELEGATION_PREFIX + ACCOUNT_2_MOCK.slice(2),
+        });
+      });
     });
 
     describe('on approve', () => {

packages/transaction-controller/src/TransactionController.ts

@@ -46,7 +46,7 @@ import { NonceTracker } from '@metamask/nonce-tracker';
 import type { RemoteFeatureFlagControllerGetStateAction } from '@metamask/remote-feature-flag-controller';
 import { errorCodes, rpcErrors, providerErrors } from '@metamask/rpc-errors';
 import type { Hex, Json } from '@metamask/utils';
-import { add0x, hexToNumber } from '@metamask/utils';
+import { add0x, hexToNumber, remove0x } from '@metamask/utils';
 import { Mutex } from 'async-mutex';
 // This package purposefully relies on Node's EventEmitter module.
 // eslint-disable-next-line import-x/no-nodejs-modules
@@ -107,6 +107,7 @@ import {
 } from './types';
 import { addTransactionBatch, isAtomicBatchSupported } from './utils/batch';
 import {
+  DELEGATION_PREFIX,
   generateEIP7702BatchTransaction,
   getDelegationAddress,
   signAuthorizationList,
@@ -3839,6 +3840,12 @@ export class TransactionController extends BaseController<
     };
 
     if (this.#isSimulationEnabled()) {
+      const authorizationAddress = txParams?.authorizationList?.[0]?.address;
+
+      const senderCode =
+        authorizationAddress &&
+        ((DELEGATION_PREFIX + remove0x(authorizationAddress)) as Hex);
+
       simulationData = await this.#trace(
         { name: 'Simulate', parentContext: traceContext },
         () =>
@@ -3852,6 +3859,7 @@ export class TransactionController extends BaseController<
             },
             {
               blockTime,
+              senderCode,
             },
           ),
       );

packages/transaction-controller/src/utils/simulation.ts

@@ -58,6 +58,7 @@ type ParsedEvent = {
 
 type GetSimulationDataOptions = {
   blockTime?: number;
+  senderCode?: Hex;
 };
 
 const log = createModuleLogger(projectLogger, 'simulation');
@@ -115,7 +116,7 @@ export async function getSimulationData(
   options: GetSimulationDataOptions = {},
 ): Promise<SimulationData> {
   const { chainId, from, to, value, data } = request;
-  const { blockTime } = options;
+  const { blockTime, senderCode } = options;
 
   log('Getting simulation data', request);
 
@@ -138,6 +139,13 @@ export async function getSimulationData(
           time: toHex(blockTime),
         },
       }),
+      ...(senderCode && {
+        overrides: {
+          [from]: {
+            code: senderCode,
+          },
+        },
+      }),
     });
 
     const transactionError = response.transactions?.[0]?.error;
@@ -324,7 +332,8 @@ async function getTokenBalanceChanges(
   events: ParsedEvent[],
   options: GetSimulationDataOptions,
 ): Promise<SimulationTokenBalanceChange[]> {
-  const { blockTime } = options;
+  const { from } = request;
+  const { blockTime, senderCode } = options;
   const balanceTxs = getTokenBalanceTransactions(request, events);
 
   log('Generated balance transactions', [...balanceTxs.after.values()]);
@@ -346,6 +355,13 @@ async function getTokenBalanceChanges(
         time: toHex(blockTime),
       },
     }),
+    ...(senderCode && {
+      overrides: {
+        [from]: {
+          code: senderCode,
+        },
+      },
+    }),
   });
 
   log('Balance simulation response', response);