@metamask-previews/transaction-controller 63.0.0-preview-e9620906a → 63.0.0-preview-222195b7a

package/CHANGELOG.md

@@ -10,6 +10,11 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 ### Changed
 
 - Bump `@metamask/core-backend` from `^6.1.1` to `^6.2.0` ([#8232](https://github.com/MetaMask/core/pull/8232))
+- Add extra parameters in types and change `addTransaction` behavior ([#8052](https://github.com/MetaMask/core/pull/8052))
+  - Add optional `excludeNativeTokenForFee` in `TransactionMeta` type.
+  - Add optional `actionId` and optional `excludeNativeTokenForFee` in `TransactionBatchRequest` type.
+  - Add optional `excludeNativeTokenForFee` to `AddTransactionOptions` type.
+  - Changed `isGasFeeTokenIgnoredIfBalance` to be false if `excludeNativeTokenForFee` is passed in `addTransaction`.
 
 ## [63.0.0]
 

package/dist/TransactionController.cjs

@@ -415,7 +415,7 @@ class TransactionController extends base_controller_1.BaseController {
      */
     async addTransaction(txParams, options) {
         (0, logger_1.projectLogger)('Adding transaction', txParams, options);
-        const { actionId, assetsFiatValues, batchId, deviceConfirmedOn, disableGasBuffer, gasFeeToken, isGasFeeIncluded, isGasFeeSponsored, isStateOnly, method, nestedTransactions, networkClientId, origin, publishHook, requestId, requiredAssets, requireApproval, securityAlertResponse, skipInitialGasEstimate, swaps = {}, traceContext, type, } = options;
+        const { actionId, assetsFiatValues, batchId, deviceConfirmedOn, disableGasBuffer, gasFeeToken, excludeNativeTokenForFee, isGasFeeIncluded, isGasFeeSponsored, isStateOnly, method, nestedTransactions, networkClientId, origin, publishHook, requestId, requiredAssets, requireApproval, securityAlertResponse, skipInitialGasEstimate, swaps = {}, traceContext, type, } = options;
         // eslint-disable-next-line no-param-reassign
         txParams = (0, utils_2.normalizeTransactionParams)(txParams);
         if (!__classPrivateFieldGet(this, _TransactionController_multichainTrackingHelper, "f").has(networkClientId)) {
@@ -453,6 +453,10 @@ class TransactionController extends base_controller_1.BaseController {
         const dappSuggestedGasFees = __classPrivateFieldGet(this, _TransactionController_instances, "m", _TransactionController_generateDappSuggestedGasFees).call(this, txParams, origin);
         const transactionType = type ?? (await (0, transaction_type_1.determineTransactionType)(txParams, ethQuery)).type;
         const existingTransactionMeta = __classPrivateFieldGet(this, _TransactionController_instances, "m", _TransactionController_getTransactionWithActionId).call(this, actionId);
+        // Original behavior was that this was set to 'true' whenever a gasFeeToken was passed.
+        // 'excludeNativeTokenForFee' optionnally overrides this behavior to prevent native token from
+        // being used when another gasFeeToken is set.
+        const isGasFeeTokenIgnoredIfBalance = Boolean(gasFeeToken) && !excludeNativeTokenForFee;
         // 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 = existingTransactionMeta
             ? (0, lodash_1.cloneDeep)(existingTransactionMeta)
@@ -466,9 +470,13 @@ class TransactionController extends base_controller_1.BaseController {
                 deviceConfirmedOn,
                 disableGasBuffer,
                 id: (0, uuid_1.v1)(),
-                isGasFeeTokenIgnoredIfBalance: Boolean(gasFeeToken),
+                isGasFeeTokenIgnoredIfBalance,
                 isGasFeeIncluded,
                 isGasFeeSponsored,
+                // To avoid the property to be set as undefined.
+                ...(excludeNativeTokenForFee === undefined
+                    ? {}
+                    : { excludeNativeTokenForFee }),
                 isFirstTimeInteraction: undefined,
                 isStateOnly,
                 nestedTransactions,