@metamask-previews/assets-controllers 25.0.0-preview.83a88a4 → 25.0.0-preview.bc4dd941

package/CHANGELOG.md

@@ -7,6 +7,26 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+### Added
+
+- **BREAKING:** Adds `@metamask/accounts-controller` ^8.0.0 and `@metamask/keyring-controller` ^12.0.0 as dependencies and peer dependencies. ([#3775](https://github.com/MetaMask/core/pull/3775/)).
+- **BREAKING:** `TokenDetectionController` newly subscribes to the `PreferencesController:stateChange`, `AccountsController:selectedAccountChange`, `KeyringController:lock`, `KeyringController:unlock` events, and allows the `PreferencesController:getState` messenger action. ([#3775](https://github.com/MetaMask/core/pull/3775/))
+
+### Changed
+
+- **BREAKING:** `TokenDetectionController` is merged with `DetectTokensController` from the `metamask-extension` repo. ([#3775](https://github.com/MetaMask/core/pull/3775/))
+  - **BREAKING:** `TokenDetectionController` now resets its polling interval to the default value of 3 minutes when token detection is triggered by external controller events `KeyringController:unlock`, `TokenListController:stateChange`, `PreferencesController:stateChange`, `AccountsController:selectedAccountChange`.
+  - **BREAKING:** `TokenDetectionController` now refetches tokens on `NetworkController:networkDidChange` if the `networkClientId` is changed instead of `chainId`.
+  - **BREAKING:** `TokenDetectionController` cannot initiate polling or token detection if `KeyringController` state is locked.
+  - **BREAKING:** The `detectTokens` method now excludes tokens that are already included in the `TokensController`'s `detectedTokens` list from the batch of incoming tokens it sends to the `TokensController` `addDetectedTokens` method.
+  - **BREAKING:** The constructor for `TokenDetectionController` expects a new required proprerty `trackMetaMetricsEvent`, which defines the callback that is called in the `detectTokens` method.
+  - **BREAKING:** In Mainnet, even if the `PreferenceController`'s `useTokenDetection` option is set to false, automatic token detection is performed on the legacy token list (token data from the contract-metadata repo).
+
+### Removed
+
+- **BREAKING:** `TokenDetectionController` constructor no longer accepts options `onPreferencesStateChange`, `getPreferencesState`. ([#3775](https://github.com/MetaMask/core/pull/3775/))
+- **BREAKING:** `TokenDetectionController` no longer allows the `NetworkController:stateChange` event. The `NetworkController:networkDidChange` event can be used instead. ([#3775](https://github.com/MetaMask/core/pull/3775/))
+
 ## [25.0.0]
 
 ### Added

package/dist/TokenDetectionController.d.ts

@@ -1,18 +1,21 @@
+import type { AccountsControllerSelectedAccountChangeEvent } from '@metamask/accounts-controller';
 import type { RestrictedControllerMessenger, ControllerGetStateAction, ControllerStateChangeEvent } from '@metamask/base-controller';
-import type { NetworkClientId, NetworkControllerNetworkDidChangeEvent, NetworkControllerStateChangeEvent, NetworkControllerGetNetworkConfigurationByNetworkClientId } from '@metamask/network-controller';
+import type { KeyringControllerGetStateAction, KeyringControllerLockEvent, KeyringControllerUnlockEvent } from '@metamask/keyring-controller';
+import type { NetworkClientId, NetworkControllerNetworkDidChangeEvent, NetworkControllerGetNetworkConfigurationByNetworkClientId } from '@metamask/network-controller';
 import { StaticIntervalPollingController } from '@metamask/polling-controller';
-import type { PreferencesState } from '@metamask/preferences-controller';
+import type { PreferencesControllerGetStateAction, PreferencesControllerStateChangeEvent } from '@metamask/preferences-controller';
 import type { AssetsContractController } from './AssetsContractController';
-import type { GetTokenListState, TokenListStateChange } from './TokenListController';
+import type { GetTokenListState, TokenListStateChange, TokenListToken } from './TokenListController';
 import type { TokensController, TokensState } from './TokensController';
+export declare const STATIC_MAINNET_TOKEN_LIST: Record<string, Partial<TokenListToken>>;
 export declare const controllerName = "TokenDetectionController";
 export declare type TokenDetectionState = Record<never, never>;
 export declare type TokenDetectionControllerGetStateAction = ControllerGetStateAction<typeof controllerName, TokenDetectionState>;
 export declare type TokenDetectionControllerActions = TokenDetectionControllerGetStateAction;
-export declare type AllowedActions = NetworkControllerGetNetworkConfigurationByNetworkClientId | GetTokenListState;
+export declare type AllowedActions = NetworkControllerGetNetworkConfigurationByNetworkClientId | GetTokenListState | KeyringControllerGetStateAction | PreferencesControllerGetStateAction;
 export declare type TokenDetectionControllerStateChangeEvent = ControllerStateChangeEvent<typeof controllerName, TokenDetectionState>;
 export declare type TokenDetectionControllerEvents = TokenDetectionControllerStateChangeEvent;
-export declare type AllowedEvents = NetworkControllerStateChangeEvent | NetworkControllerNetworkDidChangeEvent | TokenListStateChange;
+export declare type AllowedEvents = AccountsControllerSelectedAccountChangeEvent | NetworkControllerNetworkDidChangeEvent | TokenListStateChange | KeyringControllerLockEvent | KeyringControllerUnlockEvent | PreferencesControllerStateChangeEvent;
 export declare type TokenDetectionControllerMessenger = RestrictedControllerMessenger<typeof controllerName, TokenDetectionControllerActions | AllowedActions, TokenDetectionControllerEvents | AllowedEvents, AllowedActions['type'], AllowedEvents['type']>;
 /**
  * Controller that passively polls on a set interval for Tokens auto detection
@@ -21,6 +24,7 @@ export declare type TokenDetectionControllerMessenger = RestrictedControllerMess
  * @property selectedAddress - Vault selected address
  * @property networkClientId - The network client ID of the current selected network
  * @property disabled - Boolean to track if network requests are blocked
+ * @property isUnlocked - Boolean to track if the keyring state is unlocked
  * @property isDetectionEnabledFromPreferences - Boolean to track if detection is enabled from PreferencesController
  * @property isDetectionEnabledForNetwork - Boolean to track if detected is enabled for current network
  */
@@ -35,22 +39,28 @@ export declare class TokenDetectionController extends StaticIntervalPollingContr
      * @param options.interval - Polling interval used to fetch new token rates
      * @param options.networkClientId - The selected network client ID of the current network
      * @param options.selectedAddress - Vault selected address
-     * @param options.onPreferencesStateChange - Allows subscribing to preferences controller state changes.
      * @param options.addDetectedTokens - Add a list of detected tokens.
      * @param options.getBalancesInSingleCall - Gets the balances of a list of tokens for the given address.
      * @param options.getTokensState - Gets the current state of the Tokens controller.
-     * @param options.getPreferencesState - Gets the state of the preferences controller.
+     * @param options.trackMetaMetricsEvent - Sets options for MetaMetrics event tracking.
      */
-    constructor({ networkClientId, selectedAddress, interval, disabled, onPreferencesStateChange, getBalancesInSingleCall, addDetectedTokens, getPreferencesState, getTokensState, messenger, }: {
+    constructor({ networkClientId, selectedAddress, interval, disabled, getBalancesInSingleCall, addDetectedTokens, getTokensState, trackMetaMetricsEvent, messenger, }: {
         networkClientId: NetworkClientId;
         selectedAddress?: string;
         interval?: number;
         disabled?: boolean;
-        onPreferencesStateChange: (listener: (preferencesState: PreferencesState) => void) => void;
         addDetectedTokens: TokensController['addDetectedTokens'];
         getBalancesInSingleCall: AssetsContractController['getBalancesInSingleCall'];
         getTokensState: () => TokensState;
-        getPreferencesState: () => PreferencesState;
+        trackMetaMetricsEvent: (options: {
+            event: string;
+            category: string;
+            properties: {
+                tokens: string[];
+                token_standard: string;
+                asset_type: string;
+            };
+        }) => void;
         messenger: TokenDetectionControllerMessenger;
     });
     /**
@@ -61,6 +71,12 @@ export declare class TokenDetectionController extends StaticIntervalPollingContr
      * Blocks controller from making network calls
      */
     disable(): void;
+    /**
+     * Internal isActive state
+     *
+     * @type {object}
+     */
+    get isActive(): boolean;
     /**
      * Start polling for detected tokens.
      */
@@ -73,11 +89,12 @@ export declare class TokenDetectionController extends StaticIntervalPollingContr
         address: string;
     }): Promise<void>;
     /**
-     * Triggers asset ERC20 token auto detection for each contract address in contract metadata on mainnet.
+     * For each token in the token list provided by the TokenListController, checks the token's balance for the selected account address on the active network.
+     * On mainnet, if token detection is disabled in preferences, ERC20 token auto detection will be triggered for each contract address in the legacy token list from the @metamask/contract-metadata repo.
      *
-     * @param options - Options to detect tokens.
+     * @param options - Options for token detection.
      * @param options.networkClientId - The ID of the network client to use.
-     * @param options.accountAddress - The account address to use.
+     * @param options.accountAddress - the selectedAddress against which to detect for token balances.
      */
     detectTokens({ networkClientId, accountAddress, }?: {
         networkClientId?: NetworkClientId;

package/dist/TokenDetectionController.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"TokenDetectionController.d.ts","sourceRoot":"","sources":["../src/TokenDetectionController.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,6BAA6B,EAC7B,wBAAwB,EACxB,0BAA0B,EAC3B,MAAM,2BAA2B,CAAC;AAKnC,OAAO,KAAK,EACV,eAAe,EACf,sCAAsC,EACtC,iCAAiC,EACjC,yDAAyD,EAC1D,MAAM,8BAA8B,CAAC;AACtC,OAAO,EAAE,+BAA+B,EAAE,MAAM,8BAA8B,CAAC;AAC/E,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,kCAAkC,CAAC;AAGzE,OAAO,KAAK,EAAE,wBAAwB,EAAE,MAAM,4BAA4B,CAAC;AAE3E,OAAO,KAAK,EACV,iBAAiB,EACjB,oBAAoB,EACrB,MAAM,uBAAuB,CAAC;AAE/B,OAAO,KAAK,EAAE,gBAAgB,EAAE,WAAW,EAAE,MAAM,oBAAoB,CAAC;AAIxE,eAAO,MAAM,cAAc,6BAA6B,CAAC;AAEzD,oBAAY,mBAAmB,GAAG,MAAM,CAAC,KAAK,EAAE,KAAK,CAAC,CAAC;AAEvD,oBAAY,sCAAsC,GAAG,wBAAwB,CAC3E,OAAO,cAAc,EACrB,mBAAmB,CACpB,CAAC;AAEF,oBAAY,+BAA+B,GACzC,sCAAsC,CAAC;AAEzC,oBAAY,cAAc,GACtB,yDAAyD,GACzD,iBAAiB,CAAC;AAEtB,oBAAY,wCAAwC,GAClD,0BAA0B,CAAC,OAAO,cAAc,EAAE,mBAAmB,CAAC,CAAC;AAEzE,oBAAY,8BAA8B,GACxC,wCAAwC,CAAC;AAE3C,oBAAY,aAAa,GACrB,iCAAiC,GACjC,sCAAsC,GACtC,oBAAoB,CAAC;AAEzB,oBAAY,iCAAiC,GAAG,6BAA6B,CAC3E,OAAO,cAAc,EACrB,+BAA+B,GAAG,cAAc,EAChD,8BAA8B,GAAG,aAAa,EAC9C,cAAc,CAAC,MAAM,CAAC,EACtB,aAAa,CAAC,MAAM,CAAC,CACtB,CAAC;AAEF;;;;;;;;;GASG;AACH,qBAAa,wBAAyB,SAAQ,+BAA+B,CAC3E,OAAO,cAAc,EACrB,mBAAmB,EACnB,iCAAiC,CAClC;;IAqBC;;;;;;;;;;;;;;OAcG;gBACS,EACV,eAAe,EACf,eAAoB,EACpB,QAA2B,EAC3B,QAAe,EACf,wBAAwB,EACxB,uBAAuB,EACvB,iBAAiB,EACjB,mBAAmB,EACnB,cAAc,EACd,SAAS,GACV,EAAE;QACD,eAAe,EAAE,eAAe,CAAC;QACjC,eAAe,CAAC,EAAE,MAAM,CAAC;QACzB,QAAQ,CAAC,EAAE,MAAM,CAAC;QAClB,QAAQ,CAAC,EAAE,OAAO,CAAC;QACnB,wBAAwB,EAAE,CACxB,QAAQ,EAAE,CAAC,gBAAgB,EAAE,gBAAgB,KAAK,IAAI,KACnD,IAAI,CAAC;QACV,iBAAiB,EAAE,gBAAgB,CAAC,mBAAmB,CAAC,CAAC;QACzD,uBAAuB,EAAE,wBAAwB,CAAC,yBAAyB,CAAC,CAAC;QAC7E,cAAc,EAAE,MAAM,WAAW,CAAC;QAClC,mBAAmB,EAAE,MAAM,gBAAgB,CAAC;QAC5C,SAAS,EAAE,iCAAiC,CAAC;KAC9C;IA2ED;;OAEG;IACH,MAAM;IAIN;;OAEG;IACH,OAAO;IAIP;;OAEG;IACG,KAAK;IAKX;;OAEG;IACH,IAAI;IAkCE,YAAY,CAChB,eAAe,EAAE,MAAM,EACvB,OAAO,EAAE;QAAE,OAAO,EAAE,MAAM,CAAA;KAAE,GAC3B,OAAO,CAAC,IAAI,CAAC;IAUhB;;;;;;OAMG;IACG,YAAY,CAAC,EACjB,eAAe,EACf,cAAc,GACf,GAAE;QACD,eAAe,CAAC,EAAE,eAAe,CAAC;QAClC,cAAc,CAAC,EAAE,MAAM,CAAC;KACpB,GAAG,OAAO,CAAC,IAAI,CAAC;CAsFvB;AAED,eAAe,wBAAwB,CAAC"}
+{"version":3,"file":"TokenDetectionController.d.ts","sourceRoot":"","sources":["../src/TokenDetectionController.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,4CAA4C,EAAE,MAAM,+BAA+B,CAAC;AAClG,OAAO,KAAK,EACV,6BAA6B,EAC7B,wBAAwB,EACxB,0BAA0B,EAC3B,MAAM,2BAA2B,CAAC;AAOnC,OAAO,KAAK,EACV,+BAA+B,EAC/B,0BAA0B,EAC1B,4BAA4B,EAC7B,MAAM,8BAA8B,CAAC;AACtC,OAAO,KAAK,EACV,eAAe,EACf,sCAAsC,EACtC,yDAAyD,EAC1D,MAAM,8BAA8B,CAAC;AACtC,OAAO,EAAE,+BAA+B,EAAE,MAAM,8BAA8B,CAAC;AAC/E,OAAO,KAAK,EACV,mCAAmC,EACnC,qCAAqC,EACtC,MAAM,kCAAkC,CAAC;AAG1C,OAAO,KAAK,EAAE,wBAAwB,EAAE,MAAM,4BAA4B,CAAC;AAE3E,OAAO,KAAK,EACV,iBAAiB,EACjB,oBAAoB,EACpB,cAAc,EACf,MAAM,uBAAuB,CAAC;AAE/B,OAAO,KAAK,EAAE,gBAAgB,EAAE,WAAW,EAAE,MAAM,oBAAoB,CAAC;AAwBxE,eAAO,MAAM,yBAAyB,yCAahC,CAAC;AAEP,eAAO,MAAM,cAAc,6BAA6B,CAAC;AAEzD,oBAAY,mBAAmB,GAAG,MAAM,CAAC,KAAK,EAAE,KAAK,CAAC,CAAC;AAEvD,oBAAY,sCAAsC,GAAG,wBAAwB,CAC3E,OAAO,cAAc,EACrB,mBAAmB,CACpB,CAAC;AAEF,oBAAY,+BAA+B,GACzC,sCAAsC,CAAC;AAEzC,oBAAY,cAAc,GACtB,yDAAyD,GACzD,iBAAiB,GACjB,+BAA+B,GAC/B,mCAAmC,CAAC;AAExC,oBAAY,wCAAwC,GAClD,0BAA0B,CAAC,OAAO,cAAc,EAAE,mBAAmB,CAAC,CAAC;AAEzE,oBAAY,8BAA8B,GACxC,wCAAwC,CAAC;AAE3C,oBAAY,aAAa,GACrB,4CAA4C,GAC5C,sCAAsC,GACtC,oBAAoB,GACpB,0BAA0B,GAC1B,4BAA4B,GAC5B,qCAAqC,CAAC;AAE1C,oBAAY,iCAAiC,GAAG,6BAA6B,CAC3E,OAAO,cAAc,EACrB,+BAA+B,GAAG,cAAc,EAChD,8BAA8B,GAAG,aAAa,EAC9C,cAAc,CAAC,MAAM,CAAC,EACtB,aAAa,CAAC,MAAM,CAAC,CACtB,CAAC;AAEF;;;;;;;;;;GAUG;AACH,qBAAa,wBAAyB,SAAQ,+BAA+B,CAC3E,OAAO,cAAc,EACrB,mBAAmB,EACnB,iCAAiC,CAClC;;IAiCC;;;;;;;;;;;;;OAaG;gBACS,EACV,eAAe,EACf,eAAoB,EACpB,QAA2B,EAC3B,QAAe,EACf,uBAAuB,EACvB,iBAAiB,EACjB,cAAc,EACd,qBAAqB,EACrB,SAAS,GACV,EAAE;QACD,eAAe,EAAE,eAAe,CAAC;QACjC,eAAe,CAAC,EAAE,MAAM,CAAC;QACzB,QAAQ,CAAC,EAAE,MAAM,CAAC;QAClB,QAAQ,CAAC,EAAE,OAAO,CAAC;QACnB,iBAAiB,EAAE,gBAAgB,CAAC,mBAAmB,CAAC,CAAC;QACzD,uBAAuB,EAAE,wBAAwB,CAAC,yBAAyB,CAAC,CAAC;QAC7E,cAAc,EAAE,MAAM,WAAW,CAAC;QAClC,qBAAqB,EAAE,CAAC,OAAO,EAAE;YAC/B,KAAK,EAAE,MAAM,CAAC;YACd,QAAQ,EAAE,MAAM,CAAC;YACjB,UAAU,EAAE;gBACV,MAAM,EAAE,MAAM,EAAE,CAAC;gBACjB,cAAc,EAAE,MAAM,CAAC;gBACvB,UAAU,EAAE,MAAM,CAAC;aACpB,CAAC;SACH,KAAK,IAAI,CAAC;QACX,SAAS,EAAE,iCAAiC,CAAC;KAC9C;IAwHD;;OAEG;IACH,MAAM;IAIN;;OAEG;IACH,OAAO;IAIP;;;;OAIG;IACH,IAAI,QAAQ,YAEX;IAED;;OAEG;IACG,KAAK;IAKX;;OAEG;IACH,IAAI;IAkCE,YAAY,CAChB,eAAe,EAAE,MAAM,EACvB,OAAO,EAAE;QAAE,OAAO,EAAE,MAAM,CAAA;KAAE,GAC3B,OAAO,CAAC,IAAI,CAAC;IA6BhB;;;;;;;OAOG;IACG,YAAY,CAAC,EACjB,eAAe,EACf,cAAc,GACf,GAAE;QACD,eAAe,CAAC,EAAE,eAAe,CAAC;QAClC,cAAc,CAAC,EAAE,MAAM,CAAC;KACpB,GAAG,OAAO,CAAC,IAAI,CAAC;CAiHvB;AAED,eAAe,wBAAwB,CAAC"}

package/dist/TokenDetectionController.js

@@ -19,13 +19,41 @@ var __classPrivateFieldGet = (this && this.__classPrivateFieldGet) || function (
     if (typeof state === "function" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError("Cannot read private member from an object whose class did not declare it");
     return kind === "m" ? f : kind === "a" ? f.call(receiver) : f ? f.value : state.get(receiver);
 };
-var _TokenDetectionController_instances, _TokenDetectionController_intervalId, _TokenDetectionController_chainId, _TokenDetectionController_selectedAddress, _TokenDetectionController_networkClientId, _TokenDetectionController_disabled, _TokenDetectionController_isDetectionEnabledFromPreferences, _TokenDetectionController_isDetectionEnabledForNetwork, _TokenDetectionController_addDetectedTokens, _TokenDetectionController_getBalancesInSingleCall, _TokenDetectionController_getTokensState, _TokenDetectionController_stopPolling, _TokenDetectionController_startPolling, _TokenDetectionController_getCorrectChainId;
+var __rest = (this && this.__rest) || function (s, e) {
+    var t = {};
+    for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p) && e.indexOf(p) < 0)
+        t[p] = s[p];
+    if (s != null && typeof Object.getOwnPropertySymbols === "function")
+        for (var i = 0, p = Object.getOwnPropertySymbols(s); i < p.length; i++) {
+            if (e.indexOf(p[i]) < 0 && Object.prototype.propertyIsEnumerable.call(s, p[i]))
+                t[p[i]] = s[p[i]];
+        }
+    return t;
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+var _TokenDetectionController_instances, _TokenDetectionController_intervalId, _TokenDetectionController_chainId, _TokenDetectionController_selectedAddress, _TokenDetectionController_networkClientId, _TokenDetectionController_disabled, _TokenDetectionController_isUnlocked, _TokenDetectionController_isDetectionEnabledFromPreferences, _TokenDetectionController_isDetectionEnabledForNetwork, _TokenDetectionController_addDetectedTokens, _TokenDetectionController_getBalancesInSingleCall, _TokenDetectionController_getTokensState, _TokenDetectionController_trackMetaMetricsEvent, _TokenDetectionController_registerEventListeners, _TokenDetectionController_stopPolling, _TokenDetectionController_startPolling, _TokenDetectionController_getCorrectChainId, _TokenDetectionController_restartTokenDetection;
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.TokenDetectionController = exports.controllerName = void 0;
+exports.TokenDetectionController = exports.controllerName = exports.STATIC_MAINNET_TOKEN_LIST = void 0;
+const contract_metadata_1 = __importDefault(require("@metamask/contract-metadata"));
 const controller_utils_1 = require("@metamask/controller-utils");
 const polling_controller_1 = require("@metamask/polling-controller");
 const assetsUtil_1 = require("./assetsUtil");
 const DEFAULT_INTERVAL = 180000;
+/**
+ * Finds a case insensitive match in an array of strings
+ * @param source - An array of strings to search.
+ * @param target - The target string to search for.
+ * @returns The first match that is found.
+ */
+function findCaseInsensitiveMatch(source, target) {
+    return source.find((e) => e.toLowerCase() === target.toLowerCase());
+}
+exports.STATIC_MAINNET_TOKEN_LIST = Object.entries(contract_metadata_1.default).reduce((acc, [base, contract]) => {
+    const { logo } = contract, tokenMetadata = __rest(contract, ["logo"]);
+    return Object.assign(Object.assign({}, acc), { [base.toLowerCase()]: Object.assign(Object.assign({}, tokenMetadata), { address: base.toLowerCase(), iconUrl: `images/contract/${logo}`, aggregators: [] }) });
+}, {});
 exports.controllerName = 'TokenDetectionController';
 /**
  * Controller that passively polls on a set interval for Tokens auto detection
@@ -34,6 +62,7 @@ exports.controllerName = 'TokenDetectionController';
  * @property selectedAddress - Vault selected address
  * @property networkClientId - The network client ID of the current selected network
  * @property disabled - Boolean to track if network requests are blocked
+ * @property isUnlocked - Boolean to track if the keyring state is unlocked
  * @property isDetectionEnabledFromPreferences - Boolean to track if detection is enabled from PreferencesController
  * @property isDetectionEnabledForNetwork - Boolean to track if detected is enabled for current network
  */
@@ -47,14 +76,12 @@ class TokenDetectionController extends polling_controller_1.StaticIntervalPollin
      * @param options.interval - Polling interval used to fetch new token rates
      * @param options.networkClientId - The selected network client ID of the current network
      * @param options.selectedAddress - Vault selected address
-     * @param options.onPreferencesStateChange - Allows subscribing to preferences controller state changes.
      * @param options.addDetectedTokens - Add a list of detected tokens.
      * @param options.getBalancesInSingleCall - Gets the balances of a list of tokens for the given address.
      * @param options.getTokensState - Gets the current state of the Tokens controller.
-     * @param options.getPreferencesState - Gets the state of the preferences controller.
+     * @param options.trackMetaMetricsEvent - Sets options for MetaMetrics event tracking.
      */
-    constructor({ networkClientId, selectedAddress = '', interval = DEFAULT_INTERVAL, disabled = true, onPreferencesStateChange, getBalancesInSingleCall, addDetectedTokens, getPreferencesState, getTokensState, messenger, }) {
-        const { useTokenDetection: defaultUseTokenDetection } = getPreferencesState();
+    constructor({ networkClientId, selectedAddress = '', interval = DEFAULT_INTERVAL, disabled = true, getBalancesInSingleCall, addDetectedTokens, getTokensState, trackMetaMetricsEvent, messenger, }) {
         super({
             name: exports.controllerName,
             messenger,
@@ -67,47 +94,28 @@ class TokenDetectionController extends polling_controller_1.StaticIntervalPollin
         _TokenDetectionController_selectedAddress.set(this, void 0);
         _TokenDetectionController_networkClientId.set(this, void 0);
         _TokenDetectionController_disabled.set(this, void 0);
+        _TokenDetectionController_isUnlocked.set(this, void 0);
         _TokenDetectionController_isDetectionEnabledFromPreferences.set(this, void 0);
         _TokenDetectionController_isDetectionEnabledForNetwork.set(this, void 0);
         _TokenDetectionController_addDetectedTokens.set(this, void 0);
         _TokenDetectionController_getBalancesInSingleCall.set(this, void 0);
         _TokenDetectionController_getTokensState.set(this, void 0);
+        _TokenDetectionController_trackMetaMetricsEvent.set(this, void 0);
         __classPrivateFieldSet(this, _TokenDetectionController_disabled, disabled, "f");
         this.setIntervalLength(interval);
         __classPrivateFieldSet(this, _TokenDetectionController_networkClientId, networkClientId, "f");
         __classPrivateFieldSet(this, _TokenDetectionController_selectedAddress, selectedAddress, "f");
         __classPrivateFieldSet(this, _TokenDetectionController_chainId, __classPrivateFieldGet(this, _TokenDetectionController_instances, "m", _TokenDetectionController_getCorrectChainId).call(this, networkClientId), "f");
+        const { useTokenDetection: defaultUseTokenDetection } = this.messagingSystem.call('PreferencesController:getState');
         __classPrivateFieldSet(this, _TokenDetectionController_isDetectionEnabledFromPreferences, defaultUseTokenDetection, "f");
         __classPrivateFieldSet(this, _TokenDetectionController_isDetectionEnabledForNetwork, (0, assetsUtil_1.isTokenDetectionSupportedForNetwork)(__classPrivateFieldGet(this, _TokenDetectionController_chainId, "f")), "f");
         __classPrivateFieldSet(this, _TokenDetectionController_addDetectedTokens, addDetectedTokens, "f");
         __classPrivateFieldSet(this, _TokenDetectionController_getBalancesInSingleCall, getBalancesInSingleCall, "f");
         __classPrivateFieldSet(this, _TokenDetectionController_getTokensState, getTokensState, "f");
-        this.messagingSystem.subscribe('TokenListController:stateChange', ({ tokenList }) => __awaiter(this, void 0, void 0, function* () {
-            const hasTokens = Object.keys(tokenList).length;
-            if (hasTokens) {
-                yield this.detectTokens();
-            }
-        }));
-        onPreferencesStateChange(({ selectedAddress: newSelectedAddress, useTokenDetection }) => __awaiter(this, void 0, void 0, function* () {
-            const isSelectedAddressChanged = __classPrivateFieldGet(this, _TokenDetectionController_selectedAddress, "f") !== newSelectedAddress;
-            const isDetectionChangedFromPreferences = __classPrivateFieldGet(this, _TokenDetectionController_isDetectionEnabledFromPreferences, "f") !== useTokenDetection;
-            __classPrivateFieldSet(this, _TokenDetectionController_selectedAddress, newSelectedAddress, "f");
-            __classPrivateFieldSet(this, _TokenDetectionController_isDetectionEnabledFromPreferences, useTokenDetection, "f");
-            if (useTokenDetection &&
-                (isSelectedAddressChanged || isDetectionChangedFromPreferences)) {
-                yield this.detectTokens();
-            }
-        }));
-        this.messagingSystem.subscribe('NetworkController:networkDidChange', ({ selectedNetworkClientId }) => __awaiter(this, void 0, void 0, function* () {
-            __classPrivateFieldSet(this, _TokenDetectionController_networkClientId, selectedNetworkClientId, "f");
-            const newChainId = __classPrivateFieldGet(this, _TokenDetectionController_instances, "m", _TokenDetectionController_getCorrectChainId).call(this, selectedNetworkClientId);
-            const isChainIdChanged = __classPrivateFieldGet(this, _TokenDetectionController_chainId, "f") !== newChainId;
-            __classPrivateFieldSet(this, _TokenDetectionController_chainId, newChainId, "f");
-            __classPrivateFieldSet(this, _TokenDetectionController_isDetectionEnabledForNetwork, (0, assetsUtil_1.isTokenDetectionSupportedForNetwork)(newChainId), "f");
-            if (__classPrivateFieldGet(this, _TokenDetectionController_isDetectionEnabledForNetwork, "f") && isChainIdChanged) {
-                yield this.detectTokens();
-            }
-        }));
+        __classPrivateFieldSet(this, _TokenDetectionController_trackMetaMetricsEvent, trackMetaMetricsEvent, "f");
+        const { isUnlocked } = this.messagingSystem.call('KeyringController:getState');
+        __classPrivateFieldSet(this, _TokenDetectionController_isUnlocked, isUnlocked, "f");
+        __classPrivateFieldGet(this, _TokenDetectionController_instances, "m", _TokenDetectionController_registerEventListeners).call(this);
     }
     /**
      * Allows controller to make active and passive polling requests
@@ -121,6 +129,14 @@ class TokenDetectionController extends polling_controller_1.StaticIntervalPollin
     disable() {
         __classPrivateFieldSet(this, _TokenDetectionController_disabled, true, "f");
     }
+    /**
+     * Internal isActive state
+     *
+     * @type {object}
+     */
+    get isActive() {
+        return !__classPrivateFieldGet(this, _TokenDetectionController_disabled, "f") && __classPrivateFieldGet(this, _TokenDetectionController_isUnlocked, "f");
+    }
     /**
      * Start polling for detected tokens.
      */
@@ -139,7 +155,7 @@ class TokenDetectionController extends polling_controller_1.StaticIntervalPollin
     }
     _executePoll(networkClientId, options) {
         return __awaiter(this, void 0, void 0, function* () {
-            if (__classPrivateFieldGet(this, _TokenDetectionController_disabled, "f")) {
+            if (!this.isActive) {
                 return;
             }
             yield this.detectTokens({
@@ -149,29 +165,35 @@ class TokenDetectionController extends polling_controller_1.StaticIntervalPollin
         });
     }
     /**
-     * Triggers asset ERC20 token auto detection for each contract address in contract metadata on mainnet.
+     * For each token in the token list provided by the TokenListController, checks the token's balance for the selected account address on the active network.
+     * On mainnet, if token detection is disabled in preferences, ERC20 token auto detection will be triggered for each contract address in the legacy token list from the @metamask/contract-metadata repo.
      *
-     * @param options - Options to detect tokens.
+     * @param options - Options for token detection.
      * @param options.networkClientId - The ID of the network client to use.
-     * @param options.accountAddress - The account address to use.
+     * @param options.accountAddress - the selectedAddress against which to detect for token balances.
      */
     detectTokens({ networkClientId, accountAddress, } = {}) {
         return __awaiter(this, void 0, void 0, function* () {
-            if (__classPrivateFieldGet(this, _TokenDetectionController_disabled, "f") ||
-                !__classPrivateFieldGet(this, _TokenDetectionController_isDetectionEnabledForNetwork, "f") ||
-                !__classPrivateFieldGet(this, _TokenDetectionController_isDetectionEnabledFromPreferences, "f")) {
+            if (!this.isActive || !__classPrivateFieldGet(this, _TokenDetectionController_isDetectionEnabledForNetwork, "f")) {
                 return;
             }
-            const { tokens } = __classPrivateFieldGet(this, _TokenDetectionController_getTokensState, "f").call(this);
-            const selectedAddress = accountAddress || __classPrivateFieldGet(this, _TokenDetectionController_selectedAddress, "f");
+            const selectedAddress = accountAddress !== null && accountAddress !== void 0 ? accountAddress : __classPrivateFieldGet(this, _TokenDetectionController_selectedAddress, "f");
             const chainId = __classPrivateFieldGet(this, _TokenDetectionController_instances, "m", _TokenDetectionController_getCorrectChainId).call(this, networkClientId);
-            const tokensAddresses = tokens.map(
-            /* istanbul ignore next*/ (token) => token.address.toLowerCase());
+            if (!__classPrivateFieldGet(this, _TokenDetectionController_isDetectionEnabledFromPreferences, "f") &&
+                chainId !== controller_utils_1.ChainId.mainnet) {
+                return;
+            }
+            const isTokenDetectionInactiveInMainnet = !__classPrivateFieldGet(this, _TokenDetectionController_isDetectionEnabledFromPreferences, "f") && chainId === controller_utils_1.ChainId.mainnet;
             const { tokenList } = this.messagingSystem.call('TokenListController:getState');
+            const tokenListUsed = isTokenDetectionInactiveInMainnet
+                ? exports.STATIC_MAINNET_TOKEN_LIST
+                : tokenList;
+            const { tokens, detectedTokens } = __classPrivateFieldGet(this, _TokenDetectionController_getTokensState, "f").call(this);
             const tokensToDetect = [];
-            for (const address of Object.keys(tokenList)) {
-                if (!tokensAddresses.includes(address)) {
-                    tokensToDetect.push(address);
+            for (const tokenAddress of Object.keys(tokenListUsed)) {
+                if (!findCaseInsensitiveMatch(tokens.map(({ address }) => address), tokenAddress) &&
+                    !findCaseInsensitiveMatch(detectedTokens.map(({ address }) => address), tokenAddress)) {
+                    tokensToDetect.push(tokenAddress);
                 }
             }
             const sliceOfTokensToDetect = [];
@@ -189,6 +211,7 @@ class TokenDetectionController extends polling_controller_1.StaticIntervalPollin
                     var _a;
                     const balances = yield __classPrivateFieldGet(this, _TokenDetectionController_getBalancesInSingleCall, "f").call(this, selectedAddress, tokensSlice);
                     const tokensToAdd = [];
+                    const eventTokensDetails = [];
                     for (const tokenAddress of Object.keys(balances)) {
                         let ignored;
                         /* istanbul ignore else */
@@ -196,9 +219,10 @@ class TokenDetectionController extends polling_controller_1.StaticIntervalPollin
                         if (ignoredTokens.length) {
                             ignored = ignoredTokens.find((ignoredTokenAddress) => ignoredTokenAddress === (0, controller_utils_1.toChecksumHexAddress)(tokenAddress));
                         }
-                        const caseInsensitiveTokenKey = (_a = Object.keys(tokenList).find((i) => i.toLowerCase() === tokenAddress.toLowerCase())) !== null && _a !== void 0 ? _a : '';
+                        const caseInsensitiveTokenKey = (_a = findCaseInsensitiveMatch(Object.keys(tokenListUsed), tokenAddress)) !== null && _a !== void 0 ? _a : '';
                         if (ignored === undefined) {
                             const { decimals, symbol, aggregators, iconUrl, name } = tokenList[caseInsensitiveTokenKey];
+                            eventTokensDetails.push(`${symbol} - ${tokenAddress}`);
                             tokensToAdd.push({
                                 address: tokenAddress,
                                 decimals,
@@ -211,6 +235,15 @@ class TokenDetectionController extends polling_controller_1.StaticIntervalPollin
                         }
                     }
                     if (tokensToAdd.length) {
+                        __classPrivateFieldGet(this, _TokenDetectionController_trackMetaMetricsEvent, "f").call(this, {
+                            event: 'Token Detected',
+                            category: 'Wallet',
+                            properties: {
+                                tokens: eventTokensDetails,
+                                token_standard: 'ERC20',
+                                asset_type: 'TOKEN',
+                            },
+                        });
                         yield __classPrivateFieldGet(this, _TokenDetectionController_addDetectedTokens, "f").call(this, tokensToAdd, {
                             selectedAddress,
                             chainId,
@@ -222,13 +255,61 @@ class TokenDetectionController extends polling_controller_1.StaticIntervalPollin
     }
 }
 exports.TokenDetectionController = TokenDetectionController;
-_TokenDetectionController_intervalId = new WeakMap(), _TokenDetectionController_chainId = new WeakMap(), _TokenDetectionController_selectedAddress = new WeakMap(), _TokenDetectionController_networkClientId = new WeakMap(), _TokenDetectionController_disabled = new WeakMap(), _TokenDetectionController_isDetectionEnabledFromPreferences = new WeakMap(), _TokenDetectionController_isDetectionEnabledForNetwork = new WeakMap(), _TokenDetectionController_addDetectedTokens = new WeakMap(), _TokenDetectionController_getBalancesInSingleCall = new WeakMap(), _TokenDetectionController_getTokensState = new WeakMap(), _TokenDetectionController_instances = new WeakSet(), _TokenDetectionController_stopPolling = function _TokenDetectionController_stopPolling() {
+_TokenDetectionController_intervalId = new WeakMap(), _TokenDetectionController_chainId = new WeakMap(), _TokenDetectionController_selectedAddress = new WeakMap(), _TokenDetectionController_networkClientId = new WeakMap(), _TokenDetectionController_disabled = new WeakMap(), _TokenDetectionController_isUnlocked = new WeakMap(), _TokenDetectionController_isDetectionEnabledFromPreferences = new WeakMap(), _TokenDetectionController_isDetectionEnabledForNetwork = new WeakMap(), _TokenDetectionController_addDetectedTokens = new WeakMap(), _TokenDetectionController_getBalancesInSingleCall = new WeakMap(), _TokenDetectionController_getTokensState = new WeakMap(), _TokenDetectionController_trackMetaMetricsEvent = new WeakMap(), _TokenDetectionController_instances = new WeakSet(), _TokenDetectionController_registerEventListeners = function _TokenDetectionController_registerEventListeners() {
+    this.messagingSystem.subscribe('KeyringController:unlock', () => __awaiter(this, void 0, void 0, function* () {
+        __classPrivateFieldSet(this, _TokenDetectionController_isUnlocked, true, "f");
+        yield __classPrivateFieldGet(this, _TokenDetectionController_instances, "m", _TokenDetectionController_restartTokenDetection).call(this);
+    }));
+    this.messagingSystem.subscribe('KeyringController:lock', () => {
+        __classPrivateFieldSet(this, _TokenDetectionController_isUnlocked, false, "f");
+        __classPrivateFieldGet(this, _TokenDetectionController_instances, "m", _TokenDetectionController_stopPolling).call(this);
+    });
+    this.messagingSystem.subscribe('TokenListController:stateChange', ({ tokenList }) => __awaiter(this, void 0, void 0, function* () {
+        const hasTokens = Object.keys(tokenList).length;
+        if (hasTokens) {
+            yield __classPrivateFieldGet(this, _TokenDetectionController_instances, "m", _TokenDetectionController_restartTokenDetection).call(this);
+        }
+    }));
+    this.messagingSystem.subscribe('PreferencesController:stateChange', ({ selectedAddress: newSelectedAddress, useTokenDetection }) => __awaiter(this, void 0, void 0, function* () {
+        const isSelectedAddressChanged = __classPrivateFieldGet(this, _TokenDetectionController_selectedAddress, "f") !== newSelectedAddress;
+        const isDetectionChangedFromPreferences = __classPrivateFieldGet(this, _TokenDetectionController_isDetectionEnabledFromPreferences, "f") !== useTokenDetection;
+        __classPrivateFieldSet(this, _TokenDetectionController_selectedAddress, newSelectedAddress, "f");
+        __classPrivateFieldSet(this, _TokenDetectionController_isDetectionEnabledFromPreferences, useTokenDetection, "f");
+        if (useTokenDetection &&
+            (isSelectedAddressChanged || isDetectionChangedFromPreferences)) {
+            yield __classPrivateFieldGet(this, _TokenDetectionController_instances, "m", _TokenDetectionController_restartTokenDetection).call(this, {
+                selectedAddress: __classPrivateFieldGet(this, _TokenDetectionController_selectedAddress, "f"),
+            });
+        }
+    }));
+    this.messagingSystem.subscribe('AccountsController:selectedAccountChange', ({ address: newSelectedAddress }) => __awaiter(this, void 0, void 0, function* () {
+        const isSelectedAddressChanged = __classPrivateFieldGet(this, _TokenDetectionController_selectedAddress, "f") !== newSelectedAddress;
+        if (isSelectedAddressChanged &&
+            __classPrivateFieldGet(this, _TokenDetectionController_isDetectionEnabledFromPreferences, "f")) {
+            __classPrivateFieldSet(this, _TokenDetectionController_selectedAddress, newSelectedAddress, "f");
+            yield __classPrivateFieldGet(this, _TokenDetectionController_instances, "m", _TokenDetectionController_restartTokenDetection).call(this, {
+                selectedAddress: __classPrivateFieldGet(this, _TokenDetectionController_selectedAddress, "f"),
+            });
+        }
+    }));
+    this.messagingSystem.subscribe('NetworkController:networkDidChange', ({ selectedNetworkClientId }) => __awaiter(this, void 0, void 0, function* () {
+        const isNetworkClientIdChanged = __classPrivateFieldGet(this, _TokenDetectionController_networkClientId, "f") !== selectedNetworkClientId;
+        const newChainId = __classPrivateFieldGet(this, _TokenDetectionController_instances, "m", _TokenDetectionController_getCorrectChainId).call(this, selectedNetworkClientId);
+        __classPrivateFieldSet(this, _TokenDetectionController_isDetectionEnabledForNetwork, (0, assetsUtil_1.isTokenDetectionSupportedForNetwork)(newChainId), "f");
+        if (isNetworkClientIdChanged && __classPrivateFieldGet(this, _TokenDetectionController_isDetectionEnabledForNetwork, "f")) {
+            __classPrivateFieldSet(this, _TokenDetectionController_networkClientId, selectedNetworkClientId, "f");
+            yield __classPrivateFieldGet(this, _TokenDetectionController_instances, "m", _TokenDetectionController_restartTokenDetection).call(this, {
+                networkClientId: __classPrivateFieldGet(this, _TokenDetectionController_networkClientId, "f"),
+            });
+        }
+    }));
+}, _TokenDetectionController_stopPolling = function _TokenDetectionController_stopPolling() {
     if (__classPrivateFieldGet(this, _TokenDetectionController_intervalId, "f")) {
         clearInterval(__classPrivateFieldGet(this, _TokenDetectionController_intervalId, "f"));
     }
 }, _TokenDetectionController_startPolling = function _TokenDetectionController_startPolling() {
     return __awaiter(this, void 0, void 0, function* () {
-        if (__classPrivateFieldGet(this, _TokenDetectionController_disabled, "f")) {
+        if (!this.isActive) {
             return;
         }
         __classPrivateFieldGet(this, _TokenDetectionController_instances, "m", _TokenDetectionController_stopPolling).call(this);
@@ -241,6 +322,14 @@ _TokenDetectionController_intervalId = new WeakMap(), _TokenDetectionController_
     var _a;
     const { chainId } = (_a = this.messagingSystem.call('NetworkController:getNetworkConfigurationByNetworkClientId', networkClientId !== null && networkClientId !== void 0 ? networkClientId : __classPrivateFieldGet(this, _TokenDetectionController_networkClientId, "f"))) !== null && _a !== void 0 ? _a : {};
     return chainId !== null && chainId !== void 0 ? chainId : __classPrivateFieldGet(this, _TokenDetectionController_chainId, "f");
+}, _TokenDetectionController_restartTokenDetection = function _TokenDetectionController_restartTokenDetection({ selectedAddress, networkClientId, } = {}) {
+    return __awaiter(this, void 0, void 0, function* () {
+        yield this.detectTokens({
+            networkClientId,
+            accountAddress: selectedAddress,
+        });
+        this.setIntervalLength(DEFAULT_INTERVAL);
+    });
 };
 exports.default = TokenDetectionController;
 //# sourceMappingURL=TokenDetectionController.js.map

package/dist/TokenDetectionController.js.map

@@ -1 +1 @@
-{"version":3,"file":"TokenDetectionController.js","sourceRoot":"","sources":["../src/TokenDetectionController.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;AAKA,iEAGoC;AAOpC,qEAA+E;AAK/E,6CAAmE;AAQnE,MAAM,gBAAgB,GAAG,MAAM,CAAC;AAEnB,QAAA,cAAc,GAAG,0BAA0B,CAAC;AAmCzD;;;;;;;;;GASG;AACH,MAAa,wBAAyB,SAAQ,oDAI7C;IAqBC;;;;;;;;;;;;;;OAcG;IACH,YAAY,EACV,eAAe,EACf,eAAe,GAAG,EAAE,EACpB,QAAQ,GAAG,gBAAgB,EAC3B,QAAQ,GAAG,IAAI,EACf,wBAAwB,EACxB,uBAAuB,EACvB,iBAAiB,EACjB,mBAAmB,EACnB,cAAc,EACd,SAAS,GAcV;QACC,MAAM,EAAE,iBAAiB,EAAE,wBAAwB,EAAE,GACnD,mBAAmB,EAAE,CAAC;QAExB,KAAK,CAAC;YACJ,IAAI,EAAE,sBAAc;YACpB,SAAS;YACT,KAAK,EAAE,EAAE;YACT,QAAQ,EAAE,EAAE;SACb,CAAC,CAAC;;QApEL,uDAA4C;QAE5C,oDAAc;QAEd,4DAAyB;QAEzB,4DAAkC;QAElC,qDAAmB;QAEnB,8EAA4C;QAE5C,yEAAuC;QAEvC,8DAAmE;QAEnE,oEAAuF;QAEvF,2DAA4C;QAoD1C,uBAAA,IAAI,sCAAa,QAAQ,MAAA,CAAC;QAC1B,IAAI,CAAC,iBAAiB,CAAC,QAAQ,CAAC,CAAC;QAEjC,uBAAA,IAAI,6CAAoB,eAAe,MAAA,CAAC;QACxC,uBAAA,IAAI,6CAAoB,eAAe,MAAA,CAAC;QACxC,uBAAA,IAAI,qCAAY,uBAAA,IAAI,wFAAmB,MAAvB,IAAI,EAAoB,eAAe,CAAC,MAAA,CAAC;QAEzD,uBAAA,IAAI,+DAAsC,wBAAwB,MAAA,CAAC;QACnE,uBAAA,IAAI,0DAAiC,IAAA,gDAAmC,EACtE,uBAAA,IAAI,yCAAS,CACd,MAAA,CAAC;QAEF,uBAAA,IAAI,+CAAsB,iBAAiB,MAAA,CAAC;QAC5C,uBAAA,IAAI,qDAA4B,uBAAuB,MAAA,CAAC;QACxD,uBAAA,IAAI,4CAAmB,cAAc,MAAA,CAAC;QAEtC,IAAI,CAAC,eAAe,CAAC,SAAS,CAC5B,iCAAiC,EACjC,CAAO,EAAE,SAAS,EAAE,EAAE,EAAE;YACtB,MAAM,SAAS,GAAG,MAAM,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC,MAAM,CAAC;YAEhD,IAAI,SAAS,EAAE;gBACb,MAAM,IAAI,CAAC,YAAY,EAAE,CAAC;aAC3B;QACH,CAAC,CAAA,CACF,CAAC;QAEF,wBAAwB,CACtB,CAAO,EAAE,eAAe,EAAE,kBAAkB,EAAE,iBAAiB,EAAE,EAAE,EAAE;YACnE,MAAM,wBAAwB,GAC5B,uBAAA,IAAI,iDAAiB,KAAK,kBAAkB,CAAC;YAC/C,MAAM,iCAAiC,GACrC,uBAAA,IAAI,mEAAmC,KAAK,iBAAiB,CAAC;YAEhE,uBAAA,IAAI,6CAAoB,kBAAkB,MAAA,CAAC;YAC3C,uBAAA,IAAI,+DAAsC,iBAAiB,MAAA,CAAC;YAE5D,IACE,iBAAiB;gBACjB,CAAC,wBAAwB,IAAI,iCAAiC,CAAC,EAC/D;gBACA,MAAM,IAAI,CAAC,YAAY,EAAE,CAAC;aAC3B;QACH,CAAC,CAAA,CACF,CAAC;QAEF,IAAI,CAAC,eAAe,CAAC,SAAS,CAC5B,oCAAoC,EACpC,CAAO,EAAE,uBAAuB,EAAE,EAAE,EAAE;YACpC,uBAAA,IAAI,6CAAoB,uBAAuB,MAAA,CAAC;YAChD,MAAM,UAAU,GAAG,uBAAA,IAAI,wFAAmB,MAAvB,IAAI,EAAoB,uBAAuB,CAAC,CAAC;YACpE,MAAM,gBAAgB,GAAG,uBAAA,IAAI,yCAAS,KAAK,UAAU,CAAC;YACtD,uBAAA,IAAI,qCAAY,UAAU,MAAA,CAAC;YAE3B,uBAAA,IAAI,0DACF,IAAA,gDAAmC,EAAC,UAAU,CAAC,MAAA,CAAC;YAElD,IAAI,uBAAA,IAAI,8DAA8B,IAAI,gBAAgB,EAAE;gBAC1D,MAAM,IAAI,CAAC,YAAY,EAAE,CAAC;aAC3B;QACH,CAAC,CAAA,CACF,CAAC;IACJ,CAAC;IAED;;OAEG;IACH,MAAM;QACJ,uBAAA,IAAI,sCAAa,KAAK,MAAA,CAAC;IACzB,CAAC;IAED;;OAEG;IACH,OAAO;QACL,uBAAA,IAAI,sCAAa,IAAI,MAAA,CAAC;IACxB,CAAC;IAED;;OAEG;IACG,KAAK;;YACT,IAAI,CAAC,MAAM,EAAE,CAAC;YACd,MAAM,uBAAA,IAAI,mFAAc,MAAlB,IAAI,CAAgB,CAAC;QAC7B,CAAC;KAAA;IAED;;OAEG;IACH,IAAI;QACF,IAAI,CAAC,OAAO,EAAE,CAAC;QACf,uBAAA,IAAI,kFAAa,MAAjB,IAAI,CAAe,CAAC;IACtB,CAAC;IA+BK,YAAY,CAChB,eAAuB,EACvB,OAA4B;;YAE5B,IAAI,uBAAA,IAAI,0CAAU,EAAE;gBAClB,OAAO;aACR;YACD,MAAM,IAAI,CAAC,YAAY,CAAC;gBACtB,eAAe;gBACf,cAAc,EAAE,OAAO,CAAC,OAAO;aAChC,CAAC,CAAC;QACL,CAAC;KAAA;IAED;;;;;;OAMG;IACG,YAAY,CAAC,EACjB,eAAe,EACf,cAAc,MAIZ,EAAE;;YACJ,IACE,uBAAA,IAAI,0CAAU;gBACd,CAAC,uBAAA,IAAI,8DAA8B;gBACnC,CAAC,uBAAA,IAAI,mEAAmC,EACxC;gBACA,OAAO;aACR;YACD,MAAM,EAAE,MAAM,EAAE,GAAG,uBAAA,IAAI,gDAAgB,MAApB,IAAI,CAAkB,CAAC;YAC1C,MAAM,eAAe,GAAG,cAAc,IAAI,uBAAA,IAAI,iDAAiB,CAAC;YAChE,MAAM,OAAO,GAAG,uBAAA,IAAI,wFAAmB,MAAvB,IAAI,EAAoB,eAAe,CAAC,CAAC;YAEzD,MAAM,eAAe,GAAG,MAAM,CAAC,GAAG;YAChC,yBAAyB,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,OAAO,CAAC,WAAW,EAAE,CACjE,CAAC;YACF,MAAM,EAAE,SAAS,EAAE,GAAG,IAAI,CAAC,eAAe,CAAC,IAAI,CAC7C,8BAA8B,CAC/B,CAAC;YACF,MAAM,cAAc,GAAa,EAAE,CAAC;YACpC,KAAK,MAAM,OAAO,IAAI,MAAM,CAAC,IAAI,CAAC,SAAS,CAAC,EAAE;gBAC5C,IAAI,CAAC,eAAe,CAAC,QAAQ,CAAC,OAAO,CAAC,EAAE;oBACtC,cAAc,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;iBAC9B;aACF;YACD,MAAM,qBAAqB,GAAG,EAAE,CAAC;YACjC,qBAAqB,CAAC,CAAC,CAAC,GAAG,cAAc,CAAC,KAAK,CAAC,CAAC,EAAE,IAAI,CAAC,CAAC;YACzD,qBAAqB,CAAC,CAAC,CAAC,GAAG,cAAc,CAAC,KAAK,CAC7C,IAAI,EACJ,cAAc,CAAC,MAAM,GAAG,CAAC,CAC1B,CAAC;YAEF,0BAA0B;YAC1B,IAAI,CAAC,eAAe,EAAE;gBACpB,OAAO;aACR;YAED,KAAK,MAAM,WAAW,IAAI,qBAAqB,EAAE;gBAC/C,IAAI,WAAW,CAAC,MAAM,KAAK,CAAC,EAAE;oBAC5B,MAAM;iBACP;gBAED,MAAM,IAAA,gCAAa,EAAC,GAAS,EAAE;;oBAC7B,MAAM,QAAQ,GAAG,MAAM,uBAAA,IAAI,yDAAyB,MAA7B,IAAI,EACzB,eAAe,EACf,WAAW,CACZ,CAAC;oBACF,MAAM,WAAW,GAAY,EAAE,CAAC;oBAChC,KAAK,MAAM,YAAY,IAAI,MAAM,CAAC,IAAI,CAAC,QAAQ,CAAC,EAAE;wBAChD,IAAI,OAAO,CAAC;wBACZ,0BAA0B;wBAC1B,MAAM,EAAE,aAAa,EAAE,GAAG,uBAAA,IAAI,gDAAgB,MAApB,IAAI,CAAkB,CAAC;wBACjD,IAAI,aAAa,CAAC,MAAM,EAAE;4BACxB,OAAO,GAAG,aAAa,CAAC,IAAI,CAC1B,CAAC,mBAAmB,EAAE,EAAE,CACtB,mBAAmB,KAAK,IAAA,uCAAoB,EAAC,YAAY,CAAC,CAC7D,CAAC;yBACH;wBACD,MAAM,uBAAuB,GAC3B,MAAA,MAAM,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC,IAAI,CACzB,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,WAAW,EAAE,KAAK,YAAY,CAAC,WAAW,EAAE,CACtD,mCAAI,EAAE,CAAC;wBAEV,IAAI,OAAO,KAAK,SAAS,EAAE;4BACzB,MAAM,EAAE,QAAQ,EAAE,MAAM,EAAE,WAAW,EAAE,OAAO,EAAE,IAAI,EAAE,GACpD,SAAS,CAAC,uBAAuB,CAAC,CAAC;4BACrC,WAAW,CAAC,IAAI,CAAC;gCACf,OAAO,EAAE,YAAY;gCACrB,QAAQ;gCACR,MAAM;gCACN,WAAW;gCACX,KAAK,EAAE,OAAO;gCACd,QAAQ,EAAE,KAAK;gCACf,IAAI;6BACL,CAAC,CAAC;yBACJ;qBACF;oBAED,IAAI,WAAW,CAAC,MAAM,EAAE;wBACtB,MAAM,uBAAA,IAAI,mDAAmB,MAAvB,IAAI,EAAoB,WAAW,EAAE;4BACzC,eAAe;4BACf,OAAO;yBACR,CAAC,CAAC;qBACJ;gBACH,CAAC,CAAA,CAAC,CAAC;aACJ;QACH,CAAC;KAAA;CACF;AAtTD,4DAsTC;;IA5IG,IAAI,uBAAA,IAAI,4CAAY,EAAE;QACpB,aAAa,CAAC,uBAAA,IAAI,4CAAY,CAAC,CAAC;KACjC;AACH,CAAC;;QAMC,IAAI,uBAAA,IAAI,0CAAU,EAAE;YAClB,OAAO;SACR;QACD,uBAAA,IAAI,kFAAa,MAAjB,IAAI,CAAe,CAAC;QACpB,MAAM,IAAI,CAAC,YAAY,EAAE,CAAC;QAC1B,uBAAA,IAAI,wCAAe,WAAW,CAAC,GAAS,EAAE;YACxC,MAAM,IAAI,CAAC,YAAY,EAAE,CAAC;QAC5B,CAAC,CAAA,EAAE,IAAI,CAAC,iBAAiB,EAAE,CAAC,MAAA,CAAC;IAC/B,CAAC;sGAEkB,eAAiC;;IAClD,MAAM,EAAE,OAAO,EAAE,GACf,MAAA,IAAI,CAAC,eAAe,CAAC,IAAI,CACvB,4DAA4D,EAC5D,eAAe,aAAf,eAAe,cAAf,eAAe,GAAI,uBAAA,IAAI,iDAAiB,CACzC,mCAAI,EAAE,CAAC;IACV,OAAO,OAAO,aAAP,OAAO,cAAP,OAAO,GAAI,uBAAA,IAAI,yCAAS,CAAC;AAClC,CAAC;AAoHH,kBAAe,wBAAwB,CAAC","sourcesContent":["import type {\n  RestrictedControllerMessenger,\n  ControllerGetStateAction,\n  ControllerStateChangeEvent,\n} from '@metamask/base-controller';\nimport {\n  safelyExecute,\n  toChecksumHexAddress,\n} from '@metamask/controller-utils';\nimport type {\n  NetworkClientId,\n  NetworkControllerNetworkDidChangeEvent,\n  NetworkControllerStateChangeEvent,\n  NetworkControllerGetNetworkConfigurationByNetworkClientId,\n} from '@metamask/network-controller';\nimport { StaticIntervalPollingController } from '@metamask/polling-controller';\nimport type { PreferencesState } from '@metamask/preferences-controller';\nimport type { Hex } from '@metamask/utils';\n\nimport type { AssetsContractController } from './AssetsContractController';\nimport { isTokenDetectionSupportedForNetwork } from './assetsUtil';\nimport type {\n  GetTokenListState,\n  TokenListStateChange,\n} from './TokenListController';\nimport type { Token } from './TokenRatesController';\nimport type { TokensController, TokensState } from './TokensController';\n\nconst DEFAULT_INTERVAL = 180000;\n\nexport const controllerName = 'TokenDetectionController';\n\nexport type TokenDetectionState = Record<never, never>;\n\nexport type TokenDetectionControllerGetStateAction = ControllerGetStateAction<\n  typeof controllerName,\n  TokenDetectionState\n>;\n\nexport type TokenDetectionControllerActions =\n  TokenDetectionControllerGetStateAction;\n\nexport type AllowedActions =\n  | NetworkControllerGetNetworkConfigurationByNetworkClientId\n  | GetTokenListState;\n\nexport type TokenDetectionControllerStateChangeEvent =\n  ControllerStateChangeEvent<typeof controllerName, TokenDetectionState>;\n\nexport type TokenDetectionControllerEvents =\n  TokenDetectionControllerStateChangeEvent;\n\nexport type AllowedEvents =\n  | NetworkControllerStateChangeEvent\n  | NetworkControllerNetworkDidChangeEvent\n  | TokenListStateChange;\n\nexport type TokenDetectionControllerMessenger = RestrictedControllerMessenger<\n  typeof controllerName,\n  TokenDetectionControllerActions | AllowedActions,\n  TokenDetectionControllerEvents | AllowedEvents,\n  AllowedActions['type'],\n  AllowedEvents['type']\n>;\n\n/**\n * Controller that passively polls on a set interval for Tokens auto detection\n * @property intervalId - Polling interval used to fetch new token rates\n * @property chainId - The chain ID of the current network\n * @property selectedAddress - Vault selected address\n * @property networkClientId - The network client ID of the current selected network\n * @property disabled - Boolean to track if network requests are blocked\n * @property isDetectionEnabledFromPreferences - Boolean to track if detection is enabled from PreferencesController\n * @property isDetectionEnabledForNetwork - Boolean to track if detected is enabled for current network\n */\nexport class TokenDetectionController extends StaticIntervalPollingController<\n  typeof controllerName,\n  TokenDetectionState,\n  TokenDetectionControllerMessenger\n> {\n  #intervalId?: ReturnType<typeof setTimeout>;\n\n  #chainId: Hex;\n\n  #selectedAddress: string;\n\n  #networkClientId: NetworkClientId;\n\n  #disabled: boolean;\n\n  #isDetectionEnabledFromPreferences: boolean;\n\n  #isDetectionEnabledForNetwork: boolean;\n\n  readonly #addDetectedTokens: TokensController['addDetectedTokens'];\n\n  readonly #getBalancesInSingleCall: AssetsContractController['getBalancesInSingleCall'];\n\n  readonly #getTokensState: () => TokensState;\n\n  /**\n   * Creates a TokenDetectionController instance.\n   *\n   * @param options - The controller options.\n   * @param options.messenger - The controller messaging system.\n   * @param options.disabled - If set to true, all network requests are blocked.\n   * @param options.interval - Polling interval used to fetch new token rates\n   * @param options.networkClientId - The selected network client ID of the current network\n   * @param options.selectedAddress - Vault selected address\n   * @param options.onPreferencesStateChange - Allows subscribing to preferences controller state changes.\n   * @param options.addDetectedTokens - Add a list of detected tokens.\n   * @param options.getBalancesInSingleCall - Gets the balances of a list of tokens for the given address.\n   * @param options.getTokensState - Gets the current state of the Tokens controller.\n   * @param options.getPreferencesState - Gets the state of the preferences controller.\n   */\n  constructor({\n    networkClientId,\n    selectedAddress = '',\n    interval = DEFAULT_INTERVAL,\n    disabled = true,\n    onPreferencesStateChange,\n    getBalancesInSingleCall,\n    addDetectedTokens,\n    getPreferencesState,\n    getTokensState,\n    messenger,\n  }: {\n    networkClientId: NetworkClientId;\n    selectedAddress?: string;\n    interval?: number;\n    disabled?: boolean;\n    onPreferencesStateChange: (\n      listener: (preferencesState: PreferencesState) => void,\n    ) => void;\n    addDetectedTokens: TokensController['addDetectedTokens'];\n    getBalancesInSingleCall: AssetsContractController['getBalancesInSingleCall'];\n    getTokensState: () => TokensState;\n    getPreferencesState: () => PreferencesState;\n    messenger: TokenDetectionControllerMessenger;\n  }) {\n    const { useTokenDetection: defaultUseTokenDetection } =\n      getPreferencesState();\n\n    super({\n      name: controllerName,\n      messenger,\n      state: {},\n      metadata: {},\n    });\n\n    this.#disabled = disabled;\n    this.setIntervalLength(interval);\n\n    this.#networkClientId = networkClientId;\n    this.#selectedAddress = selectedAddress;\n    this.#chainId = this.#getCorrectChainId(networkClientId);\n\n    this.#isDetectionEnabledFromPreferences = defaultUseTokenDetection;\n    this.#isDetectionEnabledForNetwork = isTokenDetectionSupportedForNetwork(\n      this.#chainId,\n    );\n\n    this.#addDetectedTokens = addDetectedTokens;\n    this.#getBalancesInSingleCall = getBalancesInSingleCall;\n    this.#getTokensState = getTokensState;\n\n    this.messagingSystem.subscribe(\n      'TokenListController:stateChange',\n      async ({ tokenList }) => {\n        const hasTokens = Object.keys(tokenList).length;\n\n        if (hasTokens) {\n          await this.detectTokens();\n        }\n      },\n    );\n\n    onPreferencesStateChange(\n      async ({ selectedAddress: newSelectedAddress, useTokenDetection }) => {\n        const isSelectedAddressChanged =\n          this.#selectedAddress !== newSelectedAddress;\n        const isDetectionChangedFromPreferences =\n          this.#isDetectionEnabledFromPreferences !== useTokenDetection;\n\n        this.#selectedAddress = newSelectedAddress;\n        this.#isDetectionEnabledFromPreferences = useTokenDetection;\n\n        if (\n          useTokenDetection &&\n          (isSelectedAddressChanged || isDetectionChangedFromPreferences)\n        ) {\n          await this.detectTokens();\n        }\n      },\n    );\n\n    this.messagingSystem.subscribe(\n      'NetworkController:networkDidChange',\n      async ({ selectedNetworkClientId }) => {\n        this.#networkClientId = selectedNetworkClientId;\n        const newChainId = this.#getCorrectChainId(selectedNetworkClientId);\n        const isChainIdChanged = this.#chainId !== newChainId;\n        this.#chainId = newChainId;\n\n        this.#isDetectionEnabledForNetwork =\n          isTokenDetectionSupportedForNetwork(newChainId);\n\n        if (this.#isDetectionEnabledForNetwork && isChainIdChanged) {\n          await this.detectTokens();\n        }\n      },\n    );\n  }\n\n  /**\n   * Allows controller to make active and passive polling requests\n   */\n  enable() {\n    this.#disabled = false;\n  }\n\n  /**\n   * Blocks controller from making network calls\n   */\n  disable() {\n    this.#disabled = true;\n  }\n\n  /**\n   * Start polling for detected tokens.\n   */\n  async start() {\n    this.enable();\n    await this.#startPolling();\n  }\n\n  /**\n   * Stop polling for detected tokens.\n   */\n  stop() {\n    this.disable();\n    this.#stopPolling();\n  }\n\n  #stopPolling() {\n    if (this.#intervalId) {\n      clearInterval(this.#intervalId);\n    }\n  }\n\n  /**\n   * Starts a new polling interval.\n   */\n  async #startPolling(): Promise<void> {\n    if (this.#disabled) {\n      return;\n    }\n    this.#stopPolling();\n    await this.detectTokens();\n    this.#intervalId = setInterval(async () => {\n      await this.detectTokens();\n    }, this.getIntervalLength());\n  }\n\n  #getCorrectChainId(networkClientId?: NetworkClientId) {\n    const { chainId } =\n      this.messagingSystem.call(\n        'NetworkController:getNetworkConfigurationByNetworkClientId',\n        networkClientId ?? this.#networkClientId,\n      ) ?? {};\n    return chainId ?? this.#chainId;\n  }\n\n  async _executePoll(\n    networkClientId: string,\n    options: { address: string },\n  ): Promise<void> {\n    if (this.#disabled) {\n      return;\n    }\n    await this.detectTokens({\n      networkClientId,\n      accountAddress: options.address,\n    });\n  }\n\n  /**\n   * Triggers asset ERC20 token auto detection for each contract address in contract metadata on mainnet.\n   *\n   * @param options - Options to detect tokens.\n   * @param options.networkClientId - The ID of the network client to use.\n   * @param options.accountAddress - The account address to use.\n   */\n  async detectTokens({\n    networkClientId,\n    accountAddress,\n  }: {\n    networkClientId?: NetworkClientId;\n    accountAddress?: string;\n  } = {}): Promise<void> {\n    if (\n      this.#disabled ||\n      !this.#isDetectionEnabledForNetwork ||\n      !this.#isDetectionEnabledFromPreferences\n    ) {\n      return;\n    }\n    const { tokens } = this.#getTokensState();\n    const selectedAddress = accountAddress || this.#selectedAddress;\n    const chainId = this.#getCorrectChainId(networkClientId);\n\n    const tokensAddresses = tokens.map(\n      /* istanbul ignore next*/ (token) => token.address.toLowerCase(),\n    );\n    const { tokenList } = this.messagingSystem.call(\n      'TokenListController:getState',\n    );\n    const tokensToDetect: string[] = [];\n    for (const address of Object.keys(tokenList)) {\n      if (!tokensAddresses.includes(address)) {\n        tokensToDetect.push(address);\n      }\n    }\n    const sliceOfTokensToDetect = [];\n    sliceOfTokensToDetect[0] = tokensToDetect.slice(0, 1000);\n    sliceOfTokensToDetect[1] = tokensToDetect.slice(\n      1000,\n      tokensToDetect.length - 1,\n    );\n\n    /* istanbul ignore else */\n    if (!selectedAddress) {\n      return;\n    }\n\n    for (const tokensSlice of sliceOfTokensToDetect) {\n      if (tokensSlice.length === 0) {\n        break;\n      }\n\n      await safelyExecute(async () => {\n        const balances = await this.#getBalancesInSingleCall(\n          selectedAddress,\n          tokensSlice,\n        );\n        const tokensToAdd: Token[] = [];\n        for (const tokenAddress of Object.keys(balances)) {\n          let ignored;\n          /* istanbul ignore else */\n          const { ignoredTokens } = this.#getTokensState();\n          if (ignoredTokens.length) {\n            ignored = ignoredTokens.find(\n              (ignoredTokenAddress) =>\n                ignoredTokenAddress === toChecksumHexAddress(tokenAddress),\n            );\n          }\n          const caseInsensitiveTokenKey =\n            Object.keys(tokenList).find(\n              (i) => i.toLowerCase() === tokenAddress.toLowerCase(),\n            ) ?? '';\n\n          if (ignored === undefined) {\n            const { decimals, symbol, aggregators, iconUrl, name } =\n              tokenList[caseInsensitiveTokenKey];\n            tokensToAdd.push({\n              address: tokenAddress,\n              decimals,\n              symbol,\n              aggregators,\n              image: iconUrl,\n              isERC721: false,\n              name,\n            });\n          }\n        }\n\n        if (tokensToAdd.length) {\n          await this.#addDetectedTokens(tokensToAdd, {\n            selectedAddress,\n            chainId,\n          });\n        }\n      });\n    }\n  }\n}\n\nexport default TokenDetectionController;\n"]}
+{"version":3,"file":"TokenDetectionController.js","sourceRoot":"","sources":["../src/TokenDetectionController.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAMA,oFAAsD;AACtD,iEAIoC;AAWpC,qEAA+E;AAQ/E,6CAAmE;AASnE,MAAM,gBAAgB,GAAG,MAAM,CAAC;AAEhC;;;;;GAKG;AACH,SAAS,wBAAwB,CAAC,MAAgB,EAAE,MAAc;IAChE,OAAO,MAAM,CAAC,IAAI,CAAC,CAAC,CAAS,EAAE,EAAE,CAAC,CAAC,CAAC,WAAW,EAAE,KAAK,MAAM,CAAC,WAAW,EAAE,CAAC,CAAC;AAC9E,CAAC;AAYY,QAAA,yBAAyB,GAAG,MAAM,CAAC,OAAO,CACrD,2BAAW,CACZ,CAAC,MAAM,CAA0C,CAAC,GAAG,EAAE,CAAC,IAAI,EAAE,QAAQ,CAAC,EAAE,EAAE;IAC1E,MAAM,EAAE,IAAI,KAAuB,QAAQ,EAA1B,aAAa,UAAK,QAAQ,EAArC,QAA0B,CAAW,CAAC;IAC5C,uCACK,GAAG,KACN,CAAC,IAAI,CAAC,WAAW,EAAE,CAAC,kCACf,aAAa,KAChB,OAAO,EAAE,IAAI,CAAC,WAAW,EAAE,EAC3B,OAAO,EAAE,mBAAmB,IAAI,EAAE,EAClC,WAAW,EAAE,EAAE,OAEjB;AACJ,CAAC,EAAE,EAAE,CAAC,CAAC;AAEM,QAAA,cAAc,GAAG,0BAA0B,CAAC;AAwCzD;;;;;;;;;;GAUG;AACH,MAAa,wBAAyB,SAAQ,oDAI7C;IAiCC;;;;;;;;;;;;;OAaG;IACH,YAAY,EACV,eAAe,EACf,eAAe,GAAG,EAAE,EACpB,QAAQ,GAAG,gBAAgB,EAC3B,QAAQ,GAAG,IAAI,EACf,uBAAuB,EACvB,iBAAiB,EACjB,cAAc,EACd,qBAAqB,EACrB,SAAS,GAmBV;QACC,KAAK,CAAC;YACJ,IAAI,EAAE,sBAAc;YACpB,SAAS;YACT,KAAK,EAAE,EAAE;YACT,QAAQ,EAAE,EAAE;SACb,CAAC,CAAC;;QAhFL,uDAA4C;QAE5C,oDAAc;QAEd,4DAAyB;QAEzB,4DAAkC;QAElC,qDAAmB;QAEnB,uDAAqB;QAErB,8EAA4C;QAE5C,yEAAuC;QAEvC,8DAAmE;QAEnE,oEAAuF;QAEvF,2DAA4C;QAE5C,kEAQW;QAoDT,uBAAA,IAAI,sCAAa,QAAQ,MAAA,CAAC;QAC1B,IAAI,CAAC,iBAAiB,CAAC,QAAQ,CAAC,CAAC;QAEjC,uBAAA,IAAI,6CAAoB,eAAe,MAAA,CAAC;QACxC,uBAAA,IAAI,6CAAoB,eAAe,MAAA,CAAC;QACxC,uBAAA,IAAI,qCAAY,uBAAA,IAAI,wFAAmB,MAAvB,IAAI,EAAoB,eAAe,CAAC,MAAA,CAAC;QAEzD,MAAM,EAAE,iBAAiB,EAAE,wBAAwB,EAAE,GACnD,IAAI,CAAC,eAAe,CAAC,IAAI,CAAC,gCAAgC,CAAC,CAAC;QAC9D,uBAAA,IAAI,+DAAsC,wBAAwB,MAAA,CAAC;QACnE,uBAAA,IAAI,0DAAiC,IAAA,gDAAmC,EACtE,uBAAA,IAAI,yCAAS,CACd,MAAA,CAAC;QAEF,uBAAA,IAAI,+CAAsB,iBAAiB,MAAA,CAAC;QAC5C,uBAAA,IAAI,qDAA4B,uBAAuB,MAAA,CAAC;QACxD,uBAAA,IAAI,4CAAmB,cAAc,MAAA,CAAC;QAEtC,uBAAA,IAAI,mDAA0B,qBAAqB,MAAA,CAAC;QAEpD,MAAM,EAAE,UAAU,EAAE,GAAG,IAAI,CAAC,eAAe,CAAC,IAAI,CAC9C,4BAA4B,CAC7B,CAAC;QACF,uBAAA,IAAI,wCAAe,UAAU,MAAA,CAAC;QAE9B,uBAAA,IAAI,6FAAwB,MAA5B,IAAI,CAA0B,CAAC;IACjC,CAAC;IAsFD;;OAEG;IACH,MAAM;QACJ,uBAAA,IAAI,sCAAa,KAAK,MAAA,CAAC;IACzB,CAAC;IAED;;OAEG;IACH,OAAO;QACL,uBAAA,IAAI,sCAAa,IAAI,MAAA,CAAC;IACxB,CAAC;IAED;;;;OAIG;IACH,IAAI,QAAQ;QACV,OAAO,CAAC,uBAAA,IAAI,0CAAU,IAAI,uBAAA,IAAI,4CAAY,CAAC;IAC7C,CAAC;IAED;;OAEG;IACG,KAAK;;YACT,IAAI,CAAC,MAAM,EAAE,CAAC;YACd,MAAM,uBAAA,IAAI,mFAAc,MAAlB,IAAI,CAAgB,CAAC;QAC7B,CAAC;KAAA;IAED;;OAEG;IACH,IAAI;QACF,IAAI,CAAC,OAAO,EAAE,CAAC;QACf,uBAAA,IAAI,kFAAa,MAAjB,IAAI,CAAe,CAAC;IACtB,CAAC;IA+BK,YAAY,CAChB,eAAuB,EACvB,OAA4B;;YAE5B,IAAI,CAAC,IAAI,CAAC,QAAQ,EAAE;gBAClB,OAAO;aACR;YACD,MAAM,IAAI,CAAC,YAAY,CAAC;gBACtB,eAAe;gBACf,cAAc,EAAE,OAAO,CAAC,OAAO;aAChC,CAAC,CAAC;QACL,CAAC;KAAA;IAqBD;;;;;;;OAOG;IACG,YAAY,CAAC,EACjB,eAAe,EACf,cAAc,MAIZ,EAAE;;YACJ,IAAI,CAAC,IAAI,CAAC,QAAQ,IAAI,CAAC,uBAAA,IAAI,8DAA8B,EAAE;gBACzD,OAAO;aACR;YACD,MAAM,eAAe,GAAG,cAAc,aAAd,cAAc,cAAd,cAAc,GAAI,uBAAA,IAAI,iDAAiB,CAAC;YAChE,MAAM,OAAO,GAAG,uBAAA,IAAI,wFAAmB,MAAvB,IAAI,EAAoB,eAAe,CAAC,CAAC;YAEzD,IACE,CAAC,uBAAA,IAAI,mEAAmC;gBACxC,OAAO,KAAK,0BAAO,CAAC,OAAO,EAC3B;gBACA,OAAO;aACR;YACD,MAAM,iCAAiC,GACrC,CAAC,uBAAA,IAAI,mEAAmC,IAAI,OAAO,KAAK,0BAAO,CAAC,OAAO,CAAC;YAC1E,MAAM,EAAE,SAAS,EAAE,GAAG,IAAI,CAAC,eAAe,CAAC,IAAI,CAC7C,8BAA8B,CAC/B,CAAC;YACF,MAAM,aAAa,GAAG,iCAAiC;gBACrD,CAAC,CAAC,iCAAyB;gBAC3B,CAAC,CAAC,SAAS,CAAC;YAEd,MAAM,EAAE,MAAM,EAAE,cAAc,EAAE,GAAG,uBAAA,IAAI,gDAAgB,MAApB,IAAI,CAAkB,CAAC;YAC1D,MAAM,cAAc,GAAa,EAAE,CAAC;YAEpC,KAAK,MAAM,YAAY,IAAI,MAAM,CAAC,IAAI,CAAC,aAAa,CAAC,EAAE;gBACrD,IACE,CAAC,wBAAwB,CACvB,MAAM,CAAC,GAAG,CAAC,CAAC,EAAE,OAAO,EAAE,EAAE,EAAE,CAAC,OAAO,CAAC,EACpC,YAAY,CACb;oBACD,CAAC,wBAAwB,CACvB,cAAc,CAAC,GAAG,CAAC,CAAC,EAAE,OAAO,EAAE,EAAE,EAAE,CAAC,OAAO,CAAC,EAC5C,YAAY,CACb,EACD;oBACA,cAAc,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC;iBACnC;aACF;YACD,MAAM,qBAAqB,GAAG,EAAE,CAAC;YACjC,qBAAqB,CAAC,CAAC,CAAC,GAAG,cAAc,CAAC,KAAK,CAAC,CAAC,EAAE,IAAI,CAAC,CAAC;YACzD,qBAAqB,CAAC,CAAC,CAAC,GAAG,cAAc,CAAC,KAAK,CAC7C,IAAI,EACJ,cAAc,CAAC,MAAM,GAAG,CAAC,CAC1B,CAAC;YAEF,0BAA0B;YAC1B,IAAI,CAAC,eAAe,EAAE;gBACpB,OAAO;aACR;YAED,KAAK,MAAM,WAAW,IAAI,qBAAqB,EAAE;gBAC/C,IAAI,WAAW,CAAC,MAAM,KAAK,CAAC,EAAE;oBAC5B,MAAM;iBACP;gBAED,MAAM,IAAA,gCAAa,EAAC,GAAS,EAAE;;oBAC7B,MAAM,QAAQ,GAAG,MAAM,uBAAA,IAAI,yDAAyB,MAA7B,IAAI,EACzB,eAAe,EACf,WAAW,CACZ,CAAC;oBACF,MAAM,WAAW,GAAY,EAAE,CAAC;oBAChC,MAAM,kBAAkB,GAAG,EAAE,CAAC;oBAC9B,KAAK,MAAM,YAAY,IAAI,MAAM,CAAC,IAAI,CAAC,QAAQ,CAAC,EAAE;wBAChD,IAAI,OAAO,CAAC;wBACZ,0BAA0B;wBAC1B,MAAM,EAAE,aAAa,EAAE,GAAG,uBAAA,IAAI,gDAAgB,MAApB,IAAI,CAAkB,CAAC;wBACjD,IAAI,aAAa,CAAC,MAAM,EAAE;4BACxB,OAAO,GAAG,aAAa,CAAC,IAAI,CAC1B,CAAC,mBAAmB,EAAE,EAAE,CACtB,mBAAmB,KAAK,IAAA,uCAAoB,EAAC,YAAY,CAAC,CAC7D,CAAC;yBACH;wBACD,MAAM,uBAAuB,GAC3B,MAAA,wBAAwB,CACtB,MAAM,CAAC,IAAI,CAAC,aAAa,CAAC,EAC1B,YAAY,CACb,mCAAI,EAAE,CAAC;wBAEV,IAAI,OAAO,KAAK,SAAS,EAAE;4BACzB,MAAM,EAAE,QAAQ,EAAE,MAAM,EAAE,WAAW,EAAE,OAAO,EAAE,IAAI,EAAE,GACpD,SAAS,CAAC,uBAAuB,CAAC,CAAC;4BACrC,kBAAkB,CAAC,IAAI,CAAC,GAAG,MAAM,MAAM,YAAY,EAAE,CAAC,CAAC;4BACvD,WAAW,CAAC,IAAI,CAAC;gCACf,OAAO,EAAE,YAAY;gCACrB,QAAQ;gCACR,MAAM;gCACN,WAAW;gCACX,KAAK,EAAE,OAAO;gCACd,QAAQ,EAAE,KAAK;gCACf,IAAI;6BACL,CAAC,CAAC;yBACJ;qBACF;oBAED,IAAI,WAAW,CAAC,MAAM,EAAE;wBACtB,uBAAA,IAAI,uDAAuB,MAA3B,IAAI,EAAwB;4BAC1B,KAAK,EAAE,gBAAgB;4BACvB,QAAQ,EAAE,QAAQ;4BAClB,UAAU,EAAE;gCACV,MAAM,EAAE,kBAAkB;gCAC1B,cAAc,EAAE,OAAO;gCACvB,UAAU,EAAE,OAAO;6BACpB;yBACF,CAAC,CAAC;wBACH,MAAM,uBAAA,IAAI,mDAAmB,MAAvB,IAAI,EAAoB,WAAW,EAAE;4BACzC,eAAe;4BACf,OAAO;yBACR,CAAC,CAAC;qBACJ;gBACH,CAAC,CAAA,CAAC,CAAC;aACJ;QACH,CAAC;KAAA;CACF;AA1aD,4DA0aC;;IAnTG,IAAI,CAAC,eAAe,CAAC,SAAS,CAAC,0BAA0B,EAAE,GAAS,EAAE;QACpE,uBAAA,IAAI,wCAAe,IAAI,MAAA,CAAC;QACxB,MAAM,uBAAA,IAAI,4FAAuB,MAA3B,IAAI,CAAyB,CAAC;IACtC,CAAC,CAAA,CAAC,CAAC;IAEH,IAAI,CAAC,eAAe,CAAC,SAAS,CAAC,wBAAwB,EAAE,GAAG,EAAE;QAC5D,uBAAA,IAAI,wCAAe,KAAK,MAAA,CAAC;QACzB,uBAAA,IAAI,kFAAa,MAAjB,IAAI,CAAe,CAAC;IACtB,CAAC,CAAC,CAAC;IAEH,IAAI,CAAC,eAAe,CAAC,SAAS,CAC5B,iCAAiC,EACjC,CAAO,EAAE,SAAS,EAAE,EAAE,EAAE;QACtB,MAAM,SAAS,GAAG,MAAM,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC,MAAM,CAAC;QAEhD,IAAI,SAAS,EAAE;YACb,MAAM,uBAAA,IAAI,4FAAuB,MAA3B,IAAI,CAAyB,CAAC;SACrC;IACH,CAAC,CAAA,CACF,CAAC;IAEF,IAAI,CAAC,eAAe,CAAC,SAAS,CAC5B,mCAAmC,EACnC,CAAO,EAAE,eAAe,EAAE,kBAAkB,EAAE,iBAAiB,EAAE,EAAE,EAAE;QACnE,MAAM,wBAAwB,GAC5B,uBAAA,IAAI,iDAAiB,KAAK,kBAAkB,CAAC;QAC/C,MAAM,iCAAiC,GACrC,uBAAA,IAAI,mEAAmC,KAAK,iBAAiB,CAAC;QAEhE,uBAAA,IAAI,6CAAoB,kBAAkB,MAAA,CAAC;QAC3C,uBAAA,IAAI,+DAAsC,iBAAiB,MAAA,CAAC;QAE5D,IACE,iBAAiB;YACjB,CAAC,wBAAwB,IAAI,iCAAiC,CAAC,EAC/D;YACA,MAAM,uBAAA,IAAI,4FAAuB,MAA3B,IAAI,EAAwB;gBAChC,eAAe,EAAE,uBAAA,IAAI,iDAAiB;aACvC,CAAC,CAAC;SACJ;IACH,CAAC,CAAA,CACF,CAAC;IAEF,IAAI,CAAC,eAAe,CAAC,SAAS,CAC5B,0CAA0C,EAC1C,CAAO,EAAE,OAAO,EAAE,kBAAkB,EAAE,EAAE,EAAE;QACxC,MAAM,wBAAwB,GAC5B,uBAAA,IAAI,iDAAiB,KAAK,kBAAkB,CAAC;QAC/C,IACE,wBAAwB;YACxB,uBAAA,IAAI,mEAAmC,EACvC;YACA,uBAAA,IAAI,6CAAoB,kBAAkB,MAAA,CAAC;YAC3C,MAAM,uBAAA,IAAI,4FAAuB,MAA3B,IAAI,EAAwB;gBAChC,eAAe,EAAE,uBAAA,IAAI,iDAAiB;aACvC,CAAC,CAAC;SACJ;IACH,CAAC,CAAA,CACF,CAAC;IAEF,IAAI,CAAC,eAAe,CAAC,SAAS,CAC5B,oCAAoC,EACpC,CAAO,EAAE,uBAAuB,EAAE,EAAE,EAAE;QACpC,MAAM,wBAAwB,GAC5B,uBAAA,IAAI,iDAAiB,KAAK,uBAAuB,CAAC;QAEpD,MAAM,UAAU,GAAG,uBAAA,IAAI,wFAAmB,MAAvB,IAAI,EAAoB,uBAAuB,CAAC,CAAC;QACpE,uBAAA,IAAI,0DACF,IAAA,gDAAmC,EAAC,UAAU,CAAC,MAAA,CAAC;QAElD,IAAI,wBAAwB,IAAI,uBAAA,IAAI,8DAA8B,EAAE;YAClE,uBAAA,IAAI,6CAAoB,uBAAuB,MAAA,CAAC;YAChD,MAAM,uBAAA,IAAI,4FAAuB,MAA3B,IAAI,EAAwB;gBAChC,eAAe,EAAE,uBAAA,IAAI,iDAAiB;aACvC,CAAC,CAAC;SACJ;IACH,CAAC,CAAA,CACF,CAAC;AACJ,CAAC;IA0CC,IAAI,uBAAA,IAAI,4CAAY,EAAE;QACpB,aAAa,CAAC,uBAAA,IAAI,4CAAY,CAAC,CAAC;KACjC;AACH,CAAC;;QAMC,IAAI,CAAC,IAAI,CAAC,QAAQ,EAAE;YAClB,OAAO;SACR;QACD,uBAAA,IAAI,kFAAa,MAAjB,IAAI,CAAe,CAAC;QACpB,MAAM,IAAI,CAAC,YAAY,EAAE,CAAC;QAC1B,uBAAA,IAAI,wCAAe,WAAW,CAAC,GAAS,EAAE;YACxC,MAAM,IAAI,CAAC,YAAY,EAAE,CAAC;QAC5B,CAAC,CAAA,EAAE,IAAI,CAAC,iBAAiB,EAAE,CAAC,MAAA,CAAC;IAC/B,CAAC;sGAEkB,eAAiC;;IAClD,MAAM,EAAE,OAAO,EAAE,GACf,MAAA,IAAI,CAAC,eAAe,CAAC,IAAI,CACvB,4DAA4D,EAC5D,eAAe,aAAf,eAAe,cAAf,eAAe,GAAI,uBAAA,IAAI,iDAAiB,CACzC,mCAAI,EAAE,CAAC;IACV,OAAO,OAAO,aAAP,OAAO,cAAP,OAAO,GAAI,uBAAA,IAAI,yCAAS,CAAC;AAClC,CAAC,6GAuB4B,EAC3B,eAAe,EACf,eAAe,MAC2C,EAAE;;QAC5D,MAAM,IAAI,CAAC,YAAY,CAAC;YACtB,eAAe;YACf,cAAc,EAAE,eAAe;SAChC,CAAC,CAAC;QACH,IAAI,CAAC,iBAAiB,CAAC,gBAAgB,CAAC,CAAC;IAC3C,CAAC;;AAmIH,kBAAe,wBAAwB,CAAC","sourcesContent":["import type { AccountsControllerSelectedAccountChangeEvent } from '@metamask/accounts-controller';\nimport type {\n  RestrictedControllerMessenger,\n  ControllerGetStateAction,\n  ControllerStateChangeEvent,\n} from '@metamask/base-controller';\nimport contractMap from '@metamask/contract-metadata';\nimport {\n  ChainId,\n  safelyExecute,\n  toChecksumHexAddress,\n} from '@metamask/controller-utils';\nimport type {\n  KeyringControllerGetStateAction,\n  KeyringControllerLockEvent,\n  KeyringControllerUnlockEvent,\n} from '@metamask/keyring-controller';\nimport type {\n  NetworkClientId,\n  NetworkControllerNetworkDidChangeEvent,\n  NetworkControllerGetNetworkConfigurationByNetworkClientId,\n} from '@metamask/network-controller';\nimport { StaticIntervalPollingController } from '@metamask/polling-controller';\nimport type {\n  PreferencesControllerGetStateAction,\n  PreferencesControllerStateChangeEvent,\n} from '@metamask/preferences-controller';\nimport type { Hex } from '@metamask/utils';\n\nimport type { AssetsContractController } from './AssetsContractController';\nimport { isTokenDetectionSupportedForNetwork } from './assetsUtil';\nimport type {\n  GetTokenListState,\n  TokenListStateChange,\n  TokenListToken,\n} from './TokenListController';\nimport type { Token } from './TokenRatesController';\nimport type { TokensController, TokensState } from './TokensController';\n\nconst DEFAULT_INTERVAL = 180000;\n\n/**\n * Finds a case insensitive match in an array of strings\n * @param source - An array of strings to search.\n * @param target - The target string to search for.\n * @returns The first match that is found.\n */\nfunction findCaseInsensitiveMatch(source: string[], target: string) {\n  return source.find((e: string) => e.toLowerCase() === target.toLowerCase());\n}\n\ntype LegacyToken = Omit<\n  Token,\n  'aggregators' | 'image' | 'balanceError' | 'isERC721'\n> & {\n  name: string;\n  logo: string;\n  erc20?: boolean;\n  erc721?: boolean;\n};\n\nexport const STATIC_MAINNET_TOKEN_LIST = Object.entries<LegacyToken>(\n  contractMap,\n).reduce<Record<string, Partial<TokenListToken>>>((acc, [base, contract]) => {\n  const { logo, ...tokenMetadata } = contract;\n  return {\n    ...acc,\n    [base.toLowerCase()]: {\n      ...tokenMetadata,\n      address: base.toLowerCase(),\n      iconUrl: `images/contract/${logo}`,\n      aggregators: [],\n    },\n  };\n}, {});\n\nexport const controllerName = 'TokenDetectionController';\n\nexport type TokenDetectionState = Record<never, never>;\n\nexport type TokenDetectionControllerGetStateAction = ControllerGetStateAction<\n  typeof controllerName,\n  TokenDetectionState\n>;\n\nexport type TokenDetectionControllerActions =\n  TokenDetectionControllerGetStateAction;\n\nexport type AllowedActions =\n  | NetworkControllerGetNetworkConfigurationByNetworkClientId\n  | GetTokenListState\n  | KeyringControllerGetStateAction\n  | PreferencesControllerGetStateAction;\n\nexport type TokenDetectionControllerStateChangeEvent =\n  ControllerStateChangeEvent<typeof controllerName, TokenDetectionState>;\n\nexport type TokenDetectionControllerEvents =\n  TokenDetectionControllerStateChangeEvent;\n\nexport type AllowedEvents =\n  | AccountsControllerSelectedAccountChangeEvent\n  | NetworkControllerNetworkDidChangeEvent\n  | TokenListStateChange\n  | KeyringControllerLockEvent\n  | KeyringControllerUnlockEvent\n  | PreferencesControllerStateChangeEvent;\n\nexport type TokenDetectionControllerMessenger = RestrictedControllerMessenger<\n  typeof controllerName,\n  TokenDetectionControllerActions | AllowedActions,\n  TokenDetectionControllerEvents | AllowedEvents,\n  AllowedActions['type'],\n  AllowedEvents['type']\n>;\n\n/**\n * Controller that passively polls on a set interval for Tokens auto detection\n * @property intervalId - Polling interval used to fetch new token rates\n * @property chainId - The chain ID of the current network\n * @property selectedAddress - Vault selected address\n * @property networkClientId - The network client ID of the current selected network\n * @property disabled - Boolean to track if network requests are blocked\n * @property isUnlocked - Boolean to track if the keyring state is unlocked\n * @property isDetectionEnabledFromPreferences - Boolean to track if detection is enabled from PreferencesController\n * @property isDetectionEnabledForNetwork - Boolean to track if detected is enabled for current network\n */\nexport class TokenDetectionController extends StaticIntervalPollingController<\n  typeof controllerName,\n  TokenDetectionState,\n  TokenDetectionControllerMessenger\n> {\n  #intervalId?: ReturnType<typeof setTimeout>;\n\n  #chainId: Hex;\n\n  #selectedAddress: string;\n\n  #networkClientId: NetworkClientId;\n\n  #disabled: boolean;\n\n  #isUnlocked: boolean;\n\n  #isDetectionEnabledFromPreferences: boolean;\n\n  #isDetectionEnabledForNetwork: boolean;\n\n  readonly #addDetectedTokens: TokensController['addDetectedTokens'];\n\n  readonly #getBalancesInSingleCall: AssetsContractController['getBalancesInSingleCall'];\n\n  readonly #getTokensState: () => TokensState;\n\n  readonly #trackMetaMetricsEvent: (options: {\n    event: string;\n    category: string;\n    properties: {\n      tokens: string[];\n      token_standard: string;\n      asset_type: string;\n    };\n  }) => void;\n\n  /**\n   * Creates a TokenDetectionController instance.\n   *\n   * @param options - The controller options.\n   * @param options.messenger - The controller messaging system.\n   * @param options.disabled - If set to true, all network requests are blocked.\n   * @param options.interval - Polling interval used to fetch new token rates\n   * @param options.networkClientId - The selected network client ID of the current network\n   * @param options.selectedAddress - Vault selected address\n   * @param options.addDetectedTokens - Add a list of detected tokens.\n   * @param options.getBalancesInSingleCall - Gets the balances of a list of tokens for the given address.\n   * @param options.getTokensState - Gets the current state of the Tokens controller.\n   * @param options.trackMetaMetricsEvent - Sets options for MetaMetrics event tracking.\n   */\n  constructor({\n    networkClientId,\n    selectedAddress = '',\n    interval = DEFAULT_INTERVAL,\n    disabled = true,\n    getBalancesInSingleCall,\n    addDetectedTokens,\n    getTokensState,\n    trackMetaMetricsEvent,\n    messenger,\n  }: {\n    networkClientId: NetworkClientId;\n    selectedAddress?: string;\n    interval?: number;\n    disabled?: boolean;\n    addDetectedTokens: TokensController['addDetectedTokens'];\n    getBalancesInSingleCall: AssetsContractController['getBalancesInSingleCall'];\n    getTokensState: () => TokensState;\n    trackMetaMetricsEvent: (options: {\n      event: string;\n      category: string;\n      properties: {\n        tokens: string[];\n        token_standard: string;\n        asset_type: string;\n      };\n    }) => void;\n    messenger: TokenDetectionControllerMessenger;\n  }) {\n    super({\n      name: controllerName,\n      messenger,\n      state: {},\n      metadata: {},\n    });\n\n    this.#disabled = disabled;\n    this.setIntervalLength(interval);\n\n    this.#networkClientId = networkClientId;\n    this.#selectedAddress = selectedAddress;\n    this.#chainId = this.#getCorrectChainId(networkClientId);\n\n    const { useTokenDetection: defaultUseTokenDetection } =\n      this.messagingSystem.call('PreferencesController:getState');\n    this.#isDetectionEnabledFromPreferences = defaultUseTokenDetection;\n    this.#isDetectionEnabledForNetwork = isTokenDetectionSupportedForNetwork(\n      this.#chainId,\n    );\n\n    this.#addDetectedTokens = addDetectedTokens;\n    this.#getBalancesInSingleCall = getBalancesInSingleCall;\n    this.#getTokensState = getTokensState;\n\n    this.#trackMetaMetricsEvent = trackMetaMetricsEvent;\n\n    const { isUnlocked } = this.messagingSystem.call(\n      'KeyringController:getState',\n    );\n    this.#isUnlocked = isUnlocked;\n\n    this.#registerEventListeners();\n  }\n\n  /**\n   * Constructor helper for registering this controller's messaging system subscriptions to controller events.\n   */\n  #registerEventListeners() {\n    this.messagingSystem.subscribe('KeyringController:unlock', async () => {\n      this.#isUnlocked = true;\n      await this.#restartTokenDetection();\n    });\n\n    this.messagingSystem.subscribe('KeyringController:lock', () => {\n      this.#isUnlocked = false;\n      this.#stopPolling();\n    });\n\n    this.messagingSystem.subscribe(\n      'TokenListController:stateChange',\n      async ({ tokenList }) => {\n        const hasTokens = Object.keys(tokenList).length;\n\n        if (hasTokens) {\n          await this.#restartTokenDetection();\n        }\n      },\n    );\n\n    this.messagingSystem.subscribe(\n      'PreferencesController:stateChange',\n      async ({ selectedAddress: newSelectedAddress, useTokenDetection }) => {\n        const isSelectedAddressChanged =\n          this.#selectedAddress !== newSelectedAddress;\n        const isDetectionChangedFromPreferences =\n          this.#isDetectionEnabledFromPreferences !== useTokenDetection;\n\n        this.#selectedAddress = newSelectedAddress;\n        this.#isDetectionEnabledFromPreferences = useTokenDetection;\n\n        if (\n          useTokenDetection &&\n          (isSelectedAddressChanged || isDetectionChangedFromPreferences)\n        ) {\n          await this.#restartTokenDetection({\n            selectedAddress: this.#selectedAddress,\n          });\n        }\n      },\n    );\n\n    this.messagingSystem.subscribe(\n      'AccountsController:selectedAccountChange',\n      async ({ address: newSelectedAddress }) => {\n        const isSelectedAddressChanged =\n          this.#selectedAddress !== newSelectedAddress;\n        if (\n          isSelectedAddressChanged &&\n          this.#isDetectionEnabledFromPreferences\n        ) {\n          this.#selectedAddress = newSelectedAddress;\n          await this.#restartTokenDetection({\n            selectedAddress: this.#selectedAddress,\n          });\n        }\n      },\n    );\n\n    this.messagingSystem.subscribe(\n      'NetworkController:networkDidChange',\n      async ({ selectedNetworkClientId }) => {\n        const isNetworkClientIdChanged =\n          this.#networkClientId !== selectedNetworkClientId;\n\n        const newChainId = this.#getCorrectChainId(selectedNetworkClientId);\n        this.#isDetectionEnabledForNetwork =\n          isTokenDetectionSupportedForNetwork(newChainId);\n\n        if (isNetworkClientIdChanged && this.#isDetectionEnabledForNetwork) {\n          this.#networkClientId = selectedNetworkClientId;\n          await this.#restartTokenDetection({\n            networkClientId: this.#networkClientId,\n          });\n        }\n      },\n    );\n  }\n\n  /**\n   * Allows controller to make active and passive polling requests\n   */\n  enable() {\n    this.#disabled = false;\n  }\n\n  /**\n   * Blocks controller from making network calls\n   */\n  disable() {\n    this.#disabled = true;\n  }\n\n  /**\n   * Internal isActive state\n   *\n   * @type {object}\n   */\n  get isActive() {\n    return !this.#disabled && this.#isUnlocked;\n  }\n\n  /**\n   * Start polling for detected tokens.\n   */\n  async start() {\n    this.enable();\n    await this.#startPolling();\n  }\n\n  /**\n   * Stop polling for detected tokens.\n   */\n  stop() {\n    this.disable();\n    this.#stopPolling();\n  }\n\n  #stopPolling() {\n    if (this.#intervalId) {\n      clearInterval(this.#intervalId);\n    }\n  }\n\n  /**\n   * Starts a new polling interval.\n   */\n  async #startPolling(): Promise<void> {\n    if (!this.isActive) {\n      return;\n    }\n    this.#stopPolling();\n    await this.detectTokens();\n    this.#intervalId = setInterval(async () => {\n      await this.detectTokens();\n    }, this.getIntervalLength());\n  }\n\n  #getCorrectChainId(networkClientId?: NetworkClientId) {\n    const { chainId } =\n      this.messagingSystem.call(\n        'NetworkController:getNetworkConfigurationByNetworkClientId',\n        networkClientId ?? this.#networkClientId,\n      ) ?? {};\n    return chainId ?? this.#chainId;\n  }\n\n  async _executePoll(\n    networkClientId: string,\n    options: { address: string },\n  ): Promise<void> {\n    if (!this.isActive) {\n      return;\n    }\n    await this.detectTokens({\n      networkClientId,\n      accountAddress: options.address,\n    });\n  }\n\n  /**\n   * Restart token detection polling period and call detectNewTokens\n   * in case of address change or user session initialization.\n   *\n   * @param options - Options for restart token detection.\n   * @param options.selectedAddress - the selectedAddress against which to detect for token balances\n   * @param options.networkClientId - The ID of the network client to use.\n   */\n  async #restartTokenDetection({\n    selectedAddress,\n    networkClientId,\n  }: { selectedAddress?: string; networkClientId?: string } = {}) {\n    await this.detectTokens({\n      networkClientId,\n      accountAddress: selectedAddress,\n    });\n    this.setIntervalLength(DEFAULT_INTERVAL);\n  }\n\n  /**\n   * For each token in the token list provided by the TokenListController, checks the token's balance for the selected account address on the active network.\n   * On mainnet, if token detection is disabled in preferences, ERC20 token auto detection will be triggered for each contract address in the legacy token list from the @metamask/contract-metadata repo.\n   *\n   * @param options - Options for token detection.\n   * @param options.networkClientId - The ID of the network client to use.\n   * @param options.accountAddress - the selectedAddress against which to detect for token balances.\n   */\n  async detectTokens({\n    networkClientId,\n    accountAddress,\n  }: {\n    networkClientId?: NetworkClientId;\n    accountAddress?: string;\n  } = {}): Promise<void> {\n    if (!this.isActive || !this.#isDetectionEnabledForNetwork) {\n      return;\n    }\n    const selectedAddress = accountAddress ?? this.#selectedAddress;\n    const chainId = this.#getCorrectChainId(networkClientId);\n\n    if (\n      !this.#isDetectionEnabledFromPreferences &&\n      chainId !== ChainId.mainnet\n    ) {\n      return;\n    }\n    const isTokenDetectionInactiveInMainnet =\n      !this.#isDetectionEnabledFromPreferences && chainId === ChainId.mainnet;\n    const { tokenList } = this.messagingSystem.call(\n      'TokenListController:getState',\n    );\n    const tokenListUsed = isTokenDetectionInactiveInMainnet\n      ? STATIC_MAINNET_TOKEN_LIST\n      : tokenList;\n\n    const { tokens, detectedTokens } = this.#getTokensState();\n    const tokensToDetect: string[] = [];\n\n    for (const tokenAddress of Object.keys(tokenListUsed)) {\n      if (\n        !findCaseInsensitiveMatch(\n          tokens.map(({ address }) => address),\n          tokenAddress,\n        ) &&\n        !findCaseInsensitiveMatch(\n          detectedTokens.map(({ address }) => address),\n          tokenAddress,\n        )\n      ) {\n        tokensToDetect.push(tokenAddress);\n      }\n    }\n    const sliceOfTokensToDetect = [];\n    sliceOfTokensToDetect[0] = tokensToDetect.slice(0, 1000);\n    sliceOfTokensToDetect[1] = tokensToDetect.slice(\n      1000,\n      tokensToDetect.length - 1,\n    );\n\n    /* istanbul ignore else */\n    if (!selectedAddress) {\n      return;\n    }\n\n    for (const tokensSlice of sliceOfTokensToDetect) {\n      if (tokensSlice.length === 0) {\n        break;\n      }\n\n      await safelyExecute(async () => {\n        const balances = await this.#getBalancesInSingleCall(\n          selectedAddress,\n          tokensSlice,\n        );\n        const tokensToAdd: Token[] = [];\n        const eventTokensDetails = [];\n        for (const tokenAddress of Object.keys(balances)) {\n          let ignored;\n          /* istanbul ignore else */\n          const { ignoredTokens } = this.#getTokensState();\n          if (ignoredTokens.length) {\n            ignored = ignoredTokens.find(\n              (ignoredTokenAddress) =>\n                ignoredTokenAddress === toChecksumHexAddress(tokenAddress),\n            );\n          }\n          const caseInsensitiveTokenKey =\n            findCaseInsensitiveMatch(\n              Object.keys(tokenListUsed),\n              tokenAddress,\n            ) ?? '';\n\n          if (ignored === undefined) {\n            const { decimals, symbol, aggregators, iconUrl, name } =\n              tokenList[caseInsensitiveTokenKey];\n            eventTokensDetails.push(`${symbol} - ${tokenAddress}`);\n            tokensToAdd.push({\n              address: tokenAddress,\n              decimals,\n              symbol,\n              aggregators,\n              image: iconUrl,\n              isERC721: false,\n              name,\n            });\n          }\n        }\n\n        if (tokensToAdd.length) {\n          this.#trackMetaMetricsEvent({\n            event: 'Token Detected',\n            category: 'Wallet',\n            properties: {\n              tokens: eventTokensDetails,\n              token_standard: 'ERC20',\n              asset_type: 'TOKEN',\n            },\n          });\n          await this.#addDetectedTokens(tokensToAdd, {\n            selectedAddress,\n            chainId,\n          });\n        }\n      });\n    }\n  }\n}\n\nexport default TokenDetectionController;\n"]}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@metamask-previews/assets-controllers",
-  "version": "25.0.0-preview.83a88a4",
+  "version": "25.0.0-preview.bc4dd941",
   "description": "Controllers which manage interactions involving ERC-20, ERC-721, and ERC-1155 tokens (including NFTs)",
   "keywords": [
     "MetaMask",
@@ -36,11 +36,13 @@
     "@ethersproject/contracts": "^5.7.0",
     "@ethersproject/providers": "^5.7.0",
     "@metamask/abi-utils": "^2.0.2",
+    "@metamask/accounts-controller": "^10.0.0",
     "@metamask/approval-controller": "^5.1.2",
     "@metamask/base-controller": "^4.1.1",
     "@metamask/contract-metadata": "^2.4.0",
     "@metamask/controller-utils": "^8.0.2",
     "@metamask/eth-query": "^4.0.0",
+    "@metamask/keyring-controller": "^12.2.0",
     "@metamask/metamask-eth-abis": "3.0.0",
     "@metamask/network-controller": "^17.2.0",
     "@metamask/polling-controller": "^5.0.0",
@@ -58,7 +60,8 @@
   },
   "devDependencies": {
     "@metamask/auto-changelog": "^3.4.4",
-    "@metamask/ethjs-provider-http": "^0.2.0",
+    "@metamask/ethjs-provider-http": "^0.3.0",
+    "@metamask/keyring-api": "^3.0.0",
     "@types/jest": "^27.4.1",
     "@types/lodash": "^4.14.191",
     "@types/node": "^16.18.54",
@@ -73,7 +76,9 @@
     "typescript": "~4.8.4"
   },
   "peerDependencies": {
+    "@metamask/accounts-controller": "^10.0.0",
     "@metamask/approval-controller": "^5.1.2",
+    "@metamask/keyring-controller": "^12.2.0",
     "@metamask/network-controller": "^17.2.0",
     "@metamask/preferences-controller": "^7.0.0"
   },