@uniswap/token-list-bridge-utils 1.0.5 → 1.0.8

package/src/abis/erc20.ts

@@ -0,0 +1,226 @@
+import { AbiItem } from 'web3-utils'
+
+const abi: AbiItem[] = [
+  {
+    constant: true,
+    inputs: [],
+    name: 'name',
+    outputs: [
+      {
+        name: '',
+        type: 'string',
+      },
+    ],
+    payable: false,
+    stateMutability: 'view',
+    type: 'function',
+  },
+  {
+    constant: false,
+    inputs: [
+      {
+        name: '_spender',
+        type: 'address',
+      },
+      {
+        name: '_value',
+        type: 'uint256',
+      },
+    ],
+    name: 'approve',
+    outputs: [
+      {
+        name: '',
+        type: 'bool',
+      },
+    ],
+    payable: false,
+    stateMutability: 'nonpayable',
+    type: 'function',
+  },
+  {
+    constant: true,
+    inputs: [],
+    name: 'totalSupply',
+    outputs: [
+      {
+        name: '',
+        type: 'uint256',
+      },
+    ],
+    payable: false,
+    stateMutability: 'view',
+    type: 'function',
+  },
+  {
+    constant: false,
+    inputs: [
+      {
+        name: '_from',
+        type: 'address',
+      },
+      {
+        name: '_to',
+        type: 'address',
+      },
+      {
+        name: '_value',
+        type: 'uint256',
+      },
+    ],
+    name: 'transferFrom',
+    outputs: [
+      {
+        name: '',
+        type: 'bool',
+      },
+    ],
+    payable: false,
+    stateMutability: 'nonpayable',
+    type: 'function',
+  },
+  {
+    constant: true,
+    inputs: [],
+    name: 'decimals',
+    outputs: [
+      {
+        name: '',
+        type: 'uint8',
+      },
+    ],
+    payable: false,
+    stateMutability: 'view',
+    type: 'function',
+  },
+  {
+    constant: true,
+    inputs: [
+      {
+        name: '_owner',
+        type: 'address',
+      },
+    ],
+    name: 'balanceOf',
+    outputs: [
+      {
+        name: 'balance',
+        type: 'uint256',
+      },
+    ],
+    payable: false,
+    stateMutability: 'view',
+    type: 'function',
+  },
+  {
+    constant: true,
+    inputs: [],
+    name: 'symbol',
+    outputs: [
+      {
+        name: '',
+        type: 'string',
+      },
+    ],
+    payable: false,
+    stateMutability: 'view',
+    type: 'function',
+  },
+  {
+    constant: false,
+    inputs: [
+      {
+        name: '_to',
+        type: 'address',
+      },
+      {
+        name: '_value',
+        type: 'uint256',
+      },
+    ],
+    name: 'transfer',
+    outputs: [
+      {
+        name: '',
+        type: 'bool',
+      },
+    ],
+    payable: false,
+    stateMutability: 'nonpayable',
+    type: 'function',
+  },
+  {
+    constant: true,
+    inputs: [
+      {
+        name: '_owner',
+        type: 'address',
+      },
+      {
+        name: '_spender',
+        type: 'address',
+      },
+    ],
+    name: 'allowance',
+    outputs: [
+      {
+        name: '',
+        type: 'uint256',
+      },
+    ],
+    payable: false,
+    stateMutability: 'view',
+    type: 'function',
+  },
+  {
+    payable: true,
+    stateMutability: 'payable',
+    type: 'fallback',
+  },
+  {
+    anonymous: false,
+    inputs: [
+      {
+        indexed: true,
+        name: 'owner',
+        type: 'address',
+      },
+      {
+        indexed: true,
+        name: 'spender',
+        type: 'address',
+      },
+      {
+        indexed: false,
+        name: 'value',
+        type: 'uint256',
+      },
+    ],
+    name: 'Approval',
+    type: 'event',
+  },
+  {
+    anonymous: false,
+    inputs: [
+      {
+        indexed: true,
+        name: 'from',
+        type: 'address',
+      },
+      {
+        indexed: true,
+        name: 'to',
+        type: 'address',
+      },
+      {
+        indexed: false,
+        name: 'value',
+        type: 'uint256',
+      },
+    ],
+    name: 'Transfer',
+    type: 'event',
+  },
+]
+
+export default abi

package/src/arbitrum/set_rpc.ts

@@ -1,6 +1,7 @@
 import { config } from 'dotenv'
+import { ChainId } from '../constants/chainId'
+import { getRpcUrl } from '../utils'
 
-// fall back to https://cloudflare-eth.com/ if MAINNET_RPC not provided in an .env file
+// MAINNET_RPC value is required for arb-sdk. fall back to https://cloudflare-eth.com/ if MAINNET_RPC not provided in an .env file
 config()
-process.env.MAINNET_RPC =
-  process.env.MAINNET_RPC || 'https://cloudflare-eth.com/'
+process.env.MAINNET_RPC ??= getRpcUrl(ChainId.MAINNET)

package/src/index.test.ts

@@ -1,7 +1,6 @@
 import { TokenInfo } from '@uniswap/token-lists'
 import { chainify, chainifyTokenList, mergeTokenLists } from '.'
 import { ChainId } from './constants/chainId'
-import { ArbitrumMappingProvider } from './providers/ArbitrumMappingProvider'
 import {
   DAI,
   DAI_ARBITRUM_ONE,
@@ -237,4 +236,4 @@ describe(chainify, () => {
       },
     ])
   })
-})
+})

package/src/providers/index.ts

@@ -1,15 +1,26 @@
 import { ChainId } from '../constants/chainId'
+import { Contract } from 'web3-eth-contract'
 import { ArbitrumMappingProvider } from './ArbitrumMappingProvider'
 import { OptimismMappingProvider } from './OptimismMappingProvider'
 import { PolygonMappingProvider } from './PolygonMappingProvider'
 import { TokenInfo, TokenList } from '@uniswap/token-lists'
-import { compareTokenInfos } from '../utils'
 import { ethers } from 'ethers'
+import {
+  compareTokenInfos,
+  getRpcUrl,
+  getTokenSymbolFromContract,
+} from '../utils'
+import ERC20Abi from '../abis/erc20'
+// TODO: use ethers for contract calls (without performance reduction).
+import Web3 from 'web3'
+
+const web3 = new Web3()
 
 export async function buildList(
   chainId: ChainId,
   l1TokenList: TokenList
 ): Promise<TokenList> {
+  web3.setProvider(getRpcUrl(chainId))
   const tokenAddressMap = await getMappingProvider(
     chainId,
     l1TokenList
@@ -17,9 +28,15 @@ export async function buildList(
   const mappedTokens = []
   for (const rootToken of l1TokenList.tokens) {
     const childToken = tokenAddressMap[rootToken.address.toLowerCase()]
+    const childTokenAddress = childToken
+      ? ethers.utils.getAddress(
+          typeof childToken === 'object' ? childToken.child_token : childToken
+        )
+      : undefined
     const childTokenValid = Boolean(
-      childToken &&
-        (typeof childToken === 'object' ? !childToken.deleted : true)
+      childTokenAddress &&
+        (typeof childToken === 'object' ? !childToken.deleted : true) &&
+        (await hasExistingTokenContract(childTokenAddress, chainId))
     )
 
     if (rootToken.chainId === ChainId.MAINNET) {
@@ -41,11 +58,7 @@ export async function buildList(
             extensions: {
               bridgeInfo: {
                 [chainId]: {
-                  tokenAddress: ethers.utils.getAddress(
-                    typeof childToken === 'object'
-                      ? childToken.child_token
-                      : childToken!
-                  ),
+                  tokenAddress: childTokenAddress,
                 },
               },
             },
@@ -61,11 +74,7 @@ export async function buildList(
         const childTokenInfo: TokenInfo = {
           ...rootToken,
           chainId: chainId,
-          address: ethers.utils.getAddress(
-            typeof childToken === 'object'
-              ? childToken.child_token
-              : childToken!
-          ),
+          address: childTokenAddress,
           ...toRootExtensions,
         } as unknown as TokenInfo
         mappedTokens.push(childTokenInfo)
@@ -83,6 +92,17 @@ export async function buildList(
   return tokenList
 }
 
+// using a symbol lookup contract call to check whether the token exists on the L2
+async function hasExistingTokenContract(address: string, chainId: ChainId) {
+  try {
+    const contract: Contract = new web3.eth.Contract(ERC20Abi, address)
+    await getTokenSymbolFromContract(contract)
+  } catch {
+    return false
+  }
+  return true
+}
+
 function getMappingProvider(chainId: ChainId, l1TokenList: TokenList) {
   switch (chainId) {
     case ChainId.ARBITRUM_ONE:

package/src/utils.ts

@@ -1,6 +1,8 @@
 import { TokenInfo, TokenList } from '@uniswap/token-lists'
 import { readFileSync, existsSync } from 'fs'
 import axios from 'axios'
+import { ChainId } from './constants/chainId'
+import { Contract } from 'web3-eth-contract'
 
 export type TokenListOrFetchableTokenList = TokenList | string
 
@@ -89,3 +91,29 @@ export const isTokenList = (obj: any) => {
     throw new Error('tokenlist typeguard error: token missing required key')
   }
 }
+
+export function getRpcUrl(chainId: ChainId): string {
+  switch (chainId) {
+    case ChainId.MAINNET:
+      return 'https://cloudflare-eth.com/'
+    case ChainId.OPTIMISM:
+      return 'https://mainnet.optimism.io'
+    case ChainId.OPTIMISTIC_KOVAN:
+      return 'https://kovan.optimism.io'
+    case ChainId.ARBITRUM_ONE:
+      return 'https://arb1.arbitrum.io/rpc'
+    case ChainId.ARBITRUM_RINKEBY:
+      return 'https://rinkeby.arbitrum.io/rpc'
+    case ChainId.POLYGON:
+      return 'https://polygon-rpc.com/'
+    case ChainId.POLYGON_MUMBAI:
+      return 'https://rpc-endpoints.superfluid.dev/mumbai'
+    default:
+  }
+  throw new Error('Unsupported ChainId')
+}
+
+export async function getTokenSymbolFromContract(tokenContract: Contract) {
+  const symbol = await Promise.all([tokenContract.methods.symbol().call()])
+  return symbol
+}