@metamask-previews/transaction-controller 39.1.0-preview-fd7ad7de → 40.0.0-preview-e6722625

package/CHANGELOG.md

@@ -7,6 +7,12 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [40.0.0]
+
+### Changed
+
+- **BREAKING:** Bump `@metamask/accounts-controller` peer dependency from `^19.0.0` to `^20.0.0` ([#4195](https://github.com/MetaMask/core/pull/4956))
+
 ## [39.1.0]
 
 ### Changed
@@ -1127,7 +1133,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@39.1.0...HEAD
+[Unreleased]: https://github.com/MetaMask/core/compare/@metamask/transaction-controller@40.0.0...HEAD
+[40.0.0]: https://github.com/MetaMask/core/compare/@metamask/transaction-controller@39.1.0...@metamask/transaction-controller@40.0.0
 [39.1.0]: https://github.com/MetaMask/core/compare/@metamask/transaction-controller@39.0.0...@metamask/transaction-controller@39.1.0
 [39.0.0]: https://github.com/MetaMask/core/compare/@metamask/transaction-controller@38.3.0...@metamask/transaction-controller@39.0.0
 [38.3.0]: https://github.com/MetaMask/core/compare/@metamask/transaction-controller@38.2.0...@metamask/transaction-controller@38.3.0

package/dist/TransactionController.cjs

@@ -36,7 +36,7 @@ const LineaGasFeeFlow_1 = require("./gas-flows/LineaGasFeeFlow.cjs");
 const OptimismLayer1GasFeeFlow_1 = require("./gas-flows/OptimismLayer1GasFeeFlow.cjs");
 const ScrollLayer1GasFeeFlow_1 = require("./gas-flows/ScrollLayer1GasFeeFlow.cjs");
 const TestGasFeeFlow_1 = require("./gas-flows/TestGasFeeFlow.cjs");
-const AccountsApiRemoteTransactionSource_1 = require("./helpers/AccountsApiRemoteTransactionSource.cjs");
+const EtherscanRemoteTransactionSource_1 = require("./helpers/EtherscanRemoteTransactionSource.cjs");
 const GasFeePoller_1 = require("./helpers/GasFeePoller.cjs");
 const IncomingTransactionHelper_1 = require("./helpers/IncomingTransactionHelper.cjs");
 const MultichainTrackingHelper_1 = require("./helpers/MultichainTrackingHelper.cjs");
@@ -70,7 +70,7 @@ const metadata = {
         persist: true,
         anonymous: false,
     },
-    lastFetchedTimestamps: {
+    lastFetchedBlockNumbers: {
         persist: true,
         anonymous: false,
     },
@@ -111,7 +111,7 @@ function getDefaultTransactionControllerState() {
     return {
         methodData: {},
         transactions: [],
-        lastFetchedTimestamps: {},
+        lastFetchedBlockNumbers: {},
         submitHistory: [],
     };
 }
@@ -263,20 +263,30 @@ class TransactionController extends base_controller_1.BaseController {
             isMultichainEnabled,
             provider,
             nonceTracker: this.nonceTracker,
+            incomingTransactionOptions: incomingTransactions,
             findNetworkClientIdByChainId,
             getNetworkClientById: ((networkClientId) => {
                 return this.messagingSystem.call(`NetworkController:getNetworkClientById`, networkClientId);
             }),
             getNetworkClientRegistry,
+            removeIncomingTransactionHelperListeners: __classPrivateFieldGet(this, _TransactionController_instances, "m", _TransactionController_removeIncomingTransactionHelperListeners).bind(this),
             removePendingTransactionTrackerListeners: __classPrivateFieldGet(this, _TransactionController_instances, "m", _TransactionController_removePendingTransactionTrackerListeners).bind(this),
             createNonceTracker: __classPrivateFieldGet(this, _TransactionController_instances, "m", _TransactionController_createNonceTracker).bind(this),
+            createIncomingTransactionHelper: __classPrivateFieldGet(this, _TransactionController_instances, "m", _TransactionController_createIncomingTransactionHelper).bind(this),
             createPendingTransactionTracker: __classPrivateFieldGet(this, _TransactionController_instances, "m", _TransactionController_createPendingTransactionTracker).bind(this),
             onNetworkStateChange: (listener) => {
                 this.messagingSystem.subscribe('NetworkController:stateChange', listener);
             },
         }), "f");
         __classPrivateFieldGet(this, _TransactionController_multichainTrackingHelper, "f").initialize();
-        this.incomingTransactionHelper = __classPrivateFieldGet(this, _TransactionController_instances, "m", _TransactionController_createIncomingTransactionHelper).call(this);
+        const etherscanRemoteTransactionSource = new EtherscanRemoteTransactionSource_1.EtherscanRemoteTransactionSource({
+            apiKeysByChainId: incomingTransactions.etherscanApiKeysByChainId,
+            includeTokenTransfers: incomingTransactions.includeTokenTransfers,
+        });
+        this.incomingTransactionHelper = __classPrivateFieldGet(this, _TransactionController_instances, "m", _TransactionController_createIncomingTransactionHelper).call(this, {
+            blockTracker,
+            etherscanRemoteTransactionSource,
+        });
         this.pendingTransactionTracker = __classPrivateFieldGet(this, _TransactionController_instances, "m", _TransactionController_createPendingTransactionTracker).call(this, {
             provider,
             blockTracker,
@@ -453,20 +463,27 @@ class TransactionController extends base_controller_1.BaseController {
     startIncomingTransactionPolling(networkClientIds = []) {
         if (networkClientIds.length === 0) {
             this.incomingTransactionHelper.start();
+            return;
         }
+        __classPrivateFieldGet(this, _TransactionController_multichainTrackingHelper, "f").startIncomingTransactionPolling(networkClientIds);
     }
     stopIncomingTransactionPolling(networkClientIds = []) {
         if (networkClientIds.length === 0) {
             this.incomingTransactionHelper.stop();
+            return;
         }
+        __classPrivateFieldGet(this, _TransactionController_multichainTrackingHelper, "f").stopIncomingTransactionPolling(networkClientIds);
     }
     stopAllIncomingTransactionPolling() {
         this.incomingTransactionHelper.stop();
+        __classPrivateFieldGet(this, _TransactionController_multichainTrackingHelper, "f").stopAllIncomingTransactionPolling();
     }
     async updateIncomingTransactions(networkClientIds = []) {
         if (networkClientIds.length === 0) {
             await this.incomingTransactionHelper.update();
+            return;
         }
+        await __classPrivateFieldGet(this, _TransactionController_multichainTrackingHelper, "f").updateIncomingTransactions(networkClientIds);
     }
     /**
      * Attempts to cancel a transaction based on its ID by setting its status to "rejected"
@@ -594,45 +611,23 @@ class TransactionController extends base_controller_1.BaseController {
      * wiped on current network.
      */
     wipeTransactions(ignoreNetwork, address) {
-        (0, logger_1.projectLogger)('Wiping transactions', { ignoreNetwork, address });
         /* istanbul ignore next */
         if (ignoreNetwork && !address) {
             this.update((state) => {
                 state.transactions = [];
-                state.lastFetchedTimestamps = {};
             });
             return;
         }
         const currentChainId = this.getChainId();
-        const { lastFetchedTimestamps, transactions } = this.state;
-        const newTransactions = transactions.filter((tx) => {
-            const { chainId, txParams } = tx;
+        const newTransactions = this.state.transactions.filter(({ chainId, txParams }) => {
             const isMatchingNetwork = ignoreNetwork || chainId === currentChainId;
             if (!isMatchingNetwork) {
                 return true;
             }
-            const isMatchingAddress = !address ||
-                txParams.from?.toLowerCase() === address.toLowerCase() ||
-                txParams.to?.toLowerCase() === address.toLowerCase();
-            if (isMatchingAddress) {
-                (0, logger_1.projectLogger)('Removing transaction', tx);
-            }
+            const isMatchingAddress = !address || txParams.from?.toLowerCase() === address.toLowerCase();
             return !isMatchingAddress;
         });
-        const newLastFetchedTimestamps = Object.keys(lastFetchedTimestamps).reduce((acc, key) => {
-            const timestamp = lastFetchedTimestamps[key];
-            const isMatchingNetwork = ignoreNetwork || key.startsWith(`${currentChainId}#`);
-            const isMatchingAddress = !address || key.endsWith(`#${address.toLowerCase()}`);
-            if (!isMatchingNetwork || !isMatchingAddress) {
-                acc[key] = timestamp;
-            }
-            else {
-                (0, logger_1.projectLogger)('Removing last fetched timestamp', { key, timestamp });
-            }
-            return acc;
-        }, {});
         this.update((state) => {
-            state.lastFetchedTimestamps = newLastFetchedTimestamps;
             state.transactions = this.trimTransactionsForState(newTransactions);
         });
     }
@@ -1523,20 +1518,24 @@ class TransactionController extends base_controller_1.BaseController {
         };
         return common_1.Common.custom(customChainParams);
     }
-    onIncomingTransactions(incomingTransactions) {
+    onIncomingTransactions({ added, updated, }) {
         this.update((state) => {
             const { transactions: currentTransactions } = state;
-            state.transactions = this.trimTransactionsForState([
-                ...incomingTransactions,
-                ...currentTransactions,
-            ]);
+            const updatedTransactions = [
+                ...added,
+                ...currentTransactions.map((originalTransaction) => {
+                    const updatedTransaction = updated.find(({ hash }) => hash === originalTransaction.hash);
+                    return updatedTransaction ?? originalTransaction;
+                }),
+            ];
+            state.transactions = this.trimTransactionsForState(updatedTransactions);
         });
-        this.messagingSystem.publish(`${controllerName}:incomingTransactionsReceived`, incomingTransactions);
     }
-    onUpdatedLastFetchedTimestamp({ key, timestamp, }) {
+    onUpdatedLastFetchedBlockNumbers({ lastFetchedBlockNumbers, blockNumber, }) {
         this.update((state) => {
-            state.lastFetchedTimestamps[key] = timestamp;
+            state.lastFetchedBlockNumbers = lastFetchedBlockNumbers;
         });
+        this.messagingSystem.publish(`${controllerName}:incomingTransactionBlockReceived`, blockNumber);
     }
     generateDappSuggestedGasFees(txParams, origin) {
         if (!origin || origin === controller_utils_1.ORIGIN_METAMASK) {
@@ -1863,14 +1862,18 @@ _TransactionController_internalEvents = new WeakMap(), _TransactionController_in
         getPendingTransactions: __classPrivateFieldGet(this, _TransactionController_instances, "m", _TransactionController_getNonceTrackerPendingTransactions).bind(this, chainId),
         getConfirmedTransactions: this.getNonceTrackerTransactions.bind(this, types_1.TransactionStatus.confirmed),
     });
-}, _TransactionController_createIncomingTransactionHelper = function _TransactionController_createIncomingTransactionHelper({ chainId, } = {}) {
+}, _TransactionController_createIncomingTransactionHelper = function _TransactionController_createIncomingTransactionHelper({ blockTracker, etherscanRemoteTransactionSource, chainId, }) {
     const incomingTransactionHelper = new IncomingTransactionHelper_1.IncomingTransactionHelper({
+        blockTracker,
         getCurrentAccount: () => __classPrivateFieldGet(this, _TransactionController_instances, "m", _TransactionController_getSelectedAccount).call(this),
-        getLastFetchedTimestamps: () => this.state.lastFetchedTimestamps,
-        getChainIds: chainId ? () => [chainId] : () => [this.getChainId()],
+        getLastFetchedBlockNumbers: () => this.state.lastFetchedBlockNumbers,
+        getLocalTransactions: () => this.state.transactions,
+        getChainId: chainId ? () => chainId : this.getChainId.bind(this),
         isEnabled: __classPrivateFieldGet(this, _TransactionController_incomingTransactionOptions, "f").isEnabled,
-        remoteTransactionSource: new AccountsApiRemoteTransactionSource_1.AccountsApiRemoteTransactionSource(),
+        queryEntireHistory: __classPrivateFieldGet(this, _TransactionController_incomingTransactionOptions, "f").queryEntireHistory,
+        remoteTransactionSource: etherscanRemoteTransactionSource,
         transactionLimit: __classPrivateFieldGet(this, _TransactionController_transactionHistoryLimit, "f"),
+        updateTransactions: __classPrivateFieldGet(this, _TransactionController_incomingTransactionOptions, "f").updateTransactions,
     });
     __classPrivateFieldGet(this, _TransactionController_instances, "m", _TransactionController_addIncomingTransactionHelperListeners).call(this, incomingTransactionHelper);
     return incomingTransactionHelper;
@@ -1903,11 +1906,11 @@ _TransactionController_internalEvents = new WeakMap(), _TransactionController_in
     __classPrivateFieldGet(this, _TransactionController_instances, "m", _TransactionController_removeIncomingTransactionHelperListeners).call(this, this.incomingTransactionHelper);
     __classPrivateFieldGet(this, _TransactionController_multichainTrackingHelper, "f").stopAllTracking();
 }, _TransactionController_removeIncomingTransactionHelperListeners = function _TransactionController_removeIncomingTransactionHelperListeners(incomingTransactionHelper) {
-    incomingTransactionHelper.hub.removeAllListeners('incoming-transactions');
-    incomingTransactionHelper.hub.removeAllListeners('updated-last-fetched-timestamp');
+    incomingTransactionHelper.hub.removeAllListeners('transactions');
+    incomingTransactionHelper.hub.removeAllListeners('updatedLastFetchedBlockNumbers');
 }, _TransactionController_addIncomingTransactionHelperListeners = function _TransactionController_addIncomingTransactionHelperListeners(incomingTransactionHelper) {
-    incomingTransactionHelper.hub.on('incoming-transactions', this.onIncomingTransactions.bind(this));
-    incomingTransactionHelper.hub.on('updated-last-fetched-timestamp', this.onUpdatedLastFetchedTimestamp.bind(this));
+    incomingTransactionHelper.hub.on('transactions', this.onIncomingTransactions.bind(this));
+    incomingTransactionHelper.hub.on('updatedLastFetchedBlockNumbers', this.onUpdatedLastFetchedBlockNumbers.bind(this));
 }, _TransactionController_removePendingTransactionTrackerListeners = function _TransactionController_removePendingTransactionTrackerListeners(pendingTransactionTracker) {
     pendingTransactionTracker.hub.removeAllListeners('transaction-confirmed');
     pendingTransactionTracker.hub.removeAllListeners('transaction-dropped');