add custom metadata and provider services

Author: dglowinski

package.json

@@ -71,10 +71,5 @@
     "typescript": "^5.7.2",
     "vite-tsconfig-paths": "^5.1.3",
     "vitest": "^2.1.6"
-  },
-  "pnpm": {
-    "patchedDependencies": {
-      "@balmy/[email protected]": "patches/@[email protected]"
-    }
   }
 }

patches/@[email protected]

@@ -26,3 +26,7 @@ const cache: Record<number, TokenListItem[]> = {
 export default function getTokenList(chainId: number): TokenListItem[] {
   return cache[chainId]
 }
+
+export function getAllTokenLists() {
+  return cache
+}

pnpm-lock.yaml

@@ -0,0 +1,57 @@
+import { getAllTokenLists } from "@/common/utils/tokenList"
+import type {
+  ChainId,
+  FieldsRequirements,
+  SupportInChain,
+  TimeString,
+  TokenAddress,
+} from "@balmy/sdk"
+
+import type {
+  BaseTokenMetadata,
+  IMetadataSource,
+  MetadataInput,
+  MetadataResult,
+} from "@balmy/sdk/dist/services/metadata/types"
+import { type Address, isAddressEqual } from "viem"
+
+export class TokenlistMetadataSource
+  implements IMetadataSource<BaseTokenMetadata>
+{
+  async getMetadata<
+    Requirements extends FieldsRequirements<BaseTokenMetadata>,
+  >(params: {
+    tokens: MetadataInput[]
+    config?: { timeout?: TimeString }
+  }) {
+    const result: Record<ChainId, Record<TokenAddress, BaseTokenMetadata>> = {}
+    const allTokens = getAllTokenLists()
+    for (const { chainId, token } of params.tokens) {
+      const tokenListItem = allTokens[chainId]?.find((t) =>
+        isAddressEqual(t.addressInfo, token as Address),
+      )
+      if (tokenListItem) {
+        if (!result[chainId]) result[chainId] = {}
+        result[chainId][token] = {
+          decimals: tokenListItem.decimals,
+          symbol: tokenListItem.symbol,
+        }
+      }
+    }
+
+    return result as Record<
+      ChainId,
+      Record<TokenAddress, MetadataResult<BaseTokenMetadata, Requirements>>
+    >
+  }
+
+  supportedProperties() {
+    const properties: SupportInChain<BaseTokenMetadata> = {
+      symbol: "present",
+      decimals: "present",
+    }
+    return Object.fromEntries(
+      Object.keys(getAllTokenLists()).map((chainId) => [chainId, properties]),
+    )
+  }
+}

src/common/utils/tokenList.ts

@@ -1,10 +1,12 @@
 import {
   type BuildParams,
+  type Chain,
   type QuoteRequest,
   type QuoteResponse,
   type QuoteResponseWithTx,
   type SourceId,
   buildSDK,
+  getAllChains,
 } from "@balmy/sdk"
 import { buildFetchService } from "@balmy/sdk/dist/sdk/builders/fetch-builder"
 import { buildProviderService } from "@balmy/sdk/dist/sdk/builders/provider-builder"
@@ -36,6 +38,7 @@ import {
   quoteToRoute,
 } from "../utils"
 import { CustomSourceList } from "./balmySDK/customSourceList"
+import { TokenlistMetadataSource } from "./balmySDK/tokenlistMetadataSource"
 
 const DAO_MULTISIG = "0xcAD001c30E96765aC90307669d578219D4fb1DCe"
 const DEFAULT_TIMEOUT = "30000"
@@ -126,6 +129,21 @@ export class StrategyBalmySDK {
           },
         },
       },
+      metadata: {
+        source: {
+          type: "custom",
+          instance: new TokenlistMetadataSource(),
+        },
+      },
+      provider: {
+        source: {
+          type: "public-rpcs",
+          rpcsPerChain: combinePublicAndPrivateRPCs(),
+          config: {
+            type: "fallback",
+          },
+        },
+      },
     } as BuildParams
     this.sdk = buildSDK(buildParams)
     this.match = match
@@ -500,3 +518,27 @@ export class StrategyBalmySDK {
     }
   }
 }
+
+function combinePublicAndPrivateRPCs() {
+  const rpcs = Object.fromEntries(
+    getAllChains()
+      .filter(
+        (chain): chain is Chain & { publicRPCs: string[] } =>
+          chain.publicRPCs.length > 0,
+      )
+      .map(({ chainId, publicRPCs }) => [chainId, publicRPCs]),
+  )
+
+  const envRPCs = Object.entries(process.env).filter(([key]) =>
+    /^RPC_URL_/.test(key),
+  )
+
+  for (const [key, val] of envRPCs) {
+    if (typeof val !== "string") return
+    const chainId = Number(key.split("_").at(-1))
+    if (!rpcs[chainId]) rpcs[chainId] = []
+    if (!rpcs[chainId].includes(val)) rpcs[chainId].unshift(val)
+  }
+
+  return rpcs
+}