@metamask/assets-controller 6.3.0 → 7.0.0

package/dist/utils/customAssetsRpcSupplement.mjs

@@ -0,0 +1,68 @@
+import { parseCaipAssetType } from "@metamask/utils";
+/**
+ * Decide which chains require a supplemental `customAssetsOnly` RPC
+ * subscription so that user-imported customAssets are **always** polled by
+ * RPC — even when AccountsApi or the websocket data source has already
+ * claimed the chain in the regular handoff.
+ *
+ * RPC is the sole balance fetcher for customAssets:
+ * - AccountsApi indexes a curated token list and may return zero (or no
+ *   entry at all) for a user-imported token, even on supported chains.
+ * - The websocket data source is push-only: it relays balance deltas from
+ *   transactions, so a user who never transacts won't see balance updates.
+ *
+ * To guarantee freshness, we subscribe RPC in `customAssetsOnly` mode on
+ * any chain that:
+ * 1. has at least one selected account with a customAsset there;
+ * 2. is supported by the RPC data source;
+ * 3. is **not** already covered by the regular RPC subscription
+ *    (`rpcAssignedChains`) — otherwise customAssets are picked up there;
+ * 4. is currently enabled (in `chainToAccounts`); polling a disabled
+ *    chain wastes resources because the user can't see its balances.
+ *
+ * Malformed asset IDs are silently skipped — they can't be parsed into a
+ * chain anyway and shouldn't crash the subscription pipeline.
+ *
+ * @param input - Decision inputs.
+ * @returns Chains and account IDs that require supplemental subscription.
+ */
+export function pickRpcCustomAssetsSupplement(input) {
+    const { accountIds, customAssetsByAccount, rpcAssignedChains, rpcAvailableChains, enabledChains, } = input;
+    const chains = new Set();
+    const supplementalAccountIds = new Set();
+    for (const accountId of accountIds) {
+        const customForAccount = customAssetsByAccount[accountId];
+        if (!customForAccount || customForAccount.length === 0) {
+            continue;
+        }
+        // Mirror the controller's prior behavior: an account with any customAsset
+        // (even if all are filtered out below) is added to the candidate set.
+        // The empty-chains early-return in the caller still prevents a useless
+        // subscription, so this preserves observable behavior.
+        supplementalAccountIds.add(accountId);
+        for (const assetId of customForAccount) {
+            let chainId;
+            try {
+                chainId = parseCaipAssetType(assetId).chainId;
+            }
+            catch {
+                continue;
+            }
+            if (rpcAssignedChains.has(chainId)) {
+                continue;
+            }
+            if (!rpcAvailableChains.has(chainId)) {
+                continue;
+            }
+            if (!enabledChains.has(chainId)) {
+                continue;
+            }
+            chains.add(chainId);
+        }
+    }
+    return {
+        chains: [...chains],
+        accountIds: supplementalAccountIds,
+    };
+}
+//# sourceMappingURL=customAssetsRpcSupplement.mjs.map

package/dist/utils/customAssetsRpcSupplement.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"customAssetsRpcSupplement.mjs","sourceRoot":"","sources":["../../src/utils/customAssetsRpcSupplement.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,kBAAkB,EAAE,wBAAwB;AAoCrD;;;;;;;;;;;;;;;;;;;;;;;;;;GA0BG;AACH,MAAM,UAAU,6BAA6B,CAC3C,KAAqC;IAErC,MAAM,EACJ,UAAU,EACV,qBAAqB,EACrB,iBAAiB,EACjB,kBAAkB,EAClB,aAAa,GACd,GAAG,KAAK,CAAC;IAEV,MAAM,MAAM,GAAG,IAAI,GAAG,EAAW,CAAC;IAClC,MAAM,sBAAsB,GAAG,IAAI,GAAG,EAAU,CAAC;IAEjD,KAAK,MAAM,SAAS,IAAI,UAAU,EAAE,CAAC;QACnC,MAAM,gBAAgB,GAAG,qBAAqB,CAAC,SAAS,CAAC,CAAC;QAC1D,IAAI,CAAC,gBAAgB,IAAI,gBAAgB,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;YACvD,SAAS;QACX,CAAC;QACD,0EAA0E;QAC1E,sEAAsE;QACtE,uEAAuE;QACvE,uDAAuD;QACvD,sBAAsB,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC;QACtC,KAAK,MAAM,OAAO,IAAI,gBAAgB,EAAE,CAAC;YACvC,IAAI,OAAgB,CAAC;YACrB,IAAI,CAAC;gBACH,OAAO,GAAG,kBAAkB,CAAC,OAAO,CAAC,CAAC,OAAO,CAAC;YAChD,CAAC;YAAC,MAAM,CAAC;gBACP,SAAS;YACX,CAAC;YACD,IAAI,iBAAiB,CAAC,GAAG,CAAC,OAAO,CAAC,EAAE,CAAC;gBACnC,SAAS;YACX,CAAC;YACD,IAAI,CAAC,kBAAkB,CAAC,GAAG,CAAC,OAAO,CAAC,EAAE,CAAC;gBACrC,SAAS;YACX,CAAC;YACD,IAAI,CAAC,aAAa,CAAC,GAAG,CAAC,OAAO,CAAC,EAAE,CAAC;gBAChC,SAAS;YACX,CAAC;YACD,MAAM,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC;QACtB,CAAC;IACH,CAAC;IAED,OAAO;QACL,MAAM,EAAE,CAAC,GAAG,MAAM,CAAC;QACnB,UAAU,EAAE,sBAAsB;KACnC,CAAC;AACJ,CAAC","sourcesContent":["import { parseCaipAssetType } from '@metamask/utils';\n\nimport type { Caip19AssetId, ChainId } from '../types';\n\n/**\n * Inputs needed to decide whether `RpcDataSource` should run a supplemental\n * `customAssetsOnly` subscription. All inputs are pre-computed by the caller\n * (controller) so this helper is fully pure and deterministic.\n */\nexport type RpcCustomAssetsSupplementInput = {\n  /** Selected account IDs being considered for subscription. */\n  accountIds: string[];\n  /** `state.customAssets` slice — accountId → CAIP-19 asset IDs. */\n  customAssetsByAccount: Record<string, Caip19AssetId[]>;\n  /** Chains the regular RPC subscription already covers. */\n  rpcAssignedChains: Set<ChainId>;\n  /** Chains the RPC data source can serve (its current activeChains). */\n  rpcAvailableChains: Set<ChainId>;\n  /**\n   * Chains that are currently enabled for at least one selected account\n   * (i.e. keys of the controller's chainToAccounts map).\n   */\n  enabledChains: Set<ChainId>;\n};\n\n/**\n * The decision output: which chains and accounts need a supplemental\n * `customAssetsOnly` RPC subscription.\n */\nexport type RpcCustomAssetsSupplementResult = {\n  /** Chains that need a supplemental customAssetsOnly RPC subscription. */\n  chains: ChainId[];\n  /** Accounts that own at least one customAsset on a supplemental chain. */\n  accountIds: Set<string>;\n};\n\n/**\n * Decide which chains require a supplemental `customAssetsOnly` RPC\n * subscription so that user-imported customAssets are **always** polled by\n * RPC — even when AccountsApi or the websocket data source has already\n * claimed the chain in the regular handoff.\n *\n * RPC is the sole balance fetcher for customAssets:\n * - AccountsApi indexes a curated token list and may return zero (or no\n *   entry at all) for a user-imported token, even on supported chains.\n * - The websocket data source is push-only: it relays balance deltas from\n *   transactions, so a user who never transacts won't see balance updates.\n *\n * To guarantee freshness, we subscribe RPC in `customAssetsOnly` mode on\n * any chain that:\n * 1. has at least one selected account with a customAsset there;\n * 2. is supported by the RPC data source;\n * 3. is **not** already covered by the regular RPC subscription\n *    (`rpcAssignedChains`) — otherwise customAssets are picked up there;\n * 4. is currently enabled (in `chainToAccounts`); polling a disabled\n *    chain wastes resources because the user can't see its balances.\n *\n * Malformed asset IDs are silently skipped — they can't be parsed into a\n * chain anyway and shouldn't crash the subscription pipeline.\n *\n * @param input - Decision inputs.\n * @returns Chains and account IDs that require supplemental subscription.\n */\nexport function pickRpcCustomAssetsSupplement(\n  input: RpcCustomAssetsSupplementInput,\n): RpcCustomAssetsSupplementResult {\n  const {\n    accountIds,\n    customAssetsByAccount,\n    rpcAssignedChains,\n    rpcAvailableChains,\n    enabledChains,\n  } = input;\n\n  const chains = new Set<ChainId>();\n  const supplementalAccountIds = new Set<string>();\n\n  for (const accountId of accountIds) {\n    const customForAccount = customAssetsByAccount[accountId];\n    if (!customForAccount || customForAccount.length === 0) {\n      continue;\n    }\n    // Mirror the controller's prior behavior: an account with any customAsset\n    // (even if all are filtered out below) is added to the candidate set.\n    // The empty-chains early-return in the caller still prevents a useless\n    // subscription, so this preserves observable behavior.\n    supplementalAccountIds.add(accountId);\n    for (const assetId of customForAccount) {\n      let chainId: ChainId;\n      try {\n        chainId = parseCaipAssetType(assetId).chainId;\n      } catch {\n        continue;\n      }\n      if (rpcAssignedChains.has(chainId)) {\n        continue;\n      }\n      if (!rpcAvailableChains.has(chainId)) {\n        continue;\n      }\n      if (!enabledChains.has(chainId)) {\n        continue;\n      }\n      chains.add(chainId);\n    }\n  }\n\n  return {\n    chains: [...chains],\n    accountIds: supplementalAccountIds,\n  };\n}\n"]}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@metamask/assets-controller",
-  "version": "6.3.0",
+  "version": "7.0.0",
   "description": "Tracks assets balances/prices and handles token detection across all digital assets",
   "keywords": [
     "Ethereum",
@@ -56,27 +56,27 @@
     "@ethereumjs/util": "^9.1.0",
     "@ethersproject/abi": "^5.7.0",
     "@ethersproject/providers": "^5.7.0",
-    "@metamask/account-tree-controller": "^7.1.0",
-    "@metamask/accounts-controller": "^37.2.0",
-    "@metamask/assets-controllers": "^105.1.0",
+    "@metamask/account-tree-controller": "^7.3.0",
+    "@metamask/accounts-controller": "^38.0.0",
+    "@metamask/assets-controllers": "^106.0.0",
     "@metamask/base-controller": "^9.1.0",
     "@metamask/client-controller": "^1.0.1",
     "@metamask/controller-utils": "^11.20.0",
     "@metamask/core-backend": "^6.2.1",
     "@metamask/keyring-api": "^23.1.0",
-    "@metamask/keyring-controller": "^25.3.0",
+    "@metamask/keyring-controller": "^25.5.0",
     "@metamask/keyring-internal-api": "^11.0.1",
     "@metamask/keyring-snap-client": "^9.0.2",
     "@metamask/messenger": "^1.2.0",
     "@metamask/network-controller": "^30.1.0",
-    "@metamask/network-enablement-controller": "^5.0.2",
-    "@metamask/permission-controller": "^13.0.0",
+    "@metamask/network-enablement-controller": "^5.1.0",
+    "@metamask/permission-controller": "^13.1.0",
     "@metamask/phishing-controller": "^17.1.1",
     "@metamask/polling-controller": "^16.0.4",
     "@metamask/preferences-controller": "^23.1.0",
     "@metamask/snaps-controllers": "^19.0.0",
     "@metamask/snaps-utils": "^12.1.2",
-    "@metamask/transaction-controller": "^65.0.0",
+    "@metamask/transaction-controller": "^65.2.0",
     "@metamask/utils": "^11.9.0",
     "async-mutex": "^0.5.0",
     "bignumber.js": "^9.1.2",