@metamask-previews/assets-controller 2.0.2-preview-4c504af → 2.0.2-preview-702bd3940

package/CHANGELOG.md

@@ -24,6 +24,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ### Fixed
 
+- Default `assetsBalance` to `0` for native tokens of each account's supported chains using `NetworkEnablementController.nativeAssetIdentifiers`, so native entries are always present in state even before data sources respond ([#8036](https://github.com/MetaMask/core/pull/8036))
+- Auto-select `'merge'` update mode in `getAssets` when `chainIds` is a subset of enabled chains, preventing partial-chain fetches (e.g. after a swap, adding a custom asset, or data-source chain changes) from wiping balances of other chains ([#8036](https://github.com/MetaMask/core/pull/8036))
 - Convert WebSocket balance updates in `BackendWebsocketDataSource` from raw smallest-units to human-readable amounts using asset decimals (same behavior as RPC/Accounts API), so `assetsBalance` remains consistent across data sources ([#8032](https://github.com/MetaMask/core/pull/8032))
 - Include all assets from balance and each account's custom assets from state in `detectedAssets`, so prices and metadata are fetched for existing assets and custom tokens (previously only assets without metadata were included, so existing assets did not get prices) ([#8021](https://github.com/MetaMask/core/pull/8021))
 - Request `includeAggregators: true` when fetching token metadata from the v3 assets API so aggregator data is returned and stored in `assetsInfo` ([#8021](https://github.com/MetaMask/core/pull/8021))

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_trackMetaMetricsEvent, _AssetsController_firstInitFetchReported, _AssetsController_uiOpen, _AssetsController_keyringUnlocked, _AssetsController_controllerMutex, _AssetsController_activeSubscriptions, _AssetsController_enabledChains, _AssetsController_selectedAccounts_get, _AssetsController_backendWebsocketDataSource, _AssetsController_accountsApiDataSource, _AssetsController_snapDataSource, _AssetsController_rpcDataSource, _AssetsController_stakedBalanceDataSource, _AssetsController_allBalanceDataSources_get, _AssetsController_priceDataSource, _AssetsController_detectionMiddleware, _AssetsController_tokenDataSource, _AssetsController_unsubscribeBasicFunctionality, _AssetsController_initializeState, _AssetsController_extractEnabledChains, _AssetsController_normalizeChainReference, _AssetsController_subscribeToEvents, _AssetsController_updateActive, _AssetsController_registerActionHandlers, _AssetsController_executeMiddlewares, _AssetsController_updateState, _AssetsController_getAssetsFromState, _AssetsController_tokenStandardToAssetType, _AssetsController_start, _AssetsController_stop, _AssetsController_subscribeAssets, _AssetsController_subscribeAssetsBalance, _AssetsController_subscribeStakedBalance, _AssetsController_buildChainToAccountsMap, _AssetsController_subscribeDataSource, _AssetsController_unsubscribeDataSource, _AssetsController_buildDataRequest, _AssetsController_getEnabledChainsForAccount, _AssetsController_handleAccountGroupChanged, _AssetsController_handleEnabledNetworksChanged;
+var _AssetsController_instances, _AssetsController_isEnabled, _AssetsController_isBasicFunctionality, _AssetsController_defaultUpdateInterval, _AssetsController_trackMetaMetricsEvent, _AssetsController_firstInitFetchReported, _AssetsController_uiOpen, _AssetsController_keyringUnlocked, _AssetsController_controllerMutex, _AssetsController_activeSubscriptions, _AssetsController_enabledChains, _AssetsController_selectedAccounts_get, _AssetsController_backendWebsocketDataSource, _AssetsController_accountsApiDataSource, _AssetsController_snapDataSource, _AssetsController_rpcDataSource, _AssetsController_stakedBalanceDataSource, _AssetsController_allBalanceDataSources_get, _AssetsController_priceDataSource, _AssetsController_detectionMiddleware, _AssetsController_tokenDataSource, _AssetsController_unsubscribeBasicFunctionality, _AssetsController_initializeState, _AssetsController_extractEnabledChains, _AssetsController_normalizeChainReference, _AssetsController_subscribeToEvents, _AssetsController_updateActive, _AssetsController_registerActionHandlers, _AssetsController_executeMiddlewares, _AssetsController_resolveNativeAssetIds, _AssetsController_getNativeAssetIdsForEnabledChains, _AssetsController_getNativeAssetIdsForAccount, _AssetsController_ensureNativeBalancesDefaultZero, _AssetsController_updateState, _AssetsController_getAssetsFromState, _AssetsController_tokenStandardToAssetType, _AssetsController_start, _AssetsController_stop, _AssetsController_subscribeAssets, _AssetsController_subscribeAssetsBalance, _AssetsController_subscribeStakedBalance, _AssetsController_buildChainToAccountsMap, _AssetsController_subscribeDataSource, _AssetsController_unsubscribeDataSource, _AssetsController_buildDataRequest, _AssetsController_getEnabledChainsForAccount, _AssetsController_handleAccountGroupChanged, _AssetsController_handleEnabledNetworksChanged;
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.AssetsController = exports.getDefaultAssetsControllerState = void 0;
 const base_controller_1 = require("@metamask/base-controller");
@@ -343,6 +343,7 @@ class AssetsController extends base_controller_1.BaseController {
                 this.getAssets(__classPrivateFieldGet(this, _AssetsController_instances, "a", _AssetsController_selectedAccounts_get), {
                     chainIds: addedEnabledChains,
                     forceUpdate: true,
+                    updateMode: 'merge',
                 }).catch((error) => {
                     log('Failed to fetch balance for added chains', { error });
                 });
@@ -394,7 +395,12 @@ class AssetsController extends base_controller_1.BaseController {
                     __classPrivateFieldGet(this, _AssetsController_detectionMiddleware, "f"),
                 ];
             const { response, durationByDataSource } = await __classPrivateFieldGet(this, _AssetsController_instances, "m", _AssetsController_executeMiddlewares).call(this, sources, request);
-            await __classPrivateFieldGet(this, _AssetsController_instances, "m", _AssetsController_updateState).call(this, { ...response, updateMode: 'full' });
+            // Default to 'merge' when fetching a subset of chains so we don't wipe
+            // balances from chains that weren't included in this fetch.
+            const isPartialChainFetch = options?.chainIds !== undefined &&
+                options.chainIds.length < __classPrivateFieldGet(this, _AssetsController_enabledChains, "f").size;
+            const updateMode = options?.updateMode ?? (isPartialChainFetch ? 'merge' : 'full');
+            await __classPrivateFieldGet(this, _AssetsController_instances, "m", _AssetsController_updateState).call(this, { ...response, updateMode });
             if (__classPrivateFieldGet(this, _AssetsController_trackMetaMetricsEvent, "f") && !__classPrivateFieldGet(this, _AssetsController_firstInitFetchReported, "f")) {
                 __classPrivateFieldSet(this, _AssetsController_firstInitFetchReported, true, "f");
                 const durationMs = Date.now() - startTime;
@@ -508,13 +514,14 @@ class AssetsController extends base_controller_1.BaseController {
                     assetMetadata;
             }
         });
-        // Fetch data for the newly added custom asset
+        // Fetch data for the newly added custom asset (merge to preserve other chains)
         const account = __classPrivateFieldGet(this, _AssetsController_instances, "a", _AssetsController_selectedAccounts_get).find((a) => a.id === accountId);
         if (account) {
             const chainId = extractChainId(normalizedAssetId);
             await this.getAssets([account], {
                 chainIds: [chainId],
                 forceUpdate: true,
+                updateMode: 'merge',
             });
         }
     }
@@ -861,11 +868,44 @@ async function _AssetsController_executeMiddlewares(sources, request, initialRes
         }
     }
     return { response: result.response, durationByDataSource };
-}, _AssetsController_updateState = 
-// ============================================================================
-// STATE MANAGEMENT
-// ============================================================================
-async function _AssetsController_updateState(response) {
+}, _AssetsController_resolveNativeAssetIds = function _AssetsController_resolveNativeAssetIds(chains) {
+    const { nativeAssetIdentifiers } = this.messenger.call('NetworkEnablementController:getState');
+    const ids = [];
+    for (const chainId of chains) {
+        const nativeId = nativeAssetIdentifiers?.[chainId];
+        if (nativeId) {
+            ids.push(nativeId);
+        }
+    }
+    return ids;
+}, _AssetsController_getNativeAssetIdsForEnabledChains = function _AssetsController_getNativeAssetIdsForEnabledChains() {
+    return __classPrivateFieldGet(this, _AssetsController_instances, "m", _AssetsController_resolveNativeAssetIds).call(this, __classPrivateFieldGet(this, _AssetsController_enabledChains, "f"));
+}, _AssetsController_getNativeAssetIdsForAccount = function _AssetsController_getNativeAssetIdsForAccount(account) {
+    return __classPrivateFieldGet(this, _AssetsController_instances, "m", _AssetsController_resolveNativeAssetIds).call(this, __classPrivateFieldGet(this, _AssetsController_instances, "m", _AssetsController_getEnabledChainsForAccount).call(this, account));
+}, _AssetsController_ensureNativeBalancesDefaultZero = function _AssetsController_ensureNativeBalancesDefaultZero() {
+    const accounts = __classPrivateFieldGet(this, _AssetsController_instances, "a", _AssetsController_selectedAccounts_get);
+    if (accounts.length === 0) {
+        return;
+    }
+    this.update((state) => {
+        const balances = state.assetsBalance;
+        for (const account of accounts) {
+            const accountId = account.id;
+            const nativeAssetIds = __classPrivateFieldGet(this, _AssetsController_instances, "m", _AssetsController_getNativeAssetIdsForAccount).call(this, account);
+            if (nativeAssetIds.length === 0) {
+                continue;
+            }
+            if (!balances[accountId]) {
+                balances[accountId] = {};
+            }
+            for (const nativeAssetId of nativeAssetIds) {
+                if (!(nativeAssetId in balances[accountId])) {
+                    balances[accountId][nativeAssetId] = { amount: '0' };
+                }
+            }
+        }
+    });
+}, _AssetsController_updateState = async function _AssetsController_updateState(response) {
     const normalizedResponse = normalizeResponse(response);
     const mode = normalizedResponse.updateMode ?? 'merge';
     const releaseLock = await __classPrivateFieldGet(this, _AssetsController_controllerMutex, "f").acquire();
@@ -894,9 +934,12 @@ async function _AssetsController_updateState(response) {
                 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. Merge: response overlays previous.
-                    const effective = mode === 'full'
-                        ? (() => {
+                    // Full: response is authoritative; preserve custom assets not in response.
+                    // Merge: response overlays previous balances.
+                    // Callers that fetch partial data (e.g. newly added chains) must set updateMode: 'merge'.
+                    const effective = mode === 'merge'
+                        ? { ...previousBalances, ...accountBalances }
+                        : (() => {
                             const next = {
                                 ...accountBalances,
                             };
@@ -908,13 +951,25 @@ async function _AssetsController_updateState(response) {
                                 }
                             }
                             return next;
-                        })()
-                        : { ...previousBalances, ...accountBalances };
+                        })();
+                    // Ensure native tokens have an entry (0 if missing) for chains this account supports
+                    const account = __classPrivateFieldGet(this, _AssetsController_instances, "a", _AssetsController_selectedAccounts_get).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' };
+                        }
+                    }
                     for (const [assetId, balance] of Object.entries(effective)) {
                         const previousBalance = previousBalances[assetId];
                         const newAmount = balance.amount;
                         const oldAmount = previousBalance?.amount;
-                        if (oldAmount !== newAmount) {
+                        const isNewDefaultNativeZero = oldAmount === undefined &&
+                            newAmount === '0' &&
+                            nativeAssetIdsForAccount.includes(assetId);
+                        if (oldAmount !== newAmount && !isNewDefaultNativeZero) {
                             changedBalances.push({
                                 accountId,
                                 assetId,
@@ -1067,6 +1122,7 @@ async function _AssetsController_updateState(response) {
         enabledChainCount: __classPrivateFieldGet(this, _AssetsController_enabledChains, "f").size,
     });
     __classPrivateFieldGet(this, _AssetsController_instances, "m", _AssetsController_subscribeAssets).call(this);
+    __classPrivateFieldGet(this, _AssetsController_instances, "m", _AssetsController_ensureNativeBalancesDefaultZero).call(this);
     this.getAssets(__classPrivateFieldGet(this, _AssetsController_instances, "a", _AssetsController_selectedAccounts_get), {
         chainIds: [...__classPrivateFieldGet(this, _AssetsController_enabledChains, "f")],
         forceUpdate: true,
@@ -1274,6 +1330,7 @@ async function _AssetsController_handleAccountGroupChanged() {
             forceUpdate: true,
         });
     }
+    __classPrivateFieldGet(this, _AssetsController_instances, "m", _AssetsController_ensureNativeBalancesDefaultZero).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");
@@ -1302,12 +1359,14 @@ async function _AssetsController_handleAccountGroupChanged() {
     // The data will simply not be updated until the network is re-enabled.
     // Refresh subscriptions for new chain set
     __classPrivateFieldGet(this, _AssetsController_instances, "m", _AssetsController_subscribeAssets).call(this);
-    // Do one-time fetch for newly enabled chains
+    // Do one-time fetch for newly enabled chains; merge so we keep existing chain balances
     if (addedChains.length > 0 && __classPrivateFieldGet(this, _AssetsController_instances, "a", _AssetsController_selectedAccounts_get).length > 0) {
         await this.getAssets(__classPrivateFieldGet(this, _AssetsController_instances, "a", _AssetsController_selectedAccounts_get), {
             chainIds: addedChains,
             forceUpdate: true,
+            updateMode: 'merge',
         });
     }
+    __classPrivateFieldGet(this, _AssetsController_instances, "m", _AssetsController_ensureNativeBalancesDefaultZero).call(this);
 };
 //# sourceMappingURL=AssetsController.cjs.map