Adding TokenListController to fetch the token list from token services API

src/apis/token-service.test.ts

@@ -0,0 +1,179 @@
+import nock from 'nock';
+import { NetworksChainId } from '../network/NetworkController';
+import {
+  fetchTokenList,
+  syncTokens,
+  fetchTokenMetadata,
+} from './token-service';
+
+const TOKEN_END_POINT_API = 'https://token-api.airswap-prod.codefi.network';
+
+const sampleTokenList = [
+  {
+    address: '0xbbbbca6a901c926f240b89eacb641d8aec7aeafd',
+    symbol: 'LRC',
+    decimals: 18,
+    occurances: 11,
+    aggregators: [
+      'paraswap',
+      'pmm',
+      'airswapLight',
+      'zeroEx',
+      'bancor',
+      'coinGecko',
+      'zapper',
+      'kleros',
+      'zerion',
+      'cmc',
+      'oneInch',
+    ],
+  },
+  {
+    address: '0xc011a73ee8576fb46f5e1c5751ca3b9fe0af2a6f',
+    symbol: 'SNX',
+    decimals: 18,
+    occurances: 11,
+    aggregators: [
+      'paraswap',
+      'pmm',
+      'airswapLight',
+      'zeroEx',
+      'bancor',
+      'coinGecko',
+      'zapper',
+      'kleros',
+      'zerion',
+      'cmc',
+      'oneInch',
+    ],
+    name: 'Synthetix',
+  },
+  {
+    address: '0x408e41876cccdc0f92210600ef50372656052a38',
+    symbol: 'REN',
+    decimals: 18,
+    occurances: 11,
+    aggregators: [
+      'paraswap',
+      'pmm',
+      'airswapLight',
+      'zeroEx',
+      'bancor',
+      'coinGecko',
+      'zapper',
+      'kleros',
+      'zerion',
+      'cmc',
+      'oneInch',
+    ],
+  },
+  {
+    address: '0x514910771af9ca656af840dff83e8264ecf986ca',
+    symbol: 'LINK',
+    decimals: 18,
+    occurances: 11,
+    aggregators: [
+      'paraswap',
+      'pmm',
+      'airswapLight',
+      'zeroEx',
+      'bancor',
+      'coinGecko',
+      'zapper',
+      'kleros',
+      'zerion',
+      'cmc',
+      'oneInch',
+    ],
+    name: 'Chainlink',
+  },
+  {
+    address: '0x1f573d6fb3f13d689ff844b4ce37794d79a7ff1c',
+    symbol: 'BNT',
+    decimals: 18,
+    occurances: 11,
+    aggregators: [
+      'paraswap',
+      'pmm',
+      'airswapLight',
+      'zeroEx',
+      'bancor',
+      'coinGecko',
+      'zapper',
+      'kleros',
+      'zerion',
+      'cmc',
+      'oneInch',
+    ],
+    name: 'Bancor',
+  },
+];
+
+const sampleToken = {
+  address: '0x514910771af9ca656af840dff83e8264ecf986ca',
+  symbol: 'LINK',
+  decimals: 18,
+  occurances: 11,
+  aggregators: [
+    'paraswap',
+    'pmm',
+    'airswapLight',
+    'zeroEx',
+    'bancor',
+    'coinGecko',
+    'zapper',
+    'kleros',
+    'zerion',
+    'cmc',
+    'oneInch',
+  ],
+  name: 'Chainlink',
+};
+
+describe('FetchtokenList', () => {
+  beforeAll(() => {
+    nock.disableNetConnect();
+  });
+
+  afterAll(() => {
+    nock.enableNetConnect();
+  });
+
+  afterEach(() => {
+    nock.cleanAll();
+  });
+
+  it('should call the tokens api and return the list of tokens', async () => {
+    nock(TOKEN_END_POINT_API)
+      .get(`/tokens/${NetworksChainId.mainnet}`)
+      .reply(200, sampleTokenList)
+      .persist();
+
+    const tokens = await fetchTokenList(NetworksChainId.mainnet);
+
+    expect(tokens).toStrictEqual(sampleTokenList);
+  });
+  it('should call the api to sync tokens and returns nothing', async () => {
+    nock(TOKEN_END_POINT_API)
+      .get(`/sync/${NetworksChainId.mainnet}`)
+      .reply(200)
+      .persist();
+
+    expect(await syncTokens(NetworksChainId.mainnet)).toBeUndefined();
+  });
+  it('should call the api to return the token metadata for eth address provided', async () => {
+    nock(TOKEN_END_POINT_API)
+      .get(
+        `/tokens/${NetworksChainId.mainnet}?address=0x514910771af9ca656af840dff83e8264ecf986ca`,
+      )
+      .reply(200, sampleToken)
+      .persist();
+
+    const token = await fetchTokenMetadata(
+      NetworksChainId.mainnet,
+      '0x514910771af9ca656af840dff83e8264ecf986ca',
+    );
+
+    expect(token).toStrictEqual(sampleToken);
+  });
+});

src/apis/token-service.ts

@@ -0,0 +1,72 @@
+import { timeoutFetch } from '../util';
+
+const END_POINT = 'https://token-api.airswap-prod.codefi.network';
+
+function syncTokensURL(chainId: string) {
+  return `${END_POINT}/sync/${chainId}`;
+}
+function getTokensURL(chainId: string) {
+  return `${END_POINT}/tokens/${chainId}`;
+}
+function getTokenMetadataURL(chainId: string, tokenAddress: string) {
+  return `${END_POINT}/tokens/${chainId}?address=${tokenAddress}`;
+}
+
+/**
+ * Fetches the list of token metadata for a given network chainId
+ *
+ * @returns - Promise resolving token  List
+ */
+export async function fetchTokenList(chainId: string): Promise<Response> {
+  const tokenURL = getTokensURL(chainId);
+  const fetchOptions: RequestInit = {
+    referrer: tokenURL,
+    referrerPolicy: 'no-referrer-when-downgrade',
+    method: 'GET',
+    mode: 'cors',
+  };
+  fetchOptions.headers = new window.Headers();
+  fetchOptions.headers.set('Content-Type', 'application/json');
+  const tokenResponse = await timeoutFetch(tokenURL, fetchOptions);
+  return await tokenResponse.json();
+}
+
+/**
+ * Forces a sync of token metadata for a given network chainId.
+ * Syncing happens every 1 hour in the background, this api can
+ * be used to force a sync from our side
+ */
+export async function syncTokens(chainId: string): Promise<void> {
+  const syncURL = syncTokensURL(chainId);
+  const fetchOptions: RequestInit = {
+    referrer: syncURL,
+    referrerPolicy: 'no-referrer-when-downgrade',
+    method: 'GET',
+    mode: 'cors',
+  };
+  fetchOptions.headers = new window.Headers();
+  fetchOptions.headers.set('Content-Type', 'application/json');
+  await timeoutFetch(syncURL, fetchOptions);
+}
+
+/**
+ * Fetch metadata for the token address provided for a given network chainId
+ *
+ * @return Promise resolving token metadata for the tokenAddress provided
+ */
+export async function fetchTokenMetadata(
+  chainId: string,
+  tokenAddress: string,
+): Promise<Response> {
+  const tokenMetadataURL = getTokenMetadataURL(chainId, tokenAddress);
+  const fetchOptions: RequestInit = {
+    referrer: tokenMetadataURL,
+    referrerPolicy: 'no-referrer-when-downgrade',
+    method: 'GET',
+    mode: 'cors',
+  };
+  fetchOptions.headers = new window.Headers();
+  fetchOptions.headers.set('Content-Type', 'application/json');
+  const tokenResponse = await timeoutFetch(tokenMetadataURL, fetchOptions);
+  return await tokenResponse.json();
+}