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

package/src/fixtures/index.ts

@@ -4,14 +4,18 @@ import { ChainId } from '../constants/chainId'
 import {
   DAI,
   DAI_ARBITRUM_ONE,
+  DAI_BNB,
   DAI_OPTIMISM,
   DAI_POLYGON,
+  USDT,
+  USDT_BNB,
 } from '../constants/tokens'
 import { compareTokenInfos } from '../utils'
 
 export const Tokens: Partial<Record<ChainId, Record<string, TokenInfo>>> = {
   [ChainId.MAINNET]: {
     DAI: tokenToTokenInfo(DAI),
+    USDT: tokenToTokenInfo(USDT),
   },
   [ChainId.ARBITRUM_ONE]: {
     DAI: tokenToTokenInfo(DAI_ARBITRUM_ONE),
@@ -22,6 +26,10 @@ export const Tokens: Partial<Record<ChainId, Record<string, TokenInfo>>> = {
   [ChainId.OPTIMISM]: {
     DAI: tokenToTokenInfo(DAI_OPTIMISM),
   },
+  [ChainId.BNB]: {
+    DAI: tokenToTokenInfo(DAI_BNB),
+    USDT: tokenToTokenInfo(USDT_BNB),
+  },
 }
 
 export const sampleL1TokenList: TokenList = {
@@ -35,6 +43,17 @@ export const sampleL1TokenList: TokenList = {
   tokens: [Tokens[ChainId.MAINNET]!.DAI],
 }
 
+export const sampleL1TokenList_2: TokenList = {
+  name: 'Sample_2',
+  timestamp: new Date(1646146610).toISOString(),
+  version: {
+    major: 1,
+    minor: 0,
+    patch: 0,
+  },
+  tokens: [Tokens[ChainId.MAINNET]!.USDT],
+}
+
 export const arbBridgeL2Address = '0x467194771dae2967aef3ecbedd3bf9a310c76c65'
 export const arbBridgeL1Address = '0xd3b5b60020504bc3489d6949d545893982ba3011'
 
@@ -95,6 +114,60 @@ export const polygonedSampleTokenList = {
   ].sort(compareTokenInfos),
 }
 
+export const bnbedSampleTokenList = {
+  ...sampleL1TokenList,
+  name: 'BNBed Sample',
+  tokens: [
+    {
+      ...Tokens[ChainId.BNB]!.DAI,
+      extensions: {
+        bridgeInfo: {
+          [ChainId.MAINNET]: {
+            tokenAddress: DAI.address,
+          },
+        },
+      },
+    } as unknown as TokenInfo,
+    {
+      ...(Tokens[ChainId.MAINNET]!.DAI as unknown as TokenInfo),
+      extensions: {
+        bridgeInfo: {
+          [ChainId.BNB]: {
+            tokenAddress: DAI_BNB.address,
+          },
+        },
+      },
+    } as unknown as TokenInfo,
+  ].sort(compareTokenInfos),
+}
+
+export const bnbedSampleTokenList_2 = {
+  ...sampleL1TokenList_2,
+  name: 'BNBed Sample_2',
+  tokens: [
+    {
+      ...Tokens[ChainId.BNB]!.USDT,
+      extensions: {
+        bridgeInfo: {
+          [ChainId.MAINNET]: {
+            tokenAddress: USDT.address,
+          },
+        },
+      },
+    } as unknown as TokenInfo,
+    {
+      ...(Tokens[ChainId.MAINNET]!.USDT as unknown as TokenInfo),
+      extensions: {
+        bridgeInfo: {
+          [ChainId.BNB]: {
+            tokenAddress: USDT_BNB.address,
+          },
+        },
+      },
+    } as unknown as TokenInfo,
+  ].sort(compareTokenInfos),
+}
+
 export const optimizedSampleTokenList = {
   ...sampleL1TokenList,
   name: 'Optimized Sample',

package/src/index.test.ts

@@ -4,6 +4,7 @@ import { ChainId } from './constants/chainId'
 import {
   DAI,
   DAI_ARBITRUM_ONE,
+  DAI_BNB,
   DAI_OPTIMISM,
   DAI_POLYGON,
 } from './constants/tokens'
@@ -11,8 +12,11 @@ import {
   arbedSampleTokenList,
   optimizedSampleTokenList,
   polygonedSampleTokenList,
+  bnbedSampleTokenList,
   sampleL1TokenList,
   Tokens,
+  sampleL1TokenList_2,
+  bnbedSampleTokenList_2,
 } from './fixtures'
 
 jest.setTimeout(15000)
@@ -83,6 +87,34 @@ describe(chainifyTokenList, () => {
   })
 })
 
+it('outputs bnb list correctly', async () => {
+  const tokenList = await chainifyTokenList([ChainId.BNB], sampleL1TokenList)
+  expect(tokenList).toBeDefined()
+  expect(tokenList?.version).toEqual(bnbedSampleTokenList.version)
+  expect(
+    tokenList?.tokens.map((t) => [t.address, t.chainId, t.extensions])
+  ).toEqual(
+    // ignores other metadata
+    bnbedSampleTokenList.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()
+  expect(tokenList?.version).toEqual(bnbedSampleTokenList_2.version)
+  expect(
+    tokenList?.tokens.map((t) => [t.address, t.chainId, t.extensions])
+  ).toEqual(
+    // ignores other metadata
+    bnbedSampleTokenList_2.tokens.map((t) => [
+      t.address,
+      t.chainId,
+      t.extensions,
+    ])
+  )
+})
+
 describe(mergeTokenLists, () => {
   it('correctly deduplicates', () => {
     const merged = mergeTokenLists(sampleL1TokenList, sampleL1TokenList)
@@ -186,6 +218,9 @@ describe(chainify, () => {
         ...Tokens[ChainId.MAINNET]!.DAI,
         extensions: {
           bridgeInfo: {
+            [ChainId.BNB]: {
+              tokenAddress: DAI_BNB.address,
+            },
             [ChainId.OPTIMISM]: {
               tokenAddress: DAI_OPTIMISM.address,
             },
@@ -211,6 +246,16 @@ describe(chainify, () => {
           },
         },
       },
+      {
+        ...Tokens[ChainId.BNB]!.DAI,
+        extensions: {
+          bridgeInfo: {
+            [ChainId.MAINNET]: {
+              tokenAddress: DAI.address,
+            },
+          },
+        },
+      },
       {
         ...Tokens[ChainId.POLYGON]!.DAI,
         extensions: {

package/src/index.ts

@@ -23,6 +23,7 @@ export async function chainify(
     ChainId.ARBITRUM_ONE,
     ChainId.OPTIMISM,
     ChainId.CELO,
+    ChainId.BNB,
   ]
 
   const chainified = await chainifyTokenList(l2Chains, l1TokenListOrPathOrUrl)