Simulate with gas limit and gas fee

Override balance if insufficient.

Author: matthewwalsh0

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

@@ -2196,6 +2196,8 @@ describe('TransactionController', () => {
         expect(getBalanceChangesMock).toHaveBeenCalledWith({
           blockTime: undefined,
           chainId: MOCK_NETWORK.chainId,
+          ethQuery: expect.any(Object),
+          nestedTransactions: undefined,
           txParams: {
             data: undefined,
             from: ACCOUNT_MOCK,
@@ -6817,7 +6819,10 @@ describe('TransactionController', () => {
       expect(getBalanceChangesMock).toHaveBeenCalledTimes(1);
       expect(getBalanceChangesMock).toHaveBeenCalledWith({
         blockTime: 123,
+        ethQuery: expect.any(Object),
+        nestedTransactions: undefined,
         txParams: {
+          data: undefined,
           from: ACCOUNT_MOCK,
           to: ACCOUNT_2_MOCK,
           value: TRANSACTION_META_MOCK.txParams.value,
@@ -6854,7 +6859,10 @@ describe('TransactionController', () => {
       expect(getBalanceChangesMock).toHaveBeenCalledTimes(1);
       expect(getBalanceChangesMock).toHaveBeenCalledWith({
         blockTime: 123,
+        ethQuery: expect.any(Object),
+        nestedTransactions: undefined,
         txParams: {
+          data: undefined,
           from: ACCOUNT_MOCK,
           to: ACCOUNT_2_MOCK,
           value: TRANSACTION_META_MOCK.txParams.value,

packages/transaction-controller/src/TransactionController.ts

@@ -3975,6 +3975,8 @@ export class TransactionController extends BaseController<
     const {
       chainId,
       id: transactionId,
+      nestedTransactions,
+      networkClientId,
       simulationData: prevSimulationData,
       txParams,
     } = transactionMeta;
@@ -3996,6 +3998,8 @@ export class TransactionController extends BaseController<
           getBalanceChanges({
             blockTime,
             chainId,
+            ethQuery: this.#getEthQuery({ networkClientId }),
+            nestedTransactions,
             txParams,
           }),
       );

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

@@ -44,12 +44,6 @@ export type SimulationRequestTransaction = {
 
 /** Request to the simulation API to simulate transactions. */
 export type SimulationRequest = {
-  /**
-   * Transactions to be sequentially simulated.
-   * State changes impact subsequent transactions in the list.
-   */
-  transactions: SimulationRequestTransaction[];
-
   blockOverrides?: {
     time?: Hex;
   };
@@ -83,12 +77,30 @@ export type SimulationRequest = {
     withTransfer?: boolean;
   };
 
+  /**
+   * Transactions to be sequentially simulated.
+   * State changes impact subsequent transactions in the list.
+   */
+  transactions: SimulationRequestTransaction[];
+
   /**
    * Whether to include call traces in the response.
    * Defaults to false.
    */
   withCallTrace?: boolean;
 
+  /**
+   * Whether to include the default block data in the simulation.
+   * Defaults to false.
+   */
+  withDefaultBlockOverrides?: boolean;
+
+  /**
+   * Whether to use the gas fees in the simulation.
+   * Defaults to false.
+   */
+  withGas?: boolean;
+
   /**
    * Whether to include event logs in the response.
    * Defaults to false.

packages/transaction-controller/src/utils/balance-changes.test.ts

@@ -1,5 +1,7 @@
 import type { LogDescription } from '@ethersproject/abi';
 import { Interface } from '@ethersproject/abi';
+import { query } from '@metamask/controller-utils';
+import type EthQuery from '@metamask/eth-query';
 import { type Hex } from '@metamask/utils';
 
 import type { GetBalanceChangesRequest } from './balance-changes';
@@ -20,6 +22,11 @@ import { SimulationErrorCode, SimulationTokenStandard } from '../types';
 
 jest.mock('../api/simulation-api');
 
+jest.mock('@metamask/controller-utils', () => ({
+  ...jest.requireActual('@metamask/controller-utils'),
+  query: jest.fn(),
+}));
+
 // Utility function to encode addresses and values to 32-byte ABI format
 const encodeTo32ByteHex = (value: string | number): Hex => {
   // Pad to 32 bytes (64 characters) and add '0x' prefix
@@ -53,8 +60,16 @@ const USER_ADDRESS_WITH_LEADING_ZERO =
 
 const REQUEST_MOCK: GetBalanceChangesRequest = {
   chainId: '0x1',
+  ethQuery: {
+    sendAsync: jest.fn(),
+  } as EthQuery,
   txParams: {
+    data: '0x123',
     from: USER_ADDRESS_MOCK,
+    gas: '0xaaa',
+    maxFeePerGas: '0xbbb',
+    maxPriorityFeePerGas: '0xabc',
+    value: '0xddd',
   },
 };
 
@@ -256,10 +271,12 @@ function mockParseLog({
 
 describe('Simulation Utils', () => {
   const simulateTransactionsMock = jest.mocked(simulateTransactions);
+  const queryMock = jest.mocked(query);
 
   beforeEach(() => {
     jest.resetAllMocks();
     jest.spyOn(Interface.prototype, 'encodeFunctionData').mockReturnValue('');
+    queryMock.mockResolvedValue('0xFFFFFFFFFFFF');
   });
 
   describe('getBalanceChanges', () => {
@@ -404,10 +421,8 @@ describe('Simulation Utils', () => {
             );
 
           const result = await getBalanceChanges({
-            chainId: '0x1',
-            txParams: {
-              from,
-            },
+            ...REQUEST_MOCK,
+            txParams: { ...REQUEST_MOCK.txParams, from },
           });
 
           expect(result).toStrictEqual({
@@ -637,7 +652,13 @@ describe('Simulation Utils', () => {
               // Minting ERC-721 token.
               {
                 authorizationList: undefined,
+                data: REQUEST_MOCK.txParams.data,
                 from: REQUEST_MOCK.txParams.from,
+                gas: REQUEST_MOCK.txParams.gas,
+                maxFeePerGas: REQUEST_MOCK.txParams.maxFeePerGas,
+                maxPriorityFeePerGas:
+                  REQUEST_MOCK.txParams.maxPriorityFeePerGas,
+                value: REQUEST_MOCK.txParams.value,
               },
               // ERC-721 owner after minting.
               {
@@ -654,6 +675,8 @@ describe('Simulation Utils', () => {
                 data: expect.any(String),
               },
             ],
+            withDefaultBlockOverrides: true,
+            withGas: true,
           },
         );
         expect(result).toStrictEqual({