@lombard.finance/sdk 2.5.1 → 3.1.0

package/src/web3Sdk/abi/STAKE_AND_BAKE.json

@@ -1,15 +0,0 @@
-[
-  {
-    "inputs": [],
-    "name": "getStakeAndBakeFee",
-    "outputs": [
-      {
-        "internalType": "uint256",
-        "name": "",
-        "type": "uint256"
-      }
-    ],
-    "stateMutability": "view",
-    "type": "function"
-  }
-]

package/src/web3Sdk/abi/index.ts

@@ -1,6 +0,0 @@
-import IERC20 from './IERC20.json';
-import LBTCABI from './LBTC.json';
-import BASCULE_ABI from './BASCULE.json';
-import STAKE_AND_BAKE from './STAKE_AND_BAKE.json';
-
-export { BASCULE_ABI, IERC20, LBTCABI, STAKE_AND_BAKE };

package/src/web3Sdk/approveLBTC/approveLBTC.stories.tsx

@@ -1,77 +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 { approveLBTC, IApproveLBTCParams } from './approveLBTC';
-
-const meta = {
-  title: 'Web3SDK/approveLBTC',
-  component: StoryView,
-  tags: ['autodocs'],
-} satisfies Meta<typeof StoryView>;
-
-export default meta;
-
-type Story = StoryObj<typeof meta>;
-
-export const WithParams: Story = {
-  args: {
-    amount: 0.00001,
-    spender: '',
-    env: defaultEnv,
-  },
-};
-
-type ClaimLBTCProps = Pick<IApproveLBTCParams, 'spender' | 'amount' | 'env'>;
-
-export function StoryView(props: ClaimLBTCProps) {
-  const {
-    data: connectData,
-    error: connectError,
-    isLoading: isConnectLoading,
-    connect,
-  } = useConnect();
-
-  const request = async () => {
-    if (!connectData) {
-      return;
-    }
-
-    return approveLBTC({ ...connectData, ...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}
-      >
-        Approve LBTC
-      </Button>
-
-      <CodeBlock text={error || data} />
-    </>
-  );
-}

package/src/web3Sdk/approveLBTC/approveLBTC.ts

@@ -1,48 +0,0 @@
-import { IEnvParam } from '../../common/types/internalTypes';
-import { toSatoshi } from '../../common/utils/convertSatoshi';
-import { IWeb3SendResult, Provider } from '../../provider';
-import { IProviderBasedParams } from '../types';
-import { getGasMultiplier } from '../utils/getGasMultiplier';
-import { getLbtcTokenContract } from '../utils/getLbtcTokenContract';
-
-export interface IApproveLBTCParams extends IProviderBasedParams, IEnvParam {
-  /**
-   * Spender address
-   */
-  spender: string;
-  /**
-   * The amount of LBTC to approve
-   */
-  amount: number;
-}
-
-/**
- * Approves the transfer of a specified amount of LBTC tokens.
- *
- * @param {IApproveLBTCParams} params
- *
- * @returns {Promise<IWeb3SendResult>} transaction promise
- */
-export function approveLBTC({
-  spender,
-  amount,
-  env,
-  ...providerParams
-}: IApproveLBTCParams): Promise<IWeb3SendResult> {
-  const provider = new Provider(providerParams);
-  const tokenContract = getLbtcTokenContract(provider, env);
-  const amountSat = toSatoshi(amount).toNumber();
-
-  const tx = tokenContract.methods.approve(spender, amountSat);
-
-  return provider.sendTransactionAsync(
-    provider.account,
-    tokenContract.options.address,
-    {
-      data: tx.encodeABI(),
-      estimate: true,
-      estimateFee: true,
-      gasLimitMultiplier: getGasMultiplier(provider.chainId),
-    },
-  );
-}

package/src/web3Sdk/claimLBTC/claimLBTC.ts

@@ -1,86 +0,0 @@
-import {
-  BasculeDepositStatus,
-  getBasculeDepositStatus,
-} from '../getBasculeDepositStatus';
-import { IEnvParam } from '../../common/types/internalTypes';
-import { getErrorMessage } from '../../common/utils/getErrorMessage';
-import { IWeb3SendResult, Provider } from '../../provider';
-import { IProviderBasedParams } from '../types';
-import { getGasMultiplier } from '../utils/getGasMultiplier';
-import { getLbtcTokenContract } from '../utils/getLbtcTokenContract';
-import { throwBasculeDepositStatusError } from '../getBasculeDepositStatus/utils/throwBasculeDepositStatusError';
-import { BASCULE_SUPPORTED_CHAINS } from '../getBasculeDepositStatus/utils/const';
-
-const INSUFFICIENT_FUNDS_PARTIAL_ERROR = 'insufficient funds';
-
-const INSUFFICIENT_FUNDS_ERROR =
-  'Insufficient funds for transfer. Make sure you have enough ETH to cover the gas cost.';
-
-export interface IClaimLBTCParams extends IProviderBasedParams, IEnvParam {
-  /**
-   * Raw payload from deposit notarization.
-   */
-  data: string;
-  /**
-   * Signature from deposit notarization.
-   */
-  proofSignature: string;
-}
-
-const hexify = (hexString: string) =>
-  hexString.startsWith('0x') ? hexString : `0x${hexString}`;
-/**
- * Claims LBTC.
- *
- * @param {IClaimLBTCParams} params - The parameters for claiming LBTC.
- *
- * @returns {Promise<IWeb3SendResult>} transaction promise
- */
-export async function claimLBTC({
-  data,
-  proofSignature,
-  env,
-  ...providerParams
-}: IClaimLBTCParams): Promise<IWeb3SendResult> {
-  const provider = new Provider(providerParams);
-
-  if (BASCULE_SUPPORTED_CHAINS.includes(provider.chainId)) {
-    const status = await getBasculeDepositStatus({
-      env,
-      rawPayload: data,
-      ...providerParams,
-    });
-
-    if (status !== BasculeDepositStatus.REPORTED) {
-      throwBasculeDepositStatusError(status);
-    }
-  }
-
-  const tokenContract = getLbtcTokenContract(provider, env);
-
-  const tx = tokenContract.methods.mint(hexify(data), hexify(proofSignature));
-
-  try {
-    const result = await provider.sendTransactionAsync(
-      provider.account,
-      tokenContract.options.address,
-      {
-        data: tx.encodeABI(),
-        estimate: true,
-        estimateFee: true,
-        gasLimitMultiplier: getGasMultiplier(provider.chainId),
-      },
-    );
-
-    return result;
-  } catch (error) {
-    console.log('error', error);
-    const errorMessage = getErrorMessage(error);
-
-    if (errorMessage.includes(INSUFFICIENT_FUNDS_PARTIAL_ERROR)) {
-      throw new Error(INSUFFICIENT_FUNDS_ERROR);
-    }
-
-    throw new Error(errorMessage);
-  }
-}

package/src/web3Sdk/const.ts

@@ -1,2 +0,0 @@
-export const SECONDS_PER_DAY = 24 * 60 * 60;
-export const MS_PER_DAY = SECONDS_PER_DAY * 1000;

package/src/web3Sdk/getBasculeDepositStatus/getBasculeDepositStatus.stories.tsx

@@ -1,89 +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 {
-  getBasculeDepositStatus,
-  ICheckBasculeDepositStatusParams,
-} from './getBasculeDepositStatus';
-
-const meta = {
-  title: 'Web3SDK/getBasculeDepositStatus',
-  component: StoryView,
-  tags: ['autodocs'],
-} satisfies Meta<typeof StoryView>;
-
-export default meta;
-
-type Story = StoryObj<typeof meta>;
-
-export const WithParams: Story = {
-  args: {
-    rawPayload: '',
-    env: defaultEnv,
-  },
-};
-
-type CheckBasculeDepositStatusProps = Pick<
-  ICheckBasculeDepositStatusParams,
-  'env' | 'rawPayload'
->;
-
-const BASCULE_DEPOSIT_TX_ID =
-  '0x496028cda1ff940a1cfd9a326ac3bdff8e94ca545a6ac21d03964977561cbb52';
-
-export function StoryView(props: CheckBasculeDepositStatusProps) {
-  const {
-    data: connectData,
-    error: connectError,
-    isLoading: isConnectLoading,
-    connect,
-  } = useConnect();
-
-  const request = async () => {
-    if (!connectData) {
-      return;
-    }
-
-    return getBasculeDepositStatus({
-      ...connectData,
-      ...props,
-      rawPayload: BASCULE_DEPOSIT_TX_ID,
-    });
-  };
-
-  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 Bascule Deposit Status
-      </Button>
-
-      <CodeBlock text={error || data} />
-    </>
-  );
-}

package/src/web3Sdk/getBasculeDepositStatus/getBasculeDepositStatus.ts

@@ -1,75 +0,0 @@
-import { IEnvParam } from '../../common/types/internalTypes';
-import { getErrorMessage } from '../../common/utils/getErrorMessage';
-import { Provider } from '../../provider';
-import { IProviderBasedParams } from '../types';
-import { getBasculeTokenContract } from '../utils/getBasculeTokenContract';
-import { getLbtcTokenContract } from '../utils/getLbtcTokenContract';
-import { ZERO_ADDRESS } from '../../common/const';
-
-const NO_DEPOSIT_ID_ERROR =
-  'No deposit ID provided. Please provide a deposit ID as an argument.';
-
-// Deposit status enum
-export enum BasculeDepositStatus {
-  UNREPORTED = 0, // potentially pending
-  REPORTED = 1,
-  WITHDRAWN = 2,
-}
-
-export interface ICheckBasculeDepositStatusParams
-  extends IProviderBasedParams,
-    IEnvParam {
-  /**
-   * raw_payload of the transaction.
-   */
-  rawPayload?: string;
-}
-
-/**
- * Check bascule contract deposit status.
- *
- * @param {ICheckBasculeDepositStatusParams} params - The parameters to get status base on Bascule contract.
- *
- * @returns {Promise<BasculeDepositStatus>} Deposit status promise
- */
-export async function getBasculeDepositStatus({
-  rawPayload,
-  env,
-  ...providerParams
-}: ICheckBasculeDepositStatusParams) {
-  if (!rawPayload) {
-    throw new Error(NO_DEPOSIT_ID_ERROR);
-  }
-
-  const provider = new Provider(providerParams);
-
-  const tokenContract = getLbtcTokenContract(provider, env);
-
-  const basculeAddress: string = await tokenContract.methods.Bascule().call();
-
-  if (basculeAddress === ZERO_ADDRESS) {
-    return BasculeDepositStatus.REPORTED;
-  }
-
-  const basculeContract = getBasculeTokenContract(provider, basculeAddress);
-
-  try {
-    const legacyHash = provider
-      .getReadWeb3()
-      .utils.keccak256(
-        Buffer.from(rawPayload.slice(8), 'hex') as unknown as Uint8Array,
-      );
-
-    const status: bigint = await basculeContract.methods
-      .depositHistory(legacyHash)
-      .call();
-
-    const depositStatus: BasculeDepositStatus = Number(status);
-
-    return depositStatus;
-  } catch (error) {
-    const errorMessage = getErrorMessage(error);
-
-    throw new Error(errorMessage);
-  }
-}

package/src/web3Sdk/getBasculeDepositStatus/utils/const.ts

@@ -1,8 +0,0 @@
-import { OChainId } from '../../../common/types/types';
-
-export const BASCULE_SUPPORTED_CHAINS: number[] = [
-  OChainId.ethereum,
-  OChainId.base,
-  OChainId.binanceSmartChain,
-  OChainId.sonic
-];

package/src/web3Sdk/getBasculeDepositStatus/utils/throwBasculeDepositStatusError.ts

@@ -1,21 +0,0 @@
-import { BasculeDepositStatus } from '../getBasculeDepositStatus';
-
-export function throwBasculeDepositStatusError(status: BasculeDepositStatus) {
-  let errorMessage = '';
-
-  switch (status) {
-    case BasculeDepositStatus.UNREPORTED:
-      errorMessage = 'Checking Minting Status, try again in 30 seconds.';
-      break;
-
-    case BasculeDepositStatus.WITHDRAWN:
-      errorMessage =
-        'Funds have been withdrawn. Minting is currently disabled.';
-      break;
-
-    default:
-      errorMessage = 'Unknown Error';
-  }
-
-  throw new Error(errorMessage, { cause: true });
-}

package/src/web3Sdk/getLBTCMintingFee/getLBTCMintingFee.tsx

@@ -1,41 +0,0 @@
-import BigNumber from 'bignumber.js';
-import { TChainId } from '../../common/types/types';
-import { fromSatoshi } from '../../common/utils/convertSatoshi';
-import { ReadProvider } from '../../provider/ReadProvider';
-import { chainIdToEnv } from '../utils/chainIdToEnv';
-import { getLbtcTokenContract } from '../utils/getLbtcTokenContract';
-import { getRpcUrlConfigFromChain } from '../utils/getRpcUrlConfigFromChain';
-
-export interface IGetLBTCMintingFeeParams {
-  /**
-   * Chain ID
-   */
-  chainId: TChainId;
-  /**
-   * RPC URL
-   */
-  rpcUrl?: string;
-}
-
-/**
- * Get LBTC minting fee.
- *
- * @param chainId - Chain ID
- * @param rpcUrl - RPC URL (optional)
- *
- * @returns LBTC minting fee
- */
-export async function getLBTCMintingFee({
-  chainId,
-  rpcUrl,
-}: IGetLBTCMintingFeeParams): Promise<BigNumber> {
-  const rpcUrlConfig = getRpcUrlConfigFromChain(chainId, rpcUrl);
-  const provider = new ReadProvider({ chainId, rpcUrlConfig });
-  const env = chainIdToEnv(chainId);
-  const tokenContract = getLbtcTokenContract(provider, env);
-
-  const fee: bigint = await tokenContract.methods.getMintFee().call();
-  const feeBtc = new BigNumber(fromSatoshi(fee.toString(10)));
-
-  return feeBtc;
-}

package/src/web3Sdk/getLBTCTotalSupply/getLBTCTotalSupply.stories.tsx

@@ -1,60 +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 {
-  getLBTCTotalSupply,
-  ILBTCTotalSupplyParams,
-} from './getLBTCTotalSupply';
-
-const meta = {
-  title: 'Web3SDK/getLBTCTotalSupply',
-  component: StoryView,
-  tags: ['autodocs'],
-} satisfies Meta<typeof StoryView>;
-
-export default meta;
-
-type Story = StoryObj<typeof meta>;
-
-export const WithParams: Story = {
-  args: {
-    env: defaultEnv,
-  },
-};
-
-type TotalSupplyLBTCProps = Pick<ILBTCTotalSupplyParams, 'env'>;
-
-export function StoryView(props: TotalSupplyLBTCProps) {
-  const { data: connectData, error: connectError } = useConnect();
-
-  const request = async () => {
-    return getLBTCTotalSupply({
-      chainId: 1,
-      rpcUrl: 'https://rpc.ankr.com/eth',
-      ...props,
-    });
-  };
-
-  const { data, error, isLoading, refetch } = useQuery(request, [], false);
-
-  const formattedConnectData = connectData && {
-    account: connectData.account,
-    chainId: connectData.chainId,
-  };
-
-  return (
-    <>
-      <div className="mb-4">
-        <CodeBlock text={connectError || formattedConnectData} />
-      </div>
-      <Button onClick={refetch} disabled={isLoading} isLoading={isLoading}>
-        Get Total LBTC Supply
-      </Button>
-
-      <CodeBlock text={error || data} />
-    </>
-  );
-}

package/src/web3Sdk/getLBTCTotalSupply/getLBTCTotalSupply.ts

@@ -1,26 +0,0 @@
-import { IReadProviderParams, ReadProvider } from '../../provider/ReadProvider';
-import { TRpcUrlConfig } from '../../provider/rpcUrlConfig';
-import { IEnvParam } from '../../common/types/internalTypes';
-
-import { getLbtcTokenContract } from '../utils/getLbtcTokenContract';
-
-export interface ILBTCTotalSupplyParams extends IEnvParam {
-  rpcUrl: string;
-  chainId: IReadProviderParams['chainId'];
-}
-
-export async function getLBTCTotalSupply({
-  env,
-  rpcUrl,
-  chainId,
-}: ILBTCTotalSupplyParams): Promise<string> {
-  const rpcUrlConfig: TRpcUrlConfig = { [chainId]: rpcUrl };
-
-  const provider = new ReadProvider({ chainId, rpcUrlConfig });
-
-  const tokenContract = getLbtcTokenContract(provider, env);
-
-  const balance: bigint = await tokenContract.methods.totalSupply().call();
-
-  return balance.toString();
-}

package/src/web3Sdk/getPermitNonce/getPermitNonce.ts

@@ -1,47 +0,0 @@
-import { TChainId } from '../../common/types/types';
-import { getErrorMessage } from '../../common/utils/getErrorMessage';
-import { ReadProvider } from '../../provider/ReadProvider';
-import { chainIdToEnv } from '../utils/chainIdToEnv';
-import { getLbtcTokenContract } from '../utils/getLbtcTokenContract';
-import { getRpcUrlConfigFromChain } from '../utils/getRpcUrlConfigFromChain';
-
-export interface IGetPermitNonceParams {
-  /**
-   * Owner address to check permit nonce for
-   */
-  owner: string;
-  /**
-   * Chain ID of the network
-   */
-  chainId: TChainId;
-  /**
-   * RPC URL for the network (optional)
-   */
-  rpcUrl?: string;
-}
-
-/**
- * Get permit nonce for a specific owner address from LBTC contract.
- * This nonce is used in EIP-2612 permit operations.
- *
- * @param {IGetPermitNonceParams} params - Parameters for getting permit nonce
- * @returns {Promise<string>} Promise that resolves to the permit nonce value
- */
-export async function getPermitNonce({
-  owner,
-  rpcUrl,
-  chainId,
-}: IGetPermitNonceParams): Promise<string> {
-  const rpcUrlConfig = getRpcUrlConfigFromChain(chainId, rpcUrl);
-  const provider = new ReadProvider({ chainId, rpcUrlConfig });
-  const env = chainIdToEnv(chainId);
-  const tokenContract = getLbtcTokenContract(provider, env);
-
-  try {
-    const nonce: bigint = await tokenContract.methods.nonces(owner).call();
-    return nonce.toString();
-  } catch (error) {
-    const errorMessage = getErrorMessage(error);
-    throw new Error(errorMessage);
-  }
-}

package/src/web3Sdk/getShareValue/getShareValue.ts

@@ -1,58 +0,0 @@
-import BigNumber from 'bignumber.js';
-import { TChainId } from '../../common/types/types';
-import { ReadProvider } from '../../provider/ReadProvider';
-import { getRpcUrlConfigFromChain } from '../utils/getRpcUrlConfigFromChain';
-import { getErrorMessage } from '../../common/utils/getErrorMessage';
-import { VAULTS } from '../../vaults';
-import { fromSatoshi } from '../../common/utils/convertSatoshi';
-
-export interface IGetShareValueParameters {
-  /**
-   * Chain ID for identifying the blockchain network (e.g., Ethereum, Binance Smart Chain, etc.)
-   */
-  chainId: TChainId;
-  /**
-   * Optional RPC URL to connect to the blockchain. If not provided, a default RPC URL might be used.
-   */
-  rpcUrl?: string;
-  /**
-   * Optional vault key specifying the vault in use
-   * @default {string} - "veda"
-   */
-  vaultKey?: 'veda';
-}
-
-/**
- * Gets the value of a single share unit (in LBTC) from the specified vault.
- */
-export async function getShareValue({
-  chainId,
-  rpcUrl,
-  vaultKey = 'veda',
-}: IGetShareValueParameters): Promise<BigNumber> {
-  const vault = VAULTS[vaultKey];
-  if (!vault) {
-    throw new Error(`Unknown vault key: ${vaultKey}`);
-  }
-
-  if (!(vault.chains as unknown as number[]).includes(chainId)) {
-    throw new Error(
-      `Unsupported chain id: ${chainId}. Please switch to one of the supported chains: ${vault.chains.join(', ')}`,
-    );
-  }
-
-  const rpcUrlConfig = getRpcUrlConfigFromChain(chainId, rpcUrl);
-  const provider = new ReadProvider({ chainId, rpcUrlConfig });
-
-  try {
-    const accountant = provider.createContract<
-      typeof vault.accountantContract.abi
-    >(vault.accountantContract.abi, vault.accountantContract.address);
-
-    const exchangeRate = await accountant.methods.getRate().call();
-    return fromSatoshi(String(exchangeRate));
-  } catch (error) {
-    const errorMessage = getErrorMessage(error);
-    throw new Error(errorMessage);
-  }
-}