@metamask-previews/transaction-controller 45.0.0-preview-1adbaffc → 45.1.0-preview-1a21f764

package/CHANGELOG.md

@@ -7,6 +7,22 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [45.1.0]
+
+### Added
+
+- Add support for EIP-7702 / type 4 transactions ([#5285](https://github.com/MetaMask/core/pull/5285))
+  - Add `setCode` to `TransactionEnvelopeType`.
+  - Add `authorizationList` to `TransactionParams`.
+  - Export `Authorization` and `AuthorizationList` types.
+
+### Changed
+
+- The TransactionController messenger must now allow the `KeyringController:signAuthorization` action ([#5285](https://github.com/MetaMask/core/pull/5285))
+- Bump `@metamask/base-controller` from `^7.1.1` to `^8.0.0` ([#5305](https://github.com/MetaMask/core/pull/5305))
+- Bump `ethereumjs/tx` from `^4.2.0` to `^5.4.0` ([#5285](https://github.com/MetaMask/core/pull/5285))
+- Bump `ethereumjs/common` from `^3.2.0` to `^4.5.0` ([#5285](https://github.com/MetaMask/core/pull/5285))
+
 ## [45.0.0]
 
 ### Changed
@@ -1261,7 +1277,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@45.0.0...HEAD
+[Unreleased]: https://github.com/MetaMask/core/compare/@metamask/transaction-controller@45.1.0...HEAD
+[45.1.0]: https://github.com/MetaMask/core/compare/@metamask/transaction-controller@45.0.0...@metamask/transaction-controller@45.1.0
 [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

package/dist/TransactionController.cjs

@@ -13,12 +13,9 @@ 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_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;
+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_getInternalAccounts, _TransactionController_updateSubmitHistory;
 Object.defineProperty(exports, "__esModule", { value: true });
-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");
+exports.TransactionController = exports.ApprovalState = exports.SPEED_UP_RATE = exports.CANCEL_RATE = void 0;
 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"));
@@ -46,6 +43,8 @@ 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 batch_1 = require("./utils/batch.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");
@@ -53,6 +52,7 @@ 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");
@@ -82,7 +82,6 @@ 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
@@ -323,6 +322,34 @@ class TransactionController extends base_controller_1.BaseController {
     async handleMethodData(fourBytePrefix, networkClientId) {
         return __classPrivateFieldGet(this, _TransactionController_methodDataHelper, "f").lookup(fourBytePrefix, networkClientId);
     }
+    /**
+     * Add a batch of transactions to be submitted after approval.
+     *
+     * @param request - Request object containing the transactions to add.
+     * @returns Result object containing the generated batch ID.
+     */
+    async addTransactionBatch(request) {
+        return await (0, batch_1.addTransactionBatch)({
+            addTransaction: this.addTransaction.bind(this),
+            getChainId: __classPrivateFieldGet(this, _TransactionController_instances, "m", _TransactionController_getChainId).bind(this),
+            getEthQuery: (networkClientId) => __classPrivateFieldGet(this, _TransactionController_instances, "m", _TransactionController_getEthQuery).call(this, { networkClientId }),
+            messenger: this.messagingSystem,
+            request,
+        });
+    }
+    /**
+     * Determine which chains support atomic batch transactions with the given account address.
+     *
+     * @param address - The address of the account to check.
+     * @returns  The supported chain IDs.
+     */
+    async isAtomicBatchSupported(address) {
+        return (0, batch_1.isAtomicBatchSupported)({
+            address,
+            getEthQuery: (chainId) => __classPrivateFieldGet(this, _TransactionController_instances, "m", _TransactionController_getEthQuery).call(this, { chainId }),
+            messenger: this.messagingSystem,
+        });
+    }
     /**
      * Add a new unapproved transaction to state. Parameters will be validated, a
      * unique transaction id will be generated, and gas and gasPrice will be calculated
@@ -333,6 +360,7 @@ class TransactionController extends base_controller_1.BaseController {
      * @param options.actionId - Unique ID to prevent duplicate requests.
      * @param options.deviceConfirmedOn - An enum to indicate what device confirmed the transaction.
      * @param options.method - RPC method that requested the transaction.
+     * @param options.nestedTransactions - Params for any nested transactions encoded in the data.
      * @param options.origin - The origin of the transaction request, such as a dApp hostname.
      * @param options.requireApproval - Whether the transaction requires approval by the user, defaults to true unless explicitly disabled.
      * @param options.securityAlertResponse - Response from security validator.
@@ -347,16 +375,26 @@ class TransactionController extends base_controller_1.BaseController {
      */
     async addTransaction(txParams, options) {
         (0, logger_1.projectLogger)('Adding transaction', txParams, options);
-        const { actionId, deviceConfirmedOn, method, networkClientId, origin, requireApproval, securityAlertResponse, sendFlowHistory, swaps = {}, traceContext, type, } = options;
+        const { actionId, deviceConfirmedOn, method, nestedTransactions, networkClientId, origin, requireApproval, securityAlertResponse, sendFlowHistory, swaps = {}, traceContext, type, } = options;
         txParams = (0, utils_2.normalizeTransactionParams)(txParams);
         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;
+        const internalAccounts = __classPrivateFieldGet(this, _TransactionController_instances, "m", _TransactionController_getInternalAccounts).call(this);
+        await (0, validation_1.validateTransactionOrigin)({
+            from: txParams.from,
+            internalAccounts,
+            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, {
@@ -375,6 +413,7 @@ class TransactionController extends base_controller_1.BaseController {
                 deviceConfirmedOn,
                 id: (0, uuid_1.v1)(),
                 isFirstTimeInteraction: undefined,
+                nestedTransactions,
                 networkClientId,
                 origin,
                 securityAlertResponse,
@@ -806,12 +845,9 @@ 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 = tx_1.TransactionFactory.fromTxData(initialTx, {
-            common,
-        });
-        const initialTxAsSerializedHex = (0, util_1.bufferToHex)(initialTxAsEthTx.serialize());
+        const initialTxAsEthTx = (0, prepare_1.prepareTransaction)(chainId, initialTx);
+        const initialTxAsSerializedHex = (0, prepare_1.serializeTransaction)(initialTxAsEthTx);
         if (this.approvingTransactionIds.has(initialTxAsSerializedHex)) {
             return '';
         }
@@ -1025,10 +1061,9 @@ class TransactionController extends base_controller_1.BaseController {
             chainId,
         };
         const { from } = updatedTransactionParams;
-        const common = this.getCommonConfiguration(chainId);
-        const unsignedTransaction = tx_1.TransactionFactory.fromTxData(updatedTransactionParams, { common });
+        const unsignedTransaction = (0, prepare_1.prepareTransaction)(chainId, updatedTransactionParams);
         const signedTransaction = await this.sign(unsignedTransaction, from);
-        const rawTransaction = (0, util_1.bufferToHex)(signedTransaction.serialize());
+        const rawTransaction = (0, prepare_1.serializeTransaction)(signedTransaction);
         return rawTransaction;
     }
     /**
@@ -1043,6 +1078,7 @@ 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) {
@@ -1209,20 +1245,18 @@ class TransactionController extends base_controller_1.BaseController {
                 transactionId,
                 note: 'TransactionController#approveTransaction - Transaction approved',
             }, (draftTxMeta) => {
-                const { txParams, chainId } = draftTxMeta;
+                const { chainId, txParams } = draftTxMeta;
+                const { gas, type } = txParams;
                 draftTxMeta.status = types_1.TransactionStatus.approved;
-                draftTxMeta.txParams = {
-                    ...txParams,
-                    nonce,
-                    chainId,
-                    gasLimit: txParams.gas,
-                    ...((0, utils_2.isEIP1559Transaction)(txParams) && {
-                        type: types_1.TransactionEnvelopeType.feeMarket,
-                    }),
-                };
+                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;
+                }
             });
             this.onTransactionStatusChange(transactionMeta);
-            const rawTx = await __classPrivateFieldGet(this, _TransactionController_trace, "f").call(this, { name: 'Sign', parentContext: traceContext }, () => this.signTransaction(transactionMeta, transactionMeta.txParams));
+            const rawTx = await __classPrivateFieldGet(this, _TransactionController_trace, "f").call(this, { name: 'Sign', parentContext: traceContext }, () => this.signTransaction(transactionMeta));
             if (!this.beforePublish(transactionMeta)) {
                 (0, logger_1.projectLogger)('Skipping publishing transaction based on hook');
                 this.messagingSystem.publish(`${controllerName}:transactionPublishingSkipped`, transactionMeta);
@@ -1313,10 +1347,7 @@ class TransactionController extends base_controller_1.BaseController {
             status: types_1.TransactionStatus.rejected,
         };
         this.messagingSystem.publish(`${controllerName}:transactionFinished`, 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);
+        __classPrivateFieldGet(this, _TransactionController_internalEvents, "f").emit(`${transactionMeta.id}:finished`, updatedTransactionMeta);
         this.messagingSystem.publish(`${controllerName}:transactionRejected`, {
             transactionMeta: updatedTransactionMeta,
             actionId,
@@ -1344,8 +1375,6 @@ 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;
@@ -1426,29 +1455,6 @@ 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;
@@ -1617,12 +1623,20 @@ class TransactionController extends base_controller_1.BaseController {
         const currentAccountIsEIP1559Compatible = await this.getCurrentAccountEIP1559Compatibility();
         return (currentNetworkIsEIP1559Compatible && currentAccountIsEIP1559Compatible);
     }
-    async signTransaction(transactionMeta, txParams) {
+    async signTransaction(transactionMeta) {
+        const { txParams } = transactionMeta;
         (0, logger_1.projectLogger)('Signing transaction', txParams);
-        const unsignedEthTx = this.prepareUnsignedEthTx(transactionMeta.chainId, 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);
         this.approvingTransactionIds.add(transactionMeta.id);
         const signedTx = await new Promise((resolve, reject) => {
-            this.sign?.(unsignedEthTx, txParams.from, ...this.getAdditionalSignArguments(transactionMeta)).then(resolve, reject);
+            this.sign?.(unsignedEthTx, from, ...this.getAdditionalSignArguments(transactionMeta)).then(resolve, reject);
             this.signAbortCallbacks.set(transactionMeta.id, () => reject(new Error('Signing aborted by user')));
         });
         this.signAbortCallbacks.delete(transactionMeta.id);
@@ -1639,10 +1653,11 @@ class TransactionController extends base_controller_1.BaseController {
         const transactionMetaWithRsv = {
             ...this.updateTransactionMetaRSV(transactionMetaFromHook, signedTx),
             status: types_1.TransactionStatus.signed,
+            txParams: finalTxParams,
         };
         this.updateTransaction(transactionMetaWithRsv, 'TransactionController#approveTransaction - Transaction signed');
         this.onTransactionStatusChange(transactionMetaWithRsv);
-        const rawTx = (0, util_1.bufferToHex)(signedTx.serialize());
+        const rawTx = (0, prepare_1.serializeTransaction)(signedTx);
         const transactionMetaWithRawTx = (0, lodash_1.merge)({}, transactionMetaWithRsv, {
             rawTx,
         });
@@ -1738,10 +1753,10 @@ _TransactionController_internalEvents = new WeakMap(), _TransactionController_me
     }
     const newTxParams = (0, retry_1.getTransactionParamsWithIncreasedGasFee)(transactionMeta.txParams, rate, gasValues);
     prepareTransactionParams?.(newTxParams);
-    const unsignedEthTx = this.prepareUnsignedEthTx(transactionMeta.chainId, newTxParams);
+    const unsignedEthTx = (0, prepare_1.prepareTransaction)(transactionMeta.chainId, newTxParams);
     const signedTx = await this.sign(unsignedEthTx, transactionMeta.txParams.from);
     const transactionMetaWithRsv = this.updateTransactionMetaRSV(transactionMeta, signedTx);
-    const rawTx = (0, util_1.bufferToHex)(signedTx.serialize());
+    const rawTx = (0, prepare_1.serializeTransaction)(signedTx);
     const newFee = newTxParams.maxFeePerGas ?? newTxParams.gasPrice;
     const oldFee = newTxParams.maxFeePerGas
         ? transactionMetaWithRsv.txParams.maxFeePerGas
@@ -1832,9 +1847,6 @@ _TransactionController_internalEvents = new WeakMap(), _TransactionController_me
     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) {
@@ -1987,6 +1999,11 @@ _TransactionController_internalEvents = new WeakMap(), _TransactionController_me
     });
 }, _TransactionController_getSelectedAccount = function _TransactionController_getSelectedAccount() {
     return this.messagingSystem.call('AccountsController:getSelectedAccount');
+}, _TransactionController_getInternalAccounts = function _TransactionController_getInternalAccounts() {
+    const state = this.messagingSystem.call('AccountsController:getState');
+    return Object.values(state.internalAccounts?.accounts ?? {})
+        .filter((account) => account.type === 'eip155:eoa')
+        .map((account) => account.address);
 }, _TransactionController_updateSubmitHistory = function _TransactionController_updateSubmitHistory(transactionMeta, hash) {
     const { chainId, networkClientId, origin, rawTx, txParams } = transactionMeta;
     const { networkConfigurationsByChainId } = this.getNetworkState();