@uniswap/token-list-bridge-utils 1.1.1 → 1.3.0

package/src/providers/BnbMappingProvider.ts

@@ -0,0 +1,11 @@
+import { MappingProvider } from './MappingProvider'
+import { BnbMappedTokenData, GenericMappedTokenData } from '../constants/types'
+import bnbmappings from '../local_mappings/bnb.json'
+
+// barring a better external source, we use a local source of mappings for bnb
+export class BnbMappingProvider implements MappingProvider {
+  async provide(): Promise<BnbMappedTokenData> {
+    const tokens = bnbmappings as BnbMappedTokenData
+    return tokens
+  }
+}

package/src/providers/MappingProvider.ts

@@ -1,7 +1,11 @@
-import { GenericMappedTokenData, PolygonMappedTokenData } from '../constants/types'
+import {
+  BnbMappedTokenData,
+  GenericMappedTokenData,
+  PolygonMappedTokenData,
+} from '../constants/types'
 
 export interface MappingProvider {
   provide(): Promise<
-    PolygonMappedTokenData | GenericMappedTokenData
+    PolygonMappedTokenData | GenericMappedTokenData | BnbMappedTokenData
   >
 }

package/src/providers/index.ts

@@ -3,6 +3,7 @@ import { Contract } from 'web3-eth-contract'
 import { ArbitrumMappingProvider } from './ArbitrumMappingProvider'
 import { OptimismMappingProvider } from './OptimismMappingProvider'
 import { PolygonMappingProvider } from './PolygonMappingProvider'
+import { BnbMappingProvider } from './BnbMappingProvider'
 import { TokenInfo, TokenList } from '@uniswap/token-lists'
 import { ethers } from 'ethers'
 import {
@@ -16,6 +17,8 @@ import Web3 from 'web3'
 import {
   GenericMappedTokenData,
   PolygonMappedTokenData,
+  BnbMappedTokenData,
+  BnbMappedToken,
 } from '../constants/types'
 
 const web3 = new Web3()
@@ -25,6 +28,7 @@ const SUPPORTED_L2_CHAINS = [
   ChainId.ARBITRUM_ONE,
   ChainId.POLYGON,
   ChainId.OPTIMISM,
+  ChainId.BNB,
 ]
 
 export async function buildList(
@@ -42,6 +46,7 @@ export async function buildList(
         [key: number]: {
           childTokenValid: boolean
           childTokenAddress: string | undefined
+          decimals?: number
         }
       } = {}
       const l2MappingExtension = {
@@ -86,6 +91,9 @@ export async function buildList(
                 } as unknown as TokenInfo)
               : ({
                   ...l1Token,
+                  decimals:
+                    chainIdToChildTokenDetailsMap[chainId].decimals ??
+                    l1Token.decimals,
                   chainId: chainId,
                   address:
                     chainIdToChildTokenDetailsMap[chainId].childTokenAddress,
@@ -136,6 +144,8 @@ function getMappingProvider(chainId: ChainId, l1TokenList: TokenList) {
       return new OptimismMappingProvider()
     case ChainId.POLYGON:
       return new PolygonMappingProvider()
+    case ChainId.BNB:
+      return new BnbMappingProvider()
     default:
       throw new Error(`Chain ${chainId} not supported for fetching mappings.`)
   }
@@ -146,7 +156,10 @@ async function generateTokenMappings(
   l1TokenList: TokenList
 ) {
   const chainIdToMappingsMap: {
-    [key: number]: PolygonMappedTokenData | GenericMappedTokenData
+    [key: number]:
+      | PolygonMappedTokenData
+      | GenericMappedTokenData
+      | BnbMappedTokenData
   } = {}
 
   for (const chainId of chainIds) {
@@ -166,11 +179,15 @@ async function getChildTokenDetails(
   l1Token: TokenInfo,
   chainId: ChainId,
   chainIdToMappingsMap: {
-    [key: number]: PolygonMappedTokenData | GenericMappedTokenData
+    [key: number]:
+      | PolygonMappedTokenData
+      | GenericMappedTokenData
+      | BnbMappedTokenData
   }
 ): Promise<{
   childTokenValid: boolean
   childTokenAddress: string | undefined
+  decimals?: number | undefined
 }> {
   const existingMapping: undefined | string =
     l1Token?.extensions?.bridgeInfo?.[chainId]?.tokenAddress
@@ -189,9 +206,14 @@ async function getChildTokenDetails(
       childTokenAddress &&
         (await hasExistingTokenContract(childTokenAddress, chainId))
     )
+    const decimals =
+      chainId === ChainId.BNB
+        ? (childToken as BnbMappedToken).decimals
+        : undefined
     return {
       childTokenValid: childTokenValid,
       childTokenAddress: childTokenAddress,
+      decimals: decimals,
     }
   }
   return {

package/src/utils.ts

@@ -108,6 +108,8 @@ export function getRpcUrl(chainId: ChainId): string {
       return 'https://polygon-rpc.com/'
     case ChainId.POLYGON_MUMBAI:
       return 'https://rpc-endpoints.superfluid.dev/mumbai'
+    case ChainId.BNB:
+      return 'https://bsc-dataseed1.binance.org'
     default:
   }
   throw new Error('Unsupported ChainId')