Add swappable param to discovery endpoints (#5819)

## Explanation

* What is the current state of things and why does it need to change?
token discovery controller doesn't know about the swappable* endpoints
of the token discovery API
* What is the solution your changes offer and how does it work? add
swappable* versions of the discovery endpoints to the controller + api
service
* Are there any changes whose purpose might not obvious to those
unfamiliar with the domain? no
* If your primary goal was to update one package but you found you had
to update another one along the way, why did you do so? N/A
* If you had to upgrade a dependency, why did you do so? N/A

## References
MMPD-1626
<!--
Are there any issues that this pull request is tied to?
Are there other links that reviewers should consult to understand these
changes better?
Are there client or consumer pull requests to adopt any breaking
changes?

For example:

* Fixes #12345
* Related to #67890
-->

## Changelog

<!--
THIS SECTION IS NO LONGER NEEDED.

The process for updating changelogs has changed. Please consult the
"Updating changelogs" section of the Contributing doc for more.
-->

## Checklist

- [x] I've updated the test suite for new or updated code as appropriate
- [x] I've updated documentation (JSDoc, Markdown, etc.) for new or
updated code as appropriate
- [x] I've communicated my changes to consumers by [updating changelogs
for packages I've
changed](https://github.com/MetaMask/core/tree/main/docs/contributing.md#updating-changelogs),
highlighting breaking changes as necessary
- [x] I've prepared draft pull requests for clients and consumer
packages to resolve any breaking changes

Author: ziad-saab

packages/token-search-discovery-controller/CHANGELOG.md

@@ -10,6 +10,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 ### Changed
 
 - Bump `@metamask/base-controller` from ^8.0.0 to ^8.0.1 ([#5722](https://github.com/MetaMask/core/pull/5722))
+- Add `swappable` param to token discovery controller and API service ([#5819](https://github.com/MetaMask/core/pull/5819))
 
 ## [3.1.0]
 

packages/token-search-discovery-controller/src/token-discovery-api-service/token-discovery-api-service.test.ts

@@ -89,6 +89,10 @@ describe('TokenDiscoveryApiService', () => {
         params: { limit: '10' },
         expectedPath: '/tokens-search/trending?limit=10',
       },
+      {
+        params: { swappable: true },
+        expectedPath: '/tokens-search/trending?swappable=true',
+      },
       {
         params: {},
         expectedPath: '/tokens-search/trending',
@@ -154,6 +158,10 @@ describe('TokenDiscoveryApiService', () => {
         params: { chains: ['1', '137'] },
         expectedPath: '/tokens-search/top-gainers?chains=1,137',
       },
+      {
+        params: { swappable: true },
+        expectedPath: '/tokens-search/top-gainers?swappable=true',
+      },
     ])(
       'should construct correct URL for params: $params',
       async ({ params, expectedPath }) => {
@@ -196,6 +204,10 @@ describe('TokenDiscoveryApiService', () => {
         params: { chains: ['1', '137'] },
         expectedPath: '/tokens-search/top-losers?chains=1,137',
       },
+      {
+        params: { swappable: true },
+        expectedPath: '/tokens-search/top-losers?swappable=true',
+      },
     ])(
       'should construct correct URL for params: $params',
       async ({ params, expectedPath }) => {
@@ -238,6 +250,10 @@ describe('TokenDiscoveryApiService', () => {
         params: { chains: ['1', '137'] },
         expectedPath: '/tokens-search/blue-chip?chains=1,137',
       },
+      {
+        params: { swappable: true },
+        expectedPath: '/tokens-search/blue-chip?swappable=true',
+      },
     ])(
       'should construct correct URL for params: $params',
       async ({ params, expectedPath }) => {

packages/token-search-discovery-controller/src/token-discovery-api-service/token-discovery-api-service.ts

@@ -5,6 +5,7 @@ import type {
   TopLosersParams,
   TrendingTokensParams,
   BlueChipParams,
+  ParamsBase,
 } from '../types';
 
 export class TokenDiscoveryApiService extends AbstractTokenDiscoveryApiService {
@@ -18,19 +19,19 @@ export class TokenDiscoveryApiService extends AbstractTokenDiscoveryApiService {
     this.#baseUrl = baseUrl;
   }
 
-  async getTrendingTokensByChains(
-    trendingTokensParams?: TrendingTokensParams,
-  ): Promise<MoralisTokenResponseItem[]> {
-    const url = new URL('/tokens-search/trending', this.#baseUrl);
+  async #fetch(subPath: string, params?: ParamsBase) {
+    const url = new URL(`/tokens-search/${subPath}`, this.#baseUrl);
 
-    if (
-      trendingTokensParams?.chains &&
-      trendingTokensParams.chains.length > 0
-    ) {
-      url.searchParams.append('chains', trendingTokensParams.chains.join());
+    if (params?.chains && params.chains.length > 0) {
+      url.searchParams.append('chains', params.chains.join());
     }
-    if (trendingTokensParams?.limit) {
-      url.searchParams.append('limit', trendingTokensParams.limit);
+
+    if (params?.limit) {
+      url.searchParams.append('limit', params.limit);
+    }
+
+    if (params?.swappable) {
+      url.searchParams.append('swappable', 'true');
     }
 
     const response = await fetch(url, {
@@ -49,87 +50,27 @@ export class TokenDiscoveryApiService extends AbstractTokenDiscoveryApiService {
     return response.json();
   }
 
+  async getTrendingTokensByChains(
+    trendingTokensParams?: TrendingTokensParams,
+  ): Promise<MoralisTokenResponseItem[]> {
+    return this.#fetch('trending', trendingTokensParams);
+  }
+
   async getTopLosersByChains(
     topLosersParams?: TopLosersParams,
   ): Promise<MoralisTokenResponseItem[]> {
-    const url = new URL('/tokens-search/top-losers', this.#baseUrl);
-
-    if (topLosersParams?.chains && topLosersParams.chains.length > 0) {
-      url.searchParams.append('chains', topLosersParams.chains.join());
-    }
-    if (topLosersParams?.limit) {
-      url.searchParams.append('limit', topLosersParams.limit);
-    }
-
-    const response = await fetch(url, {
-      method: 'GET',
-      headers: {
-        'Content-Type': 'application/json',
-      },
-    });
-
-    if (!response.ok) {
-      throw new Error(
-        `Portfolio API request failed with status: ${response.status}`,
-      );
-    }
-
-    return response.json();
+    return this.#fetch('top-losers', topLosersParams);
   }
 
   async getTopGainersByChains(
     topGainersParams?: TopGainersParams,
   ): Promise<MoralisTokenResponseItem[]> {
-    const url = new URL('/tokens-search/top-gainers', this.#baseUrl);
-
-    if (topGainersParams?.chains && topGainersParams.chains.length > 0) {
-      url.searchParams.append('chains', topGainersParams.chains.join());
-    }
-    if (topGainersParams?.limit) {
-      url.searchParams.append('limit', topGainersParams.limit);
-    }
-
-    const response = await fetch(url, {
-      method: 'GET',
-      headers: {
-        'Content-Type': 'application/json',
-      },
-    });
-
-    if (!response.ok) {
-      throw new Error(
-        `Portfolio API request failed with status: ${response.status}`,
-      );
-    }
-
-    return response.json();
+    return this.#fetch('top-gainers', topGainersParams);
   }
 
   async getBlueChipTokensByChains(
     blueChipParams?: BlueChipParams,
   ): Promise<MoralisTokenResponseItem[]> {
-    const url = new URL('/tokens-search/blue-chip', this.#baseUrl);
-
-    if (blueChipParams?.chains && blueChipParams.chains.length > 0) {
-      url.searchParams.append('chains', blueChipParams.chains.join());
-    }
-    if (blueChipParams?.limit) {
-      url.searchParams.append('limit', blueChipParams.limit);
-    }
-
-    const response = await fetch(url, {
-      method: 'GET',
-      headers: {
-        'Content-Type': 'application/json',
-      },
-    });
-
-    if (!response.ok) {
-      throw new Error(
-        `Portfolio API request failed with status: ${response.status}`,
-      );
-    }
-
-    return response.json();
+    return this.#fetch('blue-chip', blueChipParams);
   }
 }

packages/token-search-discovery-controller/src/types.ts

@@ -1,11 +1,12 @@
 // Function params
 
-type ParamsBase = {
+export type ParamsBase = {
   chains?: string[];
   limit?: string;
+  swappable?: boolean;
 };
 
-export type TokenSearchParams = ParamsBase & {
+export type TokenSearchParams = Omit<ParamsBase, 'swappable'> & {
   query?: string;
 };