@metamask-previews/transaction-controller 46.0.0-preview-5dad659d → 46.0.0-preview-5b37150f

package/CHANGELOG.md

@@ -24,6 +24,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ### Changed
 
+- Throw if `addTransactionBatch` is called with any nested transaction with `to` matching internal account ([#5369](https://github.com/MetaMask/core/pull/5369))
 - **BREAKING:** Support atomic batch transactions ([#5306](https://github.com/MetaMask/core/pull/5306))
   - Require `AccountsController:getState` action permission in messenger.
   - Require `RemoteFeatureFlagController:getState` action permission in messenger.

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_incomingTransactionChainIds, _TransactionController_incomingTransactionHelper, _TransactionController_incomingTransactionOptions, _TransactionController_pendingTransactionOptions, _TransactionController_trace, _TransactionController_transactionHistoryLimit, _TransactionController_isFirstTimeInteractionEnabled, _TransactionController_isSimulationEnabled, _TransactionController_testGasFeeFlows, _TransactionController_multichainTrackingHelper, _TransactionController_retryTransaction, _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;
+var _TransactionController_instances, _TransactionController_internalEvents, _TransactionController_methodDataHelper, _TransactionController_incomingTransactionChainIds, _TransactionController_incomingTransactionHelper, _TransactionController_incomingTransactionOptions, _TransactionController_pendingTransactionOptions, _TransactionController_publishBatchHook, _TransactionController_trace, _TransactionController_transactionHistoryLimit, _TransactionController_isFirstTimeInteractionEnabled, _TransactionController_isSimulationEnabled, _TransactionController_testGasFeeFlows, _TransactionController_multichainTrackingHelper, _TransactionController_retryTransaction, _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;
 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");
@@ -23,7 +23,6 @@ const network_controller_1 = require("@metamask/network-controller");
 const nonce_tracker_1 = require("@metamask/nonce-tracker");
 const rpc_errors_1 = require("@metamask/rpc-errors");
 const utils_1 = require("@metamask/utils");
-const async_mutex_1 = require("async-mutex");
 // This package purposefully relies on Node's EventEmitter module.
 // eslint-disable-next-line import-x/no-nodejs-modules
 const events_1 = require("events");
@@ -42,6 +41,7 @@ const MethodDataHelper_1 = require("./helpers/MethodDataHelper.cjs");
 const MultichainTrackingHelper_1 = require("./helpers/MultichainTrackingHelper.cjs");
 const PendingTransactionTracker_1 = require("./helpers/PendingTransactionTracker.cjs");
 const ResimulateHelper_1 = require("./helpers/ResimulateHelper.cjs");
+const ExtraTransactionsPublishHook_1 = require("./hooks/ExtraTransactionsPublishHook.cjs");
 const logger_1 = require("./logger.cjs");
 const types_1 = require("./types.cjs");
 const batch_1 = require("./utils/batch.cjs");
@@ -192,11 +192,11 @@ class TransactionController extends base_controller_1.BaseController {
         _TransactionController_internalEvents.set(this, new events_1.EventEmitter());
         this.approvingTransactionIds = new Set();
         _TransactionController_methodDataHelper.set(this, void 0);
-        this.mutex = new async_mutex_1.Mutex();
         _TransactionController_incomingTransactionChainIds.set(this, new Set());
         _TransactionController_incomingTransactionHelper.set(this, void 0);
         _TransactionController_incomingTransactionOptions.set(this, void 0);
         _TransactionController_pendingTransactionOptions.set(this, void 0);
+        _TransactionController_publishBatchHook.set(this, void 0);
         this.signAbortCallbacks = new Map();
         _TransactionController_trace.set(this, void 0);
         _TransactionController_transactionHistoryLimit.set(this, void 0);
@@ -227,6 +227,7 @@ class TransactionController extends base_controller_1.BaseController {
         this.securityProviderRequest = securityProviderRequest;
         __classPrivateFieldSet(this, _TransactionController_incomingTransactionOptions, incomingTransactions, "f");
         __classPrivateFieldSet(this, _TransactionController_pendingTransactionOptions, pendingTransactions, "f");
+        __classPrivateFieldSet(this, _TransactionController_publishBatchHook, hooks?.publishBatch, "f");
         __classPrivateFieldSet(this, _TransactionController_transactionHistoryLimit, transactionHistoryLimit, "f");
         this.sign = sign;
         __classPrivateFieldSet(this, _TransactionController_testGasFeeFlows, testGasFeeFlows === true, "f");
@@ -340,8 +341,12 @@ class TransactionController extends base_controller_1.BaseController {
             addTransaction: this.addTransaction.bind(this),
             getChainId: __classPrivateFieldGet(this, _TransactionController_instances, "m", _TransactionController_getChainId).bind(this),
             getEthQuery: (networkClientId) => __classPrivateFieldGet(this, _TransactionController_instances, "m", _TransactionController_getEthQuery).call(this, { networkClientId }),
+            getInternalAccounts: __classPrivateFieldGet(this, _TransactionController_instances, "m", _TransactionController_getInternalAccounts).bind(this),
+            getTransaction: (transactionId) => this.getTransactionOrThrow(transactionId),
             messenger: this.messagingSystem,
+            publishBatchHook: __classPrivateFieldGet(this, _TransactionController_publishBatchHook, "f"),
             request,
+            updateTransaction: __classPrivateFieldGet(this, _TransactionController_instances, "m", _TransactionController_updateTransactionInternal).bind(this),
         });
     }
     /**
@@ -365,10 +370,12 @@ class TransactionController extends base_controller_1.BaseController {
      * @param txParams - Standard parameters for an Ethereum transaction.
      * @param options - Additional options to control how the transaction is added.
      * @param options.actionId - Unique ID to prevent duplicate requests.
+     * @param options.batchId - ID of the batch this transaction belongs to.
      * @param options.deviceConfirmedOn - An enum to indicate what device confirmed 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.
+     * @param options.publishHook - Custom logic to publish the transaction.
      * @param options.requireApproval - Whether the transaction requires approval by the user, defaults to true unless explicitly disabled.
      * @param options.securityAlertResponse - Response from security validator.
      * @param options.sendFlowHistory - The sendFlowHistory entries to add.
@@ -382,7 +389,7 @@ class TransactionController extends base_controller_1.BaseController {
      */
     async addTransaction(txParams, options) {
         (0, logger_1.projectLogger)('Adding transaction', txParams, options);
-        const { actionId, deviceConfirmedOn, method, nestedTransactions, networkClientId, origin, requireApproval, securityAlertResponse, sendFlowHistory, swaps = {}, traceContext, type, } = options;
+        const { actionId, batchId, deviceConfirmedOn, method, nestedTransactions, networkClientId, origin, publishHook, requireApproval, securityAlertResponse, sendFlowHistory, swaps = {}, traceContext, type, } = options;
         txParams = (0, utils_2.normalizeTransactionParams)(txParams);
         if (!__classPrivateFieldGet(this, _TransactionController_multichainTrackingHelper, "f").has(networkClientId)) {
             throw new Error(`Network client not found - ${networkClientId}`);
@@ -416,6 +423,7 @@ class TransactionController extends base_controller_1.BaseController {
             : {
                 // Add actionId to txMeta to check if same actionId is seen again
                 actionId,
+                batchId,
                 chainId,
                 dappSuggestedGasFees,
                 deviceConfirmedOn,
@@ -476,9 +484,10 @@ class TransactionController extends base_controller_1.BaseController {
         }
         return {
             result: this.processApproval(addedTransactionMeta, {
+                actionId,
                 isExisting: Boolean(existingTransactionMeta),
+                publishHook,
                 requireApproval,
-                actionId,
                 traceContext,
             }),
             transactionMeta: addedTransactionMeta,
@@ -1122,6 +1131,22 @@ class TransactionController extends base_controller_1.BaseController {
         abortCallback();
         this.signAbortCallbacks.delete(transactionId);
     }
+    /**
+     * Update the batch transactions associated with a transaction.
+     * These transactions will be submitted with the main transaction as a batch.
+     *
+     * @param request - The request object.
+     * @param request.transactionId - The ID of the transaction to update.
+     * @param request.batchTransactions - The new batch transactions.
+     */
+    updateBatchTransactions({ transactionId, batchTransactions, }) {
+        __classPrivateFieldGet(this, _TransactionController_instances, "m", _TransactionController_updateTransactionInternal).call(this, {
+            transactionId,
+            note: 'TransactionController#updateBatchTransactions - Batch transactions updated',
+        }, (transactionMeta) => {
+            transactionMeta.batchTransactions = batchTransactions;
+        });
+    }
     addMetadata(transactionMeta) {
         (0, validation_1.validateTxParams)(transactionMeta.txParams);
         this.update((state) => {
@@ -1171,7 +1196,7 @@ class TransactionController extends base_controller_1.BaseController {
             this.failTransaction(transactionMeta, new Error('Transaction incomplete at startup'));
         }
     }
-    async processApproval(transactionMeta, { isExisting = false, requireApproval, shouldShowRequest = true, actionId, traceContext, }) {
+    async processApproval(transactionMeta, { actionId, isExisting = false, publishHook, requireApproval, shouldShowRequest = true, traceContext, }) {
         const transactionId = transactionMeta.id;
         let resultCallbacks;
         const { meta, isCompleted } = this.isTransactionCompleted(transactionId);
@@ -1198,7 +1223,7 @@ class TransactionController extends base_controller_1.BaseController {
                 }
                 const { isCompleted: isTxCompleted } = this.isTransactionCompleted(transactionId);
                 if (!isTxCompleted) {
-                    const approvalResult = await this.approveTransaction(transactionId, traceContext);
+                    const approvalResult = await this.approveTransaction(transactionId, traceContext, publishHook);
                     if (approvalResult === ApprovalState.SkippedViaBeforePublishHook &&
                         resultCallbacks) {
                         resultCallbacks.success();
@@ -1232,7 +1257,7 @@ class TransactionController extends base_controller_1.BaseController {
         switch (finalMeta?.status) {
             case types_1.TransactionStatus.failed:
                 resultCallbacks?.error(finalMeta.error);
-                throw rpc_errors_1.rpcErrors.internal(finalMeta.error.message);
+                throw rpc_errors_1.rpcErrors.internal(finalMeta.error.stack);
             case types_1.TransactionStatus.submitted:
                 resultCallbacks?.success();
                 return finalMeta.hash;
@@ -1250,10 +1275,12 @@ class TransactionController extends base_controller_1.BaseController {
      *
      * @param transactionId - The ID of the transaction to approve.
      * @param traceContext - The parent context for any new traces.
+     * @param publishHookOverride - Custom logic to publish the transaction.
+     * @returns The approval state of the transaction.
      */
-    async approveTransaction(transactionId, traceContext) {
-        const cleanupTasks = new Array();
-        cleanupTasks.push(await this.mutex.acquire());
+    async approveTransaction(transactionId, traceContext, publishHookOverride) {
+        let clearApprovingTransactionId;
+        let clearNonceLock;
         let transactionMeta = this.getTransactionOrThrow(transactionId);
         try {
             if (!this.sign) {
@@ -1269,10 +1296,9 @@ class TransactionController extends base_controller_1.BaseController {
                 return ApprovalState.NotApproved;
             }
             this.approvingTransactionIds.add(transactionId);
-            cleanupTasks.push(() => this.approvingTransactionIds.delete(transactionId));
+            clearApprovingTransactionId = () => this.approvingTransactionIds.delete(transactionId);
             const [nonce, releaseNonce] = await (0, nonce_1.getNextNonce)(transactionMeta, (address) => __classPrivateFieldGet(this, _TransactionController_multichainTrackingHelper, "f").getNonceLock(address, transactionMeta.networkClientId));
-            // must set transaction to submitted/failed before releasing lock
-            releaseNonce && cleanupTasks.push(releaseNonce);
+            clearNonceLock = releaseNonce;
             transactionMeta = __classPrivateFieldGet(this, _TransactionController_instances, "m", _TransactionController_updateTransactionInternal).call(this, {
                 transactionId,
                 note: 'TransactionController#approveTransaction - Transaction approved',
@@ -1309,8 +1335,18 @@ class TransactionController extends base_controller_1.BaseController {
             }
             (0, logger_1.projectLogger)('Publishing transaction', transactionMeta.txParams);
             let hash;
+            clearNonceLock?.();
+            clearNonceLock = undefined;
+            if (transactionMeta.batchTransactions?.length) {
+                const extraTransactionsPublishHook = new ExtraTransactionsPublishHook_1.ExtraTransactionsPublishHook({
+                    addTransactionBatch: this.addTransactionBatch.bind(this),
+                    transactions: transactionMeta.batchTransactions,
+                });
+                publishHookOverride = extraTransactionsPublishHook.getHook();
+            }
             await __classPrivateFieldGet(this, _TransactionController_trace, "f").call(this, { name: 'Publish', parentContext: traceContext }, async () => {
-                ({ transactionHash: hash } = await this.publish(transactionMeta, rawTx));
+                const publishHook = publishHookOverride ?? this.publish;
+                ({ transactionHash: hash } = await publishHook(transactionMeta, rawTx));
                 if (hash === undefined) {
                     hash = await this.publishTransaction(ethQuery, {
                         ...transactionMeta,
@@ -1346,7 +1382,8 @@ class TransactionController extends base_controller_1.BaseController {
             return ApprovalState.NotApproved;
         }
         finally {
-            cleanupTasks.forEach((task) => task());
+            clearApprovingTransactionId?.();
+            clearNonceLock?.();
         }
     }
     async publishTransaction(ethQuery, transactionMeta, { skipSubmitHistory } = {}) {
@@ -1763,7 +1800,7 @@ class TransactionController extends base_controller_1.BaseController {
     }
 }
 exports.TransactionController = TransactionController;
-_TransactionController_internalEvents = new WeakMap(), _TransactionController_methodDataHelper = new WeakMap(), _TransactionController_incomingTransactionChainIds = new WeakMap(), _TransactionController_incomingTransactionHelper = new WeakMap(), _TransactionController_incomingTransactionOptions = new WeakMap(), _TransactionController_pendingTransactionOptions = new WeakMap(), _TransactionController_trace = new WeakMap(), _TransactionController_transactionHistoryLimit = new WeakMap(), _TransactionController_isFirstTimeInteractionEnabled = new WeakMap(), _TransactionController_isSimulationEnabled = new WeakMap(), _TransactionController_testGasFeeFlows = new WeakMap(), _TransactionController_multichainTrackingHelper = new WeakMap(), _TransactionController_checkForPendingTransactionAndStartPolling = new WeakMap(), _TransactionController_instances = new WeakSet(), _TransactionController_retryTransaction = async function _TransactionController_retryTransaction({ actionId, afterSubmit, estimatedBaseFee, gasValues, label, prepareTransactionParams, rate, transactionId, transactionType, }) {
+_TransactionController_internalEvents = new WeakMap(), _TransactionController_methodDataHelper = new WeakMap(), _TransactionController_incomingTransactionChainIds = new WeakMap(), _TransactionController_incomingTransactionHelper = new WeakMap(), _TransactionController_incomingTransactionOptions = new WeakMap(), _TransactionController_pendingTransactionOptions = new WeakMap(), _TransactionController_publishBatchHook = new WeakMap(), _TransactionController_trace = new WeakMap(), _TransactionController_transactionHistoryLimit = new WeakMap(), _TransactionController_isFirstTimeInteractionEnabled = new WeakMap(), _TransactionController_isSimulationEnabled = new WeakMap(), _TransactionController_testGasFeeFlows = new WeakMap(), _TransactionController_multichainTrackingHelper = new WeakMap(), _TransactionController_checkForPendingTransactionAndStartPolling = new WeakMap(), _TransactionController_instances = new WeakSet(), _TransactionController_retryTransaction = async function _TransactionController_retryTransaction({ actionId, afterSubmit, estimatedBaseFee, gasValues, label, prepareTransactionParams, rate, transactionId, transactionType, }) {
     // If transaction is found for same action id, do not create a new transaction.
     if (this.getTransactionWithActionId(actionId)) {
         return;