@metamask/transaction-controller 29.0.0 → 29.0.2

package/dist/{chunk-N55SEKK7.js → chunk-IXUOEWWL.js}

@@ -4,7 +4,7 @@
 var _chunkZNZEJDOEjs = require('./chunk-ZNZEJDOE.js');
 
 
-var _chunkX3KACH5Pjs = require('./chunk-X3KACH5P.js');
+var _chunkIT3SYNZ6js = require('./chunk-IT3SYNZ6.js');
 
 
 var _chunkSD6CWFDFjs = require('./chunk-SD6CWFDF.js');
@@ -234,7 +234,7 @@ var TransactionController = class extends _basecontroller.BaseController {
     _chunkZ4BLTVTBjs.__privateAdd.call(void 0, this, _getGlobalChainId);
     _chunkZ4BLTVTBjs.__privateAdd.call(void 0, this, _isCustomNetwork);
     _chunkZ4BLTVTBjs.__privateAdd.call(void 0, this, _internalEvents, new (0, _events.EventEmitter)());
-    this.inProcessOfSigning = /* @__PURE__ */ new Set();
+    this.approvingTransactionIds = /* @__PURE__ */ new Set();
     this.mutex = new (0, _asyncmutex.Mutex)();
     _chunkZ4BLTVTBjs.__privateAdd.call(void 0, this, _incomingTransactionOptions, void 0);
     _chunkZ4BLTVTBjs.__privateAdd.call(void 0, this, _pendingTransactionOptions, void 0);
@@ -725,9 +725,7 @@ var TransactionController = class extends _basecontroller.BaseController {
       _chunkUGFBA4GVjs.validateGasValues.call(void 0, gasValues);
     }
     _chunkS6VGOPUYjs.projectLogger.call(void 0, "Creating speed up transaction", transactionId, gasValues);
-    const transactionMeta = this.state.transactions.find(
-      ({ id }) => id === transactionId
-    );
+    const transactionMeta = this.getTransaction(transactionId);
     if (!transactionMeta) {
       return;
     }
@@ -776,7 +774,7 @@ var TransactionController = class extends _basecontroller.BaseController {
       unsignedEthTx,
       transactionMeta.txParams.from
     );
-    const transactionMetaWithRsv = await this.updateTransactionMetaRSV(
+    const transactionMetaWithRsv = this.updateTransactionMetaRSV(
       transactionMeta,
       signedTx
     );
@@ -1215,10 +1213,10 @@ var TransactionController = class extends _basecontroller.BaseController {
       common
     });
     const initialTxAsSerializedHex = _util.bufferToHex.call(void 0, initialTxAsEthTx.serialize());
-    if (this.inProcessOfSigning.has(initialTxAsSerializedHex)) {
+    if (this.approvingTransactionIds.has(initialTxAsSerializedHex)) {
       return "";
     }
-    this.inProcessOfSigning.add(initialTxAsSerializedHex);
+    this.approvingTransactionIds.add(initialTxAsSerializedHex);
     let rawTransactions, nonceLock;
     try {
       const fromAddress = initialTx.from;
@@ -1239,7 +1237,7 @@ var TransactionController = class extends _basecontroller.BaseController {
       throw err;
     } finally {
       nonceLock?.releaseLock();
-      this.inProcessOfSigning.delete(initialTxAsSerializedHex);
+      this.approvingTransactionIds.delete(initialTxAsSerializedHex);
     }
     return rawTransactions;
   }
@@ -1280,10 +1278,10 @@ var TransactionController = class extends _basecontroller.BaseController {
       transactionMeta,
       _lodash.pickBy.call(void 0, { hash, status })
     );
-    if (status === "submitted" /* submitted */) {
+    if (updatedTransactionMeta.status === "submitted" /* submitted */) {
       updatedTransactionMeta.submittedTime = (/* @__PURE__ */ new Date()).getTime();
     }
-    if (status === "failed" /* failed */) {
+    if (updatedTransactionMeta.status === "failed" /* failed */) {
       updatedTransactionMeta.error = _chunkUGFBA4GVjs.normalizeTxError.call(void 0, new Error(errorMessage));
     }
     this.updateTransaction(
@@ -1639,68 +1637,62 @@ var TransactionController = class extends _basecontroller.BaseController {
    * @param transactionId - The ID of the transaction to approve.
    */
   async approveTransaction(transactionId) {
-    const { transactions } = this.state;
-    const releaseLock = await this.mutex.acquire();
-    const index = transactions.findIndex(({ id }) => transactionId === id);
-    const transactionMeta = transactions[index];
-    const updatedTransactionMeta = _lodash.cloneDeep.call(void 0, transactionMeta);
-    const {
-      txParams: { from },
-      networkClientId
-    } = transactionMeta;
-    let releaseNonceLock;
+    const cleanupTasks = new Array();
+    cleanupTasks.push(await this.mutex.acquire());
+    let transactionMeta = this.getTransactionOrThrow(transactionId);
     try {
       if (!this.sign) {
-        releaseLock();
         this.failTransaction(
           transactionMeta,
           new Error("No sign method defined.")
         );
         return "not-approved" /* NotApproved */;
       } else if (!transactionMeta.chainId) {
-        releaseLock();
         this.failTransaction(transactionMeta, new Error("No chainId defined."));
         return "not-approved" /* NotApproved */;
       }
-      if (this.inProcessOfSigning.has(transactionId)) {
+      if (this.approvingTransactionIds.has(transactionId)) {
         _chunkS6VGOPUYjs.projectLogger.call(void 0, "Skipping approval as signing in progress", transactionId);
         return "not-approved" /* NotApproved */;
       }
+      this.approvingTransactionIds.add(transactionId);
+      cleanupTasks.push(
+        () => this.approvingTransactionIds.delete(transactionId)
+      );
       const [nonce, releaseNonce] = await _chunkZNZEJDOEjs.getNextNonce.call(void 0, 
         transactionMeta,
-        (address) => _chunkZ4BLTVTBjs.__privateGet.call(void 0, this, _multichainTrackingHelper).getNonceLock(address, networkClientId)
+        (address) => _chunkZ4BLTVTBjs.__privateGet.call(void 0, this, _multichainTrackingHelper).getNonceLock(
+          address,
+          transactionMeta.networkClientId
+        )
       );
-      releaseNonceLock = releaseNonce;
-      updatedTransactionMeta.status = "approved" /* approved */;
-      updatedTransactionMeta.txParams = {
-        ...updatedTransactionMeta.txParams,
-        nonce,
-        chainId: transactionMeta.chainId
-      };
-      const baseTxParams = {
-        ...updatedTransactionMeta.txParams,
-        gasLimit: updatedTransactionMeta.txParams.gas
-      };
-      this.updateTransaction(
-        updatedTransactionMeta,
-        "TransactionController#approveTransaction - Transaction approved"
-      );
-      this.onTransactionStatusChange(updatedTransactionMeta);
-      const isEIP1559 = _chunkUGFBA4GVjs.isEIP1559Transaction.call(void 0, updatedTransactionMeta.txParams);
-      const txParams = isEIP1559 ? {
-        ...baseTxParams,
-        estimatedBaseFee: updatedTransactionMeta.txParams.estimatedBaseFee,
-        type: "0x2" /* feeMarket */
-      } : baseTxParams;
+      releaseNonce && cleanupTasks.push(releaseNonce);
+      transactionMeta = _chunkZ4BLTVTBjs.__privateMethod.call(void 0, this, _updateTransactionInternal, updateTransactionInternal_fn).call(this, {
+        transactionId,
+        note: "TransactionController#approveTransaction - Transaction approved"
+      }, (draftTxMeta) => {
+        const { txParams, chainId } = draftTxMeta;
+        draftTxMeta.status = "approved" /* approved */;
+        draftTxMeta.txParams = {
+          ...txParams,
+          nonce,
+          chainId,
+          gasLimit: txParams.gas,
+          ..._chunkUGFBA4GVjs.isEIP1559Transaction.call(void 0, txParams) && {
+            type: "0x2" /* feeMarket */
+          }
+        };
+      });
+      this.onTransactionStatusChange(transactionMeta);
       const rawTx = await this.signTransaction(
-        updatedTransactionMeta,
-        txParams
+        transactionMeta,
+        transactionMeta.txParams
       );
-      if (!this.beforePublish(updatedTransactionMeta)) {
+      if (!this.beforePublish(transactionMeta)) {
         _chunkS6VGOPUYjs.projectLogger.call(void 0, "Skipping publishing transaction based on hook");
         this.messagingSystem.publish(
           `${controllerName}:transactionPublishingSkipped`,
-          updatedTransactionMeta
+          transactionMeta
         );
         return "skipped-via-before-publish-hook" /* SkippedViaBeforePublishHook */;
       }
@@ -1711,51 +1703,50 @@ var TransactionController = class extends _basecontroller.BaseController {
         networkClientId: transactionMeta.networkClientId,
         chainId: transactionMeta.chainId
       });
-      if (transactionMeta.type === "swap" /* swap */) {
+      let preTxBalance;
+      const shouldUpdatePreTxBalance = transactionMeta.type === "swap" /* swap */;
+      if (shouldUpdatePreTxBalance) {
         _chunkS6VGOPUYjs.projectLogger.call(void 0, "Determining pre-transaction balance");
-        const preTxBalance = await _controllerutils.query.call(void 0, ethQuery, "getBalance", [from]);
-        updatedTransactionMeta.preTxBalance = preTxBalance;
-        _chunkS6VGOPUYjs.projectLogger.call(void 0, 
-          "Updated pre-transaction balance",
-          updatedTransactionMeta.preTxBalance
-        );
+        preTxBalance = await _controllerutils.query.call(void 0, ethQuery, "getBalance", [
+          transactionMeta.txParams.from
+        ]);
       }
-      _chunkS6VGOPUYjs.projectLogger.call(void 0, "Publishing transaction", txParams);
+      _chunkS6VGOPUYjs.projectLogger.call(void 0, "Publishing transaction", transactionMeta.txParams);
       let { transactionHash: hash } = await this.publish(
-        updatedTransactionMeta,
+        transactionMeta,
         rawTx
       );
       if (hash === void 0) {
         hash = await this.publishTransaction(ethQuery, rawTx);
       }
       _chunkS6VGOPUYjs.projectLogger.call(void 0, "Publish successful", hash);
-      updatedTransactionMeta.hash = hash;
-      updatedTransactionMeta.status = "submitted" /* submitted */;
-      updatedTransactionMeta.submittedTime = (/* @__PURE__ */ new Date()).getTime();
-      this.updateTransaction(
-        updatedTransactionMeta,
-        "TransactionController#approveTransaction - Transaction submitted"
-      );
+      transactionMeta = _chunkZ4BLTVTBjs.__privateMethod.call(void 0, this, _updateTransactionInternal, updateTransactionInternal_fn).call(this, {
+        transactionId,
+        note: "TransactionController#approveTransaction - Transaction submitted"
+      }, (draftTxMeta) => {
+        draftTxMeta.hash = hash;
+        draftTxMeta.status = "submitted" /* submitted */;
+        draftTxMeta.submittedTime = (/* @__PURE__ */ new Date()).getTime();
+        if (shouldUpdatePreTxBalance) {
+          draftTxMeta.preTxBalance = preTxBalance;
+          _chunkS6VGOPUYjs.projectLogger.call(void 0, "Updated pre-transaction balance", preTxBalance);
+        }
+      });
       this.messagingSystem.publish(`${controllerName}:transactionSubmitted`, {
-        transactionMeta: updatedTransactionMeta
+        transactionMeta
       });
       this.messagingSystem.publish(
         `${controllerName}:transactionFinished`,
-        updatedTransactionMeta
-      );
-      _chunkZ4BLTVTBjs.__privateGet.call(void 0, this, _internalEvents).emit(
-        `${updatedTransactionMeta.id}:finished`,
-        updatedTransactionMeta
+        transactionMeta
       );
-      this.onTransactionStatusChange(updatedTransactionMeta);
+      _chunkZ4BLTVTBjs.__privateGet.call(void 0, this, _internalEvents).emit(`${transactionId}:finished`, transactionMeta);
+      this.onTransactionStatusChange(transactionMeta);
       return "approved" /* Approved */;
     } catch (error) {
       this.failTransaction(transactionMeta, error);
       return "not-approved" /* NotApproved */;
     } finally {
-      this.inProcessOfSigning.delete(transactionId);
-      releaseNonceLock?.();
-      releaseLock();
+      cleanupTasks.forEach((task) => task());
     }
   }
   async publishTransaction(ethQuery, rawTransaction) {
@@ -1877,6 +1868,15 @@ var TransactionController = class extends _basecontroller.BaseController {
     const { transactions } = this.state;
     return transactions.find(({ id }) => id === transactionId);
   }
+  getTransactionOrThrow(transactionId, errorMessagePrefix = "TransactionController") {
+    const txMeta = this.getTransaction(transactionId);
+    if (!txMeta) {
+      throw new Error(
+        `${errorMessagePrefix}: No transaction found with id ${transactionId}`
+      );
+    }
+    return txMeta;
+  }
   getApprovalId(txMeta) {
     return String(txMeta.id);
   }
@@ -2085,8 +2085,9 @@ var TransactionController = class extends _basecontroller.BaseController {
    *
    * @param transactionMeta - The TransactionMeta object to update.
    * @param signedTx - The encompassing type for all transaction types containing r, s, and v values.
+   * @returns The updated TransactionMeta object.
    */
-  async updateTransactionMetaRSV(transactionMeta, signedTx) {
+  updateTransactionMetaRSV(transactionMeta, signedTx) {
     const transactionMetaWithRsv = _lodash.cloneDeep.call(void 0, transactionMeta);
     for (const key of ["r", "s", "v"]) {
       const value = signedTx[key];
@@ -2108,7 +2109,7 @@ var TransactionController = class extends _basecontroller.BaseController {
       transactionMeta.chainId,
       txParams
     );
-    this.inProcessOfSigning.add(transactionMeta.id);
+    this.approvingTransactionIds.add(transactionMeta.id);
     const signedTx = await new Promise((resolve, reject) => {
       this.sign?.(
         unsignedEthTx,
@@ -2134,7 +2135,7 @@ var TransactionController = class extends _basecontroller.BaseController {
       return void 0;
     }
     const transactionMetaWithRsv = {
-      ...await this.updateTransactionMetaRSV(transactionMeta, signedTx),
+      ...this.updateTransactionMetaRSV(transactionMeta, signedTx),
       status: "signed" /* signed */
     };
     this.updateTransaction(
@@ -2413,6 +2414,7 @@ updateTransactionInternal_fn = function({
   if (updatedTransactionParams.length > 0) {
     _chunkZ4BLTVTBjs.__privateMethod.call(void 0, this, _onTransactionParamsUpdated, onTransactionParamsUpdated_fn).call(this, transactionMeta, updatedTransactionParams);
   }
+  return transactionMeta;
 };
 _checkIfTransactionParamsUpdated = new WeakSet();
 checkIfTransactionParamsUpdated_fn = function(newTransactionMeta) {
@@ -2458,7 +2460,7 @@ updateSimulationData_fn = async function(transactionMeta) {
     _chunkZ4BLTVTBjs.__privateMethod.call(void 0, this, _updateTransactionInternal, updateTransactionInternal_fn).call(this, { transactionId, skipHistory: true }, (txMeta) => {
       txMeta.simulationData = void 0;
     });
-    simulationData = await _chunkX3KACH5Pjs.getSimulationData.call(void 0, {
+    simulationData = await _chunkIT3SYNZ6js.getSimulationData.call(void 0, {
       chainId,
       from,
       to,
@@ -2547,4 +2549,4 @@ isCustomNetwork_fn = function(networkClientId) {
 
 
 exports.HARDFORK = HARDFORK; exports.CANCEL_RATE = CANCEL_RATE; exports.SPEED_UP_RATE = SPEED_UP_RATE; exports.ApprovalState = ApprovalState; exports.TransactionController = TransactionController;
-//# sourceMappingURL=chunk-N55SEKK7.js.map
+//# sourceMappingURL=chunk-IXUOEWWL.js.map