@metamask-previews/transaction-controller 44.1.0-preview-2a6578b3 → 45.0.0-preview-83e41399

package/CHANGELOG.md

@@ -7,6 +7,12 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [45.0.0]
+
+### Changed
+
+- **BREAKING:** Bump `@metamask/accounts-controller` peer dependency from `^22.0.0` to `^23.0.0` ([#5292](https://github.com/MetaMask/core/pull/5292))
+
 ## [44.1.0]
 
 ### Changed
@@ -1255,7 +1261,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
     All changes listed after this point were applied to this package following the monorepo conversion.
 
-[Unreleased]: https://github.com/MetaMask/core/compare/@metamask/transaction-controller@44.1.0...HEAD
+[Unreleased]: https://github.com/MetaMask/core/compare/@metamask/transaction-controller@45.0.0...HEAD
+[45.0.0]: https://github.com/MetaMask/core/compare/@metamask/transaction-controller@44.1.0...@metamask/transaction-controller@45.0.0
 [44.1.0]: https://github.com/MetaMask/core/compare/@metamask/transaction-controller@44.0.0...@metamask/transaction-controller@44.1.0
 [44.0.0]: https://github.com/MetaMask/core/compare/@metamask/transaction-controller@43.0.0...@metamask/transaction-controller@44.0.0
 [43.0.0]: https://github.com/MetaMask/core/compare/@metamask/transaction-controller@42.1.0...@metamask/transaction-controller@43.0.0

package/dist/TransactionController.cjs

@@ -1,4 +1,6 @@
 "use strict";
+/* istanbul ignore file */
+// FIXME  - remove above ignore
 var __classPrivateFieldGet = (this && this.__classPrivateFieldGet) || function (receiver, state, kind, f) {
     if (kind === "a" && !f) throw new TypeError("Private accessor was defined without a getter");
     if (typeof state === "function" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError("Cannot read private member from an object whose class did not declare it");
@@ -13,9 +15,12 @@ var __classPrivateFieldSet = (this && this.__classPrivateFieldSet) || function (
 var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
-var _TransactionController_instances, _TransactionController_internalEvents, _TransactionController_methodDataHelper, _TransactionController_incomingTransactionChainIds, _TransactionController_incomingTransactionHelper, _TransactionController_incomingTransactionOptions, _TransactionController_pendingTransactionOptions, _TransactionController_trace, _TransactionController_transactionHistoryLimit, _TransactionController_isFirstTimeInteractionEnabled, _TransactionController_isSimulationEnabled, _TransactionController_testGasFeeFlows, _TransactionController_multichainTrackingHelper, _TransactionController_retryTransaction, _TransactionController_getChainId, _TransactionController_getNetworkClientId, _TransactionController_getEthQuery, _TransactionController_getProvider, _TransactionController_createNonceTracker, _TransactionController_createPendingTransactionTracker, _TransactionController_checkForPendingTransactionAndStartPolling, _TransactionController_stopAllTracking, _TransactionController_addIncomingTransactionHelperListeners, _TransactionController_removePendingTransactionTrackerListeners, _TransactionController_addPendingTransactionTrackerListeners, _TransactionController_getNonceTrackerPendingTransactions, _TransactionController_getGasFeeFlows, _TransactionController_getLayer1GasFeeFlows, _TransactionController_updateTransactionInternal, _TransactionController_updateFirstTimeInteraction, _TransactionController_updateSimulationData, _TransactionController_onGasFeePollerTransactionUpdate, _TransactionController_getSelectedAccount, _TransactionController_updateSubmitHistory;
+var _TransactionController_instances, _TransactionController_internalEvents, _TransactionController_methodDataHelper, _TransactionController_incomingTransactionChainIds, _TransactionController_incomingTransactionHelper, _TransactionController_incomingTransactionOptions, _TransactionController_pendingTransactionOptions, _TransactionController_trace, _TransactionController_transactionHistoryLimit, _TransactionController_isFirstTimeInteractionEnabled, _TransactionController_isSimulationEnabled, _TransactionController_testGasFeeFlows, _TransactionController_multichainTrackingHelper, _TransactionController_retryTransaction, _TransactionController_getChainId, _TransactionController_getNetworkClientId, _TransactionController_getEthQuery, _TransactionController_getProvider, _TransactionController_createNonceTracker, _TransactionController_createPendingTransactionTracker, _TransactionController_checkForPendingTransactionAndStartPolling, _TransactionController_stopAllTracking, _TransactionController_removeIncomingTransactionHelperListeners, _TransactionController_addIncomingTransactionHelperListeners, _TransactionController_removePendingTransactionTrackerListeners, _TransactionController_addPendingTransactionTrackerListeners, _TransactionController_getNonceTrackerPendingTransactions, _TransactionController_getGasFeeFlows, _TransactionController_getLayer1GasFeeFlows, _TransactionController_updateTransactionInternal, _TransactionController_updateFirstTimeInteraction, _TransactionController_updateSimulationData, _TransactionController_onGasFeePollerTransactionUpdate, _TransactionController_getSelectedAccount, _TransactionController_updateSubmitHistory;
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.TransactionController = exports.ApprovalState = exports.SPEED_UP_RATE = exports.CANCEL_RATE = void 0;
+exports.TransactionController = exports.ApprovalState = exports.SPEED_UP_RATE = exports.CANCEL_RATE = exports.HARDFORK = void 0;
+const common_1 = require("@ethereumjs/common");
+const tx_1 = require("@ethereumjs/tx");
+const util_1 = require("@ethereumjs/util");
 const base_controller_1 = require("@metamask/base-controller");
 const controller_utils_1 = require("@metamask/controller-utils");
 const eth_query_1 = __importDefault(require("@metamask/eth-query"));
@@ -43,7 +48,6 @@ const MultichainTrackingHelper_1 = require("./helpers/MultichainTrackingHelper.c
 const PendingTransactionTracker_1 = require("./helpers/PendingTransactionTracker.cjs");
 const logger_1 = require("./logger.cjs");
 const types_1 = require("./types.cjs");
-const eip7702_1 = require("./utils/eip7702.cjs");
 const external_transactions_1 = require("./utils/external-transactions.cjs");
 const gas_1 = require("./utils/gas.cjs");
 const gas_fees_1 = require("./utils/gas-fees.cjs");
@@ -51,7 +55,6 @@ const gas_flow_1 = require("./utils/gas-flow.cjs");
 const history_1 = require("./utils/history.cjs");
 const layer1_gas_fee_flow_1 = require("./utils/layer1-gas-fee-flow.cjs");
 const nonce_1 = require("./utils/nonce.cjs");
-const prepare_1 = require("./utils/prepare.cjs");
 const resimulate_1 = require("./utils/resimulate.cjs");
 const retry_1 = require("./utils/retry.cjs");
 const simulation_1 = require("./utils/simulation.cjs");
@@ -81,6 +84,7 @@ const metadata = {
         anonymous: false,
     },
 };
+exports.HARDFORK = common_1.Hardfork.London;
 const SUBMIT_HISTORY_LIMIT = 100;
 /**
  * Multiplier used to determine a transaction's increased gas fee during cancellation
@@ -350,19 +354,11 @@ class TransactionController extends base_controller_1.BaseController {
         if (!__classPrivateFieldGet(this, _TransactionController_multichainTrackingHelper, "f").has(networkClientId)) {
             throw new Error(`Network client not found - ${networkClientId}`);
         }
-        const permittedAddresses = origin === undefined
-            ? undefined
-            : await this.getPermittedAccounts?.(origin);
-        const selectedAddress = __classPrivateFieldGet(this, _TransactionController_instances, "m", _TransactionController_getSelectedAccount).call(this).address;
-        await (0, validation_1.validateTransactionOrigin)({
-            from: txParams.from,
-            origin,
-            permittedAddresses,
-            selectedAddress,
-            txParams,
-        });
         const isEIP1559Compatible = await this.getEIP1559Compatibility(networkClientId);
         (0, validation_1.validateTxParams)(txParams, isEIP1559Compatible);
+        if (origin && this.getPermittedAccounts) {
+            await (0, validation_1.validateTransactionOrigin)(await this.getPermittedAccounts(origin), __classPrivateFieldGet(this, _TransactionController_instances, "m", _TransactionController_getSelectedAccount).call(this).address, txParams.from, origin);
+        }
         const dappSuggestedGasFees = this.generateDappSuggestedGasFees(txParams, origin);
         const chainId = __classPrivateFieldGet(this, _TransactionController_instances, "m", _TransactionController_getChainId).call(this, networkClientId);
         const ethQuery = __classPrivateFieldGet(this, _TransactionController_instances, "m", _TransactionController_getEthQuery).call(this, {
@@ -631,6 +627,7 @@ class TransactionController extends base_controller_1.BaseController {
             this.onTransactionStatusChange(updatedTransactionMeta);
             // Intentional given potential duration of process.
             this.updatePostBalance(updatedTransactionMeta).catch((error) => {
+                /* istanbul ignore next */
                 (0, logger_1.projectLogger)('Error while updating post balance', error);
                 throw error;
             });
@@ -812,9 +809,12 @@ class TransactionController extends base_controller_1.BaseController {
         }
         const initialTx = listOfTxParams[0];
         const { chainId } = initialTx;
+        const common = this.getCommonConfiguration(chainId);
         const networkClientId = __classPrivateFieldGet(this, _TransactionController_instances, "m", _TransactionController_getNetworkClientId).call(this, { chainId });
-        const initialTxAsEthTx = (0, prepare_1.prepareTransaction)(chainId, initialTx);
-        const initialTxAsSerializedHex = (0, prepare_1.serializeTransaction)(initialTxAsEthTx);
+        const initialTxAsEthTx = tx_1.TransactionFactory.fromTxData(initialTx, {
+            common,
+        });
+        const initialTxAsSerializedHex = (0, util_1.bufferToHex)(initialTxAsEthTx.serialize());
         if (this.approvingTransactionIds.has(initialTxAsSerializedHex)) {
             return '';
         }
@@ -858,15 +858,17 @@ class TransactionController extends base_controller_1.BaseController {
      * @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.
+     * @param options.gasLimit - The new gas limit value to be assigned
+     * @param options.gasPrice - The new gas price value to be assigned
+     * @param options.maxFeePerGas - The new max fee per gas value to be assigned
+     * @param options.maxPriorityFeePerGas - The new max priority fee per gas value to be assigned
+     * @param options.nonce - The new nonce value to be assigned
      */
-    updateCustodialTransaction(transactionId, { errorMessage, hash, status, }) {
+    updateCustodialTransaction(transactionId, { errorMessage, hash, status, gasLimit, gasPrice, maxFeePerGas, maxPriorityFeePerGas, nonce, }) {
         const transactionMeta = this.getTransaction(transactionId);
         if (!transactionMeta) {
             throw new Error(`Cannot update custodial transaction as no transaction metadata found`);
         }
-        if (!transactionMeta.custodyId) {
-            throw new Error('Transaction must be a custodian transaction');
-        }
         if (status &&
             ![
                 types_1.TransactionStatus.submitted,
@@ -882,6 +884,22 @@ class TransactionController extends base_controller_1.BaseController {
         if (updatedTransactionMeta.status === types_1.TransactionStatus.failed) {
             updatedTransactionMeta.error = (0, utils_2.normalizeTxError)(new Error(errorMessage));
         }
+        if (gasLimit) {
+            updatedTransactionMeta.txParams.gasLimit = gasLimit;
+        }
+        if (gasPrice) {
+            updatedTransactionMeta.txParams.gasPrice = gasPrice;
+        }
+        if (maxFeePerGas) {
+            updatedTransactionMeta.txParams.maxFeePerGas = maxFeePerGas;
+        }
+        if (maxPriorityFeePerGas) {
+            updatedTransactionMeta.txParams.maxPriorityFeePerGas =
+                maxPriorityFeePerGas;
+        }
+        if (nonce) {
+            updatedTransactionMeta.txParams.nonce = nonce;
+        }
         this.updateTransaction(updatedTransactionMeta, `${controllerName}:updateCustodialTransaction - Custodial transaction updated`);
         if ([types_1.TransactionStatus.submitted, types_1.TransactionStatus.failed].includes(status)) {
             this.messagingSystem.publish(`${controllerName}:transactionFinished`, updatedTransactionMeta);
@@ -1028,9 +1046,10 @@ class TransactionController extends base_controller_1.BaseController {
             chainId,
         };
         const { from } = updatedTransactionParams;
-        const unsignedTransaction = (0, prepare_1.prepareTransaction)(chainId, updatedTransactionParams);
+        const common = this.getCommonConfiguration(chainId);
+        const unsignedTransaction = tx_1.TransactionFactory.fromTxData(updatedTransactionParams, { common });
         const signedTransaction = await this.sign(unsignedTransaction, from);
-        const rawTransaction = (0, prepare_1.serializeTransaction)(signedTransaction);
+        const rawTransaction = (0, util_1.bufferToHex)(signedTransaction.serialize());
         return rawTransaction;
     }
     /**
@@ -1045,7 +1064,6 @@ class TransactionController extends base_controller_1.BaseController {
     /**
      * Stop the signing process for a specific transaction.
      * Throws an error causing the transaction status to be set to failed.
-     *
      * @param transactionId - The ID of the transaction to stop signing.
      */
     abortTransactionSigning(transactionId) {
@@ -1212,19 +1230,21 @@ class TransactionController extends base_controller_1.BaseController {
                 transactionId,
                 note: 'TransactionController#approveTransaction - Transaction approved',
             }, (draftTxMeta) => {
-                const { chainId, txParams } = draftTxMeta;
-                const { gas, type } = txParams;
+                const { txParams, chainId } = draftTxMeta;
                 draftTxMeta.status = types_1.TransactionStatus.approved;
-                draftTxMeta.txParams.chainId = chainId;
-                draftTxMeta.txParams.gasLimit = gas;
-                draftTxMeta.txParams.nonce = nonce;
-                if (!type && (0, utils_2.isEIP1559Transaction)(txParams)) {
-                    draftTxMeta.txParams.type = types_1.TransactionEnvelopeType.feeMarket;
-                }
+                draftTxMeta.txParams = {
+                    ...txParams,
+                    nonce,
+                    chainId,
+                    gasLimit: txParams.gas,
+                    ...((0, utils_2.isEIP1559Transaction)(txParams) && {
+                        type: types_1.TransactionEnvelopeType.feeMarket,
+                    }),
+                };
             });
             this.onTransactionStatusChange(transactionMeta);
             const rawTx = await __classPrivateFieldGet(this, _TransactionController_trace, "f").call(this, { name: 'Sign', parentContext: traceContext }, () => this.signTransaction(transactionMeta, transactionMeta.txParams));
-            if (!this.beforePublish(transactionMeta)) {
+            if (!this.beforePublish(transactionMeta, rawTx)) {
                 (0, logger_1.projectLogger)('Skipping publishing transaction based on hook');
                 this.messagingSystem.publish(`${controllerName}:transactionPublishingSkipped`, transactionMeta);
                 return ApprovalState.SkippedViaBeforePublishHook;
@@ -1314,7 +1334,10 @@ class TransactionController extends base_controller_1.BaseController {
             status: types_1.TransactionStatus.rejected,
         };
         this.messagingSystem.publish(`${controllerName}:transactionFinished`, updatedTransactionMeta);
-        __classPrivateFieldGet(this, _TransactionController_internalEvents, "f").emit(`${transactionMeta.id}:finished`, updatedTransactionMeta);
+        __classPrivateFieldGet(this, _TransactionController_internalEvents, "f").emit(
+        // TODO: Either fix this lint violation or explain why it's necessary to ignore.
+        // eslint-disable-next-line @typescript-eslint/restrict-template-expressions
+        `${transactionMeta.id}:finished`, updatedTransactionMeta);
         this.messagingSystem.publish(`${controllerName}:transactionRejected`, {
             transactionMeta: updatedTransactionMeta,
             actionId,
@@ -1342,6 +1365,8 @@ class TransactionController extends base_controller_1.BaseController {
             .filter((tx) => {
             const { chainId, status, txParams, time } = tx;
             if (txParams) {
+                // TODO: Either fix this lint violation or explain why it's necessary to ignore.
+                // eslint-disable-next-line @typescript-eslint/restrict-template-expressions
                 const key = `${String(txParams.nonce)}-${(0, controller_utils_1.convertHexToDecimal)(chainId)}-${new Date(time).toDateString()}`;
                 if (nonceNetworkSet.has(key)) {
                     return true;
@@ -1422,6 +1447,29 @@ class TransactionController extends base_controller_1.BaseController {
         const isCompleted = this.isLocalFinalState(transaction.status);
         return { meta: transaction, isCompleted };
     }
+    prepareUnsignedEthTx(chainId, txParams) {
+        return tx_1.TransactionFactory.fromTxData(txParams, {
+            freeze: false,
+            common: this.getCommonConfiguration(chainId),
+        });
+    }
+    /**
+     * `@ethereumjs/tx` uses `@ethereumjs/common` as a configuration tool for
+     * specifying which chain, network, hardfork and EIPs to support for
+     * a transaction. By referencing this configuration, and analyzing the fields
+     * specified in txParams, @ethereumjs/tx is able to determine which EIP-2718
+     * transaction type to use.
+     *
+     * @param chainId - The chainId to use for the configuration.
+     * @returns common configuration object
+     */
+    getCommonConfiguration(chainId) {
+        const customChainParams = {
+            chainId: parseInt(chainId, 16),
+            defaultHardfork: exports.HARDFORK,
+        };
+        return common_1.Common.custom(customChainParams);
+    }
     onIncomingTransactions(transactions) {
         if (!transactions.length) {
             return;
@@ -1592,17 +1640,10 @@ class TransactionController extends base_controller_1.BaseController {
     }
     async signTransaction(transactionMeta, txParams) {
         (0, logger_1.projectLogger)('Signing transaction', txParams);
-        const { authorizationList, from } = txParams;
-        const finalTxParams = { ...txParams };
-        finalTxParams.authorizationList = await (0, eip7702_1.signAuthorizationList)({
-            authorizationList,
-            messenger: this.messagingSystem,
-            transactionMeta,
-        });
-        const unsignedEthTx = (0, prepare_1.prepareTransaction)(transactionMeta.chainId, finalTxParams);
+        const unsignedEthTx = this.prepareUnsignedEthTx(transactionMeta.chainId, txParams);
         this.approvingTransactionIds.add(transactionMeta.id);
         const signedTx = await new Promise((resolve, reject) => {
-            this.sign?.(unsignedEthTx, from, ...this.getAdditionalSignArguments(transactionMeta)).then(resolve, reject);
+            this.sign?.(unsignedEthTx, txParams.from, ...this.getAdditionalSignArguments(transactionMeta)).then(resolve, reject);
             this.signAbortCallbacks.set(transactionMeta.id, () => reject(new Error('Signing aborted by user')));
         });
         this.signAbortCallbacks.delete(transactionMeta.id);
@@ -1622,7 +1663,7 @@ class TransactionController extends base_controller_1.BaseController {
         };
         this.updateTransaction(transactionMetaWithRsv, 'TransactionController#approveTransaction - Transaction signed');
         this.onTransactionStatusChange(transactionMetaWithRsv);
-        const rawTx = (0, prepare_1.serializeTransaction)(signedTx);
+        const rawTx = (0, util_1.bufferToHex)(signedTx.serialize());
         const transactionMetaWithRawTx = (0, lodash_1.merge)({}, transactionMetaWithRsv, {
             rawTx,
         });
@@ -1718,10 +1759,10 @@ _TransactionController_internalEvents = new WeakMap(), _TransactionController_me
     }
     const newTxParams = (0, retry_1.getTransactionParamsWithIncreasedGasFee)(transactionMeta.txParams, rate, gasValues);
     prepareTransactionParams?.(newTxParams);
-    const unsignedEthTx = (0, prepare_1.prepareTransaction)(transactionMeta.chainId, newTxParams);
+    const unsignedEthTx = this.prepareUnsignedEthTx(transactionMeta.chainId, newTxParams);
     const signedTx = await this.sign(unsignedEthTx, transactionMeta.txParams.from);
     const transactionMetaWithRsv = this.updateTransactionMetaRSV(transactionMeta, signedTx);
-    const rawTx = (0, prepare_1.serializeTransaction)(signedTx);
+    const rawTx = (0, util_1.bufferToHex)(signedTx.serialize());
     const newFee = newTxParams.maxFeePerGas ?? newTxParams.gasPrice;
     const oldFee = newTxParams.maxFeePerGas
         ? transactionMetaWithRsv.txParams.maxFeePerGas
@@ -1805,13 +1846,15 @@ _TransactionController_internalEvents = new WeakMap(), _TransactionController_me
         }),
         hooks: {
             beforeCheckPendingTransaction: this.beforeCheckPendingTransaction.bind(this),
-            beforePublish: this.beforePublish.bind(this),
         },
     });
     __classPrivateFieldGet(this, _TransactionController_instances, "m", _TransactionController_addPendingTransactionTrackerListeners).call(this, pendingTransactionTracker);
     return pendingTransactionTracker;
 }, _TransactionController_stopAllTracking = function _TransactionController_stopAllTracking() {
     __classPrivateFieldGet(this, _TransactionController_multichainTrackingHelper, "f").stopAllTracking();
+}, _TransactionController_removeIncomingTransactionHelperListeners = function _TransactionController_removeIncomingTransactionHelperListeners(incomingTransactionHelper) {
+    incomingTransactionHelper.hub.removeAllListeners('transactions');
+    incomingTransactionHelper.hub.removeAllListeners('updated-last-fetched-timestamp');
 }, _TransactionController_addIncomingTransactionHelperListeners = function _TransactionController_addIncomingTransactionHelperListeners(incomingTransactionHelper) {
     incomingTransactionHelper.hub.on('transactions', this.onIncomingTransactions.bind(this));
 }, _TransactionController_removePendingTransactionTrackerListeners = function _TransactionController_removePendingTransactionTrackerListeners(pendingTransactionTracker) {