@metamask-previews/assets-controller 2.0.2-preview-980f677 → 2.0.2-preview-567bc78af

package/dist/middlewares/DetectionMiddleware.mjs

@@ -10,12 +10,19 @@ createModuleLogger(projectLogger, CONTROLLER_NAME);
 // DETECTION MIDDLEWARE
 // ============================================================================
 /**
- * DetectionMiddleware identifies assets that do not have metadata.
+ * DetectionMiddleware builds the set of assets that downstream sources use for
+ * metadata and price fetching.
  *
  * This middleware:
- * - Checks assets in the response for metadata in state (via ctx.getAssetsState)
- * - Assets in response but without metadata are considered "detected"
- * - Fills response.detectedAssets with asset IDs per account that lack metadata
+ * - Includes every asset that appears in response.assetsBalance (so prices and
+ *   metadata are fetched for existing assets as well as new ones)
+ * - Includes each account's custom assets from state (so custom tokens get
+ *   metadata and prices even when they have no balance yet)
+ * - Fills response.detectedAssets with these asset IDs per account
+ *
+ * TokenDataSource and PriceDataSource both key off detectedAssets. TokenDataSource
+ * then filters to only fetch metadata for assets that lack it; PriceDataSource
+ * fetches prices for all detected assets.
  *
  * Usage:
  * ```typescript
@@ -31,45 +38,55 @@ export class DetectionMiddleware {
         return this.name;
     }
     /**
-     * Get the middleware for detecting assets without metadata.
+     * Get the middleware that builds detectedAssets for metadata and price fetching.
      *
      * This middleware:
-     * 1. Extracts the response from context
-     * 2. Detects assets from the response that don't have metadata
-     * 3. Fills response.detectedAssets with detected asset IDs per account
-     * 4. Calls next() to continue the middleware chain
+     * 1. Includes all assets from response.assetsBalance (so prices are fetched for existing assets too)
+     * 2. Merges each account's custom assets from state
+     * 3. Fills response.detectedAssets with these asset IDs per account
      *
      * @returns The middleware function for the assets pipeline.
      */
     get assetsMiddleware() {
         return forDataTypes(['balance'], async (ctx, next) => {
-            // Extract response from context
-            const { response } = ctx;
-            // If no balances in response, nothing to detect - pass through
-            if (!response.assetsBalance) {
-                return next(ctx);
-            }
-            // Get metadata from state
-            const { assetsInfo: stateMetadata } = ctx.getAssetsState();
+            const { request, response } = ctx;
+            // Get state for custom assets
+            const state = ctx.getAssetsState();
+            const { customAssets: stateCustomAssets } = state;
             const detectedAssets = {};
-            // Detect assets from the response that don't have metadata
-            for (const [accountId, accountBalances] of Object.entries(response.assetsBalance)) {
-                const detected = [];
-                for (const assetId of Object.keys(accountBalances)) {
-                    // Asset is detected if it does not have metadata in state
-                    if (!stateMetadata[assetId]) {
+            // 1. From balance response: include every asset with balance (so prices + metadata path include existing assets)
+            if (response.assetsBalance) {
+                for (const [accountId, accountBalances] of Object.entries(response.assetsBalance)) {
+                    const detected = [];
+                    for (const assetId of Object.keys(accountBalances)) {
                         detected.push(assetId);
                     }
+                    // Merge this account's custom assets from state
+                    const customForAccount = stateCustomAssets?.[accountId] ?? [];
+                    for (const assetId of customForAccount) {
+                        if (!detected.includes(assetId)) {
+                            detected.push(assetId);
+                        }
+                    }
+                    if (detected.length > 0) {
+                        detectedAssets[accountId] = detected;
+                    }
+                }
+            }
+            // 2. Accounts in request that weren't in balance response: include their custom assets
+            for (const { account } of request.accountsWithSupportedChains) {
+                const accountId = account.id;
+                if (detectedAssets[accountId]) {
+                    continue;
                 }
-                if (detected.length > 0) {
-                    detectedAssets[accountId] = detected;
+                const customForAccount = stateCustomAssets?.[accountId] ?? [];
+                if (customForAccount.length > 0) {
+                    detectedAssets[accountId] = customForAccount;
                 }
             }
-            // Fill detectedAssets in the response
             if (Object.keys(detectedAssets).length > 0) {
                 response.detectedAssets = detectedAssets;
             }
-            // Call next() to continue the middleware chain
             return next(ctx);
         });
     }

package/dist/middlewares/DetectionMiddleware.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"DetectionMiddleware.mjs","sourceRoot":"","sources":["../../src/middlewares/DetectionMiddleware.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,kBAAkB,EAAE,sBAAkB;AAC9D,OAAO,EAAE,YAAY,EAAE,qBAAiB;AAGxC,+EAA+E;AAC/E,YAAY;AACZ,+EAA+E;AAE/E,MAAM,eAAe,GAAG,qBAAqB,CAAC;AAE9C,uBAAuB;AACvB,kBAAkB,CAAC,aAAa,EAAE,eAAe,CAAC,CAAC;AAEnD,+EAA+E;AAC/E,uBAAuB;AACvB,+EAA+E;AAE/E;;;;;;;;;;;;;GAaG;AACH,MAAM,OAAO,mBAAmB;IAAhC;QACW,SAAI,GAAG,eAAe,CAAC;IA6DlC,CAAC;IA3DC,OAAO;QACL,OAAO,IAAI,CAAC,IAAI,CAAC;IACnB,CAAC;IAED;;;;;;;;;;OAUG;IACH,IAAI,gBAAgB;QAClB,OAAO,YAAY,CAAC,CAAC,SAAS,CAAC,EAAE,KAAK,EAAE,GAAG,EAAE,IAAI,EAAE,EAAE;YACnD,gCAAgC;YAChC,MAAM,EAAE,QAAQ,EAAE,GAAG,GAAG,CAAC;YAEzB,+DAA+D;YAC/D,IAAI,CAAC,QAAQ,CAAC,aAAa,EAAE,CAAC;gBAC5B,OAAO,IAAI,CAAC,GAAG,CAAC,CAAC;YACnB,CAAC;YAED,0BAA0B;YAC1B,MAAM,EAAE,UAAU,EAAE,aAAa,EAAE,GAAG,GAAG,CAAC,cAAc,EAAE,CAAC;YAE3D,MAAM,cAAc,GAAuC,EAAE,CAAC;YAE9D,2DAA2D;YAC3D,KAAK,MAAM,CAAC,SAAS,EAAE,eAAe,CAAC,IAAI,MAAM,CAAC,OAAO,CACvD,QAAQ,CAAC,aAAa,CACvB,EAAE,CAAC;gBACF,MAAM,QAAQ,GAAoB,EAAE,CAAC;gBAErC,KAAK,MAAM,OAAO,IAAI,MAAM,CAAC,IAAI,CAC/B,eAA0C,CAC3C,EAAE,CAAC;oBACF,0DAA0D;oBAC1D,IAAI,CAAC,aAAa,CAAC,OAAwB,CAAC,EAAE,CAAC;wBAC7C,QAAQ,CAAC,IAAI,CAAC,OAAwB,CAAC,CAAC;oBAC1C,CAAC;gBACH,CAAC;gBAED,IAAI,QAAQ,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;oBACxB,cAAc,CAAC,SAAS,CAAC,GAAG,QAAQ,CAAC;gBACvC,CAAC;YACH,CAAC;YAED,sCAAsC;YACtC,IAAI,MAAM,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;gBAC3C,QAAQ,CAAC,cAAc,GAAG,cAAc,CAAC;YAC3C,CAAC;YAED,+CAA+C;YAC/C,OAAO,IAAI,CAAC,GAAG,CAAC,CAAC;QACnB,CAAC,CAAC,CAAC;IACL,CAAC;CACF","sourcesContent":["import { projectLogger, createModuleLogger } from '../logger';\nimport { forDataTypes } from '../types';\nimport type { AccountId, Caip19AssetId, Middleware } from '../types';\n\n// ============================================================================\n// CONSTANTS\n// ============================================================================\n\nconst CONTROLLER_NAME = 'DetectionMiddleware';\n\n// Logger for debugging\ncreateModuleLogger(projectLogger, CONTROLLER_NAME);\n\n// ============================================================================\n// DETECTION MIDDLEWARE\n// ============================================================================\n\n/**\n * DetectionMiddleware identifies assets that do not have metadata.\n *\n * This middleware:\n * - Checks assets in the response for metadata in state (via ctx.getAssetsState)\n * - Assets in response but without metadata are considered \"detected\"\n * - Fills response.detectedAssets with asset IDs per account that lack metadata\n *\n * Usage:\n * ```typescript\n * const detectionMiddleware = new DetectionMiddleware();\n * const middleware = detectionMiddleware.assetsMiddleware;\n * ```\n */\nexport class DetectionMiddleware {\n  readonly name = CONTROLLER_NAME;\n\n  getName(): string {\n    return this.name;\n  }\n\n  /**\n   * Get the middleware for detecting assets without metadata.\n   *\n   * This middleware:\n   * 1. Extracts the response from context\n   * 2. Detects assets from the response that don't have metadata\n   * 3. Fills response.detectedAssets with detected asset IDs per account\n   * 4. Calls next() to continue the middleware chain\n   *\n   * @returns The middleware function for the assets pipeline.\n   */\n  get assetsMiddleware(): Middleware {\n    return forDataTypes(['balance'], async (ctx, next) => {\n      // Extract response from context\n      const { response } = ctx;\n\n      // If no balances in response, nothing to detect - pass through\n      if (!response.assetsBalance) {\n        return next(ctx);\n      }\n\n      // Get metadata from state\n      const { assetsInfo: stateMetadata } = ctx.getAssetsState();\n\n      const detectedAssets: Record<AccountId, Caip19AssetId[]> = {};\n\n      // Detect assets from the response that don't have metadata\n      for (const [accountId, accountBalances] of Object.entries(\n        response.assetsBalance,\n      )) {\n        const detected: Caip19AssetId[] = [];\n\n        for (const assetId of Object.keys(\n          accountBalances as Record<string, unknown>,\n        )) {\n          // Asset is detected if it does not have metadata in state\n          if (!stateMetadata[assetId as Caip19AssetId]) {\n            detected.push(assetId as Caip19AssetId);\n          }\n        }\n\n        if (detected.length > 0) {\n          detectedAssets[accountId] = detected;\n        }\n      }\n\n      // Fill detectedAssets in the response\n      if (Object.keys(detectedAssets).length > 0) {\n        response.detectedAssets = detectedAssets;\n      }\n\n      // Call next() to continue the middleware chain\n      return next(ctx);\n    });\n  }\n}\n"]}
+{"version":3,"file":"DetectionMiddleware.mjs","sourceRoot":"","sources":["../../src/middlewares/DetectionMiddleware.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,kBAAkB,EAAE,sBAAkB;AAC9D,OAAO,EAAE,YAAY,EAAE,qBAAiB;AAGxC,+EAA+E;AAC/E,YAAY;AACZ,+EAA+E;AAE/E,MAAM,eAAe,GAAG,qBAAqB,CAAC;AAE9C,uBAAuB;AACvB,kBAAkB,CAAC,aAAa,EAAE,eAAe,CAAC,CAAC;AAEnD,+EAA+E;AAC/E,uBAAuB;AACvB,+EAA+E;AAE/E;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,MAAM,OAAO,mBAAmB;IAAhC;QACW,SAAI,GAAG,eAAe,CAAC;IAwElC,CAAC;IAtEC,OAAO;QACL,OAAO,IAAI,CAAC,IAAI,CAAC;IACnB,CAAC;IAED;;;;;;;;;OASG;IACH,IAAI,gBAAgB;QAClB,OAAO,YAAY,CAAC,CAAC,SAAS,CAAC,EAAE,KAAK,EAAE,GAAG,EAAE,IAAI,EAAE,EAAE;YACnD,MAAM,EAAE,OAAO,EAAE,QAAQ,EAAE,GAAG,GAAG,CAAC;YAElC,8BAA8B;YAC9B,MAAM,KAAK,GAAG,GAAG,CAAC,cAAc,EAAE,CAAC;YACnC,MAAM,EAAE,YAAY,EAAE,iBAAiB,EAAE,GAAG,KAAK,CAAC;YAElD,MAAM,cAAc,GAAuC,EAAE,CAAC;YAE9D,iHAAiH;YACjH,IAAI,QAAQ,CAAC,aAAa,EAAE,CAAC;gBAC3B,KAAK,MAAM,CAAC,SAAS,EAAE,eAAe,CAAC,IAAI,MAAM,CAAC,OAAO,CACvD,QAAQ,CAAC,aAAa,CACvB,EAAE,CAAC;oBACF,MAAM,QAAQ,GAAoB,EAAE,CAAC;oBAErC,KAAK,MAAM,OAAO,IAAI,MAAM,CAAC,IAAI,CAC/B,eAA0C,CAC3C,EAAE,CAAC;wBACF,QAAQ,CAAC,IAAI,CAAC,OAAwB,CAAC,CAAC;oBAC1C,CAAC;oBAED,gDAAgD;oBAChD,MAAM,gBAAgB,GAAG,iBAAiB,EAAE,CAAC,SAAS,CAAC,IAAI,EAAE,CAAC;oBAC9D,KAAK,MAAM,OAAO,IAAI,gBAAgB,EAAE,CAAC;wBACvC,IAAI,CAAC,QAAQ,CAAC,QAAQ,CAAC,OAAO,CAAC,EAAE,CAAC;4BAChC,QAAQ,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;wBACzB,CAAC;oBACH,CAAC;oBAED,IAAI,QAAQ,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;wBACxB,cAAc,CAAC,SAAS,CAAC,GAAG,QAAQ,CAAC;oBACvC,CAAC;gBACH,CAAC;YACH,CAAC;YAED,uFAAuF;YACvF,KAAK,MAAM,EAAE,OAAO,EAAE,IAAI,OAAO,CAAC,2BAA2B,EAAE,CAAC;gBAC9D,MAAM,SAAS,GAAG,OAAO,CAAC,EAAE,CAAC;gBAC7B,IAAI,cAAc,CAAC,SAAS,CAAC,EAAE,CAAC;oBAC9B,SAAS;gBACX,CAAC;gBACD,MAAM,gBAAgB,GAAG,iBAAiB,EAAE,CAAC,SAAS,CAAC,IAAI,EAAE,CAAC;gBAC9D,IAAI,gBAAgB,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;oBAChC,cAAc,CAAC,SAAS,CAAC,GAAG,gBAAgB,CAAC;gBAC/C,CAAC;YACH,CAAC;YAED,IAAI,MAAM,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;gBAC3C,QAAQ,CAAC,cAAc,GAAG,cAAc,CAAC;YAC3C,CAAC;YAED,OAAO,IAAI,CAAC,GAAG,CAAC,CAAC;QACnB,CAAC,CAAC,CAAC;IACL,CAAC;CACF","sourcesContent":["import { projectLogger, createModuleLogger } from '../logger';\nimport { forDataTypes } from '../types';\nimport type { AccountId, Caip19AssetId, Middleware } from '../types';\n\n// ============================================================================\n// CONSTANTS\n// ============================================================================\n\nconst CONTROLLER_NAME = 'DetectionMiddleware';\n\n// Logger for debugging\ncreateModuleLogger(projectLogger, CONTROLLER_NAME);\n\n// ============================================================================\n// DETECTION MIDDLEWARE\n// ============================================================================\n\n/**\n * DetectionMiddleware builds the set of assets that downstream sources use for\n * metadata and price fetching.\n *\n * This middleware:\n * - Includes every asset that appears in response.assetsBalance (so prices and\n *   metadata are fetched for existing assets as well as new ones)\n * - Includes each account's custom assets from state (so custom tokens get\n *   metadata and prices even when they have no balance yet)\n * - Fills response.detectedAssets with these asset IDs per account\n *\n * TokenDataSource and PriceDataSource both key off detectedAssets. TokenDataSource\n * then filters to only fetch metadata for assets that lack it; PriceDataSource\n * fetches prices for all detected assets.\n *\n * Usage:\n * ```typescript\n * const detectionMiddleware = new DetectionMiddleware();\n * const middleware = detectionMiddleware.assetsMiddleware;\n * ```\n */\nexport class DetectionMiddleware {\n  readonly name = CONTROLLER_NAME;\n\n  getName(): string {\n    return this.name;\n  }\n\n  /**\n   * Get the middleware that builds detectedAssets for metadata and price fetching.\n   *\n   * This middleware:\n   * 1. Includes all assets from response.assetsBalance (so prices are fetched for existing assets too)\n   * 2. Merges each account's custom assets from state\n   * 3. Fills response.detectedAssets with these asset IDs per account\n   *\n   * @returns The middleware function for the assets pipeline.\n   */\n  get assetsMiddleware(): Middleware {\n    return forDataTypes(['balance'], async (ctx, next) => {\n      const { request, response } = ctx;\n\n      // Get state for custom assets\n      const state = ctx.getAssetsState();\n      const { customAssets: stateCustomAssets } = state;\n\n      const detectedAssets: Record<AccountId, Caip19AssetId[]> = {};\n\n      // 1. From balance response: include every asset with balance (so prices + metadata path include existing assets)\n      if (response.assetsBalance) {\n        for (const [accountId, accountBalances] of Object.entries(\n          response.assetsBalance,\n        )) {\n          const detected: Caip19AssetId[] = [];\n\n          for (const assetId of Object.keys(\n            accountBalances as Record<string, unknown>,\n          )) {\n            detected.push(assetId as Caip19AssetId);\n          }\n\n          // Merge this account's custom assets from state\n          const customForAccount = stateCustomAssets?.[accountId] ?? [];\n          for (const assetId of customForAccount) {\n            if (!detected.includes(assetId)) {\n              detected.push(assetId);\n            }\n          }\n\n          if (detected.length > 0) {\n            detectedAssets[accountId] = detected;\n          }\n        }\n      }\n\n      // 2. Accounts in request that weren't in balance response: include their custom assets\n      for (const { account } of request.accountsWithSupportedChains) {\n        const accountId = account.id;\n        if (detectedAssets[accountId]) {\n          continue;\n        }\n        const customForAccount = stateCustomAssets?.[accountId] ?? [];\n        if (customForAccount.length > 0) {\n          detectedAssets[accountId] = customForAccount;\n        }\n      }\n\n      if (Object.keys(detectedAssets).length > 0) {\n        response.detectedAssets = detectedAssets;\n      }\n\n      return next(ctx);\n    });\n  }\n}\n"]}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@metamask-previews/assets-controller",
-  "version": "2.0.2-preview-980f677",
+  "version": "2.0.2-preview-567bc78af",
   "description": "Tracks assets balances/prices and handles token detection across all digital assets",
   "keywords": [
     "MetaMask",
@@ -52,7 +52,7 @@
     "@ethersproject/abi": "^5.7.0",
     "@ethersproject/providers": "^5.7.0",
     "@metamask/account-tree-controller": "^4.1.1",
-    "@metamask/assets-controllers": "^100.0.2",
+    "@metamask/assets-controllers": "^100.0.3",
     "@metamask/base-controller": "^9.0.0",
     "@metamask/client-controller": "^1.0.0",
     "@metamask/controller-utils": "^11.19.0",
@@ -69,7 +69,7 @@
     "@metamask/preferences-controller": "^22.1.0",
     "@metamask/snaps-controllers": "^17.2.0",
     "@metamask/snaps-utils": "^11.7.0",
-    "@metamask/transaction-controller": "^62.18.0",
+    "@metamask/transaction-controller": "^62.19.0",
     "@metamask/utils": "^11.9.0",
     "async-mutex": "^0.5.0",
     "bignumber.js": "^9.1.2",