use external tokenlist api

Author: dglowinski

.env.template

@@ -9,6 +9,9 @@ CORS_ORIGIN="*" # Allowed CORS origin, adjust as necessary
 COMMON_RATE_LIMIT_WINDOW_MS="1000" # Window size for rate limiting (ms)
 COMMON_RATE_LIMIT_MAX_REQUESTS="20" # Max number of requests per window per IP
 
+# Optional endpoint to fetch the tokenlists expects `?chainId` query param
+TOKENLIST_URL=""
+
 # RPCs
 # mainnet
 RPC_URL_1=""  

README.md

@@ -155,4 +155,7 @@ const pipeline = [
 ]
 ```
 
-Additionally there is a script to generate auxiliary config files, executed by `pnpm run generate-config`. Currently it fetches the list of supported [Pendle aggregators](./src/swapService/strategies/balmySDK/sources/pendle/pendleAggregators.json) for all chains
+Additionally there is a script to generate auxiliary config files, executed by `pnpm run generate-config`. Currently it fetches the list of supported [Pendle aggregators](./src/swapService/strategies/balmySDK/sources/pendle/pendleAggregators.json) for all chains
+
+## Tokenlists
+The router relies on tokenlists for all swapped tokens. They can be fetched from `TOKENLIST_URL` or read from JSON files in `tokenLists` folder if the configuration is missing. Note the files are not updated currently. Please reach out on [Euler discord](https://discord.com/invite/pTTnr7b4mT) if you need access to the tokenlist endpoint.

src/common/utils/tokenList.ts

@@ -1,8 +1,9 @@
 import fs from "node:fs"
-import { type Address, isAddressEqual } from "viem"
+import type { Address } from "viem"
+import { RPC_URLS } from "./viemClients"
 
 export type TokenListItem = {
-  addressInfo: Address
+  address: Address
   chainId: number
   decimals: number
   logoURI: string
@@ -22,7 +23,8 @@ export type TokenListItem = {
 }
 
 const cache: Record<number, TokenListItem[]> = {}
-;(function buildCache() {
+
+const loadTokenlistsFromFiles = () => {
   let dir = `${__dirname}/../tokenLists`
   let files
   try {
@@ -39,6 +41,26 @@ const cache: Record<number, TokenListItem[]> = {}
       fs.readFileSync(`${dir}/${file}`).toString(),
     ) as TokenListItem[]
   }
+}
+;(function buildCache() {
+  const tokenlistURL = process.env.TOKENLIST_URL
+  if (!tokenlistURL) {
+    console.warn(
+      "Missing TOKENLIST_URL configuration. Falling back to static files",
+    )
+    loadTokenlistsFromFiles()
+    return
+  }
+
+  Promise.all(
+    Object.keys(RPC_URLS).map(async (chainId) => {
+      const response = await fetch(`${tokenlistURL}?chainId=${chainId}`)
+      if (!response.ok) {
+        throw new Error(`Failed fetching tokenlist for chain ${chainId}`)
+      }
+      cache[Number(chainId)] = (await response.json()) as TokenListItem[]
+    }),
+  )
 })()
 
 export default function getTokenList(chainId: number): TokenListItem[] {

src/common/utils/viemClients.ts

@@ -152,16 +152,18 @@ export const plasma = defineChain({
 
 export const RPC_URLS: Record<number, string> = {
   [chains.mainnet.id]: process.env.RPC_URL_1 || "",
-  [chains.sepolia.id]: process.env.RPC_URL_11155111 || "",
   [chains.arbitrum.id]: process.env.RPC_URL_42161 || "",
   [chains.base.id]: process.env.RPC_URL_8453 || "",
-  [bartio.id]: process.env.RPC_URL_80084 || "",
   [berachain.id]: process.env.RPC_URL_80094 || "",
   [chains.avalanche.id]: process.env.RPC_URL_43114 || "",
-  [146]: process.env.RPC_URL_146 || "",
-  [130]: process.env.RPC_URL_130 || "",
+  [chains.bsc.id]: process.env.RPC_URL_56 || "",
+  [chains.linea.id]: process.env.RPC_URL_56 || "",
+  [sonicnetwork.id]: process.env.RPC_URL_146 || "",
+  [unichain.id]: process.env.RPC_URL_130 || "",
+  [60808]: process.env.RPC_URL_130 || "", //bob
+  [1923]: process.env.RPC_URL_130 || "", //swell
   [tac.id]: process.env.RPC_URL_239 || "",
-  [chains.foundry.id]: process.env.RPC_URL_31337 || "http://localhost:8545",
+  [plasma.id]: process.env.RPC_URL_9745 || "",
 } as const
 
 export const createHttp = (chainId: number) =>
@@ -178,16 +180,7 @@ export function createChainConfig(chain: Chain) {
 }
 
 export const createClients = (): Record<number, Client<Transport, Chain>> => ({
-  [bartio.id]: createChainConfig(bartio),
   [chains.mainnet.id]: createChainConfig(chains.mainnet),
-  [chains.sepolia.id]: createClient({
-    chain: chains.sepolia,
-    transport: http(RPC_URLS[chains.sepolia.id]),
-  }),
-  [chains.foundry.id]: createClient({
-    chain: chains.foundry,
-    transport: http(RPC_URLS[chains.foundry.id]),
-  }),
   [chains.arbitrum.id]: createChainConfig(chains.arbitrum),
   [chains.base.id]: createChainConfig(chains.base),
   [sonicnetwork.id]: createClient({
@@ -208,6 +201,10 @@ export const createClients = (): Record<number, Client<Transport, Chain>> => ({
     chain: tac,
     transport: http(RPC_URLS[tac.id]),
   }),
+  [plasma.id]: createClient({
+    chain: plasma,
+    transport: http(RPC_URLS[plasma.id]),
+  }),
   [chains.linea.id]: createChainConfig(chains.linea),
 })
 

src/swapService/quoters/quoter1Inch.ts

@@ -6,8 +6,8 @@ export async function fetch1InchQuote(
   swapParams: SwapParams,
 ): Promise<SwapQuote> {
   const params = new URLSearchParams({
-    src: swapParams.tokenIn.addressInfo,
-    dst: swapParams.tokenOut.addressInfo,
+    src: swapParams.tokenIn.address,
+    dst: swapParams.tokenOut.address,
     amount: String(swapParams.amount),
     from: swapParams.from || getSwapper(swapParams.chainId),
     origin: swapParams.origin,

src/swapService/quoters/quoterKyberswap.ts

@@ -37,8 +37,8 @@ export async function fetchKyberswapQuote(
   skipBuild?: boolean,
 ): Promise<SwapQuote> {
   const params = new URLSearchParams({
-    tokenIn: swapParams.tokenIn.addressInfo,
-    tokenOut: swapParams.tokenOut.addressInfo,
+    tokenIn: swapParams.tokenIn.address,
+    tokenOut: swapParams.tokenOut.address,
     amountIn: swapParams.amount.toString(),
     gasInclude: "true",
   })

src/swapService/quoters/quoterLifi.ts

@@ -44,8 +44,8 @@ export async function fetchLiFiExactInQuote(
   const params = new URLSearchParams({
     fromChain: chainKey,
     toChain: chainKey,
-    fromToken: swapParams.tokenIn.addressInfo,
-    toToken: swapParams.tokenOut.addressInfo,
+    fromToken: swapParams.tokenIn.address,
+    toToken: swapParams.tokenOut.address,
     fromAddress: swapParams.from || getSwapper(swapParams.chainId),
     toAddress: swapParams.receiver,
     fromAmount: String(swapParams.amount),
@@ -93,8 +93,8 @@ export async function fetchLiFiExactOutQuote(
   const params = new URLSearchParams({
     fromChain: chainKey,
     toChain: chainKey,
-    fromToken: swapParams.tokenIn.addressInfo,
-    toToken: swapParams.tokenOut.addressInfo,
+    fromToken: swapParams.tokenIn.address,
+    toToken: swapParams.tokenOut.address,
     fromAddress: swapParams.from,
     toAddress: swapParams.receiver,
     toAmount: String(swapParams.amount),

src/swapService/quoters/quoterPendle.ts

@@ -16,8 +16,8 @@ export async function fetchPendleQuote(swapParams: SwapParams) {
     receiver: swapParams.receiver,
     slippage: String(swapParams.slippage / 100), // 1 = 100%
     enableAggregator: "true",
-    tokenIn: swapParams.tokenIn.addressInfo,
-    tokenOut: swapParams.tokenOut.addressInfo,
+    tokenIn: swapParams.tokenIn.address,
+    tokenOut: swapParams.tokenOut.address,
     amountIn: String(swapParams.amount),
   })
 

src/swapService/quoters/quoterUniswap.ts

@@ -36,15 +36,15 @@ export async function fetchUniswapQuote(
 
   const baseCurrency = new Token(
     swapParams.chainId,
-    swapParams.tokenOut.addressInfo,
+    swapParams.tokenOut.address,
     swapParams.tokenOut.decimals,
     swapParams.tokenOut.symbol,
     swapParams.tokenOut.name,
   )
 
   const quoteCurrency = new Token(
     swapParams.chainId,
-    swapParams.tokenIn.addressInfo,
+    swapParams.tokenIn.address,
     swapParams.tokenIn.decimals,
     swapParams.tokenIn.symbol,
     swapParams.tokenIn.name,

src/swapService/strategies/balmySDK/tokenlistMetadataSource.ts

@@ -28,7 +28,7 @@ export class TokenlistMetadataSource
     const allTokens = getAllTokenLists()
     for (const { chainId, token } of params.tokens) {
       const tokenListItem = allTokens[chainId]?.find((t) =>
-        isAddressEqual(t.addressInfo, token as Address),
+        isAddressEqual(t.address, token as Address),
       )
       if (tokenListItem) {
         if (!result[chainId]) result[chainId] = {}