@metamask/transaction-controller 10.0.0 → 11.0.0

package/dist/TransactionController.js

@@ -23,10 +23,12 @@ const eth_method_registry_1 = __importDefault(require("eth-method-registry"));
 const eth_rpc_errors_1 = require("eth-rpc-errors");
 const ethereumjs_util_1 = require("ethereumjs-util");
 const events_1 = require("events");
+const lodash_1 = require("lodash");
 const nonce_tracker_1 = __importDefault(require("nonce-tracker"));
 const uuid_1 = require("uuid");
 const EtherscanRemoteTransactionSource_1 = require("./EtherscanRemoteTransactionSource");
 const external_transactions_1 = require("./external-transactions");
+const history_1 = require("./history");
 const IncomingTransactionHelper_1 = require("./IncomingTransactionHelper");
 const types_1 = require("./types");
 const utils_1 = require("./utils");
@@ -52,20 +54,22 @@ class TransactionController extends base_controller_1.BaseController {
      *
      * @param options - The controller options.
      * @param options.blockTracker - The block tracker used to poll for new blocks data.
+     * @param options.disableHistory - Whether to disable storing history in transaction metadata.
+     * @param options.disableSendFlowHistory - Explicitly disable transaction metadata history.
      * @param options.getNetworkState - Gets the state of the network controller.
      * @param options.getSelectedAddress - Gets the address of the currently selected account.
      * @param options.incomingTransactions - Configuration options for incoming transaction support.
-     * @param options.incomingTransactions.apiKey - An optional API key to use when fetching remote transaction data.
      * @param options.incomingTransactions.includeTokenTransfers - Whether or not to include ERC20 token transfers.
      * @param options.incomingTransactions.isEnabled - Whether or not incoming transaction retrieval is enabled.
-     * @param options.incomingTransactions.updateTransactions - Whether or not to update local transactions using remote transaction data.
+     * @param options.incomingTransactions.queryEntireHistory - Whether to initially query the entire transaction history or only recent blocks.
+     * @param options.incomingTransactions.updateTransactions - Whether to update local transactions using remote transaction data.
      * @param options.messenger - The controller messenger.
      * @param options.onNetworkStateChange - Allows subscribing to network controller state changes.
      * @param options.provider - The provider used to create the underlying EthQuery instance.
      * @param config - Initial options used to configure this controller.
      * @param state - Initial state to set on this controller.
      */
-    constructor({ blockTracker, getNetworkState, getSelectedAddress, incomingTransactions = {}, messenger, onNetworkStateChange, provider, }, config, state) {
+    constructor({ blockTracker, disableHistory, disableSendFlowHistory, getNetworkState, getSelectedAddress, incomingTransactions = {}, messenger, onNetworkStateChange, provider, }, config, state) {
         super(config, state);
         this.mutex = new async_mutex_1.Mutex();
         /**
@@ -90,6 +94,8 @@ class TransactionController extends base_controller_1.BaseController {
         this.messagingSystem = messenger;
         this.getNetworkState = getNetworkState;
         this.ethQuery = new eth_query_1.default(provider);
+        this.isSendFlowHistoryDisabled = disableSendFlowHistory !== null && disableSendFlowHistory !== void 0 ? disableSendFlowHistory : false;
+        this.isHistoryDisabled = disableHistory !== null && disableHistory !== void 0 ? disableHistory : false;
         this.registry = new eth_method_registry_1.default({ provider });
         this.nonceTracker = new nonce_tracker_1.default({
             provider,
@@ -100,10 +106,11 @@ class TransactionController extends base_controller_1.BaseController {
         this.incomingTransactionHelper = new IncomingTransactionHelper_1.IncomingTransactionHelper({
             blockTracker,
             getCurrentAccount: getSelectedAddress,
+            getLastFetchedBlockNumbers: () => this.state.lastFetchedBlockNumbers,
             getNetworkState,
             isEnabled: incomingTransactions.isEnabled,
+            queryEntireHistory: incomingTransactions.queryEntireHistory,
             remoteTransactionSource: new EtherscanRemoteTransactionSource_1.EtherscanRemoteTransactionSource({
-                apiKey: incomingTransactions.apiKey,
                 includeTokenTransfers: incomingTransactions.includeTokenTransfers,
             }),
             transactionLimit: this.config.txHistoryLimit,
@@ -119,7 +126,7 @@ class TransactionController extends base_controller_1.BaseController {
     }
     failTransaction(transactionMeta, error) {
         const newTransactionMeta = Object.assign(Object.assign({}, transactionMeta), { error, status: types_1.TransactionStatus.failed });
-        this.updateTransaction(newTransactionMeta);
+        this.updateTransaction(newTransactionMeta, 'TransactionController#failTransaction - Add error message and set status to failed');
         this.hub.emit(`${transactionMeta.id}:finished`, newTransactionMeta);
     }
     registryLookup(fourBytePrefix) {
@@ -175,43 +182,46 @@ class TransactionController extends base_controller_1.BaseController {
      * unique transaction id will be generated, and gas and gasPrice will be calculated
      * if not provided. If A `<tx.id>:unapproved` hub event will be emitted once added.
      *
-     * @param transaction - The transaction object to add.
+     * @param txParams - Standard parameters for an Ethereum transaction.
      * @param opts - Additional options to control how the transaction is added.
      * @param opts.actionId - Unique ID to prevent duplicate requests.
      * @param opts.deviceConfirmedOn - An enum to indicate what device confirmed the transaction.
      * @param opts.origin - The origin of the transaction request, such as a dApp hostname.
      * @param opts.requireApproval - Whether the transaction requires approval by the user, defaults to true unless explicitly disabled.
      * @param opts.securityAlertResponse - Response from security validator.
+     * @param opts.sendFlowHistory - The sendFlowHistory entries to add.
      * @returns Object containing a promise resolving to the transaction hash if approved.
      */
-    addTransaction(transaction, { actionId, deviceConfirmedOn, origin, requireApproval, securityAlertResponse, } = {}) {
+    addTransaction(txParams, { actionId, deviceConfirmedOn, origin, requireApproval, securityAlertResponse, sendFlowHistory, } = {}) {
         return __awaiter(this, void 0, void 0, function* () {
             const { chainId, networkId } = this.getChainAndNetworkId();
             const { transactions } = this.state;
-            transaction = (0, utils_1.normalizeTransaction)(transaction);
-            (0, utils_1.validateTransaction)(transaction);
-            const dappSuggestedGasFees = this.generateDappSuggestedGasFees(transaction, origin);
+            txParams = (0, utils_1.normalizeTxParams)(txParams);
+            (0, utils_1.validateTxParams)(txParams);
+            const dappSuggestedGasFees = this.generateDappSuggestedGasFees(txParams, origin);
             const existingTransactionMeta = this.getTransactionWithActionId(actionId);
             // 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
+                actionId,
+                chainId,
+                dappSuggestedGasFees,
+                deviceConfirmedOn,
                 id: (0, uuid_1.v1)(),
                 networkID: networkId !== null && networkId !== void 0 ? networkId : undefined,
-                chainId,
                 origin,
+                securityAlertResponse,
                 status: types_1.TransactionStatus.unapproved,
                 time: Date.now(),
-                transaction,
-                deviceConfirmedOn,
+                txParams,
+                userEditedGasLimit: false,
                 verifiedOnBlockchain: false,
-                dappSuggestedGasFees,
-                securityAlertResponse,
-                // Add actionId to txMeta to check if same actionId is seen again
-                actionId,
             };
             try {
-                const { gas, estimateGasError } = yield this.estimateGas(transaction);
-                transaction.gas = gas;
-                transaction.estimateGasError = estimateGasError;
+                const { gas, estimateGasError } = yield this.estimateGas(txParams);
+                txParams.gas = gas;
+                txParams.estimateGasError = estimateGasError;
+                transactionMeta.originalGasEstimate = gas;
             }
             catch (error) {
                 this.failTransaction(transactionMeta, error);
@@ -219,6 +229,13 @@ class TransactionController extends base_controller_1.BaseController {
             }
             // Checks if a transaction already exists with a given actionId
             if (!existingTransactionMeta) {
+                if (!this.isSendFlowHistoryDisabled) {
+                    transactionMeta.sendFlowHistory = sendFlowHistory !== null && sendFlowHistory !== void 0 ? sendFlowHistory : [];
+                }
+                // Initial history push
+                if (!this.isHistoryDisabled) {
+                    (0, history_1.addInitialHistorySnapshot)(transactionMeta);
+                }
                 transactions.push(transactionMeta);
                 this.update({
                     transactions: this.trimTransactionsForState(transactions),
@@ -265,18 +282,18 @@ class TransactionController extends base_controller_1.BaseController {
      * Attempts to cancel a transaction based on its ID by setting its status to "rejected"
      * and emitting a `<tx.id>:finished` hub event.
      *
-     * @param transactionID - The ID of the transaction to cancel.
+     * @param transactionId - The ID of the transaction to cancel.
      * @param gasValues - The gas values to use for the cancellation transaction.
      * @param options - The options for the cancellation transaction.
      * @param options.estimatedBaseFee - The estimated base fee of the transaction.
      */
-    stopTransaction(transactionID, gasValues, { estimatedBaseFee } = {}) {
+    stopTransaction(transactionId, gasValues, { estimatedBaseFee } = {}) {
         var _a, _b;
         return __awaiter(this, void 0, void 0, function* () {
             if (gasValues) {
                 (0, utils_1.validateGasValues)(gasValues);
             }
-            const transactionMeta = this.state.transactions.find(({ id }) => id === transactionID);
+            const transactionMeta = this.state.transactions.find(({ id }) => id === transactionId);
             if (!transactionMeta) {
                 return;
             }
@@ -284,20 +301,20 @@ 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.transaction.gasPrice, exports.CANCEL_RATE);
+            const minGasPrice = (0, utils_1.getIncreasedPriceFromExisting)(transactionMeta.txParams.gasPrice, exports.CANCEL_RATE);
             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.transaction) === null || _a === void 0 ? void 0 : _a.maxFeePerGas;
+            const existingMaxFeePerGas = (_a = transactionMeta.txParams) === null || _a === void 0 ? void 0 : _a.maxFeePerGas;
             const minMaxFeePerGas = (0, utils_1.getIncreasedPriceFromExisting)(existingMaxFeePerGas, exports.CANCEL_RATE);
             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.transaction) === null || _b === void 0 ? void 0 : _b.maxPriorityFeePerGas;
+            const existingMaxPriorityFeePerGas = (_b = transactionMeta.txParams) === null || _b === void 0 ? void 0 : _b.maxPriorityFeePerGas;
             const minMaxPriorityFeePerGas = (0, utils_1.getIncreasedPriceFromExisting)(existingMaxPriorityFeePerGas, exports.CANCEL_RATE);
             const maxPriorityFeePerGasValues = (0, utils_1.isFeeMarketEIP1559Values)(gasValues) && gasValues.maxPriorityFeePerGas;
             const newMaxPriorityFeePerGas = (maxPriorityFeePerGasValues &&
@@ -305,25 +322,26 @@ class TransactionController extends base_controller_1.BaseController {
                 (existingMaxPriorityFeePerGas && minMaxPriorityFeePerGas);
             const txParams = newMaxFeePerGas && newMaxPriorityFeePerGas
                 ? {
-                    from: transactionMeta.transaction.from,
-                    gasLimit: transactionMeta.transaction.gas,
+                    from: transactionMeta.txParams.from,
+                    gasLimit: transactionMeta.txParams.gas,
                     maxFeePerGas: newMaxFeePerGas,
                     maxPriorityFeePerGas: newMaxPriorityFeePerGas,
                     type: 2,
-                    nonce: transactionMeta.transaction.nonce,
-                    to: transactionMeta.transaction.from,
+                    nonce: transactionMeta.txParams.nonce,
+                    to: transactionMeta.txParams.from,
                     value: '0x0',
                 }
                 : {
-                    from: transactionMeta.transaction.from,
-                    gasLimit: transactionMeta.transaction.gas,
+                    from: transactionMeta.txParams.from,
+                    gasLimit: transactionMeta.txParams.gas,
                     gasPrice: newGasPrice,
-                    nonce: transactionMeta.transaction.nonce,
-                    to: transactionMeta.transaction.from,
+                    nonce: transactionMeta.txParams.nonce,
+                    to: transactionMeta.txParams.from,
                     value: '0x0',
                 };
             const unsignedEthTx = this.prepareUnsignedEthTx(txParams);
-            const signedTx = yield this.sign(unsignedEthTx, transactionMeta.transaction.from);
+            const signedTx = yield this.sign(unsignedEthTx, transactionMeta.txParams.from);
+            yield this.updateTransactionMetaRSV(transactionMeta, signedTx);
             const rawTx = (0, ethereumjs_util_1.bufferToHex)(signedTx.serialize());
             yield (0, controller_utils_1.query)(this.ethQuery, 'sendRawTransaction', [rawTx]);
             transactionMeta.estimatedBaseFee = estimatedBaseFee;
@@ -334,13 +352,13 @@ class TransactionController extends base_controller_1.BaseController {
     /**
      * Attempts to speed up a transaction increasing transaction gasPrice by ten percent.
      *
-     * @param transactionID - The ID of the transaction to speed up.
+     * @param transactionId - The ID of the transaction to speed up.
      * @param gasValues - The gas values to use for the speed up transaction.
      * @param options - The options for the speed up transaction.
      * @param options.actionId - Unique ID to prevent duplicate requests
      * @param options.estimatedBaseFee - The estimated base fee of the transaction.
      */
-    speedUpTransaction(transactionID, gasValues, { actionId, estimatedBaseFee, } = {}) {
+    speedUpTransaction(transactionId, gasValues, { actionId, estimatedBaseFee, } = {}) {
         var _a, _b;
         return __awaiter(this, void 0, void 0, function* () {
             // If transaction is found for same action id, do not create a new speed up transaction.
@@ -350,7 +368,7 @@ class TransactionController extends base_controller_1.BaseController {
             if (gasValues) {
                 (0, utils_1.validateGasValues)(gasValues);
             }
-            const transactionMeta = this.state.transactions.find(({ id }) => id === transactionID);
+            const transactionMeta = this.state.transactions.find(({ id }) => id === transactionId);
             /* istanbul ignore next */
             if (!transactionMeta) {
                 return;
@@ -361,37 +379,36 @@ class TransactionController extends base_controller_1.BaseController {
             }
             const { transactions } = this.state;
             // gasPrice (legacy non EIP1559)
-            const minGasPrice = (0, utils_1.getIncreasedPriceFromExisting)(transactionMeta.transaction.gasPrice, exports.SPEED_UP_RATE);
+            const minGasPrice = (0, utils_1.getIncreasedPriceFromExisting)(transactionMeta.txParams.gasPrice, exports.SPEED_UP_RATE);
             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.transaction) === null || _a === void 0 ? void 0 : _a.maxFeePerGas;
+            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 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.transaction) === null || _b === void 0 ? void 0 : _b.maxPriorityFeePerGas;
+            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 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.transaction), { gasLimit: transactionMeta.transaction.gas, maxFeePerGas: newMaxFeePerGas, maxPriorityFeePerGas: newMaxPriorityFeePerGas, type: 2 }) : Object.assign(Object.assign({}, transactionMeta.transaction), { gasLimit: transactionMeta.transaction.gas, gasPrice: newGasPrice });
+                ? 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 });
             const unsignedEthTx = this.prepareUnsignedEthTx(txParams);
-            const signedTx = yield this.sign(unsignedEthTx, transactionMeta.transaction.from);
+            const signedTx = yield this.sign(unsignedEthTx, transactionMeta.txParams.from);
+            yield this.updateTransactionMetaRSV(transactionMeta, signedTx);
             const rawTx = (0, ethereumjs_util_1.bufferToHex)(signedTx.serialize());
-            const transactionHash = 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(), transactionHash,
-                actionId });
+            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 });
             const newTransactionMeta = newMaxFeePerGas && newMaxPriorityFeePerGas
-                ? Object.assign(Object.assign({}, baseTransactionMeta), { transaction: Object.assign(Object.assign({}, transactionMeta.transaction), { maxFeePerGas: newMaxFeePerGas, maxPriorityFeePerGas: newMaxPriorityFeePerGas }) }) : Object.assign(Object.assign({}, baseTransactionMeta), { transaction: Object.assign(Object.assign({}, transactionMeta.transaction), { gasPrice: newGasPrice }) });
+                ? Object.assign(Object.assign({}, baseTransactionMeta), { txParams: Object.assign(Object.assign({}, transactionMeta.txParams), { maxFeePerGas: newMaxFeePerGas, maxPriorityFeePerGas: newMaxPriorityFeePerGas }) }) : Object.assign(Object.assign({}, baseTransactionMeta), { txParams: Object.assign(Object.assign({}, transactionMeta.txParams), { gasPrice: newGasPrice }) });
             transactions.push(newTransactionMeta);
             this.update({ transactions: this.trimTransactionsForState(transactions) });
             this.hub.emit(`${transactionMeta.id}:speedup`, newTransactionMeta);
@@ -421,7 +438,7 @@ class TransactionController extends base_controller_1.BaseController {
                 false,
             ]);
             // 2. If to is not defined or this is not a contract address, and there is no data use 0x5208 / 21000.
-            // If the newtwork is a custom network then bypass this check and fetch 'estimateGas'.
+            // If the network is a custom network then bypass this check and fetch 'estimateGas'.
             /* istanbul ignore next */
             const code = to ? yield (0, controller_utils_1.query)(this.ethQuery, 'getCode', [to]) : undefined;
             /* istanbul ignore next */
@@ -502,11 +519,15 @@ class TransactionController extends base_controller_1.BaseController {
      * Updates an existing transaction in state.
      *
      * @param transactionMeta - The new transaction to store in state.
+     * @param note - A note or update reason to include in the transaction history.
      */
-    updateTransaction(transactionMeta) {
+    updateTransaction(transactionMeta, note) {
         const { transactions } = this.state;
-        transactionMeta.transaction = (0, utils_1.normalizeTransaction)(transactionMeta.transaction);
-        (0, utils_1.validateTransaction)(transactionMeta.transaction);
+        transactionMeta.txParams = (0, utils_1.normalizeTxParams)(transactionMeta.txParams);
+        (0, utils_1.validateTxParams)(transactionMeta.txParams);
+        if (!this.isHistoryDisabled) {
+            (0, history_1.updateTransactionHistory)(transactionMeta, note);
+        }
         const index = transactions.findIndex(({ id }) => transactionMeta.id === id);
         transactions[index] = transactionMeta;
         this.update({ transactions: this.trimTransactionsForState(transactions) });
@@ -526,7 +547,7 @@ class TransactionController extends base_controller_1.BaseController {
             return;
         }
         const { chainId: currentChainId, networkId: currentNetworkID } = this.getChainAndNetworkId();
-        const newTransactions = this.state.transactions.filter(({ networkID, chainId, transaction }) => {
+        const newTransactions = this.state.transactions.filter(({ networkID, chainId, txParams }) => {
             var _a;
             // Using fallback to networkID only when there is no chainId present. Should be removed when networkID is completely removed.
             const isMatchingNetwork = ignoreNetwork ||
@@ -535,7 +556,7 @@ class TransactionController extends base_controller_1.BaseController {
             if (!isMatchingNetwork) {
                 return true;
             }
-            const isMatchingAddress = !address || ((_a = transaction.from) === null || _a === void 0 ? void 0 : _a.toLowerCase()) === address.toLowerCase();
+            const isMatchingAddress = !address || ((_a = txParams.from) === null || _a === void 0 ? void 0 : _a.toLowerCase()) === address.toLowerCase();
             return !isMatchingAddress;
         });
         this.update({
@@ -570,13 +591,88 @@ class TransactionController extends base_controller_1.BaseController {
                 // Update same nonce local transactions as dropped and define replacedBy properties.
                 this.markNonceDuplicatesDropped(transactionId);
                 // Update external provided transaction with updated gas values and confirmed status.
-                this.updateTransaction(transactionMeta);
+                this.updateTransaction(transactionMeta, 'TransactionController:confirmExternalTransaction - Add external transaction');
             }
             catch (error) {
                 console.error(error);
             }
         });
     }
+    /**
+     * Append new send flow history to a transaction.
+     *
+     * @param transactionID - The ID of the transaction to update.
+     * @param currentSendFlowHistoryLength - The length of the current sendFlowHistory array.
+     * @param sendFlowHistoryToAdd - The sendFlowHistory entries to add.
+     * @returns The updated transactionMeta.
+     */
+    updateTransactionSendFlowHistory(transactionID, currentSendFlowHistoryLength, sendFlowHistoryToAdd) {
+        var _a, _b;
+        if (this.isSendFlowHistoryDisabled) {
+            throw new Error('Send flow history is disabled for the current transaction controller');
+        }
+        const transactionMeta = this.getTransaction(transactionID);
+        if (!transactionMeta) {
+            throw new Error(`Cannot update send flow history as no transaction metadata found`);
+        }
+        (0, utils_1.validateIfTransactionUnapproved)(transactionMeta, 'updateTransactionSendFlowHistory');
+        if (currentSendFlowHistoryLength ===
+            (((_a = transactionMeta === null || transactionMeta === void 0 ? void 0 : transactionMeta.sendFlowHistory) === null || _a === void 0 ? void 0 : _a.length) || 0)) {
+            transactionMeta.sendFlowHistory = [
+                ...((_b = transactionMeta === null || transactionMeta === void 0 ? void 0 : transactionMeta.sendFlowHistory) !== null && _b !== void 0 ? _b : []),
+                ...sendFlowHistoryToAdd,
+            ];
+            this.updateTransaction(transactionMeta, 'TransactionController:updateTransactionSendFlowHistory - sendFlowHistory updated');
+        }
+        return this.getTransaction(transactionID);
+    }
+    /**
+     * Update the gas values of a transaction.
+     *
+     * @param transactionId - The ID of the transaction to update.
+     * @param gasValues - Gas values to update.
+     * @param gasValues.gas - Same as transaction.gasLimit.
+     * @param gasValues.gasLimit - Maxmimum number of units of gas to use for this transaction.
+     * @param gasValues.gasPrice - Price per gas for legacy transactions.
+     * @param gasValues.maxPriorityFeePerGas - Maximum amount per gas to give to validator as incentive.
+     * @param gasValues.maxFeePerGas - Maximum amount per gas to pay for the transaction, including the priority fee.
+     * @param gasValues.estimateUsed - Which estimate level was used.
+     * @param gasValues.estimateSuggested - Which estimate level that the API suggested.
+     * @param gasValues.defaultGasEstimates - The default estimate for gas.
+     * @param gasValues.originalGasEstimate - Original estimate for gas.
+     * @param gasValues.userEditedGasLimit - The gas limit supplied by user.
+     * @param gasValues.userFeeLevel - Estimate level user selected.
+     * @returns The updated transactionMeta.
+     */
+    updateTransactionGasFees(transactionId, { defaultGasEstimates, estimateUsed, estimateSuggested, gas, gasLimit, gasPrice, maxPriorityFeePerGas, maxFeePerGas, originalGasEstimate, userEditedGasLimit, userFeeLevel, }) {
+        const transactionMeta = this.getTransaction(transactionId);
+        if (!transactionMeta) {
+            throw new Error(`Cannot update transaction as no transaction metadata found`);
+        }
+        (0, utils_1.validateIfTransactionUnapproved)(transactionMeta, 'updateTransactionGasFees');
+        let transactionGasFees = {
+            txParams: {
+                gas,
+                gasLimit,
+                gasPrice,
+                maxPriorityFeePerGas,
+                maxFeePerGas,
+            },
+            defaultGasEstimates,
+            estimateUsed,
+            estimateSuggested,
+            originalGasEstimate,
+            userEditedGasLimit,
+            userFeeLevel,
+        };
+        // only update what is defined
+        transactionGasFees.txParams = (0, lodash_1.pickBy)(transactionGasFees.txParams);
+        transactionGasFees = (0, lodash_1.pickBy)(transactionGasFees);
+        // merge updated gas values with existing transaction meta
+        const updatedMeta = (0, lodash_1.merge)(transactionMeta, transactionGasFees);
+        this.updateTransaction(updatedMeta, 'TransactionController:updateTransactionGasFees - gas values updated');
+        return this.getTransaction(transactionId);
+    }
     processApproval(transactionMeta, { isExisting = false, requireApproval, shouldShowRequest = true, }) {
         return __awaiter(this, void 0, void 0, function* () {
             const transactionId = transactionMeta.id;
@@ -622,7 +718,7 @@ class TransactionController extends base_controller_1.BaseController {
                     throw cancelError;
                 case types_1.TransactionStatus.submitted:
                     resultCallbacks === null || resultCallbacks === void 0 ? void 0 : resultCallbacks.success();
-                    return finalMeta.transactionHash;
+                    return finalMeta.hash;
                 default:
                     const internalError = eth_rpc_errors_1.ethErrors.rpc.internal(`MetaMask Tx Signature: Unknown problem: ${JSON.stringify(finalMeta || transactionId)}`);
                     resultCallbacks === null || resultCallbacks === void 0 ? void 0 : resultCallbacks.error(internalError);
@@ -636,16 +732,16 @@ class TransactionController extends base_controller_1.BaseController {
      * using the sign configuration property, then published to the blockchain.
      * A `<tx.id>:finished` hub event is fired after success or failure.
      *
-     * @param transactionID - The ID of the transaction to approve.
+     * @param transactionId - The ID of the transaction to approve.
      */
-    approveTransaction(transactionID) {
+    approveTransaction(transactionId) {
         return __awaiter(this, void 0, void 0, function* () {
             const { transactions } = this.state;
             const releaseLock = yield this.mutex.acquire();
             const { chainId } = this.getChainAndNetworkId();
-            const index = transactions.findIndex(({ id }) => transactionID === id);
+            const index = transactions.findIndex(({ id }) => transactionId === id);
             const transactionMeta = transactions[index];
-            const { transaction: { nonce, from }, } = transactionMeta;
+            const { txParams: { nonce, from }, } = transactionMeta;
             let nonceLock;
             try {
                 if (!this.sign) {
@@ -667,12 +763,12 @@ class TransactionController extends base_controller_1.BaseController {
                     nonceToUse = (0, ethereumjs_util_1.addHexPrefix)(nonceLock.nextNonce.toString(16));
                 }
                 transactionMeta.status = status;
-                transactionMeta.transaction.nonce = nonceToUse;
-                transactionMeta.transaction.chainId = chainId;
-                const baseTxParams = Object.assign(Object.assign({}, transactionMeta.transaction), { gasLimit: transactionMeta.transaction.gas });
-                const isEIP1559 = (0, utils_1.isEIP1559Transaction)(transactionMeta.transaction);
+                transactionMeta.txParams.nonce = nonceToUse;
+                transactionMeta.txParams.chainId = chainId;
+                const baseTxParams = Object.assign(Object.assign({}, transactionMeta.txParams), { gasLimit: transactionMeta.txParams.gas });
+                const isEIP1559 = (0, utils_1.isEIP1559Transaction)(transactionMeta.txParams);
                 const txParams = isEIP1559
-                    ? Object.assign(Object.assign({}, baseTxParams), { maxFeePerGas: transactionMeta.transaction.maxFeePerGas, maxPriorityFeePerGas: transactionMeta.transaction.maxPriorityFeePerGas, estimatedBaseFee: transactionMeta.transaction.estimatedBaseFee, 
+                    ? 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
@@ -681,18 +777,17 @@ class TransactionController extends base_controller_1.BaseController {
                 }
                 const unsignedEthTx = this.prepareUnsignedEthTx(txParams);
                 const signedTx = yield this.sign(unsignedEthTx, from);
+                yield this.updateTransactionMetaRSV(transactionMeta, signedTx);
                 transactionMeta.status = types_1.TransactionStatus.signed;
-                this.updateTransaction(transactionMeta);
+                this.updateTransaction(transactionMeta, 'TransactionController#approveTransaction - Transaction signed');
                 const rawTx = (0, ethereumjs_util_1.bufferToHex)(signedTx.serialize());
                 transactionMeta.rawTx = rawTx;
-                this.updateTransaction(transactionMeta);
-                const transactionHash = yield (0, controller_utils_1.query)(this.ethQuery, 'sendRawTransaction', [
-                    rawTx,
-                ]);
-                transactionMeta.transactionHash = transactionHash;
+                this.updateTransaction(transactionMeta, 'TransactionController#approveTransaction - RawTransaction added');
+                const hash = yield (0, controller_utils_1.query)(this.ethQuery, 'sendRawTransaction', [rawTx]);
+                transactionMeta.hash = hash;
                 transactionMeta.status = types_1.TransactionStatus.submitted;
                 transactionMeta.submittedTime = new Date().getTime();
-                this.updateTransaction(transactionMeta);
+                this.updateTransaction(transactionMeta, 'TransactionController#approveTransaction - Transaction submitted');
                 this.hub.emit(`${transactionMeta.id}:finished`, transactionMeta);
             }
             catch (error) {
@@ -711,16 +806,16 @@ class TransactionController extends base_controller_1.BaseController {
      * Cancels a transaction based on its ID by setting its status to "rejected"
      * and emitting a `<tx.id>:finished` hub event.
      *
-     * @param transactionID - The ID of the transaction to cancel.
+     * @param transactionId - The ID of the transaction to cancel.
      */
-    cancelTransaction(transactionID) {
-        const transactionMeta = this.state.transactions.find(({ id }) => id === transactionID);
+    cancelTransaction(transactionId) {
+        const transactionMeta = this.state.transactions.find(({ id }) => id === transactionId);
         if (!transactionMeta) {
             return;
         }
         transactionMeta.status = types_1.TransactionStatus.rejected;
         this.hub.emit(`${transactionMeta.id}:finished`, transactionMeta);
-        const transactions = this.state.transactions.filter(({ id }) => id !== transactionID);
+        const transactions = this.state.transactions.filter(({ id }) => id !== transactionId);
         this.update({ transactions: this.trimTransactionsForState(transactions) });
     }
     /**
@@ -739,10 +834,12 @@ class TransactionController extends base_controller_1.BaseController {
      */
     trimTransactionsForState(transactions) {
         const nonceNetworkSet = new Set();
-        const txsToKeep = transactions.reverse().filter((tx) => {
-            const { chainId, networkID, status, transaction, time } = tx;
-            if (transaction) {
-                const key = `${transaction.nonce}-${chainId ? (0, controller_utils_1.convertHexToDecimal)(chainId) : networkID}-${new Date(time).toDateString()}`;
+        const txsToKeep = transactions
+            .sort((a, b) => (a.time > b.time ? -1 : 1)) // Descending time order
+            .filter((tx) => {
+            const { chainId, networkID, status, txParams, time } = tx;
+            if (txParams) {
+                const key = `${txParams.nonce}-${chainId ? (0, controller_utils_1.convertHexToDecimal)(chainId) : networkID}-${new Date(time).toDateString()}`;
                 if (nonceNetworkSet.has(key)) {
                     return true;
                 }
@@ -754,7 +851,7 @@ class TransactionController extends base_controller_1.BaseController {
             }
             return false;
         });
-        txsToKeep.reverse();
+        txsToKeep.reverse(); // Ascending time order
         return txsToKeep;
     }
     /**
@@ -792,11 +889,11 @@ class TransactionController extends base_controller_1.BaseController {
      */
     blockchainTransactionStateReconciler(meta) {
         return __awaiter(this, void 0, void 0, function* () {
-            const { status, transactionHash } = meta;
+            const { status, hash } = meta;
             switch (status) {
                 case types_1.TransactionStatus.confirmed:
                     const txReceipt = yield (0, controller_utils_1.query)(this.ethQuery, 'getTransactionReceipt', [
-                        transactionHash,
+                        hash,
                     ]);
                     if (!txReceipt) {
                         return [meta, false];
@@ -805,7 +902,7 @@ class TransactionController extends base_controller_1.BaseController {
                         txReceipt.blockHash,
                     ]);
                     meta.verifiedOnBlockchain = true;
-                    meta.transaction.gasUsed = txReceipt.gasUsed;
+                    meta.txParams.gasUsed = txReceipt.gasUsed;
                     meta.txReceipt = txReceipt;
                     meta.baseFeePerGas = txBlock === null || txBlock === void 0 ? void 0 : txBlock.baseFeePerGas;
                     meta.blockTimestamp = txBlock === null || txBlock === void 0 ? void 0 : txBlock.timestamp;
@@ -819,10 +916,10 @@ class TransactionController extends base_controller_1.BaseController {
                     return [meta, true];
                 case types_1.TransactionStatus.submitted:
                     const txObj = yield (0, controller_utils_1.query)(this.ethQuery, 'getTransactionByHash', [
-                        transactionHash,
+                        hash,
                     ]);
                     if (!txObj) {
-                        const receiptShowsFailedStatus = yield this.checkTxReceiptStatusIsFailed(transactionHash);
+                        const receiptShowsFailedStatus = yield this.checkTxReceiptStatusIsFailed(hash);
                         // Case the txObj is evaluated as false, a second check will
                         // determine if the tx failed or it is pending or confirmed
                         if (receiptShowsFailedStatus) {
@@ -933,7 +1030,7 @@ class TransactionController extends base_controller_1.BaseController {
         const updatedTransactions = [
             ...added,
             ...currentTransactions.map((originalTransaction) => {
-                const updatedTransaction = updated.find(({ transactionHash }) => transactionHash === originalTransaction.transactionHash);
+                const updatedTransaction = updated.find(({ hash }) => hash === originalTransaction.hash);
                 return updatedTransaction !== null && updatedTransaction !== void 0 ? updatedTransaction : originalTransaction;
             }),
         ];
@@ -945,11 +1042,11 @@ class TransactionController extends base_controller_1.BaseController {
         this.update({ lastFetchedBlockNumbers });
         this.hub.emit('incomingTransactionBlock', blockNumber);
     }
-    generateDappSuggestedGasFees(transaction, origin) {
+    generateDappSuggestedGasFees(txParams, origin) {
         if (!origin || origin === controller_utils_1.ORIGIN_METAMASK) {
             return undefined;
         }
-        const { gasPrice, maxFeePerGas, maxPriorityFeePerGas, gas } = transaction;
+        const { gasPrice, maxFeePerGas, maxPriorityFeePerGas, gas } = txParams;
         if (gasPrice === undefined &&
             maxFeePerGas === undefined &&
             maxPriorityFeePerGas === undefined &&
@@ -976,16 +1073,22 @@ class TransactionController extends base_controller_1.BaseController {
      * @param transactionMeta - Nominated external transaction to be added to state.
      */
     addExternalTransaction(transactionMeta) {
-        var _a;
+        var _a, _b;
         return __awaiter(this, void 0, void 0, function* () {
             const { networkId, chainId } = this.getChainAndNetworkId();
             const { transactions } = this.state;
-            const fromAddress = (_a = transactionMeta === null || transactionMeta === void 0 ? void 0 : transactionMeta.transaction) === null || _a === void 0 ? void 0 : _a.from;
-            const sameFromAndNetworkTransactions = transactions.filter((transaction) => transaction.transaction.from === fromAddress &&
+            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 &&
                 (0, utils_1.transactionMatchesNetwork)(transaction, chainId, networkId));
             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),
@@ -1002,10 +1105,10 @@ class TransactionController extends base_controller_1.BaseController {
         var _a, _b;
         const { networkId, chainId } = this.getChainAndNetworkId();
         const transactionMeta = this.getTransaction(transactionId);
-        const nonce = (_a = transactionMeta === null || transactionMeta === void 0 ? void 0 : transactionMeta.transaction) === null || _a === void 0 ? void 0 : _a.nonce;
-        const from = (_b = transactionMeta === null || transactionMeta === void 0 ? void 0 : transactionMeta.transaction) === null || _b === void 0 ? void 0 : _b.from;
-        const sameNonceTxs = this.state.transactions.filter((transaction) => transaction.transaction.from === from &&
-            transaction.transaction.nonce === nonce &&
+        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 &&
+            transaction.txParams.nonce === nonce &&
             (0, utils_1.transactionMatchesNetwork)(transaction, chainId, networkId));
         if (!sameNonceTxs.length) {
             return;
@@ -1030,7 +1133,7 @@ class TransactionController extends base_controller_1.BaseController {
      */
     setTransactionStatusDropped(transactionMeta) {
         transactionMeta.status = types_1.TransactionStatus.dropped;
-        this.updateTransaction(transactionMeta);
+        this.updateTransaction(transactionMeta, 'TransactionController#setTransactionStatusDropped - Transaction dropped');
     }
     /**
      * Get transaction with provided actionId.
@@ -1050,6 +1153,26 @@ class TransactionController extends base_controller_1.BaseController {
             });
         });
     }
+    /**
+     * Updates the r, s, and v properties of a TransactionMeta object
+     * with values from a signed transaction.
+     *
+     * @param transactionMeta - The TransactionMeta object to update.
+     * @param signedTx - The encompassing type for all transaction types containing r, s, and v values.
+     */
+    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));
+            }
+        });
+    }
 }
 exports.TransactionController = TransactionController;
 exports.default = TransactionController;