@metamask-previews/transaction-controller 28.1.1-preview-a1db0714 → 29.0.0-preview-a6633f22

package/CHANGELOG.md

@@ -7,6 +7,32 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [29.0.0]
+
+### Added
+
+- Add `estimateGasFee` method ([#4216](https://github.com/MetaMask/core/pull/4216))
+  - Add `TestGasFeeFlow` that is activated by optional `testGasFeeFlows` constructor option.
+  - Add related types:
+    - `FeeMarketGasFeeEstimateForLevel`
+    - `FeeMarketGasFeeEstimates`
+    - `GasFeeEstimates`
+    - `GasFeeEstimateLevel`
+    - `GasFeeEstimateType`
+    - `GasPriceGasFeeEstimates`
+    - `LegacyGasFeeEstimates`
+
+### Changed
+
+- **BREAKING:** Update `GasFeeEstimates` type to support alternate estimate types ([#4216](https://github.com/MetaMask/core/pull/4216))
+- Bump `@metamask/base-controller` to `^5.0.2` ([#4232](https://github.com/MetaMask/core/pull/4232))
+- Bump `@metamask/approval-controller` to `^6.0.2` ([#4234](https://github.com/MetaMask/core/pull/4234))
+- Bump `@metamask/gas-fee-controller` to `^15.1.1` ([#4234](https://github.com/MetaMask/core/pull/4234))
+
+### Removed
+
+- **BREAKING:** Remove `gasFeeControllerEstimateType` property from `mergeGasFeeEstimates` function ([#4216](https://github.com/MetaMask/core/pull/4216))
+
 ## [28.1.1]
 
 ### Changed
@@ -790,7 +816,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@28.1.1...HEAD
+[Unreleased]: https://github.com/MetaMask/core/compare/@metamask/transaction-controller@29.0.0...HEAD
+[29.0.0]: https://github.com/MetaMask/core/compare/@metamask/transaction-controller@28.1.1...@metamask/transaction-controller@29.0.0
 [28.1.1]: https://github.com/MetaMask/core/compare/@metamask/transaction-controller@28.1.0...@metamask/transaction-controller@28.1.1
 [28.1.0]: https://github.com/MetaMask/core/compare/@metamask/transaction-controller@28.0.0...@metamask/transaction-controller@28.1.0
 [28.0.0]: https://github.com/MetaMask/core/compare/@metamask/transaction-controller@27.0.1...@metamask/transaction-controller@28.0.0

package/dist/TransactionController.js

@@ -4,7 +4,7 @@
 
 
 
-var _chunkASVFMULGjs = require('./chunk-ASVFMULG.js');
+var _chunkKT3F6CZPjs = require('./chunk-KT3F6CZP.js');
 require('./chunk-ZNZEJDOE.js');
 require('./chunk-X3KACH5P.js');
 require('./chunk-KT6UAKBB.js');
@@ -20,7 +20,7 @@ require('./chunk-YVCX6Z75.js');
 require('./chunk-TJMQEH57.js');
 require('./chunk-7DJO6UZA.js');
 require('./chunk-2XKEAKQG.js');
-require('./chunk-XC5NBJOF.js');
+require('./chunk-DTDTOMTB.js');
 require('./chunk-5XQ2KRYL.js');
 require('./chunk-EQT25RSP.js');
 require('./chunk-FDUCRHYT.js');
@@ -41,5 +41,5 @@ require('./chunk-Z4BLTVTB.js');
 
 
 
-exports.ApprovalState = _chunkASVFMULGjs.ApprovalState; exports.CANCEL_RATE = _chunkASVFMULGjs.CANCEL_RATE; exports.HARDFORK = _chunkASVFMULGjs.HARDFORK; exports.SPEED_UP_RATE = _chunkASVFMULGjs.SPEED_UP_RATE; exports.TransactionController = _chunkASVFMULGjs.TransactionController;
+exports.ApprovalState = _chunkKT3F6CZPjs.ApprovalState; exports.CANCEL_RATE = _chunkKT3F6CZPjs.CANCEL_RATE; exports.HARDFORK = _chunkKT3F6CZPjs.HARDFORK; exports.SPEED_UP_RATE = _chunkKT3F6CZPjs.SPEED_UP_RATE; exports.TransactionController = _chunkKT3F6CZPjs.TransactionController;
 //# sourceMappingURL=TransactionController.js.map

package/dist/TransactionController.mjs

@@ -4,7 +4,7 @@ import {
   HARDFORK,
   SPEED_UP_RATE,
   TransactionController
-} from "./chunk-BSTN6LDB.mjs";
+} from "./chunk-26BABWPE.mjs";
 import "./chunk-NHRBO3LU.mjs";
 import "./chunk-MDRMMUMS.mjs";
 import "./chunk-K4KOSAGM.mjs";
@@ -20,7 +20,7 @@ import "./chunk-FG74Z3F5.mjs";
 import "./chunk-FMRLPVFZ.mjs";
 import "./chunk-SL3GHHKG.mjs";
 import "./chunk-NOHEXQ7Y.mjs";
-import "./chunk-QWHMXCGZ.mjs";
+import "./chunk-Y7ENNK7L.mjs";
 import "./chunk-F6E3TTR3.mjs";
 import "./chunk-CPMTUMMZ.mjs";
 import "./chunk-QZLPYOGC.mjs";

package/dist/{chunk-BSTN6LDB.mjs → chunk-26BABWPE.mjs}

@@ -45,7 +45,7 @@ import {
 } from "./chunk-NOHEXQ7Y.mjs";
 import {
   IncomingTransactionHelper
-} from "./chunk-QWHMXCGZ.mjs";
+} from "./chunk-Y7ENNK7L.mjs";
 import {
   MultichainTrackingHelper
 } from "./chunk-F6E3TTR3.mjs";
@@ -161,7 +161,7 @@ var TransactionController = class extends BaseController {
    * @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.getSelectedAccount - Gets the address of the currently selected account.
+   * @param options.getSelectedAddress - Gets the address of the currently selected account.
    * @param options.incomingTransactions - Configuration options for incoming transaction support.
    * @param options.isMultichainEnabled - Enable multichain support.
    * @param options.isSimulationEnabled - Whether new transactions will be automatically simulated.
@@ -189,7 +189,7 @@ var TransactionController = class extends BaseController {
     getNetworkState,
     getPermittedAccounts,
     getSavedGasFees,
-    getSelectedAccount,
+    getSelectedAddress,
     incomingTransactions = {},
     isMultichainEnabled = false,
     isSimulationEnabled,
@@ -234,7 +234,7 @@ var TransactionController = class extends BaseController {
     __privateAdd(this, _getGlobalChainId);
     __privateAdd(this, _isCustomNetwork);
     __privateAdd(this, _internalEvents, new EventEmitter());
-    this.inProcessOfSigning = /* @__PURE__ */ new Set();
+    this.approvingTransactionIds = /* @__PURE__ */ new Set();
     this.mutex = new Mutex();
     __privateAdd(this, _incomingTransactionOptions, void 0);
     __privateAdd(this, _pendingTransactionOptions, void 0);
@@ -259,7 +259,7 @@ var TransactionController = class extends BaseController {
     this.getCurrentNetworkEIP1559Compatibility = getCurrentNetworkEIP1559Compatibility;
     this.getGasFeeEstimates = getGasFeeEstimates || (() => Promise.resolve({}));
     this.getPermittedAccounts = getPermittedAccounts;
-    this.getSelectedAccount = getSelectedAccount;
+    this.getSelectedAddress = getSelectedAddress;
     this.getExternalPendingTransactions = getExternalPendingTransactions ?? (() => []);
     this.securityProviderRequest = securityProviderRequest;
     __privateSet(this, _incomingTransactionOptions, incomingTransactions);
@@ -456,10 +456,6 @@ var TransactionController = class extends BaseController {
     networkClientId: requestNetworkClientId
   } = {}) {
     projectLogger("Adding transaction", txParams);
-    const selectedAccount = this.getSelectedAccount();
-    if (selectedAccount.type !== "eip155:eoa" && selectedAccount.type !== "eip155:erc4337") {
-      throw new Error("Selected account is not an EVM account");
-    }
     txParams = normalizeTransactionParams(txParams);
     if (requestNetworkClientId && !__privateGet(this, _multichainTrackingHelper).has(requestNetworkClientId)) {
       throw new Error(
@@ -474,7 +470,7 @@ var TransactionController = class extends BaseController {
     if (origin) {
       await validateTransactionOrigin(
         await this.getPermittedAccounts(origin),
-        selectedAccount.address,
+        this.getSelectedAddress(),
         txParams.from,
         origin
       );
@@ -729,9 +725,7 @@ var TransactionController = class extends BaseController {
       validateGasValues(gasValues);
     }
     projectLogger("Creating speed up transaction", transactionId, gasValues);
-    const transactionMeta = this.state.transactions.find(
-      ({ id }) => id === transactionId
-    );
+    const transactionMeta = this.getTransaction(transactionId);
     if (!transactionMeta) {
       return;
     }
@@ -780,7 +774,7 @@ var TransactionController = class extends BaseController {
       unsignedEthTx,
       transactionMeta.txParams.from
     );
-    const transactionMetaWithRsv = await this.updateTransactionMetaRSV(
+    const transactionMetaWithRsv = this.updateTransactionMetaRSV(
       transactionMeta,
       signedTx
     );
@@ -1219,10 +1213,10 @@ var TransactionController = class extends BaseController {
       common
     });
     const initialTxAsSerializedHex = bufferToHex(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;
@@ -1243,7 +1237,7 @@ var TransactionController = class extends BaseController {
       throw err;
     } finally {
       nonceLock?.releaseLock();
-      this.inProcessOfSigning.delete(initialTxAsSerializedHex);
+      this.approvingTransactionIds.delete(initialTxAsSerializedHex);
     }
     return rawTransactions;
   }
@@ -1284,10 +1278,10 @@ var TransactionController = class extends BaseController {
       transactionMeta,
       pickBy({ 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 = normalizeTxError(new Error(errorMessage));
     }
     this.updateTransaction(
@@ -1643,68 +1637,62 @@ var TransactionController = class extends 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 = cloneDeep(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)) {
         projectLogger("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 getNextNonce(
         transactionMeta,
-        (address) => __privateGet(this, _multichainTrackingHelper).getNonceLock(address, 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"
+        (address) => __privateGet(this, _multichainTrackingHelper).getNonceLock(
+          address,
+          transactionMeta.networkClientId
+        )
       );
-      this.onTransactionStatusChange(updatedTransactionMeta);
-      const isEIP1559 = isEIP1559Transaction(updatedTransactionMeta.txParams);
-      const txParams = isEIP1559 ? {
-        ...baseTxParams,
-        estimatedBaseFee: updatedTransactionMeta.txParams.estimatedBaseFee,
-        type: "0x2" /* feeMarket */
-      } : baseTxParams;
+      releaseNonce && cleanupTasks.push(releaseNonce);
+      transactionMeta = __privateMethod(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,
+          ...isEIP1559Transaction(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)) {
         projectLogger("Skipping publishing transaction based on hook");
         this.messagingSystem.publish(
           `${controllerName}:transactionPublishingSkipped`,
-          updatedTransactionMeta
+          transactionMeta
         );
         return "skipped-via-before-publish-hook" /* SkippedViaBeforePublishHook */;
       }
@@ -1715,51 +1703,50 @@ var TransactionController = class extends BaseController {
         networkClientId: transactionMeta.networkClientId,
         chainId: transactionMeta.chainId
       });
-      if (transactionMeta.type === "swap" /* swap */) {
+      let preTxBalance;
+      const shouldUpdatePreTxBalance = transactionMeta.type === "swap" /* swap */;
+      if (shouldUpdatePreTxBalance) {
         projectLogger("Determining pre-transaction balance");
-        const preTxBalance = await query(ethQuery, "getBalance", [from]);
-        updatedTransactionMeta.preTxBalance = preTxBalance;
-        projectLogger(
-          "Updated pre-transaction balance",
-          updatedTransactionMeta.preTxBalance
-        );
+        preTxBalance = await query(ethQuery, "getBalance", [
+          transactionMeta.txParams.from
+        ]);
       }
-      projectLogger("Publishing transaction", txParams);
+      projectLogger("Publishing transaction", transactionMeta.txParams);
       let { transactionHash: hash } = await this.publish(
-        updatedTransactionMeta,
+        transactionMeta,
         rawTx
       );
       if (hash === void 0) {
         hash = await this.publishTransaction(ethQuery, rawTx);
       }
       projectLogger("Publish successful", hash);
-      updatedTransactionMeta.hash = hash;
-      updatedTransactionMeta.status = "submitted" /* submitted */;
-      updatedTransactionMeta.submittedTime = (/* @__PURE__ */ new Date()).getTime();
-      this.updateTransaction(
-        updatedTransactionMeta,
-        "TransactionController#approveTransaction - Transaction submitted"
-      );
+      transactionMeta = __privateMethod(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;
+          projectLogger("Updated pre-transaction balance", preTxBalance);
+        }
+      });
       this.messagingSystem.publish(`${controllerName}:transactionSubmitted`, {
-        transactionMeta: updatedTransactionMeta
+        transactionMeta
       });
       this.messagingSystem.publish(
         `${controllerName}:transactionFinished`,
-        updatedTransactionMeta
-      );
-      __privateGet(this, _internalEvents).emit(
-        `${updatedTransactionMeta.id}:finished`,
-        updatedTransactionMeta
+        transactionMeta
       );
-      this.onTransactionStatusChange(updatedTransactionMeta);
+      __privateGet(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) {
@@ -1881,6 +1868,15 @@ var TransactionController = class extends 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);
   }
@@ -2089,8 +2085,9 @@ var TransactionController = class extends 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 = cloneDeep(transactionMeta);
     for (const key of ["r", "s", "v"]) {
       const value = signedTx[key];
@@ -2112,7 +2109,7 @@ var TransactionController = class extends BaseController {
       transactionMeta.chainId,
       txParams
     );
-    this.inProcessOfSigning.add(transactionMeta.id);
+    this.approvingTransactionIds.add(transactionMeta.id);
     const signedTx = await new Promise((resolve, reject) => {
       this.sign?.(
         unsignedEthTx,
@@ -2138,7 +2135,7 @@ var TransactionController = class extends BaseController {
       return void 0;
     }
     const transactionMetaWithRsv = {
-      ...await this.updateTransactionMetaRSV(transactionMeta, signedTx),
+      ...this.updateTransactionMetaRSV(transactionMeta, signedTx),
       status: "signed" /* signed */
     };
     this.updateTransaction(
@@ -2267,7 +2264,7 @@ createIncomingTransactionHelper_fn = function({
 }) {
   const incomingTransactionHelper = new IncomingTransactionHelper({
     blockTracker,
-    getCurrentAccount: this.getSelectedAccount,
+    getCurrentAccount: this.getSelectedAddress,
     getLastFetchedBlockNumbers: () => this.state.lastFetchedBlockNumbers,
     getChainId: chainId ? () => chainId : this.getChainId.bind(this),
     isEnabled: __privateGet(this, _incomingTransactionOptions).isEnabled,
@@ -2417,6 +2414,7 @@ updateTransactionInternal_fn = function({
   if (updatedTransactionParams.length > 0) {
     __privateMethod(this, _onTransactionParamsUpdated, onTransactionParamsUpdated_fn).call(this, transactionMeta, updatedTransactionParams);
   }
+  return transactionMeta;
 };
 _checkIfTransactionParamsUpdated = new WeakSet();
 checkIfTransactionParamsUpdated_fn = function(newTransactionMeta) {
@@ -2551,4 +2549,4 @@ export {
   ApprovalState,
   TransactionController
 };
-//# sourceMappingURL=chunk-BSTN6LDB.mjs.map
+//# sourceMappingURL=chunk-26BABWPE.mjs.map