@metamask-previews/assets-controller 9.1.0-preview-bdb5ec714 → 9.1.0-preview-12040e2d0

package/CHANGELOG.md

@@ -13,9 +13,12 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ### Fixed
 
-- Fix stale token balances after transactions when switching accounts or when websocket subscriptions reconnect; `AssetsController` now fetches before re-subscribing on account switch, serializes overlapping refresh work, treats `getAssets({ forceUpdate: true })` as authoritative over recent websocket freshness guards, and prevents passive polling from overwriting websocket balances for 120 seconds ([#9265](https://github.com/MetaMask/core/pull/9265))
+- 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 optional channel callbacks for more reliable notification delivery ([#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]
 

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_wsBalanceFreshUntil, _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_filterBalancesRespectingWsFreshness, _AssetsController_markWsBalancesFresh, _AssetsController_clearWsBalanceFreshness, _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_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;
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.AssetsController = exports.getDefaultAssetsControllerState = void 0;
 const base_controller_1 = require("@metamask/base-controller");
@@ -62,15 +62,6 @@ const MESSENGER_EXPOSED_METHODS = [
 ];
 /** Default polling interval hint for data sources (30 seconds) */
 const DEFAULT_POLLING_INTERVAL_MS = 30000;
-/** Sources whose passive polling must not overwrite recent websocket balances. */
-const POLLING_BALANCE_SOURCES = new Set([
-    'AccountsApiDataSource',
-    'RpcDataSource',
-    'SnapDataSource',
-    'StakedBalanceDataSource',
-]);
-/** How long websocket balance updates block stale polling overwrites. */
-const WS_BALANCE_FRESHNESS_MS = 120000;
 // ============================================================================
 // TRACE NAMES — used in Sentry spans (search these strings in Discover)
 // ============================================================================
@@ -201,9 +192,6 @@ function normalizeResponse(response) {
     if (response.updateMode) {
         normalized.updateMode = response.updateMode;
     }
-    if (response.sourceId) {
-        normalized.sourceId = response.sourceId;
-    }
     return normalized;
 }
 // ============================================================================
@@ -284,11 +272,6 @@ class AssetsController extends base_controller_1.BaseController {
          * re-subscriptions when the account set hasn't actually changed.
          */
         _AssetsController_lastKnownAccountIds.set(this, new Set());
-        /**
-         * Per `accountId:assetId`, timestamp until which websocket balance updates
-         * should not be overwritten by polling/API fetches.
-         */
-        _AssetsController_wsBalanceFreshUntil.set(this, new Map());
         _AssetsController_backendWebsocketDataSource.set(this, void 0);
         _AssetsController_accountsApiDataSource.set(this, void 0);
         _AssetsController_snapDataSource.set(this, void 0);
@@ -437,9 +420,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.
             //
-            // 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.
+            // 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.
             const fastSources = __classPrivateFieldGet(this, _AssetsController_isBasicFunctionality, "f").call(this)
                 ? [
                     (0, ParallelMiddleware_1.createParallelBalanceMiddleware)([
@@ -459,14 +442,7 @@ 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);
-            // 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',
-                sourceId: 'getAssets:forceUpdate',
-            });
+            await __classPrivateFieldGet(this, _AssetsController_instances, "m", _AssetsController_updateState).call(this, { ...response, updateMode: 'update' });
             // 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
@@ -486,11 +462,7 @@ class AssetsController extends base_controller_1.BaseController {
                     ]
                     : []),
             ], request)
-                .then(({ response: slowResponse }) => __classPrivateFieldGet(this, _AssetsController_instances, "m", _AssetsController_updateState).call(this, {
-                ...slowResponse,
-                updateMode: 'merge',
-                sourceId: 'getAssets:forceUpdate',
-            }))
+                .then(({ response: slowResponse }) => __classPrivateFieldGet(this, _AssetsController_instances, "m", _AssetsController_updateState).call(this, { ...slowResponse, updateMode: 'update' }))
                 .catch((error) => log('Background pipeline failed', { error }));
             const durationMs = performance.now() - startTime;
             // Emit trace for every full fetch (Assets Health dashboard)
@@ -897,11 +869,7 @@ 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, sourceId });
-        if (sourceId === 'BackendWebsocketDataSource' &&
-            enrichedResponse.assetsBalance) {
-            __classPrivateFieldGet(this, _AssetsController_instances, "m", _AssetsController_markWsBalancesFresh).call(this, enrichedResponse.assetsBalance);
-        }
+        await __classPrivateFieldGet(this, _AssetsController_instances, "m", _AssetsController_updateState).call(this, enrichedResponse);
         __classPrivateFieldGet(this, _AssetsController_instances, "m", _AssetsController_emitTrace).call(this, TRACE_UPDATE_PIPELINE, {
             source: sourceId,
             duration_ms: performance.now() - updateStart,
@@ -949,7 +917,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_wsBalanceFreshUntil = 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_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 = {
     controller: 'AssetsController',
 }) {
     if (!__classPrivateFieldGet(this, _AssetsController_trace, "f")) {
@@ -1411,37 +1379,9 @@ async function _AssetsController_executeMiddlewares(sources, request, initialRes
             }
         }
     });
-}, _AssetsController_filterBalancesRespectingWsFreshness = function _AssetsController_filterBalancesRespectingWsFreshness(accountId, accountBalances, sourceId) {
-    if (!sourceId || !POLLING_BALANCE_SOURCES.has(sourceId)) {
-        return accountBalances;
-    }
-    const now = Date.now();
-    const filtered = {};
-    for (const [assetId, balance] of Object.entries(accountBalances)) {
-        const freshUntil = __classPrivateFieldGet(this, _AssetsController_wsBalanceFreshUntil, "f").get(`${accountId}:${assetId}`);
-        if (freshUntil !== undefined && now < freshUntil) {
-            continue;
-        }
-        filtered[assetId] = balance;
-    }
-    return filtered;
-}, _AssetsController_markWsBalancesFresh = function _AssetsController_markWsBalancesFresh(assetsBalance) {
-    const freshUntil = Date.now() + WS_BALANCE_FRESHNESS_MS;
-    for (const [accountId, balances] of Object.entries(assetsBalance)) {
-        for (const assetId of Object.keys(balances)) {
-            __classPrivateFieldGet(this, _AssetsController_wsBalanceFreshUntil, "f").set(`${accountId}:${assetId}`, freshUntil);
-        }
-    }
-}, _AssetsController_clearWsBalanceFreshness = function _AssetsController_clearWsBalanceFreshness(assetsBalance) {
-    for (const [accountId, balances] of Object.entries(assetsBalance)) {
-        for (const assetId of Object.keys(balances)) {
-            __classPrivateFieldGet(this, _AssetsController_wsBalanceFreshUntil, "f").delete(`${accountId}:${assetId}`);
-        }
-    }
 }, _AssetsController_updateState = async function _AssetsController_updateState(response) {
     const normalizedResponse = normalizeResponse(response);
     const mode = normalizedResponse.updateMode ?? 'merge';
-    const assetsBalanceToApply = normalizedResponse.assetsBalance;
     const releaseLock = await __classPrivateFieldGet(this, _AssetsController_controllerMutex, "f").acquire();
     try {
         const previousState = this.state;
@@ -1456,7 +1396,7 @@ async function _AssetsController_executeMiddlewares(sources, request, initialRes
             const metadata = state.assetsInfo;
             const balances = state.assetsBalance;
             const prices = state.assetsPrice;
-            if (normalizedResponse.assetsInfo) {
+            if (normalizedResponse.assetsInfo && mode !== 'update') {
                 for (const [key, value] of Object.entries(normalizedResponse.assetsInfo)) {
                     if (!(0, lodash_1.isEqual)(previousState.assetsInfo[key], value)) {
                         changedMetadata.push(key);
@@ -1502,21 +1442,21 @@ async function _AssetsController_executeMiddlewares(sources, request, initialRes
                     }
                 }
             }
-            if (assetsBalanceToApply) {
-                for (const [accountId, accountBalances] of Object.entries(assetsBalanceToApply)) {
-                    const filteredAccountBalances = __classPrivateFieldGet(this, _AssetsController_instances, "m", _AssetsController_filterBalancesRespectingWsFreshness).call(this, accountId, accountBalances, normalizedResponse.sourceId);
+            if (normalizedResponse.assetsBalance) {
+                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, ...filteredAccountBalances }
+                    // Merge / update: response overlays previous balances (update never
+                    //   removes tokens missing from a partial snapshot).
+                    const effective = mode === 'merge' || mode === 'update'
+                        ? { ...previousBalances, ...accountBalances }
                         : (() => {
                             // Determine which chain namespaces this response covers.
-                            const coveredChains = new Set(Object.keys(filteredAccountBalances).map((assetId) => assetId.split('/')[0]));
+                            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 = {};
@@ -1526,7 +1466,7 @@ async function _AssetsController_executeMiddlewares(sources, request, initialRes
                                 }
                             }
                             // Apply the response (authoritative for covered chains).
-                            Object.assign(next, filteredAccountBalances);
+                            Object.assign(next, accountBalances);
                             // Preserve custom assets that the response omitted.
                             for (const customId of customAssetIds) {
                                 if (!(customId in next)) {
@@ -1575,8 +1515,8 @@ async function _AssetsController_executeMiddlewares(sources, request, initialRes
                     balances[accountId] = effective;
                 }
             }
-            // Update prices in state
-            if (normalizedResponse.assetsPrice) {
+            // Update prices in state (skipped for balance-only update mode)
+            if (normalizedResponse.assetsPrice && mode !== 'update') {
                 for (const [key, value] of Object.entries(normalizedResponse.assetsPrice)) {
                     prices[key] = value;
                 }
@@ -1638,12 +1578,6 @@ async function _AssetsController_executeMiddlewares(sources, request, initialRes
                 });
             }
         }
-        // Authoritative fetch on account switch — drop WS freshness locks so API
-        // balances (e.g. receiver +1 USDC) replace stale values from a prior send.
-        if (normalizedResponse.sourceId === 'getAssets:forceUpdate' &&
-            assetsBalanceToApply) {
-            __classPrivateFieldGet(this, _AssetsController_instances, "m", _AssetsController_clearWsBalanceFreshness).call(this, assetsBalanceToApply);
-        }
     }
     finally {
         releaseLock();