@metamask-previews/transaction-controller 48.0.0-preview-b08aa8e7 → 48.0.0-preview-a615cdf2

package/dist/TransactionController.cjs

@@ -1,6 +1,4 @@
 "use strict";
-/* istanbul ignore file */
-// FIXME  - remove above ignore
 var __classPrivateFieldGet = (this && this.__classPrivateFieldGet) || function (receiver, state, kind, f) {
     if (kind === "a" && !f) throw new TypeError("Private accessor was defined without a getter");
     if (typeof state === "function" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError("Cannot read private member from an object whose class did not declare it");
@@ -15,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, _TransactionController_updateGasEstimate;
+var _TransactionController_instances, _TransactionController_internalEvents, _TransactionController_methodDataHelper, _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, _TransactionController_updateGasEstimate;
 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");
@@ -173,7 +171,6 @@ class TransactionController extends base_controller_1.BaseController {
         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);
@@ -213,9 +210,10 @@ class TransactionController extends base_controller_1.BaseController {
         __classPrivateFieldSet(this, _TransactionController_trace, trace ?? ((_request, fn) => fn?.()), "f");
         this.afterSign = hooks?.afterSign ?? (() => true);
         this.beforeCheckPendingTransaction =
-            /* istanbul ignore next */
-            hooks?.beforeCheckPendingTransaction ?? (() => Promise.resolve(true));
-        this.beforePublish = hooks?.beforePublish ?? (() => Promise.resolve(true));
+            hooks?.beforeCheckPendingTransaction ??
+                /* istanbul ignore next */
+                (() => true);
+        this.beforePublish = hooks?.beforePublish ?? (() => true);
         this.getAdditionalSignArguments =
             hooks?.getAdditionalSignArguments ?? (() => []);
         this.publish =
@@ -267,7 +265,6 @@ class TransactionController extends base_controller_1.BaseController {
         };
         __classPrivateFieldSet(this, _TransactionController_incomingTransactionHelper, new IncomingTransactionHelper_1.IncomingTransactionHelper({
             getCache: () => this.state.lastFetchedBlockNumbers,
-            getChainIds: () => [...__classPrivateFieldGet(this, _TransactionController_incomingTransactionChainIds, "f")],
             getCurrentAccount: () => __classPrivateFieldGet(this, _TransactionController_instances, "m", _TransactionController_getSelectedAccount).call(this),
             getLocalTransactions: () => this.state.transactions,
             includeTokenTransfers: __classPrivateFieldGet(this, _TransactionController_incomingTransactionOptions, "f").includeTokenTransfers,
@@ -291,10 +288,6 @@ class TransactionController extends base_controller_1.BaseController {
         });
         this.onBootCleanup();
         __classPrivateFieldGet(this, _TransactionController_checkForPendingTransactionAndStartPolling, "f").call(this);
-        this.registerMessageHandlers();
-    }
-    registerMessageHandlers() {
-        this.messagingSystem.registerActionHandler(`${controllerName}:updateCustodialTransaction`, this.updateCustodialTransaction.bind(this));
     }
     /**
      * Stops polling and removes listeners to prepare the controller for garbage collection.
@@ -468,21 +461,13 @@ class TransactionController extends base_controller_1.BaseController {
             transactionMeta: addedTransactionMeta,
         };
     }
-    startIncomingTransactionPolling(chainIds) {
-        chainIds.forEach((chainId) => __classPrivateFieldGet(this, _TransactionController_incomingTransactionChainIds, "f").add(chainId));
+    startIncomingTransactionPolling() {
         __classPrivateFieldGet(this, _TransactionController_incomingTransactionHelper, "f").start();
     }
-    stopIncomingTransactionPolling(chainIds) {
-        chainIds?.forEach((chainId) => __classPrivateFieldGet(this, _TransactionController_incomingTransactionChainIds, "f").delete(chainId));
-        if (!chainIds) {
-            __classPrivateFieldGet(this, _TransactionController_incomingTransactionChainIds, "f").clear();
-        }
-        if (__classPrivateFieldGet(this, _TransactionController_incomingTransactionChainIds, "f").size === 0) {
-            __classPrivateFieldGet(this, _TransactionController_incomingTransactionHelper, "f").stop();
-        }
+    stopIncomingTransactionPolling() {
+        __classPrivateFieldGet(this, _TransactionController_incomingTransactionHelper, "f").stop();
     }
-    async updateIncomingTransactions(chainIds) {
-        chainIds.forEach((chainId) => __classPrivateFieldGet(this, _TransactionController_incomingTransactionChainIds, "f").add(chainId));
+    async updateIncomingTransactions() {
         await __classPrivateFieldGet(this, _TransactionController_incomingTransactionHelper, "f").update();
     }
     /**
@@ -657,7 +642,6 @@ class TransactionController extends base_controller_1.BaseController {
             this.onTransactionStatusChange(updatedTransactionMeta);
             // Intentional given potential duration of process.
             this.updatePostBalance(updatedTransactionMeta).catch((error) => {
-                /* istanbul ignore next */
                 (0, logger_1.projectLogger)('Error while updating post balance', error);
                 throw error;
             });
@@ -901,23 +885,20 @@ class TransactionController extends base_controller_1.BaseController {
     /**
      * Update a custodial transaction.
      *
-     * @param payload - The custodial transaction options to update.
-     * @param payload.transactionId - The ID of the transaction to update.
-     * @param payload.errorMessage - The error message to be assigned in case transaction status update to failed.
-     * @param payload.hash - The new hash value to be assigned.
-     * @param payload.status - The new status value to be assigned.
-     * @param payload.gasLimit - The new gas limit value to be assigned
-     * @param payload.gasPrice - The new gas price value to be assigned
-     * @param payload.maxFeePerGas - The new max fee per gas value to be assigned
-     * @param payload.maxPriorityFeePerGas - The new max priority fee per gas value to be assigned
-     * @param payload.nonce - The new nonce value to be assigned
-     * @param payload.type - The tranasction type (hardfork) to be assigned
+     * @param transactionId - The ID of the transaction to update.
+     * @param options - The custodial transaction options to update.
+     * @param options.errorMessage - The error message to be assigned in case transaction status update to failed.
+     * @param options.hash - The new hash value to be assigned.
+     * @param options.status - The new status value to be assigned.
      */
-    updateCustodialTransaction({ transactionId, errorMessage, hash, status, gasLimit, gasPrice, maxFeePerGas, maxPriorityFeePerGas, nonce, type, }) {
+    updateCustodialTransaction(transactionId, { errorMessage, hash, status, }) {
         const transactionMeta = this.getTransaction(transactionId);
         if (!transactionMeta) {
             throw new Error(`Cannot update custodial transaction as no transaction metadata found`);
         }
+        if (!transactionMeta.custodyId) {
+            throw new Error('Transaction must be a custodian transaction');
+        }
         if (status &&
             ![
                 types_1.TransactionStatus.submitted,
@@ -933,30 +914,6 @@ class TransactionController extends base_controller_1.BaseController {
         if (updatedTransactionMeta.status === types_1.TransactionStatus.failed) {
             updatedTransactionMeta.error = (0, utils_2.normalizeTxError)(new Error(errorMessage));
         }
-        if (gasLimit) {
-            updatedTransactionMeta.txParams.gasLimit = gasLimit;
-        }
-        if (gasPrice) {
-            updatedTransactionMeta.txParams.gasPrice = gasPrice;
-        }
-        if (maxFeePerGas) {
-            updatedTransactionMeta.txParams.maxFeePerGas = maxFeePerGas;
-        }
-        if (maxPriorityFeePerGas) {
-            updatedTransactionMeta.txParams.maxPriorityFeePerGas =
-                maxPriorityFeePerGas;
-        }
-        if (type) {
-            updatedTransactionMeta.txParams.type = type;
-            // If the type was reverted to legacy, we need to remove the maxFeePerGas and maxPriorityFeePerGas values
-            if (type === types_1.TransactionEnvelopeType.legacy) {
-                updatedTransactionMeta.txParams.maxFeePerGas = undefined;
-                updatedTransactionMeta.txParams.maxPriorityFeePerGas = undefined;
-            }
-        }
-        if (nonce) {
-            updatedTransactionMeta.txParams.nonce = nonce;
-        }
         this.updateTransaction(updatedTransactionMeta, `${controllerName}:updateCustodialTransaction - Custodial transaction updated`);
         if ([types_1.TransactionStatus.submitted, types_1.TransactionStatus.failed].includes(status)) {
             this.messagingSystem.publish(`${controllerName}:transactionFinished`, updatedTransactionMeta);
@@ -1345,7 +1302,7 @@ 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));
-            if (!(await this.beforePublish(transactionMeta))) {
+            if (!this.beforePublish(transactionMeta)) {
                 (0, logger_1.projectLogger)('Skipping publishing transaction based on hook');
                 this.messagingSystem.publish(`${controllerName}:transactionPublishingSkipped`, transactionMeta);
                 return ApprovalState.SkippedViaBeforePublishHook;
@@ -1819,7 +1776,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_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, }) {
     // If transaction is found for same action id, do not create a new transaction.
     if (this.getTransactionWithActionId(actionId)) {
         return;
@@ -1928,6 +1885,7 @@ _TransactionController_internalEvents = new WeakMap(), _TransactionController_me
         }),
         hooks: {
             beforeCheckPendingTransaction: this.beforeCheckPendingTransaction.bind(this),
+            beforePublish: this.beforePublish.bind(this),
         },
     });
     __classPrivateFieldGet(this, _TransactionController_instances, "m", _TransactionController_addPendingTransactionTrackerListeners).call(this, pendingTransactionTracker);