@metamask/transaction-controller 41.0.0 → 42.0.0

package/CHANGELOG.md

@@ -7,6 +7,58 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [42.0.0]
+
+### Added
+
+- Retrieve incoming transactions using Accounts API ([#4927](https://github.com/MetaMask/core/pull/4927))
+  - Add `INCOMING_TRANSACTIONS_SUPPORTED_CHAIN_IDS` constant.
+
+### Changed
+
+- **BREAKING:** Retrieve incoming transactions using Accounts API ([#4927](https://github.com/MetaMask/core/pull/4927))
+  - Rename `TransactionControllerIncomingTransactionBlockReceivedEvent` to `TransactionControllerIncomingTransactionsReceivedEvent`.
+  - Replace `networkClientIds` argument with `chainIds` in following methods:
+    - `startIncomingTransactionPolling`
+    - `stopIncomingTransactionPolling`
+    - `updateIncomingTransactions`
+- Bump `@metamask/eth-block-tracker` from `^11.0.2` to `^11.0.3` ([#5025](https://github.com/MetaMask/core/pull/5025))
+
+### Removed
+
+- **BREAKING:** Retrieve incoming transactions using Accounts API ([#4927](https://github.com/MetaMask/core/pull/4927))
+  - Remove `ETHERSCAN_SUPPORTED_NETWORKS` constant.
+  - Remove types:
+    - `EtherscanTransactionMeta`
+    - `RemoteTransactionSource`
+    - `RemoteTransactionSourceRequest`
+
+## [41.1.0]
+
+### Added
+
+- Add optional `destinationChainId` property to `TransactionMeta` to facilitate Bridge transactions ([#4988](https://github.com/MetaMask/core/pull/4988))
+
+### Changed
+
+- Bump `@metamask/controller-utils` from `^11.4.3` to `^11.4.4` ([#5012](https://github.com/MetaMask/core/pull/5012))
+
+### Fixed
+
+- Make implicit peer dependencies explicit ([#4974](https://github.com/MetaMask/core/pull/4974))
+  - Add the following packages as peer dependencies of this package to satisfy peer dependency requirements from other dependencies:
+    - `@babel/runtime` `^7.0.0` (required by `@metamask/ethjs-provider-http`)
+    - `@metamask/eth-block-tracker` `>=9` (required by `@metamask/nonce-tracker`)
+  - These dependencies really should be present in projects that consume this package (e.g. MetaMask clients), and this change ensures that they now are.
+  - Furthermore, we are assuming that clients already use these dependencies, since otherwise it would be impossible to consume this package in its entirety or even create a working build. Hence, the addition of these peer dependencies is really a formality and should not be breaking.
+- Correct ESM-compatible build so that imports of the following packages that re-export other modules via `export *` are no longer corrupted: ([#5011](https://github.com/MetaMask/core/pull/5011))
+  - `@ethereumjs/common`
+  - `@ethereumjs/util`
+  - `@metamask/eth-query`
+  - `bn.js`
+  - `fast-json-patch`
+  - `lodash`
+
 ## [41.0.0]
 
 ### Added
@@ -1163,7 +1215,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@41.0.0...HEAD
+[Unreleased]: https://github.com/MetaMask/core/compare/@metamask/transaction-controller@42.0.0...HEAD
+[42.0.0]: https://github.com/MetaMask/core/compare/@metamask/transaction-controller@41.1.0...@metamask/transaction-controller@42.0.0
+[41.1.0]: https://github.com/MetaMask/core/compare/@metamask/transaction-controller@41.0.0...@metamask/transaction-controller@41.1.0
 [41.0.0]: https://github.com/MetaMask/core/compare/@metamask/transaction-controller@40.1.0...@metamask/transaction-controller@41.0.0
 [40.1.0]: https://github.com/MetaMask/core/compare/@metamask/transaction-controller@40.0.0...@metamask/transaction-controller@40.1.0
 [40.0.0]: https://github.com/MetaMask/core/compare/@metamask/transaction-controller@39.1.0...@metamask/transaction-controller@40.0.0

package/README.md

@@ -10,6 +10,10 @@ or
 
 `npm install @metamask/transaction-controller`
 
+## Compatibility
+
+This package relies implicitly upon the `EventEmitter` module. This module is available natively in Node.js, but when using this package for the browser, make sure to use a polyfill such as `events`.
+
 ## Contributing
 
 This package is part of a monorepo. Instructions for contributing can be found in the [monorepo README](https://github.com/MetaMask/core#readme).

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_methodDataHelper, _TransactionController_incomingTransactionOptions, _TransactionController_pendingTransactionOptions, _TransactionController_trace, _TransactionController_transactionHistoryLimit, _TransactionController_isFirstTimeInteractionEnabled, _TransactionController_isSimulationEnabled, _TransactionController_testGasFeeFlows, _TransactionController_multichainTrackingHelper, _TransactionController_retryTransaction, _TransactionController_getChainId, _TransactionController_getNetworkClientId, _TransactionController_getEthQuery, _TransactionController_getProvider, _TransactionController_createNonceTracker, _TransactionController_createRemoteTransactionSource, _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_updateFirstTimeInteraction, _TransactionController_updateSimulationData, _TransactionController_onGasFeePollerTransactionUpdate, _TransactionController_getSelectedAccount, _TransactionController_updateSubmitHistory;
+var _TransactionController_instances, _TransactionController_internalEvents, _TransactionController_methodDataHelper, _TransactionController_incomingTransactionChainIds, _TransactionController_incomingTransactionHelper, _TransactionController_incomingTransactionOptions, _TransactionController_pendingTransactionOptions, _TransactionController_trace, _TransactionController_transactionHistoryLimit, _TransactionController_isFirstTimeInteractionEnabled, _TransactionController_isSimulationEnabled, _TransactionController_testGasFeeFlows, _TransactionController_multichainTrackingHelper, _TransactionController_retryTransaction, _TransactionController_getChainId, _TransactionController_getNetworkClientId, _TransactionController_getEthQuery, _TransactionController_getProvider, _TransactionController_createNonceTracker, _TransactionController_createPendingTransactionTracker, _TransactionController_checkForPendingTransactionAndStartPolling, _TransactionController_stopAllTracking, _TransactionController_removeIncomingTransactionHelperListeners, _TransactionController_addIncomingTransactionHelperListeners, _TransactionController_removePendingTransactionTrackerListeners, _TransactionController_addPendingTransactionTrackerListeners, _TransactionController_getNonceTrackerPendingTransactions, _TransactionController_getGasFeeFlows, _TransactionController_getLayer1GasFeeFlows, _TransactionController_updateTransactionInternal, _TransactionController_updateFirstTimeInteraction, _TransactionController_updateSimulationData, _TransactionController_onGasFeePollerTransactionUpdate, _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");
@@ -27,6 +27,8 @@ const nonce_tracker_1 = require("@metamask/nonce-tracker");
 const rpc_errors_1 = require("@metamask/rpc-errors");
 const utils_1 = require("@metamask/utils");
 const async_mutex_1 = require("async-mutex");
+// This package purposefully relies on Node's EventEmitter module.
+// eslint-disable-next-line import/no-nodejs-modules
 const events_1 = require("events");
 const lodash_1 = require("lodash");
 const uuid_1 = require("uuid");
@@ -36,7 +38,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 EtherscanRemoteTransactionSource_1 = require("./helpers/EtherscanRemoteTransactionSource.cjs");
+const AccountsApiRemoteTransactionSource_1 = require("./helpers/AccountsApiRemoteTransactionSource.cjs");
 const GasFeePoller_1 = require("./helpers/GasFeePoller.cjs");
 const IncomingTransactionHelper_1 = require("./helpers/IncomingTransactionHelper.cjs");
 const MethodDataHelper_1 = require("./helpers/MethodDataHelper.cjs");
@@ -192,6 +194,8 @@ class TransactionController extends base_controller_1.BaseController {
         this.approvingTransactionIds = new Set();
         _TransactionController_methodDataHelper.set(this, void 0);
         this.mutex = new async_mutex_1.Mutex();
+        _TransactionController_incomingTransactionChainIds.set(this, new Set());
+        _TransactionController_incomingTransactionHelper.set(this, void 0);
         _TransactionController_incomingTransactionOptions.set(this, void 0);
         _TransactionController_pendingTransactionOptions.set(this, void 0);
         this.signAbortCallbacks = new Map();
@@ -247,12 +251,9 @@ class TransactionController extends base_controller_1.BaseController {
                 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),
-            createRemoteTransactionSource: __classPrivateFieldGet(this, _TransactionController_instances, "m", _TransactionController_createRemoteTransactionSource).bind(this),
             onNetworkStateChange: (listener) => {
                 this.messagingSystem.subscribe('NetworkController:stateChange', listener);
             },
@@ -281,6 +282,25 @@ class TransactionController extends base_controller_1.BaseController {
                 _state.methodData[fourBytePrefix] = methodData;
             });
         });
+        const updateCache = (fn) => {
+            this.update((_state) => {
+                fn(_state.lastFetchedBlockNumbers);
+            });
+        };
+        __classPrivateFieldSet(this, _TransactionController_incomingTransactionHelper, new IncomingTransactionHelper_1.IncomingTransactionHelper({
+            getCache: () => this.state.lastFetchedBlockNumbers,
+            getChainIds: () => [...__classPrivateFieldGet(this, _TransactionController_incomingTransactionChainIds, "f")],
+            getCurrentAccount: () => __classPrivateFieldGet(this, _TransactionController_instances, "m", _TransactionController_getSelectedAccount).call(this),
+            getLocalTransactions: () => this.state.transactions,
+            includeTokenTransfers: __classPrivateFieldGet(this, _TransactionController_incomingTransactionOptions, "f").includeTokenTransfers,
+            isEnabled: __classPrivateFieldGet(this, _TransactionController_incomingTransactionOptions, "f").isEnabled,
+            queryEntireHistory: __classPrivateFieldGet(this, _TransactionController_incomingTransactionOptions, "f").queryEntireHistory,
+            remoteTransactionSource: new AccountsApiRemoteTransactionSource_1.AccountsApiRemoteTransactionSource(),
+            trimTransactions: this.trimTransactionsForState.bind(this),
+            updateCache,
+            updateTransactions: __classPrivateFieldGet(this, _TransactionController_incomingTransactionOptions, "f").updateTransactions,
+        }), "f");
+        __classPrivateFieldGet(this, _TransactionController_instances, "m", _TransactionController_addIncomingTransactionHelperListeners).call(this, __classPrivateFieldGet(this, _TransactionController_incomingTransactionHelper, "f"));
         // when transactionsController state changes
         // check for pending transactions and start polling if there are any
         this.messagingSystem.subscribe('TransactionController:stateChange', __classPrivateFieldGet(this, _TransactionController_checkForPendingTransactionAndStartPolling, "f"));
@@ -417,14 +437,22 @@ class TransactionController extends base_controller_1.BaseController {
             transactionMeta: addedTransactionMeta,
         };
     }
-    startIncomingTransactionPolling(networkClientIds) {
-        __classPrivateFieldGet(this, _TransactionController_multichainTrackingHelper, "f").startIncomingTransactionPolling(networkClientIds);
+    startIncomingTransactionPolling(chainIds) {
+        chainIds.forEach((chainId) => __classPrivateFieldGet(this, _TransactionController_incomingTransactionChainIds, "f").add(chainId));
+        __classPrivateFieldGet(this, _TransactionController_incomingTransactionHelper, "f").start();
     }
-    stopIncomingTransactionPolling(networkClientIds) {
-        __classPrivateFieldGet(this, _TransactionController_multichainTrackingHelper, "f").stopIncomingTransactionPolling(networkClientIds);
+    stopIncomingTransactionPolling(chainIds) {
+        chainIds?.forEach((chainId) => __classPrivateFieldGet(this, _TransactionController_incomingTransactionChainIds, "f").delete(chainId));
+        if (!chainIds) {
+            __classPrivateFieldGet(this, _TransactionController_incomingTransactionChainIds, "f").clear();
+        }
+        if (__classPrivateFieldGet(this, _TransactionController_incomingTransactionChainIds, "f").size === 0) {
+            __classPrivateFieldGet(this, _TransactionController_incomingTransactionHelper, "f").stop();
+        }
     }
-    async updateIncomingTransactions(networkClientIds = []) {
-        await __classPrivateFieldGet(this, _TransactionController_multichainTrackingHelper, "f").updateIncomingTransactions(networkClientIds);
+    async updateIncomingTransactions(chainIds) {
+        chainIds.forEach((chainId) => __classPrivateFieldGet(this, _TransactionController_incomingTransactionChainIds, "f").add(chainId));
+        await __classPrivateFieldGet(this, _TransactionController_incomingTransactionHelper, "f").update();
     }
     /**
      * Attempts to cancel a transaction based on its ID by setting its status to "rejected"
@@ -1421,26 +1449,27 @@ class TransactionController extends base_controller_1.BaseController {
         };
         return common_1.Common.custom(customChainParams);
     }
-    onIncomingTransactions({ added, updated, }) {
-        this.update((state) => {
-            const { transactions } = state;
-            const existingTransactions = transactions.map((tx) => updated.find(({ hash }) => hash === tx.hash) ?? tx);
-            const updatedTransactions = [...added, ...existingTransactions].map((tx) => {
-                const { chainId } = tx;
-                const networkClientId = __classPrivateFieldGet(this, _TransactionController_instances, "m", _TransactionController_getNetworkClientId).call(this, { chainId });
-                return {
-                    ...tx,
-                    networkClientId,
-                };
-            });
-            state.transactions = this.trimTransactionsForState(updatedTransactions);
+    onIncomingTransactions(transactions) {
+        if (!transactions.length) {
+            return;
+        }
+        const finalTransactions = transactions.map((tx) => {
+            const { chainId } = tx;
+            const networkClientId = __classPrivateFieldGet(this, _TransactionController_instances, "m", _TransactionController_getNetworkClientId).call(this, { chainId });
+            return {
+                ...tx,
+                networkClientId,
+            };
         });
-    }
-    onUpdatedLastFetchedBlockNumbers({ lastFetchedBlockNumbers, blockNumber, }) {
         this.update((state) => {
-            state.lastFetchedBlockNumbers = lastFetchedBlockNumbers;
+            const { transactions: currentTransactions } = state;
+            state.transactions = this.trimTransactionsForState([
+                ...finalTransactions,
+                ...currentTransactions,
+            ]);
+            (0, logger_1.projectLogger)('Added incoming transactions to state', finalTransactions.length, finalTransactions);
         });
-        this.messagingSystem.publish(`${controllerName}:incomingTransactionBlockReceived`, blockNumber);
+        this.messagingSystem.publish(`${controllerName}:incomingTransactionsReceived`, finalTransactions);
     }
     generateDappSuggestedGasFees(txParams, origin) {
         if (!origin || origin === controller_utils_1.ORIGIN_METAMASK) {
@@ -1687,7 +1716,7 @@ class TransactionController extends base_controller_1.BaseController {
     }
 }
 exports.TransactionController = TransactionController;
-_TransactionController_internalEvents = new WeakMap(), _TransactionController_methodDataHelper = new WeakMap(), _TransactionController_incomingTransactionOptions = new WeakMap(), _TransactionController_pendingTransactionOptions = new WeakMap(), _TransactionController_trace = new WeakMap(), _TransactionController_transactionHistoryLimit = new WeakMap(), _TransactionController_isFirstTimeInteractionEnabled = new WeakMap(), _TransactionController_isSimulationEnabled = new WeakMap(), _TransactionController_testGasFeeFlows = new WeakMap(), _TransactionController_multichainTrackingHelper = new WeakMap(), _TransactionController_checkForPendingTransactionAndStartPolling = new WeakMap(), _TransactionController_instances = new WeakSet(), _TransactionController_retryTransaction = async function _TransactionController_retryTransaction({ actionId, afterSubmit, estimatedBaseFee, gasValues, label, prepareTransactionParams, rate, transactionId, transactionType, }) {
+_TransactionController_internalEvents = new WeakMap(), _TransactionController_methodDataHelper = new WeakMap(), _TransactionController_incomingTransactionChainIds = new WeakMap(), _TransactionController_incomingTransactionHelper = new WeakMap(), _TransactionController_incomingTransactionOptions = new WeakMap(), _TransactionController_pendingTransactionOptions = new WeakMap(), _TransactionController_trace = new WeakMap(), _TransactionController_transactionHistoryLimit = new WeakMap(), _TransactionController_isFirstTimeInteractionEnabled = new WeakMap(), _TransactionController_isSimulationEnabled = new WeakMap(), _TransactionController_testGasFeeFlows = new WeakMap(), _TransactionController_multichainTrackingHelper = new WeakMap(), _TransactionController_checkForPendingTransactionAndStartPolling = new WeakMap(), _TransactionController_instances = new WeakSet(), _TransactionController_retryTransaction = async function _TransactionController_retryTransaction({ actionId, afterSubmit, estimatedBaseFee, gasValues, label, prepareTransactionParams, rate, transactionId, transactionType, }) {
     // If transaction is found for same action id, do not create a new transaction.
     if (this.getTransactionWithActionId(actionId)) {
         return;
@@ -1779,26 +1808,6 @@ _TransactionController_internalEvents = new WeakMap(), _TransactionController_me
         getPendingTransactions: __classPrivateFieldGet(this, _TransactionController_instances, "m", _TransactionController_getNonceTrackerPendingTransactions).bind(this, chainId),
         getConfirmedTransactions: this.getNonceTrackerTransactions.bind(this, types_1.TransactionStatus.confirmed, chainId),
     });
-}, _TransactionController_createRemoteTransactionSource = function _TransactionController_createRemoteTransactionSource() {
-    return new EtherscanRemoteTransactionSource_1.EtherscanRemoteTransactionSource({
-        apiKeysByChainId: __classPrivateFieldGet(this, _TransactionController_incomingTransactionOptions, "f").etherscanApiKeysByChainId,
-        includeTokenTransfers: __classPrivateFieldGet(this, _TransactionController_incomingTransactionOptions, "f").includeTokenTransfers,
-    });
-}, _TransactionController_createIncomingTransactionHelper = function _TransactionController_createIncomingTransactionHelper({ blockTracker, remoteTransactionSource, chainId, }) {
-    const incomingTransactionHelper = new IncomingTransactionHelper_1.IncomingTransactionHelper({
-        blockTracker,
-        getCurrentAccount: () => __classPrivateFieldGet(this, _TransactionController_instances, "m", _TransactionController_getSelectedAccount).call(this),
-        getLastFetchedBlockNumbers: () => this.state.lastFetchedBlockNumbers,
-        getLocalTransactions: () => this.state.transactions,
-        getChainId: () => chainId,
-        isEnabled: __classPrivateFieldGet(this, _TransactionController_incomingTransactionOptions, "f").isEnabled,
-        queryEntireHistory: __classPrivateFieldGet(this, _TransactionController_incomingTransactionOptions, "f").queryEntireHistory,
-        remoteTransactionSource,
-        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;
 }, _TransactionController_createPendingTransactionTracker = function _TransactionController_createPendingTransactionTracker({ provider, blockTracker, chainId, }) {
     const ethQuery = new eth_query_1.default(provider);
     const pendingTransactionTracker = new PendingTransactionTracker_1.PendingTransactionTracker({
@@ -1824,10 +1833,9 @@ _TransactionController_internalEvents = new WeakMap(), _TransactionController_me
     __classPrivateFieldGet(this, _TransactionController_multichainTrackingHelper, "f").stopAllTracking();
 }, _TransactionController_removeIncomingTransactionHelperListeners = function _TransactionController_removeIncomingTransactionHelperListeners(incomingTransactionHelper) {
     incomingTransactionHelper.hub.removeAllListeners('transactions');
-    incomingTransactionHelper.hub.removeAllListeners('updatedLastFetchedBlockNumbers');
+    incomingTransactionHelper.hub.removeAllListeners('updated-last-fetched-timestamp');
 }, _TransactionController_addIncomingTransactionHelperListeners = function _TransactionController_addIncomingTransactionHelperListeners(incomingTransactionHelper) {
     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');