@metamask/transaction-controller 46.0.0 → 48.0.0

package/dist/TransactionController.mjs

@@ -9,7 +9,7 @@ var __classPrivateFieldSet = (this && this.__classPrivateFieldSet) || function (
     if (typeof state === "function" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError("Cannot write private member to an object whose class did not declare it");
     return (kind === "a" ? f.call(receiver, value) : f ? f.value = value : state.set(receiver, value)), value;
 };
-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_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, _TransactionController_updateGasEstimate;
 function $importDefault(module) {
     if (module?.__esModule) {
         return module.default;
@@ -46,7 +46,8 @@ import { PendingTransactionTracker } from "./helpers/PendingTransactionTracker.m
 import { ResimulateHelper, hasSimulationDataChanged, shouldResimulate } from "./helpers/ResimulateHelper.mjs";
 import { projectLogger as log } from "./logger.mjs";
 import { TransactionEnvelopeType, TransactionType, TransactionStatus, SimulationErrorCode } from "./types.mjs";
-import { signAuthorizationList } from "./utils/eip7702.mjs";
+import { addTransactionBatch, isAtomicBatchSupported } from "./utils/batch.mjs";
+import { generateEIP7702BatchTransaction, signAuthorizationList } from "./utils/eip7702.mjs";
 import { validateConfirmedExternalTransaction } from "./utils/external-transactions.mjs";
 import { addGasBuffer, estimateGas, updateGas } from "./utils/gas.mjs";
 import { updateGasFees } from "./utils/gas-fees.mjs";
@@ -155,31 +156,9 @@ export class TransactionController extends BaseController {
      * Constructs a TransactionController.
      *
      * @param options - The controller options.
-     * @param options.disableHistory - Whether to disable storing history in transaction metadata.
-     * @param options.disableSendFlowHistory - Explicitly disable transaction metadata history.
-     * @param options.disableSwaps - Whether to disable additional processing on swaps transactions.
-     * @param options.getCurrentAccountEIP1559Compatibility - Whether or not the account supports EIP-1559.
-     * @param options.getCurrentNetworkEIP1559Compatibility - Whether or not the network supports EIP-1559.
-     * @param options.getExternalPendingTransactions - Callback to retrieve pending transactions from external sources.
-     * @param options.getGasFeeEstimates - Callback to retrieve gas fee estimates.
-     * @param options.getNetworkClientRegistry - Gets the network client registry.
-     * @param options.getNetworkState - Gets the state of the network controller.
-     * @param options.getPermittedAccounts - Get accounts that a given origin has permissions for.
-     * @param options.getSavedGasFees - Gets the saved gas fee config.
-     * @param options.incomingTransactions - Configuration options for incoming transaction support.
-     * @param options.isFirstTimeInteractionEnabled - Whether first time interaction checks are enabled.
-     * @param options.isSimulationEnabled - Whether new transactions will be automatically simulated.
-     * @param options.messenger - The controller messenger.
-     * @param options.pendingTransactions - Configuration options for pending transaction support.
-     * @param options.securityProviderRequest - A function for verifying a transaction, whether it is malicious or not.
-     * @param options.sign - Function used to sign transactions.
-     * @param options.state - Initial state to set on this controller.
-     * @param options.testGasFeeFlows - Whether to use the test gas fee flow.
-     * @param options.trace - Callback to generate trace information.
-     * @param options.transactionHistoryLimit - Transaction history limit.
-     * @param options.hooks - The controller hooks.
      */
-    constructor({ disableHistory, disableSendFlowHistory, disableSwaps, getCurrentAccountEIP1559Compatibility, getCurrentNetworkEIP1559Compatibility, getExternalPendingTransactions, getGasFeeEstimates, getNetworkClientRegistry, getNetworkState, getPermittedAccounts, getSavedGasFees, incomingTransactions = {}, isFirstTimeInteractionEnabled, isSimulationEnabled, messenger, pendingTransactions = {}, securityProviderRequest, sign, state, testGasFeeFlows, trace, transactionHistoryLimit = 40, hooks, }) {
+    constructor(options) {
+        const { disableHistory, disableSendFlowHistory, disableSwaps, getCurrentAccountEIP1559Compatibility, getCurrentNetworkEIP1559Compatibility, getExternalPendingTransactions, getGasFeeEstimates, getNetworkClientRegistry, getNetworkState, getPermittedAccounts, getSavedGasFees, incomingTransactions = {}, isFirstTimeInteractionEnabled, isSimulationEnabled, messenger, pendingTransactions = {}, securityProviderRequest, sign, state, testGasFeeFlows, trace, transactionHistoryLimit = 40, hooks, } = options;
         super({
             name: controllerName,
             metadata,
@@ -330,6 +309,35 @@ export class TransactionController extends 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 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 }),
+            getInternalAccounts: __classPrivateFieldGet(this, _TransactionController_instances, "m", _TransactionController_getInternalAccounts).bind(this),
+            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 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
@@ -340,6 +348,7 @@ export class TransactionController extends 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.
@@ -354,7 +363,7 @@ export class TransactionController extends BaseController {
      */
     async addTransaction(txParams, options) {
         log('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 = normalizeTransactionParams(txParams);
         if (!__classPrivateFieldGet(this, _TransactionController_multichainTrackingHelper, "f").has(networkClientId)) {
             throw new Error(`Network client not found - ${networkClientId}`);
@@ -363,12 +372,15 @@ export class TransactionController extends BaseController {
             ? 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 validateTransactionOrigin({
             from: txParams.from,
+            internalAccounts,
             origin,
             permittedAddresses,
             selectedAddress,
             txParams,
+            type,
         });
         const isEIP1559Compatible = await this.getEIP1559Compatibility(networkClientId);
         validateTxParams(txParams, isEIP1559Compatible);
@@ -390,6 +402,7 @@ export class TransactionController extends BaseController {
                 deviceConfirmedOn,
                 id: random(),
                 isFirstTimeInteraction: undefined,
+                nestedTransactions,
                 networkClientId,
                 origin,
                 securityAlertResponse,
@@ -480,7 +493,7 @@ export class TransactionController extends BaseController {
      * @param options.estimatedBaseFee - The estimated base fee of the transaction.
      */
     async stopTransaction(transactionId, gasValues, { estimatedBaseFee, actionId, } = {}) {
-        return await __classPrivateFieldGet(this, _TransactionController_instances, "m", _TransactionController_retryTransaction).call(this, {
+        await __classPrivateFieldGet(this, _TransactionController_instances, "m", _TransactionController_retryTransaction).call(this, {
             actionId,
             estimatedBaseFee,
             gasValues,
@@ -509,7 +522,7 @@ export class TransactionController extends BaseController {
      * @param options.estimatedBaseFee - The estimated base fee of the transaction.
      */
     async speedUpTransaction(transactionId, gasValues, { actionId, estimatedBaseFee, } = {}) {
-        return await __classPrivateFieldGet(this, _TransactionController_instances, "m", _TransactionController_retryTransaction).call(this, {
+        await __classPrivateFieldGet(this, _TransactionController_instances, "m", _TransactionController_retryTransaction).call(this, {
             actionId,
             estimatedBaseFee,
             gasValues,
@@ -542,6 +555,7 @@ export class TransactionController extends BaseController {
      * @param transaction - The transaction params to estimate gas for.
      * @param multiplier - The multiplier to use for the gas buffer.
      * @param networkClientId - The network client id to use for the estimate.
+     * @returns The buffered estimated gas and whether the estimation failed.
      */
     async estimateGasBuffered(transaction, multiplier, networkClientId) {
         const ethQuery = __classPrivateFieldGet(this, _TransactionController_instances, "m", _TransactionController_getEthQuery).call(this, {
@@ -1028,6 +1042,7 @@ export class TransactionController extends BaseController {
      * @param request.transactionParams - The transaction parameters to estimate the layer 1 gas fee for.
      * @param request.chainId - The ID of the chain where the transaction will be executed.
      * @param request.networkClientId - The ID of a specific network client to process the transaction.
+     * @returns The layer 1 gas fee.
      */
     async getLayer1GasFee({ transactionParams, chainId, networkClientId, }) {
         const provider = __classPrivateFieldGet(this, _TransactionController_instances, "m", _TransactionController_getProvider).call(this, {
@@ -1090,6 +1105,54 @@ export class TransactionController extends BaseController {
         abortCallback();
         this.signAbortCallbacks.delete(transactionId);
     }
+    /**
+     * Update the transaction data of a single nested transaction within an atomic batch transaction.
+     *
+     * @param options - The options bag.
+     * @param options.transactionId - ID of the atomic batch transaction.
+     * @param options.transactionIndex - Index of the nested transaction within the atomic batch transaction.
+     * @param options.transactionData - New data to set for the nested transaction.
+     * @returns The updated data for the atomic batch transaction.
+     */
+    async updateAtomicBatchData({ transactionId, transactionIndex, transactionData, }) {
+        log('Updating atomic batch data', {
+            transactionId,
+            transactionIndex,
+            transactionData,
+        });
+        const updatedTransactionMeta = __classPrivateFieldGet(this, _TransactionController_instances, "m", _TransactionController_updateTransactionInternal).call(this, {
+            transactionId,
+            note: 'TransactionController#updateAtomicBatchData - Atomic batch data updated',
+        }, (transactionMeta) => {
+            const { nestedTransactions, txParams } = transactionMeta;
+            const from = txParams.from;
+            const nestedTransaction = nestedTransactions?.[transactionIndex];
+            if (!nestedTransaction) {
+                throw new Error(`Nested transaction not found with index - ${transactionIndex}`);
+            }
+            nestedTransaction.data = transactionData;
+            const batchTransaction = generateEIP7702BatchTransaction(from, nestedTransactions);
+            transactionMeta.txParams.data = batchTransaction.data;
+        });
+        const draftTransaction = cloneDeep({
+            ...updatedTransactionMeta,
+            txParams: {
+                ...updatedTransactionMeta.txParams,
+                // Clear existing gas to force estimation
+                gas: undefined,
+            },
+        });
+        await __classPrivateFieldGet(this, _TransactionController_instances, "m", _TransactionController_updateGasEstimate).call(this, draftTransaction);
+        __classPrivateFieldGet(this, _TransactionController_instances, "m", _TransactionController_updateTransactionInternal).call(this, {
+            transactionId,
+            note: 'TransactionController#updateAtomicBatchData - Gas estimate updated',
+        }, (transactionMeta) => {
+            transactionMeta.txParams.gas = draftTransaction.txParams.gas;
+            transactionMeta.simulationFails = draftTransaction.simulationFails;
+            transactionMeta.gasLimitNoBuffer = draftTransaction.gasLimitNoBuffer;
+        });
+        return updatedTransactionMeta.txParams.data;
+    }
     addMetadata(transactionMeta) {
         validateTxParams(transactionMeta.txParams);
         this.update((state) => {
@@ -1102,18 +1165,11 @@ export class TransactionController extends BaseController {
     async updateGasProperties(transactionMeta, { traceContext } = {}) {
         const isEIP1559Compatible = transactionMeta.txParams.type !== TransactionEnvelopeType.legacy &&
             (await this.getEIP1559Compatibility(transactionMeta.networkClientId));
-        const { networkClientId, chainId } = transactionMeta;
-        const isCustomNetwork = __classPrivateFieldGet(this, _TransactionController_multichainTrackingHelper, "f").getNetworkClient({ networkClientId })
-            .configuration.type === NetworkClientType.Custom;
+        const { networkClientId } = transactionMeta;
         const ethQuery = __classPrivateFieldGet(this, _TransactionController_instances, "m", _TransactionController_getEthQuery).call(this, { networkClientId });
         const provider = __classPrivateFieldGet(this, _TransactionController_instances, "m", _TransactionController_getProvider).call(this, { networkClientId });
         await __classPrivateFieldGet(this, _TransactionController_trace, "f").call(this, { name: 'Update Gas', parentContext: traceContext }, async () => {
-            await updateGas({
-                ethQuery,
-                chainId,
-                isCustomNetwork,
-                txMeta: transactionMeta,
-            });
+            await __classPrivateFieldGet(this, _TransactionController_instances, "m", _TransactionController_updateGasEstimate).call(this, transactionMeta);
         });
         await __classPrivateFieldGet(this, _TransactionController_trace, "f").call(this, { name: 'Update Gas Fees', parentContext: traceContext }, async () => await updateGasFees({
             eip1559: isEIP1559Compatible,
@@ -1185,7 +1241,10 @@ export class TransactionController extends BaseController {
                 if (!isTxCompleted) {
                     if (error?.code === errorCodes.provider.userRejectedRequest) {
                         this.cancelTransaction(transactionId, actionId);
-                        throw providerErrors.userRejectedRequest('MetaMask Tx Signature: User denied transaction signature.');
+                        throw providerErrors.userRejectedRequest({
+                            message: 'MetaMask Tx Signature: User denied transaction signature.',
+                            data: error?.data,
+                        });
                     }
                     else {
                         this.failTransaction(meta, error, actionId);
@@ -1215,6 +1274,7 @@ export class TransactionController extends BaseController {
      *
      * @param transactionId - The ID of the transaction to approve.
      * @param traceContext - The parent context for any new traces.
+     * @returns The state of the approval.
      */
     async approveTransaction(transactionId, traceContext) {
         const cleanupTasks = new Array();
@@ -1253,7 +1313,7 @@ export class TransactionController extends BaseController {
                 }
             });
             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)) {
                 log('Skipping publishing transaction based on hook');
                 this.messagingSystem.publish(`${controllerName}:transactionPublishingSkipped`, transactionMeta);
@@ -1620,7 +1680,8 @@ export class TransactionController extends BaseController {
         const currentAccountIsEIP1559Compatible = await this.getCurrentAccountEIP1559Compatibility();
         return (currentNetworkIsEIP1559Compatible && currentAccountIsEIP1559Compatible);
     }
-    async signTransaction(transactionMeta, txParams) {
+    async signTransaction(transactionMeta) {
+        const { txParams } = transactionMeta;
         log('Signing transaction', txParams);
         const { authorizationList, from } = txParams;
         const finalTxParams = { ...txParams };
@@ -1649,6 +1710,7 @@ export class TransactionController extends BaseController {
         const transactionMetaWithRsv = {
             ...this.updateTransactionMetaRSV(transactionMetaFromHook, signedTx),
             status: TransactionStatus.signed,
+            txParams: finalTxParams,
         };
         this.updateTransaction(transactionMetaWithRsv, 'TransactionController#approveTransaction - Transaction signed');
         this.onTransactionStatusChange(transactionMetaWithRsv);
@@ -1868,6 +1930,9 @@ _TransactionController_internalEvents = new WeakMap(), _TransactionController_me
     let resimulateResponse;
     this.update((state) => {
         const index = state.transactions.findIndex(({ id }) => id === transactionId);
+        if (index === -1) {
+            throw new Error(`Cannot update transaction as ID not found - ${transactionId}`);
+        }
         let transactionMeta = state.transactions[index];
         const originalTransactionMeta = cloneDeep(transactionMeta);
         transactionMeta = callback(transactionMeta) ?? transactionMeta;
@@ -1993,6 +2058,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();
@@ -2018,5 +2088,16 @@ _TransactionController_internalEvents = new WeakMap(), _TransactionController_me
         }
         submitHistory.unshift(submitHistoryEntry);
     });
+}, _TransactionController_updateGasEstimate = async function _TransactionController_updateGasEstimate(transactionMeta) {
+    const { chainId, networkClientId } = transactionMeta;
+    const isCustomNetwork = __classPrivateFieldGet(this, _TransactionController_multichainTrackingHelper, "f").getNetworkClient({ networkClientId })
+        .configuration.type === NetworkClientType.Custom;
+    const ethQuery = __classPrivateFieldGet(this, _TransactionController_instances, "m", _TransactionController_getEthQuery).call(this, { networkClientId });
+    await updateGas({
+        chainId,
+        ethQuery,
+        isCustomNetwork,
+        txMeta: transactionMeta,
+    });
 };
 //# sourceMappingURL=TransactionController.mjs.map