update recommendAssets to handle multiple requests

thal0x · thal0x · commit 7a597bb5a3ba · 2023-12-22T13:11:36.000-06:00
diff --git a/packages/core/src/__test__/client.test.ts b/packages/core/src/__test__/client.test.ts
@@ -8,6 +8,7 @@ import {
   DenomWithChainID,
   originAssetsResponseFromJSON,
   OriginAssetsResponseJSON,
+  RecommendationEntry,
 } from "../types";
 
 export const server = setupServer();
@@ -523,27 +524,34 @@ describe("client", () => {
     it("handles 200 OK", async () => {
       server.use(
         rest.post(
-          "https://api.skip.money/v1/fungible/recommend_assets",
+          "https://api.skip.money/v2/fungible/recommend_assets",
           (_, res, ctx) => {
             return res(
               ctx.status(200),
               ctx.json({
-                recommendations: [
+                recommendations: [],
+                recommendation_entries: [
                   {
-                    asset: {
-                      denom:
-                        "ibc/14F9BC3E44B8A9C1BE1FB08980FAB87034C9905EF17CF2F5008FC085218811CC",
-                      chain_id: "cosmoshub-4",
-                      origin_denom: "uosmo",
-                      origin_chain_id: "osmosis-1",
-                      trace: "transfer/channel-141",
-                      symbol: "OSMO",
-                      name: "OSMO",
-                      logo_uri:
-                        "https://raw.githubusercontent.com/cosmostation/chainlist/main/chain/osmosis/asset/osmo.png",
-                      decimals: 6,
-                    },
-                    reason: "MOST_LIQUID",
+                    recommendations: [
+                      {
+                        asset: {
+                          denom:
+                            "ibc/14F9BC3E44B8A9C1BE1FB08980FAB87034C9905EF17CF2F5008FC085218811CC",
+                          chain_id: "cosmoshub-4",
+                          origin_denom: "uosmo",
+                          origin_chain_id: "osmosis-1",
+                          trace: "transfer/channel-141",
+                          symbol: "OSMO",
+                          name: "OSMO",
+                          logo_uri:
+                            "https://raw.githubusercontent.com/cosmostation/chainlist/main/chain/osmosis/asset/osmo.png",
+                          decimals: 6,
+                          is_cw20: true,
+                          is_evm: true,
+                        },
+                        reason: "MOST_LIQUID",
+                      },
+                    ],
                   },
                 ],
               }),
@@ -556,30 +564,44 @@ describe("client", () => {
         apiURL: SKIP_API_URL,
       });
 
-      const response = await client.recommendAssets({
-        sourceAssetChainID: "osmosis-1",
-        sourceAssetDenom: "uosmo",
-        destChainID: "cosmoshub-4",
-      });
-
-      expect(response).toEqual([
+      const response = await client.recommendAssets([
         {
-          asset: {
-            denom:
-              "ibc/14F9BC3E44B8A9C1BE1FB08980FAB87034C9905EF17CF2F5008FC085218811CC",
-            chainID: "cosmoshub-4",
-            originDenom: "uosmo",
-            originChainID: "osmosis-1",
-            trace: "transfer/channel-141",
-            symbol: "OSMO",
-            name: "OSMO",
-            logoURI:
-              "https://raw.githubusercontent.com/cosmostation/chainlist/main/chain/osmosis/asset/osmo.png",
-            decimals: 6,
-          },
-          reason: "MOST_LIQUID",
+          sourceAssetChainID: "osmosis-1",
+          sourceAssetDenom: "uosmo",
+          destChainID: "cosmoshub-4",
         },
       ]);
+
+      const expected: RecommendationEntry[] = [
+        {
+          recommendations: [
+            {
+              asset: {
+                denom:
+                  "ibc/14F9BC3E44B8A9C1BE1FB08980FAB87034C9905EF17CF2F5008FC085218811CC",
+                chainID: "cosmoshub-4",
+                originDenom: "uosmo",
+                originChainID: "osmosis-1",
+                trace: "transfer/channel-141",
+                symbol: "OSMO",
+                name: "OSMO",
+                logoURI:
+                  "https://raw.githubusercontent.com/cosmostation/chainlist/main/chain/osmosis/asset/osmo.png",
+                decimals: 6,
+                isCW20: true,
+                isEVM: true,
+                tokenContract: undefined,
+                description: undefined,
+                coingeckoID: undefined,
+                recommendedSymbol: undefined,
+              },
+              reason: "MOST_LIQUID",
+            },
+          ],
+        },
+      ];
+
+      expect(response).toEqual(expected);
     });
   });
 
diff --git a/packages/core/src/client.ts b/packages/core/src/client.ts
@@ -58,8 +58,7 @@ import {
   assetFromJSON,
   AssetJSON,
   AssetOrError,
-  assetRecommendationFromJSON,
-  AssetRecommendationJSON,
+  AssetRecommendationRequest,
   AssetsBetweenChainsRequest,
   assetsBetweenChainsRequestToJSON,
   assetsBetweenChainsResponseFromJSON,
@@ -85,8 +84,9 @@ import {
   originAssetsRequestToJSON,
   originAssetsResponseFromJSON,
   OriginAssetsResponseJSON,
-  RecommendAssetsRequest,
   recommendAssetsRequestToJSON,
+  recommendAssetsResponseFromJSON,
+  RecommendAssetsResponseJSON,
   RouteRequest,
   RouteRequestJSON,
   routeRequestToJSON,
@@ -850,20 +850,20 @@ export class SkipRouter {
     return routeResponseFromJSON(response);
   }
 
-  async recommendAssets(options: RecommendAssetsRequest) {
-    const response = await this.requestClient.post<{
-      recommendations: AssetRecommendationJSON[];
-    }>(
-      "/v1/fungible/recommend_assets",
-      recommendAssetsRequestToJSON({
-        ...options,
-        clientID: this.clientID,
-      }),
-    );
+  async recommendAssets(
+    request: AssetRecommendationRequest | AssetRecommendationRequest[],
+  ) {
+    const options = recommendAssetsRequestToJSON({
+      requests: Array.isArray(request) ? request : [request],
+      clientID: this.clientID,
+    });
 
-    return response.recommendations.map((recommendation) =>
-      assetRecommendationFromJSON(recommendation),
+    const response = await this.requestClient.post<RecommendAssetsResponseJSON>(
+      "/v2/fungible/recommend_assets",
+      options,
     );
+
+    return recommendAssetsResponseFromJSON(response).recommendationEntries;
   }
 
   async ibcOriginAssets(assets: DenomWithChainID[]): Promise<AssetOrError[]> {
diff --git a/packages/core/src/types/__test__/converters.test.ts b/packages/core/src/types/__test__/converters.test.ts
@@ -641,33 +641,49 @@ test("feeAssetToJSON", () => {
 
 test("recommendAssetsRequestFromJSON", () => {
   const recommendAssetsRequestJSON: RecommendAssetsRequestJSON = {
-    source_asset_denom: "uosmo",
-    source_asset_chain_id: "osmosis-1",
-    dest_chain_id: "neutron-1",
-    reason: "MOST_LIQUID",
+    requests: [
+      {
+        source_asset_denom: "uosmo",
+        source_asset_chain_id: "osmosis-1",
+        dest_chain_id: "neutron-1",
+        reason: "MOST_LIQUID",
+      },
+    ],
   };
 
   expect(recommendAssetsRequestFromJSON(recommendAssetsRequestJSON)).toEqual({
-    sourceAssetDenom: "uosmo",
-    sourceAssetChainID: "osmosis-1",
-    destChainID: "neutron-1",
-    reason: "MOST_LIQUID",
+    requests: [
+      {
+        sourceAssetDenom: "uosmo",
+        sourceAssetChainID: "osmosis-1",
+        destChainID: "neutron-1",
+        reason: "MOST_LIQUID",
+      },
+    ],
   });
 });
 
 test("recommendAssetsRequestToJSON", () => {
   const recommendAssetsRequest: RecommendAssetsRequest = {
-    sourceAssetDenom: "uosmo",
-    sourceAssetChainID: "osmosis-1",
-    destChainID: "neutron-1",
-    reason: "MOST_LIQUID",
+    requests: [
+      {
+        sourceAssetDenom: "uosmo",
+        sourceAssetChainID: "osmosis-1",
+        destChainID: "neutron-1",
+        reason: "MOST_LIQUID",
+      },
+    ],
   };
 
   expect(recommendAssetsRequestToJSON(recommendAssetsRequest)).toEqual({
-    source_asset_denom: "uosmo",
-    source_asset_chain_id: "osmosis-1",
-    dest_chain_id: "neutron-1",
-    reason: "MOST_LIQUID",
+    requests: [
+      {
+        source_asset_denom: "uosmo",
+        source_asset_chain_id: "osmosis-1",
+        dest_chain_id: "neutron-1",
+        reason: "MOST_LIQUID",
+      },
+    ],
   });
 });
 
diff --git a/packages/core/src/types/converters.ts b/packages/core/src/types/converters.ts
@@ -80,6 +80,8 @@ import {
   AssetBetweenChainsJSON,
   AssetRecommendation,
   AssetRecommendationJSON,
+  AssetRecommendationRequest,
+  AssetRecommendationRequestJSON,
   AssetsBetweenChainsRequest,
   AssetsBetweenChainsRequestJSON,
   AssetsBetweenChainsResponse,
@@ -96,6 +98,10 @@ import {
   OperationJSON,
   RecommendAssetsRequest,
   RecommendAssetsRequestJSON,
+  RecommendAssetsResponse,
+  RecommendAssetsResponseJSON,
+  RecommendationEntry,
+  RecommendationEntryJSON,
   RouteRequest,
   RouteRequestJSON,
   RouteResponse,
@@ -284,10 +290,9 @@ export function recommendAssetsRequestFromJSON(
   recommendAssetsRequestJSON: RecommendAssetsRequestJSON,
 ): RecommendAssetsRequest {
   return {
-    sourceAssetDenom: recommendAssetsRequestJSON.source_asset_denom,
-    sourceAssetChainID: recommendAssetsRequestJSON.source_asset_chain_id,
-    destChainID: recommendAssetsRequestJSON.dest_chain_id,
-    reason: recommendAssetsRequestJSON.reason,
+    requests: recommendAssetsRequestJSON.requests.map(
+      assetRecommendationRequestFromJSON,
+    ),
     clientID: recommendAssetsRequestJSON.client_id,
   };
 }
@@ -296,14 +301,53 @@ export function recommendAssetsRequestToJSON(
   recommendAssetsRequest: RecommendAssetsRequest,
 ): RecommendAssetsRequestJSON {
   return {
-    source_asset_denom: recommendAssetsRequest.sourceAssetDenom,
-    source_asset_chain_id: recommendAssetsRequest.sourceAssetChainID,
-    dest_chain_id: recommendAssetsRequest.destChainID,
-    reason: recommendAssetsRequest.reason,
+    requests: recommendAssetsRequest.requests.map(
+      assetRecommendationRequestToJSON,
+    ),
     client_id: recommendAssetsRequest.clientID,
   };
 }
 
+export function recommendAssetsResponseFromJSON(
+  value: RecommendAssetsResponseJSON,
+): RecommendAssetsResponse {
+  return {
+    recommendations: value.recommendations.map(assetRecommendationFromJSON),
+    recommendationEntries: value.recommendation_entries.map(
+      recommendationEntryFromJSON,
+    ),
+  };
+}
+
+export function recommendAssetsResponseToJSON(
+  value: RecommendAssetsResponse,
+): RecommendAssetsResponseJSON {
+  return {
+    recommendations: value.recommendations.map(assetRecommendationToJSON),
+    recommendation_entries: value.recommendationEntries.map(
+      recommendationEntryToJSON,
+    ),
+  };
+}
+
+export function recommendationEntryFromJSON(
+  value: RecommendationEntryJSON,
+): RecommendationEntry {
+  return {
+    recommendations: value.recommendations.map(assetRecommendationFromJSON),
+    error: value.error,
+  };
+}
+
+export function recommendationEntryToJSON(
+  value: RecommendationEntry,
+): RecommendationEntryJSON {
+  return {
+    recommendations: value.recommendations.map(assetRecommendationToJSON),
+    error: value.error,
+  };
+}
+
 export function swapVenueFromJSON(swapVenueJSON: SwapVenueJSON): SwapVenue {
   return {
     name: swapVenueJSON.name,
@@ -1367,3 +1411,25 @@ export function assetsBetweenChainsResponseFromJSON(
     ),
   };
 }
+
+export function assetRecommendationRequestFromJSON(
+  value: AssetRecommendationRequestJSON,
+): AssetRecommendationRequest {
+  return {
+    sourceAssetDenom: value.source_asset_denom,
+    sourceAssetChainID: value.source_asset_chain_id,
+    destChainID: value.dest_chain_id,
+    reason: value.reason,
+  };
+}
+
+export function assetRecommendationRequestToJSON(
+  value: AssetRecommendationRequest,
+): AssetRecommendationRequestJSON {
+  return {
+    source_asset_denom: value.sourceAssetDenom,
+    source_asset_chain_id: value.sourceAssetChainID,
+    dest_chain_id: value.destChainID,
+    reason: value.reason,
+  };
+}
diff --git a/packages/core/src/types/unified.ts b/packages/core/src/types/unified.ts
