@metamask-previews/assets-controller 6.1.0-preview-7e80c49 → 6.1.0-preview-127523577

package/CHANGELOG.md

@@ -7,6 +7,17 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+### Added
+
+- Add `CustomAssetGraduationMiddleware` that removes an EVM asset from `customAssets[selectedAccount]` when `AccountsApiDataSource` or `BackendWebsocketDataSource` reports a balance for it ([#8582](https://github.com/MetaMask/core/pull/8582))
+  - Non-EVM custom assets (Solana, BTC, Tron) are not affected.
+  - `RpcDataSource` continues to be the sole balance fetcher for assets still in `customAssets`.
+- Add `RpcFallbackMiddleware` to the fast pipeline so chains that error in `response.errors` (network error, `unprocessedNetworks`, timeout) fall back to `RpcDataSource` ([#8582](https://github.com/MetaMask/core/pull/8582))
+  - Successful RPC results are merged into the response and recovered chains are cleared from `response.errors`.
+- Add a configurable `fetchTimeoutMs` option (default `15000`) to `AccountsApiDataSource`, `PriceDataSource`, and `TokenDataSource` ([#8582](https://github.com/MetaMask/core/pull/8582))
+  - On timeout, AccountsAPI marks every requested chain as errored so `RpcFallbackMiddleware` picks them up; price and token enrichment degrade gracefully.
+- Add `fetchWithTimeout` utility that races an async task against a timeout ([#8582](https://github.com/MetaMask/core/pull/8582))
+
 ## [6.1.0]
 
 ### Added

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_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_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_updateState, _AssetsController_getAssetsFromState, _AssetsController_shouldHideNativeToken, _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_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_updateState, _AssetsController_getAssetsFromState, _AssetsController_shouldHideNativeToken, _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");
@@ -30,9 +30,12 @@ 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 errors_1 = require("./errors.cjs");
 const logger_1 = require("./logger.cjs");
+const CustomAssetGraduationMiddleware_1 = require("./middlewares/CustomAssetGraduationMiddleware.cjs");
 const DetectionMiddleware_1 = require("./middlewares/DetectionMiddleware.cjs");
 const ParallelMiddleware_1 = require("./middlewares/ParallelMiddleware.cjs");
+const RpcFallbackMiddleware_1 = require("./middlewares/RpcFallbackMiddleware.cjs");
 const utils_2 = require("./utils/index.cjs");
 const constants_1 = require("./utils/constants.cjs");
 const NATIVE_ASSETS_QUERY_KEY = ['nativeAssets'];
@@ -212,7 +215,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, trace, accountsApiDataSourceConfig, priceDataSourceConfig, stakedBalanceDataSourceConfig, isOnboarded, }) {
+    constructor({ messenger, state = {}, defaultUpdateInterval = DEFAULT_POLLING_INTERVAL_MS, isEnabled = () => true, isBasicFunctionality, subscribeToBasicFunctionalityChange, queryApiClient, rpcDataSourceConfig, trace, captureException, accountsApiDataSourceConfig, priceDataSourceConfig, stakedBalanceDataSourceConfig, isOnboarded, }) {
         super({
             name: CONTROLLER_NAME,
             messenger,
@@ -231,6 +234,8 @@ class AssetsController extends base_controller_1.BaseController {
         _AssetsController_defaultUpdateInterval.set(this, void 0);
         /** Optional trace callback for first init/fetch measurement (duration). */
         _AssetsController_trace.set(this, void 0);
+        /** Optional reporter for Issue-style errors (e.g. Sentry.captureException). */
+        _AssetsController_captureException.set(this, void 0);
         /** Whether we have already reported first init fetch for this session (reset on #stop). */
         _AssetsController_firstInitFetchReported.set(this, false);
         /** Whether we have already reported state size for this session (reset on #stop). */
@@ -262,6 +267,8 @@ class AssetsController extends base_controller_1.BaseController {
         _AssetsController_stakedBalanceDataSource.set(this, void 0);
         _AssetsController_priceDataSource.set(this, void 0);
         _AssetsController_detectionMiddleware.set(this, void 0);
+        _AssetsController_customAssetGraduationMiddleware.set(this, void 0);
+        _AssetsController_rpcFallbackMiddleware.set(this, void 0);
         _AssetsController_tokenDataSource.set(this, void 0);
         _AssetsController_unsubscribeBasicFunctionality.set(this, null);
         _AssetsController_queryApiClient.set(this, void 0);
@@ -270,6 +277,7 @@ class AssetsController extends base_controller_1.BaseController {
         __classPrivateFieldSet(this, _AssetsController_isBasicFunctionality, isBasicFunctionality ?? (() => true), "f");
         __classPrivateFieldSet(this, _AssetsController_defaultUpdateInterval, defaultUpdateInterval, "f");
         __classPrivateFieldSet(this, _AssetsController_trace, trace, "f");
+        __classPrivateFieldSet(this, _AssetsController_captureException, captureException, "f");
         __classPrivateFieldSet(this, _AssetsController_queryApiClient, queryApiClient, "f");
         const rpcConfig = rpcDataSourceConfig ?? {};
         __classPrivateFieldGet(this, _AssetsController_instances, "m", _AssetsController_initializeNativeAssetsMap).call(this, queryApiClient);
@@ -324,6 +332,20 @@ class AssetsController extends base_controller_1.BaseController {
             ...priceDataSourceConfig,
         }), "f");
         __classPrivateFieldSet(this, _AssetsController_detectionMiddleware, new DetectionMiddleware_1.DetectionMiddleware(), "f");
+        __classPrivateFieldSet(this, _AssetsController_customAssetGraduationMiddleware, new CustomAssetGraduationMiddleware_1.CustomAssetGraduationMiddleware({
+            getSelectedAccountId: () => {
+                try {
+                    return __classPrivateFieldGet(this, _AssetsController_instances, "m", _AssetsController_getSelectedAccounts).call(this)[0]?.id;
+                }
+                catch {
+                    return undefined;
+                }
+            },
+            removeCustomAsset: (accountId, assetId) => this.removeCustomAsset(accountId, assetId),
+        }), "f");
+        __classPrivateFieldSet(this, _AssetsController_rpcFallbackMiddleware, new RpcFallbackMiddleware_1.RpcFallbackMiddleware({
+            rpcDataSource: __classPrivateFieldGet(this, _AssetsController_rpcDataSource, "f"),
+        }), "f");
         if (!__classPrivateFieldGet(this, _AssetsController_isEnabled, "f")) {
             log('AssetsController is disabled, skipping initialization');
             return;
@@ -392,6 +414,11 @@ class AssetsController extends base_controller_1.BaseController {
                         __classPrivateFieldGet(this, _AssetsController_accountsApiDataSource, "f"),
                         __classPrivateFieldGet(this, _AssetsController_stakedBalanceDataSource, "f"),
                     ]),
+                    // Graduation must run BEFORE the RPC fallback so it only sees
+                    // AccountsApi/Websocket balances. RPC intentionally carries
+                    // custom assets and must never trigger graduation.
+                    __classPrivateFieldGet(this, _AssetsController_customAssetGraduationMiddleware, "f"),
+                    __classPrivateFieldGet(this, _AssetsController_rpcFallbackMiddleware, "f"),
                     __classPrivateFieldGet(this, _AssetsController_detectionMiddleware, "f"),
                     (0, ParallelMiddleware_1.createParallelMiddleware)([
                         __classPrivateFieldGet(this, _AssetsController_tokenDataSource, "f"),
@@ -795,7 +822,17 @@ class AssetsController extends base_controller_1.BaseController {
                 ...resolvedRequest,
                 dataTypes: resolvedRequest.dataTypes.filter((dt) => dt !== 'metadata' && dt !== 'price'),
             };
-        const enrichmentSources = [__classPrivateFieldGet(this, _AssetsController_detectionMiddleware, "f")];
+        // Graduate custom assets only when AccountsAPI / Websocket reports them.
+        // RPC already fetches custom assets on purpose, and Snap handles non-EVM
+        // chains the rule does not apply to, so skip the middleware for those.
+        const shouldGraduateCustomAssets = sourceId === 'AccountsApiDataSource' ||
+            sourceId === 'BackendWebsocketDataSource';
+        const enrichmentSources = [
+            ...(shouldGraduateCustomAssets
+                ? [__classPrivateFieldGet(this, _AssetsController_customAssetGraduationMiddleware, "f")]
+                : []),
+            __classPrivateFieldGet(this, _AssetsController_detectionMiddleware, "f"),
+        ];
         if (__classPrivateFieldGet(this, _AssetsController_isBasicFunctionality, "f").call(this)) {
             enrichmentSources.push((0, ParallelMiddleware_1.createParallelMiddleware)([
                 __classPrivateFieldGet(this, _AssetsController_tokenDataSource, "f"),
@@ -850,7 +887,7 @@ class AssetsController extends base_controller_1.BaseController {
     }
 }
 exports.AssetsController = AssetsController;
-_AssetsController_isEnabled = new WeakMap(), _AssetsController_isBasicFunctionality = new WeakMap(), _AssetsController_defaultUpdateInterval = new WeakMap(), _AssetsController_trace = new WeakMap(), _AssetsController_firstInitFetchReported = new WeakMap(), _AssetsController_stateSizeReported = new WeakMap(), _AssetsController_uiOpen = new WeakMap(), _AssetsController_keyringUnlocked = new WeakMap(), _AssetsController_controllerMutex = new WeakMap(), _AssetsController_activeSubscriptions = new WeakMap(), _AssetsController_enabledChains = new WeakMap(), _AssetsController_lastKnownAccountIds = 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_queryApiClient = new WeakMap(), _AssetsController_onActiveChainsUpdated = new WeakMap(), _AssetsController_instances = new WeakSet(), _AssetsController_emitTrace = function _AssetsController_emitTrace(name, data, tags = {
+_AssetsController_isEnabled = new WeakMap(), _AssetsController_isBasicFunctionality = new WeakMap(), _AssetsController_defaultUpdateInterval = new WeakMap(), _AssetsController_trace = new WeakMap(), _AssetsController_captureException = new WeakMap(), _AssetsController_firstInitFetchReported = new WeakMap(), _AssetsController_stateSizeReported = new WeakMap(), _AssetsController_uiOpen = new WeakMap(), _AssetsController_keyringUnlocked = new WeakMap(), _AssetsController_controllerMutex = new WeakMap(), _AssetsController_activeSubscriptions = new WeakMap(), _AssetsController_enabledChains = new WeakMap(), _AssetsController_lastKnownAccountIds = 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_customAssetGraduationMiddleware = new WeakMap(), _AssetsController_rpcFallbackMiddleware = new WeakMap(), _AssetsController_tokenDataSource = new WeakMap(), _AssetsController_unsubscribeBasicFunctionality = new WeakMap(), _AssetsController_queryApiClient = new WeakMap(), _AssetsController_onActiveChainsUpdated = new WeakMap(), _AssetsController_instances = new WeakSet(), _AssetsController_emitTrace = function _AssetsController_emitTrace(name, data, tags = {
     controller: 'AssetsController',
 }) {
     if (!__classPrivateFieldGet(this, _AssetsController_trace, "f")) {
@@ -1160,12 +1197,28 @@ async function _AssetsController_executeMiddlewares(sources, request, initialRes
             account_count: request.accountsWithSupportedChains.length,
         });
     }
-    // Emit error traces for failed middlewares
+    // Failed middlewares: Issues (optional) + perf/Dashboard spans
     if (middlewareErrors.length > 0) {
+        const failedSources = middlewareErrors.join(',');
+        const assetsError = new errors_1.AssetsDataSourceError({
+            failedSources,
+            errorCount: middlewareErrors.length,
+            chainCount: request.chainIds.length,
+        });
+        try {
+            __classPrivateFieldGet(this, _AssetsController_captureException, "f")?.call(this, assetsError);
+        }
+        catch {
+            // Never let telemetry throw.
+        }
         __classPrivateFieldGet(this, _AssetsController_instances, "m", _AssetsController_emitTrace).call(this, TRACE_DATA_SOURCE_ERROR, {
-            failed_sources: middlewareErrors.join(','),
+            failed_sources: failedSources,
             error_count: middlewareErrors.length,
             chain_count: request.chainIds.length,
+        }, {
+            controller: 'AssetsController',
+            severity: 'error',
+            error_type: assetsError.name,
         });
     }
     return { response: result.response, durationByDataSource };