@metamask-previews/transaction-controller 52.0.0-preview-e3c959f → 52.0.0-preview-e56c504a

package/CHANGELOG.md

@@ -7,9 +7,12 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
-### Fixed
+### Added
 
-- Fix gas estimation for type 4 transactions ([#5519](https://github.com/MetaMask/core/pull/5519))
+- Add `gasFeeTokens` to `TransactionMeta` ([#5524](https://github.com/MetaMask/core/pull/5524))
+  - Add `GasFeeToken` type.
+  - Add `selectedGasFeeToken` to `TransactionMeta`.
+  - Add `updateSelectedGasFeeToken` method.
 
 ## [52.0.0]
 
@@ -33,7 +36,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 ### Added
 
 - Add additional metadata for batch metrics ([#5488](https://github.com/MetaMask/core/pull/5488))
-  - Add `delegationAddress` to `TransactionMetadata`.
+  - Add `delegationAddress` to `TransactionMeta`.
   - Add `NestedTransactionMetadata` type containing `BatchTransactionParams` and `type`.
   - Add optional `type` to `TransactionBatchSingleRequest`.
 - Verify EIP-7702 contract address using signatures ([#5472](https://github.com/MetaMask/core/pull/5472))
@@ -44,8 +47,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 - **BREAKING:** Bump `@metamask/accounts-controller` peer dependency to `^26.1.0` ([#5481](https://github.com/MetaMask/core/pull/5481))
 - **BREAKING:** Add additional metadata for batch metrics ([#5488](https://github.com/MetaMask/core/pull/5488))
-  - Change `error` in `TransactionMetadata` to optional for all statuses.
-  - Change `nestedTransactions` in `TransactionMetadata` to array of `NestedTransactionMetadata`.
+  - Change `error` in `TransactionMeta` to optional for all statuses.
+  - Change `nestedTransactions` in `TransactionMeta` to array of `NestedTransactionMetadata`.
 - Throw if `addTransactionBatch` called with external origin and size limit exceeded ([#5489](https://github.com/MetaMask/core/pull/5489))
 - Verify EIP-7702 contract address using signatures ([#5472](https://github.com/MetaMask/core/pull/5472))
   - Use new `contracts` property from feature flags instead of `contractAddresses`.

package/dist/TransactionController.cjs

@@ -549,12 +549,7 @@ class TransactionController extends base_controller_1.BaseController {
         const ethQuery = __classPrivateFieldGet(this, _TransactionController_instances, "m", _TransactionController_getEthQuery).call(this, {
             networkClientId,
         });
-        const { estimatedGas, simulationFails } = await (0, gas_1.estimateGas)({
-            chainId: __classPrivateFieldGet(this, _TransactionController_instances, "m", _TransactionController_getChainId).call(this, networkClientId),
-            ethQuery,
-            isSimulationEnabled: __classPrivateFieldGet(this, _TransactionController_isSimulationEnabled, "f").call(this),
-            txParams: transaction,
-        });
+        const { estimatedGas, simulationFails } = await (0, gas_1.estimateGas)(transaction, ethQuery);
         return { gas: estimatedGas, simulationFails };
     }
     /**
@@ -569,12 +564,7 @@ class TransactionController extends base_controller_1.BaseController {
         const ethQuery = __classPrivateFieldGet(this, _TransactionController_instances, "m", _TransactionController_getEthQuery).call(this, {
             networkClientId,
         });
-        const { blockGasLimit, estimatedGas, simulationFails } = await (0, gas_1.estimateGas)({
-            chainId: __classPrivateFieldGet(this, _TransactionController_instances, "m", _TransactionController_getChainId).call(this, networkClientId),
-            ethQuery,
-            isSimulationEnabled: __classPrivateFieldGet(this, _TransactionController_isSimulationEnabled, "f").call(this),
-            txParams: transaction,
-        });
+        const { blockGasLimit, estimatedGas, simulationFails } = await (0, gas_1.estimateGas)(transaction, ethQuery);
         const gas = (0, gas_1.addGasBuffer)(estimatedGas, blockGasLimit, multiplier);
         return {
             gas,
@@ -1166,6 +1156,21 @@ class TransactionController extends base_controller_1.BaseController {
         });
         return updatedTransactionMeta.txParams.data;
     }
+    /**
+     * Update the selected gas fee token for a transaction.
+     *
+     * @param transactionId - The ID of the transaction to update.
+     * @param contractAddress - The contract address of the selected gas fee token.
+     */
+    updateSelectedGasFeeToken(transactionId, contractAddress) {
+        __classPrivateFieldGet(this, _TransactionController_instances, "m", _TransactionController_updateTransactionInternal).call(this, { transactionId }, (transactionMeta) => {
+            const hasMatchingGasFeeToken = transactionMeta.gasFeeTokens?.some((token) => token.tokenAddress.toLowerCase() === contractAddress.toLowerCase());
+            if (!hasMatchingGasFeeToken) {
+                throw new Error(`No matching gas fee token found with address - ${contractAddress}`);
+            }
+            transactionMeta.selectedGasFeeToken = contractAddress;
+        });
+    }
     addMetadata(transactionMeta) {
         (0, validation_1.validateTxParams)(transactionMeta.txParams);
         this.update((state) => {
@@ -2011,8 +2016,9 @@ _TransactionController_internalEvents = new WeakMap(), _TransactionController_me
         },
         tokenBalanceChanges: [],
     };
+    let gasFeeTokens = [];
     if (__classPrivateFieldGet(this, _TransactionController_isSimulationEnabled, "f").call(this)) {
-        simulationData = await __classPrivateFieldGet(this, _TransactionController_trace, "f").call(this, { name: 'Simulate', parentContext: traceContext }, () => (0, simulation_1.getSimulationData)({
+        const result = await __classPrivateFieldGet(this, _TransactionController_trace, "f").call(this, { name: 'Simulate', parentContext: traceContext }, () => (0, simulation_1.getSimulationData)({
             chainId,
             from: from,
             to: to,
@@ -2021,6 +2027,8 @@ _TransactionController_internalEvents = new WeakMap(), _TransactionController_me
         }, {
             blockTime,
         }));
+        gasFeeTokens = result?.gasFeeTokens;
+        simulationData = result?.simulationData;
         if (blockTime &&
             prevSimulationData &&
             (0, ResimulateHelper_1.hasSimulationDataChanged)(prevSimulationData, simulationData)) {
@@ -2041,6 +2049,7 @@ _TransactionController_internalEvents = new WeakMap(), _TransactionController_me
         note: 'TransactionController#updateSimulationData - Update simulation data',
         skipResimulateCheck: Boolean(blockTime),
     }, (txMeta) => {
+        txMeta.gasFeeTokens = gasFeeTokens;
         txMeta.simulationData = simulationData;
     });
     (0, logger_1.projectLogger)('Updated simulation data', transactionId, simulationData);
@@ -2097,7 +2106,6 @@ _TransactionController_internalEvents = new WeakMap(), _TransactionController_me
         chainId,
         ethQuery,
         isCustomNetwork,
-        isSimulationEnabled: __classPrivateFieldGet(this, _TransactionController_isSimulationEnabled, "f").call(this),
         txMeta: transactionMeta,
     });
 }, _TransactionController_deleteTransaction = function _TransactionController_deleteTransaction(transactionId) {