feat: tx-ctrl add forceGasFeeToken param

Author: maxime-oe

packages/transaction-controller/src/TransactionController.ts

@@ -1276,6 +1276,7 @@ export class TransactionController extends BaseController<
       deviceConfirmedOn,
       disableGasBuffer,
       gasFeeToken,
+      forceGasFeeToken,
       isGasFeeIncluded,
       isGasFeeSponsored,
       isStateOnly,
@@ -1361,7 +1362,11 @@ export class TransactionController extends BaseController<
       type ?? (await determineTransactionType(txParams, ethQuery)).type;
 
     const existingTransactionMeta = this.#getTransactionWithActionId(actionId);
-
+    // Original behavior was that this was set to 'true' whenever a gasFeeToken was passed.
+    // 'forceGasFeeToken' optionnally overrides this behavior to prevent native token from
+    // being used when another gasFeeToken is set.
+    const isGasFeeTokenIgnoredIfBalance =
+      Boolean(gasFeeToken) && !forceGasFeeToken;
     // If a request to add a transaction with the same actionId is submitted again, a new transaction will not be created for it.
     let addedTransactionMeta: TransactionMeta = existingTransactionMeta
       ? cloneDeep(existingTransactionMeta)
@@ -1375,7 +1380,7 @@ export class TransactionController extends BaseController<
           deviceConfirmedOn,
           disableGasBuffer,
           id: random(),
-          isGasFeeTokenIgnoredIfBalance: Boolean(gasFeeToken),
+          isGasFeeTokenIgnoredIfBalance,
           isGasFeeIncluded,
           isGasFeeSponsored,
           isFirstTimeInteraction: undefined,

packages/transaction-controller/src/types.ts

@@ -1795,6 +1795,10 @@ export type TransactionBatchRequest = {
   /** Address of an ERC-20 token to pay for the gas fee, if the user has insufficient native balance. */
   gasFeeToken?: Hex;
 
+  /** When set to `true` and if gasFeeToken is set, use gasFeeToken regardless of user native balance. */
+  /** Unless true, gasFeeToken is only taken as a suggestion and native balance will be used in batch 7702 transactions */
+  forceGasFeeToken?: boolean;
+
   /** Gas limit for the transaction batch if submitted via EIP-7702. */
   gasLimit7702?: Hex;
 
@@ -2166,6 +2170,10 @@ export type AddTransactionOptions = {
   /** Whether MetaMask will sponsor the gas fee for the transaction. */
   isGasFeeSponsored?: boolean;
 
+  /** When set to `true` and if gasFeeToken is set, use gasFeeToken regardless of user native balance. */
+  /** Unless true, gasFeeToken is only taken as a suggestion and native balance will be used in batch 7702 transactions */
+  forceGasFeeToken?: boolean;
+
   /**
    * Whether the transaction has no lifecycle and is not signed or published.
    *

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

@@ -430,6 +430,7 @@ async function addTransactionBatchWith7702(
   const { result } = await addTransaction(txParams, {
     batchId,
     gasFeeToken,
+    forceGasFeeToken: userRequest.forceGasFeeToken,
     isGasFeeIncluded: userRequest.isGasFeeIncluded,
     isGasFeeSponsored: userRequest.isGasFeeSponsored,
     nestedTransactions,