@metamask-previews/assets-controller 0.0.0-preview-6dfa4aeba → 0.1.0-preview-ce3ee897a

package/CHANGELOG.md

@@ -9,13 +9,26 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ### Added
 
+- Add `assetPreferences` state and `AssetPreferences` type for per-asset UI preferences (e.g. `hidden`), separate from `assetsMetadata` ([#7777](https://github.com/MetaMask/core/pull/7777))
+- Add `hideAsset(assetId)`, `unhideAsset(assetId)` for managing hidden assets globally; hidden assets are excluded from `getAssets` but balance updates continue to be tracked ([#7777](https://github.com/MetaMask/core/pull/7777))
+
+### Changed
+
+- Narrow `AssetsControllerState` types from `Json` to semantic types: `assetsMetadata` → `AssetMetadata`, `assetsBalance` → `AssetBalance`, `assetsPrice` → `AssetPrice`, `assetPreferences` → `AssetPreferences`, `customAssets` → `Caip19AssetId[]` ([#7777](https://github.com/MetaMask/core/pull/7777))
+
+- Replace `viem` dependency with manual ABI encoding/decoding in `MulticallClient` ([#7839](https://github.com/MetaMask/core/pull/7839))
+
+## [0.1.0]
+
+### Added
+
+- Add `isEnabled` option to `AssetsController`, `initMessengers`, and `initDataSources` to conditionally skip initialization when disabled and avoid duplicated requests ([#7831](https://github.com/MetaMask/core/pull/7831))
 - Complete rewrite of AssetsController with middleware architecture for unified asset management across all blockchain networks (EVM and non-EVM) ([#7685](https://github.com/MetaMask/core/pull/7685))
 - Initial release ([#7587](https://github.com/MetaMask/core/pull/7587))
 - Add `MulticallClient` for batching RPC calls using Multicall3 contract ([#7677](https://github.com/MetaMask/core/pull/7677))
 - Add batch utilities (`divideIntoBatches`, `reduceInBatchesSerially`) for processing arrays in batches ([#7677](https://github.com/MetaMask/core/pull/7677))
 - Add `TokenDetector` service for detecting ERC-20 tokens with non-zero balances on a chain ([#7683](https://github.com/MetaMask/core/pull/7683))
 - Add `BalanceFetcher` service for fetching token balances for user's imported/detected tokens ([#7684](https://github.com/MetaMask/core/pull/7684))
-- Add `viem` dependency for ABI encoding/decoding in MulticallClient
 - Add configurable polling intervals for `RpcDataSource` via `RpcDataSourceConfig` in `initDataSources` ([#7709](https://github.com/MetaMask/core/pull/7709))
 - Add comprehensive unit tests for data sources (`AccountsApiDataSource`, `BackendWebsocketDataSource`, `PriceDataSource`, `TokenDataSource`, `SnapDataSource`), `DetectionMiddleware`, and `AssetsController` ([#7714](https://github.com/MetaMask/core/pull/7714))
 
@@ -26,8 +39,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - Store native token metadata (type, symbol, name, decimals) in `assetsMetadata` derived from `NetworkController` chain status ([#7752](https://github.com/MetaMask/core/pull/7752))
 - `AccountsApiDataSource` now includes `assetsMetadata` in response with token info from V5 API ([#7752](https://github.com/MetaMask/core/pull/7752))
 - Bump `@metamask/keyring-controller` from `^25.0.0` to `^25.1.0` ([#7713](https://github.com/MetaMask/core/pull/7713))
-- Refactor `MulticallClient` to use viem for ABI encoding/decoding instead of manual implementation
 - Refactor `RpcDataSource` to delegate polling to `BalanceFetcher` and `TokenDetector` services ([#7709](https://github.com/MetaMask/core/pull/7709))
 - Refactor `BalanceFetcher` and `TokenDetector` to extend `StaticIntervalPollingControllerOnly` for independent polling management ([#7709](https://github.com/MetaMask/core/pull/7709))
 
-[Unreleased]: https://github.com/MetaMask/core/
+[Unreleased]: https://github.com/MetaMask/core/compare/@metamask/assets-controller@0.1.0...HEAD
+[0.1.0]: https://github.com/MetaMask/core/releases/tag/@metamask/assets-controller@0.1.0

package/dist/AssetsController.cjs

@@ -13,7 +13,7 @@ var __classPrivateFieldGet = (this && this.__classPrivateFieldGet) || function (
 var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
-var _AssetsController_instances, _AssetsController_defaultUpdateInterval, _AssetsController_controllerMutex, _AssetsController_activeSubscriptions, _AssetsController_enabledChains, _AssetsController_selectedAccounts_get, _AssetsController_dataSources, _AssetsController_initializeState, _AssetsController_extractEnabledChains, _AssetsController_normalizeChainReference, _AssetsController_subscribeToEvents, _AssetsController_registerActionHandlers, _AssetsController_executeMiddlewares, _AssetsController_assignChainsToDataSources, _AssetsController_updateState, _AssetsController_getAssetsFromState, _AssetsController_tokenStandardToAssetType, _AssetsController_start, _AssetsController_stop, _AssetsController_subscribeToDataSources, _AssetsController_subscribeAssetsBalance, _AssetsController_buildChainToAccountsMap, _AssetsController_getAccountsForChains, _AssetsController_subscribeToDataSource, _AssetsController_unsubscribeDataSource, _AssetsController_getEnabledChainsForAccount, _AssetsController_handleAccountGroupChanged, _AssetsController_handleEnabledNetworksChanged, _AssetsController_handleSubscriptionUpdate;
+var _AssetsController_instances, _AssetsController_isEnabled, _AssetsController_defaultUpdateInterval, _AssetsController_controllerMutex, _AssetsController_activeSubscriptions, _AssetsController_enabledChains, _AssetsController_selectedAccounts_get, _AssetsController_dataSources, _AssetsController_initializeState, _AssetsController_extractEnabledChains, _AssetsController_normalizeChainReference, _AssetsController_subscribeToEvents, _AssetsController_registerActionHandlers, _AssetsController_executeMiddlewares, _AssetsController_assignChainsToDataSources, _AssetsController_updateState, _AssetsController_getAssetsFromState, _AssetsController_tokenStandardToAssetType, _AssetsController_start, _AssetsController_stop, _AssetsController_subscribeToDataSources, _AssetsController_subscribeAssetsBalance, _AssetsController_buildChainToAccountsMap, _AssetsController_getAccountsForChains, _AssetsController_subscribeToDataSource, _AssetsController_unsubscribeDataSource, _AssetsController_getEnabledChainsForAccount, _AssetsController_handleAccountGroupChanged, _AssetsController_handleEnabledNetworksChanged, _AssetsController_handleSubscriptionUpdate;
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.AssetsController = exports.getDefaultAssetsControllerState = void 0;
 const base_controller_1 = require("@metamask/base-controller");
@@ -33,7 +33,7 @@ const log = (0, logger_1.createModuleLogger)(logger_1.projectLogger, CONTROLLER_
 /**
  * Returns the default state for AssetsController.
  *
- * @returns The default AssetsController state with empty metadata, balance, price, and customAssets maps.
+ * @returns The default AssetsController state with empty maps.
  */
 function getDefaultAssetsControllerState() {
     return {
@@ -41,6 +41,7 @@ function getDefaultAssetsControllerState() {
         assetsBalance: {},
         assetsPrice: {},
         customAssets: {},
+        assetPreferences: {},
     };
 }
 exports.getDefaultAssetsControllerState = getDefaultAssetsControllerState;
@@ -72,6 +73,12 @@ const stateMetadata = {
         includeInDebugSnapshot: false,
         usedInUi: true,
     },
+    assetPreferences: {
+        persist: true,
+        includeInStateLogs: false,
+        includeInDebugSnapshot: false,
+        usedInUi: true,
+    },
 };
 // ============================================================================
 // HELPER FUNCTIONS
@@ -161,7 +168,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, }) {
+    constructor({ messenger, state = {}, defaultUpdateInterval = DEFAULT_POLLING_INTERVAL_MS, isEnabled = () => true, }) {
         super({
             name: CONTROLLER_NAME,
             messenger,
@@ -172,6 +179,8 @@ class AssetsController extends base_controller_1.BaseController {
             },
         });
         _AssetsController_instances.add(this);
+        /** Whether the controller is enabled */
+        _AssetsController_isEnabled.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());
@@ -190,7 +199,12 @@ class AssetsController extends base_controller_1.BaseController {
          * Key: sourceId, Value: Set of currently available chainIds
          */
         _AssetsController_dataSources.set(this, new Map());
+        __classPrivateFieldSet(this, _AssetsController_isEnabled, isEnabled(), "f");
         __classPrivateFieldSet(this, _AssetsController_defaultUpdateInterval, defaultUpdateInterval, "f");
+        if (!__classPrivateFieldGet(this, _AssetsController_isEnabled, "f")) {
+            log('AssetsController is disabled, skipping initialization');
+            return;
+        }
         log('Initializing AssetsController', {
             defaultUpdateInterval,
         });
@@ -347,6 +361,7 @@ class AssetsController extends base_controller_1.BaseController {
     /**
      * Add a custom asset for an account.
      * Custom assets are included in subscription and fetch operations.
+     * Adding a custom asset also unhides it if it was previously hidden.
      *
      * @param accountId - The account ID to add the custom asset for.
      * @param assetId - The CAIP-19 asset ID to add.
@@ -363,6 +378,14 @@ class AssetsController extends base_controller_1.BaseController {
             if (!customAssets[accountId].includes(normalizedAssetId)) {
                 customAssets[accountId].push(normalizedAssetId);
             }
+            // Unhide the asset if it was hidden (via assetPreferences)
+            const prefs = state.assetPreferences[normalizedAssetId];
+            if (prefs?.hidden) {
+                delete prefs.hidden;
+                if (Object.keys(prefs).length === 0) {
+                    delete state.assetPreferences[normalizedAssetId];
+                }
+            }
         });
         // Fetch data for the newly added custom asset
         const account = __classPrivateFieldGet(this, _AssetsController_instances, "a", _AssetsController_selectedAccounts_get).find((a) => a.id === accountId);
@@ -384,12 +407,11 @@ class AssetsController extends base_controller_1.BaseController {
         const normalizedAssetId = (0, utils_2.normalizeAssetId)(assetId);
         log('Removing custom asset', { accountId, assetId: normalizedAssetId });
         this.update((state) => {
-            const customAssets = state.customAssets;
-            if (customAssets[accountId]) {
-                customAssets[accountId] = customAssets[accountId].filter((id) => id !== normalizedAssetId);
+            if (state.customAssets[accountId]) {
+                state.customAssets[accountId] = state.customAssets[accountId].filter((id) => id !== normalizedAssetId);
                 // Clean up empty arrays
-                if (customAssets[accountId].length === 0) {
-                    delete customAssets[accountId];
+                if (state.customAssets[accountId].length === 0) {
+                    delete state.customAssets[accountId];
                 }
             }
         });
@@ -401,7 +423,45 @@ class AssetsController extends base_controller_1.BaseController {
      * @returns Array of CAIP-19 asset IDs for the account's custom assets.
      */
     getCustomAssets(accountId) {
-        return (this.state.customAssets[accountId] ?? []);
+        return this.state.customAssets[accountId] ?? [];
+    }
+    // ============================================================================
+    // HIDDEN ASSETS MANAGEMENT
+    // ============================================================================
+    /**
+     * Hide an asset globally.
+     * Hidden assets are excluded from the asset list returned by getAssets.
+     * The hidden state is stored in assetPreferences.
+     *
+     * @param assetId - The CAIP-19 asset ID to hide.
+     */
+    hideAsset(assetId) {
+        const normalizedAssetId = (0, utils_2.normalizeAssetId)(assetId);
+        log('Hiding asset', { assetId: normalizedAssetId });
+        this.update((state) => {
+            if (!state.assetPreferences[normalizedAssetId]) {
+                state.assetPreferences[normalizedAssetId] = {};
+            }
+            state.assetPreferences[normalizedAssetId].hidden = true;
+        });
+    }
+    /**
+     * Unhide an asset globally.
+     *
+     * @param assetId - The CAIP-19 asset ID to unhide.
+     */
+    unhideAsset(assetId) {
+        const normalizedAssetId = (0, utils_2.normalizeAssetId)(assetId);
+        log('Unhiding asset', { assetId: normalizedAssetId });
+        this.update((state) => {
+            const prefs = state.assetPreferences[normalizedAssetId];
+            if (prefs) {
+                delete prefs.hidden;
+                if (Object.keys(prefs).length === 0) {
+                    delete state.assetPreferences[normalizedAssetId];
+                }
+            }
+        });
     }
     /**
      * Subscribe to price updates for all assets held by the given accounts.
@@ -494,10 +554,12 @@ class AssetsController extends base_controller_1.BaseController {
         this.messenger.unregisterActionHandler('AssetsController:addCustomAsset');
         this.messenger.unregisterActionHandler('AssetsController:removeCustomAsset');
         this.messenger.unregisterActionHandler('AssetsController:getCustomAssets');
+        this.messenger.unregisterActionHandler('AssetsController:hideAsset');
+        this.messenger.unregisterActionHandler('AssetsController:unhideAsset');
     }
 }
 exports.AssetsController = AssetsController;
-_AssetsController_defaultUpdateInterval = new WeakMap(), _AssetsController_controllerMutex = new WeakMap(), _AssetsController_activeSubscriptions = new WeakMap(), _AssetsController_enabledChains = new WeakMap(), _AssetsController_dataSources = new WeakMap(), _AssetsController_instances = new WeakSet(), _AssetsController_selectedAccounts_get = function _AssetsController_selectedAccounts_get() {
+_AssetsController_isEnabled = new WeakMap(), _AssetsController_defaultUpdateInterval = new WeakMap(), _AssetsController_controllerMutex = new WeakMap(), _AssetsController_activeSubscriptions = new WeakMap(), _AssetsController_enabledChains = new WeakMap(), _AssetsController_dataSources = new WeakMap(), _AssetsController_instances = new WeakSet(), _AssetsController_selectedAccounts_get = function _AssetsController_selectedAccounts_get() {
     return this.messenger.call('AccountTreeController:getAccountsFromSelectedAccountGroup');
 }, _AssetsController_initializeState = function _AssetsController_initializeState() {
     const { enabledNetworkMap } = this.messenger.call('NetworkEnablementController:getState');
@@ -556,6 +618,8 @@ _AssetsController_defaultUpdateInterval = new WeakMap(), _AssetsController_contr
     this.messenger.registerActionHandler('AssetsController:addCustomAsset', this.addCustomAsset.bind(this));
     this.messenger.registerActionHandler('AssetsController:removeCustomAsset', this.removeCustomAsset.bind(this));
     this.messenger.registerActionHandler('AssetsController:getCustomAssets', this.getCustomAssets.bind(this));
+    this.messenger.registerActionHandler('AssetsController:hideAsset', this.hideAsset.bind(this));
+    this.messenger.registerActionHandler('AssetsController:unhideAsset', this.unhideAsset.bind(this));
 }, _AssetsController_executeMiddlewares = 
 // ============================================================================
 // MIDDLEWARE EXECUTION
@@ -627,7 +691,7 @@ async function _AssetsController_updateState(response) {
         const changedBalances = [];
         const changedMetadata = [];
         this.update((state) => {
-            // Use type assertions to avoid deep type instantiation issues with Draft<Json>
+            // Use type assertions to avoid deep type instantiation issues with Immer Draft types
             const metadata = state.assetsMetadata;
             const balances = state.assetsBalance;
             const prices = state.assetsPrice;
@@ -738,16 +802,21 @@ async function _AssetsController_updateState(response) {
         const accountBalances = this.state.assetsBalance[account.id] ?? {};
         for (const [assetId, balance] of Object.entries(accountBalances)) {
             const typedAssetId = assetId;
-            const assetChainId = extractChainId(typedAssetId);
-            if (!chainIdSet.has(assetChainId)) {
-                continue;
-            }
             const metadataRaw = this.state.assetsMetadata[typedAssetId];
             // Skip assets without metadata
             if (!metadataRaw) {
                 continue;
             }
             const metadata = metadataRaw;
+            // Skip hidden assets (assetPreferences)
+            const prefs = this.state.assetPreferences[typedAssetId];
+            if (prefs?.hidden) {
+                continue;
+            }
+            const assetChainId = extractChainId(typedAssetId);
+            if (!chainIdSet.has(assetChainId)) {
+                continue;
+            }
             // Filter by asset type
             const tokenAssetType = __classPrivateFieldGet(this, _AssetsController_instances, "m", _AssetsController_tokenStandardToAssetType).call(this, metadata.type);
             if (!assetTypeSet.has(tokenAssetType)) {