@uniswap/token-list-bridge-utils 2.3.0 → 2.6.0

package/src/providers/BaseMappingProvider.ts

@@ -3,7 +3,7 @@ import { ChainId } from '../constants/chainId'
 import { getTokenList } from '../utils'
 import { GenericMappedTokenData } from '../constants/types'
 
-const baseGoerliTokenListURL =
+const baseTokenListURL =
   'https://raw.githubusercontent.com/' +
   'ethereum-optimism/ethereum-optimism.github.io/master/optimism.tokenlist.json'
 
@@ -15,7 +15,7 @@ export class BaseMappingProvider implements MappingProvider {
   async provide(): Promise<GenericMappedTokenData> {
     const tokens: { [key: string]: string | undefined } = {}
 
-    let allTokens = await getTokenList(baseGoerliTokenListURL)
+    let allTokens = await getTokenList(baseTokenListURL)
 
     let opTokenId_baseAddressMap: Record<string, string> = {}
     allTokens.tokens.forEach((token) => {

package/src/providers/PolygonMappingProvider.ts

@@ -1,28 +1,36 @@
 import axios from 'axios'
 import { MappingProvider } from './MappingProvider'
-import { PolygonMappedTokenData } from '../constants/types'
+import {
+  PolygonMappedTokenData,
+  PolygonTokenListResponse,
+  PolygonWrappedToken,
+} from '../constants/types'
 
-// called from https://mapper.polygon.technology
 const url =
-  'https://api-polygon-tokens.polygon.technology/api/v1/info/all-mappings'
-const access_token = '504afd90-3228-4df9-9d88-9b4d70646101'
+  'https://api-polygon-tokens.polygon.technology/tokenlists/mapped.tokenlist.json'
+
+const POS_BRIDGE_TAG = 'pos'
 
 /**
- * The Polygon team manually maintains the mapping via user submissions at
- * https://mapper.polygon.technology.
  *
  * This provider provides the l1->l2(Polygon) token mappings.
  */
 export class PolygonMappingProvider implements MappingProvider {
   async provide(): Promise<PolygonMappedTokenData> {
-    const response = await axios.get(url, {
-      headers: { 'x-access-token': access_token },
-    })
+    const response = await axios.get<PolygonTokenListResponse>(url)
     const tokens: PolygonMappedTokenData = {}
 
-    for (const token of response.data) {
-      if (token.isPos) {
-        tokens[token.rootToken.toLowerCase()] = token
+    for (const token of response.data.tokens) {
+      const posToken = token.wrappedTokens.find(
+        (wrapped: PolygonWrappedToken) => wrapped.tags.includes(POS_BRIDGE_TAG)
+      )
+
+      if (posToken) {
+        tokens[token.originTokenAddress.toLowerCase()] = {
+          rootToken: token.originTokenAddress,
+          childToken: posToken.wrappedTokenAddress,
+          isPos: true,
+        }
       }
     }
     return tokens

package/src/providers/UnichainMappingProvider.ts

@@ -0,0 +1,11 @@
+import { MappingProvider } from './MappingProvider'
+import { MappedTokenData } from '../constants/types'
+import unichainMappings from '../local_mappings/unichain.json'
+
+// we use a local source of mappings for unichain
+export class UnichainMappingProvider implements MappingProvider {
+  async provide(): Promise<MappedTokenData> {
+    const tokens = unichainMappings as MappedTokenData
+    return tokens
+  }
+}

package/src/providers/index.ts

@@ -4,6 +4,7 @@ import { ArbitrumMappingProvider } from './ArbitrumMappingProvider'
 import { OptimismMappingProvider } from './OptimismMappingProvider'
 import { PolygonMappingProvider } from './PolygonMappingProvider'
 import { BnbMappingProvider } from './BnbMappingProvider'
+import { UnichainMappingProvider } from './UnichainMappingProvider'
 import { TokenInfo, TokenList } from '@uniswap/token-lists'
 import { ethers } from 'ethers'
 import {
@@ -21,7 +22,6 @@ import {
   MappedToken,
 } from '../constants/types'
 import { AvalancheMappingProvider } from './AvalancheMappingProvider'
-import { BaseGoerliMappingProvider } from './BaseGoerliMappingProvider'
 import { BaseMappingProvider } from './BaseMappingProvider'
 import { CeloMappingProvider } from './CeloMappingProvider'
 
@@ -36,7 +36,7 @@ const CHAINS_WITH_MAPPING_PROVIDERS = [
   ChainId.AVALANCHE,
   ChainId.CELO,
   ChainId.BASE,
-  ChainId.BASE_GOERLI,
+  ChainId.UNICHAIN,
 ]
 
 export async function buildList(
@@ -160,8 +160,8 @@ function getMappingProvider(chainId: ChainId, l1TokenList: TokenList) {
       return new CeloMappingProvider()
     case ChainId.BASE:
       return new BaseMappingProvider()
-    case ChainId.BASE_GOERLI:
-      return new BaseGoerliMappingProvider()
+    case ChainId.UNICHAIN:
+      return new UnichainMappingProvider()
     default:
       throw new Error(`Chain ${chainId} not supported for fetching mappings.`)
   }
@@ -229,7 +229,9 @@ async function getChildTokenDetails(
       : undefined
     const childTokenValid = Boolean(
       childTokenAddress &&
-        (await hasExistingTokenContract(childTokenAddress, chainId))
+        (chainId === ChainId.UNICHAIN // barring a unichain rpc url, we skip the contract call. Since we're using a manually curated list of tokens, we can assume they exist.
+          ? true
+          : await hasExistingTokenContract(childTokenAddress, chainId))
     )
     const decimals =
       childToken &&

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:
@@ -118,8 +118,6 @@ export function getRpcUrl(chainId: ChainId): string {
       return 'https://alfajores-forno.celo-testnet.org/'
     case ChainId.BASE:
       return 'https://mainnet.base.org'
-    case ChainId.BASE_GOERLI:
-      return 'https://goerli.base.org'
     default:
   }
   throw new Error('Unsupported ChainId')

package/dist/providers/BaseGoerliMappingProvider.d.ts

@@ -1,9 +0,0 @@
-import { MappingProvider } from './MappingProvider';
-import { GenericMappedTokenData } from '../constants/types';
-/**
- * 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 declare class BaseGoerliMappingProvider implements MappingProvider {
-    provide(): Promise<GenericMappedTokenData>;
-}

package/src/providers/BaseGoerliMappingProvider.ts

@@ -1,43 +0,0 @@
-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: Record<string, string> = {}
-    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
-  }
-}