@multiversx/sdk-dapp-liquidity 0.2.0-alpha.1

package/README.md

@@ -0,0 +1,186 @@
+# @multiversx/mx-sdk-dapp-liquidity
+
+## Overview
+
+Generic SDK for multi-chain wallet connections and transaction signing.
+
+## Installation
+
+```bash
+npm install @multiversx/mx-sdk-dapp-liquidity
+```
+
+## Commands
+
+### Install dependencies
+
+```bash
+yarn
+```
+
+### Start
+
+```bash
+yarn start
+```
+
+### Build
+
+```bash
+yarn build
+```
+
+### Build and watch
+
+```bash
+yarn build:watch
+```
+
+### Test
+
+```bash
+yarn test
+```
+
+### Lint
+
+```bash
+yarn lint
+```
+
+### Release (publish)
+
+```bash
+yarn publish-package
+```
+
+### Release next version (publish)
+
+```bash
+yarn publish-package-next
+```
+
+## Usage
+
+```css
+@import 'node_modules/@multiversx/mx-sdk-dapp-liquidity/style.css';
+```
+
+```tsx
+import { init, Web3AppProvider, AppKitNetwork, BridgeForm, TransactionToastContainer } from '@multiversx/sdk-dapp-liquidity';
+
+const metadata = {
+  name: 'AppName',
+  description: 'AppName Example',
+  url: 'https://example.com', // origin must match your domain & subdomain
+  icons: ['https://avatars.githubusercontent.com/u/179229932']
+};
+const projectId = "@reown project id";
+const provider = init({
+  /**
+   * @reown AppKit options
+   */
+  appKitOptions: {
+    allowUnsupportedChain: true,
+    projectId,
+    metadata,
+    connectorImages: {
+      injected: 'https://avatars.githubusercontent.com/u/179229932',
+      walletConnect: 'https://avatars.githubusercontent.com/u/37784886?s=200&v=4',
+      "io.metamask": 'https://avatars.githubusercontent.com/u/11744586?s=200&v=4',
+      "com.trustwallet.app": 'https://avatars.githubusercontent.com/u/32179889?s=200&v=4',
+    },
+    themeMode: "dark",
+    themeVariables: {
+      "--w3m-font-family": "Roobert,system-ui,sans-serif",
+    },
+    features: {
+      email: false,
+      socials: false,
+    }
+  },
+  /**
+   * WagmiAdapter config
+   */
+  adapterConfig: {
+    ssr: true,
+  },
+  /**
+   * Accepted chain IDs. The chains with ids [31, 44, 54] will be ignored as these are mapped to the mvx networks as [1, D, T]
+   */
+  acceptedChainIDs: ["97", "4002"],
+  /**
+   * Accepted connectors IDs
+   */
+  acceptedConnectorsIDs: [
+    'io.metamask',
+    'com.trustwallet.app',
+    'walletconnect'
+  ],
+  /**
+   * Liquidity API URL
+   */
+  apiURL: "https://devnet-tools.multiversx.com/liquidity-sdk",
+  /**
+   * Bridge URL. This is used to redirect the user to the bridge status page for tracking transactions (history). Will be removed in the next major release.
+   */
+  bridgeURL: "https://devnet-bridge.multiversx.com",
+  /**
+   * MultiversX API URL
+   */
+  mvxApiURL: "https://devnet-api.multiversx.com",
+  /**
+   * MultiversX Explorer URL
+   */
+  mvxExplorerAddress: "https://devnet-explorer.multiversx.com",
+  /**
+   * MultiversX Chain ID
+   * Possible options 31 | 44 | 54 which are mapped to 1 | D | T
+   */
+  mvxChainId: "44",
+});
+
+const App = () => {
+  const [showHistory, setShowHistory] = useState(false);
+  
+  const mvxAccount = useGetAccount();
+  const evmAccount = useAccount();
+  const nativeAuthToken = useGetNativeAuthToken();
+
+  const onConnectToMvx = async () => {
+    // Login to MultiversX
+  }
+    
+  const onDisconnectFromMvx = async () => {
+    // Logout from MultiversX
+  }
+  
+  const onHistoryClose = () => {
+    setShowHistory(false);
+  }
+  
+  return (
+    // Wrap your app with Web3AppProvider to enable multi-chain connections
+    <Web3AppProvider appKit={provider.appKit} config={provider.config} options={provider.options}>
+      <BridgeForm
+        mvxChainId={"44"}
+        mvxAddress={mvxAccount?.address}
+        username={mvxAccount?.username}
+        nativeAuthToken={nativeAuthToken}
+        callbackRoute={"/deposit"}
+        showHistory={showHistory}
+        onSuccessfullySentTransaction={(txHashes) => {
+          // DO SOMETHING
+        }}
+        onFailedSentTransaction={() => {
+          // DO SOMETHING
+        }}
+        onHistoryClose={onHistoryClose}
+        onMvxConnect={onConnectToMvx}
+        onMvxDisconnect={onDisconnectFromMvx}
+      />
+      <TransactionToastContainer theme="colored" />
+    </Web3AppProvider>
+  )
+}
+```

package/all-networks-EJIVYZ_i.mjs

@@ -0,0 +1,4 @@
+const AllNetworks = "data:image/svg+xml,%3csvg%20width='24'%20height='24'%20viewBox='0%200%2024%2024'%20fill='none'%20xmlns='http://www.w3.org/2000/svg'%3e%3cg%20clip-path='url(%23clip0_800_5975)'%3e%3crect%20width='16'%20height='16'%20rx='4'%20fill='%23627EEA'/%3e%3cg%20clip-path='url(%23clip1_800_5975)'%3e%3cpath%20d='M8%2016C12.4183%2016%2016%2012.4183%2016%208C16%203.58172%2012.4183%200%208%200C3.58172%200%200%203.58172%200%208C0%2012.4183%203.58172%2016%208%2016Z'%20fill='%23627EEA'/%3e%3cpath%20d='M8.24902%202V6.435L11.9975%208.11L8.24902%202Z'%20fill='white'%20fill-opacity='0.602'/%3e%3cpath%20d='M8.249%202L4.5%208.11L8.249%206.435V2Z'%20fill='white'/%3e%3cpath%20d='M8.24902%2010.9841V13.9976L12%208.80811L8.24902%2010.9841Z'%20fill='white'%20fill-opacity='0.602'/%3e%3cpath%20d='M8.249%2013.9976V10.9836L4.5%208.80811L8.249%2013.9976Z'%20fill='white'/%3e%3cpath%20d='M8.24902%2010.2865L11.9975%208.11004L8.24902%206.43604V10.2865Z'%20fill='white'%20fill-opacity='0.2'/%3e%3cpath%20d='M4.5%208.11004L8.249%2010.2865V6.43604L4.5%208.11004Z'%20fill='white'%20fill-opacity='0.602'/%3e%3c/g%3e%3c/g%3e%3crect%20x='8'%20y='8'%20width='16'%20height='16'%20rx='4'%20fill='%23F0B90B'/%3e%3cpath%20d='M12.703%2015.9785L11.3515%2017.3252L10%2015.9785L11.3515%2014.6319L12.703%2015.9785ZM16%2012.6933L18.3168%2015.0166L19.6683%2013.67L17.3515%2011.3466L16%2010L14.6485%2011.3466L12.3168%2013.67L13.6683%2015.0166L16%2012.6933ZM20.6485%2014.6319L19.297%2015.9785L20.6485%2017.3252C21.1763%2016.7993%2021.4722%2016.5044%2022%2015.9785L20.6485%2014.6319ZM16%2019.2489L13.6832%2016.9404L12.3168%2018.2871L14.6337%2020.5956L15.9852%2021.9422L17.3366%2020.5956L19.6683%2018.2871L18.3168%2016.9404L16%2019.2489ZM16%2017.3252L17.3515%2015.9785L16%2014.6319L14.6485%2015.9785L16%2017.3252Z'%20fill='white'/%3e%3cdefs%3e%3cclipPath%20id='clip0_800_5975'%3e%3crect%20width='16'%20height='16'%20rx='4'%20fill='white'/%3e%3c/clipPath%3e%3cclipPath%20id='clip1_800_5975'%3e%3crect%20width='16'%20height='16'%20fill='white'/%3e%3c/clipPath%3e%3c/defs%3e%3c/svg%3e";
+export {
+  AllNetworks as A
+};

package/all-networks-NYACMyeN.js

@@ -0,0 +1,4 @@
+#!/usr/bin/env node
+"use strict";
+const AllNetworks = "data:image/svg+xml,%3csvg%20width='24'%20height='24'%20viewBox='0%200%2024%2024'%20fill='none'%20xmlns='http://www.w3.org/2000/svg'%3e%3cg%20clip-path='url(%23clip0_800_5975)'%3e%3crect%20width='16'%20height='16'%20rx='4'%20fill='%23627EEA'/%3e%3cg%20clip-path='url(%23clip1_800_5975)'%3e%3cpath%20d='M8%2016C12.4183%2016%2016%2012.4183%2016%208C16%203.58172%2012.4183%200%208%200C3.58172%200%200%203.58172%200%208C0%2012.4183%203.58172%2016%208%2016Z'%20fill='%23627EEA'/%3e%3cpath%20d='M8.24902%202V6.435L11.9975%208.11L8.24902%202Z'%20fill='white'%20fill-opacity='0.602'/%3e%3cpath%20d='M8.249%202L4.5%208.11L8.249%206.435V2Z'%20fill='white'/%3e%3cpath%20d='M8.24902%2010.9841V13.9976L12%208.80811L8.24902%2010.9841Z'%20fill='white'%20fill-opacity='0.602'/%3e%3cpath%20d='M8.249%2013.9976V10.9836L4.5%208.80811L8.249%2013.9976Z'%20fill='white'/%3e%3cpath%20d='M8.24902%2010.2865L11.9975%208.11004L8.24902%206.43604V10.2865Z'%20fill='white'%20fill-opacity='0.2'/%3e%3cpath%20d='M4.5%208.11004L8.249%2010.2865V6.43604L4.5%208.11004Z'%20fill='white'%20fill-opacity='0.602'/%3e%3c/g%3e%3c/g%3e%3crect%20x='8'%20y='8'%20width='16'%20height='16'%20rx='4'%20fill='%23F0B90B'/%3e%3cpath%20d='M12.703%2015.9785L11.3515%2017.3252L10%2015.9785L11.3515%2014.6319L12.703%2015.9785ZM16%2012.6933L18.3168%2015.0166L19.6683%2013.67L17.3515%2011.3466L16%2010L14.6485%2011.3466L12.3168%2013.67L13.6683%2015.0166L16%2012.6933ZM20.6485%2014.6319L19.297%2015.9785L20.6485%2017.3252C21.1763%2016.7993%2021.4722%2016.5044%2022%2015.9785L20.6485%2014.6319ZM16%2019.2489L13.6832%2016.9404L12.3168%2018.2871L14.6337%2020.5956L15.9852%2021.9422L17.3366%2020.5956L19.6683%2018.2871L18.3168%2016.9404L16%2019.2489ZM16%2017.3252L17.3515%2015.9785L16%2014.6319L14.6485%2015.9785L16%2017.3252Z'%20fill='white'/%3e%3cdefs%3e%3cclipPath%20id='clip0_800_5975'%3e%3crect%20width='16'%20height='16'%20rx='4'%20fill='white'/%3e%3c/clipPath%3e%3cclipPath%20id='clip1_800_5975'%3e%3crect%20width='16'%20height='16'%20fill='white'/%3e%3c/clipPath%3e%3c/defs%3e%3c/svg%3e";
+exports.AllNetworks = AllNetworks;

package/api/confirmRate.d.ts

@@ -0,0 +1,11 @@
+import { ServerTransaction } from '../types/transaction';
+import { ConfirmRateDto } from '../dto/ConfirmRate.dto.ts';
+import { AxiosResponse } from 'axios';
+
+type ConfirmRateProps = {
+    url: string;
+    nativeAuthToken: string;
+    body: ConfirmRateDto;
+};
+export declare function confirmRate({ url, nativeAuthToken, body }: ConfirmRateProps): Promise<AxiosResponse<ServerTransaction[]>>;
+export {};

package/api/confirmRate.js

@@ -0,0 +1,30 @@
+#!/usr/bin/env node
+"use strict";
+Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
+const axios = require("axios");
+const helpers_decodeToken = require("../helpers/decodeToken.js");
+async function confirmRate({
+  url,
+  nativeAuthToken,
+  body
+}) {
+  var _a;
+  const config = {
+    baseURL: url,
+    headers: {
+      Authorization: `Bearer ${nativeAuthToken}`
+    }
+  };
+  if (!nativeAuthToken) {
+    (_a = config.headers) == null ? true : delete _a.Authorization;
+  }
+  const decodedToken = await helpers_decodeToken.decodeToken(nativeAuthToken);
+  if (config.headers.set) {
+    config.headers.set({
+      ...config.headers,
+      origin: (decodedToken == null ? void 0 : decodedToken.origin) ?? ""
+    });
+  }
+  return await axios.post(`/rate/confirm`, body, config);
+}
+exports.confirmRate = confirmRate;

package/api/confirmRate.mjs

@@ -0,0 +1,29 @@
+import axios from "axios";
+import { decodeToken } from "../helpers/decodeToken.mjs";
+async function confirmRate({
+  url,
+  nativeAuthToken,
+  body
+}) {
+  var _a;
+  const config = {
+    baseURL: url,
+    headers: {
+      Authorization: `Bearer ${nativeAuthToken}`
+    }
+  };
+  if (!nativeAuthToken) {
+    (_a = config.headers) == null ? true : delete _a.Authorization;
+  }
+  const decodedToken = await decodeToken(nativeAuthToken);
+  if (config.headers.set) {
+    config.headers.set({
+      ...config.headers,
+      origin: (decodedToken == null ? void 0 : decodedToken.origin) ?? ""
+    });
+  }
+  return await axios.post(`/rate/confirm`, body, config);
+}
+export {
+  confirmRate
+};

package/api/getChains.d.ts

@@ -0,0 +1,6 @@
+import { ChainDTO } from '../dto/Chain.dto';
+import { AxiosResponse } from 'axios';
+
+export declare function getChains({ url }: {
+    url: string;
+}): Promise<AxiosResponse<ChainDTO[]>>;

package/api/getChains.js

@@ -0,0 +1,12 @@
+#!/usr/bin/env node
+"use strict";
+Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
+const axios = require("axios");
+async function getChains({
+  url
+}) {
+  return await axios.get("/chains", {
+    baseURL: url
+  });
+}
+exports.getChains = getChains;

package/api/getChains.mjs

@@ -0,0 +1,11 @@
+import axios from "axios";
+async function getChains({
+  url
+}) {
+  return await axios.get("/chains", {
+    baseURL: url
+  });
+}
+export {
+  getChains
+};

package/api/getRate.d.ts

@@ -0,0 +1,10 @@
+import { RateRequestBody, RateRequestResponse } from 'types/rate';
+import { AxiosResponse } from 'axios';
+
+interface RateProps {
+    url: string;
+    nativeAuthToken: string;
+    body: RateRequestBody;
+}
+export declare function getRate({ url, nativeAuthToken, body }: RateProps): Promise<AxiosResponse<RateRequestResponse>>;
+export {};

package/api/getRate.js

@@ -0,0 +1,28 @@
+#!/usr/bin/env node
+"use strict";
+Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
+const axios = require("axios");
+const helpers_decodeToken = require("../helpers/decodeToken.js");
+async function getRate({
+  url,
+  nativeAuthToken,
+  body
+}) {
+  var _a;
+  const config = {
+    baseURL: url,
+    headers: {
+      Authorization: `Bearer ${nativeAuthToken}`
+    }
+  };
+  if (!nativeAuthToken) {
+    (_a = config.headers) == null ? true : delete _a.Authorization;
+  }
+  const decodedToken = await helpers_decodeToken.decodeToken(nativeAuthToken);
+  config.headers = {
+    ...config.headers,
+    origin: decodedToken == null ? void 0 : decodedToken.origin
+  };
+  return await axios.post(`/rate`, body, config);
+}
+exports.getRate = getRate;

package/api/getRate.mjs

@@ -0,0 +1,27 @@
+import axios from "axios";
+import { decodeToken } from "../helpers/decodeToken.mjs";
+async function getRate({
+  url,
+  nativeAuthToken,
+  body
+}) {
+  var _a;
+  const config = {
+    baseURL: url,
+    headers: {
+      Authorization: `Bearer ${nativeAuthToken}`
+    }
+  };
+  if (!nativeAuthToken) {
+    (_a = config.headers) == null ? true : delete _a.Authorization;
+  }
+  const decodedToken = await decodeToken(nativeAuthToken);
+  config.headers = {
+    ...config.headers,
+    origin: decodedToken == null ? void 0 : decodedToken.origin
+  };
+  return await axios.post(`/rate`, body, config);
+}
+export {
+  getRate
+};

package/api/getTokens.d.ts

@@ -0,0 +1,7 @@
+import { TokenType } from '../types/token';
+import { AxiosResponse } from 'axios';
+
+export declare function getTokens({ url, chainId }: {
+    url: string;
+    chainId?: number;
+}): Promise<AxiosResponse<TokenType[]>>;

package/api/getTokens.js

@@ -0,0 +1,14 @@
+#!/usr/bin/env node
+"use strict";
+Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
+const axios = require("axios");
+async function getTokens({
+  url,
+  chainId
+}) {
+  const endpoint = chainId ? `/tokens/${chainId}` : "/tokens";
+  return await axios.get(endpoint, {
+    baseURL: url
+  });
+}
+exports.getTokens = getTokens;

package/api/getTokens.mjs

@@ -0,0 +1,13 @@
+import axios from "axios";
+async function getTokens({
+  url,
+  chainId
+}) {
+  const endpoint = chainId ? `/tokens/${chainId}` : "/tokens";
+  return await axios.get(endpoint, {
+    baseURL: url
+  });
+}
+export {
+  getTokens
+};

package/api/getTokensBalances.d.ts

@@ -0,0 +1,8 @@
+import { TokenBalanceDTO } from '../dto/TokenBalance.dto';
+import { AxiosResponse } from 'axios';
+
+export declare function getTokensBalances({ url, userAddress, chainId }: {
+    url: string;
+    userAddress: string;
+    chainId: string;
+}): Promise<AxiosResponse<TokenBalanceDTO[]>>;

package/api/getTokensBalances.js

@@ -0,0 +1,17 @@
+#!/usr/bin/env node
+"use strict";
+Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
+const axios = require("axios");
+async function getTokensBalances({
+  url,
+  userAddress,
+  chainId
+}) {
+  return await axios.get(
+    `/tokens/balances/${userAddress}/${chainId}`,
+    {
+      baseURL: url
+    }
+  );
+}
+exports.getTokensBalances = getTokensBalances;

package/api/getTokensBalances.mjs

@@ -0,0 +1,16 @@
+import axios from "axios";
+async function getTokensBalances({
+  url,
+  userAddress,
+  chainId
+}) {
+  return await axios.get(
+    `/tokens/balances/${userAddress}/${chainId}`,
+    {
+      baseURL: url
+    }
+  );
+}
+export {
+  getTokensBalances
+};

package/api/getTransactions.d.ts

@@ -0,0 +1,7 @@
+import { TransactionDTO } from 'dto/Transaction.dto';
+import { AxiosResponse } from 'axios';
+
+export declare function getTransactions({ url, userWalletAddress }: {
+    url: string;
+    userWalletAddress: string;
+}): Promise<AxiosResponse<TransactionDTO[]>>;

package/api/getTransactions.js

@@ -0,0 +1,14 @@
+#!/usr/bin/env node
+"use strict";
+Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
+const axios = require("axios");
+async function getTransactions({
+  url,
+  userWalletAddress
+}) {
+  const endpoint = userWalletAddress ? `/transactions/${userWalletAddress}` : "/transactions";
+  return await axios.get(endpoint, {
+    baseURL: url
+  });
+}
+exports.getTransactions = getTransactions;

package/api/getTransactions.mjs

@@ -0,0 +1,13 @@
+import axios from "axios";
+async function getTransactions({
+  url,
+  userWalletAddress
+}) {
+  const endpoint = userWalletAddress ? `/transactions/${userWalletAddress}` : "/transactions";
+  return await axios.get(endpoint, {
+    baseURL: url
+  });
+}
+export {
+  getTransactions
+};

package/api/index.d.ts

@@ -0,0 +1,7 @@
+export * from './confirmRate';
+export * from './getChains';
+export * from './getRate';
+export * from './getTokens';
+export * from './getTokensBalances';
+export * from './getTransactions';
+export * from './sendTransactions';

package/api/index.js

@@ -0,0 +1,17 @@
+#!/usr/bin/env node
+"use strict";
+Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
+const api_confirmRate = require("./confirmRate.js");
+const api_getChains = require("./getChains.js");
+const api_getRate = require("./getRate.js");
+const api_getTokens = require("./getTokens.js");
+const api_getTokensBalances = require("./getTokensBalances.js");
+const api_getTransactions = require("./getTransactions.js");
+const api_sendTransactions = require("./sendTransactions.js");
+exports.confirmRate = api_confirmRate.confirmRate;
+exports.getChains = api_getChains.getChains;
+exports.getRate = api_getRate.getRate;
+exports.getTokens = api_getTokens.getTokens;
+exports.getTokensBalances = api_getTokensBalances.getTokensBalances;
+exports.getTransactions = api_getTransactions.getTransactions;
+exports.sendTransactions = api_sendTransactions.sendTransactions;

package/api/index.mjs

@@ -0,0 +1,16 @@
+import { confirmRate } from "./confirmRate.mjs";
+import { getChains } from "./getChains.mjs";
+import { getRate } from "./getRate.mjs";
+import { getTokens } from "./getTokens.mjs";
+import { getTokensBalances } from "./getTokensBalances.mjs";
+import { getTransactions } from "./getTransactions.mjs";
+import { sendTransactions } from "./sendTransactions.mjs";
+export {
+  confirmRate,
+  getChains,
+  getRate,
+  getTokens,
+  getTokensBalances,
+  getTransactions,
+  sendTransactions
+};

package/api/sendTransactions.d.ts

@@ -0,0 +1,11 @@
+import { ServerTransaction } from '../types/transaction';
+import { BatchTransactions } from '../types/batchTransactions';
+import { AxiosRequestConfig, AxiosResponse } from 'axios';
+
+export type SendTransactionsType = {
+    transactions: ServerTransaction[];
+    url: string;
+    token: string;
+    axiosConfig?: AxiosRequestConfig;
+};
+export declare const sendTransactions: ({ transactions, url, token, axiosConfig }: SendTransactionsType) => Promise<AxiosResponse<BatchTransactions>>;

package/api/sendTransactions.js

@@ -0,0 +1,29 @@
+#!/usr/bin/env node
+"use strict";
+Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
+const axios = require("axios");
+const helpers_serializeTransaction = require("../helpers/serializeTransaction.js");
+const sendTransactions = async ({
+  transactions,
+  url,
+  token,
+  axiosConfig
+}) => {
+  const config = {
+    baseURL: url,
+    headers: {
+      "Content-Type": "application/json",
+      Accept: "application/json",
+      Authorization: `Bearer ${token}`
+    },
+    ...axiosConfig
+  };
+  return axios.post(
+    `/transactions`,
+    transactions.map(
+      (transaction) => JSON.parse(helpers_serializeTransaction.serializeTransaction(transaction))
+    ),
+    config
+  );
+};
+exports.sendTransactions = sendTransactions;

package/api/sendTransactions.mjs

@@ -0,0 +1,28 @@
+import axios from "axios";
+import { serializeTransaction } from "../helpers/serializeTransaction.mjs";
+const sendTransactions = async ({
+  transactions,
+  url,
+  token,
+  axiosConfig
+}) => {
+  const config = {
+    baseURL: url,
+    headers: {
+      "Content-Type": "application/json",
+      Accept: "application/json",
+      Authorization: `Bearer ${token}`
+    },
+    ...axiosConfig
+  };
+  return axios.post(
+    `/transactions`,
+    transactions.map(
+      (transaction) => JSON.parse(serializeTransaction(transaction))
+    ),
+    config
+  );
+};
+export {
+  sendTransactions
+};

package/api/tests/confirmRate.spec.d.ts

@@ -0,0 +1 @@
+export {};