Merge pull request #14897 from LedgerHQ/feat/live-27020/x-ledger-client-v4-ux

feat(live-27020): add wallet40 feature flag into x-ledger-client-v4-ux swap header

Author: liviuciulinaru

.changeset/wise-crabs-know.md

@@ -0,0 +1,7 @@
+---
+"ledger-live-desktop": minor
+"live-mobile": minor
+"@ledgerhq/live-common": minor
+---
+
+swap: add wallet40 feature flag into x-ledger-client-v4-ux swap header

apps/ledger-live-desktop/src/renderer/components/WebPTXPlayer/CustomHandlers.ts

@@ -36,12 +36,14 @@ import { objectToURLSearchParams } from "@ledgerhq/live-common/wallet-api/helper
 import { useRemoteLiveAppContext } from "@ledgerhq/live-common/platform/providers/RemoteLiveAppProvider/index";
 import { useLocalLiveAppContext } from "@ledgerhq/live-common/wallet-api/LocalLiveAppProvider/index";
 import { usesEncodedAccountIdFormat } from "@ledgerhq/live-common/wallet-api/utils/deriveAccountIdForManifest";
+import { useWalletFeaturesConfig } from "@ledgerhq/live-common/featureFlags/index";
 
 export function usePTXCustomHandlers(manifest: WebviewProps["manifest"], accounts: AccountLike[]) {
   const dispatch = useDispatch();
   const { setDrawer } = React.useContext(context);
   const { getRouteToPlatformApp } = useStake();
   const navigate = useNavigate();
+  const { isEnabled } = useWalletFeaturesConfig("desktop");
   const walletState = useSelector(walletSelector);
   const { state: liveAppRegistryState } = useRemoteLiveAppContext();
   const { state: localLiveAppState } = useLocalLiveAppContext();
@@ -84,6 +86,7 @@ export function usePTXCustomHandlers(manifest: WebviewProps["manifest"], account
       ),
     [],
   );
+  const flags = useMemo(() => ({ wallet40Ux: isEnabled }), [isEnabled]);
 
   const getAccount = useCallback(
     async (accountId: string): Promise<AccountLike | null> => {
@@ -159,6 +162,7 @@ export function usePTXCustomHandlers(manifest: WebviewProps["manifest"], account
         accounts,
         tracking,
         manifest,
+        flags,
         uiHooks: {
           "custom.exchange.start": ({ exchangeParams, onSuccess, onCancel }) => {
             dispatch(
@@ -359,6 +363,7 @@ export function usePTXCustomHandlers(manifest: WebviewProps["manifest"], account
     accounts,
     tracking,
     manifest,
+    flags,
     dispatch,
     setDrawer,
     navigate,

apps/ledger-live-mobile/src/components/WebPTXPlayer/CustomHandlers.ts

@@ -41,6 +41,7 @@ import { usesEncodedAccountIdFormat } from "@ledgerhq/live-common/wallet-api/uti
 import { updateAccountWithUpdater } from "~/actions/accounts";
 import { useDispatch } from "~/context/hooks";
 import { ExchangeSwap } from "@ledgerhq/live-common/exchange/swap/types";
+import { useWalletFeaturesConfig } from "@ledgerhq/live-common/featureFlags/index";
 
 const DrawerClosedError = createCustomErrorClass("DrawerClosedError");
 const drawerClosedError = new DrawerClosedError("User closed the drawer");
@@ -69,6 +70,8 @@ export function useCustomExchangeHandlers({
   const deviceRef = useRef<Device | undefined>(undefined);
   const syncAccountById = useSyncAccountById();
   const dispatch = useDispatch();
+  const { isEnabled } = useWalletFeaturesConfig("mobile");
+  const flags = useMemo(() => ({ wallet40Ux: isEnabled }), [isEnabled]);
   const { state: liveAppRegistryState } = useRemoteLiveAppContext();
   const { state: localLiveAppState } = useLocalLiveAppContext();
 
@@ -291,6 +294,7 @@ export function useCustomExchangeHandlers({
         accounts,
         tracking,
         manifest,
+        flags,
         uiHooks: {
           "custom.exchange.start": ({ exchangeParams, onSuccess, onCancel }) => {
             const promiseId = `start-${Date.now()}`;
@@ -475,6 +479,7 @@ export function useCustomExchangeHandlers({
     onCompleteError,
     onCompleteResult,
     handleLoaderDrawer,
+    flags,
     sendAppReady,
     syncAccountById,
     tracking,

libs/ledger-live-common/src/exchange/swap/api/v5/__tests__/actions.spec.ts

@@ -0,0 +1,71 @@
+import axios from "axios";
+import BigNumber from "bignumber.js";
+import { retrieveSwapPayload } from "../actions";
+
+jest.mock("axios");
+jest.mock("../../..", () => ({
+  getSwapAPIBaseURL: jest.fn(() => "https://swap.ledger.com/v5"),
+}));
+
+describe("retrieveSwapPayload", () => {
+  const post = jest.fn();
+  const mockedAxios = jest.mocked(axios);
+
+  const payloadData = {
+    provider: "changelly",
+    deviceTransactionId: "tx-id",
+    fromAccountAddress: "from-address",
+    toAccountAddress: "to-address",
+    fromAccountCurrency: "bitcoin",
+    toAccountCurrency: "ethereum",
+    amount: "1",
+    amountInAtomicUnit: new BigNumber("100000000"),
+  };
+
+  beforeEach(() => {
+    jest.clearAllMocks();
+    mockedAxios.create.mockReturnValue({ post } as never);
+    post.mockResolvedValue({
+      data: {
+        binaryPayload: "binary",
+        signature: "signature",
+        payinAddress: "payin",
+        swapId: "swap-id",
+      },
+    });
+  });
+
+  it("sends x-ledger-client-v4-ux header when wallet40Ux flag is true", async () => {
+    await retrieveSwapPayload({ ...payloadData, flags: { wallet40Ux: true } });
+
+    expect(post).toHaveBeenCalledWith(
+      "https://swap.ledger.com/v5/swap",
+      expect.any(Object),
+      expect.objectContaining({
+        headers: {
+          "x-ledger-client-v4-ux": "true",
+        },
+      }),
+    );
+  });
+
+  it("does not send request headers when wallet40Ux flag is missing", async () => {
+    await retrieveSwapPayload(payloadData);
+
+    expect(post).toHaveBeenCalledWith(
+      "https://swap.ledger.com/v5/swap",
+      expect.any(Object),
+      undefined,
+    );
+  });
+
+  it("does not send request headers when wallet40Ux flag is false", async () => {
+    await retrieveSwapPayload({ ...payloadData, flags: { wallet40Ux: false } });
+
+    expect(post).toHaveBeenCalledWith(
+      "https://swap.ledger.com/v5/swap",
+      expect.any(Object),
+      undefined,
+    );
+  });
+});

libs/ledger-live-common/src/exchange/swap/api/v5/actions.ts

@@ -23,7 +23,10 @@ export async function retrieveSwapPayload(
     rateId: data.quoteId,
   };
 
-  const res = await swapAxiosClient.post(`${SWAP_API_BASE}/swap`, request);
+  const requestConfig = data.flags?.wallet40Ux
+    ? { headers: { "x-ledger-client-v4-ux": "true" } }
+    : undefined;
+  const res = await swapAxiosClient.post(`${SWAP_API_BASE}/swap`, request, requestConfig);
 
   return {
     binaryPayload: res.data?.binaryPayload,

libs/ledger-live-common/src/exchange/swap/postSwapState.test.ts

@@ -0,0 +1,67 @@
+import network from "@ledgerhq/live-network";
+import { postSwapAccepted, postSwapCancelled } from "./postSwapState";
+
+jest.mock("@ledgerhq/live-network", () => ({
+  __esModule: true,
+  default: jest.fn().mockResolvedValue({}),
+}));
+
+jest.mock("./utils/isIntegrationTestEnv", () => ({
+  isIntegrationTestEnv: () => false,
+}));
+
+const mockedNetwork = jest.mocked(network);
+
+describe("postSwapState wallet40 header", () => {
+  beforeEach(() => {
+    jest.clearAllMocks();
+  });
+
+  it("adds x-ledger-client-v4-ux=true when wallet40Ux flag is true", async () => {
+    await postSwapAccepted({
+      provider: "changelly",
+      swapId: "swap-id",
+      transactionId: "tx-id",
+      flags: { wallet40Ux: true },
+    });
+
+    const request = mockedNetwork.mock.calls[0][0] as { headers?: Record<string, string> };
+    expect(request.headers?.["x-ledger-client-v4-ux"]).toBe("true");
+  });
+
+  it("adds x-ledger-client-v4-ux=true for cancelled call when wallet40Ux flag is true", async () => {
+    await postSwapCancelled({
+      provider: "changelly",
+      swapId: "swap-id",
+      swapAppVersion: "4.0.0",
+      flags: { wallet40Ux: true },
+    });
+
+    const request = mockedNetwork.mock.calls[0][0] as { headers?: Record<string, string> };
+    expect(request.headers?.["x-ledger-client-v4-ux"]).toBe("true");
+    expect(request.headers?.["x-swap-app-version"]).toBe("4.0.0");
+  });
+
+  it("does not add x-ledger-client-v4-ux when wallet40Ux flag is missing", async () => {
+    await postSwapAccepted({
+      provider: "changelly",
+      swapId: "swap-id",
+      transactionId: "tx-id",
+    });
+
+    const request = mockedNetwork.mock.calls[0][0] as { headers?: Record<string, string> };
+    expect(request.headers?.["x-ledger-client-v4-ux"]).toBeUndefined();
+  });
+
+  it("does not add x-ledger-client-v4-ux when wallet40Ux flag is false", async () => {
+    await postSwapAccepted({
+      provider: "changelly",
+      swapId: "swap-id",
+      transactionId: "tx-id",
+      flags: { wallet40Ux: false },
+    });
+
+    const request = mockedNetwork.mock.calls[0][0] as { headers?: Record<string, string> };
+    expect(request.headers?.["x-ledger-client-v4-ux"]).toBeUndefined();
+  });
+});

libs/ledger-live-common/src/exchange/swap/postSwapState.ts

@@ -1,7 +1,7 @@
 import crypto from "crypto";
 import network from "@ledgerhq/live-network";
 import { mockPostSwapAccepted, mockPostSwapCancelled } from "./mock";
-import type { PostSwapAccepted, PostSwapCancelled } from "./types";
+import type { PostSwapAccepted, PostSwapCancelled, FeatureFlags } from "./types";
 import { isIntegrationTestEnv } from "./utils/isIntegrationTestEnv";
 import { getSwapAPIBaseURL, getSwapUserIP } from ".";
 
@@ -47,6 +47,9 @@ function createSwapIntentHashes({
   return { swapIntentWithProvider, swapIntentWithoutProvider };
 }
 
+const getWallet40Header = (flags?: FeatureFlags): Record<string, string> =>
+  flags?.wallet40Ux ? { "x-ledger-client-v4-ux": "true" } : {};
+
 export const postSwapAccepted: PostSwapAccepted = async ({
   provider,
   swapId = "",
@@ -55,6 +58,7 @@ export const postSwapAccepted: PostSwapAccepted = async ({
   fromAccountAddress,
   toAccountAddress,
   fromAmount,
+  flags,
   ...rest
 }) => {
   if (isIntegrationTestEnv())
@@ -80,6 +84,7 @@ export const postSwapAccepted: PostSwapAccepted = async ({
     const headers = {
       ...(ipHeader || {}),
       ...(swapAppVersion ? { "x-swap-app-version": swapAppVersion } : {}),
+      ...getWallet40Header(flags),
     };
 
     await network({
@@ -107,6 +112,7 @@ export const postSwapCancelled: PostSwapCancelled = async ({
   refundAddress,
   payoutAddress,
   data,
+  flags,
   ...rest
 }) => {
   if (isIntegrationTestEnv()) return mockPostSwapCancelled({ provider, swapId, ...rest });
@@ -135,6 +141,7 @@ export const postSwapCancelled: PostSwapCancelled = async ({
     const headers = {
       ...(ipHeader || {}),
       ...(swapAppVersion ? { "x-swap-app-version": swapAppVersion } : {}),
+      ...getWallet40Header(flags),
     };
 
     const requestData = {

libs/ledger-live-common/src/exchange/swap/setBroadcastTransaction.ts

@@ -2,7 +2,7 @@ import { getEnv } from "@ledgerhq/live-env";
 import { Operation } from "@ledgerhq/types-live";
 import { postSwapAccepted, postSwapCancelled } from "./index";
 import { DeviceModelId } from "@ledgerhq/devices";
-import { TradeMethod } from "./types";
+import { FeatureFlags, TradeMethod } from "./types";
 
 export const setBroadcastTransaction = ({
   result,
@@ -15,6 +15,7 @@ export const setBroadcastTransaction = ({
   fromAccountAddress,
   toAccountAddress,
   fromAmount,
+  flags,
 }: {
   result: { operation: Operation | string; swapId: string };
   provider: string;
@@ -26,6 +27,7 @@ export const setBroadcastTransaction = ({
   fromAccountAddress?: string;
   toAccountAddress?: string;
   fromAmount?: string;
+  flags?: FeatureFlags;
 }) => {
   const { operation, swapId } = result;
 
@@ -48,6 +50,7 @@ export const setBroadcastTransaction = ({
       fromAccountAddress,
       toAccountAddress,
       fromAmount,
+      flags,
     });
   } else {
     postSwapAccepted({
@@ -62,6 +65,7 @@ export const setBroadcastTransaction = ({
       fromAccountAddress,
       toAccountAddress,
       fromAmount,
+      flags,
     });
   }
 };

libs/ledger-live-common/src/exchange/swap/types.ts

@@ -183,6 +183,10 @@ export type SwapStatus = {
 // -----
 // Related to Swap state API call (accepted or cancelled)
 
+export type FeatureFlags = {
+  wallet40Ux?: boolean;
+};
+
 type SwapStateRequest = {
   provider: string;
   swapId: string;
@@ -203,6 +207,7 @@ type SwapStateRequest = {
   refundAddress?: string;
   payoutAddress?: string;
   sponsored?: boolean;
+  flags?: FeatureFlags;
 }>;
 
 export type SwapStateAcceptedRequest = SwapStateRequest & {
@@ -326,6 +331,7 @@ export type SwapPayloadRequestData = {
   amountInAtomicUnit: BigNumber;
   quoteId?: string;
   toNewTokenId?: string;
+  flags?: FeatureFlags;
 };
 export type SwapPayloadResponse = {
   binaryPayload: string;

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

@@ -33,7 +33,7 @@ import { BigNumber } from "bignumber.js";
 import { getAccountBridge } from "../../bridge";
 import { retrieveSwapPayload } from "../../exchange/swap/api/v5/actions";
 import { transactionStrategy } from "../../exchange/swap/transactionStrategies";
-import { ExchangeSwap } from "../../exchange/swap/types";
+import { ExchangeSwap, FeatureFlags } from "../../exchange/swap/types";
 import { Exchange } from "../../exchange/types";
 import { Transaction } from "../../generated/types";
 import {
@@ -146,6 +146,7 @@ export const handlers = ({
   accounts,
   tracking,
   manifest,
+  flags,
   uiHooks: {
     "custom.exchange.start": uiExchangeStart,
     "custom.exchange.complete": uiExchangeComplete,
@@ -157,6 +158,7 @@ export const handlers = ({
   accounts: AccountLike[];
   tracking: TrackingAPI;
   manifest: AppManifest;
+  flags?: FeatureFlags;
   uiHooks: ExchangeUiHooks;
 }) =>
   ({
@@ -496,6 +498,7 @@ export const handlers = ({
           amountInAtomicUnit: fromAmountAtomic,
           quoteId,
           toNewTokenId,
+          flags,
         }).catch((error: Error) => {
           const wrappedError = createStepError({
             error: get(error, "response.data.error", error),
@@ -621,6 +624,7 @@ export const handlers = ({
                 fromAccountAddress,
                 toAccountAddress,
                 fromAmount,
+                flags,
               });
 
               resolve({ operationHash, swapId });
@@ -661,6 +665,7 @@ export const handlers = ({
                 data: (transaction as EvmTransaction).data
                   ? `0x${padHexString((transaction as EvmTransaction).data?.toString("hex") || "")}`
                   : "0x",
+                flags,
               });
 
               reject(completeExchangeError);