@metamask/transaction-controller 60.1.0 → 60.2.0

package/CHANGELOG.md

@@ -7,6 +7,13 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [60.2.0]
+
+### Added
+
+- Add `isGasFeeIncluded` to `TransactionMeta`, `TransactionBatchRequest` and `addTransaction` options so the client can signal that MetaMask is compensated for the gas fee by the transaction ([#6428](https://github.com/MetaMask/core/pull/6428))
+- Add optional `gasUsed` property to `TransactionMeta`, returned by the transaction simulation result ([#6410](https://github.com/MetaMask/core/pull/6410))
+
 ## [60.1.0]
 
 ### Added
@@ -1782,7 +1789,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@60.1.0...HEAD
+[Unreleased]: https://github.com/MetaMask/core/compare/@metamask/transaction-controller@60.2.0...HEAD
+[60.2.0]: https://github.com/MetaMask/core/compare/@metamask/transaction-controller@60.1.0...@metamask/transaction-controller@60.2.0
 [60.1.0]: https://github.com/MetaMask/core/compare/@metamask/transaction-controller@60.0.0...@metamask/transaction-controller@60.1.0
 [60.0.0]: https://github.com/MetaMask/core/compare/@metamask/transaction-controller@59.2.0...@metamask/transaction-controller@60.0.0
 [59.2.0]: https://github.com/MetaMask/core/compare/@metamask/transaction-controller@59.1.0...@metamask/transaction-controller@59.2.0

package/dist/TransactionController.cjs

@@ -367,6 +367,7 @@ class TransactionController extends base_controller_1.BaseController {
      * @param options.batchId - A custom ID for the batch this transaction belongs to.
      * @param options.deviceConfirmedOn - An enum to indicate what device confirmed the transaction.
      * @param options.disableGasBuffer - Whether to disable the gas estimation buffer.
+     * @param options.isGasFeeIncluded - Whether MetaMask will be compensated for the gas fee by 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.
@@ -384,7 +385,7 @@ class TransactionController extends base_controller_1.BaseController {
      */
     async addTransaction(txParams, options) {
         (0, logger_1.projectLogger)('Adding transaction', txParams, options);
-        const { actionId, assetsFiatValues, batchId, deviceConfirmedOn, disableGasBuffer, method, nestedTransactions, networkClientId, origin, publishHook, requireApproval, securityAlertResponse, sendFlowHistory, swaps = {}, traceContext, type, } = options;
+        const { actionId, assetsFiatValues, batchId, deviceConfirmedOn, disableGasBuffer, isGasFeeIncluded, method, nestedTransactions, networkClientId, origin, publishHook, requireApproval, securityAlertResponse, sendFlowHistory, swaps = {}, traceContext, type, } = options;
         txParams = (0, utils_2.normalizeTransactionParams)(txParams);
         if (!__classPrivateFieldGet(this, _TransactionController_multichainTrackingHelper, "f").has(networkClientId)) {
             throw new Error(`Network client not found - ${networkClientId}`);
@@ -436,6 +437,7 @@ class TransactionController extends base_controller_1.BaseController {
                 deviceConfirmedOn,
                 disableGasBuffer,
                 id: (0, uuid_1.v1)(),
+                isGasFeeIncluded,
                 isFirstTimeInteraction: undefined,
                 nestedTransactions,
                 networkClientId,
@@ -2120,11 +2122,12 @@ async function _TransactionController_approveTransaction(transactionId, traceCon
         },
         tokenBalanceChanges: [],
     };
+    let gasUsed;
     let gasFeeTokens = [];
     let isGasFeeSponsored = false;
     const isBalanceChangesSkipped = __classPrivateFieldGet(this, _TransactionController_skipSimulationTransactionIds, "f").has(transactionId);
     if (__classPrivateFieldGet(this, _TransactionController_isSimulationEnabled, "f").call(this) && !isBalanceChangesSkipped) {
-        simulationData = await __classPrivateFieldGet(this, _TransactionController_trace, "f").call(this, { name: 'Simulate', parentContext: traceContext }, () => (0, balance_changes_1.getBalanceChanges)({
+        const balanceChangesResult = await __classPrivateFieldGet(this, _TransactionController_trace, "f").call(this, { name: 'Simulate', parentContext: traceContext }, () => (0, balance_changes_1.getBalanceChanges)({
             blockTime,
             chainId,
             ethQuery: __classPrivateFieldGet(this, _TransactionController_instances, "m", _TransactionController_getEthQuery).call(this, { networkClientId }),
@@ -2132,6 +2135,8 @@ async function _TransactionController_approveTransaction(transactionId, traceCon
             nestedTransactions,
             txParams,
         }));
+        simulationData = balanceChangesResult.simulationData;
+        gasUsed = balanceChangesResult.gasUsed;
         if (blockTime &&
             prevSimulationData &&
             (0, ResimulateHelper_1.hasSimulationDataChanged)(prevSimulationData, simulationData)) {
@@ -2164,6 +2169,7 @@ async function _TransactionController_approveTransaction(transactionId, traceCon
     }, (txMeta) => {
         txMeta.gasFeeTokens = gasFeeTokens;
         txMeta.isGasFeeSponsored = isGasFeeSponsored;
+        txMeta.gasUsed = gasUsed;
         if (!isBalanceChangesSkipped) {
             txMeta.simulationData = simulationData;
         }