@uniswap/token-list-bridge-utils 2.2.0 → 2.4.0

package/src/fixtures/index.ts

@@ -17,6 +17,7 @@ import {
   DAI_BASE_GOERLI,
   COINBASE_WRAPPED_STAKED_ETH_OPTIMISM,
   DAI_BASE,
+  USDT_CELO,
 } from '../constants/tokens'
 import { compareTokenInfos } from '../utils'
 
@@ -60,6 +61,9 @@ export const Tokens: Partial<Record<ChainId, Record<string, TokenInfo>>> = {
       COINBASE_WRAPPED_STAKED_ETH_BASE_GOERLI
     ),
   },
+  [ChainId.CELO]: {
+    USDT: tokenToTokenInfo(USDT_CELO),
+  },
 }
 
 export const sampleL1TokenList: TokenList = {
@@ -236,6 +240,33 @@ export const bnbedSampleTokenList_2 = {
   ].sort(compareTokenInfos),
 }
 
+export const celoedSampleTokenList = {
+  ...sampleL1TokenList_2,
+  name: 'Celo Sample',
+  tokens: [
+    {
+      ...Tokens[ChainId.CELO]!.USDT,
+      extensions: {
+        bridgeInfo: {
+          [ChainId.MAINNET]: {
+            tokenAddress: USDT.address,
+          },
+        },
+      },
+    } as unknown as TokenInfo,
+    {
+      ...(Tokens[ChainId.MAINNET]!.USDT as unknown as TokenInfo),
+      extensions: {
+        bridgeInfo: {
+          [ChainId.CELO]: {
+            tokenAddress: USDT_CELO.address,
+          },
+        },
+      },
+    } as unknown as TokenInfo,
+  ].sort(compareTokenInfos),
+}
+
 export const baseGoerliSampleTokenList_3 = {
   ...sampleL1TokenList_3,
   name: 'Base Goerli Sample_3',

package/src/index.test.ts

@@ -29,6 +29,7 @@ import {
   sampleL1TokenList_3,
   baseGoerliSampleTokenList_3,
   baseSampleTokenList_3,
+  celoedSampleTokenList,
 } from './fixtures'
 
 jest.setTimeout(15000)
@@ -130,6 +131,22 @@ it('outputs bnb list correctly', async () => {
   )
 })
 
+it('outputs celo list correctly', async () => {
+  const tokenList = await chainifyTokenList([ChainId.CELO], sampleL1TokenList_2)
+  expect(tokenList).toBeDefined()
+  expect(tokenList?.version).toEqual(celoedSampleTokenList.version)
+  expect(
+    tokenList?.tokens.map((t) => [t.address, t.chainId, t.extensions])
+  ).toEqual(
+    // ignores other metadata
+    celoedSampleTokenList.tokens.map((t) => [
+      t.address,
+      t.chainId,
+      t.extensions,
+    ])
+  )
+})
+
 it('outputs bnb list correctly with different decimals', async () => {
   const tokenList = await chainifyTokenList([ChainId.BNB], sampleL1TokenList_2)
   expect(tokenList).toBeDefined()

package/src/local_mappings/celo.json

@@ -0,0 +1,19 @@
+{
+  "0xdac17f958d2ee523a2206206994597c13d831ec7": {
+    "childToken": "0x617f3112bf5397D0467D315cC709EF968D9ba546",
+    "decimals": 18
+  },
+  "0x2260FAC5E5542a773Aa44fBCfeDf7C193bc2C599": {
+    "childToken": "0xd71Ffd0940c920786eC4DbB5A12306669b5b81EF",
+    "decimals": 18
+  },
+  "0xC02aaA39b223FE8D0A0e5C4F27eAD9083C756Cc2": {
+    "childToken": "0xb829b68f57CC546dA7E5806A929e53bE32a4625D",
+    "decimals": 18
+  },
+  "0xa0b86991c6218b36c1d19d4a2e9eb0ce3606eb48": {
+    "childToken": "0x37f750B7cC259A2f741AF45294f6a16572CF5cAd",
+    "decimals": 6
+  }
+}
+

package/src/providers/CeloMappingProvider.ts

@@ -0,0 +1,10 @@
+import { MappingProvider } from './MappingProvider'
+import { MappedTokenData } from '../constants/types'
+import celoMappings from '../local_mappings/celo.json'
+
+// barring a better external source, we use a local source of mappings for celo
+export class CeloMappingProvider implements MappingProvider {
+  async provide(): Promise<MappedTokenData> {
+    return celoMappings as MappedTokenData
+  }
+}

package/src/providers/PolygonMappingProvider.ts

@@ -3,7 +3,8 @@ import { MappingProvider } from './MappingProvider'
 import { PolygonMappedTokenData } from '../constants/types'
 
 // called from https://mapper.polygon.technology
-const url = 'https://open-api.polygon.technology/api/v1/info/all-mappings'
+const url =
+  'https://api-polygon-tokens.polygon.technology/api/v1/info/all-mappings'
 const access_token = '504afd90-3228-4df9-9d88-9b4d70646101'
 
 /**

package/src/providers/index.ts

@@ -23,6 +23,7 @@ import {
 import { AvalancheMappingProvider } from './AvalancheMappingProvider'
 import { BaseGoerliMappingProvider } from './BaseGoerliMappingProvider'
 import { BaseMappingProvider } from './BaseMappingProvider'
+import { CeloMappingProvider } from './CeloMappingProvider'
 
 const web3 = new Web3()
 
@@ -33,6 +34,7 @@ const CHAINS_WITH_MAPPING_PROVIDERS = [
   ChainId.OPTIMISM,
   ChainId.BNB,
   ChainId.AVALANCHE,
+  ChainId.CELO,
   ChainId.BASE,
   ChainId.BASE_GOERLI,
 ]
@@ -154,6 +156,8 @@ function getMappingProvider(chainId: ChainId, l1TokenList: TokenList) {
       return new BnbMappingProvider()
     case ChainId.AVALANCHE:
       return new AvalancheMappingProvider()
+    case ChainId.CELO:
+      return new CeloMappingProvider()
     case ChainId.BASE:
       return new BaseMappingProvider()
     case ChainId.BASE_GOERLI:
@@ -228,7 +232,10 @@ async function getChildTokenDetails(
         (await hasExistingTokenContract(childTokenAddress, chainId))
     )
     const decimals =
-      childToken && (chainId === ChainId.BNB || chainId === ChainId.AVALANCHE)
+      childToken &&
+      (chainId === ChainId.BNB ||
+        chainId === ChainId.AVALANCHE ||
+        chainId === ChainId.CELO)
         ? (childToken as MappedToken).decimals
         : undefined
     return {

package/src/utils.ts

@@ -95,7 +95,7 @@ export const isTokenList = (obj: any) => {
 export function getRpcUrl(chainId: ChainId): string {
   switch (chainId) {
     case ChainId.MAINNET:
-      return 'https://rpc.ankr.com/eth'
+      return 'https://ethereum-rpc.publicnode.com'
     case ChainId.OPTIMISM:
       return 'https://rpc.ankr.com/optimism' // seems to have higher rate limit than https://mainnet.optimism.io/
     case ChainId.OPTIMISTIC_KOVAN:
@@ -112,6 +112,10 @@ export function getRpcUrl(chainId: ChainId): string {
       return 'https://bsc-dataseed1.binance.org'
     case ChainId.AVALANCHE:
       return 'https://api.avax.network/ext/bc/C/rpc'
+    case ChainId.CELO:
+      return 'https://forno.celo.org/'
+    case ChainId.CELO_ALFAJORES:
+      return 'https://alfajores-forno.celo-testnet.org/'
     case ChainId.BASE:
       return 'https://mainnet.base.org'
     case ChainId.BASE_GOERLI: