@metamask-previews/assets-controller 1.0.0-preview-1346d4756 → 1.0.0-preview-0cc7da31a

package/CHANGELOG.md

@@ -9,6 +9,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ### Added
 
+- Add `StakedBalanceDataSource` that polls supported staking contracts on enabled chains and merges staked balances into `assetsBalance`. Configurable via `stakedBalanceDataSourceConfig` (`enabled`, `pollInterval`); the controller subscribes to it when enabled and cleans up on destroy ([#7936](https://github.com/MetaMask/core/pull/7936))
 - Add optional `trackMetaMetricsEvent` callback to measure and report first init/fetch historical time (duration in ms) to MetaMetrics when the initial asset fetch completes after unlock or app open ([#7871](https://github.com/MetaMask/core/pull/7871))
 - Add `AccountsApiDataSourceConfig` and `PriceDataSourceConfig` types; add `accountsApiDataSourceConfig` and `priceDataSourceConfig` options to `AssetsControllerOptions` for per-data-source configuration (pollInterval, tokenDetectionEnabled, etc.). When `tokenDetectionEnabled` is false, `AccountsApiDataSource` only returns balances for tokens already in state and does not add new tokens ([#7926](https://github.com/MetaMask/core/pull/7926))
 - Add `useExternalService` option to `TokenDetector`, `TokenDetectionOptions`, `RpcDataSourceConfig`, and `RpcDataSourceOptions`. Token detection runs only when both `tokenDetectionEnabled` and `useExternalService` are true and stops when either is false ([#7924](https://github.com/MetaMask/core/pull/7924))

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_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;
+var _AssetsController_instances, _AssetsController_isEnabled, _AssetsController_isBasicFunctionality, _AssetsController_defaultUpdateInterval, _AssetsController_pricePollInterval, _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_constructionState, _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;
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.AssetsController = exports.getDefaultAssetsControllerState = void 0;
 const base_controller_1 = require("@metamask/base-controller");
@@ -26,6 +26,7 @@ const BackendWebsocketDataSource_1 = require("./data-sources/BackendWebsocketDat
 const PriceDataSource_1 = require("./data-sources/PriceDataSource.cjs");
 const RpcDataSource_1 = require("./data-sources/RpcDataSource.cjs");
 const SnapDataSource_1 = require("./data-sources/SnapDataSource.cjs");
+const StakedBalanceDataSource_1 = require("./data-sources/StakedBalanceDataSource.cjs");
 const TokenDataSource_1 = require("./data-sources/TokenDataSource.cjs");
 const logger_1 = require("./logger.cjs");
 const DetectionMiddleware_1 = require("./middlewares/DetectionMiddleware.cjs");
@@ -182,7 +183,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, isBasicFunctionality, subscribeToBasicFunctionalityChange, queryApiClient, rpcDataSourceConfig, trackMetaMetricsEvent, accountsApiDataSourceConfig, priceDataSourceConfig, }) {
+    constructor({ messenger, state = {}, defaultUpdateInterval = DEFAULT_POLLING_INTERVAL_MS, isEnabled = () => true, isBasicFunctionality, subscribeToBasicFunctionalityChange, queryApiClient, rpcDataSourceConfig, trackMetaMetricsEvent, accountsApiDataSourceConfig, priceDataSourceConfig, stakedBalanceDataSourceConfig, }) {
         super({
             name: CONTROLLER_NAME,
             messenger,
@@ -199,6 +200,8 @@ class AssetsController extends base_controller_1.BaseController {
         _AssetsController_isBasicFunctionality.set(this, void 0);
         /** Default update interval hint passed to data sources */
         _AssetsController_defaultUpdateInterval.set(this, void 0);
+        /** Price subscription poll interval from priceDataSourceConfig (used when subscribeAssetsPrice gets no updateInterval). */
+        _AssetsController_pricePollInterval.set(this, void 0);
         /** Optional callback for first init/fetch MetaMetrics (duration). */
         _AssetsController_trackMetaMetricsEvent.set(this, void 0);
         /** Whether we have already reported first init fetch for this session (reset on #stop). */
@@ -217,16 +220,24 @@ class AssetsController extends base_controller_1.BaseController {
         _AssetsController_accountsApiDataSource.set(this, void 0);
         _AssetsController_snapDataSource.set(this, void 0);
         _AssetsController_rpcDataSource.set(this, void 0);
+        _AssetsController_stakedBalanceDataSource.set(this, void 0);
         _AssetsController_priceDataSource.set(this, void 0);
         _AssetsController_detectionMiddleware.set(this, void 0);
         _AssetsController_tokenDataSource.set(this, void 0);
         _AssetsController_unsubscribeBasicFunctionality.set(this, null);
+        _AssetsController_constructionState.set(this, { initialized: false });
         __classPrivateFieldSet(this, _AssetsController_isEnabled, isEnabled(), "f");
         __classPrivateFieldSet(this, _AssetsController_isBasicFunctionality, isBasicFunctionality ?? (() => true), "f");
         __classPrivateFieldSet(this, _AssetsController_defaultUpdateInterval, defaultUpdateInterval, "f");
+        __classPrivateFieldSet(this, _AssetsController_pricePollInterval, priceDataSourceConfig?.pollInterval, "f");
         __classPrivateFieldSet(this, _AssetsController_trackMetaMetricsEvent, trackMetaMetricsEvent, "f");
         const rpcConfig = rpcDataSourceConfig ?? {};
-        const onActiveChainsUpdated = (dataSourceName, chains, previousChains) => this.handleActiveChainsUpdate(dataSourceName, chains, previousChains);
+        const onActiveChainsUpdated = (dataSourceName, chains, previousChains) => {
+            if (!__classPrivateFieldGet(this, _AssetsController_constructionState, "f").initialized) {
+                return;
+            }
+            this.handleActiveChainsUpdate(dataSourceName, chains, previousChains);
+        };
         __classPrivateFieldSet(this, _AssetsController_backendWebsocketDataSource, new BackendWebsocketDataSource_1.BackendWebsocketDataSource({
             messenger: this.messenger,
             queryApiClient,
@@ -246,6 +257,11 @@ class AssetsController extends base_controller_1.BaseController {
             onActiveChainsUpdated,
             ...rpcConfig,
         }), "f");
+        __classPrivateFieldSet(this, _AssetsController_stakedBalanceDataSource, new StakedBalanceDataSource_1.StakedBalanceDataSource({
+            messenger: this.messenger,
+            onActiveChainsUpdated,
+            ...stakedBalanceDataSourceConfig,
+        }), "f");
         __classPrivateFieldSet(this, _AssetsController_tokenDataSource, new TokenDataSource_1.TokenDataSource({
             queryApiClient,
         }), "f");
@@ -264,6 +280,8 @@ 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);
+        __classPrivateFieldGet(this, _AssetsController_constructionState, "f").initialized = true;
+        // Subscriptions start only on KeyringController:unlock -> #start(), not here.
         // Subscribe to basic-functionality changes after construction so a synchronous
         // onChange during subscribe cannot run before data sources are initialized.
         if (subscribeToBasicFunctionalityChange) {
@@ -290,6 +308,9 @@ class AssetsController extends base_controller_1.BaseController {
      * @param previousChains - Previous chains; used to compute added/removed.
      */
     handleActiveChainsUpdate(dataSourceId, activeChains, previousChains) {
+        if (!__classPrivateFieldGet(this, _AssetsController_isEnabled, "f")) {
+            return;
+        }
         log('Data source active chains changed', {
             dataSourceId,
             chainCount: activeChains.length,
@@ -343,11 +364,16 @@ class AssetsController extends base_controller_1.BaseController {
                     __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"),
                 ]
-                : [__classPrivateFieldGet(this, _AssetsController_rpcDataSource, "f"), __classPrivateFieldGet(this, _AssetsController_detectionMiddleware, "f")];
+                : [
+                    __classPrivateFieldGet(this, _AssetsController_rpcDataSource, "f"),
+                    __classPrivateFieldGet(this, _AssetsController_stakedBalanceDataSource, "f"),
+                    __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);
             if (__classPrivateFieldGet(this, _AssetsController_trackMetaMetricsEvent, "f") && !__classPrivateFieldGet(this, _AssetsController_firstInitFetchReported, "f")) {
@@ -527,7 +553,7 @@ class AssetsController extends base_controller_1.BaseController {
         if (!__classPrivateFieldGet(this, _AssetsController_isBasicFunctionality, "f").call(this)) {
             return;
         }
-        const { updateInterval = __classPrivateFieldGet(this, _AssetsController_defaultUpdateInterval, "f") } = options;
+        const { updateInterval = __classPrivateFieldGet(this, _AssetsController_pricePollInterval, "f") ?? __classPrivateFieldGet(this, _AssetsController_defaultUpdateInterval, "f"), } = options;
         const subscriptionKey = 'ds:PriceDataSource';
         const existingSubscription = __classPrivateFieldGet(this, _AssetsController_activeSubscriptions, "f").get(subscriptionKey);
         const isUpdate = existingSubscription !== undefined;
@@ -615,6 +641,7 @@ class AssetsController extends base_controller_1.BaseController {
         __classPrivateFieldGet(this, _AssetsController_accountsApiDataSource, "f")?.destroy?.();
         __classPrivateFieldGet(this, _AssetsController_snapDataSource, "f")?.destroy?.();
         __classPrivateFieldGet(this, _AssetsController_rpcDataSource, "f")?.destroy?.();
+        __classPrivateFieldGet(this, _AssetsController_stakedBalanceDataSource, "f")?.destroy?.();
         // Stop all active subscriptions
         __classPrivateFieldGet(this, _AssetsController_instances, "m", _AssetsController_stop).call(this);
         if (__classPrivateFieldGet(this, _AssetsController_unsubscribeBasicFunctionality, "f")) {
@@ -634,7 +661,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_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_pricePollInterval = 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_constructionState = 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 [
@@ -670,7 +697,7 @@ _AssetsController_isEnabled = new WeakMap(), _AssetsController_isBasicFunctional
     }
     return chains;
 }, _AssetsController_normalizeChainReference = function _AssetsController_normalizeChainReference(namespace, reference) {
-    if (namespace === 'eip155' && reference.startsWith('0x')) {
+    if (namespace === 'eip155' && (0, utils_1.isStrictHexString)(reference)) {
         // Convert hex to decimal for EIP155 chains
         return parseInt(reference, 16).toString();
     }
@@ -949,13 +976,17 @@ async function _AssetsController_updateState(response) {
     this.unsubscribeAssetsPrice();
     // Stop balance subscriptions by properly notifying data sources via messenger
     // 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).
+    // Use #allBalanceDataSources + staked balance source so we unsubscribe from
+    // every source that may have been subscribed.
+    const allSources = [
+        ...__classPrivateFieldGet(this, _AssetsController_instances, "a", _AssetsController_allBalanceDataSources_get),
+        __classPrivateFieldGet(this, _AssetsController_stakedBalanceDataSource, "f"),
+    ];
     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_allBalanceDataSources_get).find((ds) => ds.getName() === sourceId);
+            const source = allSources.find((ds) => ds.getName() === sourceId);
             if (source) {
                 __classPrivateFieldGet(this, _AssetsController_instances, "m", _AssetsController_unsubscribeDataSource).call(this, source);
             }
@@ -970,6 +1001,10 @@ async function _AssetsController_updateState(response) {
     __classPrivateFieldGet(this, _AssetsController_instances, "m", _AssetsController_subscribeAssetsBalance).call(this, __classPrivateFieldGet(this, _AssetsController_instances, "a", _AssetsController_selectedAccounts_get), [
         ...__classPrivateFieldGet(this, _AssetsController_enabledChains, "f"),
     ]);
+    // Subscribe to staked balance updates (separate from regular balance chain-claiming)
+    __classPrivateFieldGet(this, _AssetsController_instances, "m", _AssetsController_subscribeStakedBalance).call(this, __classPrivateFieldGet(this, _AssetsController_instances, "a", _AssetsController_selectedAccounts_get), [
+        ...__classPrivateFieldGet(this, _AssetsController_enabledChains, "f"),
+    ]);
     // Subscribe to price updates for all assets held by selected accounts
     this.subscribeAssetsPrice(__classPrivateFieldGet(this, _AssetsController_instances, "a", _AssetsController_selectedAccounts_get), [...__classPrivateFieldGet(this, _AssetsController_enabledChains, "f")]);
 }, _AssetsController_subscribeAssetsBalance = function _AssetsController_subscribeAssetsBalance(accounts, chainIds) {
@@ -1000,6 +1035,18 @@ async function _AssetsController_updateState(response) {
             __classPrivateFieldGet(this, _AssetsController_instances, "m", _AssetsController_subscribeDataSource).call(this, source, accountsForSource, assignedChains);
         }
     }
+}, _AssetsController_subscribeStakedBalance = function _AssetsController_subscribeStakedBalance(accounts, chainIds) {
+    const source = __classPrivateFieldGet(this, _AssetsController_stakedBalanceDataSource, "f");
+    if (!source) {
+        return;
+    }
+    const availableChains = new Set(source.getActiveChainsSync());
+    const assignedChains = chainIds.filter((chainId) => availableChains.has(chainId));
+    if (assignedChains.length === 0) {
+        __classPrivateFieldGet(this, _AssetsController_instances, "m", _AssetsController_unsubscribeDataSource).call(this, source);
+        return;
+    }
+    __classPrivateFieldGet(this, _AssetsController_instances, "m", _AssetsController_subscribeDataSource).call(this, source, accounts, assignedChains);
 }, _AssetsController_buildChainToAccountsMap = function _AssetsController_buildChainToAccountsMap(accounts, chainsToSubscribe) {
     const chainToAccounts = new Map();
     for (const account of accounts) {
@@ -1076,16 +1123,24 @@ async function _AssetsController_updateState(response) {
     const scopes = account.scopes ?? [];
     const result = [];
     for (const scope of scopes) {
-        const [namespace, reference] = scope.split(':');
+        const scopeStr = scope;
+        if (!(0, utils_1.isCaipChainId)(scopeStr)) {
+            result.push(scope);
+            continue;
+        }
+        const { namespace, reference } = (0, utils_1.parseCaipChainId)(scopeStr);
         // Wildcard scope (e.g., "eip155:0" means all enabled chains in that namespace)
         if (reference === '0') {
             for (const chain of __classPrivateFieldGet(this, _AssetsController_enabledChains, "f")) {
-                if (chain.startsWith(`${namespace}:`)) {
-                    result.push(chain);
+                if ((0, utils_1.isCaipChainId)(chain)) {
+                    const chainParsed = (0, utils_1.parseCaipChainId)(chain);
+                    if (chainParsed.namespace === namespace) {
+                        result.push(chain);
+                    }
                 }
             }
         }
-        else if (namespace === 'eip155' && reference?.startsWith('0x')) {
+        else if (namespace === 'eip155' && (0, utils_1.isStrictHexString)(reference)) {
             // Normalize hex to decimal for EIP155
             result.push(`eip155:${parseInt(reference, 16)}`);
         }