feat(LIVE-12276): add swap user IP (#6883)

* feat(LIVE-12276): add swap user IP

* feat(LIVE-12276): changeset

.changeset/popular-keys-double.md

@@ -0,0 +1,6 @@
+---
+"@ledgerhq/live-common": patch
+"@ledgerhq/live-env": patch
+---
+
+Add user IP

libs/env/src/env.ts

@@ -583,6 +583,11 @@ const envDefinitions = {
     parser: stringParser,
     desc: "Swap API base",
   },
+  SWAP_USER_IP: {
+    def: "",
+    parser: stringParser,
+    desc: "Swap IP",
+  },
   SYNC_ALL_INTERVAL: {
     def: 8 * 60 * 1000,
     parser: intParser,

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

@@ -6,7 +6,7 @@ import { fetchCurrencyAllMock } from "./__mocks__/fetchCurrencyAll.mocks";
 import { ResponseData as ResponseDataTo } from "./fetchCurrencyTo";
 import { ResponseData as ResponseDataFrom } from "./fetchCurrencyFrom";
 import { flattenV5CurrenciesAll } from "../../utils/flattenV5CurrenciesAll";
-import { getAvailableProviders, getSwapAPIBaseURL } from "../..";
+import { getSwapAPIBaseURL, getSwapUserIP, getAvailableProviders } from "../..";
 import { getEnv } from "@ledgerhq/live-env";
 
 type Props = {
@@ -26,12 +26,14 @@ export async function fetchCurrencyAll({ additionalCoinsFlag = false }: Props) {
   const url = new URL(`${getSwapAPIBaseURL()}/currencies/all`);
   url.searchParams.append("providers-whitelist", providers.join(","));
   url.searchParams.append("additional-coins-flag", additionalCoinsFlag.toString());
+  const headers = getSwapUserIP();
 
   try {
     const { data } = await network<ResponseDataAll>({
       method: "GET",
       url: url.toString(),
       timeout: DEFAULT_SWAP_TIMEOUT_MS,
+      ...(headers !== undefined ? { headers } : {}),
     });
     return flattenV5CurrenciesAll(data);
   } catch (e: unknown) {

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

@@ -2,7 +2,7 @@ import network from "@ledgerhq/live-network/network";
 import { DEFAULT_SWAP_TIMEOUT_MS } from "../../const/timeout";
 import { flattenV5CurrenciesToAndFrom } from "../../utils/flattenV5CurrenciesToAndFrom";
 import { fetchCurrencyFromMock } from "./__mocks__/fetchCurrencyFrom.mocks";
-import { getAvailableProviders, getSwapAPIBaseURL } from "../..";
+import { getAvailableProviders, getSwapAPIBaseURL, getSwapUserIP } from "../..";
 import { getEnv } from "@ledgerhq/live-env";
 
 type Props = {
@@ -21,6 +21,7 @@ export async function fetchCurrencyFrom({ currencyTo, additionalCoinsFlag = fals
   if (getEnv("MOCK") || getEnv("PLAYWRIGHT_RUN"))
     return flattenV5CurrenciesToAndFrom(fetchCurrencyFromMock);
 
+  const headers = getSwapUserIP();
   const url = new URL(`${getSwapAPIBaseURL()}/currencies/from`);
   const providers = getAvailableProviders();
   url.searchParams.append("providers-whitelist", providers.join(","));
@@ -35,6 +36,7 @@ export async function fetchCurrencyFrom({ currencyTo, additionalCoinsFlag = fals
       method: "GET",
       url: url.toString(),
       timeout: DEFAULT_SWAP_TIMEOUT_MS,
+      ...(headers !== undefined ? { headers } : {}),
     });
     return flattenV5CurrenciesToAndFrom(data);
   } catch (e) {

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

@@ -5,7 +5,7 @@ import { DEFAULT_SWAP_TIMEOUT_MS } from "../../const/timeout";
 import axios from "axios";
 import { LedgerAPI4xx } from "@ledgerhq/errors";
 import { flattenV5CurrenciesToAndFrom } from "../../utils/flattenV5CurrenciesToAndFrom";
-import { getAvailableProviders, getSwapAPIBaseURL } from "../..";
+import { getAvailableProviders, getSwapAPIBaseURL, getSwapUserIP } from "../..";
 
 type Props = {
   currencyFromId?: string;
@@ -30,12 +30,14 @@ export async function fetchCurrencyTo({ currencyFromId, additionalCoinsFlag = fa
   url.searchParams.append("providers-whitelist", providers.join(","));
   url.searchParams.append("additional-coins-flag", additionalCoinsFlag.toString());
   url.searchParams.append("currency-from", currencyFromId!);
+  const headers = getSwapUserIP();
 
   try {
     const { data } = await network<ResponseData>({
       method: "GET",
       url: url.toString(),
       timeout: DEFAULT_SWAP_TIMEOUT_MS,
+      ...(headers !== undefined ? { headers } : {}),
     });
     return flattenV5CurrenciesToAndFrom(data);
   } catch (e: unknown) {

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

@@ -8,7 +8,7 @@ import { SwapGenericAPIError } from "../../../../errors";
 import { enrichRatesResponse } from "../../utils/enrichRatesResponse";
 import { isIntegrationTestEnv } from "../../utils/isIntegrationTestEnv";
 import { fetchRatesMock } from "./__mocks__/fetchRates.mocks";
-import { getAvailableProviders, getSwapAPIBaseURL } from "../..";
+import { getAvailableProviders, getSwapAPIBaseURL, getSwapUserIP } from "../..";
 
 type Props = {
   removeProviders: Array<string>;
@@ -100,13 +100,14 @@ export async function fetchRates({
     amountFrom: fromCurrencyAmount, // not sure why amountFrom thinks it can be undefined here
     providers: providers,
   };
-
+  const headers = getSwapUserIP();
   try {
     const { data } = await network<ExchangeRateResponseRaw[]>({
       method: "POST",
       url: url.toString(),
       timeout: DEFAULT_SWAP_TIMEOUT_MS,
       data: requestBody,
+      ...(headers !== undefined ? { headers } : {}),
     });
     const filteredData = data.filter(
       response => ![300, 304, 306, 308].includes((response as ExchangeRateErrorDefault)?.errorCode),

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

@@ -8,7 +8,7 @@ import {
   SwapExchangeRateAmountTooLow,
   SwapExchangeRateAmountTooLowOrTooHigh,
 } from "../../errors";
-import { getSwapAPIBaseURL, getSwapAPIError } from "./";
+import { getSwapAPIBaseURL, getSwapAPIError, getSwapUserIP } from "./";
 import { mockGetExchangeRates } from "./mock";
 import type { CustomMinOrMaxError, GetExchangeRates } from "./types";
 import { isIntegrationTestEnv } from "./utils/isIntegrationTestEnv";
@@ -44,12 +44,14 @@ const getExchangeRates: GetExchangeRates = async ({
     providers: providerList,
   };
 
+  const headers = getSwapUserIP();
   const res = await network({
     method: "POST",
     url: `${getSwapAPIBaseURL()}/rate`,
     ...(timeout ? { timeout } : {}),
     ...(timeoutErrorMessage ? { timeoutErrorMessage } : {}),
     data: request,
+    ...(headers !== undefined ? headers : {}),
   });
 
   const rates = res.data.map(async responseData => {

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

@@ -2,15 +2,17 @@ import network from "@ledgerhq/live-network/network";
 import { mockGetStatus } from "./mock";
 import type { GetMultipleStatus } from "./types";
 import { isIntegrationTestEnv } from "./utils/isIntegrationTestEnv";
-import { getSwapAPIBaseURL } from ".";
+import { getSwapAPIBaseURL, getSwapUserIP } from ".";
 
 export const getMultipleStatus: GetMultipleStatus = async statusList => {
   if (isIntegrationTestEnv()) return mockGetStatus(statusList);
 
+  const headers = getSwapUserIP();
   const res = await network({
     method: "POST",
     url: `${getSwapAPIBaseURL()}/swap/status`,
     data: statusList,
+    ...(headers !== undefined ? { headers } : {}),
   });
   return res.data;
 };

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

@@ -34,6 +34,13 @@ export const isSwapOperationPending: (status: string) => boolean = status =>
   !operationStatusList.finishedKO.includes(status);
 
 const getSwapAPIBaseURL: () => string = () => getEnv("SWAP_API_BASE");
+const getSwapUserIP = () => {
+  const SWAP_USER_IP = getEnv("SWAP_USER_IP");
+  if (SWAP_USER_IP) {
+    return { "X-Forwarded-For": SWAP_USER_IP };
+  }
+  return undefined;
+};
 
 const SWAP_API_BASE_PATTERN = /.*\/v(?<version>\d+)\/*$/;
 const getSwapAPIVersion: () => number = () => {
@@ -127,6 +134,7 @@ export const getSwapAPIError = (errorCode: number, errorMessage?: string) => {
 
 export {
   getSwapAPIBaseURL,
+  getSwapUserIP,
   getSwapAPIVersion,
   getCompleteSwapHistory,
   postSwapAccepted,

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

@@ -23,7 +23,7 @@ import {
 import perFamily from "../../generated/exchange";
 import { withDevice } from "../../hw/deviceAccess";
 import { delay } from "../../promise";
-import { getSwapAPIBaseURL } from "./";
+import { getSwapAPIBaseURL, getSwapUserIP } from "./";
 import { mockInitSwap } from "./mock";
 import type { InitSwapInput, SwapRequestEvent } from "./types";
 import { decodePayloadProtobuf } from "@ledgerhq/hw-app-exchange";
@@ -76,6 +76,8 @@ const initSwap = (input: InitSwapInput): Observable<SwapRequestEvent> => {
 
         const headers = {
           EquipmentId: getEnv("USER_ID"),
+
+          ...(getSwapUserIP() !== undefined ? getSwapUserIP() : {}),
         };
 
         const data = {

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

@@ -2,7 +2,7 @@ import network from "@ledgerhq/live-network/network";
 import { mockPostSwapAccepted, mockPostSwapCancelled } from "./mock";
 import type { PostSwapAccepted, PostSwapCancelled } from "./types";
 import { isIntegrationTestEnv } from "./utils/isIntegrationTestEnv";
-import { getSwapAPIBaseURL } from ".";
+import { getSwapAPIBaseURL, getSwapUserIP } from ".";
 
 export const postSwapAccepted: PostSwapAccepted = async ({
   provider,
@@ -21,10 +21,12 @@ export const postSwapAccepted: PostSwapAccepted = async ({
     return null;
   }
   try {
+    const headers = getSwapUserIP();
     await network({
       method: "POST",
       url: `${getSwapAPIBaseURL()}/swap/accepted`,
       data: { provider, swapId, transactionId, ...rest },
+      ...(headers !== undefined ? { headers } : {}),
     });
   } catch (error) {
     console.error(error);