fix: include gas in simulation requests (#5754)

Include gas limit and gas fees in balance change simulation requests.

Specifically:

- Create alternate simulation request specifically for gas fee tokens in
new `utils/gas-fee-tokens.ts`.
- Rename `utils/simulation.ts` to `utils/balance-changes.ts`.
- Add `withGas` and `withDefaultBlockOverrides` to balance change
simulation requests.
- Override balance in balance change requests if insufficient balance.
- Subtract gas cost from native balance change.
- Replace code override with `authorizationList` including `from`
property.
- Retrieve MetaMask fee from simulation API.

- [x] I've updated the test suite for new or updated code as appropriate
- [x] I've updated documentation (JSDoc, Markdown, etc.) for new or
updated code as appropriate
- [x] I've communicated my changes to consumers by [updating changelogs
for packages I've
changed](https://github.com/MetaMask/core/tree/main/docs/contributing.md#updating-changelogs),
highlighting breaking changes as necessary
- [x] 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

@@ -51,7 +51,7 @@ import {
   JsonRpcError,
 } from '@metamask/rpc-errors';
 import type { Hex, Json } from '@metamask/utils';
-import { add0x, hexToNumber, remove0x } from '@metamask/utils';
+import { add0x, hexToNumber } from '@metamask/utils';
 // This package purposefully relies on Node's EventEmitter module.
 // eslint-disable-next-line import-x/no-nodejs-modules
 import { EventEmitter } from 'events';
@@ -124,22 +124,16 @@ import {
   SimulationErrorCode,
   GasFeeEstimateLevel,
 } from './types';
+import { getBalanceChanges } from './utils/balance-changes';
+import { addTransactionBatch, isAtomicBatchSupported } from './utils/batch';
 import {
-  addTransactionBatch,
-  ERROR_MESSAGE_NO_UPGRADE_CONTRACT,
-  isAtomicBatchSupported,
-} from './utils/batch';
-import {
-  DELEGATION_PREFIX,
-  doesChainSupportEIP7702,
-  ERROR_MESSGE_PUBLIC_KEY,
   generateEIP7702BatchTransaction,
   getDelegationAddress,
   signAuthorizationList,
 } from './utils/eip7702';
 import { validateConfirmedExternalTransaction } from './utils/external-transactions';
-import { getEIP7702UpgradeContractAddress } from './utils/feature-flags';
 import { addGasBuffer, estimateGas, updateGas } from './utils/gas';
+import { getGasFeeTokens } from './utils/gas-fee-tokens';
 import { updateGasFees } from './utils/gas-fees';
 import { getGasFeeFlow } from './utils/gas-flow';
 import {
@@ -156,8 +150,6 @@ import {
 } from './utils/nonce';
 import { prepareTransaction, serializeTransaction } from './utils/prepare';
 import { getTransactionParamsWithIncreasedGasFee } from './utils/retry';
-import type { GetSimulationDataRequest } from './utils/simulation';
-import { getSimulationData } from './utils/simulation';
 import {
   updatePostTransactionBalance,
   updateSwapsTransaction,
@@ -4031,8 +4023,14 @@ export class TransactionController extends BaseController<
       traceContext?: TraceContext;
     } = {},
   ) {
-    const { id: transactionId, simulationData: prevSimulationData } =
-      transactionMeta;
+    const {
+      chainId,
+      id: transactionId,
+      nestedTransactions,
+      networkClientId,
+      simulationData: prevSimulationData,
+      txParams,
+    } = transactionMeta;
 
     let simulationData: SimulationData = {
       error: {
@@ -4045,14 +4043,17 @@ export class TransactionController extends BaseController<
     let gasFeeTokens: GasFeeToken[] = [];
 
     if (this.#isSimulationEnabled()) {
-      const result = await this.#getSimulationData({
-        blockTime,
-        traceContext,
-        transactionMeta,
-      });
-
-      gasFeeTokens = result?.gasFeeTokens;
-      simulationData = result?.simulationData;
+      simulationData = await this.#trace(
+        { name: 'Simulate', parentContext: traceContext },
+        () =>
+          getBalanceChanges({
+            blockTime,
+            chainId,
+            ethQuery: this.#getEthQuery({ networkClientId }),
+            nestedTransactions,
+            txParams,
+          }),
+      );
 
       if (
         blockTime &&
@@ -4064,6 +4065,14 @@ export class TransactionController extends BaseController<
           isUpdatedAfterSecurityCheck: true,
         };
       }
+
+      gasFeeTokens = await getGasFeeTokens({
+        chainId,
+        isEIP7702GasFeeTokensEnabled: this.#isEIP7702GasFeeTokensEnabled,
+        messenger: this.messagingSystem,
+        publicKeyEIP7702: this.#publicKeyEIP7702,
+        transactionMeta,
+      });
     }
 
     const finalTransactionMeta = this.#getTransaction(transactionId);
@@ -4281,100 +4290,4 @@ export class TransactionController extends BaseController<
       newTransactionMeta,
     );
   }
-
-  async #getSimulationData({
-    blockTime,
-    traceContext,
-    transactionMeta,
-  }: {
-    blockTime?: number;
-    traceContext?: TraceContext;
-    transactionMeta: TransactionMeta;
-  }) {
-    const { chainId, delegationAddress, txParams } = transactionMeta;
-
-    const {
-      authorizationList: authorizationListRequest,
-      data,
-      from,
-      to,
-      value,
-    } = txParams;
-
-    const authorizationAddress = authorizationListRequest?.[0]?.address;
-
-    const senderCode =
-      authorizationAddress &&
-      ((DELEGATION_PREFIX + remove0x(authorizationAddress)) as Hex);
-
-    const is7702GasFeeTokensEnabled =
-      await this.#isEIP7702GasFeeTokensEnabled(transactionMeta);
-
-    const use7702Fees =
-      is7702GasFeeTokensEnabled &&
-      doesChainSupportEIP7702(chainId, this.messagingSystem);
-
-    let authorizationList:
-      | GetSimulationDataRequest['authorizationList']
-      | undefined = authorizationListRequest?.map((authorization) => ({
-      address: authorization.address,
-      from: from as Hex,
-    }));
-
-    if (use7702Fees && !delegationAddress && !authorizationList) {
-      authorizationList = this.#getSimulationAuthorizationList({
-        chainId,
-        from: from as Hex,
-      });
-    }
-
-    return await this.#trace(
-      { name: 'Simulate', parentContext: traceContext },
-      () =>
-        getSimulationData(
-          {
-            authorizationList,
-            chainId,
-            data: data as Hex,
-            from: from as Hex,
-            to: to as Hex,
-            value: value as Hex,
-          },
-          {
-            blockTime,
-            senderCode,
-            use7702Fees,
-          },
-        ),
-    );
-  }
-
-  #getSimulationAuthorizationList({
-    chainId,
-    from,
-  }: {
-    chainId: Hex;
-    from: Hex;
-  }): GetSimulationDataRequest['authorizationList'] | undefined {
-    if (!this.#publicKeyEIP7702) {
-      throw rpcErrors.internal(ERROR_MESSGE_PUBLIC_KEY);
-    }
-
-    const upgradeAddress = getEIP7702UpgradeContractAddress(
-      chainId,
-      this.messagingSystem,
-      this.#publicKeyEIP7702,
-    );
-
-    if (!upgradeAddress) {
-      throw rpcErrors.internal(ERROR_MESSAGE_NO_UPGRADE_CONTRACT);
-    }
-
-    return [
-      {
-        address: upgradeAddress,
-        from: from as Hex,
-      },
-    ];
-  }
 }

packages/transaction-controller/src/TransactionController.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.
@@ -161,6 +173,9 @@ export type SimulationResponseTokenFee = {
   /** Conversation rate of 1 token to native WEI. */
   rateWei: Hex;
 
+  /** Portion of `balanceNeededToken` that is the fee paid to MetaMask. */
+  serviceFee?: Hex;
+
   /** Estimated gas limit required for fee transfer. */
   transferEstimate: Hex;
 };
@@ -188,6 +203,12 @@ export type SimulationResponseTransaction = {
     tokenFees: SimulationResponseTokenFee[];
   }[];
 
+  /**
+   * Estimated total gas cost of the transaction.
+   * Included in the stateDiff if `withGas` is true.
+   */
+  gasCost?: number;
+
   /** Required `gasLimit` for the transaction. */
   gasLimit?: Hex;
 

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

@@ -1723,6 +1723,9 @@ export type GasFeeToken = {
   /** Decimals of the token. */
   decimals: number;
 
+  /** Portion of the amount that is the fee paid to MetaMask. */
+  fee?: Hex;
+
   /** Estimated gas limit required for original transaction. */
   gas: Hex;