@metamask/transaction-controller 53.0.0 → 54.0.0

package/CHANGELOG.md

@@ -7,6 +7,29 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [54.0.0]
+
+### Added
+
+- Add `isExternalSign` property to `TransactionMeta` to disable nonce generation and signing ([#5604](https://github.com/MetaMask/core/pull/5604))
+- Add types for `isAtomicBatchSupported` method ([#5600](https://github.com/MetaMask/core/pull/5600))
+  - `IsAtomicBatchSupportedRequest`
+  - `IsAtomicBatchSupportedResult`
+  - `IsAtomicBatchSupportedResultEntry`
+
+### Changed
+
+- **BREAKING:** Update signature of `isAtomicBatchSupported` method ([#5600](https://github.com/MetaMask/core/pull/5600))
+  - Replace `address` argument with `request` object containing `address` and optional `chainIds`.
+  - Return array of `IsAtomicBatchSupportedResultEntry` objects.
+- Skip `origin` validation for `batch` transaction type ([#5586](https://github.com/MetaMask/core/pull/5586))
+
+### Fixed
+
+- **BREAKING:** `enableTxParamsGasFeeUpdates` is renamed to `isAutomaticGasFeeUpdateEnabled` now expects a callback function instead of a boolean. ([#5602](https://github.com/MetaMask/core/pull/5602))
+  - This callback is invoked before performing `txParams` gas fee updates. The update will proceed only if the callback returns a truthy value.
+  - If not set it will default to return `false`.
+
 ## [53.0.0]
 
 ### Added
@@ -1484,7 +1507,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
     All changes listed after this point were applied to this package following the monorepo conversion.
 
-[Unreleased]: https://github.com/MetaMask/core/compare/@metamask/transaction-controller@53.0.0...HEAD
+[Unreleased]: https://github.com/MetaMask/core/compare/@metamask/transaction-controller@54.0.0...HEAD
+[54.0.0]: https://github.com/MetaMask/core/compare/@metamask/transaction-controller@53.0.0...@metamask/transaction-controller@54.0.0
 [53.0.0]: https://github.com/MetaMask/core/compare/@metamask/transaction-controller@52.3.0...@metamask/transaction-controller@53.0.0
 [52.3.0]: https://github.com/MetaMask/core/compare/@metamask/transaction-controller@52.2.0...@metamask/transaction-controller@52.3.0
 [52.2.0]: https://github.com/MetaMask/core/compare/@metamask/transaction-controller@52.1.0...@metamask/transaction-controller@52.2.0

package/dist/TransactionController.cjs

@@ -13,7 +13,7 @@ var __classPrivateFieldSet = (this && this.__classPrivateFieldSet) || function (
 var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
-var _TransactionController_instances, _TransactionController_internalEvents, _TransactionController_methodDataHelper, _TransactionController_incomingTransactionHelper, _TransactionController_incomingTransactionOptions, _TransactionController_pendingTransactionOptions, _TransactionController_publishBatchHook, _TransactionController_publicKeyEIP7702, _TransactionController_trace, _TransactionController_transactionHistoryLimit, _TransactionController_isFirstTimeInteractionEnabled, _TransactionController_isSimulationEnabled, _TransactionController_testGasFeeFlows, _TransactionController_multichainTrackingHelper, _TransactionController_retryTransaction, _TransactionController_rejectTransaction, _TransactionController_getChainId, _TransactionController_getNetworkClientId, _TransactionController_getEthQuery, _TransactionController_getProvider, _TransactionController_createNonceTracker, _TransactionController_createPendingTransactionTracker, _TransactionController_checkForPendingTransactionAndStartPolling, _TransactionController_stopAllTracking, _TransactionController_addIncomingTransactionHelperListeners, _TransactionController_removePendingTransactionTrackerListeners, _TransactionController_addPendingTransactionTrackerListeners, _TransactionController_getNonceTrackerPendingTransactions, _TransactionController_getGasFeeFlows, _TransactionController_getLayer1GasFeeFlows, _TransactionController_updateTransactionInternal, _TransactionController_updateFirstTimeInteraction, _TransactionController_updateSimulationData, _TransactionController_onGasFeePollerTransactionUpdate, _TransactionController_getSelectedAccount, _TransactionController_getInternalAccounts, _TransactionController_updateSubmitHistory, _TransactionController_updateGasEstimate, _TransactionController_registerActionHandlers, _TransactionController_deleteTransaction, _TransactionController_isRejectError, _TransactionController_rejectTransactionAndThrow;
+var _TransactionController_instances, _TransactionController_internalEvents, _TransactionController_methodDataHelper, _TransactionController_incomingTransactionHelper, _TransactionController_incomingTransactionOptions, _TransactionController_pendingTransactionOptions, _TransactionController_publishBatchHook, _TransactionController_publicKeyEIP7702, _TransactionController_trace, _TransactionController_transactionHistoryLimit, _TransactionController_isFirstTimeInteractionEnabled, _TransactionController_isSimulationEnabled, _TransactionController_testGasFeeFlows, _TransactionController_multichainTrackingHelper, _TransactionController_retryTransaction, _TransactionController_rejectTransaction, _TransactionController_getChainId, _TransactionController_getNetworkClientId, _TransactionController_getEthQuery, _TransactionController_getProvider, _TransactionController_markNonceDuplicatesDropped, _TransactionController_signTransaction, _TransactionController_onConfirmedTransaction, _TransactionController_createNonceTracker, _TransactionController_createPendingTransactionTracker, _TransactionController_checkForPendingTransactionAndStartPolling, _TransactionController_stopAllTracking, _TransactionController_addIncomingTransactionHelperListeners, _TransactionController_removePendingTransactionTrackerListeners, _TransactionController_addPendingTransactionTrackerListeners, _TransactionController_getNonceTrackerPendingTransactions, _TransactionController_getGasFeeFlows, _TransactionController_getLayer1GasFeeFlows, _TransactionController_updateTransactionInternal, _TransactionController_updateFirstTimeInteraction, _TransactionController_updateSimulationData, _TransactionController_onGasFeePollerTransactionUpdate, _TransactionController_getSelectedAccount, _TransactionController_getInternalAccounts, _TransactionController_updateSubmitHistory, _TransactionController_updateGasEstimate, _TransactionController_registerActionHandlers, _TransactionController_deleteTransaction, _TransactionController_isRejectError, _TransactionController_rejectTransactionAndThrow;
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.TransactionController = exports.ApprovalState = exports.SPEED_UP_RATE = exports.CANCEL_RATE = void 0;
 const base_controller_1 = require("@metamask/base-controller");
@@ -157,7 +157,7 @@ class TransactionController extends base_controller_1.BaseController {
      * @param options - The controller options.
      */
     constructor(options) {
-        const { disableHistory, disableSendFlowHistory, disableSwaps, enableTxParamsGasFeeUpdates, getCurrentAccountEIP1559Compatibility, getCurrentNetworkEIP1559Compatibility, getExternalPendingTransactions, getGasFeeEstimates, getNetworkClientRegistry, getNetworkState, getPermittedAccounts, getSavedGasFees, incomingTransactions = {}, isFirstTimeInteractionEnabled, isSimulationEnabled, messenger, pendingTransactions = {}, publicKeyEIP7702, securityProviderRequest, sign, state, testGasFeeFlows, trace, transactionHistoryLimit = 40, hooks, } = options;
+        const { disableHistory, disableSendFlowHistory, disableSwaps, isAutomaticGasFeeUpdateEnabled, getCurrentAccountEIP1559Compatibility, getCurrentNetworkEIP1559Compatibility, getExternalPendingTransactions, getGasFeeEstimates, getNetworkClientRegistry, getNetworkState, getPermittedAccounts, getSavedGasFees, incomingTransactions = {}, isFirstTimeInteractionEnabled, isSimulationEnabled, messenger, pendingTransactions = {}, publicKeyEIP7702, securityProviderRequest, sign, state, testGasFeeFlows, trace, transactionHistoryLimit = 40, hooks, } = options;
         super({
             name: controllerName,
             metadata,
@@ -187,7 +187,8 @@ class TransactionController extends base_controller_1.BaseController {
             __classPrivateFieldGet(this, _TransactionController_multichainTrackingHelper, "f").checkForPendingTransactionAndStartPolling();
         });
         this.messagingSystem = messenger;
-        this.isTxParamsGasFeeUpdatesEnabled = enableTxParamsGasFeeUpdates ?? false;
+        this.isTxParamsGasFeeUpdatesEnabled =
+            isAutomaticGasFeeUpdateEnabled ?? ((_txMeta) => false);
         this.getNetworkState = getNetworkState;
         this.isSendFlowHistoryDisabled = disableSendFlowHistory ?? false;
         this.isHistoryDisabled = disableHistory ?? false;
@@ -334,12 +335,12 @@ class TransactionController extends base_controller_1.BaseController {
     /**
      * Determine which chains support atomic batch transactions with the given account address.
      *
-     * @param address - The address of the account to check.
-     * @returns  The supported chain IDs.
+     * @param request - Request object containing the account address and other parameters.
+     * @returns  Result object containing the supported chains and related information.
      */
-    async isAtomicBatchSupported(address) {
+    async isAtomicBatchSupported(request) {
         return (0, batch_1.isAtomicBatchSupported)({
-            address,
+            ...request,
             getEthQuery: (chainId) => __classPrivateFieldGet(this, _TransactionController_instances, "m", _TransactionController_getEthQuery).call(this, { chainId }),
             messenger: this.messagingSystem,
             publicKeyEIP7702: __classPrivateFieldGet(this, _TransactionController_publicKeyEIP7702, "f"),
@@ -678,7 +679,7 @@ class TransactionController extends base_controller_1.BaseController {
                 updatedTransactionMeta.baseFeePerGas = baseFeePerGas;
             }
             // Update same nonce local transactions as dropped and define replacedBy properties.
-            this.markNonceDuplicatesDropped(transactionId);
+            __classPrivateFieldGet(this, _TransactionController_instances, "m", _TransactionController_markNonceDuplicatesDropped).call(this, transactionId);
             // Update external provided transaction with updated gas values and confirmed status.
             this.updateTransaction(updatedTransactionMeta, `${controllerName}:confirmExternalTransaction - Add external transaction`);
             this.onTransactionStatusChange(updatedTransactionMeta);
@@ -1394,13 +1395,13 @@ class TransactionController extends base_controller_1.BaseController {
                 }
             });
             this.onTransactionStatusChange(transactionMeta);
-            const rawTx = await __classPrivateFieldGet(this, _TransactionController_trace, "f").call(this, { name: 'Sign', parentContext: traceContext }, () => this.signTransaction(transactionMeta));
+            const rawTx = await __classPrivateFieldGet(this, _TransactionController_trace, "f").call(this, { name: 'Sign', parentContext: traceContext }, () => __classPrivateFieldGet(this, _TransactionController_instances, "m", _TransactionController_signTransaction).call(this, transactionMeta));
             if (!(await this.beforePublish(transactionMeta))) {
                 (0, logger_1.projectLogger)('Skipping publishing transaction based on hook');
                 this.messagingSystem.publish(`${controllerName}:transactionPublishingSkipped`, transactionMeta);
                 return ApprovalState.SkippedViaBeforePublishHook;
             }
-            if (!rawTx) {
+            if (!rawTx && !transactionMeta.isExternalSign) {
                 return ApprovalState.NotApproved;
             }
             const { networkClientId } = transactionMeta;
@@ -1427,7 +1428,7 @@ class TransactionController extends base_controller_1.BaseController {
             }
             await __classPrivateFieldGet(this, _TransactionController_trace, "f").call(this, { name: 'Publish', parentContext: traceContext }, async () => {
                 const publishHook = publishHookOverride ?? this.publish;
-                ({ transactionHash: hash } = await publishHook(transactionMeta, rawTx));
+                ({ transactionHash: hash } = await publishHook(transactionMeta, rawTx ?? '0x'));
                 if (hash === undefined) {
                     hash = await this.publishTransaction(ethQuery, {
                         ...transactionMeta,
@@ -1651,44 +1652,6 @@ class TransactionController extends base_controller_1.BaseController {
         });
         return newTransactionMeta;
     }
-    /**
-     * Sets other txMeta statuses to dropped if the txMeta that has been confirmed has other transactions
-     * in the transactions have the same nonce.
-     *
-     * @param transactionId - Used to identify original transaction.
-     */
-    markNonceDuplicatesDropped(transactionId) {
-        const transactionMeta = this.getTransaction(transactionId);
-        if (!transactionMeta) {
-            return;
-        }
-        const nonce = transactionMeta.txParams?.nonce;
-        const from = transactionMeta.txParams?.from;
-        const { chainId } = transactionMeta;
-        const sameNonceTransactions = this.state.transactions.filter((transaction) => transaction.id !== transactionId &&
-            transaction.txParams.from === from &&
-            transaction.txParams.nonce === nonce &&
-            transaction.chainId === chainId &&
-            transaction.type !== types_1.TransactionType.incoming);
-        const sameNonceTransactionIds = sameNonceTransactions.map((transaction) => transaction.id);
-        if (sameNonceTransactions.length === 0) {
-            return;
-        }
-        this.update((state) => {
-            for (const transaction of state.transactions) {
-                if (sameNonceTransactionIds.includes(transaction.id)) {
-                    transaction.replacedBy = transactionMeta?.hash;
-                    transaction.replacedById = transactionMeta?.id;
-                }
-            }
-        });
-        for (const transaction of this.state.transactions) {
-            if (sameNonceTransactionIds.includes(transaction.id) &&
-                transaction.status !== types_1.TransactionStatus.failed) {
-                this.setTransactionStatusDropped(transaction);
-            }
-        }
-    }
     /**
      * Method to set transaction status to dropped.
      *
@@ -1745,47 +1708,6 @@ class TransactionController extends base_controller_1.BaseController {
         const currentAccountIsEIP1559Compatible = await this.getCurrentAccountEIP1559Compatibility();
         return (currentNetworkIsEIP1559Compatible && currentAccountIsEIP1559Compatible);
     }
-    async signTransaction(transactionMeta) {
-        const { txParams } = transactionMeta;
-        (0, logger_1.projectLogger)('Signing transaction', txParams);
-        const { authorizationList, from } = txParams;
-        const finalTxParams = { ...txParams };
-        finalTxParams.authorizationList = await (0, eip7702_1.signAuthorizationList)({
-            authorizationList,
-            messenger: this.messagingSystem,
-            transactionMeta,
-        });
-        const unsignedEthTx = (0, prepare_1.prepareTransaction)(transactionMeta.chainId, finalTxParams);
-        this.approvingTransactionIds.add(transactionMeta.id);
-        const signedTx = await new Promise((resolve, reject) => {
-            this.sign?.(unsignedEthTx, from, ...this.getAdditionalSignArguments(transactionMeta)).then(resolve, reject);
-            this.signAbortCallbacks.set(transactionMeta.id, () => reject(new Error('Signing aborted by user')));
-        });
-        this.signAbortCallbacks.delete(transactionMeta.id);
-        if (!signedTx) {
-            (0, logger_1.projectLogger)('Skipping signed status as no signed transaction');
-            return undefined;
-        }
-        const transactionMetaFromHook = (0, lodash_1.cloneDeep)(transactionMeta);
-        if (!this.afterSign(transactionMetaFromHook, signedTx)) {
-            this.updateTransaction(transactionMetaFromHook, 'TransactionController#signTransaction - Update after sign');
-            (0, logger_1.projectLogger)('Skipping signed status based on hook');
-            return undefined;
-        }
-        const transactionMetaWithRsv = {
-            ...this.updateTransactionMetaRSV(transactionMetaFromHook, signedTx),
-            status: types_1.TransactionStatus.signed,
-            txParams: finalTxParams,
-        };
-        this.updateTransaction(transactionMetaWithRsv, 'TransactionController#approveTransaction - Transaction signed');
-        this.onTransactionStatusChange(transactionMetaWithRsv);
-        const rawTx = (0, prepare_1.serializeTransaction)(signedTx);
-        const transactionMetaWithRawTx = (0, lodash_1.merge)({}, transactionMetaWithRsv, {
-            rawTx,
-        });
-        this.updateTransaction(transactionMetaWithRawTx, 'TransactionController#approveTransaction - RawTransaction added');
-        return rawTx;
-    }
     onTransactionStatusChange(transactionMeta) {
         this.messagingSystem.publish(`${controllerName}:transactionStatusUpdated`, {
             transactionMeta,
@@ -1794,17 +1716,6 @@ class TransactionController extends base_controller_1.BaseController {
     getNonceTrackerTransactions(statuses, address, chainId) {
         return (0, nonce_1.getAndFormatTransactionsForNonceTracker)(chainId, address, statuses, this.state.transactions);
     }
-    onConfirmedTransaction(transactionMeta) {
-        (0, logger_1.projectLogger)('Processing confirmed transaction', transactionMeta.id);
-        this.markNonceDuplicatesDropped(transactionMeta.id);
-        this.messagingSystem.publish(`${controllerName}:transactionConfirmed`, transactionMeta);
-        this.onTransactionStatusChange(transactionMeta);
-        // Intentional given potential duration of process.
-        this.updatePostBalance(transactionMeta).catch((error) => {
-            (0, logger_1.projectLogger)('Error while updating post balance', error);
-            throw error;
-        });
-    }
     async updatePostBalance(transactionMeta) {
         try {
             const { networkClientId, type } = transactionMeta;
@@ -1953,6 +1864,92 @@ _TransactionController_internalEvents = new WeakMap(), _TransactionController_me
         chainId,
         networkClientId,
     }).provider;
+}, _TransactionController_markNonceDuplicatesDropped = function _TransactionController_markNonceDuplicatesDropped(transactionId) {
+    const transactionMeta = this.getTransaction(transactionId);
+    if (!transactionMeta) {
+        return;
+    }
+    const nonce = transactionMeta.txParams?.nonce;
+    const from = transactionMeta.txParams?.from;
+    const { chainId } = transactionMeta;
+    const sameNonceTransactions = this.state.transactions.filter((transaction) => transaction.id !== transactionId &&
+        transaction.txParams.from === from &&
+        nonce &&
+        transaction.txParams.nonce === nonce &&
+        transaction.chainId === chainId &&
+        transaction.type !== types_1.TransactionType.incoming);
+    const sameNonceTransactionIds = sameNonceTransactions.map((transaction) => transaction.id);
+    if (sameNonceTransactions.length === 0) {
+        return;
+    }
+    this.update((state) => {
+        for (const transaction of state.transactions) {
+            if (sameNonceTransactionIds.includes(transaction.id)) {
+                transaction.replacedBy = transactionMeta?.hash;
+                transaction.replacedById = transactionMeta?.id;
+            }
+        }
+    });
+    for (const transaction of this.state.transactions) {
+        if (sameNonceTransactionIds.includes(transaction.id) &&
+            transaction.status !== types_1.TransactionStatus.failed) {
+            this.setTransactionStatusDropped(transaction);
+        }
+    }
+}, _TransactionController_signTransaction = async function _TransactionController_signTransaction(transactionMeta) {
+    const { isExternalSign, txParams } = transactionMeta;
+    if (isExternalSign) {
+        (0, logger_1.projectLogger)('Skipping sign as signed externally');
+        return undefined;
+    }
+    (0, logger_1.projectLogger)('Signing transaction', txParams);
+    const { authorizationList, from } = txParams;
+    const finalTxParams = { ...txParams };
+    finalTxParams.authorizationList = await (0, eip7702_1.signAuthorizationList)({
+        authorizationList,
+        messenger: this.messagingSystem,
+        transactionMeta,
+    });
+    const unsignedEthTx = (0, prepare_1.prepareTransaction)(transactionMeta.chainId, finalTxParams);
+    this.approvingTransactionIds.add(transactionMeta.id);
+    const signedTx = await new Promise((resolve, reject) => {
+        this.sign?.(unsignedEthTx, from, ...this.getAdditionalSignArguments(transactionMeta)).then(resolve, reject);
+        this.signAbortCallbacks.set(transactionMeta.id, () => reject(new Error('Signing aborted by user')));
+    });
+    this.signAbortCallbacks.delete(transactionMeta.id);
+    if (!signedTx) {
+        (0, logger_1.projectLogger)('Skipping signed status as no signed transaction');
+        return undefined;
+    }
+    const transactionMetaFromHook = (0, lodash_1.cloneDeep)(transactionMeta);
+    if (!this.afterSign(transactionMetaFromHook, signedTx)) {
+        this.updateTransaction(transactionMetaFromHook, 'TransactionController#signTransaction - Update after sign');
+        (0, logger_1.projectLogger)('Skipping signed status based on hook');
+        return undefined;
+    }
+    const transactionMetaWithRsv = {
+        ...this.updateTransactionMetaRSV(transactionMetaFromHook, signedTx),
+        status: types_1.TransactionStatus.signed,
+        txParams: finalTxParams,
+    };
+    this.updateTransaction(transactionMetaWithRsv, 'TransactionController#approveTransaction - Transaction signed');
+    this.onTransactionStatusChange(transactionMetaWithRsv);
+    const rawTx = (0, prepare_1.serializeTransaction)(signedTx);
+    const transactionMetaWithRawTx = (0, lodash_1.merge)({}, transactionMetaWithRsv, {
+        rawTx,
+    });
+    this.updateTransaction(transactionMetaWithRawTx, 'TransactionController#approveTransaction - RawTransaction added');
+    return rawTx;
+}, _TransactionController_onConfirmedTransaction = function _TransactionController_onConfirmedTransaction(transactionMeta) {
+    (0, logger_1.projectLogger)('Processing confirmed transaction', transactionMeta.id);
+    __classPrivateFieldGet(this, _TransactionController_instances, "m", _TransactionController_markNonceDuplicatesDropped).call(this, transactionMeta.id);
+    this.messagingSystem.publish(`${controllerName}:transactionConfirmed`, transactionMeta);
+    this.onTransactionStatusChange(transactionMeta);
+    // Intentional given potential duration of process.
+    this.updatePostBalance(transactionMeta).catch((error) => {
+        (0, logger_1.projectLogger)('Error while updating post balance', error);
+        throw error;
+    });
 }, _TransactionController_createNonceTracker = function _TransactionController_createNonceTracker({ provider, blockTracker, chainId, }) {
     return new nonce_tracker_1.NonceTracker({
         // TODO: Fix types
@@ -1995,7 +1992,7 @@ _TransactionController_internalEvents = new WeakMap(), _TransactionController_me
     pendingTransactionTracker.hub.removeAllListeners('transaction-failed');
     pendingTransactionTracker.hub.removeAllListeners('transaction-updated');
 }, _TransactionController_addPendingTransactionTrackerListeners = function _TransactionController_addPendingTransactionTrackerListeners(pendingTransactionTracker) {
-    pendingTransactionTracker.hub.on('transaction-confirmed', this.onConfirmedTransaction.bind(this));
+    pendingTransactionTracker.hub.on('transaction-confirmed', __classPrivateFieldGet(this, _TransactionController_instances, "m", _TransactionController_onConfirmedTransaction).bind(this));
     pendingTransactionTracker.hub.on('transaction-dropped', this.setTransactionStatusDropped.bind(this));
     pendingTransactionTracker.hub.on('transaction-failed', this.failTransaction.bind(this));
     pendingTransactionTracker.hub.on('transaction-updated', this.updateTransaction.bind(this));