@metamask-previews/transaction-controller 52.1.0-preview-7ecf950 → 52.1.0-preview-8a8331b2

package/CHANGELOG.md

@@ -14,6 +14,26 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
   - Add optional `securityAlertId` to `SecurityAlertResponse`.
   - Add optional `securityAlertId` to `TransactionBatchRequest`.
   - Add optional `validateSecurity` callback to `TransactionBatchRequest`.
+- Support publish batch hook ([#5401](https://github.com/MetaMask/core/pull/5401))
+  - Add `hooks.publishBatch` option to constructor.
+  - Add `updateBatchTransactions` method.
+  - Add `maxFeePerGas` and `maxPriorityFeePerGas` to `updateEditableParams` options.
+  - Add types.
+    - `PublishBatchHook`
+    - `PublishBatchHookRequest`
+    - `PublishBatchHookResult`
+    - `PublishBatchHookTransaction`
+    - `PublishHook`
+    - `PublishHookResult`
+  - Add optional properties to `TransactionMeta`.
+    - `batchTransactions`
+    - `disableGasBuffer`
+  - Add optional properties to `BatchTransactionParams`.
+    - `gas`
+    - `maxFeePerGas`
+    - `maxPriorityFeePerGas`
+  - Add optional `existingTransaction` property to `TransactionBatchSingleRequest`.
+  - Add optional `useHook` property to `TransactionBatchRequest`.
 
 ## [52.1.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_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_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_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_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");
@@ -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");
@@ -170,10 +170,10 @@ 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_incomingTransactionHelper.set(this, void 0);
         _TransactionController_incomingTransactionOptions.set(this, void 0);
         _TransactionController_pendingTransactionOptions.set(this, void 0);
+        _TransactionController_publishBatchHook.set(this, void 0);
         _TransactionController_publicKeyEIP7702.set(this, void 0);
         this.signAbortCallbacks = new Map();
         _TransactionController_trace.set(this, void 0);
@@ -206,6 +206,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_publicKeyEIP7702, publicKeyEIP7702, "f");
         __classPrivateFieldSet(this, _TransactionController_transactionHistoryLimit, transactionHistoryLimit, "f");
         this.sign = sign;
@@ -320,9 +321,12 @@ class TransactionController extends base_controller_1.BaseController {
             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"),
             publicKeyEIP7702: __classPrivateFieldGet(this, _TransactionController_publicKeyEIP7702, "f"),
             request,
+            updateTransaction: __classPrivateFieldGet(this, _TransactionController_instances, "m", _TransactionController_updateTransactionInternal).bind(this),
         });
     }
     /**
@@ -349,9 +353,11 @@ class TransactionController extends base_controller_1.BaseController {
      * @param options.actionId - Unique ID to prevent duplicate requests.
      * @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.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.
@@ -365,7 +371,7 @@ class TransactionController extends base_controller_1.BaseController {
      */
     async addTransaction(txParams, options) {
         (0, logger_1.projectLogger)('Adding transaction', txParams, options);
-        const { actionId, batchId, deviceConfirmedOn, method, nestedTransactions, networkClientId, origin, requireApproval, securityAlertResponse, sendFlowHistory, swaps = {}, traceContext, type, } = options;
+        const { actionId, batchId, deviceConfirmedOn, disableGasBuffer, 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}`);
@@ -394,7 +400,7 @@ class TransactionController extends base_controller_1.BaseController {
         (0, validation_1.validateTxParams)(txParams, isEIP1559Compatible);
         const isDuplicateBatchId = batchId?.length &&
             this.state.transactions.some((tx) => tx.batchId?.toLowerCase() === batchId?.toLowerCase());
-        if (isDuplicateBatchId) {
+        if (isDuplicateBatchId && origin && origin !== controller_utils_1.ORIGIN_METAMASK) {
             throw rpc_errors_1.rpcErrors.invalidInput('Batch ID already exists');
         }
         const dappSuggestedGasFees = this.generateDappSuggestedGasFees(txParams, origin);
@@ -412,6 +418,7 @@ class TransactionController extends base_controller_1.BaseController {
                 dappSuggestedGasFees,
                 delegationAddress,
                 deviceConfirmedOn,
+                disableGasBuffer,
                 id: (0, uuid_1.v1)(),
                 isFirstTimeInteraction: undefined,
                 nestedTransactions,
@@ -469,9 +476,10 @@ class TransactionController extends base_controller_1.BaseController {
         }
         return {
             result: this.processApproval(addedTransactionMeta, {
+                actionId,
                 isExisting: Boolean(existingTransactionMeta),
+                publishHook,
                 requireApproval,
-                actionId,
                 traceContext,
             }),
             transactionMeta: addedTransactionMeta,
@@ -794,14 +802,16 @@ class TransactionController extends base_controller_1.BaseController {
      * @param txId - The ID of the transaction to update.
      * @param params - The editable parameters to update.
      * @param params.data - Data to pass with the transaction.
+     * @param params.from - Address to send the transaction from.
      * @param params.gas - Maximum number of units of gas to use for the transaction.
      * @param params.gasPrice - Price per gas for legacy transactions.
-     * @param params.from - Address to send the transaction from.
+     * @param params.maxFeePerGas - Maximum amount per gas to pay for the transaction, including the priority fee.
+     * @param params.maxPriorityFeePerGas - Maximum amount per gas to give to validator as incentive.
      * @param params.to - Address to send the transaction to.
      * @param params.value - Value associated with the transaction.
      * @returns The updated transaction metadata.
      */
-    async updateEditableParams(txId, { data, gas, gasPrice, from, to, value, }) {
+    async updateEditableParams(txId, { data, from, gas, gasPrice, maxFeePerGas, maxPriorityFeePerGas, to, value, }) {
         const transactionMeta = this.getTransaction(txId);
         if (!transactionMeta) {
             throw new Error(`Cannot update editable params as no transaction metadata found`);
@@ -815,6 +825,8 @@ class TransactionController extends base_controller_1.BaseController {
                 value,
                 gas,
                 gasPrice,
+                maxFeePerGas,
+                maxPriorityFeePerGas,
             },
         };
         editableParams.txParams = (0, lodash_1.pickBy)(editableParams.txParams);
@@ -1167,6 +1179,23 @@ class TransactionController extends base_controller_1.BaseController {
         });
         return updatedTransactionMeta.txParams.data;
     }
+    /**
+     * 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, }) {
+        (0, logger_1.projectLogger)('Updating batch transactions', { 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) => {
@@ -1209,7 +1238,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);
@@ -1236,7 +1265,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();
@@ -1284,12 +1313,14 @@ 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 state of the approval.
      */
-    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);
+        (0, logger_1.projectLogger)('Approving transaction', transactionMeta);
         try {
             if (!this.sign) {
                 this.failTransaction(transactionMeta, new Error('No sign method defined.'));
@@ -1304,10 +1335,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',
@@ -1344,8 +1374,19 @@ class TransactionController extends base_controller_1.BaseController {
             }
             (0, logger_1.projectLogger)('Publishing transaction', transactionMeta.txParams);
             let hash;
+            clearNonceLock?.();
+            clearNonceLock = undefined;
+            if (transactionMeta.batchTransactions?.length) {
+                (0, logger_1.projectLogger)('Found batch transactions', transactionMeta.batchTransactions);
+                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,
@@ -1381,7 +1422,8 @@ class TransactionController extends base_controller_1.BaseController {
             return ApprovalState.NotApproved;
         }
         finally {
-            cleanupTasks.forEach((task) => task());
+            clearApprovingTransactionId?.();
+            clearNonceLock?.();
         }
     }
     async publishTransaction(ethQuery, transactionMeta, { skipSubmitHistory } = {}) {
@@ -1708,8 +1750,8 @@ class TransactionController extends base_controller_1.BaseController {
             transactionMeta,
         });
     }
-    getNonceTrackerTransactions(status, address, chainId) {
-        return (0, nonce_1.getAndFormatTransactionsForNonceTracker)(chainId, address, status, this.state.transactions);
+    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);
@@ -1770,7 +1812,7 @@ class TransactionController extends base_controller_1.BaseController {
     }
 }
 exports.TransactionController = TransactionController;
-_TransactionController_internalEvents = new WeakMap(), _TransactionController_methodDataHelper = new WeakMap(), _TransactionController_incomingTransactionHelper = new WeakMap(), _TransactionController_incomingTransactionOptions = new WeakMap(), _TransactionController_pendingTransactionOptions = new WeakMap(), _TransactionController_publicKeyEIP7702 = 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_incomingTransactionHelper = new WeakMap(), _TransactionController_incomingTransactionOptions = new WeakMap(), _TransactionController_pendingTransactionOptions = new WeakMap(), _TransactionController_publishBatchHook = new WeakMap(), _TransactionController_publicKeyEIP7702 = 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;
@@ -1878,7 +1920,7 @@ _TransactionController_internalEvents = new WeakMap(), _TransactionController_me
         // TODO: Fix types
         blockTracker,
         getPendingTransactions: __classPrivateFieldGet(this, _TransactionController_instances, "m", _TransactionController_getNonceTrackerPendingTransactions).bind(this, chainId),
-        getConfirmedTransactions: this.getNonceTrackerTransactions.bind(this, types_1.TransactionStatus.confirmed, chainId),
+        getConfirmedTransactions: this.getNonceTrackerTransactions.bind(this, [types_1.TransactionStatus.confirmed], chainId),
     });
 }, _TransactionController_createPendingTransactionTracker = function _TransactionController_createPendingTransactionTracker({ provider, blockTracker, chainId, networkClientId, }) {
     const ethQuery = new eth_query_1.default(provider);
@@ -1917,7 +1959,11 @@ _TransactionController_internalEvents = new WeakMap(), _TransactionController_me
     pendingTransactionTracker.hub.on('transaction-failed', this.failTransaction.bind(this));
     pendingTransactionTracker.hub.on('transaction-updated', this.updateTransaction.bind(this));
 }, _TransactionController_getNonceTrackerPendingTransactions = function _TransactionController_getNonceTrackerPendingTransactions(chainId, address) {
-    const standardPendingTransactions = this.getNonceTrackerTransactions(types_1.TransactionStatus.submitted, address, chainId);
+    const standardPendingTransactions = this.getNonceTrackerTransactions([
+        types_1.TransactionStatus.approved,
+        types_1.TransactionStatus.signed,
+        types_1.TransactionStatus.submitted,
+    ], address, chainId);
     const externalPendingTransactions = this.getExternalPendingTransactions(address, chainId);
     return [...standardPendingTransactions, ...externalPendingTransactions];
 }, _TransactionController_getGasFeeFlows = function _TransactionController_getGasFeeFlows() {