@metamask-previews/assets-controller 1.0.0-preview-b271ae9 → 1.0.0-preview-1a74d12

package/CHANGELOG.md

@@ -7,6 +7,10 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+### Added
+
+- Add basic functionality toggle: `isBasicFunctionality` (getter `() => boolean`); no value is stored in the controller. When the getter returns true (matches UI "Basic functionality" ON), token and price APIs are used; when false, only RPC is used. Optional `subscribeToBasicFunctionalityChange(onChange)` lets the consumer register for toggle changes (e.g. extension subscribes to PreferencesController:stateChange, mobile uses its own mechanism); may return an unsubscribe function for controller destroy ([#7904](https://github.com/MetaMask/core/pull/7904))
+
 ### Changed
 
 - **BREAKING:** Rename state and `DataResponse` property from `assetsMetadata` to `assetsInfo`. Update consumers that read `state.assetsMetadata` or set `response.assetsMetadata` to use `assetsInfo` instead ([#7902](https://github.com/MetaMask/core/pull/7902))

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_defaultUpdateInterval, _AssetsController_controllerMutex, _AssetsController_activeSubscriptions, _AssetsController_enabledChains, _AssetsController_selectedAccounts_get, _AssetsController_backendWebsocketDataSource, _AssetsController_accountsApiDataSource, _AssetsController_snapDataSource, _AssetsController_rpcDataSource, _AssetsController_subscriptionBalanceDataSources_get, _AssetsController_priceDataSource, _AssetsController_detectionMiddleware, _AssetsController_tokenDataSource, _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_buildChainToAccountsMap, _AssetsController_subscribeDataSource, _AssetsController_unsubscribeDataSource, _AssetsController_buildDataRequest, _AssetsController_getEnabledChainsForAccount, _AssetsController_handleAccountGroupChanged, _AssetsController_handleEnabledNetworksChanged;
+var _AssetsController_instances, _AssetsController_isEnabled, _AssetsController_isBasicFunctionality, _AssetsController_defaultUpdateInterval, _AssetsController_controllerMutex, _AssetsController_activeSubscriptions, _AssetsController_enabledChains, _AssetsController_selectedAccounts_get, _AssetsController_backendWebsocketDataSource, _AssetsController_accountsApiDataSource, _AssetsController_snapDataSource, _AssetsController_rpcDataSource, _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_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");
@@ -182,7 +182,7 @@ function normalizeResponse(response) {
  * - The controller does NOT manage polling - it simply receives pushed updates
  */
 class AssetsController extends base_controller_1.BaseController {
-    constructor({ messenger, state = {}, defaultUpdateInterval = DEFAULT_POLLING_INTERVAL_MS, isEnabled = () => true, queryApiClient, rpcDataSourceConfig, }) {
+    constructor({ messenger, state = {}, defaultUpdateInterval = DEFAULT_POLLING_INTERVAL_MS, isEnabled = () => true, isBasicFunctionality, subscribeToBasicFunctionalityChange, queryApiClient, rpcDataSourceConfig, }) {
         super({
             name: CONTROLLER_NAME,
             messenger,
@@ -195,6 +195,8 @@ class AssetsController extends base_controller_1.BaseController {
         _AssetsController_instances.add(this);
         /** Whether the controller is enabled */
         _AssetsController_isEnabled.set(this, void 0);
+        /** Getter for basic functionality (only balance fetch/subscribe use RPC; token/price API not used). No attribute stored. */
+        _AssetsController_isBasicFunctionality.set(this, void 0);
         /** Default update interval hint passed to data sources */
         _AssetsController_defaultUpdateInterval.set(this, void 0);
         _AssetsController_controllerMutex.set(this, new async_mutex_1.Mutex());
@@ -214,7 +216,9 @@ class AssetsController extends base_controller_1.BaseController {
         _AssetsController_priceDataSource.set(this, void 0);
         _AssetsController_detectionMiddleware.set(this, void 0);
         _AssetsController_tokenDataSource.set(this, void 0);
+        _AssetsController_unsubscribeBasicFunctionality.set(this, null);
         __classPrivateFieldSet(this, _AssetsController_isEnabled, isEnabled(), "f");
+        __classPrivateFieldSet(this, _AssetsController_isBasicFunctionality, isBasicFunctionality ?? (() => true), "f");
         __classPrivateFieldSet(this, _AssetsController_defaultUpdateInterval, defaultUpdateInterval, "f");
         const rpcConfig = rpcDataSourceConfig ?? {};
         const onActiveChainsUpdated = (dataSourceName, chains, previousChains) => this.handleActiveChainsUpdate(dataSourceName, chains, previousChains);
@@ -253,6 +257,14 @@ 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);
+        // Subscribe to basic-functionality changes after construction so a synchronous
+        // onChange during subscribe cannot run before data sources are initialized.
+        if (subscribeToBasicFunctionalityChange) {
+            const unsubscribe = subscribeToBasicFunctionalityChange((isBasic) => this.handleBasicFunctionalityChange(isBasic));
+            if (typeof unsubscribe === 'function') {
+                __classPrivateFieldSet(this, _AssetsController_unsubscribeBasicFunctionality, unsubscribe, "f");
+            }
+        }
     }
     // ============================================================================
     // DATA SOURCE CHAIN MANAGEMENT
@@ -318,14 +330,20 @@ class AssetsController extends base_controller_1.BaseController {
                 customAssets: customAssets.length > 0 ? customAssets : undefined,
                 forceUpdate: true,
             });
-            const response = await __classPrivateFieldGet(this, _AssetsController_instances, "m", _AssetsController_executeMiddlewares).call(this, [
-                __classPrivateFieldGet(this, _AssetsController_accountsApiDataSource, "f").assetsMiddleware,
-                __classPrivateFieldGet(this, _AssetsController_snapDataSource, "f").assetsMiddleware,
-                __classPrivateFieldGet(this, _AssetsController_rpcDataSource, "f").assetsMiddleware,
-                __classPrivateFieldGet(this, _AssetsController_detectionMiddleware, "f").assetsMiddleware,
-                __classPrivateFieldGet(this, _AssetsController_tokenDataSource, "f").assetsMiddleware,
-                __classPrivateFieldGet(this, _AssetsController_priceDataSource, "f").assetsMiddleware,
-            ], request);
+            const middlewares = __classPrivateFieldGet(this, _AssetsController_isBasicFunctionality, "f").call(this)
+                ? [
+                    __classPrivateFieldGet(this, _AssetsController_accountsApiDataSource, "f").assetsMiddleware,
+                    __classPrivateFieldGet(this, _AssetsController_snapDataSource, "f").assetsMiddleware,
+                    __classPrivateFieldGet(this, _AssetsController_rpcDataSource, "f").assetsMiddleware,
+                    __classPrivateFieldGet(this, _AssetsController_detectionMiddleware, "f").assetsMiddleware,
+                    __classPrivateFieldGet(this, _AssetsController_tokenDataSource, "f").assetsMiddleware,
+                    __classPrivateFieldGet(this, _AssetsController_priceDataSource, "f").assetsMiddleware,
+                ]
+                : [
+                    __classPrivateFieldGet(this, _AssetsController_rpcDataSource, "f").assetsMiddleware,
+                    __classPrivateFieldGet(this, _AssetsController_detectionMiddleware, "f").assetsMiddleware,
+                ];
+            const response = await __classPrivateFieldGet(this, _AssetsController_instances, "m", _AssetsController_executeMiddlewares).call(this, middlewares, request);
             await __classPrivateFieldGet(this, _AssetsController_instances, "m", _AssetsController_updateState).call(this, response);
         }
         return __classPrivateFieldGet(this, _AssetsController_instances, "m", _AssetsController_getAssetsFromState).call(this, accounts, chainIds, assetTypes);
@@ -492,6 +510,9 @@ class AssetsController extends base_controller_1.BaseController {
      * @param options.updateInterval - Polling interval in ms.
      */
     subscribeAssetsPrice(accounts, chainIds, options = {}) {
+        if (!__classPrivateFieldGet(this, _AssetsController_isBasicFunctionality, "f").call(this)) {
+            return;
+        }
         const { updateInterval = __classPrivateFieldGet(this, _AssetsController_defaultUpdateInterval, "f") } = options;
         const subscriptionKey = 'ds:PriceDataSource';
         const existingSubscription = __classPrivateFieldGet(this, _AssetsController_activeSubscriptions, "f").get(subscriptionKey);
@@ -531,6 +552,18 @@ class AssetsController extends base_controller_1.BaseController {
         __classPrivateFieldGet(this, _AssetsController_priceDataSource, "f").unsubscribe(subscriptionKey).catch(console.error);
         existingSubscription.unsubscribe();
     }
+    /**
+     * Handle basic functionality toggle change. Call this from the consumer (extension or mobile)
+     * when the user changes the "Basic functionality" setting. Refreshes subscriptions so the
+     * current {@link AssetsControllerOptions.isBasicFunctionality} getter is used (true = APIs on,
+     * false = RPC only).
+     *
+     * @param _isBasic - The new value (for call-site clarity; the getter is the source of truth).
+     */
+    handleBasicFunctionalityChange(_isBasic) {
+        __classPrivateFieldGet(this, _AssetsController_instances, "m", _AssetsController_stop).call(this);
+        __classPrivateFieldGet(this, _AssetsController_instances, "m", _AssetsController_subscribeAssets).call(this);
+    }
     /**
      * Handle assets updated from a data source.
      * Called via the onAssetsUpdate callback passed in SubscriptionRequest when the controller subscribes to a data source.
@@ -564,21 +597,20 @@ class AssetsController extends base_controller_1.BaseController {
     // ============================================================================
     destroy() {
         log('Destroying AssetsController', {
-            dataSourceCount: __classPrivateFieldGet(this, _AssetsController_instances, "a", _AssetsController_subscriptionBalanceDataSources_get).length,
+            dataSourceCount: __classPrivateFieldGet(this, _AssetsController_instances, "a", _AssetsController_allBalanceDataSources_get).length,
             subscriptionCount: __classPrivateFieldGet(this, _AssetsController_activeSubscriptions, "f").size,
         });
         // Destroy instantiated data sources
         __classPrivateFieldGet(this, _AssetsController_backendWebsocketDataSource, "f")?.destroy?.();
         __classPrivateFieldGet(this, _AssetsController_accountsApiDataSource, "f")?.destroy?.();
         __classPrivateFieldGet(this, _AssetsController_snapDataSource, "f")?.destroy?.();
-        if (__classPrivateFieldGet(this, _AssetsController_rpcDataSource, "f") &&
-            'destroy' in __classPrivateFieldGet(this, _AssetsController_rpcDataSource, "f") &&
-            typeof __classPrivateFieldGet(this, _AssetsController_rpcDataSource, "f").destroy ===
-                'function') {
-            __classPrivateFieldGet(this, _AssetsController_rpcDataSource, "f").destroy();
-        }
+        __classPrivateFieldGet(this, _AssetsController_rpcDataSource, "f")?.destroy?.();
         // Stop all active subscriptions
         __classPrivateFieldGet(this, _AssetsController_instances, "m", _AssetsController_stop).call(this);
+        if (__classPrivateFieldGet(this, _AssetsController_unsubscribeBasicFunctionality, "f")) {
+            __classPrivateFieldGet(this, _AssetsController_unsubscribeBasicFunctionality, "f").call(this);
+            __classPrivateFieldSet(this, _AssetsController_unsubscribeBasicFunctionality, null, "f");
+        }
         // Unregister action handlers
         this.messenger.unregisterActionHandler('AssetsController:getAssets');
         this.messenger.unregisterActionHandler('AssetsController:getAssetsBalance');
@@ -592,9 +624,9 @@ class AssetsController extends base_controller_1.BaseController {
     }
 }
 exports.AssetsController = AssetsController;
-_AssetsController_isEnabled = new WeakMap(), _AssetsController_defaultUpdateInterval = 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_priceDataSource = new WeakMap(), _AssetsController_detectionMiddleware = new WeakMap(), _AssetsController_tokenDataSource = 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_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_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_subscriptionBalanceDataSources_get = function _AssetsController_subscriptionBalanceDataSources_get() {
+}, _AssetsController_allBalanceDataSources_get = function _AssetsController_allBalanceDataSources_get() {
     return [
         __classPrivateFieldGet(this, _AssetsController_backendWebsocketDataSource, "f"),
         __classPrivateFieldGet(this, _AssetsController_accountsApiDataSource, "f"),
@@ -885,13 +917,14 @@ async function _AssetsController_updateState(response) {
     // Stop price subscription first (uses direct messenger call)
     this.unsubscribeAssetsPrice();
     // Stop balance subscriptions by properly notifying data sources via messenger
-    // This ensures data sources stop their polling timers
-    // Convert to array first to avoid modifying map during iteration
+    // This ensures data sources stop their polling timers.
+    // Use #allBalanceDataSources so we unsubscribe from every source that may have
+    // been subscribed (e.g. when switching from full to basic functionality).
     const subscriptionKeys = [...__classPrivateFieldGet(this, _AssetsController_activeSubscriptions, "f").keys()];
     for (const subscriptionKey of subscriptionKeys) {
         if (subscriptionKey.startsWith('ds:')) {
             const sourceId = subscriptionKey.slice(3);
-            const source = __classPrivateFieldGet(this, _AssetsController_instances, "a", _AssetsController_subscriptionBalanceDataSources_get).find((ds) => ds.getName() === sourceId);
+            const source = __classPrivateFieldGet(this, _AssetsController_instances, "a", _AssetsController_allBalanceDataSources_get).find((ds) => ds.getName() === sourceId);
             if (source) {
                 __classPrivateFieldGet(this, _AssetsController_instances, "m", _AssetsController_unsubscribeDataSource).call(this, source);
             }
@@ -911,7 +944,11 @@ async function _AssetsController_updateState(response) {
 }, _AssetsController_subscribeAssetsBalance = function _AssetsController_subscribeAssetsBalance(accounts, chainIds) {
     const chainToAccounts = __classPrivateFieldGet(this, _AssetsController_instances, "m", _AssetsController_buildChainToAccountsMap).call(this, accounts, new Set(chainIds));
     const remainingChains = new Set(chainToAccounts.keys());
-    for (const source of __classPrivateFieldGet(this, _AssetsController_instances, "a", _AssetsController_subscriptionBalanceDataSources_get)) {
+    // When basic functionality is on (getter true), use all balance data sources; when off (getter false), RPC only.
+    const balanceDataSources = __classPrivateFieldGet(this, _AssetsController_isBasicFunctionality, "f").call(this)
+        ? __classPrivateFieldGet(this, _AssetsController_instances, "a", _AssetsController_allBalanceDataSources_get)
+        : [__classPrivateFieldGet(this, _AssetsController_rpcDataSource, "f")];
+    for (const source of balanceDataSources) {
         const availableChains = new Set(source.getActiveChainsSync());
         const assignedChains = [];
         for (const chainId of remainingChains) {