@metamask/transaction-controller 18.2.0 → 18.3.1

package/dist/TransactionController.js

@@ -66,12 +66,13 @@ class TransactionController extends base_controller_1.BaseControllerV1 {
      * @param options.disableHistory - Whether to disable storing history in transaction metadata.
      * @param options.disableSendFlowHistory - Explicitly disable transaction metadata history.
      * @param options.disableSwaps - Whether to disable additional processing on swaps transactions.
-     * @param options.getSavedGasFees - Gets the saved gas fee config.
      * @param options.getCurrentAccountEIP1559Compatibility - Whether or not the account supports EIP-1559.
      * @param options.getCurrentNetworkEIP1559Compatibility - Whether or not the network supports EIP-1559.
+     * @param options.getExternalPendingTransactions - Callback to retrieve pending transactions from external sources.
      * @param options.getGasFeeEstimates - Callback to retrieve gas fee estimates.
      * @param options.getNetworkState - Gets the state of the network controller.
      * @param options.getPermittedAccounts - Get accounts that a given origin has permissions for.
+     * @param options.getSavedGasFees - Gets the saved gas fee config.
      * @param options.getSelectedAddress - Gets the address of the currently selected account.
      * @param options.incomingTransactions - Configuration options for incoming transaction support.
      * @param options.incomingTransactions.includeTokenTransfers - Whether or not to include ERC20 token transfers.
@@ -94,7 +95,7 @@ class TransactionController extends base_controller_1.BaseControllerV1 {
      * @param config - Initial options used to configure this controller.
      * @param state - Initial state to set on this controller.
      */
-    constructor({ blockTracker, cancelMultiplier, disableHistory, disableSendFlowHistory, disableSwaps, getSavedGasFees, getCurrentAccountEIP1559Compatibility, getCurrentNetworkEIP1559Compatibility, getGasFeeEstimates, getNetworkState, getPermittedAccounts, getSelectedAddress, incomingTransactions = {}, messenger, onNetworkStateChange, pendingTransactions = {}, provider, securityProviderRequest, speedUpMultiplier, hooks = {}, }, config, state) {
+    constructor({ blockTracker, cancelMultiplier, disableHistory, disableSendFlowHistory, disableSwaps, getCurrentAccountEIP1559Compatibility, getCurrentNetworkEIP1559Compatibility, getExternalPendingTransactions, getGasFeeEstimates, getNetworkState, getPermittedAccounts, getSavedGasFees, getSelectedAddress, incomingTransactions = {}, messenger, onNetworkStateChange, pendingTransactions = {}, provider, securityProviderRequest, speedUpMultiplier, hooks = {}, }, config, state) {
         var _a, _b, _c, _d, _e;
         super(config, state);
         this.inProcessOfSigning = new Set();
@@ -133,6 +134,8 @@ class TransactionController extends base_controller_1.BaseControllerV1 {
             getGasFeeEstimates || (() => Promise.resolve({}));
         this.getPermittedAccounts = getPermittedAccounts;
         this.getSelectedAddress = getSelectedAddress;
+        this.getExternalPendingTransactions =
+            getExternalPendingTransactions !== null && getExternalPendingTransactions !== void 0 ? getExternalPendingTransactions : (() => []);
         this.securityProviderRequest = securityProviderRequest;
         this.cancelMultiplier = cancelMultiplier !== null && cancelMultiplier !== void 0 ? cancelMultiplier : exports.CANCEL_RATE;
         this.speedUpMultiplier = speedUpMultiplier !== null && speedUpMultiplier !== void 0 ? speedUpMultiplier : exports.SPEED_UP_RATE;
@@ -149,7 +152,7 @@ class TransactionController extends base_controller_1.BaseControllerV1 {
             // @ts-expect-error provider types misaligned: SafeEventEmitterProvider vs Record<string,string>
             provider,
             blockTracker,
-            getPendingTransactions: this.getNonceTrackerTransactions.bind(this, types_1.TransactionStatus.submitted),
+            getPendingTransactions: this.getNonceTrackerPendingTransactions.bind(this),
             getConfirmedTransactions: this.getNonceTrackerTransactions.bind(this, types_1.TransactionStatus.confirmed),
         });
         this.incomingTransactionHelper = new IncomingTransactionHelper_1.IncomingTransactionHelper({
@@ -175,7 +178,11 @@ class TransactionController extends base_controller_1.BaseControllerV1 {
             getTransactions: () => this.state.transactions,
             isResubmitEnabled: pendingTransactions.isResubmitEnabled,
             nonceTracker: this.nonceTracker,
-            onStateChange: this.subscribe.bind(this),
+            onStateChange: (listener) => {
+                this.subscribe(listener);
+                onNetworkStateChange(listener);
+                listener();
+            },
             publishTransaction: this.publishTransaction.bind(this),
             hooks: {
                 beforeCheckPendingTransaction: this.beforeCheckPendingTransaction.bind(this),
@@ -184,8 +191,7 @@ class TransactionController extends base_controller_1.BaseControllerV1 {
         });
         this.addPendingTransactionTrackerListeners();
         onNetworkStateChange(() => {
-            this.ethQuery = new eth_query_1.default(this.provider);
-            this.registry = new eth_method_registry_1.default({ provider: this.provider });
+            (0, logger_1.projectLogger)('Detected network change', this.getChainId());
             this.onBootCleanup();
         });
         this.onBootCleanup();
@@ -302,6 +308,8 @@ class TransactionController extends base_controller_1.BaseControllerV1 {
                 yield (0, swaps_1.updateSwapsTransaction)(transactionMeta, transactionType, swaps, {
                     isSwapsDisabled: this.isSwapsDisabled,
                     cancelTransaction: this.cancelTransaction.bind(this),
+                    // TODO: Replace `any` with type
+                    // eslint-disable-next-line @typescript-eslint/no-explicit-any
                     controllerHubEmitter: this.hub.emit.bind(this.hub),
                 });
                 this.addMetadata(transactionMeta);
@@ -713,6 +721,8 @@ class TransactionController extends base_controller_1.BaseControllerV1 {
             originalGasEstimate,
             userEditedGasLimit,
             userFeeLevel,
+            // TODO: Replace `any` with type
+            // eslint-disable-next-line @typescript-eslint/no-explicit-any
         };
         // only update what is defined
         transactionGasFees.txParams = (0, lodash_1.pickBy)(transactionGasFees.txParams);
@@ -744,6 +754,8 @@ class TransactionController extends base_controller_1.BaseControllerV1 {
                 maxFeePerGas,
                 maxPriorityFeePerGas,
             },
+            // TODO: Replace `any` with type
+            // eslint-disable-next-line @typescript-eslint/no-explicit-any
         };
         // only update what is defined
         transactionPreviousGas.previousGas = (0, lodash_1.pickBy)(transactionPreviousGas.previousGas);
@@ -810,6 +822,9 @@ class TransactionController extends base_controller_1.BaseControllerV1 {
      */
     approveTransactionsWithSameNonce(listOfTxParams = []) {
         return __awaiter(this, void 0, void 0, function* () {
+            (0, logger_1.projectLogger)('Approving transactions with same nonce', {
+                transactions: listOfTxParams,
+            });
             if (listOfTxParams.length === 0) {
                 return '';
             }
@@ -829,6 +844,7 @@ class TransactionController extends base_controller_1.BaseControllerV1 {
                 const fromAddress = initialTx.from;
                 nonceLock = yield this.nonceTracker.getNonceLock(fromAddress);
                 const nonce = nonceLock.nextNonce;
+                (0, logger_1.projectLogger)('Using nonce from nonce tracker', nonce, nonceLock.nonceDetails);
                 rawTransactions = yield Promise.all(listOfTxParams.map((txParams) => {
                     txParams.nonce = (0, ethereumjs_util_1.addHexPrefix)(nonce.toString(16));
                     return this.signExternalTransaction(txParams);
@@ -889,7 +905,8 @@ class TransactionController extends base_controller_1.BaseControllerV1 {
     initApprovals() {
         const chainId = this.getChainId();
         const unapprovedTxs = this.state.transactions.filter((transaction) => transaction.status === types_1.TransactionStatus.unapproved &&
-            transaction.chainId === chainId);
+            transaction.chainId === chainId &&
+            !transaction.isUserOperation);
         for (const txMeta of unapprovedTxs) {
             this.processApproval(txMeta, {
                 shouldShowRequest: false,
@@ -922,7 +939,9 @@ class TransactionController extends base_controller_1.BaseControllerV1 {
         const predicateMethods = (0, lodash_1.mapValues)(searchCriteria, (predicate) => {
             return typeof predicate === 'function'
                 ? predicate
-                : (v) => v === predicate;
+                : // TODO: Replace `any` with type
+                    // eslint-disable-next-line @typescript-eslint/no-explicit-any
+                    (v) => v === predicate;
         });
         const transactionsToFilter = initialList !== null && initialList !== void 0 ? initialList : this.state.transactions;
         // Combine sortBy and pickBy to transform our state object into an array of
@@ -940,9 +959,13 @@ class TransactionController extends base_controller_1.BaseControllerV1 {
                 // are not fully satisfied. We check both txParams and the base
                 // object as predicate keys can be either.
                 if (key in transaction.txParams) {
+                    // TODO: Replace `any` with type
+                    // eslint-disable-next-line @typescript-eslint/no-explicit-any
                     if (predicate(transaction.txParams[key]) === false) {
                         return false;
                     }
+                    // TODO: Replace `any` with type
+                    // eslint-disable-next-line @typescript-eslint/no-explicit-any
                 }
                 else if (predicate(transaction[key]) === false) {
                     return false;
@@ -1038,23 +1061,6 @@ class TransactionController extends base_controller_1.BaseControllerV1 {
     onBootCleanup() {
         this.submitApprovedTransactions();
     }
-    /**
-     * Create approvals for all unapproved transactions on current chain.
-     */
-    createApprovalsForUnapprovedTransactions() {
-        const unapprovedTransactions = this.getCurrentChainTransactionsByStatus(types_1.TransactionStatus.unapproved);
-        for (const transactionMeta of unapprovedTransactions) {
-            this.processApproval(transactionMeta, {
-                shouldShowRequest: false,
-            }).catch((error) => {
-                if ((error === null || error === void 0 ? void 0 : error.code) === rpc_errors_1.errorCodes.provider.userRejectedRequest) {
-                    return;
-                }
-                /* istanbul ignore next */
-                console.error('Error during persisted transaction approval', error);
-            });
-        }
-    }
     /**
      * Force to submit approved transactions on current chain.
      */
@@ -1110,6 +1116,8 @@ class TransactionController extends base_controller_1.BaseControllerV1 {
                             actionId,
                         });
                     }
+                    // TODO: Replace `any` with type
+                    // eslint-disable-next-line @typescript-eslint/no-explicit-any
                 }
                 catch (error) {
                     const { isCompleted: isTxCompleted } = this.isTransactionCompleted(transactionId);
@@ -1209,6 +1217,8 @@ class TransactionController extends base_controller_1.BaseControllerV1 {
                 });
                 this.hub.emit(`${transactionMeta.id}:finished`, transactionMeta);
                 this.onTransactionStatusChange(transactionMeta);
+                // TODO: Replace `any` with type
+                // eslint-disable-next-line @typescript-eslint/no-explicit-any
             }
             catch (error) {
                 this.failTransaction(transactionMeta, error);
@@ -1452,17 +1462,16 @@ class TransactionController extends base_controller_1.BaseControllerV1 {
         const transactionMeta = this.getTransaction(transactionId);
         const nonce = (_a = transactionMeta === null || transactionMeta === void 0 ? void 0 : transactionMeta.txParams) === null || _a === void 0 ? void 0 : _a.nonce;
         const from = (_b = transactionMeta === null || transactionMeta === void 0 ? void 0 : transactionMeta.txParams) === null || _b === void 0 ? void 0 : _b.from;
-        const sameNonceTxs = this.state.transactions.filter((transaction) => transaction.txParams.from === from &&
+        const sameNonceTxs = this.state.transactions.filter((transaction) => transaction.id !== transactionId &&
+            transaction.txParams.from === from &&
             transaction.txParams.nonce === nonce &&
-            transaction.chainId === chainId);
+            transaction.chainId === chainId &&
+            transaction.type !== types_1.TransactionType.incoming);
         if (!sameNonceTxs.length) {
             return;
         }
         // Mark all same nonce transactions as dropped and give it a replacedBy hash
         for (const transaction of sameNonceTxs) {
-            if (transaction.id === transactionId) {
-                continue;
-            }
             transaction.replacedBy = transactionMeta === null || transactionMeta === void 0 ? void 0 : transactionMeta.hash;
             transaction.replacedById = transactionMeta === null || transactionMeta === void 0 ? void 0 : transactionMeta.id;
             // Drop any transaction that wasn't previously failed (off chain failure)
@@ -1511,14 +1520,12 @@ class TransactionController extends base_controller_1.BaseControllerV1 {
      */
     updateTransactionMetaRSV(transactionMeta, signedTx) {
         return __awaiter(this, void 0, void 0, function* () {
-            if (signedTx.r) {
-                transactionMeta.r = (0, ethereumjs_util_1.addHexPrefix)(signedTx.r.toString(16));
-            }
-            if (signedTx.s) {
-                transactionMeta.s = (0, ethereumjs_util_1.addHexPrefix)(signedTx.s.toString(16));
-            }
-            if (signedTx.v) {
-                transactionMeta.v = (0, ethereumjs_util_1.addHexPrefix)(signedTx.v.toString(16));
+            for (const key of ['r', 's', 'v']) {
+                const value = signedTx[key];
+                if (value === undefined || value === null) {
+                    continue;
+                }
+                transactionMeta[key] = (0, ethereumjs_util_1.addHexPrefix)(value.toString(16));
             }
         });
     }
@@ -1564,6 +1571,11 @@ class TransactionController extends base_controller_1.BaseControllerV1 {
     onTransactionStatusChange(transactionMeta) {
         this.hub.emit('transaction-status-update', { transactionMeta });
     }
+    getNonceTrackerPendingTransactions(address) {
+        const standardPendingTransactions = this.getNonceTrackerTransactions(types_1.TransactionStatus.submitted, address);
+        const externalPendingTransactions = this.getExternalPendingTransactions(address);
+        return [...standardPendingTransactions, ...externalPendingTransactions];
+    }
     getNonceTrackerTransactions(status, address) {
         const currentChainId = this.getChainId();
         return (0, nonce_1.getAndFormatTransactionsForNonceTracker)(currentChainId, address, status, this.state.transactions);