@metamask-previews/transaction-controller 10.0.0-preview.f0f357a → 11.0.0-preview.56ca173

package/dist/TransactionController.js

@@ -23,6 +23,7 @@ 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");
@@ -58,7 +59,6 @@ class TransactionController extends base_controller_1.BaseController {
      * @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.queryEntireHistory - Whether to initially query the entire transaction history or only recent blocks.
@@ -111,7 +111,6 @@ class TransactionController extends base_controller_1.BaseController {
             isEnabled: incomingTransactions.isEnabled,
             queryEntireHistory: incomingTransactions.queryEntireHistory,
             remoteTransactionSource: new EtherscanRemoteTransactionSource_1.EtherscanRemoteTransactionSource({
-                apiKey: incomingTransactions.apiKey,
                 includeTokenTransfers: incomingTransactions.includeTokenTransfers,
             }),
             transactionLimit: this.config.txHistoryLimit,
@@ -183,7 +182,7 @@ 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.
@@ -193,13 +192,13 @@ class TransactionController extends base_controller_1.BaseController {
      * @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, sendFlowHistory, } = {}) {
+    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 || {
@@ -214,13 +213,14 @@ class TransactionController extends base_controller_1.BaseController {
                 securityAlertResponse,
                 status: types_1.TransactionStatus.unapproved,
                 time: Date.now(),
-                transaction,
+                txParams,
+                userEditedGasLimit: false,
                 verifiedOnBlockchain: false,
             };
             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) {
@@ -282,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;
             }
@@ -301,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 &&
@@ -322,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;
@@ -351,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.
@@ -367,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;
@@ -378,35 +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 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.transaction.gas });
+                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);
@@ -521,8 +523,8 @@ class TransactionController extends base_controller_1.BaseController {
      */
     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);
         }
@@ -545,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 ||
@@ -554,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({
@@ -624,6 +626,53 @@ class TransactionController extends base_controller_1.BaseController {
         }
         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;
@@ -683,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) {
@@ -714,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
@@ -728,6 +777,7 @@ 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, 'TransactionController#approveTransaction - Transaction signed');
                 const rawTx = (0, ethereumjs_util_1.bufferToHex)(signedTx.serialize());
@@ -756,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) });
     }
     /**
@@ -787,9 +837,9 @@ class TransactionController extends base_controller_1.BaseController {
         const txsToKeep = transactions
             .sort((a, b) => (a.time > b.time ? -1 : 1)) // Descending time order
             .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 { 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;
                 }
@@ -852,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;
@@ -992,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 &&
@@ -1027,8 +1077,8 @@ class TransactionController extends base_controller_1.BaseController {
         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);
@@ -1055,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;
@@ -1103,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;