@metamask-previews/assets-controller 8.3.2-preview-2b6e433 → 8.3.2-preview-cf351fcd3

package/CHANGELOG.md

@@ -9,9 +9,16 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ### Changed
 
+- **BREAKING:** `DataResponse.updateMode` (`AssetsUpdateMode`) changed from `'merge' | 'full'` to `{ type: 'merge' } | { type: 'full'; fullReplaceChainIds: ChainId[] }`. `'full'` now replaces balances only for listed chains. Update all `updateMode` reads/writes to the object form ([#9062](https://github.com/MetaMask/core/pull/9062))
+  - `mergeDataResponses` preserves `'full'` updates by unioning `fullReplaceChainIds` during merges.
 - Bump `@metamask/network-enablement-controller` from `^5.2.0` to `^5.3.0` ([#9003](https://github.com/MetaMask/core/pull/9003))
 - Bump `@metamask/transaction-controller` from `^66.0.1` to `^67.0.0` ([#9021](https://github.com/MetaMask/core/pull/9021))
 
+### Fixed
+
+- `AssetsController` no longer wipes balances on chains a `'full'` update doesn't cover, fixing tokens disappearing on unlock and network switch. Previously a `'full'` response (e.g. from `AccountsApiDataSource` subscription polls) replaced an account's entire balance map across all chains, clearing tokens on chains the source doesn't serve (custom/RPC-only chains) or that came back `unprocessed`. `'full'` replacement is now scoped to `fullReplaceChainIds`, and user custom assets are always preserved ([#9062](https://github.com/MetaMask/core/pull/9062))
+  - `AccountsApiDataSource` now sets `fullReplaceChainIds` to processed chains (excluding `unprocessedNetworks`) so `'full'` updates never clear balances on unfetched chains
+
 ## [8.3.2]
 
 ### Changed

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_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_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_resolveNativeAssetIds, _AssetsController_getNativeAssetIdsForEnabledChains, _AssetsController_getNativeAssetIdsForAccount, _AssetsController_ensureNativeBalancesDefaultZero, _AssetsController_ensureDefaultTrackedAssetsSeeded, _AssetsController_buildFullBalances, _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");
@@ -441,7 +441,7 @@ class AssetsController extends base_controller_1.BaseController {
             // 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' });
+            await __classPrivateFieldGet(this, _AssetsController_instances, "m", _AssetsController_updateState).call(this, { ...response, updateMode: { type: '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
@@ -461,7 +461,7 @@ class AssetsController extends base_controller_1.BaseController {
                     ]
                     : []),
             ], request)
-                .then(({ response: slowResponse }) => __classPrivateFieldGet(this, _AssetsController_instances, "m", _AssetsController_updateState).call(this, { ...slowResponse, updateMode: 'merge' }))
+                .then(({ response: slowResponse }) => __classPrivateFieldGet(this, _AssetsController_instances, "m", _AssetsController_updateState).call(this, { ...slowResponse, updateMode: { type: 'merge' } }))
                 .catch((error) => log('Background pipeline failed', { error }));
             const durationMs = performance.now() - startTime;
             // Emit trace for every full fetch (Assets Health dashboard)
@@ -647,7 +647,7 @@ class AssetsController extends base_controller_1.BaseController {
                 dataTypes: ['balance', 'metadata', 'price'],
                 assetTypes: ['fungible'],
                 forceUpdate: true,
-                updateMode: 'merge',
+                updateMode: { type: 'merge' },
             });
         }
         // Re-evaluate subscriptions so the supplemental RPC poll picks up the
@@ -1166,7 +1166,7 @@ _AssetsController_isEnabled = new WeakMap(), _AssetsController_isBasicFunctional
             this.getAssets(__classPrivateFieldGet(this, _AssetsController_instances, "m", _AssetsController_getSelectedAccounts).call(this), {
                 chainIds: addedEnabledChains,
                 forceUpdate: true,
-                updateMode: 'merge',
+                updateMode: { type: 'merge' },
             }).catch((error) => {
                 log('Failed to fetch balance for added chains', { error });
             });
@@ -1361,9 +1361,31 @@ async function _AssetsController_executeMiddlewares(sources, request, initialRes
             }
         }
     });
+}, _AssetsController_buildFullBalances = function _AssetsController_buildFullBalances({ previousBalances, accountBalances, customAssetIds, fullReplaceChains, }) {
+    const next = { ...previousBalances };
+    const customAssetIdSet = new Set(customAssetIds);
+    // Drop stale balance entries on the authoritative chains so the response is the
+    // source of truth there — but never drop user custom assets.
+    for (const assetId of Object.keys(next)) {
+        if (customAssetIdSet.has(assetId)) {
+            continue;
+        }
+        if (fullReplaceChains.has(extractChainId(assetId))) {
+            delete next[assetId];
+        }
+    }
+    // Apply the response (authoritative on its replaced chains).
+    Object.assign(next, accountBalances);
+    // Custom assets must survive a full refresh even when the source omits them.
+    for (const customId of customAssetIds) {
+        next[customId] ?? (next[customId] = previousBalances[customId] ?? { amount: '0' });
+    }
+    return next;
 }, _AssetsController_updateState = async function _AssetsController_updateState(response) {
     const normalizedResponse = normalizeResponse(response);
-    const mode = normalizedResponse.updateMode ?? 'merge';
+    const mode = normalizedResponse.updateMode ?? {
+        type: 'merge',
+    };
     const releaseLock = await __classPrivateFieldGet(this, _AssetsController_controllerMutex, "f").acquire();
     try {
         const previousState = this.state;
@@ -1409,33 +1431,36 @@ 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; preserve custom assets not in response.
+                    /*
+                    
+                    const updateMode: AssetsUpdateMode = normalizedResponse.updateMode ?? {
+                      type: 'merge',
+                    };
+                    const fullReplaceChains: Set<ChainId> | null =
+                      updateMode.type === 'full'
+                        ? new Set(updateMode.fullReplaceChainIds)
+                        : null;
+                    
+                    */
+                    // Full: response is authoritative, but only for the chains it declares
+                    // balances on every other chain are preserved.
                     // Merge: response overlays previous balances.
-                    // Callers that fetch partial data (e.g. newly added chains) must set updateMode: 'merge'.
-                    const effective = mode === 'merge'
+                    // Callers that fetch partial data (e.g. newly added chains) must use { type: 'merge' }.
+                    const effective = mode.type === 'merge'
                         ? { ...previousBalances, ...accountBalances }
-                        : (() => {
-                            const next = {
-                                ...accountBalances,
-                            };
-                            for (const customId of customAssetIds) {
-                                if (!(customId in next)) {
-                                    const prev = previousBalances[customId];
-                                    next[customId] =
-                                        prev ?? { amount: '0' };
-                                }
-                            }
-                            return next;
-                        })();
+                        : __classPrivateFieldGet(this, _AssetsController_instances, "m", _AssetsController_buildFullBalances).call(this, {
+                            previousBalances,
+                            accountBalances,
+                            customAssetIds,
+                            fullReplaceChains: new Set(mode.fullReplaceChainIds),
+                        });
                     // 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
                         ? __classPrivateFieldGet(this, _AssetsController_instances, "m", _AssetsController_getNativeAssetIdsForAccount).call(this, account)
                         : __classPrivateFieldGet(this, _AssetsController_instances, "m", _AssetsController_getNativeAssetIdsForEnabledChains).call(this);
                     for (const nativeAssetId of nativeAssetIdsForAccount) {
-                        if (!(nativeAssetId in effective)) {
-                            effective[nativeAssetId] = { amount: '0' };
-                        }
+                        effective[nativeAssetId] ?? (effective[nativeAssetId] = { amount: '0' });
                     }
                     for (const [assetId, balance] of Object.entries(effective)) {
                         const previousBalance = previousBalances[assetId];
@@ -1941,7 +1966,7 @@ async function _AssetsController_handleAccountGroupChanged() {
         await this.getAssets(__classPrivateFieldGet(this, _AssetsController_instances, "m", _AssetsController_getSelectedAccounts).call(this), {
             chainIds: addedChains,
             forceUpdate: true,
-            updateMode: 'merge',
+            updateMode: { type: 'merge' },
         });
     }
     __classPrivateFieldGet(this, _AssetsController_instances, "m", _AssetsController_ensureNativeBalancesDefaultZero).call(this);