@metamask-previews/assets-controller 9.1.0-preview-53326764b → 9.1.0-preview-5c294abf8

package/CHANGELOG.md

@@ -20,6 +20,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - Remove the 120-second websocket balance freshness guard that blocked force-refresh and polling updates from correcting stale websocket balances ([#9273](https://github.com/MetaMask/core/pull/9273))
 - `BackendWebsocketDataSource` registers subscription handlers before the subscribe handshake so in-flight account-activity notifications are not dropped, cleans up subscription state on subscribe failure, and resolves balance updates from stored subscription state when notifications arrive with stale subscription IDs ([#9273](https://github.com/MetaMask/core/pull/9273))
 - `AssetsController` refreshes data-source `activeChains`, re-subscribes, and force-fetches balances for the newly selected EVM chain when the user switches networks via `NetworkController:networkDidChange`
+- `AssetsController` bypasses the price deduper cache and fetches spot prices for assets on a newly selected or added EVM network only when those assets have no entry in `assetsPrice` yet; `DetectionMiddleware` queues newly detected assets for the same pipeline price fetch so RPC-detected tokens are priced without waiting for the poll interval
+- `AssetsController` merge updates from `getAssets({ forceUpdate: true })` now replace balances on API-covered chains so unlock/startup reflects the fresh Accounts API snapshot instead of preserving stale pre-lock tokens; subscription-driven merges are unchanged
 
 ## [9.1.0]
 

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_trace, _AssetsController_captureException, _AssetsController_firstInitFetchReported, _AssetsController_stateSizeReported, _AssetsController_emitTrace, _AssetsController_emitStateSizeTrace, _AssetsController_uiOpen, _AssetsController_keyringUnlocked, _AssetsController_controllerMutex, _AssetsController_accountRefreshMutex, _AssetsController_activeSubscriptions, _AssetsController_enabledChains, _AssetsController_lastKnownAccountIds, _AssetsController_getSelectedAccounts, _AssetsController_backendWebsocketDataSource, _AssetsController_accountsApiDataSource, _AssetsController_snapDataSource, _AssetsController_rpcDataSource, _AssetsController_stakedBalanceDataSource, _AssetsController_allBalanceDataSources_get, _AssetsController_priceDataSource, _AssetsController_detectionMiddleware, _AssetsController_customAssetGraduationMiddleware, _AssetsController_rpcFallbackMiddleware, _AssetsController_tokenDataSource, _AssetsController_unsubscribeBasicFunctionality, _AssetsController_queryApiClient, _AssetsController_onActiveChainsUpdated, _AssetsController_initializeNativeAssetsMap, _AssetsController_initializeState, _AssetsController_extractEnabledChains, _AssetsController_normalizeChainReference, _AssetsController_subscribeToEvents, _AssetsController_onUnapprovedTransactionAdded, _AssetsController_onTransactionConfirmed, _AssetsController_onAccountActivityBalanceUpdated, _AssetsController_updateActive, _AssetsController_handleAccountTreeStateChange, _AssetsController_runAccountTreeRefresh, _AssetsController_registerActionHandlers, _AssetsController_handleActiveChainsUpdate, _AssetsController_executeMiddlewares, _AssetsController_getNativeAssetMap, _AssetsController_isNativeAsset, _AssetsController_getAssetType, _AssetsController_resolveNativeAssetIds, _AssetsController_getNativeAssetIdsForEnabledChains, _AssetsController_getNativeAssetIdsForAccount, _AssetsController_getSlowPipelineChainIds, _AssetsController_ensureNativeBalancesDefaultZero, _AssetsController_ensureDefaultTrackedAssetsSeeded, _AssetsController_updateState, _AssetsController_getAssetsFromState, _AssetsController_shouldHideNativeToken, _AssetsController_tokenStandardToAssetType, _AssetsController_start, _AssetsController_stop, _AssetsController_subscribeAssets, _AssetsController_subscribeAssetsBalance, _AssetsController_subscribeRpcCustomAssetsSupplement, _AssetsController_unsubscribeBySubscriptionKey, _AssetsController_subscribeStakedBalance, _AssetsController_buildChainToAccountsMap, _AssetsController_subscribeDataSource, _AssetsController_unsubscribeDataSource, _AssetsController_buildDataRequest, _AssetsController_getEnabledChainsForAccount, _AssetsController_handleAccountGroupChanged, _AssetsController_handleEnabledNetworksChanged, _AssetsController_handleNetworkAdded, _AssetsController_refreshActiveChainsOnNetworkSwitch, _AssetsController_getSelectedEvmChainIdFromNetworkState, _AssetsController_handleNetworkDidChange, _AssetsController_refreshAssetsAfterNetworkChange;
+var _AssetsController_instances, _AssetsController_isEnabled, _AssetsController_isBasicFunctionality, _AssetsController_defaultUpdateInterval, _AssetsController_trace, _AssetsController_captureException, _AssetsController_firstInitFetchReported, _AssetsController_stateSizeReported, _AssetsController_emitTrace, _AssetsController_emitStateSizeTrace, _AssetsController_uiOpen, _AssetsController_keyringUnlocked, _AssetsController_controllerMutex, _AssetsController_accountRefreshMutex, _AssetsController_activeSubscriptions, _AssetsController_enabledChains, _AssetsController_lastKnownAccountIds, _AssetsController_getSelectedAccounts, _AssetsController_backendWebsocketDataSource, _AssetsController_accountsApiDataSource, _AssetsController_snapDataSource, _AssetsController_rpcDataSource, _AssetsController_stakedBalanceDataSource, _AssetsController_allBalanceDataSources_get, _AssetsController_priceDataSource, _AssetsController_detectionMiddleware, _AssetsController_customAssetGraduationMiddleware, _AssetsController_rpcFallbackMiddleware, _AssetsController_tokenDataSource, _AssetsController_unsubscribeBasicFunctionality, _AssetsController_queryApiClient, _AssetsController_onActiveChainsUpdated, _AssetsController_initializeNativeAssetsMap, _AssetsController_initializeState, _AssetsController_extractEnabledChains, _AssetsController_normalizeChainReference, _AssetsController_subscribeToEvents, _AssetsController_onUnapprovedTransactionAdded, _AssetsController_onTransactionConfirmed, _AssetsController_onAccountActivityBalanceUpdated, _AssetsController_updateActive, _AssetsController_handleAccountTreeStateChange, _AssetsController_runAccountTreeRefresh, _AssetsController_runStartupRefresh, _AssetsController_registerActionHandlers, _AssetsController_handleActiveChainsUpdate, _AssetsController_executeMiddlewares, _AssetsController_fetchMissingPricesWithoutCache, _AssetsController_getNativeAssetMap, _AssetsController_isNativeAsset, _AssetsController_getAssetType, _AssetsController_resolveNativeAssetIds, _AssetsController_getNativeAssetIdsForEnabledChains, _AssetsController_getNativeAssetIdsForAccount, _AssetsController_getSlowPipelineChainIds, _AssetsController_ensureNativeBalancesDefaultZero, _AssetsController_ensureDefaultTrackedAssetsSeeded, _AssetsController_updateState, _AssetsController_getAssetsFromState, _AssetsController_shouldHideNativeToken, _AssetsController_tokenStandardToAssetType, _AssetsController_start, _AssetsController_stop, _AssetsController_subscribeAssets, _AssetsController_subscribeAssetsBalance, _AssetsController_subscribeRpcCustomAssetsSupplement, _AssetsController_unsubscribeBySubscriptionKey, _AssetsController_subscribeStakedBalance, _AssetsController_buildChainToAccountsMap, _AssetsController_subscribeDataSource, _AssetsController_unsubscribeDataSource, _AssetsController_buildDataRequest, _AssetsController_getEnabledChainsForAccount, _AssetsController_handleAccountGroupChanged, _AssetsController_handleEnabledNetworksChanged, _AssetsController_handleNetworkAdded, _AssetsController_refreshActiveChainsOnNetworkSwitch, _AssetsController_getSelectedEvmChainIdFromNetworkState, _AssetsController_handleNetworkDidChange, _AssetsController_refreshAssetsAfterNetworkChange, _AssetsController_refreshAssetsAfterNetworkAdded;
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.AssetsController = exports.getDefaultAssetsControllerState = void 0;
 const base_controller_1 = require("@metamask/base-controller");
@@ -193,8 +193,41 @@ function normalizeResponse(response) {
     if (response.updateMode) {
         normalized.updateMode = response.updateMode;
     }
+    if (response.replaceCoveredChainBalances) {
+        normalized.replaceCoveredChainBalances = true;
+    }
     return normalized;
 }
+/**
+ * Merge account balances from a data-source response into prior state.
+ *
+ * @param previousBalances - Balances already in state for this account.
+ * @param accountBalances - Balances from the incoming response.
+ * @param customAssetIds - Custom assets to preserve when replacing covered chains.
+ * @param replaceCoveredChains - When true, drop prior balances on chains present
+ *   in the response before applying it (authoritative chain slice).
+ * @returns The merged balance map for the account.
+ */
+function mergeAccountBalances(previousBalances, accountBalances, customAssetIds, replaceCoveredChains) {
+    if (!replaceCoveredChains) {
+        return { ...previousBalances, ...accountBalances };
+    }
+    const coveredChains = new Set(Object.keys(accountBalances).map((assetId) => assetId.split('/')[0]));
+    const next = {};
+    for (const [assetId, balance] of Object.entries(previousBalances)) {
+        if (!coveredChains.has(assetId.split('/')[0])) {
+            next[assetId] = balance;
+        }
+    }
+    Object.assign(next, accountBalances);
+    for (const customId of customAssetIds) {
+        if (!Object.prototype.hasOwnProperty.call(next, customId)) {
+            const prev = previousBalances[customId];
+            next[customId] = prev ?? { amount: '0' };
+        }
+    }
+    return next;
+}
 // ============================================================================
 // CONTROLLER IMPLEMENTATION
 // ============================================================================
@@ -443,7 +476,11 @@ class AssetsController extends base_controller_1.BaseController {
                 ]
                 : [__classPrivateFieldGet(this, _AssetsController_stakedBalanceDataSource, "f"), __classPrivateFieldGet(this, _AssetsController_detectionMiddleware, "f")];
             const { response, durationByDataSource } = await __classPrivateFieldGet(this, _AssetsController_instances, "m", _AssetsController_executeMiddlewares).call(this, fastSources, request);
-            await __classPrivateFieldGet(this, _AssetsController_instances, "m", _AssetsController_updateState).call(this, { ...response, updateMode: 'merge' });
+            await __classPrivateFieldGet(this, _AssetsController_instances, "m", _AssetsController_updateState).call(this, {
+                ...response,
+                updateMode: 'merge',
+                replaceCoveredChainBalances: true,
+            });
             // Background pipeline: snap and RPC run in parallel after the fast path
             // commits to state. Their balances are merged together before detection.
             // Token + price enrichment matches the pre-split behavior: only when basic
@@ -875,7 +912,10 @@ class AssetsController extends base_controller_1.BaseController {
             ]));
         }
         const { response: enrichedResponse } = await __classPrivateFieldGet(this, _AssetsController_instances, "m", _AssetsController_executeMiddlewares).call(this, enrichmentSources, pipelineRequest, response);
-        await __classPrivateFieldGet(this, _AssetsController_instances, "m", _AssetsController_updateState).call(this, enrichedResponse);
+        await __classPrivateFieldGet(this, _AssetsController_instances, "m", _AssetsController_updateState).call(this, {
+            ...enrichedResponse,
+            replaceCoveredChainBalances: response.replaceCoveredChainBalances,
+        });
         __classPrivateFieldGet(this, _AssetsController_instances, "m", _AssetsController_emitTrace).call(this, TRACE_UPDATE_PIPELINE, {
             source: sourceId,
             duration_ms: performance.now() - updateStart,
@@ -1064,7 +1104,9 @@ _AssetsController_isEnabled = new WeakMap(), _AssetsController_isBasicFunctional
     // enabled in NetworkEnablementController.
     this.messenger.subscribe('NetworkController:networkAdded', (networkConfiguration) => {
         __classPrivateFieldGet(this, _AssetsController_instances, "m", _AssetsController_handleNetworkAdded).call(this, networkConfiguration.chainId);
-        __classPrivateFieldGet(this, _AssetsController_instances, "m", _AssetsController_refreshAssetsAfterNetworkChange).call(this);
+        __classPrivateFieldGet(this, _AssetsController_instances, "m", _AssetsController_refreshAssetsAfterNetworkAdded).call(this, networkConfiguration.chainId).catch((error) => {
+            log('Failed to refresh assets after network added', { error });
+        });
     });
     this.messenger.subscribe('NetworkController:networkRemoved', () => {
         __classPrivateFieldGet(this, _AssetsController_instances, "m", _AssetsController_refreshAssetsAfterNetworkChange).call(this);
@@ -1221,6 +1263,32 @@ _AssetsController_isEnabled = new WeakMap(), _AssetsController_isBasicFunctional
     finally {
         releaseLock();
     }
+}, _AssetsController_runStartupRefresh = 
+/**
+ * Force-fetch balances then subscribe. Used on unlock / first startup.
+ *
+ * @param accounts - Selected accounts to refresh.
+ */
+async function _AssetsController_runStartupRefresh(accounts) {
+    const releaseLock = await __classPrivateFieldGet(this, _AssetsController_accountRefreshMutex, "f").acquire();
+    try {
+        await this.getAssets(accounts, {
+            chainIds: [...__classPrivateFieldGet(this, _AssetsController_enabledChains, "f")],
+            forceUpdate: true,
+        });
+        __classPrivateFieldGet(this, _AssetsController_instances, "m", _AssetsController_subscribeAssets).call(this);
+        __classPrivateFieldGet(this, _AssetsController_instances, "m", _AssetsController_ensureNativeBalancesDefaultZero).call(this);
+        __classPrivateFieldGet(this, _AssetsController_instances, "m", _AssetsController_ensureDefaultTrackedAssetsSeeded).call(this);
+    }
+    catch (error) {
+        log('Failed to fetch assets on startup', error);
+        __classPrivateFieldGet(this, _AssetsController_instances, "m", _AssetsController_subscribeAssets).call(this);
+        __classPrivateFieldGet(this, _AssetsController_instances, "m", _AssetsController_ensureNativeBalancesDefaultZero).call(this);
+        __classPrivateFieldGet(this, _AssetsController_instances, "m", _AssetsController_ensureDefaultTrackedAssetsSeeded).call(this);
+    }
+    finally {
+        releaseLock();
+    }
 }, _AssetsController_registerActionHandlers = function _AssetsController_registerActionHandlers() {
     this.messenger.registerMethodActionHandlers(this, MESSENGER_EXPOSED_METHODS);
 }, _AssetsController_handleActiveChainsUpdate = function _AssetsController_handleActiveChainsUpdate(dataSourceId, activeChains, previousChains) {
@@ -1334,6 +1402,41 @@ async function _AssetsController_executeMiddlewares(sources, request, initialRes
         });
     }
     return { response: result.response, durationByDataSource };
+}, _AssetsController_fetchMissingPricesWithoutCache = function _AssetsController_fetchMissingPricesWithoutCache(accounts, chainIds) {
+    if (!__classPrivateFieldGet(this, _AssetsController_isBasicFunctionality, "f").call(this) || accounts.length === 0) {
+        return;
+    }
+    const accountIds = new Set(accounts.map((account) => account.id));
+    const chainFilter = new Set(chainIds);
+    const assetsForPriceUpdate = [];
+    const prices = this.state.assetsPrice;
+    for (const [accountId, accountBalances] of Object.entries(this.state.assetsBalance)) {
+        if (!accountIds.has(accountId)) {
+            continue;
+        }
+        for (const assetId of Object.keys(accountBalances)) {
+            if (!chainFilter.has(assetId.split('/')[0])) {
+                continue;
+            }
+            const normalizedAssetId = (0, utils_2.normalizeAssetId)(assetId);
+            if (prices[normalizedAssetId] ?? prices[assetId]) {
+                continue;
+            }
+            assetsForPriceUpdate.push(normalizedAssetId);
+        }
+    }
+    if (assetsForPriceUpdate.length === 0) {
+        return;
+    }
+    __classPrivateFieldGet(this, _AssetsController_priceDataSource, "f").invalidatePriceCache();
+    this.getAssets(accounts, {
+        forceUpdate: true,
+        dataTypes: ['price'],
+        chainIds,
+        assetsForPriceUpdate,
+    }).catch((error) => {
+        log('Failed to fetch missing prices', { error });
+    });
 }, _AssetsController_getNativeAssetMap = function _AssetsController_getNativeAssetMap() {
     return (__classPrivateFieldGet(this, _AssetsController_queryApiClient, "f").getCachedData(NATIVE_ASSETS_QUERY_KEY) ?? {});
 }, _AssetsController_isNativeAsset = function _AssetsController_isNativeAsset(assetId) {
@@ -1520,36 +1623,9 @@ async function _AssetsController_executeMiddlewares(sources, request, initialRes
                 for (const [accountId, accountBalances] of Object.entries(normalizedResponse.assetsBalance)) {
                     const previousBalances = previousState.assetsBalance[accountId] ?? {};
                     const customAssetIds = state.customAssets[accountId] ?? [];
-                    // Full: response is authoritative for the chains it covered;
-                    //   balances for chains not in the response are preserved from
-                    //   previous state so unsupported chains (e.g. Ink on AccountsAPI)
-                    //   are never inadvertently reset to zero.
-                    // Merge: response overlays previous balances.
-                    const effective = mode === 'merge'
-                        ? { ...previousBalances, ...accountBalances }
-                        : (() => {
-                            // Determine which chain namespaces this response covers.
-                            const coveredChains = new Set(Object.keys(accountBalances).map((assetId) => assetId.split('/')[0]));
-                            // Start from previous balances, dropping only entries for
-                            // chains this response is authoritative over.
-                            const next = {};
-                            for (const [assetId, balance] of Object.entries(previousBalances)) {
-                                if (!coveredChains.has(assetId.split('/')[0])) {
-                                    next[assetId] = balance;
-                                }
-                            }
-                            // Apply the response (authoritative for covered chains).
-                            Object.assign(next, accountBalances);
-                            // Preserve custom assets that the response omitted.
-                            for (const customId of customAssetIds) {
-                                if (!Object.prototype.hasOwnProperty.call(next, customId)) {
-                                    const prev = previousBalances[customId];
-                                    next[customId] =
-                                        prev ?? { amount: '0' };
-                                }
-                            }
-                            return next;
-                        })();
+                    const replaceCoveredChains = mode === 'full' ||
+                        normalizedResponse.replaceCoveredChainBalances === true;
+                    const effective = mergeAccountBalances(previousBalances, accountBalances, customAssetIds, replaceCoveredChains);
                     // Ensure native tokens have an entry (0 if missing) for chains this account supports
                     const account = __classPrivateFieldGet(this, _AssetsController_instances, "m", _AssetsController_getSelectedAccounts).call(this).find((a) => a.id === accountId);
                     const nativeAssetIdsForAccount = account
@@ -1748,14 +1824,8 @@ async function _AssetsController_executeMiddlewares(sources, request, initialRes
         enabledChainCount: chainIds.length,
     });
     __classPrivateFieldSet(this, _AssetsController_lastKnownAccountIds, new Set(accounts.map((a) => a.id)), "f");
-    __classPrivateFieldGet(this, _AssetsController_instances, "m", _AssetsController_subscribeAssets).call(this);
-    __classPrivateFieldGet(this, _AssetsController_instances, "m", _AssetsController_ensureNativeBalancesDefaultZero).call(this);
-    __classPrivateFieldGet(this, _AssetsController_instances, "m", _AssetsController_ensureDefaultTrackedAssetsSeeded).call(this);
-    this.getAssets(accounts, {
-        chainIds,
-        forceUpdate: true,
-    }).catch((error) => {
-        log('Failed to fetch assets', error);
+    __classPrivateFieldGet(this, _AssetsController_instances, "m", _AssetsController_runStartupRefresh).call(this, accounts).catch((error) => {
+        log('Failed to start asset tracking', error);
     });
 }, _AssetsController_stop = function _AssetsController_stop() {
     log('Stopping asset tracking', {
@@ -2154,17 +2224,49 @@ async function _AssetsController_handleNetworkDidChange(networkState) {
         await this.getAssets(accounts, {
             chainIds: [selectedChainId],
             forceUpdate: true,
+            dataTypes: ['balance', 'metadata', 'price'],
         });
         __classPrivateFieldGet(this, _AssetsController_instances, "m", _AssetsController_ensureNativeBalancesDefaultZero).call(this);
+        __classPrivateFieldGet(this, _AssetsController_instances, "m", _AssetsController_fetchMissingPricesWithoutCache).call(this, accounts, [selectedChainId]);
     }
     finally {
         releaseLock();
     }
 }, _AssetsController_refreshAssetsAfterNetworkChange = function _AssetsController_refreshAssetsAfterNetworkChange() {
-    this.getAssets(__classPrivateFieldGet(this, _AssetsController_instances, "m", _AssetsController_getSelectedAccounts).call(this), {
+    const accounts = __classPrivateFieldGet(this, _AssetsController_instances, "m", _AssetsController_getSelectedAccounts).call(this);
+    if (accounts.length === 0) {
+        return;
+    }
+    this.getAssets(accounts, {
         forceUpdate: true,
+        dataTypes: ['balance', 'metadata'],
     }).catch((error) => {
         log('Failed to refresh assets after network change', { error });
     });
+}, _AssetsController_refreshAssetsAfterNetworkAdded = 
+/**
+ * Refresh balances and fetch missing prices after a network is added.
+ *
+ * @param hexChainId - Hex chain id of the newly-added network.
+ */
+async function _AssetsController_refreshAssetsAfterNetworkAdded(hexChainId) {
+    const accounts = __classPrivateFieldGet(this, _AssetsController_instances, "m", _AssetsController_getSelectedAccounts).call(this);
+    if (accounts.length === 0) {
+        return;
+    }
+    let caipChainId;
+    try {
+        caipChainId = `eip155:${parseInt(hexChainId, 16)}`;
+    }
+    catch {
+        return;
+    }
+    await this.getAssets(accounts, {
+        chainIds: [caipChainId],
+        forceUpdate: true,
+        dataTypes: ['balance', 'metadata', 'price'],
+    });
+    __classPrivateFieldGet(this, _AssetsController_instances, "m", _AssetsController_ensureNativeBalancesDefaultZero).call(this);
+    __classPrivateFieldGet(this, _AssetsController_instances, "m", _AssetsController_fetchMissingPricesWithoutCache).call(this, accounts, [caipChainId]);
 };
 //# sourceMappingURL=AssetsController.cjs.map