@metamask/transaction-controller 56.0.0 → 56.1.0

package/CHANGELOG.md

@@ -7,6 +7,23 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [56.1.0]
+
+### Added
+
+- Automatically update gas fee properties in `txParams` when `updateTransactionGasFees` method is called with `userFeeLevel` ([#5800](https://github.com/MetaMask/core/pull/5800))
+- Support additional debug of incoming transaction requests ([#5803](https://github.com/MetaMask/core/pull/5803))
+  - Add optional `incomingTransactions.client` constructor property.
+  - Add optional `tags` property to `updateIncomingTransactions` method.
+
+### Changed
+
+- Bump `@metamask/controller-utils` to `^11.9.0` ([#5812](https://github.com/MetaMask/core/pull/5812))
+
+### Fixed
+
+- Throw correct error code if upgrade rejected ([#5814](https://github.com/MetaMask/core/pull/5814))
+
 ## [56.0.0]
 
 ### Changed
@@ -1584,7 +1601,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@56.0.0...HEAD
+[Unreleased]: https://github.com/MetaMask/core/compare/@metamask/transaction-controller@56.1.0...HEAD
+[56.1.0]: https://github.com/MetaMask/core/compare/@metamask/transaction-controller@56.0.0...@metamask/transaction-controller@56.1.0
 [56.0.0]: https://github.com/MetaMask/core/compare/@metamask/transaction-controller@55.0.2...@metamask/transaction-controller@56.0.0
 [55.0.2]: https://github.com/MetaMask/core/compare/@metamask/transaction-controller@55.0.1...@metamask/transaction-controller@55.0.2
 [55.0.1]: https://github.com/MetaMask/core/compare/@metamask/transaction-controller@55.0.0...@metamask/transaction-controller@55.0.1

package/dist/TransactionController.cjs

@@ -259,6 +259,7 @@ class TransactionController extends base_controller_1.BaseController {
             });
         };
         __classPrivateFieldSet(this, _TransactionController_incomingTransactionHelper, new IncomingTransactionHelper_1.IncomingTransactionHelper({
+            client: __classPrivateFieldGet(this, _TransactionController_incomingTransactionOptions, "f").client,
             getCache: () => this.state.lastFetchedBlockNumbers,
             getCurrentAccount: () => __classPrivateFieldGet(this, _TransactionController_instances, "m", _TransactionController_getSelectedAccount).call(this),
             getLocalTransactions: () => this.state.transactions,
@@ -494,8 +495,14 @@ class TransactionController extends base_controller_1.BaseController {
     stopIncomingTransactionPolling() {
         __classPrivateFieldGet(this, _TransactionController_incomingTransactionHelper, "f").stop();
     }
-    async updateIncomingTransactions() {
-        await __classPrivateFieldGet(this, _TransactionController_incomingTransactionHelper, "f").update();
+    /**
+     * Update the incoming transactions by polling the remote transaction source.
+     *
+     * @param request - Request object.
+     * @param request.tags - Additional tags to identify the source of the request.
+     */
+    async updateIncomingTransactions({ tags } = {}) {
+        await __classPrivateFieldGet(this, _TransactionController_incomingTransactionHelper, "f").update({ tags });
     }
     /**
      * Attempts to cancel a transaction based on its ID by setting its status to "rejected"
@@ -736,35 +743,66 @@ class TransactionController extends base_controller_1.BaseController {
      * @param gasValues.userFeeLevel - Estimate level user selected.
      * @returns The updated transactionMeta.
      */
-    updateTransactionGasFees(transactionId, { defaultGasEstimates, estimateUsed, estimateSuggested, gas, gasLimit, gasPrice, maxPriorityFeePerGas, maxFeePerGas, originalGasEstimate, userEditedGasLimit, userFeeLevel, }) {
+    updateTransactionGasFees(transactionId, { defaultGasEstimates, estimateUsed, estimateSuggested, gas, gasLimit, gasPrice, maxPriorityFeePerGas, maxFeePerGas, originalGasEstimate, userEditedGasLimit, userFeeLevel: userFeeLevelParam, }) {
         const transactionMeta = __classPrivateFieldGet(this, _TransactionController_instances, "m", _TransactionController_getTransaction).call(this, transactionId);
         if (!transactionMeta) {
             throw new Error(`Cannot update transaction as no transaction metadata found`);
         }
         (0, utils_2.validateIfTransactionUnapproved)(transactionMeta, 'updateTransactionGasFees');
-        let transactionGasFees = {
-            txParams: {
-                gas,
-                gasLimit,
+        const clonedTransactionMeta = (0, lodash_1.cloneDeep)(transactionMeta);
+        const isTransactionGasFeeEstimatesExists = transactionMeta.gasFeeEstimates;
+        const isAutomaticGasFeeUpdateEnabled = __classPrivateFieldGet(this, _TransactionController_isAutomaticGasFeeUpdateEnabled, "f").call(this, transactionMeta);
+        const userFeeLevel = userFeeLevelParam;
+        const isOneOfFeeLevelSelected = Object.values(types_1.GasFeeEstimateLevel).includes(userFeeLevel);
+        const shouldUpdateTxParamsGasFees = isTransactionGasFeeEstimatesExists &&
+            isAutomaticGasFeeUpdateEnabled &&
+            isOneOfFeeLevelSelected;
+        if (shouldUpdateTxParamsGasFees) {
+            (0, GasFeePoller_1.updateTransactionGasEstimates)({
+                txMeta: clonedTransactionMeta,
+                userFeeLevel,
+            });
+        }
+        const txParamsUpdate = {
+            gas,
+            gasLimit,
+        };
+        if (shouldUpdateTxParamsGasFees) {
+            // Get updated values from clonedTransactionMeta if we're using automated fee updates
+            Object.assign(txParamsUpdate, {
+                gasPrice: clonedTransactionMeta.txParams.gasPrice,
+                maxPriorityFeePerGas: clonedTransactionMeta.txParams.maxPriorityFeePerGas,
+                maxFeePerGas: clonedTransactionMeta.txParams.maxFeePerGas,
+            });
+        }
+        else {
+            Object.assign(txParamsUpdate, {
                 gasPrice,
                 maxPriorityFeePerGas,
                 maxFeePerGas,
-            },
+            });
+        }
+        const transactionGasFees = {
+            txParams: (0, lodash_1.pickBy)(txParamsUpdate),
             defaultGasEstimates,
             estimateUsed,
             estimateSuggested,
             originalGasEstimate,
             userEditedGasLimit,
             userFeeLevel,
-            // TODO: Replace `any` with type
-            // eslint-disable-next-line @typescript-eslint/no-explicit-any
         };
-        // only update what is defined
-        transactionGasFees.txParams = (0, lodash_1.pickBy)(transactionGasFees.txParams);
-        transactionGasFees = (0, lodash_1.pickBy)(transactionGasFees);
-        // merge updated gas values with existing transaction meta
-        const updatedMeta = (0, lodash_1.merge)({}, transactionMeta, transactionGasFees);
-        this.updateTransaction(updatedMeta, `${controllerName}:updateTransactionGasFees - gas values updated`);
+        const filteredTransactionGasFees = (0, lodash_1.pickBy)(transactionGasFees);
+        __classPrivateFieldGet(this, _TransactionController_instances, "m", _TransactionController_updateTransactionInternal).call(this, {
+            transactionId,
+            note: `${controllerName}:updateTransactionGasFees - gas values updated`,
+            skipResimulateCheck: true,
+        }, (draftTxMeta) => {
+            const { txParams, ...otherProps } = filteredTransactionGasFees;
+            Object.assign(draftTxMeta, otherProps);
+            if (txParams) {
+                Object.assign(draftTxMeta.txParams, txParams);
+            }
+        });
         return __classPrivateFieldGet(this, _TransactionController_instances, "m", _TransactionController_getTransaction).call(this, transactionId);
     }
     /**
@@ -2042,7 +2080,7 @@ async function _TransactionController_approveTransaction(transactionId, traceCon
     (0, logger_1.projectLogger)('Updated simulation data', transactionId, simulationData);
 }, _TransactionController_onGasFeePollerTransactionUpdate = function _TransactionController_onGasFeePollerTransactionUpdate({ transactionId, gasFeeEstimates, gasFeeEstimatesLoaded, layer1GasFee, }) {
     __classPrivateFieldGet(this, _TransactionController_instances, "m", _TransactionController_updateTransactionInternal).call(this, { transactionId, skipHistory: true }, (txMeta) => {
-        (0, GasFeePoller_1.updateTransactionGasFees)({
+        (0, GasFeePoller_1.updateTransactionGasProperties)({
             txMeta,
             gasFeeEstimates,
             gasFeeEstimatesLoaded,
@@ -2105,7 +2143,7 @@ async function _TransactionController_approveTransaction(transactionId, traceCon
 }, _TransactionController_isRejectError = function _TransactionController_isRejectError(error) {
     return [
         rpc_errors_1.errorCodes.provider.userRejectedRequest,
-        rpc_errors_1.errorCodes.rpc.methodNotSupported,
+        validation_1.ErrorCode.RejectedUpgrade,
     ].includes(error.code);
 }, _TransactionController_rejectTransactionAndThrow = function _TransactionController_rejectTransactionAndThrow(transactionId, actionId, error) {
     __classPrivateFieldGet(this, _TransactionController_instances, "m", _TransactionController_rejectTransaction).call(this, transactionId, actionId, error);