Remove default tokens list, change vetted to allowlisted (#3678)

* Remove default tokens list, change vetted to allowlisted - Removed the old default tokens list as it's no longer used in the UI. In the future we may add a special list. - Renamed the vetted list to allowlisted to be consistent with tokenlists repo and other places that we allow tokens. As vetted was ambiguous if it represents all allowlisted tokens or a hand picked "vetted" set of them. * Make Faucet table use allowlist * Change name to balancerTokenList * Fix type error * Fix token list provider tests * Fix Avalanche and Sepolia * Fix fake tokenlist tests
Sobal · Jul 30, 2023 · 0e12f6d · 0e12f6d
1 parent 73a27eb
commit 0e12f6d
Show file tree

Hide file tree

Showing 17 changed files with 34 additions and 116 deletions.
diff --git a/src/components/tables/FaucetTable/FaucetTable.vue b/src/components/tables/FaucetTable/FaucetTable.vue
@@ -17,11 +17,11 @@ import { useTokens } from '@/providers/tokens.provider';
 const { t } = useI18n();
 const { upToLargeBreakpoint } = useBreakpoints();
 const { fNum } = useNumbers();
-const { defaultTokenList } = useTokenLists();
+const { balancerTokenList } = useTokenLists();
 const { priceFor, balanceFor } = useTokens();
 
 const tokens = computed(() => {
-  const tokensWithValues = Object.values(defaultTokenList.value.tokens)
+  const tokensWithValues = Object.values(balancerTokenList.value.tokens)
     .map(token => {
       const balance = balanceFor(token.address);
       const price = priceFor(token.address);

diff --git a/src/composables/useDisabledJoinPool.ts b/src/composables/useDisabledJoinPool.ts
@@ -35,10 +35,10 @@ function doesRequireAllowListing(pool: Pool, account: string): boolean {
 
 export function useDisabledJoinPool(pool: Pool) {
   const { account } = useWeb3();
-  const { vettedTokenList } = useTokenLists();
+  const { balancerTokenList } = useTokenLists();
 
   const notVettedTokens = computed(() => {
-    const vettedTokenAddresses = vettedTokenList.value.tokens.map(
+    const vettedTokenAddresses = balancerTokenList.value.tokens.map(
       t => t.address
     );
 

diff --git a/src/lib/config/arbitrum/tokenlists.ts b/src/lib/config/arbitrum/tokenlists.ts
@@ -2,9 +2,7 @@ import { TokenListURLMap } from '@/types/TokenList';
 
 const tokenlists: TokenListURLMap = {
   Balancer: {
-    Default:
-      'https://raw.githubusercontent.com/balancer/tokenlists/main/generated/listed-old.tokenlist.json',
-    Vetted:
+    Allowlisted:
       'https://raw.githubusercontent.com/balancer/tokenlists/main/generated/balancer.tokenlist.json',
   },
   External: [],

diff --git a/src/lib/config/gnosis-chain/tokenlists.ts b/src/lib/config/gnosis-chain/tokenlists.ts
@@ -2,9 +2,7 @@ import { TokenListURLMap } from '@/types/TokenList';
 
 const tokenlists: TokenListURLMap = {
   Balancer: {
-    Default:
-      'https://raw.githubusercontent.com/balancer/tokenlists/main/generated/listed-old.tokenlist.json',
-    Vetted:
+    Allowlisted:
       'https://raw.githubusercontent.com/balancer/tokenlists/main/generated/balancer.tokenlist.json',
   },
   External: [

diff --git a/src/lib/config/goerli/tokenlists.ts b/src/lib/config/goerli/tokenlists.ts
@@ -2,9 +2,7 @@ import { TokenListURLMap } from '@/types/TokenList';
 
 const tokenlists: TokenListURLMap = {
   Balancer: {
-    Default:
-      'https://raw.githubusercontent.com/balancer/tokenlists/main/generated/listed-old.tokenlist.json',
-    Vetted:
+    Allowlisted:
       'https://raw.githubusercontent.com/balancer/tokenlists/main/generated/balancer.tokenlist.json',
   },
   External: [],

diff --git a/src/lib/config/mainnet/tokenlists.ts b/src/lib/config/mainnet/tokenlists.ts
@@ -2,9 +2,7 @@ import { TokenListURLMap } from '@/types/TokenList';
 
 const tokenlists: TokenListURLMap = {
   Balancer: {
-    Default:
-      'https://raw.githubusercontent.com/balancer/tokenlists/main/generated/listed-old.tokenlist.json',
-    Vetted:
+    Allowlisted:
       'https://raw.githubusercontent.com/balancer/tokenlists/main/generated/balancer.tokenlist.json',
   },
   External: [

diff --git a/src/lib/config/neon-devnet/tokenlists.ts b/src/lib/config/neon-devnet/tokenlists.ts
@@ -2,9 +2,7 @@ import { TokenListURLMap } from '@/types/TokenList';
 
 const tokenlists: TokenListURLMap = {
   Balancer: {
-    Default:
-      'https://raw.githubusercontent.com/neonlabsorg/token-list/main/tokenlist.json',
-    Vetted:
+    Allowlisted:
       'https://raw.githubusercontent.com/neonlabsorg/token-list/main/tokenlist.json',
   },
   External: [],

diff --git a/src/lib/config/neon-mainnet/tokenlists.ts b/src/lib/config/neon-mainnet/tokenlists.ts
@@ -2,9 +2,7 @@ import { TokenListURLMap } from '@/types/TokenList';
 
 const tokenlists: TokenListURLMap = {
   Balancer: {
-    Default:
-      'https://raw.githubusercontent.com/neonlabsorg/token-list/main/tokenlist.json',
-    Vetted:
+    Allowlisted:
       'https://raw.githubusercontent.com/neonlabsorg/token-list/main/tokenlist.json',
   },
   External: [],

diff --git a/src/lib/config/optimism/tokenlists.ts b/src/lib/config/optimism/tokenlists.ts
@@ -2,8 +2,7 @@ import { TokenListURLMap } from '@/types/TokenList';
 
 const tokenlists: TokenListURLMap = {
   Balancer: {
-    Default: '',
-    Vetted: '',
+    Allowlisted: '',
   },
   External: [],
 };

diff --git a/src/lib/config/polygon/tokenlists.ts b/src/lib/config/polygon/tokenlists.ts
@@ -2,9 +2,7 @@ import { TokenListURLMap } from '@/types/TokenList';
 
 const tokenlists: TokenListURLMap = {
   Balancer: {
-    Default:
-      'https://raw.githubusercontent.com/balancer/tokenlists/main/generated/listed-old.tokenlist.json',
-    Vetted:
+    Allowlisted:
       'https://raw.githubusercontent.com/balancer/tokenlists/main/generated/balancer.tokenlist.json',
   },
   External: [

diff --git a/src/lib/config/zkevm/tokenlists.ts b/src/lib/config/zkevm/tokenlists.ts
@@ -2,9 +2,7 @@ import { TokenListURLMap } from '@/types/TokenList';
 
 const tokenlists: TokenListURLMap = {
   Balancer: {
-    Default:
-      'https://raw.githubusercontent.com/balancer/tokenlists/main/generated/balancer.tokenlist.json',
-    Vetted:
+    Allowlisted:
       'https://raw.githubusercontent.com/balancer/tokenlists/main/generated/balancer.tokenlist.json',
   },
   External: [],

diff --git a/src/providers/__mocks__/tokens.provider.fake.spec.ts b/src/providers/__mocks__/tokens.provider.fake.spec.ts
@@ -55,12 +55,12 @@ test('Fakes provided state', async () => {
 
   expect(wrappedNativeAsset.value.address).toBe(wethAddress);
 
-  expect(Object.keys(activeTokenListTokens.value)).toHaveLength(12);
+  expect(Object.keys(activeTokenListTokens.value)).toHaveLength(16);
   expect(Object.keys(activeTokenListTokens.value)).toEqual(
     expect.arrayContaining([])
   );
 
-  expect(Object.keys(balancerTokenListTokens.value)).toHaveLength(21);
+  expect(Object.keys(balancerTokenListTokens.value)).toHaveLength(16);
 
   expect(Object.keys(prices.value)).toHaveLength(2);
   expect(Object.keys(balances.value)).toHaveLength(2);

diff --git a/src/providers/token-lists.provider.spec.ts b/src/providers/token-lists.provider.spec.ts
@@ -23,81 +23,27 @@ describe('Token lists provider should', () => {
 
     expect(firstTokenListSymbols(result.activeTokenLists.value)).toEqual([
       'BAL',
-      'DAI',
-      'USDT',
-      'USDC',
-      'WETH',
-      'WBTC',
-      'miMATIC',
-      // Explicitly added to test tokens-5.json to simplify testing:
-      'bb-a-USD',
-      'bb-a-USDT',
-      'test-pool-symbol',
       'bb-a-DAI',
-      'GRO',
-    ]);
-  });
-
-  test('provide approved TokenList', async () => {
-    const { result } = mountComposableWithTokenLists();
-    expect(firstTokenListSymbols(result.approvedTokenLists.value)).toEqual([
-      'BAL',
-      'DAI',
-      'USDT',
-      'USDC',
-      'WETH',
-      'WBTC',
-      'miMATIC',
-      // Explicitly added to test tokens-5.json to simplify testing:
-      'bb-a-USD',
+      'bb-a-USDC',
       'bb-a-USDT',
-      'test-pool-symbol',
-      'bb-a-DAI',
-      'GRO',
-    ]);
-  });
-
-  test('provide balancer TokenList', async () => {
-    const { result } = mountComposableWithTokenLists();
-    expect(firstTokenListSymbols(result.balancerTokenLists.value)).toEqual([
-      'BAL',
-      'DAI',
-      'USDT',
-      'USDC',
-      'WETH',
-      'WBTC',
-      'miMATIC',
-      // Explicitly added to test tokens-5.json to simplify testing:
       'bb-a-USD',
-      'bb-a-USDT',
-      'test-pool-symbol',
-      'bb-a-DAI',
-      'GRO',
-    ]);
-  });
-
-  test('provide default TokenList', async () => {
-    const { result } = mountComposableWithTokenLists();
-    expect(tokenListSymbols(result.defaultTokenList.value)).toEqual([
-      'BAL',
       'DAI',
+      'FEI',
+      'GNO',
       'USDT',
       'USDC',
       'WETH',
       'WBTC',
-      'miMATIC',
-      // Explicitly added to test tokens-5.json to simplify testing:
-      'bb-a-USD',
-      'bb-a-USDT',
-      'test-pool-symbol',
-      'bb-a-DAI',
+      'aDAI',
+      'aUSDC',
+      'aUSDT',
       'GRO',
     ]);
   });
 
-  test('provide vetted TokenList', async () => {
+  test('provide balancer TokenList', async () => {
     const { result } = mountComposableWithTokenLists();
-    expect(tokenListSymbols(result.vettedTokenList.value)).toEqual([
+    expect(tokenListSymbols(result.balancerTokenList.value)).toEqual([
       'BAL',
       'bb-a-DAI',
       'bb-a-USDC',

diff --git a/src/providers/token-lists.provider.ts b/src/providers/token-lists.provider.ts
@@ -32,7 +32,7 @@ const { networkId } = useNetwork();
  * STATE
  */
 const state: TokenListsState = reactive({
-  activeListKeys: [uris.Balancer.Default],
+  activeListKeys: [uris.Balancer.Allowlisted],
 });
 
 const allTokenLists = ref({});
@@ -50,17 +50,10 @@ const activeTokenLists = computed(
 );
 
 /**
- * The default Balancer token list.
+ * All allowlisted tokens from tokenlists repo
  */
-const defaultTokenList = computed(
-  (): TokenList => allTokenLists.value[uris.Balancer.Default]
-);
-
-/**
- * The Balancer vetted token list, contains LBP tokens.
- */
-const vettedTokenList = computed(
-  (): TokenList => allTokenLists.value[uris.Balancer.Vetted]
+const balancerTokenList = computed(
+  (): TokenList => allTokenLists.value[uris.Balancer.Allowlisted]
 );
 
 /**
@@ -128,10 +121,9 @@ export const tokenListsProvider = () => {
     // computed
     allTokenLists,
     activeTokenLists,
-    defaultTokenList,
     balancerTokenLists,
     approvedTokenLists,
-    vettedTokenList,
+    balancerTokenList,
     // methods
     toggleTokenList,
     isActiveList,

diff --git a/src/providers/tokens.provider.ts b/src/providers/tokens.provider.ts
@@ -273,7 +273,7 @@ export const tokensProvider = (
 
     const newTokens = await new TokenService().metadata.get(
       injectable,
-      omit(allTokenLists.value, tokenListUris.Balancer.Default)
+      omit(allTokenLists.value, tokenListUris.Balancer.Allowlisted)
     );
 
     state.injectedTokens = { ...state.injectedTokens, ...newTokens };

diff --git a/src/services/token-list/token-list.service.ts b/src/services/token-list/token-list.service.ts
@@ -11,10 +11,8 @@ interface TokenListUris {
   All: string[];
   Balancer: {
     All: string[];
-    // Compliant list for exchange
-    Default: string;
-    // Extended list to include LBP tokens
-    Vetted: string;
+    // Allowlisted tokens list from tokenslist repo
+    Allowlisted: string;
   };
   Approved: string[];
   External: string[];
@@ -36,9 +34,9 @@ export default class TokenListService {
       this.appNetwork
     ).tokenlists;
 
-    const balancerLists = [Balancer.Default, Balancer.Vetted];
+    const balancerLists = [Balancer.Allowlisted];
     const All = [...balancerLists, ...External];
-    const Approved = [Balancer.Default, ...External];
+    const Approved = [Balancer.Allowlisted, ...External];
 
     return {
       All,

diff --git a/src/types/TokenList.ts b/src/types/TokenList.ts
@@ -44,8 +44,7 @@ export type TokenInfoMap = Record<string, TokenInfo>;
 
 export interface TokenListURLMap {
   Balancer: {
-    Default: string;
-    Vetted: string;
+    Allowlisted: string;
   };
   External: string[];
 }