@multiversx/sdk-dapp-liquidity 1.1.0-alpha.1 → 1.1.0-alpha.10

package/README.md

@@ -183,4 +183,9 @@ const App = () => {
     </Web3AppProvider>
   )
 }
-```
+```
+
+## Disclaimer
+
+1. This package is in active development and is subject to change. We recommend to check the latest version and update your code accordingly.
+2. This package is not fully supported on the Next.js framework. We are working on a solution to make it compatible with Next.js.

package/api/getTransactions.d.ts

@@ -1,7 +1,13 @@
+import { ProviderType } from 'types/providerType';
 import { TransactionDTO } from 'dto/Transaction.dto';
 import { AxiosResponse } from 'axios';
 
-export declare function getTransactions({ url, userWalletAddress }: {
+export declare function getTransactions({ url, address, sender, provider, status, tokenIn, tokenOut }: {
     url: string;
-    userWalletAddress: string;
+    address: string;
+    sender?: string;
+    provider?: ProviderType;
+    status?: string;
+    tokenIn?: string;
+    tokenOut?: string;
 }): Promise<AxiosResponse<TransactionDTO[]>>;

package/api/getTransactions.js

@@ -4,10 +4,30 @@ Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
 const axios = require("axios");
 async function getTransactions({
   url,
-  userWalletAddress
+  address,
+  sender,
+  provider,
+  status,
+  tokenIn,
+  tokenOut
 }) {
-  const endpoint = userWalletAddress ? `/transactions/${userWalletAddress}` : "/transactions";
-  return await axios.get(endpoint, {
+  const queryParams = new URLSearchParams({
+    receiver: address || "",
+    sender: sender || "",
+    provider: provider || "",
+    status: status || "",
+    tokenIn: tokenIn || "",
+    tokenOut: tokenOut || ""
+  });
+  const params = Object.entries(Object.fromEntries(queryParams.entries()));
+  for (const [key, value] of params) {
+    if (value === "") {
+      queryParams.delete(key);
+    }
+  }
+  const queryString = queryParams.toString();
+  const endpointWithParams = `/transactions?${queryString}`;
+  return await axios.get(endpointWithParams, {
     baseURL: url
   });
 }

package/api/getTransactions.mjs

@@ -1,10 +1,30 @@
 import axios from "axios";
 async function getTransactions({
   url,
-  userWalletAddress
+  address,
+  sender,
+  provider,
+  status,
+  tokenIn,
+  tokenOut
 }) {
-  const endpoint = userWalletAddress ? `/transactions/${userWalletAddress}` : "/transactions";
-  return await axios.get(endpoint, {
+  const queryParams = new URLSearchParams({
+    receiver: address || "",
+    sender: sender || "",
+    provider: provider || "",
+    status: status || "",
+    tokenIn: tokenIn || "",
+    tokenOut: tokenOut || ""
+  });
+  const params = Object.entries(Object.fromEntries(queryParams.entries()));
+  for (const [key, value] of params) {
+    if (value === "") {
+      queryParams.delete(key);
+    }
+  }
+  const queryString = queryParams.toString();
+  const endpointWithParams = `/transactions?${queryString}`;
+  return await axios.get(endpointWithParams, {
     baseURL: url
   });
 }

package/api/tests/getTokens.spec.js

@@ -9,7 +9,7 @@ describe("getTokens", () => {
   it("fetches tokens successfully without chainId", async () => {
     const response = [
       {
-        chainId: 1,
+        chainId: "1",
         address: "0x123",
         name: "Token One",
         symbol: "T1",
@@ -32,7 +32,7 @@ describe("getTokens", () => {
     const chainId = 1;
     const response = [
       {
-        chainId: 1,
+        chainId: "1",
         address: "0x123",
         name: "Token One",
         symbol: "T1",

package/api/tests/getTokens.spec.mjs

@@ -7,7 +7,7 @@ describe("getTokens", () => {
   it("fetches tokens successfully without chainId", async () => {
     const response = [
       {
-        chainId: 1,
+        chainId: "1",
         address: "0x123",
         name: "Token One",
         symbol: "T1",
@@ -30,7 +30,7 @@ describe("getTokens", () => {
     const chainId = 1;
     const response = [
       {
-        chainId: 1,
+        chainId: "1",
         address: "0x123",
         name: "Token One",
         symbol: "T1",

package/api/tests/getTransactions.spec.js

@@ -7,87 +7,97 @@ jest.mock("axios");
 const mockedAxios = axios;
 describe("getTransactions", () => {
   const url = "https://api.example.com";
-  it("fetches transactions without userWalletAddress", async () => {
-    const userWalletAddress = "";
-    const response = [
-      {
-        fromChainId: "97",
-        toChainId: "44",
-        tokenIn: "0x063b637324e6115f8da67f761A99B7F00B7Fd908",
-        tokenOut: "USDT-58d5d0",
-        amountIn: "11000000",
-        amountOut: "11000000",
-        depositTimestamp: 1738054613,
-        sender: "0x1009c2f59e03c383ca8f2766cfe305a1e79f4c8d",
-        status: "success",
-        receiver: "erd1sp0aaszznqnuvyvkmxkv2ultcvlf637c093sfc26dszks60jdqsqy2knqu",
-        txHash: "0xe7e706c1793d06a252a3f040f07732989e4a6466d804cae17105c09818bc2994",
-        fee: "0",
-        provider: types_providerType.ProviderType.MultiversxBridge
-      }
-    ];
-    mockedAxios.get.mockResolvedValue({ data: response });
-    const result = await api_getTransactions.getTransactions({ url, userWalletAddress });
-    expect(mockedAxios.get).toHaveBeenCalledWith("/transactions", {
+  const mockResponse = [
+    {
+      fromChainId: "97",
+      toChainId: "44",
+      tokenIn: "0x063b637324e6115f8da67f761A99B7F00B7Fd908",
+      tokenOut: "USDT-58d5d0",
+      amountIn: "11000000",
+      amountOut: "11000000",
+      depositTimestamp: 1738054613,
+      sender: "0x1009c2f59e03c383ca8f2766cfe305a1e79f4c8d",
+      status: "success",
+      receiver: "erd1sp0aaszznqnuvyvkmxkv2ultcvlf637c093sfc26dszks60jdqsqy2knqu",
+      txHash: "0xe7e706c1793d06a252a3f040f07732989e4a6466d804cae17105c09818bc2994",
+      fee: "0",
+      provider: types_providerType.ProviderType.MultiversxBridge
+    }
+  ];
+  beforeEach(() => {
+    mockedAxios.get.mockClear();
+    mockedAxios.get.mockResolvedValue({ data: mockResponse });
+  });
+  it("fetches transactions with only address parameter", async () => {
+    const address = "0x123";
+    const result = await api_getTransactions.getTransactions({ url, address });
+    expect(mockedAxios.get).toHaveBeenCalledWith(
+      "/transactions?receiver=0x123",
+      { baseURL: url }
+    );
+    expect(result.data).toEqual(mockResponse);
+  });
+  it("fetches transactions with empty address", async () => {
+    const address = "";
+    const result = await api_getTransactions.getTransactions({ url, address });
+    expect(mockedAxios.get).toHaveBeenCalledWith("/transactions?", {
       baseURL: url
     });
-    expect(result.data).toEqual(response);
+    expect(result.data).toEqual(mockResponse);
   });
-  it("fetches transactions with userWalletAddress", async () => {
-    const userWalletAddress = "0x123";
-    const response = [
-      {
-        fromChainId: "97",
-        toChainId: "44",
-        tokenIn: "0x063b637324e6115f8da67f761A99B7F00B7Fd908",
-        tokenOut: "USDT-58d5d0",
-        amountIn: "11000000",
-        amountOut: "11000000",
-        depositTimestamp: 1738054613,
-        sender: "0x1009c2f59e03c383ca8f2766cfe305a1e79f4c8d",
-        status: "success",
-        receiver: "erd1sp0aaszznqnuvyvkmxkv2ultcvlf637c093sfc26dszks60jdqsqy2knqu",
-        txHash: "0xe7e706c1793d06a252a3f040f07732989e4a6466d804cae17105c09818bc2994",
-        fee: "0",
-        provider: types_providerType.ProviderType.MultiversxBridge
-      }
-    ];
-    mockedAxios.get.mockResolvedValue({ data: response });
-    const result = await api_getTransactions.getTransactions({ url, userWalletAddress });
+  it("includes all non-empty parameters in the query", async () => {
+    const result = await api_getTransactions.getTransactions({
+      url,
+      address: "0x123",
+      sender: "0xABC",
+      provider: types_providerType.ProviderType.MultiversxBridge,
+      status: "success",
+      tokenIn: "0xTOKEN",
+      tokenOut: "WEGLD-123456"
+    });
     expect(mockedAxios.get).toHaveBeenCalledWith(
-      `/transactions/${userWalletAddress}`,
+      "/transactions?receiver=0x123&sender=0xABC&provider=multiversx-bridge&status=success&tokenIn=0xTOKEN&tokenOut=WEGLD-123456",
       { baseURL: url }
     );
-    expect(result.data).toEqual(response);
+    expect(result.data).toEqual(mockResponse);
   });
-  it("fetches transactions with both transactionId and userWalletAddress", async () => {
-    const userWalletAddress = "0x123";
-    const response = [
-      {
-        fromChainId: "97",
-        toChainId: "44",
-        tokenIn: "0x063b637324e6115f8da67f761A99B7F00B7Fd908",
-        tokenOut: "USDT-58d5d0",
-        amountIn: "11000000",
-        amountOut: "11000000",
-        depositTimestamp: 1738054613,
-        sender: "0x1009c2f59e03c383ca8f2766cfe305a1e79f4c8d",
-        status: "success",
-        receiver: "erd1sp0aaszznqnuvyvkmxkv2ultcvlf637c093sfc26dszks60jdqsqy2knqu",
-        txHash: "0xe7e706c1793d06a252a3f040f07732989e4a6466d804cae17105c09818bc2994",
-        fee: "0",
-        provider: types_providerType.ProviderType.MultiversxBridge
-      }
-    ];
-    mockedAxios.get.mockResolvedValue({ data: response });
+  it("excludes empty parameters from the query", async () => {
     const result = await api_getTransactions.getTransactions({
       url,
-      userWalletAddress
+      address: "0x123",
+      sender: "",
+      provider: types_providerType.ProviderType.MultiversxBridge,
+      status: "",
+      tokenIn: "0xTOKEN",
+      tokenOut: ""
     });
     expect(mockedAxios.get).toHaveBeenCalledWith(
-      `/transactions/${userWalletAddress}`,
+      "/transactions?receiver=0x123&provider=multiversx-bridge&tokenIn=0xTOKEN",
       { baseURL: url }
     );
-    expect(result.data).toEqual(response);
+    expect(result.data).toEqual(mockResponse);
+  });
+  it("handles axios error", async () => {
+    const error = new Error("Network error");
+    mockedAxios.get.mockRejectedValueOnce(error);
+    await expect(api_getTransactions.getTransactions({ url, address: "0x123" })).rejects.toThrow(
+      "Network error"
+    );
+    expect(mockedAxios.get).toHaveBeenCalledWith(
+      "/transactions?receiver=0x123",
+      { baseURL: url }
+    );
+  });
+  it("passes through axios response", async () => {
+    const axiosResponse = {
+      data: mockResponse,
+      status: 200,
+      statusText: "OK",
+      headers: {},
+      config: {}
+    };
+    mockedAxios.get.mockResolvedValueOnce(axiosResponse);
+    const result = await api_getTransactions.getTransactions({ url, address: "0x123" });
+    expect(result).toEqual(axiosResponse);
   });
 });

package/api/tests/getTransactions.spec.mjs

@@ -5,87 +5,97 @@ jest.mock("axios");
 const mockedAxios = axios;
 describe("getTransactions", () => {
   const url = "https://api.example.com";
-  it("fetches transactions without userWalletAddress", async () => {
-    const userWalletAddress = "";
-    const response = [
-      {
-        fromChainId: "97",
-        toChainId: "44",
-        tokenIn: "0x063b637324e6115f8da67f761A99B7F00B7Fd908",
-        tokenOut: "USDT-58d5d0",
-        amountIn: "11000000",
-        amountOut: "11000000",
-        depositTimestamp: 1738054613,
-        sender: "0x1009c2f59e03c383ca8f2766cfe305a1e79f4c8d",
-        status: "success",
-        receiver: "erd1sp0aaszznqnuvyvkmxkv2ultcvlf637c093sfc26dszks60jdqsqy2knqu",
-        txHash: "0xe7e706c1793d06a252a3f040f07732989e4a6466d804cae17105c09818bc2994",
-        fee: "0",
-        provider: ProviderType.MultiversxBridge
-      }
-    ];
-    mockedAxios.get.mockResolvedValue({ data: response });
-    const result = await getTransactions({ url, userWalletAddress });
-    expect(mockedAxios.get).toHaveBeenCalledWith("/transactions", {
+  const mockResponse = [
+    {
+      fromChainId: "97",
+      toChainId: "44",
+      tokenIn: "0x063b637324e6115f8da67f761A99B7F00B7Fd908",
+      tokenOut: "USDT-58d5d0",
+      amountIn: "11000000",
+      amountOut: "11000000",
+      depositTimestamp: 1738054613,
+      sender: "0x1009c2f59e03c383ca8f2766cfe305a1e79f4c8d",
+      status: "success",
+      receiver: "erd1sp0aaszznqnuvyvkmxkv2ultcvlf637c093sfc26dszks60jdqsqy2knqu",
+      txHash: "0xe7e706c1793d06a252a3f040f07732989e4a6466d804cae17105c09818bc2994",
+      fee: "0",
+      provider: ProviderType.MultiversxBridge
+    }
+  ];
+  beforeEach(() => {
+    mockedAxios.get.mockClear();
+    mockedAxios.get.mockResolvedValue({ data: mockResponse });
+  });
+  it("fetches transactions with only address parameter", async () => {
+    const address = "0x123";
+    const result = await getTransactions({ url, address });
+    expect(mockedAxios.get).toHaveBeenCalledWith(
+      "/transactions?receiver=0x123",
+      { baseURL: url }
+    );
+    expect(result.data).toEqual(mockResponse);
+  });
+  it("fetches transactions with empty address", async () => {
+    const address = "";
+    const result = await getTransactions({ url, address });
+    expect(mockedAxios.get).toHaveBeenCalledWith("/transactions?", {
       baseURL: url
     });
-    expect(result.data).toEqual(response);
+    expect(result.data).toEqual(mockResponse);
   });
-  it("fetches transactions with userWalletAddress", async () => {
-    const userWalletAddress = "0x123";
-    const response = [
-      {
-        fromChainId: "97",
-        toChainId: "44",
-        tokenIn: "0x063b637324e6115f8da67f761A99B7F00B7Fd908",
-        tokenOut: "USDT-58d5d0",
-        amountIn: "11000000",
-        amountOut: "11000000",
-        depositTimestamp: 1738054613,
-        sender: "0x1009c2f59e03c383ca8f2766cfe305a1e79f4c8d",
-        status: "success",
-        receiver: "erd1sp0aaszznqnuvyvkmxkv2ultcvlf637c093sfc26dszks60jdqsqy2knqu",
-        txHash: "0xe7e706c1793d06a252a3f040f07732989e4a6466d804cae17105c09818bc2994",
-        fee: "0",
-        provider: ProviderType.MultiversxBridge
-      }
-    ];
-    mockedAxios.get.mockResolvedValue({ data: response });
-    const result = await getTransactions({ url, userWalletAddress });
+  it("includes all non-empty parameters in the query", async () => {
+    const result = await getTransactions({
+      url,
+      address: "0x123",
+      sender: "0xABC",
+      provider: ProviderType.MultiversxBridge,
+      status: "success",
+      tokenIn: "0xTOKEN",
+      tokenOut: "WEGLD-123456"
+    });
     expect(mockedAxios.get).toHaveBeenCalledWith(
-      `/transactions/${userWalletAddress}`,
+      "/transactions?receiver=0x123&sender=0xABC&provider=multiversx-bridge&status=success&tokenIn=0xTOKEN&tokenOut=WEGLD-123456",
       { baseURL: url }
     );
-    expect(result.data).toEqual(response);
+    expect(result.data).toEqual(mockResponse);
   });
-  it("fetches transactions with both transactionId and userWalletAddress", async () => {
-    const userWalletAddress = "0x123";
-    const response = [
-      {
-        fromChainId: "97",
-        toChainId: "44",
-        tokenIn: "0x063b637324e6115f8da67f761A99B7F00B7Fd908",
-        tokenOut: "USDT-58d5d0",
-        amountIn: "11000000",
-        amountOut: "11000000",
-        depositTimestamp: 1738054613,
-        sender: "0x1009c2f59e03c383ca8f2766cfe305a1e79f4c8d",
-        status: "success",
-        receiver: "erd1sp0aaszznqnuvyvkmxkv2ultcvlf637c093sfc26dszks60jdqsqy2knqu",
-        txHash: "0xe7e706c1793d06a252a3f040f07732989e4a6466d804cae17105c09818bc2994",
-        fee: "0",
-        provider: ProviderType.MultiversxBridge
-      }
-    ];
-    mockedAxios.get.mockResolvedValue({ data: response });
+  it("excludes empty parameters from the query", async () => {
     const result = await getTransactions({
       url,
-      userWalletAddress
+      address: "0x123",
+      sender: "",
+      provider: ProviderType.MultiversxBridge,
+      status: "",
+      tokenIn: "0xTOKEN",
+      tokenOut: ""
     });
     expect(mockedAxios.get).toHaveBeenCalledWith(
-      `/transactions/${userWalletAddress}`,
+      "/transactions?receiver=0x123&provider=multiversx-bridge&tokenIn=0xTOKEN",
       { baseURL: url }
     );
-    expect(result.data).toEqual(response);
+    expect(result.data).toEqual(mockResponse);
+  });
+  it("handles axios error", async () => {
+    const error = new Error("Network error");
+    mockedAxios.get.mockRejectedValueOnce(error);
+    await expect(getTransactions({ url, address: "0x123" })).rejects.toThrow(
+      "Network error"
+    );
+    expect(mockedAxios.get).toHaveBeenCalledWith(
+      "/transactions?receiver=0x123",
+      { baseURL: url }
+    );
+  });
+  it("passes through axios response", async () => {
+    const axiosResponse = {
+      data: mockResponse,
+      status: 200,
+      statusText: "OK",
+      headers: {},
+      config: {}
+    };
+    mockedAxios.get.mockResolvedValueOnce(axiosResponse);
+    const result = await getTransactions({ url, address: "0x123" });
+    expect(result).toEqual(axiosResponse);
   });
 });

package/constants/index.d.ts

@@ -1 +1,2 @@
-export declare const MVX_CHAIN_IDS: number[];
+export declare const MVX_CHAIN_IDS: string[];
+export declare const NON_EVM_CHAIN_IDS_MAP: Record<string, string>;

package/constants/index.js

@@ -1,5 +1,15 @@
 #!/usr/bin/env node
 "use strict";
 Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
-const MVX_CHAIN_IDS = [31, 44, 54];
+const MVX_CHAIN_IDS = ["31", "44", "54"];
+const NON_EVM_CHAIN_IDS_MAP = {
+  "0": "000000000019d6689c085ae165831e93",
+  // Bitcoin
+  // TODO chain ID to be defined at the API level
+  "-1": "000000000933ea01ad0ee984209779ba",
+  // Bitcoin Testnet
+  "101": "5eykt4UsFv8P8NJdTREpY1vzqKqZKvdp",
+  "103": "EtWTRABZaYq6iMfeYKouRu166VU2xqa1"
+};
 exports.MVX_CHAIN_IDS = MVX_CHAIN_IDS;
+exports.NON_EVM_CHAIN_IDS_MAP = NON_EVM_CHAIN_IDS_MAP;

package/constants/index.mjs

@@ -1,4 +1,14 @@
-const MVX_CHAIN_IDS = [31, 44, 54];
+const MVX_CHAIN_IDS = ["31", "44", "54"];
+const NON_EVM_CHAIN_IDS_MAP = {
+  "0": "000000000019d6689c085ae165831e93",
+  // Bitcoin
+  // TODO chain ID to be defined at the API level
+  "-1": "000000000933ea01ad0ee984209779ba",
+  // Bitcoin Testnet
+  "101": "5eykt4UsFv8P8NJdTREpY1vzqKqZKvdp",
+  "103": "EtWTRABZaYq6iMfeYKouRu166VU2xqa1"
+};
 export {
-  MVX_CHAIN_IDS
+  MVX_CHAIN_IDS,
+  NON_EVM_CHAIN_IDS_MAP
 };

package/dto/Chain.dto.d.ts

@@ -1,9 +1,11 @@
+import { ChainType } from '../types/chainType';
+
 export interface ChainDTO {
     chainId: string;
     chainName: string;
     pngUrl: string;
     svgUrl: string;
-    chainType: string;
+    chainType: ChainType;
     rpc: string;
     networkName: string;
     nativeCurrency: {

package/dto/ConfirmRate.dto.d.ts

@@ -8,4 +8,5 @@ export interface ConfirmRateDto extends RateRequestResponse {
     toChainId: string;
     sender: string;
     receiver: string;
+    backUrl?: string;
 }

package/dto/Token.dto.d.ts

@@ -1,5 +1,5 @@
 export interface TokenDTO {
-    chainId: number;
+    chainId: string;
     address: string;
     name: string;
     symbol: string;
@@ -12,4 +12,5 @@ export interface TokenDTO {
         maxBridgeAmount: string;
     };
     availableTokens?: string[];
+    isNative?: boolean;
 }