@metamask/transaction-controller 37.0.0 → 37.2.0

package/CHANGELOG.md

@@ -7,6 +7,31 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [37.2.0]
+
+### Added
+
+- Add optional `incomingTransactions.etherscanApiKeysByChainId` constructor property to support API keys in requests to Etherscan ([#4748](https://github.com/MetaMask/core/pull/4748))
+
+### Fixed
+
+- Cleanup transactions only during initialisation ([#4753](https://github.com/MetaMask/core/pull/4753))
+- Remove `gasPrice` from requests to `linea_estimateGas` ([#4737](https://github.com/MetaMask/core/pull/4737))
+
+## [37.1.0]
+
+### Added
+
+- Populate `submitHistory` in state when submitting transactions to network ([#4706](https://github.com/MetaMask/core/pull/4706))
+- Export `CHAIN_IDS`, `ETHERSCAN_SUPPORTED_NETWORKS` and `SPEED_UP_RATE` constants ([#4706](https://github.com/MetaMask/core/pull/4706))
+
+### Changed
+
+- Make `getPermittedAccounts` constructor callback optional ([#4706](https://github.com/MetaMask/core/pull/4706))
+- Bump accounts related packages ([#4713](https://github.com/MetaMask/core/pull/4713)), ([#4728](https://github.com/MetaMask/core/pull/4728))
+  - Those packages are now built slightly differently and are part of the [accounts monorepo](https://github.com/MetaMask/accounts).
+  - Bump `@metamask/keyring-api` from `^8.1.0` to `^8.1.4`
+
 ## [37.0.0]
 
 ### Changed
@@ -1023,7 +1048,9 @@ 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@37.0.0...HEAD
+[Unreleased]: https://github.com/MetaMask/core/compare/@metamask/transaction-controller@37.2.0...HEAD
+[37.2.0]: https://github.com/MetaMask/core/compare/@metamask/transaction-controller@37.1.0...@metamask/transaction-controller@37.2.0
+[37.1.0]: https://github.com/MetaMask/core/compare/@metamask/transaction-controller@37.0.0...@metamask/transaction-controller@37.1.0
 [37.0.0]: https://github.com/MetaMask/core/compare/@metamask/transaction-controller@36.1.0...@metamask/transaction-controller@37.0.0
 [36.1.0]: https://github.com/MetaMask/core/compare/@metamask/transaction-controller@36.0.0...@metamask/transaction-controller@36.1.0
 [36.0.0]: https://github.com/MetaMask/core/compare/@metamask/transaction-controller@35.2.0...@metamask/transaction-controller@36.0.0

package/dist/TransactionController.cjs

@@ -13,7 +13,7 @@ var __classPrivateFieldSet = (this && this.__classPrivateFieldSet) || function (
 var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
-var _TransactionController_instances, _TransactionController_internalEvents, _TransactionController_incomingTransactionOptions, _TransactionController_pendingTransactionOptions, _TransactionController_trace, _TransactionController_transactionHistoryLimit, _TransactionController_isSimulationEnabled, _TransactionController_testGasFeeFlows, _TransactionController_multichainTrackingHelper, _TransactionController_retryTransaction, _TransactionController_createNonceTracker, _TransactionController_createIncomingTransactionHelper, _TransactionController_createPendingTransactionTracker, _TransactionController_checkForPendingTransactionAndStartPolling, _TransactionController_stopAllTracking, _TransactionController_removeIncomingTransactionHelperListeners, _TransactionController_addIncomingTransactionHelperListeners, _TransactionController_removePendingTransactionTrackerListeners, _TransactionController_addPendingTransactionTrackerListeners, _TransactionController_getNonceTrackerPendingTransactions, _TransactionController_getGasFeeFlows, _TransactionController_getLayer1GasFeeFlows, _TransactionController_updateTransactionInternal, _TransactionController_checkIfTransactionParamsUpdated, _TransactionController_onTransactionParamsUpdated, _TransactionController_updateSimulationData, _TransactionController_onGasFeePollerTransactionUpdate, _TransactionController_getNetworkClientId, _TransactionController_getGlobalNetworkClientId, _TransactionController_getGlobalChainId, _TransactionController_isCustomNetwork, _TransactionController_getSelectedAccount;
+var _TransactionController_instances, _TransactionController_internalEvents, _TransactionController_incomingTransactionOptions, _TransactionController_pendingTransactionOptions, _TransactionController_trace, _TransactionController_transactionHistoryLimit, _TransactionController_isSimulationEnabled, _TransactionController_testGasFeeFlows, _TransactionController_multichainTrackingHelper, _TransactionController_retryTransaction, _TransactionController_createNonceTracker, _TransactionController_createIncomingTransactionHelper, _TransactionController_createPendingTransactionTracker, _TransactionController_checkForPendingTransactionAndStartPolling, _TransactionController_stopAllTracking, _TransactionController_removeIncomingTransactionHelperListeners, _TransactionController_addIncomingTransactionHelperListeners, _TransactionController_removePendingTransactionTrackerListeners, _TransactionController_addPendingTransactionTrackerListeners, _TransactionController_getNonceTrackerPendingTransactions, _TransactionController_getGasFeeFlows, _TransactionController_getLayer1GasFeeFlows, _TransactionController_updateTransactionInternal, _TransactionController_checkIfTransactionParamsUpdated, _TransactionController_onTransactionParamsUpdated, _TransactionController_updateSimulationData, _TransactionController_onGasFeePollerTransactionUpdate, _TransactionController_getNetworkClientId, _TransactionController_getGlobalNetworkClientId, _TransactionController_getGlobalChainId, _TransactionController_isCustomNetwork, _TransactionController_getSelectedAccount, _TransactionController_updateSubmitHistory;
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.TransactionController = exports.ApprovalState = exports.SPEED_UP_RATE = exports.CANCEL_RATE = exports.HARDFORK = void 0;
 const common_1 = require("@ethereumjs/common");
@@ -73,8 +73,13 @@ const metadata = {
         persist: true,
         anonymous: false,
     },
+    submitHistory: {
+        persist: true,
+        anonymous: false,
+    },
 };
 exports.HARDFORK = common_1.Hardfork.London;
+const SUBMIT_HISTORY_LIMIT = 100;
 /**
  * Multiplier used to determine a transaction's increased gas fee during cancellation
  */
@@ -106,6 +111,7 @@ function getDefaultTransactionControllerState() {
         methodData: {},
         transactions: [],
         lastFetchedBlockNumbers: {},
+        submitHistory: [],
     };
 }
 /**
@@ -273,6 +279,7 @@ class TransactionController extends base_controller_1.BaseController {
         }), "f");
         __classPrivateFieldGet(this, _TransactionController_multichainTrackingHelper, "f").initialize();
         const etherscanRemoteTransactionSource = new EtherscanRemoteTransactionSource_1.EtherscanRemoteTransactionSource({
+            apiKeysByChainId: incomingTransactions.etherscanApiKeysByChainId,
             includeTokenTransfers: incomingTransactions.includeTokenTransfers,
         });
         this.incomingTransactionHelper = __classPrivateFieldGet(this, _TransactionController_instances, "m", _TransactionController_createIncomingTransactionHelper).call(this, {
@@ -308,7 +315,6 @@ class TransactionController extends base_controller_1.BaseController {
         onNetworkStateChange(() => {
             (0, logger_1.projectLogger)('Detected network change', this.getChainId());
             this.pendingTransactionTracker.startIfPendingTransactions();
-            this.onBootCleanup();
         });
         this.onBootCleanup();
         __classPrivateFieldGet(this, _TransactionController_checkForPendingTransactionAndStartPolling, "f").call(this);
@@ -375,7 +381,7 @@ class TransactionController extends base_controller_1.BaseController {
         const networkClientId = requestNetworkClientId ?? __classPrivateFieldGet(this, _TransactionController_instances, "m", _TransactionController_getGlobalNetworkClientId).call(this);
         const isEIP1559Compatible = await this.getEIP1559Compatibility(networkClientId);
         (0, validation_1.validateTxParams)(txParams, isEIP1559Compatible);
-        if (origin) {
+        if (origin && this.getPermittedAccounts) {
             await (0, validation_1.validateTransactionOrigin)(await this.getPermittedAccounts(origin), __classPrivateFieldGet(this, _TransactionController_instances, "m", _TransactionController_getSelectedAccount).call(this).address, txParams.from, origin);
         }
         const dappSuggestedGasFees = this.generateDappSuggestedGasFees(txParams, origin);
@@ -1300,7 +1306,10 @@ class TransactionController extends base_controller_1.BaseController {
             await __classPrivateFieldGet(this, _TransactionController_trace, "f").call(this, { name: 'Publish', parentContext: traceContext }, async () => {
                 ({ transactionHash: hash } = await this.publish(transactionMeta, rawTx));
                 if (hash === undefined) {
-                    hash = await this.publishTransaction(ethQuery, rawTx);
+                    hash = await this.publishTransaction(ethQuery, {
+                        ...transactionMeta,
+                        rawTx,
+                    });
                 }
             });
             (0, logger_1.projectLogger)('Publish successful', hash);
@@ -1334,8 +1343,14 @@ class TransactionController extends base_controller_1.BaseController {
             cleanupTasks.forEach((task) => task());
         }
     }
-    async publishTransaction(ethQuery, rawTransaction) {
-        return await (0, controller_utils_1.query)(ethQuery, 'sendRawTransaction', [rawTransaction]);
+    async publishTransaction(ethQuery, transactionMeta, { skipSubmitHistory } = {}) {
+        const transactionHash = await (0, controller_utils_1.query)(ethQuery, 'sendRawTransaction', [
+            transactionMeta.rawTx,
+        ]);
+        if (skipSubmitHistory !== true) {
+            __classPrivateFieldGet(this, _TransactionController_instances, "m", _TransactionController_updateSubmitHistory).call(this, transactionMeta, transactionHash);
+        }
+        return transactionHash;
     }
     /**
      * Cancels a transaction based on its ID by setting its status to "rejected"
@@ -1742,10 +1757,9 @@ class TransactionController extends base_controller_1.BaseController {
             (0, logger_1.projectLogger)('Error while updating post transaction balance', error);
         }
     }
-    async publishTransactionForRetry(ethQuery, rawTx, transactionMeta) {
+    async publishTransactionForRetry(ethQuery, transactionMeta) {
         try {
-            const hash = await this.publishTransaction(ethQuery, rawTx);
-            return hash;
+            return await this.publishTransaction(ethQuery, transactionMeta);
         }
         catch (error) {
             if (this.isTransactionAlreadyConfirmedError(error)) {
@@ -1809,12 +1823,10 @@ _TransactionController_internalEvents = new WeakMap(), _TransactionController_in
         networkClientId: transactionMeta.networkClientId,
         chainId: transactionMeta.chainId,
     });
-    const hash = await this.publishTransactionForRetry(ethQuery, rawTx, transactionMeta);
     const newTransactionMeta = {
         ...transactionMetaWithRsv,
         actionId,
         estimatedBaseFee,
-        hash,
         id: (0, uuid_1.v1)(),
         originalGasEstimate: transactionMeta.txParams.gas,
         originalType: transactionMeta.type,
@@ -1823,6 +1835,11 @@ _TransactionController_internalEvents = new WeakMap(), _TransactionController_in
         txParams: newTxParams,
         type: transactionType,
     };
+    const hash = await this.publishTransactionForRetry(ethQuery, {
+        ...newTransactionMeta,
+        origin: label,
+    });
+    newTransactionMeta.hash = hash;
     this.addMetadata(newTransactionMeta);
     // speedUpTransaction has no approval request, so we assume the user has already approved the transaction
     this.messagingSystem.publish(`${controllerName}:transactionApproved`, {
@@ -1849,6 +1866,7 @@ _TransactionController_internalEvents = new WeakMap(), _TransactionController_in
         blockTracker,
         getCurrentAccount: () => __classPrivateFieldGet(this, _TransactionController_instances, "m", _TransactionController_getSelectedAccount).call(this),
         getLastFetchedBlockNumbers: () => this.state.lastFetchedBlockNumbers,
+        getLocalTransactions: () => this.state.transactions,
         getChainId: chainId ? () => chainId : this.getChainId.bind(this),
         isEnabled: __classPrivateFieldGet(this, _TransactionController_incomingTransactionOptions, "f").isEnabled,
         queryEntireHistory: __classPrivateFieldGet(this, _TransactionController_incomingTransactionOptions, "f").queryEntireHistory,
@@ -1870,7 +1888,9 @@ _TransactionController_internalEvents = new WeakMap(), _TransactionController_in
         getGlobalLock: () => __classPrivateFieldGet(this, _TransactionController_multichainTrackingHelper, "f").acquireNonceLockForChainIdKey({
             chainId: getChainId(),
         }),
-        publishTransaction: this.publishTransaction.bind(this),
+        publishTransaction: (_ethQuery, transactionMeta) => this.publishTransaction(_ethQuery, transactionMeta, {
+            skipSubmitHistory: true,
+        }),
         hooks: {
             beforeCheckPendingTransaction: this.beforeCheckPendingTransaction.bind(this),
             beforePublish: this.beforePublish.bind(this),
@@ -2022,5 +2042,30 @@ _TransactionController_internalEvents = new WeakMap(), _TransactionController_in
     return (this.messagingSystem.call(`NetworkController:getNetworkClientById`, networkClientId).configuration.type === network_controller_1.NetworkClientType.Custom);
 }, _TransactionController_getSelectedAccount = function _TransactionController_getSelectedAccount() {
     return this.messagingSystem.call('AccountsController:getSelectedAccount');
+}, _TransactionController_updateSubmitHistory = function _TransactionController_updateSubmitHistory(transactionMeta, hash) {
+    const { chainId, networkClientId, origin, rawTx, txParams } = transactionMeta;
+    const { networkConfigurationsByChainId } = this.getNetworkState();
+    const networkConfiguration = networkConfigurationsByChainId[chainId];
+    const endpoint = networkConfiguration?.rpcEndpoints.find((currentEndpoint) => currentEndpoint.networkClientId === networkClientId);
+    const networkUrl = endpoint?.url;
+    const networkType = endpoint?.name ?? networkClientId;
+    const submitHistoryEntry = {
+        chainId,
+        hash,
+        networkType,
+        networkUrl,
+        origin,
+        rawTransaction: rawTx,
+        time: Date.now(),
+        transaction: txParams,
+    };
+    (0, logger_1.projectLogger)('Updating submit history', submitHistoryEntry);
+    this.update((state) => {
+        const { submitHistory } = state;
+        if (submitHistory.length === SUBMIT_HISTORY_LIMIT) {
+            submitHistory.pop();
+        }
+        submitHistory.unshift(submitHistoryEntry);
+    });
 };
 //# sourceMappingURL=TransactionController.cjs.map