@metamask-previews/assets-controller 1.0.0-preview-38a9cf6c3 → 1.0.0-preview-eb9a46682

package/CHANGELOG.md

@@ -9,10 +9,14 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ### Added
 
+- Add optional `trackMetaMetricsEvent` callback to measure and report first init/fetch historical time (duration in ms) to MetaMetrics when the initial asset fetch completes after unlock or app open ([#7871](https://github.com/MetaMask/core/pull/7871))
+- Add `AccountsApiDataSourceConfig` and `PriceDataSourceConfig` types; add `accountsApiDataSourceConfig` and `priceDataSourceConfig` options to `AssetsControllerOptions` for per-data-source configuration (pollInterval, tokenDetectionEnabled, etc.). When `tokenDetectionEnabled` is false, `AccountsApiDataSource` only returns balances for tokens already in state and does not add new tokens ([#7926](https://github.com/MetaMask/core/pull/7926))
+- Add `useExternalService` option to `TokenDetector`, `TokenDetectionOptions`, `RpcDataSourceConfig`, and `RpcDataSourceOptions`. Token detection runs only when both `tokenDetectionEnabled` and `useExternalService` are true and stops when either is false ([#7924](https://github.com/MetaMask/core/pull/7924))
 - Add basic functionality toggle: `isBasicFunctionality` (getter `() => boolean`); no value is stored in the controller. When the getter returns true (matches UI "Basic functionality" ON), token and price APIs are used; when false, only RPC is used. Optional `subscribeToBasicFunctionalityChange(onChange)` lets the consumer register for toggle changes (e.g. extension subscribes to PreferencesController:stateChange, mobile uses its own mechanism); may return an unsubscribe function for controller destroy ([#7904](https://github.com/MetaMask/core/pull/7904))
 
 ### Changed
 
+- **BREAKING:** `AccountsApiDataSourceConfig.tokenDetectionEnabled` is now a getter `() => boolean` (was `boolean`) so the Accounts API data source reacts when the user toggles token detection at runtime, consistent with `RpcDataSourceConfig.tokenDetectionEnabled`. Pass a function, e.g. `tokenDetectionEnabled: () => preferenceController.state.useTokenDetection`.
 - **BREAKING:** Rename state and `DataResponse` property from `assetsMetadata` to `assetsInfo`. Update consumers that read `state.assetsMetadata` or set `response.assetsMetadata` to use `assetsInfo` instead ([#7902](https://github.com/MetaMask/core/pull/7902))
 - Bump `@metamask/keyring-api` from `^21.0.0` to `^21.5.0` ([#7857](https://github.com/MetaMask/core/pull/7857))
 - Bump `@metamask/keyring-internal-api` from `^9.0.0` to `^10.0.0` ([#7857](https://github.com/MetaMask/core/pull/7857))

package/dist/AssetsController.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 _AssetsController_instances, _AssetsController_isEnabled, _AssetsController_isBasicFunctionality, _AssetsController_defaultUpdateInterval, _AssetsController_controllerMutex, _AssetsController_activeSubscriptions, _AssetsController_enabledChains, _AssetsController_selectedAccounts_get, _AssetsController_backendWebsocketDataSource, _AssetsController_accountsApiDataSource, _AssetsController_snapDataSource, _AssetsController_rpcDataSource, _AssetsController_allBalanceDataSources_get, _AssetsController_priceDataSource, _AssetsController_detectionMiddleware, _AssetsController_tokenDataSource, _AssetsController_unsubscribeBasicFunctionality, _AssetsController_initializeState, _AssetsController_extractEnabledChains, _AssetsController_normalizeChainReference, _AssetsController_subscribeToEvents, _AssetsController_registerActionHandlers, _AssetsController_executeMiddlewares, _AssetsController_updateState, _AssetsController_getAssetsFromState, _AssetsController_tokenStandardToAssetType, _AssetsController_start, _AssetsController_stop, _AssetsController_subscribeAssets, _AssetsController_subscribeAssetsBalance, _AssetsController_buildChainToAccountsMap, _AssetsController_subscribeDataSource, _AssetsController_unsubscribeDataSource, _AssetsController_buildDataRequest, _AssetsController_getEnabledChainsForAccount, _AssetsController_handleAccountGroupChanged, _AssetsController_handleEnabledNetworksChanged;
+var _AssetsController_instances, _AssetsController_isEnabled, _AssetsController_isBasicFunctionality, _AssetsController_defaultUpdateInterval, _AssetsController_trackMetaMetricsEvent, _AssetsController_firstInitFetchReported, _AssetsController_controllerMutex, _AssetsController_activeSubscriptions, _AssetsController_enabledChains, _AssetsController_selectedAccounts_get, _AssetsController_backendWebsocketDataSource, _AssetsController_accountsApiDataSource, _AssetsController_snapDataSource, _AssetsController_rpcDataSource, _AssetsController_allBalanceDataSources_get, _AssetsController_priceDataSource, _AssetsController_detectionMiddleware, _AssetsController_tokenDataSource, _AssetsController_unsubscribeBasicFunctionality, _AssetsController_initializeState, _AssetsController_extractEnabledChains, _AssetsController_normalizeChainReference, _AssetsController_subscribeToEvents, _AssetsController_registerActionHandlers, _AssetsController_executeMiddlewares, _AssetsController_updateState, _AssetsController_getAssetsFromState, _AssetsController_tokenStandardToAssetType, _AssetsController_start, _AssetsController_stop, _AssetsController_subscribeAssets, _AssetsController_subscribeAssetsBalance, _AssetsController_buildChainToAccountsMap, _AssetsController_subscribeDataSource, _AssetsController_unsubscribeDataSource, _AssetsController_buildDataRequest, _AssetsController_getEnabledChainsForAccount, _AssetsController_handleAccountGroupChanged, _AssetsController_handleEnabledNetworksChanged;
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.AssetsController = exports.getDefaultAssetsControllerState = void 0;
 const base_controller_1 = require("@metamask/base-controller");
@@ -182,7 +182,7 @@ function normalizeResponse(response) {
  * - The controller does NOT manage polling - it simply receives pushed updates
  */
 class AssetsController extends base_controller_1.BaseController {
-    constructor({ messenger, state = {}, defaultUpdateInterval = DEFAULT_POLLING_INTERVAL_MS, isEnabled = () => true, isBasicFunctionality, subscribeToBasicFunctionalityChange, queryApiClient, rpcDataSourceConfig, }) {
+    constructor({ messenger, state = {}, defaultUpdateInterval = DEFAULT_POLLING_INTERVAL_MS, isEnabled = () => true, isBasicFunctionality, subscribeToBasicFunctionalityChange, queryApiClient, rpcDataSourceConfig, trackMetaMetricsEvent, accountsApiDataSourceConfig, priceDataSourceConfig, }) {
         super({
             name: CONTROLLER_NAME,
             messenger,
@@ -199,6 +199,10 @@ class AssetsController extends base_controller_1.BaseController {
         _AssetsController_isBasicFunctionality.set(this, void 0);
         /** Default update interval hint passed to data sources */
         _AssetsController_defaultUpdateInterval.set(this, void 0);
+        /** Optional callback for first init/fetch MetaMetrics (duration). */
+        _AssetsController_trackMetaMetricsEvent.set(this, void 0);
+        /** Whether we have already reported first init fetch for this session (reset on #stop). */
+        _AssetsController_firstInitFetchReported.set(this, false);
         _AssetsController_controllerMutex.set(this, new async_mutex_1.Mutex());
         /**
          * Active balance subscriptions keyed by account ID.
@@ -220,6 +224,7 @@ class AssetsController extends base_controller_1.BaseController {
         __classPrivateFieldSet(this, _AssetsController_isEnabled, isEnabled(), "f");
         __classPrivateFieldSet(this, _AssetsController_isBasicFunctionality, isBasicFunctionality ?? (() => true), "f");
         __classPrivateFieldSet(this, _AssetsController_defaultUpdateInterval, defaultUpdateInterval, "f");
+        __classPrivateFieldSet(this, _AssetsController_trackMetaMetricsEvent, trackMetaMetricsEvent, "f");
         const rpcConfig = rpcDataSourceConfig ?? {};
         const onActiveChainsUpdated = (dataSourceName, chains, previousChains) => this.handleActiveChainsUpdate(dataSourceName, chains, previousChains);
         __classPrivateFieldSet(this, _AssetsController_backendWebsocketDataSource, new BackendWebsocketDataSource_1.BackendWebsocketDataSource({
@@ -230,6 +235,7 @@ class AssetsController extends base_controller_1.BaseController {
         __classPrivateFieldSet(this, _AssetsController_accountsApiDataSource, new AccountsApiDataSource_1.AccountsApiDataSource({
             queryApiClient,
             onActiveChainsUpdated,
+            ...accountsApiDataSourceConfig,
         }), "f");
         __classPrivateFieldSet(this, _AssetsController_snapDataSource, new SnapDataSource_1.SnapDataSource({
             messenger: this.messenger,
@@ -245,6 +251,7 @@ class AssetsController extends base_controller_1.BaseController {
         }), "f");
         __classPrivateFieldSet(this, _AssetsController_priceDataSource, new PriceDataSource_1.PriceDataSource({
             queryApiClient,
+            ...priceDataSourceConfig,
         }), "f");
         __classPrivateFieldSet(this, _AssetsController_detectionMiddleware, new DetectionMiddleware_1.DetectionMiddleware(), "f");
         if (!__classPrivateFieldGet(this, _AssetsController_isEnabled, "f")) {
@@ -324,27 +331,34 @@ class AssetsController extends base_controller_1.BaseController {
             customAssets.push(...accountCustomAssets);
         }
         if (options?.forceUpdate) {
+            const startTime = Date.now();
             const request = __classPrivateFieldGet(this, _AssetsController_instances, "m", _AssetsController_buildDataRequest).call(this, accounts, chainIds, {
                 assetTypes,
                 dataTypes,
                 customAssets: customAssets.length > 0 ? customAssets : undefined,
                 forceUpdate: true,
             });
-            const middlewares = __classPrivateFieldGet(this, _AssetsController_isBasicFunctionality, "f").call(this)
+            const sources = __classPrivateFieldGet(this, _AssetsController_isBasicFunctionality, "f").call(this)
                 ? [
-                    __classPrivateFieldGet(this, _AssetsController_accountsApiDataSource, "f").assetsMiddleware,
-                    __classPrivateFieldGet(this, _AssetsController_snapDataSource, "f").assetsMiddleware,
-                    __classPrivateFieldGet(this, _AssetsController_rpcDataSource, "f").assetsMiddleware,
-                    __classPrivateFieldGet(this, _AssetsController_detectionMiddleware, "f").assetsMiddleware,
-                    __classPrivateFieldGet(this, _AssetsController_tokenDataSource, "f").assetsMiddleware,
-                    __classPrivateFieldGet(this, _AssetsController_priceDataSource, "f").assetsMiddleware,
+                    __classPrivateFieldGet(this, _AssetsController_accountsApiDataSource, "f"),
+                    __classPrivateFieldGet(this, _AssetsController_snapDataSource, "f"),
+                    __classPrivateFieldGet(this, _AssetsController_rpcDataSource, "f"),
+                    __classPrivateFieldGet(this, _AssetsController_detectionMiddleware, "f"),
+                    __classPrivateFieldGet(this, _AssetsController_tokenDataSource, "f"),
+                    __classPrivateFieldGet(this, _AssetsController_priceDataSource, "f"),
                 ]
-                : [
-                    __classPrivateFieldGet(this, _AssetsController_rpcDataSource, "f").assetsMiddleware,
-                    __classPrivateFieldGet(this, _AssetsController_detectionMiddleware, "f").assetsMiddleware,
-                ];
-            const response = await __classPrivateFieldGet(this, _AssetsController_instances, "m", _AssetsController_executeMiddlewares).call(this, middlewares, request);
+                : [__classPrivateFieldGet(this, _AssetsController_rpcDataSource, "f"), __classPrivateFieldGet(this, _AssetsController_detectionMiddleware, "f")];
+            const { response, durationByDataSource } = await __classPrivateFieldGet(this, _AssetsController_instances, "m", _AssetsController_executeMiddlewares).call(this, sources, request);
             await __classPrivateFieldGet(this, _AssetsController_instances, "m", _AssetsController_updateState).call(this, response);
+            if (__classPrivateFieldGet(this, _AssetsController_trackMetaMetricsEvent, "f") && !__classPrivateFieldGet(this, _AssetsController_firstInitFetchReported, "f")) {
+                __classPrivateFieldSet(this, _AssetsController_firstInitFetchReported, true, "f");
+                const durationMs = Date.now() - startTime;
+                __classPrivateFieldGet(this, _AssetsController_trackMetaMetricsEvent, "f").call(this, {
+                    durationMs,
+                    chainIds,
+                    durationByDataSource,
+                });
+            }
         }
         return __classPrivateFieldGet(this, _AssetsController_instances, "m", _AssetsController_getAssetsFromState).call(this, accounts, chainIds, assetTypes);
     }
@@ -581,11 +595,7 @@ class AssetsController extends base_controller_1.BaseController {
         });
         // Run through enrichment middlewares (Event Stack: Detection → Token → Price)
         // Include 'metadata' in dataTypes so TokenDataSource runs to enrich detected assets
-        const enrichedResponse = await __classPrivateFieldGet(this, _AssetsController_instances, "m", _AssetsController_executeMiddlewares).call(this, [
-            __classPrivateFieldGet(this, _AssetsController_detectionMiddleware, "f").assetsMiddleware,
-            __classPrivateFieldGet(this, _AssetsController_tokenDataSource, "f").assetsMiddleware,
-            __classPrivateFieldGet(this, _AssetsController_priceDataSource, "f").assetsMiddleware,
-        ], request ?? {
+        const { response: enrichedResponse } = await __classPrivateFieldGet(this, _AssetsController_instances, "m", _AssetsController_executeMiddlewares).call(this, [__classPrivateFieldGet(this, _AssetsController_detectionMiddleware, "f"), __classPrivateFieldGet(this, _AssetsController_tokenDataSource, "f"), __classPrivateFieldGet(this, _AssetsController_priceDataSource, "f")], request ?? {
             accountsWithSupportedChains: [],
             chainIds: [],
             dataTypes: ['balance', 'metadata', 'price'],
@@ -624,7 +634,7 @@ class AssetsController extends base_controller_1.BaseController {
     }
 }
 exports.AssetsController = AssetsController;
-_AssetsController_isEnabled = new WeakMap(), _AssetsController_isBasicFunctionality = new WeakMap(), _AssetsController_defaultUpdateInterval = new WeakMap(), _AssetsController_controllerMutex = new WeakMap(), _AssetsController_activeSubscriptions = new WeakMap(), _AssetsController_enabledChains = new WeakMap(), _AssetsController_backendWebsocketDataSource = new WeakMap(), _AssetsController_accountsApiDataSource = new WeakMap(), _AssetsController_snapDataSource = new WeakMap(), _AssetsController_rpcDataSource = new WeakMap(), _AssetsController_priceDataSource = new WeakMap(), _AssetsController_detectionMiddleware = new WeakMap(), _AssetsController_tokenDataSource = new WeakMap(), _AssetsController_unsubscribeBasicFunctionality = new WeakMap(), _AssetsController_instances = new WeakSet(), _AssetsController_selectedAccounts_get = function _AssetsController_selectedAccounts_get() {
+_AssetsController_isEnabled = new WeakMap(), _AssetsController_isBasicFunctionality = new WeakMap(), _AssetsController_defaultUpdateInterval = new WeakMap(), _AssetsController_trackMetaMetricsEvent = new WeakMap(), _AssetsController_firstInitFetchReported = new WeakMap(), _AssetsController_controllerMutex = new WeakMap(), _AssetsController_activeSubscriptions = new WeakMap(), _AssetsController_enabledChains = new WeakMap(), _AssetsController_backendWebsocketDataSource = new WeakMap(), _AssetsController_accountsApiDataSource = new WeakMap(), _AssetsController_snapDataSource = new WeakMap(), _AssetsController_rpcDataSource = new WeakMap(), _AssetsController_priceDataSource = new WeakMap(), _AssetsController_detectionMiddleware = new WeakMap(), _AssetsController_tokenDataSource = new WeakMap(), _AssetsController_unsubscribeBasicFunctionality = new WeakMap(), _AssetsController_instances = new WeakSet(), _AssetsController_selectedAccounts_get = function _AssetsController_selectedAccounts_get() {
     return this.messenger.call('AccountTreeController:getAccountsFromSelectedAccountGroup');
 }, _AssetsController_allBalanceDataSources_get = function _AssetsController_allBalanceDataSources_get() {
     return [
@@ -685,14 +695,27 @@ _AssetsController_isEnabled = new WeakMap(), _AssetsController_isBasicFunctional
 // ============================================================================
 /**
  * Execute middlewares with request/response context.
+ * Returns response and exclusive duration per source (sum ≈ wall time).
  *
- * @param middlewares - Middlewares to execute in order.
+ * @param sources - Data sources or middlewares with getName() and assetsMiddleware (executed in order).
  * @param request - The data request.
  * @param initialResponse - Optional initial response (for enriching existing data).
- * @returns The final DataResponse after all middlewares have processed.
+ * @returns Response and durationByDataSource (exclusive ms per source name).
  */
-async function _AssetsController_executeMiddlewares(middlewares, request, initialResponse = {}) {
-    const chain = middlewares.reduceRight((next, middleware) => async (ctx) => {
+async function _AssetsController_executeMiddlewares(sources, request, initialResponse = {}) {
+    const names = sources.map((source) => source.getName());
+    const middlewares = sources.map((source) => source.assetsMiddleware);
+    const inclusive = [];
+    const wrapped = middlewares.map((middleware, i) => (async (ctx, next) => {
+        const start = Date.now();
+        try {
+            return await middleware(ctx, next);
+        }
+        finally {
+            inclusive[i] = Date.now() - start;
+        }
+    }));
+    const chain = wrapped.reduceRight((next, middleware) => async (ctx) => {
         try {
             return await middleware(ctx, next);
         }
@@ -706,7 +729,16 @@ async function _AssetsController_executeMiddlewares(middlewares, request, initia
         response: initialResponse,
         getAssetsState: () => this.state,
     });
-    return result.response;
+    const durationByDataSource = {};
+    for (let i = 0; i < inclusive.length; i++) {
+        const nextInc = i + 1 < inclusive.length ? (inclusive[i + 1] ?? 0) : 0;
+        const exclusive = Math.max(0, (inclusive[i] ?? 0) - nextInc);
+        const name = names[i];
+        if (name !== undefined) {
+            durationByDataSource[name] = exclusive;
+        }
+    }
+    return { response: result.response, durationByDataSource };
 }, _AssetsController_updateState = 
 // ============================================================================
 // STATE MANAGEMENT
@@ -901,19 +933,18 @@ async function _AssetsController_updateState(response) {
         enabledChainCount: __classPrivateFieldGet(this, _AssetsController_enabledChains, "f").size,
     });
     __classPrivateFieldGet(this, _AssetsController_instances, "m", _AssetsController_subscribeAssets).call(this);
-    if (__classPrivateFieldGet(this, _AssetsController_instances, "a", _AssetsController_selectedAccounts_get).length > 0) {
-        this.getAssets(__classPrivateFieldGet(this, _AssetsController_instances, "a", _AssetsController_selectedAccounts_get), {
-            chainIds: [...__classPrivateFieldGet(this, _AssetsController_enabledChains, "f")],
-            forceUpdate: true,
-        }).catch((error) => {
-            log('Failed to fetch assets', error);
-        });
-    }
+    this.getAssets(__classPrivateFieldGet(this, _AssetsController_instances, "a", _AssetsController_selectedAccounts_get), {
+        chainIds: [...__classPrivateFieldGet(this, _AssetsController_enabledChains, "f")],
+        forceUpdate: true,
+    }).catch((error) => {
+        log('Failed to fetch assets', error);
+    });
 }, _AssetsController_stop = function _AssetsController_stop() {
     log('Stopping asset tracking', {
         activeSubscriptionCount: __classPrivateFieldGet(this, _AssetsController_activeSubscriptions, "f").size,
         hasPriceSubscription: __classPrivateFieldGet(this, _AssetsController_activeSubscriptions, "f").has('ds:PriceDataSource'),
     });
+    __classPrivateFieldSet(this, _AssetsController_firstInitFetchReported, false, "f");
     // Stop price subscription first (uses direct messenger call)
     this.unsubscribeAssetsPrice();
     // Stop balance subscriptions by properly notifying data sources via messenger