@metamask-previews/assets-controller 2.0.2-preview-32ed9958c → 2.0.2-preview-d1f62d044

package/CHANGELOG.md

@@ -7,6 +7,12 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+### Added
+
+- Add parallel middlewares in `ParallelMiddleware.ts`: `createParallelBalanceMiddleware` runs balance data sources (Accounts API, Snap, RPC) in parallel with chain partitioning and a fallback round for failed chains; `createParallelMiddleware` runs TokenDataSource and PriceDataSource in parallel (same request, merged response). Both use `mergeDataResponses` and limited concurrency via `p-limit` ([#7950](https://github.com/MetaMask/core/pull/7950))
+- Add `@metamask/client-controller` dependency and subscribe to `ClientController:stateChange`. Asset tracking runs only when the UI is open (ClientController) and the keyring is unlocked (KeyringController), and stops when either the UI closes or the keyring locks (Client + Keyring lifecycle) ([#7950](https://github.com/MetaMask/core/pull/7950))
+- Add full and merge update modes: `DataResponse.updateMode` and type `AssetsUpdateMode` (`'full'` | `'merge'`). Fetch uses `'full'` (response is authoritative for scope; custom assets not in response are preserved). Subscriptions could use `'merge'` or `'full'` depending on data sources. Default is `'merge'` when omitted ([#7950](https://github.com/MetaMask/core/pull/7950))
+
 ### Changed
 
 - Bump `@metamask/transaction-controller` from `^62.17.1` to `^62.18.0` ([#8005](https://github.com/MetaMask/core/pull/8005))

package/dist/AssetsController.cjs

@@ -13,10 +13,11 @@ 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_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_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_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");
+const client_controller_1 = require("@metamask/client-controller");
 const utils_1 = require("@metamask/utils");
 const async_mutex_1 = require("async-mutex");
 const bignumber_js_1 = __importDefault(require("bignumber.js"));
@@ -30,6 +31,7 @@ const StakedBalanceDataSource_1 = require("./data-sources/StakedBalanceDataSourc
 const TokenDataSource_1 = require("./data-sources/TokenDataSource.cjs");
 const logger_1 = require("./logger.cjs");
 const DetectionMiddleware_1 = require("./middlewares/DetectionMiddleware.cjs");
+const ParallelMiddleware_1 = require("./middlewares/ParallelMiddleware.cjs");
 const utils_2 = require("./utils.cjs");
 // ============================================================================
 // CONTROLLER CONSTANTS
@@ -152,6 +154,9 @@ function normalizeResponse(response) {
     if (response.errors) {
         normalized.errors = { ...response.errors };
     }
+    if (response.updateMode) {
+        normalized.updateMode = response.updateMode;
+    }
     return normalized;
 }
 // ============================================================================
@@ -173,8 +178,10 @@ function normalizeResponse(response) {
  *    based on which chains they support. When active chains change, the controller
  *    dynamically adjusts subscriptions.
  *
- * 4. **Keyring Lifecycle**: Listens to KeyringController unlock/lock events to
- *    start/stop subscriptions when the wallet is unlocked or locked.
+ * 4. **Client + Keyring Lifecycle**: Starts subscriptions only when both the UI is
+ *    open (ClientController) and the wallet is unlocked (KeyringController).
+ *    Stops when either the UI closes or the keyring locks. See client-controller
+ *    README for the combined pattern.
  *
  * ## Architecture
  *
@@ -204,6 +211,10 @@ class AssetsController extends base_controller_1.BaseController {
         _AssetsController_trackMetaMetricsEvent.set(this, void 0);
         /** Whether we have already reported first init fetch for this session (reset on #stop). */
         _AssetsController_firstInitFetchReported.set(this, false);
+        /** Whether the client (UI) is open. Combined with #keyringUnlocked for #updateActive. */
+        _AssetsController_uiOpen.set(this, false);
+        /** Whether the keyring is unlocked. Combined with #uiOpen for #updateActive. */
+        _AssetsController_keyringUnlocked.set(this, false);
         _AssetsController_controllerMutex.set(this, new async_mutex_1.Mutex());
         /**
          * Active balance subscriptions keyed by account ID.
@@ -273,7 +284,7 @@ class AssetsController extends base_controller_1.BaseController {
         __classPrivateFieldGet(this, _AssetsController_instances, "m", _AssetsController_initializeState).call(this);
         __classPrivateFieldGet(this, _AssetsController_instances, "m", _AssetsController_subscribeToEvents).call(this);
         __classPrivateFieldGet(this, _AssetsController_instances, "m", _AssetsController_registerActionHandlers).call(this);
-        // Subscriptions start only on KeyringController:unlock -> #start(), not here.
+        // Subscriptions start only when both UI is open and keyring unlocked -> #updateActive().
         // Subscribe to basic-functionality changes after construction so a synchronous
         // onChange during subscribe cannot run before data sources are initialized.
         if (subscribeToBasicFunctionalityChange) {
@@ -337,6 +348,9 @@ class AssetsController extends base_controller_1.BaseController {
         const chainIds = options?.chainIds ?? [...__classPrivateFieldGet(this, _AssetsController_enabledChains, "f")];
         const assetTypes = options?.assetTypes ?? ['fungible'];
         const dataTypes = options?.dataTypes ?? ['balance', 'metadata', 'price'];
+        if (accounts.length === 0 || chainIds.length === 0) {
+            return __classPrivateFieldGet(this, _AssetsController_instances, "m", _AssetsController_getAssetsFromState).call(this, accounts, chainIds, assetTypes);
+        }
         // Collect custom assets for all requested accounts
         const customAssets = [];
         for (const account of accounts) {
@@ -353,13 +367,17 @@ class AssetsController extends base_controller_1.BaseController {
             });
             const sources = __classPrivateFieldGet(this, _AssetsController_isBasicFunctionality, "f").call(this)
                 ? [
-                    __classPrivateFieldGet(this, _AssetsController_accountsApiDataSource, "f"),
-                    __classPrivateFieldGet(this, _AssetsController_snapDataSource, "f"),
-                    __classPrivateFieldGet(this, _AssetsController_rpcDataSource, "f"),
-                    __classPrivateFieldGet(this, _AssetsController_stakedBalanceDataSource, "f"),
+                    (0, ParallelMiddleware_1.createParallelBalanceMiddleware)([
+                        __classPrivateFieldGet(this, _AssetsController_accountsApiDataSource, "f"),
+                        __classPrivateFieldGet(this, _AssetsController_snapDataSource, "f"),
+                        __classPrivateFieldGet(this, _AssetsController_rpcDataSource, "f"),
+                        __classPrivateFieldGet(this, _AssetsController_stakedBalanceDataSource, "f"),
+                    ]),
                     __classPrivateFieldGet(this, _AssetsController_detectionMiddleware, "f"),
-                    __classPrivateFieldGet(this, _AssetsController_tokenDataSource, "f"),
-                    __classPrivateFieldGet(this, _AssetsController_priceDataSource, "f"),
+                    (0, ParallelMiddleware_1.createParallelMiddleware)([
+                        __classPrivateFieldGet(this, _AssetsController_tokenDataSource, "f"),
+                        __classPrivateFieldGet(this, _AssetsController_priceDataSource, "f"),
+                    ]),
                 ]
                 : [
                     __classPrivateFieldGet(this, _AssetsController_rpcDataSource, "f"),
@@ -367,7 +385,7 @@ 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);
+            await __classPrivateFieldGet(this, _AssetsController_instances, "m", _AssetsController_updateState).call(this, { ...response, updateMode: 'full' });
             if (__classPrivateFieldGet(this, _AssetsController_trackMetaMetricsEvent, "f") && !__classPrivateFieldGet(this, _AssetsController_firstInitFetchReported, "f")) {
                 __classPrivateFieldSet(this, _AssetsController_firstInitFetchReported, true, "f");
                 const durationMs = Date.now() - startTime;
@@ -607,9 +625,15 @@ class AssetsController extends base_controller_1.BaseController {
             hasBalance: Boolean(response.assetsBalance),
             hasPrice: Boolean(response.assetsPrice),
         });
-        // Run through enrichment middlewares (Event Stack: Detection → Token → Price)
+        // Run through enrichment middlewares (Detection, then Token + Price in parallel)
         // Include 'metadata' in dataTypes so TokenDataSource runs to enrich detected assets
-        const { response: enrichedResponse } = await __classPrivateFieldGet(this, _AssetsController_instances, "m", _AssetsController_executeMiddlewares).call(this, [__classPrivateFieldGet(this, _AssetsController_detectionMiddleware, "f"), __classPrivateFieldGet(this, _AssetsController_tokenDataSource, "f"), __classPrivateFieldGet(this, _AssetsController_priceDataSource, "f")], request ?? {
+        const { response: enrichedResponse } = await __classPrivateFieldGet(this, _AssetsController_instances, "m", _AssetsController_executeMiddlewares).call(this, [
+            __classPrivateFieldGet(this, _AssetsController_detectionMiddleware, "f"),
+            (0, ParallelMiddleware_1.createParallelMiddleware)([
+                __classPrivateFieldGet(this, _AssetsController_tokenDataSource, "f"),
+                __classPrivateFieldGet(this, _AssetsController_priceDataSource, "f"),
+            ]),
+        ], request ?? {
             accountsWithSupportedChains: [],
             chainIds: [],
             dataTypes: ['balance', 'metadata', 'price'],
@@ -649,7 +673,7 @@ class AssetsController extends base_controller_1.BaseController {
     }
 }
 exports.AssetsController = AssetsController;
-_AssetsController_isEnabled = new WeakMap(), _AssetsController_isBasicFunctionality = new WeakMap(), _AssetsController_defaultUpdateInterval = new WeakMap(), _AssetsController_trackMetaMetricsEvent = new WeakMap(), _AssetsController_firstInitFetchReported = new WeakMap(), _AssetsController_controllerMutex = new WeakMap(), _AssetsController_activeSubscriptions = new WeakMap(), _AssetsController_enabledChains = 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_tokenDataSource = new WeakMap(), _AssetsController_unsubscribeBasicFunctionality = new WeakMap(), _AssetsController_instances = new WeakSet(), _AssetsController_selectedAccounts_get = function _AssetsController_selectedAccounts_get() {
+_AssetsController_isEnabled = new WeakMap(), _AssetsController_isBasicFunctionality = new WeakMap(), _AssetsController_defaultUpdateInterval = new WeakMap(), _AssetsController_trackMetaMetricsEvent = new WeakMap(), _AssetsController_firstInitFetchReported = new WeakMap(), _AssetsController_uiOpen = new WeakMap(), _AssetsController_keyringUnlocked = new WeakMap(), _AssetsController_controllerMutex = new WeakMap(), _AssetsController_activeSubscriptions = new WeakMap(), _AssetsController_enabledChains = 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_tokenDataSource = new WeakMap(), _AssetsController_unsubscribeBasicFunctionality = new WeakMap(), _AssetsController_instances = new WeakSet(), _AssetsController_selectedAccounts_get = function _AssetsController_selectedAccounts_get() {
     return this.messenger.call('AccountTreeController:getAccountsFromSelectedAccountGroup');
 }, _AssetsController_allBalanceDataSources_get = function _AssetsController_allBalanceDataSources_get() {
     return [
@@ -699,9 +723,27 @@ _AssetsController_isEnabled = new WeakMap(), _AssetsController_isBasicFunctional
     this.messenger.subscribe('NetworkEnablementController:stateChange', ({ enabledNetworkMap }) => {
         __classPrivateFieldGet(this, _AssetsController_instances, "m", _AssetsController_handleEnabledNetworksChanged).call(this, enabledNetworkMap).catch(console.error);
     });
-    // Keyring lifecycle: start when unlocked, stop when locked
-    this.messenger.subscribe('KeyringController:unlock', () => __classPrivateFieldGet(this, _AssetsController_instances, "m", _AssetsController_start).call(this));
-    this.messenger.subscribe('KeyringController:lock', () => __classPrivateFieldGet(this, _AssetsController_instances, "m", _AssetsController_stop).call(this));
+    // Client + Keyring lifecycle: only run when UI is open AND keyring is unlocked
+    this.messenger.subscribe('ClientController:stateChange', (isUiOpen) => {
+        __classPrivateFieldSet(this, _AssetsController_uiOpen, isUiOpen, "f");
+        __classPrivateFieldGet(this, _AssetsController_instances, "m", _AssetsController_updateActive).call(this);
+    }, client_controller_1.clientControllerSelectors.selectIsUiOpen);
+    this.messenger.subscribe('KeyringController:unlock', () => {
+        __classPrivateFieldSet(this, _AssetsController_keyringUnlocked, true, "f");
+        __classPrivateFieldGet(this, _AssetsController_instances, "m", _AssetsController_updateActive).call(this);
+    });
+    this.messenger.subscribe('KeyringController:lock', () => {
+        __classPrivateFieldSet(this, _AssetsController_keyringUnlocked, false, "f");
+        __classPrivateFieldGet(this, _AssetsController_instances, "m", _AssetsController_updateActive).call(this);
+    });
+}, _AssetsController_updateActive = function _AssetsController_updateActive() {
+    const shouldRun = __classPrivateFieldGet(this, _AssetsController_uiOpen, "f") && __classPrivateFieldGet(this, _AssetsController_keyringUnlocked, "f");
+    if (shouldRun) {
+        __classPrivateFieldGet(this, _AssetsController_instances, "m", _AssetsController_start).call(this);
+    }
+    else {
+        __classPrivateFieldGet(this, _AssetsController_instances, "m", _AssetsController_stop).call(this);
+    }
 }, _AssetsController_registerActionHandlers = function _AssetsController_registerActionHandlers() {
     this.messenger.registerMethodActionHandlers(this, MESSENGER_EXPOSED_METHODS);
 }, _AssetsController_executeMiddlewares = 
@@ -759,8 +801,8 @@ async function _AssetsController_executeMiddlewares(sources, request, initialRes
 // STATE MANAGEMENT
 // ============================================================================
 async function _AssetsController_updateState(response) {
-    // Normalize asset IDs (checksum EVM addresses) before storing in state
     const normalizedResponse = normalizeResponse(response);
+    const mode = normalizedResponse.updateMode ?? 'merge';
     const releaseLock = await __classPrivateFieldGet(this, _AssetsController_controllerMutex, "f").acquire();
     try {
         const previousState = this.state;
@@ -786,15 +828,27 @@ async function _AssetsController_updateState(response) {
             if (normalizedResponse.assetsBalance) {
                 for (const [accountId, accountBalances] of Object.entries(normalizedResponse.assetsBalance)) {
                     const previousBalances = previousState.assetsBalance[accountId] ?? {};
-                    if (!balances[accountId]) {
-                        balances[accountId] = {};
-                    }
-                    for (const [assetId, balance] of Object.entries(accountBalances)) {
+                    const customAssetIds = state.customAssets[accountId] ?? [];
+                    // Full: response is authoritative; preserve custom assets not in response. Merge: response overlays previous.
+                    const effective = mode === 'full'
+                        ? (() => {
+                            const next = {
+                                ...accountBalances,
+                            };
+                            for (const customId of customAssetIds) {
+                                if (!(customId in next)) {
+                                    const prev = previousBalances[customId];
+                                    next[customId] =
+                                        prev ?? { amount: '0' };
+                                }
+                            }
+                            return next;
+                        })()
+                        : { ...previousBalances, ...accountBalances };
+                    for (const [assetId, balance] of Object.entries(effective)) {
                         const previousBalance = previousBalances[assetId];
-                        const balanceData = balance;
-                        const newAmount = balanceData.amount;
+                        const newAmount = balance.amount;
                         const oldAmount = previousBalance?.amount;
-                        // Track if balance actually changed
                         if (oldAmount !== newAmount) {
                             changedBalances.push({
                                 accountId,
@@ -804,7 +858,7 @@ async function _AssetsController_updateState(response) {
                             });
                         }
                     }
-                    Object.assign(balances[accountId], accountBalances);
+                    balances[accountId] = effective;
                 }
             }
             // Update prices in state
@@ -982,7 +1036,7 @@ async function _AssetsController_updateState(response) {
     }
     __classPrivateFieldGet(this, _AssetsController_activeSubscriptions, "f").clear();
 }, _AssetsController_subscribeAssets = function _AssetsController_subscribeAssets() {
-    if (__classPrivateFieldGet(this, _AssetsController_instances, "a", _AssetsController_selectedAccounts_get).length === 0) {
+    if (__classPrivateFieldGet(this, _AssetsController_instances, "a", _AssetsController_selectedAccounts_get).length === 0 || __classPrivateFieldGet(this, _AssetsController_enabledChains, "f").size === 0) {
         return;
     }
     // Subscribe to balance updates (batched by data source)