@uniswap/token-list-bridge-utils 2.0.0 → 2.1.0

package/src/fixtures/index.ts

@@ -10,6 +10,9 @@ import {
   DAI_POLYGON,
   USDT,
   USDT_BNB,
+  COINBASE_WRAPPED_STAKED_ETH,
+  COINBASE_WRAPPED_STAKED_ETH_BASE_GOERLI,
+  COINBASE_WRAPPED_STAKED_ETH_ARBITRUM_ONE,
 } from '../constants/tokens'
 import { compareTokenInfos } from '../utils'
 
@@ -17,9 +20,13 @@ export const Tokens: Partial<Record<ChainId, Record<string, TokenInfo>>> = {
   [ChainId.MAINNET]: {
     DAI: tokenToTokenInfo(DAI),
     USDT: tokenToTokenInfo(USDT),
+    COINBASE_WRAPPED_STAKED_ETH: tokenToTokenInfo(COINBASE_WRAPPED_STAKED_ETH),
   },
   [ChainId.ARBITRUM_ONE]: {
     DAI: tokenToTokenInfo(DAI_ARBITRUM_ONE),
+    COINBASE_WRAPPED_STAKED_ETH: tokenToTokenInfo(
+      COINBASE_WRAPPED_STAKED_ETH_ARBITRUM_ONE
+    ),
   },
   [ChainId.POLYGON]: {
     DAI: tokenToTokenInfo(DAI_POLYGON),
@@ -34,6 +41,11 @@ export const Tokens: Partial<Record<ChainId, Record<string, TokenInfo>>> = {
   [ChainId.AVALANCHE]: {
     DAI: tokenToTokenInfo(DAI_AVALANCHE),
   },
+  [ChainId.BASE_GOERLI]: {
+    COINBASE_WRAPPED_STAKED_ETH: tokenToTokenInfo(
+      COINBASE_WRAPPED_STAKED_ETH_BASE_GOERLI
+    ),
+  },
 }
 
 export const sampleL1TokenList: TokenList = {
@@ -58,6 +70,17 @@ export const sampleL1TokenList_2: TokenList = {
   tokens: [Tokens[ChainId.MAINNET]!.USDT],
 }
 
+export const sampleL1TokenList_3: TokenList = {
+  name: 'Sample_3',
+  timestamp: new Date(1646146610).toISOString(),
+  version: {
+    major: 1,
+    minor: 0,
+    patch: 0,
+  },
+  tokens: [Tokens[ChainId.MAINNET]!.COINBASE_WRAPPED_STAKED_ETH],
+}
+
 export const arbBridgeL2Address = '0x467194771dae2967aef3ecbedd3bf9a310c76c65'
 export const arbBridgeL1Address = '0xd3b5b60020504bc3489d6949d545893982ba3011'
 
@@ -199,6 +222,34 @@ export const bnbedSampleTokenList_2 = {
   ].sort(compareTokenInfos),
 }
 
+export const baseGoerliSampleTokenList_3 = {
+  ...sampleL1TokenList_3,
+  name: 'Base Goerli Sample_3',
+  tokens: [
+    {
+      ...Tokens[ChainId.BASE_GOERLI]!.COINBASE_WRAPPED_STAKED_ETH,
+      extensions: {
+        bridgeInfo: {
+          [ChainId.MAINNET]: {
+            tokenAddress: COINBASE_WRAPPED_STAKED_ETH.address,
+          },
+        },
+      },
+    } as unknown as TokenInfo,
+    {
+      ...(Tokens[ChainId.MAINNET]!
+        .COINBASE_WRAPPED_STAKED_ETH as unknown as TokenInfo),
+      extensions: {
+        bridgeInfo: {
+          [ChainId.BASE_GOERLI]: {
+            tokenAddress: COINBASE_WRAPPED_STAKED_ETH_BASE_GOERLI.address,
+          },
+        },
+      },
+    } as unknown as TokenInfo,
+  ].sort(compareTokenInfos),
+}
+
 export const optimizedSampleTokenList = {
   ...sampleL1TokenList,
   name: 'Optimized Sample',

package/src/index.test.ts

@@ -2,6 +2,9 @@ import { TokenInfo } from '@uniswap/token-lists'
 import { chainify, chainifyTokenList, mergeTokenLists } from '.'
 import { ChainId } from './constants/chainId'
 import {
+  COINBASE_WRAPPED_STAKED_ETH,
+  COINBASE_WRAPPED_STAKED_ETH_ARBITRUM_ONE,
+  COINBASE_WRAPPED_STAKED_ETH_BASE_GOERLI,
   DAI,
   DAI_ARBITRUM_ONE,
   DAI_AVALANCHE,
@@ -19,6 +22,8 @@ import {
   sampleL1TokenList_2,
   bnbedSampleTokenList_2,
   avalanchedSampleTokenList,
+  sampleL1TokenList_3,
+  baseGoerliSampleTokenList_3,
 } from './fixtures'
 
 jest.setTimeout(15000)
@@ -136,6 +141,25 @@ it('outputs bnb list correctly with different decimals', async () => {
   )
 })
 
+it('outputs base goerli list correctly', async () => {
+  const tokenList = await chainifyTokenList(
+    [ChainId.BASE_GOERLI],
+    sampleL1TokenList_3
+  )
+  expect(tokenList).toBeDefined()
+  expect(tokenList?.version).toEqual(baseGoerliSampleTokenList_3.version)
+  expect(
+    tokenList?.tokens.map((t) => [t.address, t.chainId, t.extensions])
+  ).toEqual(
+    // ignores other metadata
+    baseGoerliSampleTokenList_3.tokens.map((t) => [
+      t.address,
+      t.chainId,
+      t.extensions,
+    ])
+  )
+})
+
 describe(mergeTokenLists, () => {
   it('correctly deduplicates', () => {
     const merged = mergeTokenLists(sampleL1TokenList, sampleL1TokenList)
@@ -231,6 +255,93 @@ describe(mergeTokenLists, () => {
   })
 })
 describe(chainify, () => {
+  it('creates tokenMap correctly in chainify', async () => {
+    const chainified = await chainify(sampleL1TokenList)
+
+    expect(chainified.tokenMap).toEqual({
+      '10_0xDA10009cBd5D07dd0CeCc66161FC93D7c9000da1': {
+        ...Tokens[ChainId.OPTIMISM]!.DAI,
+        name: 'Dai Stablecoin',
+        extensions: {
+          bridgeInfo: {
+            [ChainId.MAINNET]: {
+              tokenAddress: DAI.address,
+            },
+          },
+        },
+      },
+      '137_0x8f3Cf7ad23Cd3CaDbD9735AFf958023239c6A063': {
+        ...Tokens[ChainId.POLYGON]!.DAI,
+        extensions: {
+          bridgeInfo: {
+            [ChainId.MAINNET]: {
+              tokenAddress: DAI.address,
+            },
+          },
+        },
+      },
+      '1_0x6B175474E89094C44Da98b954EedeAC495271d0F': {
+        ...Tokens[ChainId.MAINNET]!.DAI,
+        extensions: {
+          bridgeInfo: {
+            [ChainId.BNB]: {
+              tokenAddress: DAI_BNB.address,
+            },
+            [ChainId.AVALANCHE]: {
+              tokenAddress: DAI_AVALANCHE.address,
+            },
+            [ChainId.OPTIMISM]: {
+              tokenAddress: DAI_OPTIMISM.address,
+            },
+            [ChainId.POLYGON]: {
+              tokenAddress: DAI_POLYGON.address,
+            },
+            [ChainId.ARBITRUM_ONE]: {
+              tokenAddress: DAI_ARBITRUM_ONE.address,
+              // destBridgeAddress: arbBridgeL2Address,
+              // originBridgeAddress: arbBridgeL1Address,
+            },
+          },
+        },
+      },
+      '42161_0xDA10009cBd5D07dd0CeCc66161FC93D7c9000da1': {
+        ...Tokens[ChainId.ARBITRUM_ONE]!.DAI,
+        extensions: {
+          bridgeInfo: {
+            [ChainId.MAINNET]: {
+              tokenAddress: DAI.address,
+              // originBridgeAddress: arbBridgeL2Address,
+              // destBridgeAddress: arbBridgeL1Address,
+            },
+          },
+        },
+        name: 'Dai Stablecoin',
+      },
+      '43114_0xd586E7F844cEa2F87f50152665BCbc2C279D8d70': {
+        ...Tokens[ChainId.AVALANCHE]!.DAI,
+        name: 'Dai Stablecoin',
+        symbol: 'DAI',
+        extensions: {
+          bridgeInfo: {
+            [ChainId.MAINNET]: {
+              tokenAddress: DAI.address,
+            },
+          },
+        },
+      },
+      '56_0x1AF3F329e8BE154074D8769D1FFa4eE058B1DBc3': {
+        ...Tokens[ChainId.BNB]!.DAI,
+        extensions: {
+          bridgeInfo: {
+            [ChainId.MAINNET]: {
+              tokenAddress: DAI.address,
+            },
+          },
+        },
+      },
+    })
+  })
+
   it('provides bridge extensions', async () => {
     const chainified = await chainify(sampleL1TokenList)
 
@@ -317,4 +428,46 @@ describe(chainify, () => {
       },
     ])
   })
+
+  it('provides bridge extensions for base goerli list', async () => {
+    const chainified = await chainify(sampleL1TokenList_3)
+
+    expect(chainified.tokens).toEqual([
+      {
+        ...Tokens[ChainId.MAINNET]!.COINBASE_WRAPPED_STAKED_ETH,
+        extensions: {
+          bridgeInfo: {
+            [ChainId.ARBITRUM_ONE]: {
+              tokenAddress: COINBASE_WRAPPED_STAKED_ETH_ARBITRUM_ONE.address,
+            },
+            [ChainId.BASE_GOERLI]: {
+              tokenAddress: COINBASE_WRAPPED_STAKED_ETH_BASE_GOERLI.address,
+            },
+          },
+        },
+      },
+      {
+        ...Tokens[ChainId.ARBITRUM_ONE]!.COINBASE_WRAPPED_STAKED_ETH,
+        name: 'Coinbase Wrapped Staked ETH',
+        extensions: {
+          bridgeInfo: {
+            [ChainId.MAINNET]: {
+              tokenAddress: COINBASE_WRAPPED_STAKED_ETH.address,
+            },
+          },
+        },
+      },
+      {
+        ...Tokens[ChainId.BASE_GOERLI]!.COINBASE_WRAPPED_STAKED_ETH,
+        name: 'Coinbase Wrapped Staked ETH',
+        extensions: {
+          bridgeInfo: {
+            [ChainId.MAINNET]: {
+              tokenAddress: COINBASE_WRAPPED_STAKED_ETH.address,
+            },
+          },
+        },
+      },
+    ])
+  })
 })

package/src/index.ts

@@ -25,13 +25,22 @@ export async function chainify(
     ChainId.CELO,
     ChainId.BNB,
     ChainId.AVALANCHE,
+    ChainId.BASE_GOERLI,
   ]
 
   const chainified = await chainifyTokenList(l2Chains, l1TokenListOrPathOrUrl)
-  return mergeTokenLists(
+  const merged = mergeTokenLists(
     l1TokenList, // providing l1 first to make sure duplicated tokens resolve to this list
     chainified
   )
+
+  const tokenMap = {}
+  if (merged.tokens && merged.tokens.length > 0) {
+    merged.tokens.forEach((token) => {
+      tokenMap[`${token.chainId}_${token.address}`] = token
+    })
+  }
+  return { ...merged, tokenMap }
 }
 
 /**

package/src/providers/BaseGoerliMappingProvider.ts

@@ -0,0 +1,43 @@
+import { MappingProvider } from './MappingProvider'
+import { ChainId } from '../constants/chainId'
+import { getTokenList } from '../utils'
+import { GenericMappedTokenData } from '../constants/types'
+
+const baseGoerliTokenListURL =
+  'https://raw.githubusercontent.com/' +
+  'ethereum-optimism/ethereum-optimism.github.io/master/optimism.tokenlist.json'
+
+/**
+ * The Base Goerli mapping (linked above) is manually maintained by the Coinbase team
+ * in this repository: https://github.com/ethereum-optimism/ethereum-optimism.github.io.
+ */
+export class BaseGoerliMappingProvider implements MappingProvider {
+  async provide(): Promise<GenericMappedTokenData> {
+    const tokens: { [key: string]: string | undefined } = {}
+
+    let allTokens = await getTokenList(baseGoerliTokenListURL)
+
+    let opTokenId_baseGoerliAddressMap = {}
+    allTokens.tokens.forEach((token) => {
+      if (token.chainId === ChainId.BASE_GOERLI) {
+        if (typeof token.extensions?.opTokenId === 'string') {
+          opTokenId_baseGoerliAddressMap[token.extensions.opTokenId] =
+            token.address
+        }
+      }
+    })
+
+    allTokens.tokens.forEach((token) => {
+      if (
+        token.chainId === ChainId.MAINNET &&
+        typeof token.extensions?.opTokenId === 'string' &&
+        token.extensions!.opTokenId in opTokenId_baseGoerliAddressMap
+      ) {
+        tokens[token.address.toLowerCase()] =
+          opTokenId_baseGoerliAddressMap[token.extensions!.opTokenId]
+      }
+    })
+
+    return tokens
+  }
+}

package/src/providers/index.ts

@@ -21,6 +21,7 @@ import {
   MappedToken,
 } from '../constants/types'
 import { AvalancheMappingProvider } from './AvalancheMappingProvider'
+import { BaseGoerliMappingProvider } from './BaseGoerliMappingProvider'
 
 const web3 = new Web3()
 
@@ -31,6 +32,7 @@ const CHAINS_WITH_MAPPING_PROVIDERS = [
   ChainId.OPTIMISM,
   ChainId.BNB,
   ChainId.AVALANCHE,
+  ChainId.BASE_GOERLI,
 ]
 
 export async function buildList(
@@ -150,6 +152,8 @@ function getMappingProvider(chainId: ChainId, l1TokenList: TokenList) {
       return new BnbMappingProvider()
     case ChainId.AVALANCHE:
       return new AvalancheMappingProvider()
+    case ChainId.BASE_GOERLI:
+      return new BaseGoerliMappingProvider()
     default:
       throw new Error(`Chain ${chainId} not supported for fetching mappings.`)
   }

package/src/utils.ts

@@ -111,7 +111,9 @@ export function getRpcUrl(chainId: ChainId): string {
     case ChainId.BNB:
       return 'https://bsc-dataseed1.binance.org'
     case ChainId.AVALANCHE:
-      return 'https://api.avax.network/ext/bc/C/rpc' 
+      return 'https://api.avax.network/ext/bc/C/rpc'
+    case ChainId.BASE_GOERLI:
+      return 'https://goerli.base.org'
     default:
   }
   throw new Error('Unsupported ChainId')