@metamask-previews/transaction-controller 46.0.0-preview-b8f29301 → 46.0.0-preview-0ae65d9e

package/CHANGELOG.md

@@ -9,6 +9,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ### Added
 
+- Add `updateAtomicBatchData` method ([#5380](https://github.com/MetaMask/core/pull/5380))
 - Support atomic batch transactions ([#5306](https://github.com/MetaMask/core/pull/5306))
   - Add methods:
     - `addTransactionBatch`

package/dist/TransactionController.cjs

@@ -154,31 +154,9 @@ class TransactionController extends base_controller_1.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,
@@ -513,7 +491,7 @@ class TransactionController extends base_controller_1.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,
@@ -542,7 +520,7 @@ class TransactionController extends base_controller_1.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,
@@ -575,6 +553,7 @@ class TransactionController extends base_controller_1.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, {
@@ -1061,6 +1040,7 @@ class TransactionController extends base_controller_1.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, {
@@ -1123,6 +1103,37 @@ class TransactionController extends base_controller_1.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.
+     */
+    updateAtomicBatchData({ transactionId, transactionIndex, transactionData, }) {
+        (0, logger_1.projectLogger)('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 = (0, eip7702_1.generateEIP7702BatchTransaction)(from, nestedTransactions);
+            transactionMeta.txParams.data = batchTransaction.data;
+        });
+        return updatedTransactionMeta.txParams.data;
+    }
     addMetadata(transactionMeta) {
         (0, validation_1.validateTxParams)(transactionMeta.txParams);
         this.update((state) => {
@@ -1251,6 +1262,7 @@ class TransactionController extends base_controller_1.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();
@@ -1907,6 +1919,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 = (0, lodash_1.cloneDeep)(transactionMeta);
         transactionMeta = callback(transactionMeta) ?? transactionMeta;