@metamask-previews/assets-controller 6.0.0-preview-5e99f980f → 6.0.0-preview-42c8fd288

package/CHANGELOG.md

@@ -7,6 +7,10 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+### Added
+
+- Add `isNativeAsset` utility that centralizes native asset detection across all CAIP-19 representations (`slip44:` namespace, known native asset IDs from `SPOT_PRICES_SUPPORT_INFO`, and `erc20:` with zero address) ([#8483](https://github.com/MetaMask/core/pull/8483))
+
 ### Changed
 
 - Bump `@metamask/assets-controllers` from `^104.0.0` to `^104.1.0` ([#8509](https://github.com/MetaMask/core/pull/8509))
@@ -15,6 +19,12 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - Bump `@metamask/keyring-snap-client` from `^8.2.0` to `^9.0.1` ([#8464](https://github.com/MetaMask/core/pull/8464))
 - Bump `@metamask/transaction-controller` from `^64.2.0` to `^64.3.0` ([#8482](https://github.com/MetaMask/core/pull/8482))
 
+### Fixed
+
+- Native asset detection now correctly identifies native assets across all CAIP-19 representations, not just `slip44:` namespace checks ([#TBD](https://github.com/MetaMask/core/pull/TBD))
+  - Previously, native assets represented as ERC-20 tokens (e.g., Polygon's POL at `0x…1010`) were not recognized as native, causing incorrect token type classification, balance handling, and missing entries in bridge exchange rates and transaction pay legacy formats.
+- Legacy format conversions (bridge exchange rates and transaction pay) now use the correct chain-specific native token address via `getNativeTokenAddress()` instead of always using the zero address ([#TBD](https://github.com/MetaMask/core/pull/TBD))
+
 ## [6.0.0]
 
 ### Added

package/dist/AssetsController.cjs

@@ -13,9 +13,10 @@ 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_onActiveChainsUpdated, _AssetsController_initializeState, _AssetsController_extractEnabledChains, _AssetsController_normalizeChainReference, _AssetsController_subscribeToEvents, _AssetsController_onUnapprovedTransactionAdded, _AssetsController_updateActive, _AssetsController_handleAccountTreeStateChange, _AssetsController_registerActionHandlers, _AssetsController_handleActiveChainsUpdate, _AssetsController_executeMiddlewares, _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_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_initializeState, _AssetsController_extractEnabledChains, _AssetsController_normalizeChainReference, _AssetsController_subscribeToEvents, _AssetsController_onUnapprovedTransactionAdded, _AssetsController_updateActive, _AssetsController_handleAccountTreeStateChange, _AssetsController_registerActionHandlers, _AssetsController_handleActiveChainsUpdate, _AssetsController_executeMiddlewares, _AssetsController_getNativeAssetMap, _AssetsController_getKnownNativeAssetIds, _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 assets_controllers_1 = require("@metamask/assets-controllers");
 const base_controller_1 = require("@metamask/base-controller");
 const client_controller_1 = require("@metamask/client-controller");
 const controller_utils_1 = require("@metamask/controller-utils");
@@ -34,6 +35,8 @@ 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/index.cjs");
+const isNativeAsset_1 = require("./utils/isNativeAsset.cjs");
+const NATIVE_ASSETS_QUERY_KEY = ['nativeAssets'];
 // ============================================================================
 // CONTROLLER CONSTANTS
 // ============================================================================
@@ -262,12 +265,43 @@ class AssetsController extends base_controller_1.BaseController {
         _AssetsController_detectionMiddleware.set(this, void 0);
         _AssetsController_tokenDataSource.set(this, void 0);
         _AssetsController_unsubscribeBasicFunctionality.set(this, null);
+        _AssetsController_queryApiClient.set(this, void 0);
         _AssetsController_onActiveChainsUpdated.set(this, void 0);
         __classPrivateFieldSet(this, _AssetsController_isEnabled, isEnabled(), "f");
         __classPrivateFieldSet(this, _AssetsController_isBasicFunctionality, isBasicFunctionality ?? (() => true), "f");
         __classPrivateFieldSet(this, _AssetsController_defaultUpdateInterval, defaultUpdateInterval, "f");
         __classPrivateFieldSet(this, _AssetsController_trace, trace, "f");
+        __classPrivateFieldSet(this, _AssetsController_queryApiClient, queryApiClient, "f");
         const rpcConfig = rpcDataSourceConfig ?? {};
+        queryApiClient.queryClient
+            .fetchQuery({
+            queryKey: NATIVE_ASSETS_QUERY_KEY,
+            queryFn: async () => {
+                // Today: build from constant. Tomorrow: replace body with API call.
+                const map = {};
+                for (const nativeAssetId of Object.values(assets_controllers_1.SPOT_PRICES_SUPPORT_INFO)) {
+                    const { chainId } = (0, utils_1.parseCaipAssetType)(nativeAssetId);
+                    map[chainId] = nativeAssetId;
+                }
+                return map;
+            },
+            staleTime: Infinity,
+            gcTime: Infinity,
+        })
+            .catch(() => {
+            // Failure to populate native asset cache is non-fatal;
+            // isNativeAsset falls back to SPOT_PRICES_SUPPORT_INFO heuristics.
+        });
+        // Seed the cache synchronously so that synchronous consumers (e.g.
+        // isNativeAsset, #resolveNativeAssetIds) have data available immediately.
+        // When fetchQuery resolves (currently instant, future: API), it overwrites
+        // this with potentially fresher data.
+        const initialNativeAssetMap = {};
+        for (const nativeAssetId of Object.values(assets_controllers_1.SPOT_PRICES_SUPPORT_INFO)) {
+            const { chainId } = (0, utils_1.parseCaipAssetType)(nativeAssetId);
+            initialNativeAssetMap[chainId] = nativeAssetId;
+        }
+        queryApiClient.setCachedData(NATIVE_ASSETS_QUERY_KEY, initialNativeAssetMap);
         __classPrivateFieldSet(this, _AssetsController_onActiveChainsUpdated, (dataSourceName, chains, previousChains) => {
             try {
                 __classPrivateFieldGet(this, _AssetsController_instances, "m", _AssetsController_handleActiveChainsUpdate).call(this, dataSourceName, chains, previousChains);
@@ -296,6 +330,7 @@ class AssetsController extends base_controller_1.BaseController {
         __classPrivateFieldSet(this, _AssetsController_rpcDataSource, new RpcDataSource_1.RpcDataSource({
             messenger: this.messenger,
             onActiveChainsUpdated: __classPrivateFieldGet(this, _AssetsController_onActiveChainsUpdated, "f"),
+            getNativeAssetForChain: (chainId) => __classPrivateFieldGet(this, _AssetsController_instances, "m", _AssetsController_getNativeAssetMap).call(this)[chainId],
             ...rpcConfig,
             isOnboarded: rpcConfig.isOnboarded ?? isOnboarded,
         }), "f");
@@ -307,8 +342,7 @@ class AssetsController extends base_controller_1.BaseController {
         __classPrivateFieldSet(this, _AssetsController_tokenDataSource, new TokenDataSource_1.TokenDataSource(this.messenger, {
             queryApiClient,
             getNativeAssetIds: () => {
-                const { nativeAssetIdentifiers } = this.messenger.call('NetworkEnablementController:getState');
-                return Object.values(nativeAssetIdentifiers);
+                return Object.values(__classPrivateFieldGet(this, _AssetsController_instances, "m", _AssetsController_getNativeAssetMap).call(this));
             },
         }), "f");
         __classPrivateFieldSet(this, _AssetsController_priceDataSource, new PriceDataSource_1.PriceDataSource({
@@ -496,12 +530,11 @@ class AssetsController extends base_controller_1.BaseController {
      * @returns Bridge-compatible exchange rate state derived from assetsPrice and selectedCurrency.
      */
     getExchangeRatesForBridge() {
-        const { nativeAssetIdentifiers } = this.messenger.call('NetworkEnablementController:getState');
         const { networkConfigurationsByChainId } = this.messenger.call('NetworkController:getState');
         return (0, utils_2.formatExchangeRatesForBridge)({
             assetsPrice: this.state.assetsPrice,
             selectedCurrency: this.state.selectedCurrency,
-            nativeAssetIdentifiers,
+            nativeAssetIdentifiers: __classPrivateFieldGet(this, _AssetsController_instances, "m", _AssetsController_getNativeAssetMap).call(this),
             networkConfigurationsByChainId,
         });
     }
@@ -516,7 +549,6 @@ class AssetsController extends base_controller_1.BaseController {
      */
     getStateForTransactionPay() {
         const accounts = __classPrivateFieldGet(this, _AssetsController_instances, "m", _AssetsController_getSelectedAccounts).call(this);
-        const { nativeAssetIdentifiers } = this.messenger.call('NetworkEnablementController:getState');
         const { networkConfigurationsByChainId } = this.messenger.call('NetworkController:getState');
         return (0, utils_2.formatStateForTransactionPay)({
             assetsBalance: this.state.assetsBalance,
@@ -524,7 +556,7 @@ class AssetsController extends base_controller_1.BaseController {
             assetsPrice: this.state.assetsPrice,
             selectedCurrency: this.state.selectedCurrency,
             accounts: accounts.map((a) => ({ id: a.id, address: a.address })),
-            nativeAssetIdentifiers,
+            nativeAssetIdentifiers: __classPrivateFieldGet(this, _AssetsController_instances, "m", _AssetsController_getNativeAssetMap).call(this),
             networkConfigurationsByChainId,
         });
     }
@@ -568,7 +600,7 @@ class AssetsController extends base_controller_1.BaseController {
             if (pendingMetadata) {
                 const parsed = (0, utils_1.parseCaipAssetType)(normalizedAssetId);
                 let tokenType = 'erc20';
-                if (parsed.assetNamespace === 'slip44') {
+                if ((0, isNativeAsset_1.isNativeAsset)(normalizedAssetId, __classPrivateFieldGet(this, _AssetsController_instances, "m", _AssetsController_getKnownNativeAssetIds).call(this))) {
                     tokenType = 'native';
                 }
                 else if (parsed.assetNamespace === 'spl') {
@@ -844,7 +876,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_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_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 = {
     controller: 'AssetsController',
 }) {
     if (!__classPrivateFieldGet(this, _AssetsController_trace, "f")) {
@@ -1144,11 +1176,15 @@ async function _AssetsController_executeMiddlewares(sources, request, initialRes
         });
     }
     return { response: result.response, durationByDataSource };
+}, _AssetsController_getNativeAssetMap = function _AssetsController_getNativeAssetMap() {
+    return (__classPrivateFieldGet(this, _AssetsController_queryApiClient, "f").getCachedData(NATIVE_ASSETS_QUERY_KEY) ?? {});
+}, _AssetsController_getKnownNativeAssetIds = function _AssetsController_getKnownNativeAssetIds() {
+    return new Set(Object.values(__classPrivateFieldGet(this, _AssetsController_instances, "m", _AssetsController_getNativeAssetMap).call(this)).map((id) => id.toLowerCase()));
 }, _AssetsController_resolveNativeAssetIds = function _AssetsController_resolveNativeAssetIds(chains) {
-    const { nativeAssetIdentifiers } = this.messenger.call('NetworkEnablementController:getState');
+    const nativeAssetMap = __classPrivateFieldGet(this, _AssetsController_instances, "m", _AssetsController_getNativeAssetMap).call(this);
     const ids = [];
     for (const chainId of chains) {
-        const nativeId = nativeAssetIdentifiers?.[chainId];
+        const nativeId = nativeAssetMap[chainId];
         if (nativeId) {
             ids.push(nativeId);
         }
@@ -1408,7 +1444,8 @@ async function _AssetsController_executeMiddlewares(sources, request, initialRes
         return false;
     }
     // Check if it's a native token (either by metadata type or assetId format)
-    const isNative = metadata.type === 'native' || assetId.includes('/slip44:');
+    const isNative = metadata.type === 'native' ||
+        (0, isNativeAsset_1.isNativeAsset)(assetId, __classPrivateFieldGet(this, _AssetsController_instances, "m", _AssetsController_getKnownNativeAssetIds).call(this));
     return isNative;
 }, _AssetsController_tokenStandardToAssetType = function _AssetsController_tokenStandardToAssetType(tokenStandard) {
     switch (tokenStandard) {