@metamask/transaction-controller 27.0.1 → 28.0.0

package/CHANGELOG.md

@@ -7,6 +7,16 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [28.0.0]
+
+### Changed
+
+- **BREAKING:** Change `getLayer1GasFee` arguments to a request object ([#4149](https://github.com/MetaMask/core/pull/4149))
+
+### Fixed
+
+- Fix automatic update of layer 1 gas fee after interval ([#4149](https://github.com/MetaMask/core/pull/4149))
+
 ## [27.0.1]
 
 ### Fixed
@@ -764,7 +774,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@27.0.1...HEAD
+[Unreleased]: https://github.com/MetaMask/core/compare/@metamask/transaction-controller@28.0.0...HEAD
+[28.0.0]: https://github.com/MetaMask/core/compare/@metamask/transaction-controller@27.0.1...@metamask/transaction-controller@28.0.0
 [27.0.1]: https://github.com/MetaMask/core/compare/@metamask/transaction-controller@27.0.0...@metamask/transaction-controller@27.0.1
 [27.0.0]: https://github.com/MetaMask/core/compare/@metamask/transaction-controller@26.0.0...@metamask/transaction-controller@27.0.0
 [26.0.0]: https://github.com/MetaMask/core/compare/@metamask/transaction-controller@25.3.0...@metamask/transaction-controller@26.0.0

package/dist/TransactionController.js

@@ -4,7 +4,7 @@
 
 
 
-var _chunk5SKCGFUCjs = require('./chunk-5SKCGFUC.js');
+var _chunkX5WPBDI5js = require('./chunk-X5WPBDI5.js');
 require('./chunk-SD6CWFDF.js');
 require('./chunk-VH47Q6TS.js');
 require('./chunk-AO3AE3L7.js');
@@ -13,8 +13,8 @@ require('./chunk-ZNZEJDOE.js');
 require('./chunk-3VF7ZGRV.js');
 require('./chunk-KT6UAKBB.js');
 require('./chunk-ETMW527M.js');
-require('./chunk-HUVOOFOM.js');
-require('./chunk-5WFLNKCL.js');
+require('./chunk-V6UIRCOF.js');
+require('./chunk-2XKEAKQG.js');
 require('./chunk-DTDTOMTB.js');
 require('./chunk-CPYXP2OC.js');
 require('./chunk-3JEUO765.js');
@@ -38,5 +38,5 @@ require('./chunk-Z4BLTVTB.js');
 
 
 
-exports.ApprovalState = _chunk5SKCGFUCjs.ApprovalState; exports.CANCEL_RATE = _chunk5SKCGFUCjs.CANCEL_RATE; exports.HARDFORK = _chunk5SKCGFUCjs.HARDFORK; exports.SPEED_UP_RATE = _chunk5SKCGFUCjs.SPEED_UP_RATE; exports.TransactionController = _chunk5SKCGFUCjs.TransactionController;
+exports.ApprovalState = _chunkX5WPBDI5js.ApprovalState; exports.CANCEL_RATE = _chunkX5WPBDI5js.CANCEL_RATE; exports.HARDFORK = _chunkX5WPBDI5js.HARDFORK; exports.SPEED_UP_RATE = _chunkX5WPBDI5js.SPEED_UP_RATE; exports.TransactionController = _chunkX5WPBDI5js.TransactionController;
 //# sourceMappingURL=TransactionController.js.map

package/dist/TransactionController.mjs

@@ -4,7 +4,7 @@ import {
   HARDFORK,
   SPEED_UP_RATE,
   TransactionController
-} from "./chunk-JDLNCMGI.mjs";
+} from "./chunk-H6NWVGHL.mjs";
 import "./chunk-KG4UW4K4.mjs";
 import "./chunk-NM6OYEPP.mjs";
 import "./chunk-DRSMLO7B.mjs";
@@ -13,8 +13,8 @@ import "./chunk-NHRBO3LU.mjs";
 import "./chunk-L7ZKSKEI.mjs";
 import "./chunk-K4KOSAGM.mjs";
 import "./chunk-53IYIDVS.mjs";
-import "./chunk-35MG26Y3.mjs";
-import "./chunk-W3CS5GRD.mjs";
+import "./chunk-HHK4QSNF.mjs";
+import "./chunk-NOHEXQ7Y.mjs";
 import "./chunk-Y7ENNK7L.mjs";
 import "./chunk-RXRJSBSF.mjs";
 import "./chunk-TKWTUPCQ.mjs";

package/dist/{chunk-5WFLNKCL.js → chunk-2XKEAKQG.js}

@@ -7,10 +7,12 @@ var _utils = require('@metamask/utils');
 var log = _utils.createModuleLogger.call(void 0, _chunkS6VGOPUYjs.projectLogger, "layer-1-gas-fee-flow");
 async function updateTransactionLayer1GasFee(request) {
   const layer1GasFee = await getTransactionLayer1GasFee(request);
-  if (layer1GasFee) {
-    const { transactionMeta } = request;
-    transactionMeta.layer1GasFee = layer1GasFee;
+  if (!layer1GasFee) {
+    return;
   }
+  const { transactionMeta } = request;
+  transactionMeta.layer1GasFee = layer1GasFee;
+  log("Updated layer 1 gas fee", layer1GasFee, transactionMeta.id);
 }
 function getLayer1GasFeeFlow(transactionMeta, layer1GasFeeFlows) {
   return layer1GasFeeFlows.find(
@@ -27,9 +29,13 @@ async function getTransactionLayer1GasFee({
     layer1GasFeeFlows
   );
   if (!layer1GasFeeFlow) {
-    log("Layer 1 gas fee flow not found", transactionMeta.id);
     return void 0;
   }
+  log(
+    "Found layer 1 gas fee flow",
+    layer1GasFeeFlow.constructor.name,
+    transactionMeta.id
+  );
   try {
     const { layer1Fee } = await layer1GasFeeFlow.getLayer1Fee({
       provider,
@@ -46,4 +52,4 @@ async function getTransactionLayer1GasFee({
 
 
 exports.updateTransactionLayer1GasFee = updateTransactionLayer1GasFee; exports.getTransactionLayer1GasFee = getTransactionLayer1GasFee;
-//# sourceMappingURL=chunk-5WFLNKCL.js.map
+//# sourceMappingURL=chunk-2XKEAKQG.js.map

package/dist/chunk-2XKEAKQG.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/utils/layer1-gas-fee-flow.ts"],"names":[],"mappings":";;;;;AACA,SAAS,0BAAoC;AAK7C,IAAM,MAAM,mBAAmB,eAAe,sBAAsB;AAepE,eAAsB,8BACpB,SACA;AACA,QAAM,eAAe,MAAM,2BAA2B,OAAO;AAE7D,MAAI,CAAC,cAAc;AACjB;AAAA,EACF;AAEA,QAAM,EAAE,gBAAgB,IAAI;AAE5B,kBAAgB,eAAe;AAE/B,MAAI,2BAA2B,cAAc,gBAAgB,EAAE;AACjE;AAQA,SAAS,oBACP,iBACA,mBAC8B;AAC9B,SAAO,kBAAkB;AAAA,IAAK,CAAC,qBAC7B,iBAAiB,mBAAmB,eAAe;AAAA,EACrD;AACF;AASA,eAAsB,2BAA2B;AAAA,EAC/C;AAAA,EACA;AAAA,EACA;AACF,GAAwD;AACtD,QAAM,mBAAmB;AAAA,IACvB;AAAA,IACA;AAAA,EACF;AAEA,MAAI,CAAC,kBAAkB;AACrB,WAAO;AAAA,EACT;AAEA;AAAA,IACE;AAAA,IACA,iBAAiB,YAAY;AAAA,IAC7B,gBAAgB;AAAA,EAClB;AAEA,MAAI;AACF,UAAM,EAAE,UAAU,IAAI,MAAM,iBAAiB,aAAa;AAAA,MACxD;AAAA,MACA;AAAA,IACF,CAAC;AACD,WAAO;AAAA,EACT,SAAS,OAAO;AACd,QAAI,iCAAiC,gBAAgB,IAAI,KAAK;AAC9D,WAAO;AAAA,EACT;AACF","sourcesContent":["import type { Provider } from '@metamask/network-controller';\nimport { createModuleLogger, type Hex } from '@metamask/utils';\n\nimport { projectLogger } from '../logger';\nimport type { Layer1GasFeeFlow, TransactionMeta } from '../types';\n\nconst log = createModuleLogger(projectLogger, 'layer-1-gas-fee-flow');\n\nexport type UpdateLayer1GasFeeRequest = {\n  layer1GasFeeFlows: Layer1GasFeeFlow[];\n  provider: Provider;\n  transactionMeta: TransactionMeta;\n};\n\n/**\n * Updates the given transactionMeta with the layer 1 gas fee.\n * @param request - The request to use when getting the layer 1 gas fee.\n * @param request.provider - Provider used to create a new underlying EthQuery instance\n * @param request.transactionMeta - The transaction to get the layer 1 gas fee for.\n * @param request.layer1GasFeeFlows - The layer 1 gas fee flows to search.\n */\nexport async function updateTransactionLayer1GasFee(\n  request: UpdateLayer1GasFeeRequest,\n) {\n  const layer1GasFee = await getTransactionLayer1GasFee(request);\n\n  if (!layer1GasFee) {\n    return;\n  }\n\n  const { transactionMeta } = request;\n\n  transactionMeta.layer1GasFee = layer1GasFee;\n\n  log('Updated layer 1 gas fee', layer1GasFee, transactionMeta.id);\n}\n\n/**\n * Get the layer 1 gas fee flow for a transaction.\n * @param transactionMeta - The transaction to get the layer 1 gas fee flow for.\n * @param layer1GasFeeFlows - The layer 1 gas fee flows to search.\n * @returns The layer 1 gas fee flow for the transaction, or undefined if none match.\n */\nfunction getLayer1GasFeeFlow(\n  transactionMeta: TransactionMeta,\n  layer1GasFeeFlows: Layer1GasFeeFlow[],\n): Layer1GasFeeFlow | undefined {\n  return layer1GasFeeFlows.find((layer1GasFeeFlow) =>\n    layer1GasFeeFlow.matchesTransaction(transactionMeta),\n  );\n}\n\n/**\n * Get the layer 1 gas fee for a transaction and return the layer1Fee.\n * @param request - The request to use when getting the layer 1 gas fee.\n * @param request.layer1GasFeeFlows - The layer 1 gas fee flows to search.\n * @param request.provider - The provider to use to get the layer 1 gas fee.\n * @param request.transactionMeta - The transaction to get the layer 1 gas fee for.\n */\nexport async function getTransactionLayer1GasFee({\n  layer1GasFeeFlows,\n  provider,\n  transactionMeta,\n}: UpdateLayer1GasFeeRequest): Promise<Hex | undefined> {\n  const layer1GasFeeFlow = getLayer1GasFeeFlow(\n    transactionMeta,\n    layer1GasFeeFlows,\n  );\n\n  if (!layer1GasFeeFlow) {\n    return undefined;\n  }\n\n  log(\n    'Found layer 1 gas fee flow',\n    layer1GasFeeFlow.constructor.name,\n    transactionMeta.id,\n  );\n\n  try {\n    const { layer1Fee } = await layer1GasFeeFlow.getLayer1Fee({\n      provider,\n      transactionMeta,\n    });\n    return layer1Fee;\n  } catch (error) {\n    log('Failed to get layer 1 gas fee', transactionMeta.id, error);\n    return undefined;\n  }\n}\n"]}

package/dist/{chunk-JDLNCMGI.mjs → chunk-H6NWVGHL.mjs}

@@ -26,11 +26,11 @@ import {
 } from "./chunk-53IYIDVS.mjs";
 import {
   GasFeePoller
-} from "./chunk-35MG26Y3.mjs";
+} from "./chunk-HHK4QSNF.mjs";
 import {
   getTransactionLayer1GasFee,
   updateTransactionLayer1GasFee
-} from "./chunk-W3CS5GRD.mjs";
+} from "./chunk-NOHEXQ7Y.mjs";
 import {
   IncomingTransactionHelper
 } from "./chunk-Y7ENNK7L.mjs";
@@ -134,7 +134,7 @@ function getDefaultTransactionControllerState() {
     lastFetchedBlockNumbers: {}
   };
 }
-var _internalEvents, _incomingTransactionOptions, _pendingTransactionOptions, _transactionHistoryLimit, _isSimulationEnabled, _multichainTrackingHelper, _createNonceTracker, createNonceTracker_fn, _createIncomingTransactionHelper, createIncomingTransactionHelper_fn, _createPendingTransactionTracker, createPendingTransactionTracker_fn, _checkForPendingTransactionAndStartPolling, _stopAllTracking, stopAllTracking_fn, _removeIncomingTransactionHelperListeners, removeIncomingTransactionHelperListeners_fn, _addIncomingTransactionHelperListeners, addIncomingTransactionHelperListeners_fn, _removePendingTransactionTrackerListeners, removePendingTransactionTrackerListeners_fn, _addPendingTransactionTrackerListeners, addPendingTransactionTrackerListeners_fn, _getNonceTrackerPendingTransactions, getNonceTrackerPendingTransactions_fn, _getGasFeeFlows, getGasFeeFlows_fn, _getLayer1GasFeeFlows, getLayer1GasFeeFlows_fn, _updateTransactionInternal, updateTransactionInternal_fn, _checkIfTransactionParamsUpdated, checkIfTransactionParamsUpdated_fn, _onTransactionParamsUpdated, onTransactionParamsUpdated_fn, _updateSimulationData, updateSimulationData_fn;
+var _internalEvents, _incomingTransactionOptions, _pendingTransactionOptions, _transactionHistoryLimit, _isSimulationEnabled, _multichainTrackingHelper, _createNonceTracker, createNonceTracker_fn, _createIncomingTransactionHelper, createIncomingTransactionHelper_fn, _createPendingTransactionTracker, createPendingTransactionTracker_fn, _checkForPendingTransactionAndStartPolling, _stopAllTracking, stopAllTracking_fn, _removeIncomingTransactionHelperListeners, removeIncomingTransactionHelperListeners_fn, _addIncomingTransactionHelperListeners, addIncomingTransactionHelperListeners_fn, _removePendingTransactionTrackerListeners, removePendingTransactionTrackerListeners_fn, _addPendingTransactionTrackerListeners, addPendingTransactionTrackerListeners_fn, _getNonceTrackerPendingTransactions, getNonceTrackerPendingTransactions_fn, _getGasFeeFlows, getGasFeeFlows_fn, _getLayer1GasFeeFlows, getLayer1GasFeeFlows_fn, _updateTransactionInternal, updateTransactionInternal_fn, _checkIfTransactionParamsUpdated, checkIfTransactionParamsUpdated_fn, _onTransactionParamsUpdated, onTransactionParamsUpdated_fn, _updateSimulationData, updateSimulationData_fn, _onGasFeePollerTransactionUpdate, onGasFeePollerTransactionUpdate_fn;
 var TransactionController = class extends BaseController {
   /**
    * Constructs a TransactionController.
@@ -217,6 +217,7 @@ var TransactionController = class extends BaseController {
     __privateAdd(this, _checkIfTransactionParamsUpdated);
     __privateAdd(this, _onTransactionParamsUpdated);
     __privateAdd(this, _updateSimulationData);
+    __privateAdd(this, _onGasFeePollerTransactionUpdate);
     __privateAdd(this, _internalEvents, new EventEmitter());
     this.inProcessOfSigning = /* @__PURE__ */ new Set();
     this.mutex = new Mutex();
@@ -323,7 +324,7 @@ var TransactionController = class extends BaseController {
     });
     gasFeePoller.hub.on(
       "transaction-updated",
-      (transactionMeta) => __privateMethod(this, _updateTransactionInternal, updateTransactionInternal_fn).call(this, transactionMeta, { skipHistory: true })
+      __privateMethod(this, _onGasFeePollerTransactionUpdate, onGasFeePollerTransactionUpdate_fn).bind(this)
     );
     this.messagingSystem.subscribe(
       "TransactionController:stateChange",
@@ -857,10 +858,8 @@ var TransactionController = class extends BaseController {
    * @param note - A note or update reason to include in the transaction history.
    */
   updateTransaction(transactionMeta, note) {
-    __privateMethod(this, _updateTransactionInternal, updateTransactionInternal_fn).call(this, transactionMeta, {
-      note,
-      skipHistory: this.isHistoryDisabled
-    });
+    const { id: transactionId } = transactionMeta;
+    __privateMethod(this, _updateTransactionInternal, updateTransactionInternal_fn).call(this, { transactionId, note, skipHistory: this.isHistoryDisabled }, () => ({ ...transactionMeta }));
   }
   /**
    * Update the security alert response for a transaction.
@@ -1367,18 +1366,23 @@ var TransactionController = class extends BaseController {
     return filteredTransactions;
   }
   /**
-   * Utility method to get the layer 1 gas fee for given transaction params.
+   * Determine the layer 1 gas fee for the given transaction parameters.
    *
-   * @param chainId - Estimated transaction chainId.
-   * @param networkClientId - Estimated transaction networkClientId.
-   * @param transactionParams - The transaction params to estimate layer 1 gas fee for.
+   * @param request - The request object.
+   * @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.
    */
-  async getLayer1GasFee(chainId, networkClientId, transactionParams) {
+  async getLayer1GasFee({
+    transactionParams,
+    chainId,
+    networkClientId
+  }) {
     const provider = __privateGet(this, _multichainTrackingHelper).getProvider({
       networkClientId,
       chainId
     });
-    const layer1GasFee = await getTransactionLayer1GasFee({
+    return await getTransactionLayer1GasFee({
       layer1GasFeeFlows: this.layer1GasFeeFlows,
       provider,
       transactionMeta: {
@@ -1386,7 +1390,6 @@ var TransactionController = class extends BaseController {
         chainId
       }
     });
-    return layer1GasFee;
   }
   async signExternalTransaction(chainId, transactionParams) {
     if (!this.sign) {
@@ -2327,25 +2330,36 @@ getLayer1GasFeeFlows_fn = function() {
   return [new OptimismLayer1GasFeeFlow()];
 };
 _updateTransactionInternal = new WeakSet();
-updateTransactionInternal_fn = function(transactionMeta, { note, skipHistory }) {
-  const normalizedTransaction = {
-    ...transactionMeta,
-    txParams: normalizeTransactionParams(transactionMeta.txParams)
-  };
-  validateTxParams(normalizedTransaction.txParams);
-  const updatedTransactionParams = __privateMethod(this, _checkIfTransactionParamsUpdated, checkIfTransactionParamsUpdated_fn).call(this, normalizedTransaction);
-  const transactionWithUpdatedHistory = skipHistory === true ? normalizedTransaction : updateTransactionHistory(
-    normalizedTransaction,
-    note ?? "Transaction updated"
-  );
+updateTransactionInternal_fn = function({
+  transactionId,
+  note,
+  skipHistory
+}, callback) {
+  let updatedTransactionParams = [];
   this.update((state) => {
     const index = state.transactions.findIndex(
-      ({ id }) => transactionMeta.id === id
+      ({ id }) => id === transactionId
     );
-    state.transactions[index] = transactionWithUpdatedHistory;
+    let transactionMeta2 = state.transactions[index];
+    transactionMeta2 = callback(transactionMeta2) ?? transactionMeta2;
+    transactionMeta2.txParams = normalizeTransactionParams(
+      transactionMeta2.txParams
+    );
+    validateTxParams(transactionMeta2.txParams);
+    updatedTransactionParams = __privateMethod(this, _checkIfTransactionParamsUpdated, checkIfTransactionParamsUpdated_fn).call(this, transactionMeta2);
+    if (skipHistory !== true) {
+      transactionMeta2 = updateTransactionHistory(
+        transactionMeta2,
+        note ?? "Transaction updated"
+      );
+    }
+    state.transactions[index] = transactionMeta2;
   });
+  const transactionMeta = this.getTransaction(
+    transactionId
+  );
   if (updatedTransactionParams.length > 0) {
-    __privateMethod(this, _onTransactionParamsUpdated, onTransactionParamsUpdated_fn).call(this, normalizedTransaction, updatedTransactionParams);
+    __privateMethod(this, _onTransactionParamsUpdated, onTransactionParamsUpdated_fn).call(this, transactionMeta, updatedTransactionParams);
   }
 };
 _checkIfTransactionParamsUpdated = new WeakSet();
@@ -2379,7 +2393,7 @@ onTransactionParamsUpdated_fn = function(transactionMeta, updatedParams) {
 };
 _updateSimulationData = new WeakSet();
 updateSimulationData_fn = async function(transactionMeta) {
-  const { id, chainId, txParams } = transactionMeta;
+  const { id: transactionId, chainId, txParams } = transactionMeta;
   const { from, to, value, data } = txParams;
   let simulationData = {
     error: {
@@ -2389,7 +2403,9 @@ updateSimulationData_fn = async function(transactionMeta) {
     tokenBalanceChanges: []
   };
   if (__privateGet(this, _isSimulationEnabled).call(this)) {
-    __privateMethod(this, _updateTransactionInternal, updateTransactionInternal_fn).call(this, { ...transactionMeta, simulationData: void 0 }, { skipHistory: true });
+    __privateMethod(this, _updateTransactionInternal, updateTransactionInternal_fn).call(this, { transactionId, skipHistory: true }, (txMeta) => {
+      txMeta.simulationData = void 0;
+    });
     simulationData = await getSimulationData({
       chainId,
       from,
@@ -2398,20 +2414,41 @@ updateSimulationData_fn = async function(transactionMeta) {
       data
     });
   }
-  const finalTransactionMeta = this.getTransaction(id);
+  const finalTransactionMeta = this.getTransaction(transactionId);
   if (!finalTransactionMeta) {
     projectLogger(
       "Cannot update simulation data as transaction not found",
-      id,
+      transactionId,
       simulationData
     );
     return;
   }
-  this.updateTransaction(
-    { ...finalTransactionMeta, simulationData },
-    "TransactionController#updateSimulationData - Update simulation data"
-  );
-  projectLogger("Updated simulation data", id, simulationData);
+  __privateMethod(this, _updateTransactionInternal, updateTransactionInternal_fn).call(this, {
+    transactionId,
+    note: "TransactionController#updateSimulationData - Update simulation data"
+  }, (txMeta) => {
+    txMeta.simulationData = simulationData;
+  });
+  projectLogger("Updated simulation data", transactionId, simulationData);
+};
+_onGasFeePollerTransactionUpdate = new WeakSet();
+onGasFeePollerTransactionUpdate_fn = function({
+  transactionId,
+  gasFeeEstimates,
+  gasFeeEstimatesLoaded,
+  layer1GasFee
+}) {
+  __privateMethod(this, _updateTransactionInternal, updateTransactionInternal_fn).call(this, { transactionId, skipHistory: true }, (txMeta) => {
+    if (gasFeeEstimates) {
+      txMeta.gasFeeEstimates = gasFeeEstimates;
+    }
+    if (gasFeeEstimatesLoaded !== void 0) {
+      txMeta.gasFeeEstimatesLoaded = gasFeeEstimatesLoaded;
+    }
+    if (layer1GasFee) {
+      txMeta.layer1GasFee = layer1GasFee;
+    }
+  });
 };
 
 export {
@@ -2421,4 +2458,4 @@ export {
   ApprovalState,
   TransactionController
 };
-//# sourceMappingURL=chunk-JDLNCMGI.mjs.map
+//# sourceMappingURL=chunk-H6NWVGHL.mjs.map