address feedback

Author: pedronfigueiredo

packages/transaction-controller/CHANGELOG.md

@@ -9,7 +9,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ### Added
 
-- Add `isGasFeeIncluded` to `TransactionMeta`, `TransactionBatchRequest` and `addTransaction` options so that the client can signal that the gas fee is included in the transaction. ([#6428](https://github.com/MetaMask/core/pull/6428))
+- Add `isGasFeeIncluded` to `TransactionMeta`, `TransactionBatchRequest` and `addTransaction` options so the client can signal that MetaMask is compensated for the gas fee by the transaction ([#6428](https://github.com/MetaMask/core/pull/6428))
 
 ## [60.1.0]
 

packages/transaction-controller/src/TransactionController.ts

@@ -1124,7 +1124,7 @@ export class TransactionController extends BaseController<
    * @param options.batchId - A custom ID for the batch this transaction belongs to.
    * @param options.deviceConfirmedOn - An enum to indicate what device confirmed the transaction.
    * @param options.disableGasBuffer - Whether to disable the gas estimation buffer.
-   * @param options.isGasFeeIncluded - Whether the gas fee is included in the transaction.
+   * @param options.isGasFeeIncluded - Whether MetaMask will be compensated for the gas fee by the transaction.
    * @param options.method - RPC method that requested the transaction.
    * @param options.nestedTransactions - Params for any nested transactions encoded in the data.
    * @param options.origin - The origin of the transaction request, such as a dApp hostname.

packages/transaction-controller/src/types.ts

@@ -260,7 +260,7 @@ export type TransactionMeta = {
    */
   isExternalSign?: boolean;
 
-  /** Whether the gas fee is included in the transaction. */
+  /** Whether MetaMask will be compensated for the gas fee by the transaction. */
   isGasFeeIncluded?: boolean;
 
   /**
@@ -1678,7 +1678,7 @@ export type TransactionBatchRequest = {
   /** Address of the account to submit the transaction batch. */
   from: Hex;
 
-  /** Whether the gas fee is included in the transaction. */
+  /** Whether MetaMask will be compensated for the gas fee by the transaction. */
   isGasFeeIncluded?: boolean;
 
   /** ID of the network client to submit the transaction. */

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

@@ -775,6 +775,33 @@ describe('Batch Utils', () => {
       );
     });
 
+    it.each([true, false])(
+      'passes isGasFeeIncluded flag (%s) through to addTransaction when provided (EIP-7702 path)',
+      async (isGasFeeIncluded) => {
+        isAccountUpgradedToEIP7702Mock.mockResolvedValueOnce({
+          delegationAddress: undefined,
+          isSupported: true,
+        });
+
+        addTransactionMock.mockResolvedValueOnce({
+          transactionMeta: TRANSACTION_META_MOCK,
+          result: Promise.resolve(''),
+        });
+
+        request.request.isGasFeeIncluded = isGasFeeIncluded;
+
+        await addTransactionBatch(request);
+
+        expect(addTransactionMock).toHaveBeenCalledTimes(1);
+        expect(addTransactionMock).toHaveBeenCalledWith(
+          expect.any(Object),
+          expect.objectContaining({
+            isGasFeeIncluded,
+          }),
+        );
+      },
+    );
+
     describe('validates security', () => {
       it('using transaction params', async () => {
         isAccountUpgradedToEIP7702Mock.mockResolvedValueOnce({

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

@@ -389,7 +389,7 @@ async function addTransactionBatchWith7702(
 
   const { result } = await addTransaction(txParams, {
     batchId,
-    isGasFeeIncluded: request.request.isGasFeeIncluded,
+    isGasFeeIncluded: userRequest.isGasFeeIncluded,
     nestedTransactions,
     networkClientId,
     origin,