feat(LIVE-29447): add wallet best quote api

Author: philipptpunkt

.changeset/clever-otters-greet.md

@@ -0,0 +1,6 @@
+---
+"@ledgerhq/wallet-api-exchange-module": minor
+"@ledgerhq/live-common": minor
+---
+
+add wallet-api method to fetch the best swap quote

libs/exchange-module/src/index.ts

@@ -10,6 +10,8 @@ import {
   ExchangeSwapParams,
   SwapResult,
   SwapLiveError,
+  type GetBestQuoteResponse,
+  type GetBestQuoteWireArgs,
   type GetQuotesResponse,
   type GetQuotesWireArgs,
   type GetTransactionStatusResponse,
@@ -189,6 +191,16 @@ export class ExchangeModule extends CustomModule {
     return this.request<GetQuotesWireArgs, GetQuotesResponse>("custom.exchange.getQuotes", params);
   }
 
+  /**
+   * Fetch the best swap quote from the Ledger swap backend (via Wallet API host).
+   */
+  async getBestQuote(params: GetBestQuoteWireArgs): Promise<GetBestQuoteResponse> {
+    return this.request<GetBestQuoteWireArgs, GetBestQuoteResponse>(
+      "custom.exchange.getBestQuote",
+      params,
+    );
+  }
+
   /**
    * Fetch swap transaction status from the Wallet API host.
    */

libs/exchange-module/src/types.ts

@@ -139,6 +139,9 @@ export type GetQuotesArgs = {
 
 export type GetQuotesWireArgs = Omit<GetQuotesArgs, "signal">;
 
+export type GetBestQuoteArgs = GetQuotesArgs;
+export type GetBestQuoteWireArgs = GetQuotesWireArgs;
+
 // Swap transaction status (`custom.exchange.getTransactionStatus`).
 
 export type TransactionStatusInput = {
@@ -468,3 +471,10 @@ export type GetQuotesResponse = {
    */
   errors: QuotesError[];
 };
+
+export type GetBestQuoteResponse =
+  | Quote
+  | {
+      providerErrors: QuoteProviderError[];
+      errors: QuotesError[];
+    };

libs/ledger-live-common/src/wallet-api/Exchange/quotes/getBestQuote.test.ts

@@ -0,0 +1,107 @@
+import { getBestQuote } from "./getBestQuote";
+import { getQuotes, type GetQuotesContext } from "./getQuotes";
+import {
+  ProviderErrorCodes,
+  QuotesErrorCodes,
+  type GetBestQuoteArgs,
+  type GetQuotesResponse,
+  type Quote,
+} from "./types";
+
+jest.mock("./getQuotes", () => ({
+  getQuotes: jest.fn(),
+}));
+
+const getQuotesMock = jest.mocked(getQuotes);
+
+function makeQuote(key: string): Quote {
+  return {
+    key,
+    provider: "lifi",
+    providerDetails: {
+      name: "LiFi",
+      type: "DEX",
+      isUniswapX: false,
+      requiresKYC: false,
+      continuesInProviderLiveApp: false,
+    },
+    quoteDetails: {
+      type: "float",
+      sendAmount: 1,
+      receiveAmount: 1,
+      gasLess: false,
+      networkFees: { currencyId: "ethereum" },
+      slippage: 1,
+      exchangeRate: 1,
+    },
+    warnings: [],
+    errors: [],
+  };
+}
+
+const args: GetBestQuoteArgs = {
+  providers: ["lifi"],
+  data: {
+    amount: "1",
+    sendAccountId: "send-account",
+    receiveAccountId: "receive-account",
+    sendAddress: "0xfrom",
+    receiveAddress: "0xto",
+    sendCurrencyId: "ethereum",
+    receiveCurrencyId: "bitcoin",
+  },
+  sortBy: "netCounterValue",
+};
+
+const context: GetQuotesContext = {
+  accounts: [],
+  spotPrices: { bitcoin: 30_000, ethereum: 2_000 },
+  locale: "en",
+  counterValueCurrency: "usd",
+};
+
+describe("getBestQuote", () => {
+  beforeEach(() => {
+    jest.clearAllMocks();
+  });
+
+  it("returns the first quote from the sorted getQuotes response", async () => {
+    const bestQuote = makeQuote("best");
+    const response: GetQuotesResponse = {
+      quotes: [bestQuote, makeQuote("second")],
+      providerErrors: [],
+      warnings: [],
+      errors: [],
+    };
+    getQuotesMock.mockResolvedValue(response);
+
+    await expect(getBestQuote(args, context)).resolves.toBe(bestQuote);
+    expect(getQuotesMock).toHaveBeenCalledWith(args, context);
+  });
+
+  it("returns quote diagnostics when getQuotes has no quotes", async () => {
+    const response: GetQuotesResponse = {
+      quotes: [],
+      providerErrors: [
+        {
+          code: ProviderErrorCodes.AMOUNT_OFF_LIMITS,
+          type: "float",
+          provider: "lifi",
+          message: "min",
+          parameter: { minAmount: "10" },
+        },
+      ],
+      warnings: [],
+      errors: [
+        { code: QuotesErrorCodes.NO_QUOTES },
+        { code: QuotesErrorCodes.AMOUNT_TOO_LOW, minAmount: "10" },
+      ],
+    };
+    getQuotesMock.mockResolvedValue(response);
+
+    await expect(getBestQuote(args, context)).resolves.toEqual({
+      providerErrors: response.providerErrors,
+      errors: response.errors,
+    });
+  });
+});

libs/ledger-live-common/src/wallet-api/Exchange/quotes/getBestQuote.ts

@@ -0,0 +1,19 @@
+import { getQuotes, type GetQuotesContext } from "./getQuotes";
+import type { GetBestQuoteArgs, GetBestQuoteResponse } from "./types";
+
+export async function getBestQuote(
+  args: GetBestQuoteArgs,
+  context: GetQuotesContext,
+): Promise<GetBestQuoteResponse> {
+  const response = await getQuotes(args, context);
+  const [bestQuote] = response.quotes;
+
+  if (bestQuote) {
+    return bestQuote;
+  }
+
+  return {
+    providerErrors: response.providerErrors,
+    errors: response.errors,
+  };
+}

libs/ledger-live-common/src/wallet-api/Exchange/quotes/index.ts

@@ -1,3 +1,4 @@
 export type * from "./types";
+export { getBestQuote } from "./getBestQuote";
 export { getQuotes } from "./getQuotes";
 export type { GetQuotesContext } from "./getQuotes";

libs/ledger-live-common/src/wallet-api/Exchange/quotes/types.ts

@@ -6,6 +6,9 @@ export type {
   QuotesInput,
   QuotesAppPlatform,
   QuoteSortBy,
+  GetBestQuoteArgs,
+  GetBestQuoteWireArgs,
+  GetBestQuoteResponse,
   GetQuotesArgs,
   GetQuotesWireArgs,
   GetQuotesResponse,

libs/ledger-live-common/src/wallet-api/Exchange/server.ts

@@ -27,6 +27,8 @@ import {
   ExchangeType,
   SwapLiveError,
   SwapResult,
+  type GetBestQuoteResponse,
+  type GetBestQuoteWireArgs,
   type GetQuotesResponse,
   type GetQuotesWireArgs,
 } from "@ledgerhq/wallet-api-exchange-module";
@@ -61,7 +63,7 @@ import { createStepError, StepError, toError } from "./parser";
 import { handleErrors } from "./handleSwapErrors";
 import get from "lodash/get";
 import { SwapError } from "./SwapError";
-import { getQuotes } from "./quotes";
+import { getBestQuote, getQuotes } from "./quotes";
 import { resolveQuotesInput } from "./quotes/resolveQuotesInput";
 import { fetchSpotPrices } from "./quotes/service/fetchSpotPrices";
 import {
@@ -82,6 +84,7 @@ type Handlers = {
   "custom.isReady": RPCHandler<void, void>;
   "custom.exchange.swap": RPCHandler<SwapResult, ExchangeSwapParams>;
   "custom.exchange.getQuotes": RPCHandler<GetQuotesResponse, GetQuotesWireArgs>;
+  "custom.exchange.getBestQuote": RPCHandler<GetBestQuoteResponse, GetBestQuoteWireArgs>;
   "custom.exchange.getTransactionStatus": RPCHandler<
     GetTransactionStatusResponse,
     GetTransactionStatusWireArgs
@@ -800,6 +803,32 @@ export const handlers = ({
       },
     ),
 
+    "custom.exchange.getBestQuote": customWrapper<GetBestQuoteWireArgs, GetBestQuoteResponse>(
+      async params => {
+        if (!params) {
+          throw new ServerError(createUnknownError({ message: "params is undefined" }));
+        }
+        const quotesInput = resolveQuotesInput(params.data, accounts);
+        const spotPrices = await fetchSpotPrices({
+          currencyIds: quotesInput
+            ? [
+                quotesInput.sendCurrencyId,
+                quotesInput.receiveCurrencyId,
+                quotesInput.networkFeesCurrencyId,
+              ]
+            : [],
+          counterValue: counterValueCurrency,
+        });
+        return getBestQuote(params, {
+          accounts,
+          spotPrices,
+          locale,
+          counterValueCurrency,
+          deviceModelId,
+        });
+      },
+    ),
+
     "custom.exchange.getTransactionStatus": customWrapper<
       GetTransactionStatusWireArgs,
       GetTransactionStatusResponse