@lombard.finance/sdk 2.5.2 → 3.1.0

package/src/provider/utils/getMaxPriorityFeePerGas.ts

@@ -1,25 +0,0 @@
-import BigNumber from 'bignumber.js';
-import Web3 from 'web3';
-
-export async function getMaxPriorityFeePerGas(
-  rpcUrl: string,
-): Promise<BigNumber> {
-  const response = await fetch(rpcUrl, {
-    method: 'POST',
-    headers: {
-      'Content-Type': 'application/json',
-    },
-    body: JSON.stringify({
-      jsonrpc: '2.0',
-      id: 1,
-      method: 'eth_maxPriorityFeePerGas',
-      params: [],
-    }),
-  });
-
-  const data = await response.json();
-
-  const convertedHexValue = Web3.utils.hexToNumber(data?.result);
-
-  return new BigNumber(Number(convertedHexValue));
-}

package/src/sdk/getLBTCExchangeRate/getLBTCExchangeRate.ts

@@ -1,65 +0,0 @@
-import axios from 'axios';
-import BigNumber from 'bignumber.js';
-import { IEnvParam } from '../../common/types/internalTypes';
-import { OChainId, TChainId } from '../../common/types/types';
-import { SATOSHI_SCALE } from '../../common/utils/convertSatoshi';
-import { getApiConfig } from '../apiConfig';
-import { MIN_STAKE_AMOUNT_BTC } from '../const';
-import { getChainNameById } from '../utils/getChainNameById';
-
-type ExchangeRateResponse = {
-  amount_out: string;
-};
-
-export interface IgetLBTCExchangeRateParams extends IEnvParam {
-  /**
-   * The chain id of the asset to get the exchange rate for. Exchange rate is the same for all chains so this param is optional.
-   *
-   * @default OChainId.ethereum
-   */
-  chainId?: TChainId;
-  /**
-   * The amount of the asset to get the exchange rate for. If not provided, the exchange rate will be returned for 1 BTC.
-   *
-   * @default 1
-   */
-  amount?: number;
-}
-
-export interface IgetLBTCExchangeRateResponse {
-  /**
-   * The exchange rate for LBTC:BTC
-   */
-  exchangeRate: number;
-  /**
-   * The minimum amount of the asset to stake
-   */
-  minAmount: number;
-}
-
-/**
- * Retrieves the exchange rate for LBTC.
- *
- * @param {IgetLBTCExchangeRateParams} params
- *
- * @returns {Promise<IgetLBTCExchangeRateResponse>} - The exchange rate.
- */
-export async function getLBTCExchangeRate({
-  env,
-  chainId = OChainId.ethereum,
-  amount = 1,
-}: IgetLBTCExchangeRateParams): Promise<IgetLBTCExchangeRateResponse> {
-  const { baseApiUrl } = getApiConfig(env);
-  const chainIdName = getChainNameById(chainId);
-
-  const { data } = await axios.get<ExchangeRateResponse>(
-    `api/v1/exchange/rate/${chainIdName}`,
-    { baseURL: baseApiUrl, params: { amount } },
-  );
-
-  const minAmount = new BigNumber(MIN_STAKE_AMOUNT_BTC)
-    .multipliedBy(SATOSHI_SCALE)
-    .toFixed();
-
-  return { exchangeRate: +data.amount_out, minAmount: +minAmount };
-}

package/src/sdk/getNetworkFeeSignature/getNetworkFeeSignature.stories.tsx

@@ -1,85 +0,0 @@
-import type { Meta, StoryObj } from '@storybook/react';
-import { defaultEnv } from '@lombard.finance/sdk-common';
-import { Button } from '../../stories/components/Button';
-import { CodeBlock } from '../../stories/components/CodeBlock';
-import { useConnect } from '../../stories/hooks/useConnect';
-import useQuery from '../../stories/hooks/useQuery';
-import {
-  getNetworkFeeSignature,
-  IGetNetworkFeeSignatureParams,
-} from './getNetworkFeeSignature';
-
-const meta = {
-  title: 'SDK/getNetworkFeeSignature',
-  component: StoryView,
-  tags: ['autodocs'],
-} satisfies Meta<typeof StoryView>;
-
-export default meta;
-
-type Story = StoryObj<typeof meta>;
-
-export const WithParams: Story = {
-  args: {
-    env: defaultEnv,
-  },
-};
-
-type GetNetworkFeeSignatureParamsProps = Pick<
-  IGetNetworkFeeSignatureParams,
-  'env'
->;
-
-export function StoryView(props: GetNetworkFeeSignatureParamsProps) {
-  const {
-    data: connectData,
-    error: connectError,
-    isLoading: isConnectLoading,
-    connect,
-  } = useConnect();
-
-  const request = async () => {
-    if (!connectData) {
-      return;
-    }
-
-    return getNetworkFeeSignature({
-      chainId: connectData.chainId,
-      address: connectData.account,
-      ...props,
-    });
-  };
-
-  const { data, error, isLoading, refetch } = useQuery(request, [], false);
-
-  const formattedConnectData = connectData && {
-    account: connectData.account,
-    chainId: connectData.chainId,
-  };
-
-  return (
-    <>
-      <div className="mb-4">
-        <Button
-          onClick={connect}
-          disabled={isConnectLoading}
-          isLoading={isConnectLoading}
-        >
-          Connect
-        </Button>
-
-        <CodeBlock text={connectError || formattedConnectData} />
-      </div>
-
-      <Button
-        onClick={refetch}
-        disabled={isLoading || !connectData}
-        isLoading={isLoading}
-      >
-        Get authorization fee sign
-      </Button>
-
-      <CodeBlock text={error || data} />
-    </>
-  );
-}

package/src/sdk/getUserStakeAndBakeSignature/getUserStakeAndBakeSignature.stories.tsx

@@ -1,86 +0,0 @@
-import type { Meta, StoryObj } from '@storybook/react';
-import { defaultEnv } from '@lombard.finance/sdk-common';
-import { Button } from '../../stories/components/Button';
-import { CodeBlock } from '../../stories/components/CodeBlock';
-import { useConnect } from '../../stories/hooks/useConnect';
-import useQuery from '../../stories/hooks/useQuery';
-import {
-  IGetUserStakeAndBakeSignatureParams,
-  getUserStakeAndBakeSignature,
-} from './getUserStakeAndBakeSignature';
-
-const meta = {
-  title: 'SDK/getUserStakeAndBakeSignature',
-  component: StoryView,
-  tags: ['autodocs'],
-} satisfies Meta<typeof StoryView>;
-
-export default meta;
-
-type Story = StoryObj<typeof meta>;
-
-export const WithParams: Story = {
-  args: {
-    env: defaultEnv,
-  },
-};
-
-type GetUserStakeAndBakeSignatureProps = Pick<
-  IGetUserStakeAndBakeSignatureParams,
-  'env'
->;
-
-export function StoryView(props: GetUserStakeAndBakeSignatureProps) {
-  const {
-    data: connectData,
-    error: connectError,
-    isLoading: isConnectLoading,
-    connect,
-  } = useConnect();
-
-  const request = async () => {
-    if (!connectData?.account) {
-      return;
-    }
-
-    return getUserStakeAndBakeSignature({
-      ...props,
-      userDestinationAddress: connectData.account,
-      chainId: connectData.chainId,
-    });
-  };
-
-  const { data, error, isLoading, refetch } = useQuery(request, [], false);
-
-  const formattedConnectData = connectData && {
-    account: connectData.account,
-    chainId: connectData.chainId,
-  };
-
-  return (
-    <>
-      <p>
-        This method gets the user's stake and bake signature from the API. The
-        signature is used to approve spending of tokens.
-      </p>
-
-      <div className="mb-4">
-        <Button
-          onClick={connect}
-          disabled={isConnectLoading}
-          isLoading={isConnectLoading}
-        >
-          Connect
-        </Button>
-
-        <CodeBlock text={connectError || formattedConnectData} />
-      </div>
-
-      <Button onClick={refetch} disabled={isLoading} isLoading={isLoading}>
-        Get User Stake and Bake Signature
-      </Button>
-
-      <CodeBlock text={error || data} />
-    </>
-  );
-}

package/src/sdk/internalTypes.ts

@@ -1,18 +0,0 @@
-export const OChainName = {
-  eth: 'DESTINATION_BLOCKCHAIN_ETHEREUM',
-  ethOld: 'BLOCKCHAIN_ETHEREUM',
-
-  base: 'DESTINATION_BLOCKCHAIN_BASE',
-  baseOld: 'BLOCKCHAIN_BASE',
-
-  bsc: 'DESTINATION_BLOCKCHAIN_BSC',
-  bscOld: 'BLOCKCHAIN_BSC',
-
-  sui: 'DESTINATION_BLOCKCHAIN_SUI',
-  suiOld: 'BLOCKCHAIN_SUI',
-
-  sonic: 'DESTINATION_BLOCKCHAIN_SONIC',
-  sonicOld: 'BLOCKCHAIN_SONIC',
-} as const;
-
-export type TChainName = (typeof OChainName)[keyof typeof OChainName];

package/src/sdk/storeNetworkFeeSignature/storeNetworkFeeSignature.stories.tsx

@@ -1,86 +0,0 @@
-import type { Meta, StoryObj } from '@storybook/react';
-import { defaultEnv } from '@lombard.finance/sdk-common';
-import { Button } from '../../stories/components/Button';
-import { CodeBlock } from '../../stories/components/CodeBlock';
-import { useConnect } from '../../stories/hooks/useConnect';
-import useQuery from '../../stories/hooks/useQuery';
-import {
-  IStoreNetworkFeeSignatureParams,
-  storeNetworkFeeSignature,
-} from './storeNetworkFeeSignature';
-
-const meta = {
-  title: 'SDK/storeNetworkFeeSignature',
-  component: StoryView,
-  tags: ['autodocs'],
-} satisfies Meta<typeof StoryView>;
-
-export default meta;
-
-type Story = StoryObj<typeof meta>;
-
-export const WithParams: Story = {
-  args: {
-    env: defaultEnv,
-  },
-};
-
-type StoreNetworkFeeSignatureProps = Pick<
-  IStoreNetworkFeeSignatureParams,
-  'env'
->;
-
-export function StoryView(props: StoreNetworkFeeSignatureProps) {
-  const {
-    data: connectData,
-    error: connectError,
-    isLoading: isConnectLoading,
-    connect,
-  } = useConnect();
-
-  const request = async () => {
-    if (!connectData) {
-      return;
-    }
-
-    return storeNetworkFeeSignature({
-      address: connectData.account,
-      ...props,
-      signature: '',
-      typedData: '',
-    });
-  };
-
-  const { data, error, isLoading, refetch } = useQuery(request, [], false);
-
-  const formattedConnectData = connectData && {
-    account: connectData.account,
-    chainId: connectData.chainId,
-  };
-
-  return (
-    <>
-      <div className="mb-4">
-        <Button
-          onClick={connect}
-          disabled={isConnectLoading}
-          isLoading={isConnectLoading}
-        >
-          Connect
-        </Button>
-
-        <CodeBlock text={connectError || formattedConnectData} />
-      </div>
-
-      <Button
-        onClick={refetch}
-        disabled={isLoading || !connectData}
-        isLoading={isLoading}
-      >
-        Authorize
-      </Button>
-
-      <CodeBlock text={error || data} />
-    </>
-  );
-}

package/src/sdk/storeStakeAndBakeSignature/storeStakeAndBakeSignature.stories.tsx

@@ -1,116 +0,0 @@
-import type { Meta, StoryObj } from '@storybook/react';
-import { defaultEnv } from '@lombard.finance/sdk-common';
-import { Button } from '../../stories/components/Button';
-import { CodeBlock } from '../../stories/components/CodeBlock';
-import { useConnect } from '../../stories/hooks/useConnect';
-import useQuery from '../../stories/hooks/useQuery';
-
-import {
-  ISignStakeAndBakeParams,
-  signStakeAndBake,
-} from '../../web3Sdk/signStakeAndBake/signStakeAndBake';
-import { storeStakeAndBakeSignature } from './storeStakeAndBakeSignature';
-
-const meta = {
-  title: 'SDK/storeStakeAndBakeSignature',
-  component: StoryView,
-  tags: ['autodocs'],
-} satisfies Meta<typeof StoryView>;
-
-export default meta;
-
-type Story = StoryObj<typeof meta>;
-
-export const WithParams: Story = {
-  args: {
-    value: '20000',
-    expiry: 3600,
-    vaultKey: 'veda',
-  },
-};
-
-type SignStakeAndBakeParams = Pick<
-  ISignStakeAndBakeParams,
-  'value' | 'expiry' | 'vaultKey'
->;
-
-export function StoryView(props: SignStakeAndBakeParams) {
-  const {
-    data: connectData,
-    error: connectError,
-    isLoading: isConnectLoading,
-    connect,
-  } = useConnect();
-
-  const request = async () => {
-    if (!connectData || !connectData.provider) {
-      return;
-    }
-
-    // First sign the authorization
-    const { signature, typedData } = await signStakeAndBake({
-      provider: connectData.provider,
-      address: connectData.account,
-      chainId: connectData.chainId,
-      value: props.value,
-      expiry: props.expiry,
-      vaultKey: props.vaultKey,
-    });
-
-    // Then store it
-    await storeStakeAndBakeSignature({
-      signature,
-      typedData,
-      env: defaultEnv,
-    });
-
-    return { signature, typedData };
-  };
-
-  const { data, error, isLoading, refetch } = useQuery(request, [], false);
-
-  const formattedConnectData = connectData && {
-    account: connectData.account,
-    chainId: connectData.chainId,
-  };
-
-  return (
-    <>
-      <p>
-        This method signs and stores the stake and bake signature in the
-        backend. The signature is used to approve spending of tokens.
-      </p>
-
-      <div className="mb-4">
-        <Button
-          onClick={connect}
-          disabled={isConnectLoading}
-          isLoading={isConnectLoading}
-        >
-          Connect
-        </Button>
-
-        <CodeBlock text={connectError || formattedConnectData} />
-      </div>
-
-      <Button
-        onClick={refetch}
-        disabled={isLoading || !connectData}
-        isLoading={isLoading}
-      >
-        Sign and Store Stake and Bake Signature
-      </Button>
-
-      <CodeBlock
-        text={
-          error ||
-          (data && {
-            ...data,
-            signature: data.signature,
-            typedData: data.typedData ? JSON.parse(data.typedData) : '',
-          })
-        }
-      />
-    </>
-  );
-}

package/src/sdk/utils/getChainIdByName.ts

@@ -1,48 +0,0 @@
-import { defaultEnv } from '@lombard.finance/sdk-common';
-import {
-  getBaseNetworkByEnv,
-  getBscNetworkByEnv,
-  getEthNetworkByEnv,
-  getSonicNetworkByEnv,
-  getSuiNetworkByEnv,
-  OChainId,
-  SuiChain,
-  TChainId,
-} from '../../common/types/types';
-import { Env } from '@lombard.finance/sdk-common';
-import { OChainName, TChainName } from '../internalTypes';
-
-/**
- * @param chain the chain ID
- * @param env
- * @returns the chain name
- */
-export function getChainIdByName(
-  chain: string,
-  env: Env = defaultEnv,
-): TChainId | SuiChain {
-  switch (chain as TChainName) {
-    case OChainName.eth:
-    case OChainName.ethOld:
-      return getEthNetworkByEnv(env);
-
-    case OChainName.base:
-    case OChainName.baseOld:
-      return getBaseNetworkByEnv(env);
-
-    case OChainName.bsc:
-    case OChainName.bscOld:
-      return getBscNetworkByEnv(env);
-
-    case OChainName.sui:
-    case OChainName.suiOld:
-      return getSuiNetworkByEnv(env);
-
-    case OChainName.sonic:
-    case OChainName.sonicOld:
-      return getSonicNetworkByEnv(env);
-
-    default:
-      return OChainId.ethereum;
-  }
-}

package/src/sdk/utils/getChainNameById.ts

@@ -1,41 +0,0 @@
-import { OChainId, SuiChain, TChainId } from '../../common/types/types';
-import { OChainName, TChainName } from '../internalTypes';
-
-/**
- * @param chainId the chain ID
- *
- * @returns the chain name
- */
-export function getChainNameById(
-  chainId: TChainId | SuiChain,
-  isOld = false,
-): TChainName {
-  if (
-    chainId === OChainId.ethereum ||
-    chainId === OChainId.holesky ||
-    chainId === OChainId.sepolia
-  ) {
-    return isOld ? OChainName.ethOld : OChainName.eth;
-  }
-
-  if (chainId === OChainId.base || chainId === OChainId.baseSepoliaTestnet) {
-    return isOld ? OChainName.baseOld : OChainName.base;
-  }
-
-  if (
-    chainId === OChainId.binanceSmartChain ||
-    chainId === OChainId.binanceSmartChainTestnet
-  ) {
-    return isOld ? OChainName.bscOld : OChainName.bsc;
-  }
-
-  if (chainId === OChainId.sonic || chainId === OChainId.sonicBlazeTestnet) {
-    return isOld ? OChainName.sonicOld : OChainName.sonic;
-  }
-
-  if (chainId === 'sui:testnet' || chainId === 'sui:mainnet') {
-    return isOld ? OChainName.suiOld : OChainName.sui;
-  }
-
-  throw new Error(`Unknown chain ID: ${chainId}`);
-}

package/src/stories/const.ts

@@ -1 +0,0 @@
-export const exampleEvmAddress = '0x659579f1460c38c3ce3288b47b074646cef855fc';

package/src/stories/hooks/useConnect.ts

@@ -1,47 +0,0 @@
-import Web3 from 'web3';
-import { IEIP1193Provider, TChainId } from '../../common/types/types';
-import { isValidChain } from '../../common/utils/isValidChain';
-import { connectInjectedWallet } from '../utils/connectInjectedWallet';
-import { getWalletInfo } from '../utils/getWalletInfo';
-import useQuery from './useQuery';
-
-interface IRequestConnect {
-  provider: IEIP1193Provider;
-  account: string;
-  chainId: TChainId;
-}
-
-interface IUseConnect {
-  data: IRequestConnect | null;
-  error: string | null;
-  isLoading: boolean;
-  connect: () => void;
-}
-
-export function useConnect(): IUseConnect {
-  const {
-    data,
-    error,
-    isLoading,
-    refetch: connect,
-  } = useQuery(requestConnect, [], false);
-
-  return {
-    data,
-    error,
-    isLoading,
-    connect,
-  };
-}
-
-async function requestConnect(): Promise<IRequestConnect> {
-  const provider = await connectInjectedWallet();
-  const web3 = new Web3(provider);
-  const { account, chainId } = await getWalletInfo(web3);
-
-  if (!isValidChain(chainId)) {
-    throw new Error('Invalid chain');
-  }
-
-  return { provider, account, chainId };
-}

package/src/stories/utils/connectInjectedWallet.ts

@@ -1,12 +0,0 @@
-type TEip1559Provider = any;
-
-export async function connectInjectedWallet(): Promise<TEip1559Provider> {
-  const { ethereum } = window as any;
-  if (!ethereum) {
-    throw new Error('Ethereum object not found');
-  }
-
-  await ethereum.enable();
-
-  return ethereum;
-}

package/src/stories/utils/fromCamelCase.ts

@@ -1,16 +0,0 @@
-/**
- * Convert a camelCase string to readable string with spaces.
- *
- * @param value - CamelCase string.
- *
- * @returns Readable string with spaces.
- */
-export function fromCamelCase(value: string): string {
-  return (
-    value
-      // Insert a space before all caps
-      .replace(/([A-Z])/g, ' $1')
-      // Uppercase the first character
-      .replace(/^./, str => str.toUpperCase())
-  );
-}

package/src/stories/utils/getMetaTitle.ts

@@ -1,7 +0,0 @@
-/**
- * @param functionName - The name of the function.
- * @returns The meta title in the format "SDK/{functionName}".
- */
-export function getMetaTitle(functionName: string): string {
-  return `SDK/${functionName}`;
-}

package/src/stories/utils/getWalletInfo.ts

@@ -1,31 +0,0 @@
-import Web3, { FMT_BYTES, FMT_NUMBER } from 'web3';
-
-interface IGetWalletInfo {
-  account: string;
-  chainId: number;
-}
-
-/**
- * Retrieves wallet information.
- *
- * @param web3 - The Web3 instance.
- * @returns A promise that resolves to an object containing the account and chainId.
- * @throws An error if no account is found.
- */
-export async function getWalletInfo(web3: Web3): Promise<IGetWalletInfo> {
-  const [account] = await web3.eth.getAccounts();
-
-  if (!account) {
-    throw new Error('No account found');
-  }
-
-  const chainId = await web3.eth.getChainId({
-    bytes: FMT_BYTES.HEX,
-    number: FMT_NUMBER.NUMBER,
-  });
-
-  return {
-    account,
-    chainId,
-  };
-}