@metamask/transaction-controller 18.0.0 → 18.2.0

package/dist/TransactionController.js

@@ -35,6 +35,7 @@ const external_transactions_1 = require("./utils/external-transactions");
 const gas_1 = require("./utils/gas");
 const gas_fees_1 = require("./utils/gas-fees");
 const history_1 = require("./utils/history");
+const nonce_1 = require("./utils/nonce");
 const swaps_1 = require("./utils/swaps");
 const transaction_type_1 = require("./utils/transaction-type");
 const utils_1 = require("./utils/utils");
@@ -61,6 +62,7 @@ class TransactionController extends base_controller_1.BaseControllerV1 {
      *
      * @param options - The controller options.
      * @param options.blockTracker - The block tracker used to poll for new blocks data.
+     * @param options.cancelMultiplier - Multiplier used to determine a transaction's increased gas fee during cancellation.
      * @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.
@@ -82,6 +84,7 @@ class TransactionController extends base_controller_1.BaseControllerV1 {
      * @param options.pendingTransactions.isResubmitEnabled - Whether transaction publishing is automatically retried.
      * @param options.provider - The provider used to create the underlying EthQuery instance.
      * @param options.securityProviderRequest - A function for verifying a transaction, whether it is malicious or not.
+     * @param options.speedUpMultiplier - Multiplier used to determine a transaction's increased gas fee during speed up.
      * @param options.hooks - The controller hooks.
      * @param options.hooks.afterSign - Additional logic to execute after signing a transaction. Return false to not change the status to signed.
      * @param options.hooks.beforeApproveOnInit - Additional logic to execute before starting an approval flow for a transaction during initialization. Return false to skip the transaction.
@@ -91,7 +94,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, disableHistory, disableSendFlowHistory, disableSwaps, getSavedGasFees, getCurrentAccountEIP1559Compatibility, getCurrentNetworkEIP1559Compatibility, getGasFeeEstimates, getNetworkState, getPermittedAccounts, getSelectedAddress, incomingTransactions = {}, messenger, onNetworkStateChange, pendingTransactions = {}, provider, securityProviderRequest, hooks = {}, }, config, state) {
+    constructor({ blockTracker, cancelMultiplier, disableHistory, disableSendFlowHistory, disableSwaps, getSavedGasFees, getCurrentAccountEIP1559Compatibility, getCurrentNetworkEIP1559Compatibility, getGasFeeEstimates, getNetworkState, getPermittedAccounts, getSelectedAddress, incomingTransactions = {}, messenger, onNetworkStateChange, pendingTransactions = {}, provider, securityProviderRequest, speedUpMultiplier, hooks = {}, }, config, state) {
         var _a, _b, _c, _d, _e;
         super(config, state);
         this.inProcessOfSigning = new Set();
@@ -131,6 +134,8 @@ class TransactionController extends base_controller_1.BaseControllerV1 {
         this.getPermittedAccounts = getPermittedAccounts;
         this.getSelectedAddress = getSelectedAddress;
         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;
         this.afterSign = (_a = hooks === null || hooks === void 0 ? void 0 : hooks.afterSign) !== null && _a !== void 0 ? _a : (() => true);
         this.beforeApproveOnInit = (_b = hooks === null || hooks === void 0 ? void 0 : hooks.beforeApproveOnInit) !== null && _b !== void 0 ? _b : (() => true);
         this.beforeCheckPendingTransaction =
@@ -334,7 +339,7 @@ class TransactionController extends base_controller_1.BaseControllerV1 {
      * @param options.estimatedBaseFee - The estimated base fee of the transaction.
      */
     stopTransaction(transactionId, gasValues, { estimatedBaseFee, actionId, } = {}) {
-        var _a, _b;
+        var _a, _b, _c;
         return __awaiter(this, void 0, void 0, function* () {
             // If transaction is found for same action id, do not create a cancel transaction.
             if (this.getTransactionWithActionId(actionId)) {
@@ -345,6 +350,7 @@ class TransactionController extends base_controller_1.BaseControllerV1 {
                 gasValues = (0, utils_1.normalizeGasFeeValues)(gasValues);
                 (0, utils_1.validateGasValues)(gasValues);
             }
+            (0, logger_1.projectLogger)('Creating cancel transaction', transactionId, gasValues);
             const transactionMeta = this.getTransaction(transactionId);
             if (!transactionMeta) {
                 return;
@@ -353,21 +359,21 @@ class TransactionController extends base_controller_1.BaseControllerV1 {
                 throw new Error('No sign method defined.');
             }
             // gasPrice (legacy non EIP1559)
-            const minGasPrice = (0, utils_1.getIncreasedPriceFromExisting)(transactionMeta.txParams.gasPrice, exports.CANCEL_RATE);
+            const minGasPrice = (0, utils_1.getIncreasedPriceFromExisting)(transactionMeta.txParams.gasPrice, this.cancelMultiplier);
             const gasPriceFromValues = (0, utils_1.isGasPriceValue)(gasValues) && gasValues.gasPrice;
             const newGasPrice = (gasPriceFromValues &&
                 (0, utils_1.validateMinimumIncrease)(gasPriceFromValues, minGasPrice)) ||
                 minGasPrice;
             // maxFeePerGas (EIP1559)
             const existingMaxFeePerGas = (_a = transactionMeta.txParams) === null || _a === void 0 ? void 0 : _a.maxFeePerGas;
-            const minMaxFeePerGas = (0, utils_1.getIncreasedPriceFromExisting)(existingMaxFeePerGas, exports.CANCEL_RATE);
+            const minMaxFeePerGas = (0, utils_1.getIncreasedPriceFromExisting)(existingMaxFeePerGas, this.cancelMultiplier);
             const maxFeePerGasValues = (0, utils_1.isFeeMarketEIP1559Values)(gasValues) && gasValues.maxFeePerGas;
             const newMaxFeePerGas = (maxFeePerGasValues &&
                 (0, utils_1.validateMinimumIncrease)(maxFeePerGasValues, minMaxFeePerGas)) ||
                 (existingMaxFeePerGas && minMaxFeePerGas);
             // maxPriorityFeePerGas (EIP1559)
             const existingMaxPriorityFeePerGas = (_b = transactionMeta.txParams) === null || _b === void 0 ? void 0 : _b.maxPriorityFeePerGas;
-            const minMaxPriorityFeePerGas = (0, utils_1.getIncreasedPriceFromExisting)(existingMaxPriorityFeePerGas, exports.CANCEL_RATE);
+            const minMaxPriorityFeePerGas = (0, utils_1.getIncreasedPriceFromExisting)(existingMaxPriorityFeePerGas, this.cancelMultiplier);
             const maxPriorityFeePerGasValues = (0, utils_1.isFeeMarketEIP1559Values)(gasValues) && gasValues.maxPriorityFeePerGas;
             const newMaxPriorityFeePerGas = (maxPriorityFeePerGasValues &&
                 (0, utils_1.validateMinimumIncrease)(maxPriorityFeePerGasValues, minMaxPriorityFeePerGas)) ||
@@ -394,6 +400,15 @@ class TransactionController extends base_controller_1.BaseControllerV1 {
             const unsignedEthTx = this.prepareUnsignedEthTx(newTxParams);
             const signedTx = yield this.sign(unsignedEthTx, transactionMeta.txParams.from);
             const rawTx = (0, ethereumjs_util_1.bufferToHex)(signedTx.serialize());
+            const newFee = (_c = newTxParams.maxFeePerGas) !== null && _c !== void 0 ? _c : newTxParams.gasPrice;
+            const oldFee = newTxParams.maxFeePerGas
+                ? transactionMeta.txParams.maxFeePerGas
+                : transactionMeta.txParams.gasPrice;
+            (0, logger_1.projectLogger)('Submitting cancel transaction', {
+                oldFee,
+                newFee,
+                txParams: newTxParams,
+            });
             const hash = yield this.publishTransaction(rawTx);
             const cancelTransactionMeta = {
                 actionId,
@@ -430,7 +445,7 @@ class TransactionController extends base_controller_1.BaseControllerV1 {
      * @param options.estimatedBaseFee - The estimated base fee of the transaction.
      */
     speedUpTransaction(transactionId, gasValues, { actionId, estimatedBaseFee, } = {}) {
-        var _a, _b;
+        var _a, _b, _c;
         return __awaiter(this, void 0, void 0, function* () {
             // If transaction is found for same action id, do not create a new speed up transaction.
             if (this.getTransactionWithActionId(actionId)) {
@@ -441,6 +456,7 @@ class TransactionController extends base_controller_1.BaseControllerV1 {
                 gasValues = (0, utils_1.normalizeGasFeeValues)(gasValues);
                 (0, utils_1.validateGasValues)(gasValues);
             }
+            (0, logger_1.projectLogger)('Creating speed up transaction', transactionId, gasValues);
             const transactionMeta = this.state.transactions.find(({ id }) => id === transactionId);
             /* istanbul ignore next */
             if (!transactionMeta) {
@@ -451,21 +467,21 @@ class TransactionController extends base_controller_1.BaseControllerV1 {
                 throw new Error('No sign method defined.');
             }
             // gasPrice (legacy non EIP1559)
-            const minGasPrice = (0, utils_1.getIncreasedPriceFromExisting)(transactionMeta.txParams.gasPrice, exports.SPEED_UP_RATE);
+            const minGasPrice = (0, utils_1.getIncreasedPriceFromExisting)(transactionMeta.txParams.gasPrice, this.speedUpMultiplier);
             const gasPriceFromValues = (0, utils_1.isGasPriceValue)(gasValues) && gasValues.gasPrice;
             const newGasPrice = (gasPriceFromValues &&
                 (0, utils_1.validateMinimumIncrease)(gasPriceFromValues, minGasPrice)) ||
                 minGasPrice;
             // maxFeePerGas (EIP1559)
             const existingMaxFeePerGas = (_a = transactionMeta.txParams) === null || _a === void 0 ? void 0 : _a.maxFeePerGas;
-            const minMaxFeePerGas = (0, utils_1.getIncreasedPriceFromExisting)(existingMaxFeePerGas, exports.SPEED_UP_RATE);
+            const minMaxFeePerGas = (0, utils_1.getIncreasedPriceFromExisting)(existingMaxFeePerGas, this.speedUpMultiplier);
             const maxFeePerGasValues = (0, utils_1.isFeeMarketEIP1559Values)(gasValues) && gasValues.maxFeePerGas;
             const newMaxFeePerGas = (maxFeePerGasValues &&
                 (0, utils_1.validateMinimumIncrease)(maxFeePerGasValues, minMaxFeePerGas)) ||
                 (existingMaxFeePerGas && minMaxFeePerGas);
             // maxPriorityFeePerGas (EIP1559)
             const existingMaxPriorityFeePerGas = (_b = transactionMeta.txParams) === null || _b === void 0 ? void 0 : _b.maxPriorityFeePerGas;
-            const minMaxPriorityFeePerGas = (0, utils_1.getIncreasedPriceFromExisting)(existingMaxPriorityFeePerGas, exports.SPEED_UP_RATE);
+            const minMaxPriorityFeePerGas = (0, utils_1.getIncreasedPriceFromExisting)(existingMaxPriorityFeePerGas, this.speedUpMultiplier);
             const maxPriorityFeePerGasValues = (0, utils_1.isFeeMarketEIP1559Values)(gasValues) && gasValues.maxPriorityFeePerGas;
             const newMaxPriorityFeePerGas = (maxPriorityFeePerGasValues &&
                 (0, utils_1.validateMinimumIncrease)(maxPriorityFeePerGasValues, minMaxPriorityFeePerGas)) ||
@@ -476,6 +492,11 @@ class TransactionController extends base_controller_1.BaseControllerV1 {
             const signedTx = yield this.sign(unsignedEthTx, transactionMeta.txParams.from);
             yield this.updateTransactionMetaRSV(transactionMeta, signedTx);
             const rawTx = (0, ethereumjs_util_1.bufferToHex)(signedTx.serialize());
+            const newFee = (_c = txParams.maxFeePerGas) !== null && _c !== void 0 ? _c : txParams.gasPrice;
+            const oldFee = txParams.maxFeePerGas
+                ? transactionMeta.txParams.maxFeePerGas
+                : transactionMeta.txParams.gasPrice;
+            (0, logger_1.projectLogger)('Submitting speed up transaction', { oldFee, newFee, txParams });
             const hash = yield (0, controller_utils_1.query)(this.ethQuery, 'sendRawTransaction', [rawTx]);
             const baseTransactionMeta = Object.assign(Object.assign({}, transactionMeta), { estimatedBaseFee, id: (0, uuid_1.v1)(), time: Date.now(), hash,
                 actionId, originalGasEstimate: transactionMeta.txParams.gas, type: types_1.TransactionType.retry, originalType: transactionMeta.type });
@@ -1070,6 +1091,15 @@ class TransactionController extends base_controller_1.BaseControllerV1 {
                                 resultCallbacks = undefined;
                             });
                         }
+                        const approvalValue = acceptResult.value;
+                        const updatedTransaction = approvalValue === null || approvalValue === void 0 ? void 0 : approvalValue.txMeta;
+                        if (updatedTransaction) {
+                            (0, logger_1.projectLogger)('Updating transaction with approval data', {
+                                customNonce: updatedTransaction.customNonceValue,
+                                params: updatedTransaction.txParams,
+                            });
+                            this.updateTransaction(updatedTransaction, 'TransactionController#processApproval - Updated with approval data');
+                        }
                     }
                     const { isCompleted: isTxCompleted } = this.isTransactionCompleted(transactionId);
                     if (!isTxCompleted) {
@@ -1124,8 +1154,8 @@ class TransactionController extends base_controller_1.BaseControllerV1 {
             const chainId = this.getChainId();
             const index = transactions.findIndex(({ id }) => transactionId === id);
             const transactionMeta = transactions[index];
-            const { txParams: { nonce, from }, } = transactionMeta;
-            let nonceLock;
+            const { txParams: { from }, } = transactionMeta;
+            let releaseNonceLock;
             try {
                 if (!this.sign) {
                     releaseLock();
@@ -1141,15 +1171,10 @@ class TransactionController extends base_controller_1.BaseControllerV1 {
                     (0, logger_1.projectLogger)('Skipping approval as signing in progress', transactionId);
                     return;
                 }
-                let nonceToUse = nonce;
-                // if a nonce already exists on the transactionMeta it means this is a speedup or cancel transaction
-                // so we want to reuse that nonce and hope that it beats the previous attempt to chain. Otherwise use a new locked nonce
-                if (!nonceToUse) {
-                    nonceLock = yield this.nonceTracker.getNonceLock(from);
-                    nonceToUse = (0, ethereumjs_util_1.addHexPrefix)(nonceLock.nextNonce.toString(16));
-                }
+                const [nonce, releaseNonce] = yield (0, nonce_1.getNextNonce)(transactionMeta, this.nonceTracker);
+                releaseNonceLock = releaseNonce;
                 transactionMeta.status = types_1.TransactionStatus.approved;
-                transactionMeta.txParams.nonce = nonceToUse;
+                transactionMeta.txParams.nonce = nonce;
                 transactionMeta.txParams.chainId = chainId;
                 const baseTxParams = Object.assign(Object.assign({}, transactionMeta.txParams), { gasLimit: transactionMeta.txParams.gas });
                 this.updateTransaction(transactionMeta, 'TransactionController#approveTransaction - Transaction approved');
@@ -1166,7 +1191,15 @@ class TransactionController extends base_controller_1.BaseControllerV1 {
                 if (!rawTx) {
                     return;
                 }
+                if (transactionMeta.type === types_1.TransactionType.swap) {
+                    (0, logger_1.projectLogger)('Determining pre-transaction balance');
+                    const preTxBalance = yield (0, controller_utils_1.query)(this.ethQuery, 'getBalance', [from]);
+                    transactionMeta.preTxBalance = preTxBalance;
+                    (0, logger_1.projectLogger)('Updated pre-transaction balance', transactionMeta.preTxBalance);
+                }
+                (0, logger_1.projectLogger)('Publishing transaction', txParams);
                 const hash = yield this.publishTransaction(rawTx);
+                (0, logger_1.projectLogger)('Publish successful', hash);
                 transactionMeta.hash = hash;
                 transactionMeta.status = types_1.TransactionStatus.submitted;
                 transactionMeta.submittedTime = new Date().getTime();
@@ -1183,9 +1216,7 @@ class TransactionController extends base_controller_1.BaseControllerV1 {
             finally {
                 this.inProcessOfSigning.delete(transactionId);
                 // must set transaction to submitted/failed before releasing lock
-                if (nonceLock) {
-                    nonceLock.releaseLock();
-                }
+                releaseNonceLock === null || releaseNonceLock === void 0 ? void 0 : releaseNonceLock();
                 releaseLock();
             }
         });
@@ -1535,10 +1566,11 @@ class TransactionController extends base_controller_1.BaseControllerV1 {
     }
     getNonceTrackerTransactions(status, address) {
         const currentChainId = this.getChainId();
-        return (0, utils_1.getAndFormatTransactionsForNonceTracker)(currentChainId, address, status, this.state.transactions);
+        return (0, nonce_1.getAndFormatTransactionsForNonceTracker)(currentChainId, address, status, this.state.transactions);
     }
     onConfirmedTransaction(transactionMeta) {
         (0, logger_1.projectLogger)('Processing confirmed transaction', transactionMeta.id);
+        this.markNonceDuplicatesDropped(transactionMeta.id);
         this.hub.emit('transaction-confirmed', { transactionMeta });
         this.hub.emit(`${transactionMeta.id}:confirmed`, transactionMeta);
         this.onTransactionStatusChange(transactionMeta);