fix: lower occurenceFloor for linea mainnet to 1 (#4253)

sahar-fehri · web-flow · commit 68b8de7c553c · 2024-05-07T20:26:41.000+02:00
## Explanation

Lower occurenceFloor for linea mainnet to only 1 list instead of 3.
Add a filter for lineaTeam aggregator when we fetch token list from
token-api when the user is on linea-mainnet.

## References

&lt;!--
Are there any issues that this pull request is tied to? Are there other
links that reviewers should consult to understand these changes better?

For example:

* Fixes #12345
* Related to #67890
--&gt;

## Changelog

&lt;!--
If you're making any consumer-facing changes, list those changes here as
if you were updating a changelog, using the template below as a guide.

(CATEGORY is one of BREAKING, ADDED, CHANGED, DEPRECATED, REMOVED, or
FIXED. For security-related issues, follow the Security Advisory
process.)

Please take care to name the exact pieces of the API you've added or
changed (e.g. types, interfaces, functions, or methods).

If there are any breaking changes, make sure to offer a solution for
consumers to follow once they upgrade to the changes.

Finally, if you're only making changes to development scripts or tests,
you may replace the template below with "None".
--&gt;

### `@metamask/assets-controllers`

- **CHANGED**: Changed query parameter occurenceFloor in getTokensURL to
equal 1 for linea-mainnet and default to 3 for other networks.
- **Added**: Added a filter for `lineaTeam` aggregator on the returned
list by `fetchTokenListByChainId` when the user is on linea mainnet.

## Checklist

- [ ] I've updated the test suite for new or updated code as appropriate
- [ ] I've updated documentation (JSDoc, Markdown, etc.) for new or
updated code as appropriate
- [ ] I've highlighted breaking changes using the "BREAKING" category
above as appropriate
diff --git a/packages/assets-controllers/src/token-service.test.ts b/packages/assets-controllers/src/token-service.test.ts
@@ -112,6 +112,107 @@ const sampleTokenList = [
   },
 ];
 
+const sampleTokenListLinea = [
+  {
+    address: '0xbbbbca6a901c926f240b89eacb641d8aec7aeafd',
+    symbol: 'LRC',
+    decimals: 18,
+    occurrences: 11,
+    aggregators: [
+      'lineaTeam',
+      'pmm',
+      'airswapLight',
+      'zeroEx',
+      'bancor',
+      'coinGecko',
+      'zapper',
+      'kleros',
+      'zerion',
+      'cmc',
+      'oneInch',
+    ],
+  },
+  {
+    address: '0xc011a73ee8576fb46f5e1c5751ca3b9fe0af2a6f',
+    symbol: 'SNX',
+    decimals: 18,
+    occurrences: 11,
+    aggregators: [
+      'lineaTeam',
+      'pmm',
+      'airswapLight',
+      'zeroEx',
+      'bancor',
+      'coinGecko',
+      'zapper',
+      'kleros',
+      'zerion',
+      'cmc',
+      'oneInch',
+    ],
+    name: 'Synthetix',
+  },
+  {
+    address: '0x408e41876cccdc0f92210600ef50372656052a38',
+    symbol: 'REN',
+    decimals: 18,
+    occurrences: 11,
+    aggregators: [
+      'lineaTeam',
+      'pmm',
+      'airswapLight',
+      'zeroEx',
+      'bancor',
+      'coinGecko',
+      'zapper',
+      'kleros',
+      'zerion',
+      'cmc',
+      'oneInch',
+    ],
+  },
+  {
+    address: '0x514910771af9ca656af840dff83e8264ecf986ca',
+    symbol: 'LINK',
+    decimals: 18,
+    occurrences: 11,
+    aggregators: [
+      'lineaTeam',
+      'pmm',
+      'airswapLight',
+      'zeroEx',
+      'bancor',
+      'coinGecko',
+      'zapper',
+      'kleros',
+      'zerion',
+      'cmc',
+      'oneInch',
+    ],
+    name: 'Chainlink',
+  },
+  {
+    address: '0x1f573d6fb3f13d689ff844b4ce37794d79a7ff1c',
+    symbol: 'BNT',
+    decimals: 18,
+    occurrences: 11,
+    aggregators: [
+      'paraswap',
+      'pmm',
+      'airswapLight',
+      'zeroEx',
+      'bancor',
+      'coinGecko',
+      'zapper',
+      'kleros',
+      'zerion',
+      'cmc',
+      'oneInch',
+    ],
+    name: 'Bancor',
+  },
+];
+
 const sampleToken = {
   address: '0x514910771af9ca656af840dff83e8264ecf986ca',
   symbol: 'LINK',
@@ -152,6 +253,23 @@ describe('Token service', () => {
       expect(tokens).toStrictEqual(sampleTokenList);
     });
 
+    it('should call the tokens api and return the list of tokens on linea mainnet', async () => {
+      const { signal } = new AbortController();
+      const lineaChainId = 59144;
+      const lineaHexChain = toHex(lineaChainId);
+
+      nock(TOKEN_END_POINT_API)
+        .get(
+          `/tokens/${lineaChainId}?occurrenceFloor=1&includeNativeAssets=false&includeDuplicateSymbolAssets=false&includeTokenFees=false&includeAssetType=false`,
+        )
+        .reply(200, sampleTokenListLinea)
+        .persist();
+
+      const tokens = await fetchTokenListByChainId(lineaHexChain, signal);
+
+      expect(tokens).toStrictEqual(sampleTokenListLinea);
+    });
+
     it('should return undefined if the fetch is aborted', async () => {
       const abortController = new AbortController();
       nock(TOKEN_END_POINT_API)
diff --git a/packages/assets-controllers/src/token-service.ts b/packages/assets-controllers/src/token-service.ts
@@ -1,4 +1,8 @@
-import { convertHexToDecimal, timeoutFetch } from '@metamask/controller-utils';
+import {
+  ChainId,
+  convertHexToDecimal,
+  timeoutFetch,
+} from '@metamask/controller-utils';
 import type { Hex } from '@metamask/utils';
 
 import { isTokenListSupportedForNetwork } from './assetsUtil';
@@ -14,9 +18,10 @@ export const TOKEN_METADATA_NO_SUPPORT_ERROR =
  * @returns The tokens URL.
  */
 function getTokensURL(chainId: Hex) {
+  const occurrenceFloor = chainId === ChainId['linea-mainnet'] ? 1 : 3;
   return `${TOKEN_END_POINT_API}/tokens/${convertHexToDecimal(
     chainId,
-  )}?occurrenceFloor=3&includeNativeAssets=false&includeDuplicateSymbolAssets=false&includeTokenFees=false&includeAssetType=false`;
+  )}?occurrenceFloor=${occurrenceFloor}&includeNativeAssets=false&includeDuplicateSymbolAssets=false&includeTokenFees=false&includeAssetType=false`;
 }
 
 /**
@@ -56,7 +61,14 @@ export async function fetchTokenListByChainId(
   const tokenURL = getTokensURL(chainId);
   const response = await queryApi(tokenURL, abortSignal, timeout);
   if (response) {
-    return parseJsonResponse(response);
+    const result = await parseJsonResponse(response);
+    if (Array.isArray(result) && chainId === ChainId['linea-mainnet']) {
+      return result.filter(
+        (elm) =>
+          elm.aggregators.includes('lineaTeam') || elm.aggregators.length >= 3,
+      );
+    }
+    return result;
   }
   return undefined;
 }
