@metamask-previews/transaction-controller 17.0.0-preview.5736db0 → 18.3.0-preview.3fbb6b41

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");
@@ -55,21 +56,23 @@ const controllerName = 'TransactionController';
 /**
  * Controller responsible for submitting and managing transactions.
  */
-class TransactionController extends base_controller_1.BaseController {
+class TransactionController extends base_controller_1.BaseControllerV1 {
     /**
      * Creates a TransactionController instance.
      *
      * @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.
-     * @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.
@@ -82,6 +85,7 @@ class TransactionController extends base_controller_1.BaseController {
      * @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 +95,7 @@ class TransactionController extends base_controller_1.BaseController {
      * @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, 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();
@@ -123,14 +127,18 @@ class TransactionController extends base_controller_1.BaseController {
         this.registry = new eth_method_registry_1.default({ provider });
         this.getSavedGasFees = getSavedGasFees !== null && getSavedGasFees !== void 0 ? getSavedGasFees : ((_chainId) => undefined);
         this.getCurrentAccountEIP1559Compatibility =
-            getCurrentAccountEIP1559Compatibility;
+            getCurrentAccountEIP1559Compatibility !== null && getCurrentAccountEIP1559Compatibility !== void 0 ? getCurrentAccountEIP1559Compatibility : (() => Promise.resolve(true));
         this.getCurrentNetworkEIP1559Compatibility =
             getCurrentNetworkEIP1559Compatibility;
         this.getGasFeeEstimates =
             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;
         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 =
@@ -144,8 +152,8 @@ class TransactionController extends base_controller_1.BaseController {
             // @ts-expect-error provider types misaligned: SafeEventEmitterProvider vs Record<string,string>
             provider,
             blockTracker,
-            getPendingTransactions: (address) => (0, utils_1.getAndFormatTransactionsForNonceTracker)(address, types_1.TransactionStatus.submitted, this.state.transactions),
-            getConfirmedTransactions: (address) => (0, utils_1.getAndFormatTransactionsForNonceTracker)(address, types_1.TransactionStatus.confirmed, this.state.transactions),
+            getPendingTransactions: this.getNonceTrackerPendingTransactions.bind(this),
+            getConfirmedTransactions: this.getNonceTrackerTransactions.bind(this, types_1.TransactionStatus.confirmed),
         });
         this.incomingTransactionHelper = new IncomingTransactionHelper_1.IncomingTransactionHelper({
             blockTracker,
@@ -251,7 +259,7 @@ class TransactionController extends base_controller_1.BaseController {
      */
     addTransaction(txParams, { actionId, deviceConfirmedOn, method, origin, requireApproval, securityAlertResponse, sendFlowHistory, swaps = {}, type, } = {}) {
         return __awaiter(this, void 0, void 0, function* () {
-            const chainId = this.getChainId();
+            (0, logger_1.projectLogger)('Adding transaction', txParams);
             txParams = (0, utils_1.normalizeTxParams)(txParams);
             const isEIP1559Compatible = yield this.getEIP1559Compatibility();
             (0, validation_1.validateTxParams)(txParams, isEIP1559Compatible);
@@ -261,6 +269,7 @@ class TransactionController extends base_controller_1.BaseController {
             const dappSuggestedGasFees = this.generateDappSuggestedGasFees(txParams, origin);
             const transactionType = type !== null && type !== void 0 ? type : (yield (0, transaction_type_1.determineTransactionType)(txParams, this.ethQuery)).type;
             const existingTransactionMeta = this.getTransactionWithActionId(actionId);
+            const chainId = this.getChainId();
             // If a request to add a transaction with the same actionId is submitted again, a new transaction will not be created for it.
             const transactionMeta = existingTransactionMeta || {
                 // Add actionId to txMeta to check if same actionId is seen again
@@ -333,15 +342,18 @@ class TransactionController extends base_controller_1.BaseController {
      * @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)) {
                 return;
             }
             if (gasValues) {
+                // Not good practice to reassign a parameter but temporarily avoiding a larger refactor.
+                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;
@@ -350,21 +362,21 @@ class TransactionController extends base_controller_1.BaseController {
                 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)) ||
@@ -375,7 +387,7 @@ class TransactionController extends base_controller_1.BaseController {
                     gasLimit: transactionMeta.txParams.gas,
                     maxFeePerGas: newMaxFeePerGas,
                     maxPriorityFeePerGas: newMaxPriorityFeePerGas,
-                    type: '2',
+                    type: types_1.TransactionEnvelopeType.feeMarket,
                     nonce: transactionMeta.txParams.nonce,
                     to: transactionMeta.txParams.from,
                     value: '0x0',
@@ -391,6 +403,15 @@ class TransactionController extends base_controller_1.BaseController {
             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,
@@ -427,15 +448,18 @@ class TransactionController extends base_controller_1.BaseController {
      * @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)) {
                 return;
             }
             if (gasValues) {
+                // Not good practice to reassign a parameter but temporarily avoiding a larger refactor.
+                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) {
@@ -446,31 +470,36 @@ class TransactionController extends base_controller_1.BaseController {
                 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)) ||
                 (existingMaxPriorityFeePerGas && minMaxPriorityFeePerGas);
             const txParams = newMaxFeePerGas && newMaxPriorityFeePerGas
-                ? Object.assign(Object.assign({}, transactionMeta.txParams), { gasLimit: transactionMeta.txParams.gas, maxFeePerGas: newMaxFeePerGas, maxPriorityFeePerGas: newMaxPriorityFeePerGas, type: '2' }) : Object.assign(Object.assign({}, transactionMeta.txParams), { gasLimit: transactionMeta.txParams.gas, gasPrice: newGasPrice });
+                ? Object.assign(Object.assign({}, transactionMeta.txParams), { gasLimit: transactionMeta.txParams.gas, maxFeePerGas: newMaxFeePerGas, maxPriorityFeePerGas: newMaxPriorityFeePerGas, type: types_1.TransactionEnvelopeType.feeMarket }) : Object.assign(Object.assign({}, transactionMeta.txParams), { gasLimit: transactionMeta.txParams.gas, gasPrice: newGasPrice });
             const unsignedEthTx = this.prepareUnsignedEthTx(txParams);
             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 });
@@ -609,29 +638,15 @@ class TransactionController extends base_controller_1.BaseController {
                 // Update external provided transaction with updated gas values and confirmed status.
                 this.updateTransaction(transactionMeta, 'TransactionController:confirmExternalTransaction - Add external transaction');
                 this.onTransactionStatusChange(transactionMeta);
-                if (transactionMeta.type === types_1.TransactionType.swap) {
-                    (0, swaps_1.updatePostTransactionBalance)(transactionMeta, {
-                        ethQuery: this.ethQuery,
-                        getTransaction: this.getTransaction.bind(this),
-                        updateTransaction: this.updateTransaction.bind(this),
-                    })
-                        .then(({ updatedTransactionMeta, approvalTransactionMeta }) => {
-                        this.hub.emit('post-transaction-balance-updated', {
-                            transactionMeta: updatedTransactionMeta,
-                            approvalTransactionMeta,
-                        });
-                    })
-                        .catch((error) => {
-                        /* istanbul ignore next */
-                        (0, logger_1.projectLogger)('Error while updating post transaction balance', error);
-                    });
-                }
+                // Intentional given potential duration of process.
+                // eslint-disable-next-line @typescript-eslint/no-floating-promises
+                this.updatePostBalance(transactionMeta);
                 this.hub.emit('transaction-confirmed', {
                     transactionMeta,
                 });
             }
             catch (error) {
-                console.error(error);
+                console.error('Failed to confirm external transaction', error);
             }
         });
     }
@@ -798,6 +813,9 @@ class TransactionController extends base_controller_1.BaseController {
      */
     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 '';
             }
@@ -817,6 +835,7 @@ class TransactionController extends base_controller_1.BaseController {
                 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);
@@ -842,14 +861,12 @@ class TransactionController extends base_controller_1.BaseController {
      *
      * @param transactionId - The ID of the transaction to update.
      * @param options - The custodial transaction options to update.
-     * @param options.custodyStatus - The new custody status value to be assigned.
      * @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, { custodyStatus, errorMessage, hash, status, }) {
-        let transactionMeta;
-        transactionMeta = this.getTransaction(transactionId);
+    updateCustodialTransaction(transactionId, { errorMessage, hash, status, }) {
+        const transactionMeta = this.getTransaction(transactionId);
         if (!transactionMeta) {
             throw new Error(`Cannot update custodial transaction as no transaction metadata found`);
         }
@@ -864,23 +881,112 @@ class TransactionController extends base_controller_1.BaseController {
             ].includes(status)) {
             throw new Error(`Cannot update custodial transaction with status: ${status}`);
         }
-        if (status === types_1.TransactionStatus.signed) {
-            transactionMeta.status = status;
-        }
+        const updatedTransactionMeta = (0, lodash_1.merge)(transactionMeta, (0, lodash_1.pickBy)({ hash, status }));
         if (status === types_1.TransactionStatus.submitted) {
-            transactionMeta.submittedTime = new Date().getTime();
-            transactionMeta.status = status;
+            updatedTransactionMeta.submittedTime = new Date().getTime();
         }
         if (status === types_1.TransactionStatus.failed) {
-            transactionMeta = Object.assign(Object.assign({}, transactionMeta), { error: (0, utils_1.normalizeTxError)(new Error(errorMessage)), status: types_1.TransactionStatus.failed });
+            updatedTransactionMeta.error = (0, utils_1.normalizeTxError)(new Error(errorMessage));
         }
-        if (custodyStatus) {
-            transactionMeta.custodyStatus = custodyStatus;
+        this.updateTransaction(updatedTransactionMeta, `TransactionController:updateCustodialTransaction - Custodial transaction updated`);
+    }
+    /**
+     * Creates approvals for all unapproved transactions persisted.
+     */
+    initApprovals() {
+        const chainId = this.getChainId();
+        const unapprovedTxs = this.state.transactions.filter((transaction) => transaction.status === types_1.TransactionStatus.unapproved &&
+            transaction.chainId === chainId);
+        for (const txMeta of unapprovedTxs) {
+            this.processApproval(txMeta, {
+                shouldShowRequest: false,
+            }).catch((error) => {
+                if ((error === null || error === void 0 ? void 0 : error.code) === rpc_errors_1.errorCodes.provider.userRejectedRequest) {
+                    return;
+                }
+                console.error('Error during persisted transaction approval', error);
+            });
         }
-        if (hash) {
-            transactionMeta.hash = hash;
+    }
+    /**
+     * Search transaction metadata for matching entries.
+     *
+     * @param opts - Options bag.
+     * @param opts.searchCriteria - An object containing values or functions for transaction properties to filter transactions with.
+     * @param opts.initialList - The transactions to search. Defaults to the current state.
+     * @param opts.filterToCurrentNetwork - Whether to filter the results to the current network. Defaults to true.
+     * @param opts.limit - The maximum number of transactions to return. No limit by default.
+     * @returns An array of transactions matching the provided options.
+     */
+    getTransactions({ searchCriteria = {}, initialList, filterToCurrentNetwork = true, limit, } = {}) {
+        const chainId = this.getChainId();
+        // searchCriteria is an object that might have values that aren't predicate
+        // methods. When providing any other value type (string, number, etc), we
+        // consider this shorthand for "check the value at key for strict equality
+        // with the provided value". To conform this object to be only methods, we
+        // mapValues (lodash) such that every value on the object is a method that
+        // returns a boolean.
+        const predicateMethods = (0, lodash_1.mapValues)(searchCriteria, (predicate) => {
+            return typeof predicate === 'function'
+                ? predicate
+                : (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
+        // matching transactions that are sorted by time.
+        const filteredTransactions = (0, lodash_1.sortBy)((0, lodash_1.pickBy)(transactionsToFilter, (transaction) => {
+            if (filterToCurrentNetwork && transaction.chainId !== chainId) {
+                return false;
+            }
+            // iterate over the predicateMethods keys to check if the transaction
+            // matches the searchCriteria
+            for (const [key, predicate] of Object.entries(predicateMethods)) {
+                // We return false early as soon as we know that one of the specified
+                // search criteria do not match the transaction. This prevents
+                // needlessly checking all criteria when we already know the criteria
+                // are not fully satisfied. We check both txParams and the base
+                // object as predicate keys can be either.
+                if (key in transaction.txParams) {
+                    if (predicate(transaction.txParams[key]) === false) {
+                        return false;
+                    }
+                }
+                else if (predicate(transaction[key]) === false) {
+                    return false;
+                }
+            }
+            return true;
+        }), 'time');
+        if (limit !== undefined) {
+            // We need to have all transactions of a given nonce in order to display
+            // necessary details in the UI. We use the size of this set to determine
+            // whether we have reached the limit provided, thus ensuring that all
+            // transactions of nonces we include will be sent to the UI.
+            const nonces = new Set();
+            const txs = [];
+            // By default, the transaction list we filter from is sorted by time ASC.
+            // To ensure that filtered results prefers the newest transactions we
+            // iterate from right to left, inserting transactions into front of a new
+            // array. The original order is preserved, but we ensure that newest txs
+            // are preferred.
+            for (let i = filteredTransactions.length - 1; i > -1; i--) {
+                const txMeta = filteredTransactions[i];
+                const { nonce } = txMeta.txParams;
+                if (!nonces.has(nonce)) {
+                    if (nonces.size < limit) {
+                        nonces.add(nonce);
+                    }
+                    else {
+                        continue;
+                    }
+                }
+                // Push transaction into the beginning of our array to ensure the
+                // original order is preserved.
+                txs.unshift(txMeta);
+            }
+            return txs;
         }
-        this.updateTransaction(transactionMeta, `TransactionController:updateCustodialTransaction - Custodial transaction updated`);
+        return filteredTransactions;
     }
     signExternalTransaction(transactionParams) {
         return __awaiter(this, void 0, void 0, function* () {
@@ -915,7 +1021,8 @@ class TransactionController extends base_controller_1.BaseController {
     }
     updateGasProperties(transactionMeta) {
         return __awaiter(this, void 0, void 0, function* () {
-            const isEIP1559Compatible = yield this.getEIP1559Compatibility();
+            const isEIP1559Compatible = (yield this.getEIP1559Compatibility()) &&
+                transactionMeta.txParams.type !== types_1.TransactionEnvelopeType.legacy;
             const chainId = this.getChainId();
             yield (0, gas_1.updateGas)({
                 ethQuery: this.ethQuery,
@@ -936,8 +1043,6 @@ class TransactionController extends base_controller_1.BaseController {
         return this.state.transactions.filter((transaction) => transaction.status === status && transaction.chainId === chainId);
     }
     onBootCleanup() {
-        this.createApprovalsForUnapprovedTransactions();
-        this.loadGasValuesForUnapprovedTransactions();
         this.submitApprovedTransactions();
     }
     /**
@@ -957,26 +1062,6 @@ class TransactionController extends base_controller_1.BaseController {
             });
         }
     }
-    /**
-     * Update the gas values of all unapproved transactions on current chain.
-     */
-    loadGasValuesForUnapprovedTransactions() {
-        return __awaiter(this, void 0, void 0, function* () {
-            const unapprovedTransactions = this.getCurrentChainTransactionsByStatus(types_1.TransactionStatus.unapproved);
-            const results = yield Promise.allSettled(unapprovedTransactions.map((transactionMeta) => __awaiter(this, void 0, void 0, function* () {
-                yield this.updateGasProperties(transactionMeta);
-                this.updateTransaction(transactionMeta, 'TransactionController:loadGasValuesForUnapprovedTransactions - Gas values updated');
-            })));
-            for (const [index, result] of results.entries()) {
-                if (result.status === 'rejected') {
-                    const transactionMeta = unapprovedTransactions[index];
-                    this.failTransaction(transactionMeta, result.reason);
-                    /* istanbul ignore next */
-                    console.error('Error while loading gas values for persisted transaction id: ', transactionMeta.id, result.reason);
-                }
-            }
-        });
-    }
     /**
      * Force to submit approved transactions on current chain.
      */
@@ -1006,6 +1091,22 @@ class TransactionController extends base_controller_1.BaseController {
                             shouldShowRequest,
                         });
                         resultCallbacks = acceptResult.resultCallbacks;
+                        if (resultCallbacks) {
+                            this.hub.once(`${transactionId}:publish-skip`, () => {
+                                resultCallbacks === null || resultCallbacks === void 0 ? void 0 : resultCallbacks.success();
+                                // Remove the reference to prevent additional reports once submitted.
+                                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) {
@@ -1060,8 +1161,8 @@ class TransactionController extends base_controller_1.BaseController {
             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();
@@ -1077,37 +1178,35 @@ class TransactionController extends base_controller_1.BaseController {
                     (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');
                 this.onTransactionStatusChange(transactionMeta);
                 const isEIP1559 = (0, utils_1.isEIP1559Transaction)(transactionMeta.txParams);
                 const txParams = isEIP1559
-                    ? Object.assign(Object.assign({}, baseTxParams), { maxFeePerGas: transactionMeta.txParams.maxFeePerGas, maxPriorityFeePerGas: transactionMeta.txParams.maxPriorityFeePerGas, estimatedBaseFee: transactionMeta.txParams.estimatedBaseFee, 
-                        // specify type 2 if maxFeePerGas and maxPriorityFeePerGas are set
-                        type: '2' }) : baseTxParams;
-                // delete gasPrice if maxFeePerGas and maxPriorityFeePerGas are set
-                if (isEIP1559) {
-                    delete txParams.gasPrice;
-                }
-                const rawTx = yield this.signTransaction(transactionMeta);
+                    ? Object.assign(Object.assign({}, baseTxParams), { estimatedBaseFee: transactionMeta.txParams.estimatedBaseFee, type: types_1.TransactionEnvelopeType.feeMarket }) : baseTxParams;
+                const rawTx = yield this.signTransaction(transactionMeta, txParams);
                 if (!this.beforePublish(transactionMeta)) {
                     (0, logger_1.projectLogger)('Skipping publishing transaction based on hook');
+                    this.hub.emit(`${transactionMeta.id}:publish-skip`, transactionMeta);
                     return;
                 }
                 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();
@@ -1124,9 +1223,7 @@ class TransactionController extends base_controller_1.BaseController {
             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();
             }
         });
@@ -1167,7 +1264,7 @@ class TransactionController extends base_controller_1.BaseController {
      * representation, this function will not break apart transactions with the
      * same nonce, created on the same day, per network. Not accounting for transactions of the same
      * nonce, same day and network combo can result in confusing or broken experiences
-     * in the UI. The transactions are then updated using the BaseController update.
+     * in the UI. The transactions are then updated using the BaseControllerV1 update.
      *
      * @param transactions - The transactions to be applied to the state.
      * @returns The trimmed list of transactions.
@@ -1331,25 +1428,23 @@ class TransactionController extends base_controller_1.BaseController {
      */
     addExternalTransaction(transactionMeta) {
         var _a, _b;
-        return __awaiter(this, void 0, void 0, function* () {
-            const chainId = this.getChainId();
-            const { transactions } = this.state;
-            const fromAddress = (_a = transactionMeta === null || transactionMeta === void 0 ? void 0 : transactionMeta.txParams) === null || _a === void 0 ? void 0 : _a.from;
-            const sameFromAndNetworkTransactions = transactions.filter((transaction) => transaction.txParams.from === fromAddress &&
-                transaction.chainId === chainId);
-            const confirmedTxs = sameFromAndNetworkTransactions.filter((transaction) => transaction.status === types_1.TransactionStatus.confirmed);
-            const pendingTxs = sameFromAndNetworkTransactions.filter((transaction) => transaction.status === types_1.TransactionStatus.submitted);
-            (0, external_transactions_1.validateConfirmedExternalTransaction)(transactionMeta, confirmedTxs, pendingTxs);
-            // Make sure provided external transaction has non empty history array
-            if (!((_b = transactionMeta.history) !== null && _b !== void 0 ? _b : []).length) {
-                if (!this.isHistoryDisabled) {
-                    (0, history_1.addInitialHistorySnapshot)(transactionMeta);
-                }
+        const chainId = this.getChainId();
+        const { transactions } = this.state;
+        const fromAddress = (_a = transactionMeta === null || transactionMeta === void 0 ? void 0 : transactionMeta.txParams) === null || _a === void 0 ? void 0 : _a.from;
+        const sameFromAndNetworkTransactions = transactions.filter((transaction) => transaction.txParams.from === fromAddress &&
+            transaction.chainId === chainId);
+        const confirmedTxs = sameFromAndNetworkTransactions.filter((transaction) => transaction.status === types_1.TransactionStatus.confirmed);
+        const pendingTxs = sameFromAndNetworkTransactions.filter((transaction) => transaction.status === types_1.TransactionStatus.submitted);
+        (0, external_transactions_1.validateConfirmedExternalTransaction)(transactionMeta, confirmedTxs, pendingTxs);
+        // Make sure provided external transaction has non empty history array
+        if (!((_b = transactionMeta.history) !== null && _b !== void 0 ? _b : []).length) {
+            if (!this.isHistoryDisabled) {
+                (0, history_1.addInitialHistorySnapshot)(transactionMeta);
             }
-            const updatedTransactions = [...transactions, transactionMeta];
-            this.update({
-                transactions: this.trimTransactionsForState(updatedTransactions),
-            });
+        }
+        const updatedTransactions = [...transactions, transactionMeta];
+        this.update({
+            transactions: this.trimTransactionsForState(updatedTransactions),
         });
     }
     /**
@@ -1435,27 +1530,22 @@ class TransactionController extends base_controller_1.BaseController {
         });
     }
     getEIP1559Compatibility() {
-        var _a, _b;
         return __awaiter(this, void 0, void 0, function* () {
             const currentNetworkIsEIP1559Compatible = yield this.getCurrentNetworkEIP1559Compatibility();
-            const currentAccountIsEIP1559Compatible = (_b = (_a = this.getCurrentAccountEIP1559Compatibility) === null || _a === void 0 ? void 0 : _a.call(this)) !== null && _b !== void 0 ? _b : true;
+            const currentAccountIsEIP1559Compatible = yield this.getCurrentAccountEIP1559Compatibility();
             return (currentNetworkIsEIP1559Compatible && currentAccountIsEIP1559Compatible);
         });
     }
     addPendingTransactionTrackerListeners() {
-        this.pendingTransactionTracker.hub.on('transaction-confirmed', (transactionMeta) => {
-            this.hub.emit('transaction-confirmed', { transactionMeta });
-            this.hub.emit(`${transactionMeta.id}:confirmed`, transactionMeta);
-            this.onTransactionStatusChange(transactionMeta);
-        });
+        this.pendingTransactionTracker.hub.on('transaction-confirmed', this.onConfirmedTransaction.bind(this));
         this.pendingTransactionTracker.hub.on('transaction-dropped', this.setTransactionStatusDropped.bind(this));
         this.pendingTransactionTracker.hub.on('transaction-failed', this.failTransaction.bind(this));
         this.pendingTransactionTracker.hub.on('transaction-updated', this.updateTransaction.bind(this));
     }
-    signTransaction(transactionMeta) {
+    signTransaction(transactionMeta, txParams) {
         var _a;
         return __awaiter(this, void 0, void 0, function* () {
-            const { txParams } = transactionMeta;
+            (0, logger_1.projectLogger)('Signing transaction', txParams);
             const unsignedEthTx = this.prepareUnsignedEthTx(txParams);
             this.inProcessOfSigning.add(transactionMeta.id);
             const signedTx = yield ((_a = this.sign) === null || _a === void 0 ? void 0 : _a.call(this, unsignedEthTx, txParams.from, ...this.getAdditionalSignArguments(transactionMeta)));
@@ -1464,6 +1554,7 @@ class TransactionController extends base_controller_1.BaseController {
                 return undefined;
             }
             if (!this.afterSign(transactionMeta, signedTx)) {
+                this.updateTransaction(transactionMeta, 'TransactionController#signTransaction - Update after sign');
                 (0, logger_1.projectLogger)('Skipping signed status based on hook');
                 return undefined;
             }
@@ -1480,7 +1571,47 @@ class TransactionController extends base_controller_1.BaseController {
     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);
+    }
+    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);
+        // Intentional given potential duration of process.
+        // eslint-disable-next-line @typescript-eslint/no-floating-promises
+        this.updatePostBalance(transactionMeta);
+    }
+    updatePostBalance(transactionMeta) {
+        return __awaiter(this, void 0, void 0, function* () {
+            try {
+                if (transactionMeta.type !== types_1.TransactionType.swap) {
+                    return;
+                }
+                const { updatedTransactionMeta, approvalTransactionMeta } = yield (0, swaps_1.updatePostTransactionBalance)(transactionMeta, {
+                    ethQuery: this.ethQuery,
+                    getTransaction: this.getTransaction.bind(this),
+                    updateTransaction: this.updateTransaction.bind(this),
+                });
+                this.hub.emit('post-transaction-balance-updated', {
+                    transactionMeta: updatedTransactionMeta,
+                    approvalTransactionMeta,
+                });
+            }
+            catch (error) {
+                /* istanbul ignore next */
+                (0, logger_1.projectLogger)('Error while updating post transaction balance', error);
+            }
+        });
+    }
 }
 exports.TransactionController = TransactionController;
-exports.default = TransactionController;
 //# sourceMappingURL=TransactionController.js.map