@metamask-previews/assets-controller 9.1.0-preview-ba933fc1b → 9.1.0-preview-14cbc2873

package/CHANGELOG.md

@@ -11,15 +11,6 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 - Bump `@metamask/transaction-controller` from `^68.1.1` to `^68.2.0` ([#9253](https://github.com/MetaMask/core/pull/9253))
 
-### Fixed
-
-- Fix stale token balances after transactions when switching accounts or when websocket subscriptions reconnect; `AssetsController` now fetches before re-subscribing on account switch and serializes overlapping refresh work ([#9265](https://github.com/MetaMask/core/pull/9265))
-- `AccountsApiDataSource` bypasses the TanStack Query balance cache when `forceUpdate` is true so forced refreshes return up-to-date balances instead of 60-second cached values ([#9265](https://github.com/MetaMask/core/pull/9265))
-- `BackendWebsocketDataSource` re-subscribes when subscribed accounts change (case-insensitive EVM address matching), serializes subscribe/unsubscribe to prevent races on account switch, and registers channel callbacks as a fallback when server `subscriptionId` values do not match ([#9265](https://github.com/MetaMask/core/pull/9265))
-- 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))
-- Add `update` balance update mode so fetch and force-refresh pipelines patch balances without removing tokens omitted from partial API snapshots; `getAssets({ forceUpdate: true })`, `AccountsApiDataSource`, and `SnapDataSource` use this mode ([#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))
-
 ## [9.1.0]
 
 ### Added

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_updateActive, _AssetsController_handleAccountTreeStateChange, _AssetsController_runAccountTreeRefresh, _AssetsController_registerActionHandlers, _AssetsController_handleActiveChainsUpdate, _AssetsController_executeMiddlewares, _AssetsController_getNativeAssetMap, _AssetsController_isNativeAsset, _AssetsController_getAssetType, _AssetsController_resolveNativeAssetIds, _AssetsController_getNativeAssetIdsForEnabledChains, _AssetsController_getNativeAssetIdsForAccount, _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_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_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_updateActive, _AssetsController_handleAccountTreeStateChange, _AssetsController_registerActionHandlers, _AssetsController_handleActiveChainsUpdate, _AssetsController_executeMiddlewares, _AssetsController_getNativeAssetMap, _AssetsController_isNativeAsset, _AssetsController_getAssetType, _AssetsController_resolveNativeAssetIds, _AssetsController_getNativeAssetIdsForEnabledChains, _AssetsController_getNativeAssetIdsForAccount, _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_refreshAssetsAfterNetworkChange;
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.AssetsController = exports.getDefaultAssetsControllerState = void 0;
 const base_controller_1 = require("@metamask/base-controller");
@@ -255,8 +255,6 @@ class AssetsController extends base_controller_1.BaseController {
         /** Whether the keyring is unlocked. Combined with #uiOpen for #updateActive. */
         _AssetsController_keyringUnlocked.set(this, false);
         _AssetsController_controllerMutex.set(this, new async_mutex_1.Mutex());
-        /** Serializes account-switch fetch + subscribe to prevent overlapping races. */
-        _AssetsController_accountRefreshMutex.set(this, new async_mutex_1.Mutex());
         /**
          * Active balance subscriptions keyed by account ID.
          * Each account has one logical subscription that may span multiple data sources.
@@ -420,9 +418,9 @@ class AssetsController extends base_controller_1.BaseController {
             // creation, RPC is slow on many chains). Results are committed to state
             // immediately so the UI can display balances without waiting for them.
             //
-            // Fast/slow pipelines use 'update' so partial API snapshots cannot wipe
-            // tokens missing from the response (e.g. USDC when only native balance
-            // is returned). Balances present in the response are still refreshed.
+            // Both the fast and background pipelines use 'merge' mode because neither
+            // alone represents the full set of data sources. Using 'full' in either
+            // would wipe balances from the sources handled by the other pipeline.
             const fastSources = __classPrivateFieldGet(this, _AssetsController_isBasicFunctionality, "f").call(this)
                 ? [
                     (0, ParallelMiddleware_1.createParallelBalanceMiddleware)([
@@ -442,7 +440,10 @@ 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: 'update' });
+            // The fast pipeline only contains a subset of data sources (AccountsApi +
+            // StakedBalance), so it must always merge to avoid wiping Snap/RPC
+            // balances that the background pipeline hasn't yet replaced.
+            await __classPrivateFieldGet(this, _AssetsController_instances, "m", _AssetsController_updateState).call(this, { ...response, updateMode: 'merge' });
             // 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
@@ -462,7 +463,7 @@ class AssetsController extends base_controller_1.BaseController {
                     ]
                     : []),
             ], request)
-                .then(({ response: slowResponse }) => __classPrivateFieldGet(this, _AssetsController_instances, "m", _AssetsController_updateState).call(this, { ...slowResponse, updateMode: 'update' }))
+                .then(({ response: slowResponse }) => __classPrivateFieldGet(this, _AssetsController_instances, "m", _AssetsController_updateState).call(this, { ...slowResponse, updateMode: 'merge' }))
                 .catch((error) => log('Background pipeline failed', { error }));
             const durationMs = performance.now() - startTime;
             // Emit trace for every full fetch (Assets Health dashboard)
@@ -917,7 +918,7 @@ class AssetsController extends base_controller_1.BaseController {
     }
 }
 exports.AssetsController = AssetsController;
-_AssetsController_isEnabled = new WeakMap(), _AssetsController_isBasicFunctionality = new WeakMap(), _AssetsController_defaultUpdateInterval = new WeakMap(), _AssetsController_trace = new WeakMap(), _AssetsController_captureException = new WeakMap(), _AssetsController_firstInitFetchReported = new WeakMap(), _AssetsController_stateSizeReported = new WeakMap(), _AssetsController_uiOpen = new WeakMap(), _AssetsController_keyringUnlocked = new WeakMap(), _AssetsController_controllerMutex = new WeakMap(), _AssetsController_accountRefreshMutex = new WeakMap(), _AssetsController_activeSubscriptions = new WeakMap(), _AssetsController_enabledChains = new WeakMap(), _AssetsController_lastKnownAccountIds = new WeakMap(), _AssetsController_backendWebsocketDataSource = new WeakMap(), _AssetsController_accountsApiDataSource = new WeakMap(), _AssetsController_snapDataSource = new WeakMap(), _AssetsController_rpcDataSource = new WeakMap(), _AssetsController_stakedBalanceDataSource = new WeakMap(), _AssetsController_priceDataSource = new WeakMap(), _AssetsController_detectionMiddleware = new WeakMap(), _AssetsController_customAssetGraduationMiddleware = new WeakMap(), _AssetsController_rpcFallbackMiddleware = new WeakMap(), _AssetsController_tokenDataSource = new WeakMap(), _AssetsController_unsubscribeBasicFunctionality = new WeakMap(), _AssetsController_queryApiClient = new WeakMap(), _AssetsController_onActiveChainsUpdated = new WeakMap(), _AssetsController_instances = new WeakSet(), _AssetsController_emitTrace = function _AssetsController_emitTrace(name, data, tags = {
+_AssetsController_isEnabled = new WeakMap(), _AssetsController_isBasicFunctionality = new WeakMap(), _AssetsController_defaultUpdateInterval = new WeakMap(), _AssetsController_trace = new WeakMap(), _AssetsController_captureException = new WeakMap(), _AssetsController_firstInitFetchReported = new WeakMap(), _AssetsController_stateSizeReported = new WeakMap(), _AssetsController_uiOpen = new WeakMap(), _AssetsController_keyringUnlocked = new WeakMap(), _AssetsController_controllerMutex = new WeakMap(), _AssetsController_activeSubscriptions = new WeakMap(), _AssetsController_enabledChains = new WeakMap(), _AssetsController_lastKnownAccountIds = new WeakMap(), _AssetsController_backendWebsocketDataSource = new WeakMap(), _AssetsController_accountsApiDataSource = new WeakMap(), _AssetsController_snapDataSource = new WeakMap(), _AssetsController_rpcDataSource = new WeakMap(), _AssetsController_stakedBalanceDataSource = new WeakMap(), _AssetsController_priceDataSource = new WeakMap(), _AssetsController_detectionMiddleware = new WeakMap(), _AssetsController_customAssetGraduationMiddleware = new WeakMap(), _AssetsController_rpcFallbackMiddleware = new WeakMap(), _AssetsController_tokenDataSource = new WeakMap(), _AssetsController_unsubscribeBasicFunctionality = new WeakMap(), _AssetsController_queryApiClient = new WeakMap(), _AssetsController_onActiveChainsUpdated = new WeakMap(), _AssetsController_instances = new WeakSet(), _AssetsController_emitTrace = function _AssetsController_emitTrace(name, data, tags = {
     controller: 'AssetsController',
 }) {
     if (!__classPrivateFieldGet(this, _AssetsController_trace, "f")) {
@@ -1124,39 +1125,23 @@ _AssetsController_isEnabled = new WeakMap(), _AssetsController_isBasicFunctional
         if (!accountsChanged) {
             return;
         }
-        const hasOverlap = [...currentIds].some((id) => __classPrivateFieldGet(this, _AssetsController_lastKnownAccountIds, "f").has(id));
-        if (!hasOverlap && __classPrivateFieldGet(this, _AssetsController_lastKnownAccountIds, "f").size > 0) {
-            return;
-        }
         log('Account tree changed with new accounts, re-subscribing', {
             previousCount: __classPrivateFieldGet(this, _AssetsController_lastKnownAccountIds, "f").size,
             currentCount: currentIds.size,
         });
         __classPrivateFieldSet(this, _AssetsController_lastKnownAccountIds, currentIds, "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);
-        __classPrivateFieldGet(this, _AssetsController_instances, "m", _AssetsController_runAccountTreeRefresh).call(this, accounts).catch((error) => {
-            log('Failed to refresh assets after tree change', error);
-        });
-    }
-    else {
-        __classPrivateFieldGet(this, _AssetsController_instances, "m", _AssetsController_start).call(this);
-    }
-}, _AssetsController_runAccountTreeRefresh = async function _AssetsController_runAccountTreeRefresh(accounts) {
-    const releaseLock = await __classPrivateFieldGet(this, _AssetsController_accountRefreshMutex, "f").acquire();
-    try {
-        await this.getAssets(accounts, {
+        this.getAssets(accounts, {
             chainIds: [...__classPrivateFieldGet(this, _AssetsController_enabledChains, "f")],
             forceUpdate: true,
+        }).catch((error) => {
+            log('Failed to fetch assets after tree change', error);
         });
-        __classPrivateFieldGet(this, _AssetsController_instances, "m", _AssetsController_subscribeAssets).call(this);
     }
-    catch (error) {
-        log('Failed to fetch assets after tree change', error);
-        __classPrivateFieldGet(this, _AssetsController_instances, "m", _AssetsController_subscribeAssets).call(this);
-    }
-    finally {
-        releaseLock();
+    else {
+        __classPrivateFieldGet(this, _AssetsController_instances, "m", _AssetsController_start).call(this);
     }
 }, _AssetsController_registerActionHandlers = function _AssetsController_registerActionHandlers() {
     this.messenger.registerMethodActionHandlers(this, MESSENGER_EXPOSED_METHODS);
@@ -1397,43 +1382,29 @@ async function _AssetsController_executeMiddlewares(sources, request, initialRes
             const balances = state.assetsBalance;
             const prices = state.assetsPrice;
             if (normalizedResponse.assetsInfo) {
-                if (mode === 'update') {
-                    // Balance-only refresh: patch amounts without overwriting metadata,
-                    // but seed entries that are missing so RPC-only chains (e.g.
-                    // Avalanche) can render native balances on first fetch.
-                    for (const [key, value] of Object.entries(normalizedResponse.assetsInfo)) {
-                        if (metadata[key]) {
-                            continue;
-                        }
-                        metadata[key] = value;
+                for (const [key, value] of Object.entries(normalizedResponse.assetsInfo)) {
+                    if (!(0, lodash_1.isEqual)(previousState.assetsInfo[key], value)) {
                         changedMetadata.push(key);
                     }
-                }
-                else {
-                    for (const [key, value] of Object.entries(normalizedResponse.assetsInfo)) {
-                        if (!(0, lodash_1.isEqual)(previousState.assetsInfo[key], value)) {
-                            changedMetadata.push(key);
-                        }
-                        const existing = metadata[key];
-                        const incoming = value;
-                        // When the API returns no symbol or name for this token, it has no
-                        // real knowledge of it (e.g. a user-deployed token not indexed by
-                        // the API). Preserve richer metadata already in state (e.g. from
-                        // pendingMetadata set by addCustomAsset) so that the correct
-                        // decimals/symbol/name/image are not overwritten with empty values.
-                        if (existing && !incoming.symbol && !incoming.name) {
-                            metadata[key] = {
-                                ...existing,
-                                ...incoming,
-                                symbol: existing.symbol,
-                                name: existing.name,
-                                decimals: existing.decimals ?? incoming.decimals,
-                                image: existing.image ?? incoming.image,
-                            };
-                        }
-                        else {
-                            metadata[key] = value;
-                        }
+                    const existing = metadata[key];
+                    const incoming = value;
+                    // When the API returns no symbol or name for this token, it has no
+                    // real knowledge of it (e.g. a user-deployed token not indexed by
+                    // the API). Preserve richer metadata already in state (e.g. from
+                    // pendingMetadata set by addCustomAsset) so that the correct
+                    // decimals/symbol/name/image are not overwritten with empty values.
+                    if (existing && !incoming.symbol && !incoming.name) {
+                        metadata[key] = {
+                            ...existing,
+                            ...incoming,
+                            symbol: existing.symbol,
+                            name: existing.name,
+                            decimals: existing.decimals ?? incoming.decimals,
+                            image: existing.image ?? incoming.image,
+                        };
+                    }
+                    else {
+                        metadata[key] = value;
                     }
                 }
             }
@@ -1464,9 +1435,8 @@ async function _AssetsController_executeMiddlewares(sources, request, initialRes
                     //   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 / update: response overlays previous balances (update never
-                    //   removes tokens missing from a partial snapshot).
-                    const effective = mode === 'merge' || mode === 'update'
+                    // Merge: response overlays previous balances.
+                    const effective = mode === 'merge'
                         ? { ...previousBalances, ...accountBalances }
                         : (() => {
                             // Determine which chain namespaces this response covers.
@@ -1529,21 +1499,10 @@ async function _AssetsController_executeMiddlewares(sources, request, initialRes
                     balances[accountId] = effective;
                 }
             }
-            // Update prices in state. Update mode only seeds missing entries so
-            // balance-only refreshes do not clobber existing price data.
+            // Update prices in state
             if (normalizedResponse.assetsPrice) {
-                if (mode === 'update') {
-                    for (const [key, value] of Object.entries(normalizedResponse.assetsPrice)) {
-                        if (prices[key]) {
-                            continue;
-                        }
-                        prices[key] = value;
-                    }
-                }
-                else {
-                    for (const [key, value] of Object.entries(normalizedResponse.assetsPrice)) {
-                        prices[key] = value;
-                    }
+                for (const [key, value] of Object.entries(normalizedResponse.assetsPrice)) {
+                    prices[key] = value;
                 }
             }
         });
@@ -1973,22 +1932,16 @@ async function _AssetsController_handleAccountGroupChanged() {
         accountIds: accounts.map((a) => a.id),
     });
     __classPrivateFieldSet(this, _AssetsController_lastKnownAccountIds, new Set(accounts.map((a) => a.id)), "f");
-    const releaseLock = await __classPrivateFieldGet(this, _AssetsController_accountRefreshMutex, "f").acquire();
-    try {
-        if (accounts.length > 0) {
-            await this.getAssets(accounts, {
-                chainIds: [...__classPrivateFieldGet(this, _AssetsController_enabledChains, "f")],
-                forceUpdate: true,
-            });
-        }
-        // Subscribe after fetch so WS notifications can recover state
-        __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();
+    // Subscribe and fetch for the new account group
+    __classPrivateFieldGet(this, _AssetsController_instances, "m", _AssetsController_subscribeAssets).call(this);
+    if (accounts.length > 0) {
+        await this.getAssets(accounts, {
+            chainIds: [...__classPrivateFieldGet(this, _AssetsController_enabledChains, "f")],
+            forceUpdate: true,
+        });
     }
+    __classPrivateFieldGet(this, _AssetsController_instances, "m", _AssetsController_ensureNativeBalancesDefaultZero).call(this);
+    __classPrivateFieldGet(this, _AssetsController_instances, "m", _AssetsController_ensureDefaultTrackedAssetsSeeded).call(this);
 }, _AssetsController_handleEnabledNetworksChanged = async function _AssetsController_handleEnabledNetworksChanged(enabledNetworkMap) {
     const previousChains = __classPrivateFieldGet(this, _AssetsController_enabledChains, "f");
     __classPrivateFieldSet(this, _AssetsController_enabledChains, __classPrivateFieldGet(this, _AssetsController_instances, "m", _AssetsController_extractEnabledChains).call(this, enabledNetworkMap), "f");