@lombard.finance/sdk 2.5.2 → 3.2.0

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);
-  }
-}

package/src/web3Sdk/getStakeAndBakeFee/getStakeAndBakeFee.tsx

@@ -1,48 +0,0 @@
-import { TChainId } from '../../common/types/types';
-import { ReadProvider } from '../../provider/ReadProvider';
-import { getRpcUrlConfigFromChain } from '../utils/getRpcUrlConfigFromChain';
-import { STAKE_AND_BAKE } from '../abi';
-import { getErrorMessage } from '../../common/utils/getErrorMessage';
-
-export interface IGetStakeAndBakeFeeParams {
-  /**
-   * Chain ID
-   */
-  chainId: TChainId;
-  /**
-   * RPC URL
-   */
-  rpcUrl?: string;
-  /**
-   * Vault Address
-   */
-  vaultAddress: string;
-}
-
-/**
- * Get Stake and bake fee.
- *
- * @param chainId - Chain ID
- * @param rpcUrl - RPC URL (optional)
- * @param vaultAddress - Vault Address
- *
- * @returns Stake and bake fee in satoshis
- */
-export async function getStakeAndBakeFee({
-  chainId,
-  rpcUrl,
-  vaultAddress,
-}: IGetStakeAndBakeFeeParams): Promise<string> {
-  const rpcUrlConfig = getRpcUrlConfigFromChain(chainId, rpcUrl);
-  const provider = new ReadProvider({ chainId, rpcUrlConfig });
-
-  try {
-    const contract = provider.createContract(STAKE_AND_BAKE, vaultAddress);
-
-    const fee: bigint = await contract.methods.getStakeAndBakeFee().call();
-    return fee.toString();
-  } catch (error) {
-    const errorMessage = getErrorMessage(error);
-    throw new Error(errorMessage);
-  }
-}

package/src/web3Sdk/lbtcAddressConfig.ts

@@ -1,96 +0,0 @@
-import { ZERO_ADDRESS as PLACEHOLDER_ADDRESS } from '../common/const';
-import { OChainId, TChainId } from '../common/types/types';
-import { Env, defaultEnv } from '@lombard.finance/sdk-common';
-
-type LbtcTokenConfig = Record<TChainId, string>;
-
-const stageConfig: LbtcTokenConfig = {
-  [OChainId.holesky]: '0xED7bfd5C1790576105Af4649817f6d35A75CD818',
-  [OChainId.ethereum]: PLACEHOLDER_ADDRESS,
-
-  [OChainId.binanceSmartChainTestnet]:
-    '0x731eFa688F3679688cf60A3993b8658138953ED6',
-  [OChainId.binanceSmartChain]: PLACEHOLDER_ADDRESS,
-  [OChainId.sepolia]: '0xc47e4b3124597fdf8dd07843d4a7052f2ee80c30',
-
-  [OChainId.base]: PLACEHOLDER_ADDRESS,
-  [OChainId.baseSepoliaTestnet]: '0x731eFa688F3679688cf60A3993b8658138953ED6',
-
-  [OChainId.berachain]: PLACEHOLDER_ADDRESS,
-  [OChainId.berachainBartioTestnet]:
-    '0xc47e4b3124597FDF8DD07843D4a7052F2eE80C30',
-
-  [OChainId.corn]: PLACEHOLDER_ADDRESS,
-  [OChainId.swell]: PLACEHOLDER_ADDRESS,
-
-  [OChainId.sonic]: PLACEHOLDER_ADDRESS,
-  [OChainId.sonicBlazeTestnet]: '0x731eFa688F3679688cf60A3993b8658138953ED6',
-
-  [OChainId.morph]: PLACEHOLDER_ADDRESS,
-  [OChainId.morphHolesky]: PLACEHOLDER_ADDRESS,
-  [OChainId.etherlink]: PLACEHOLDER_ADDRESS,
-};
-
-const testnetConfig: LbtcTokenConfig = {
-  [OChainId.holesky]: '0x38A13AB20D15ffbE5A7312d2336EF1552580a4E2',
-  [OChainId.ethereum]: PLACEHOLDER_ADDRESS,
-
-  [OChainId.binanceSmartChainTestnet]:
-    '0x107Fc7d90484534704dD2A9e24c7BD45DB4dD1B5',
-  [OChainId.binanceSmartChain]: PLACEHOLDER_ADDRESS,
-  [OChainId.sepolia]: '0xc47e4b3124597fdf8dd07843d4a7052f2ee80c30',
-
-  [OChainId.base]: PLACEHOLDER_ADDRESS,
-  [OChainId.baseSepoliaTestnet]: PLACEHOLDER_ADDRESS,
-
-  [OChainId.berachain]: PLACEHOLDER_ADDRESS,
-  [OChainId.berachainBartioTestnet]:
-    '0xc47e4b3124597FDF8DD07843D4a7052F2eE80C30',
-
-  [OChainId.corn]: PLACEHOLDER_ADDRESS,
-  [OChainId.swell]: PLACEHOLDER_ADDRESS,
-
-  [OChainId.sonic]: PLACEHOLDER_ADDRESS,
-  [OChainId.sonicBlazeTestnet]: '0x107Fc7d90484534704dD2A9e24c7BD45DB4dD1B5',
-
-  [OChainId.morph]: PLACEHOLDER_ADDRESS,
-  [OChainId.morphHolesky]: PLACEHOLDER_ADDRESS,
-  [OChainId.etherlink]: PLACEHOLDER_ADDRESS,
-};
-
-const prodConfig: LbtcTokenConfig = {
-  [OChainId.ethereum]: '0x8236a87084f8b84306f72007f36f2618a5634494',
-  [OChainId.holesky]: PLACEHOLDER_ADDRESS,
-  [OChainId.sepolia]: PLACEHOLDER_ADDRESS,
-
-  [OChainId.binanceSmartChainTestnet]: PLACEHOLDER_ADDRESS,
-  [OChainId.binanceSmartChain]: '0xecAc9C5F704e954931349Da37F60E39f515c11c1',
-
-  [OChainId.base]: '0xecAc9C5F704e954931349Da37F60E39f515c11c1',
-  [OChainId.baseSepoliaTestnet]: PLACEHOLDER_ADDRESS,
-
-  [OChainId.berachain]: '0xecAc9C5F704e954931349Da37F60E39f515c11c1',
-  [OChainId.berachainBartioTestnet]: PLACEHOLDER_ADDRESS,
-
-  [OChainId.corn]: '0xecAc9C5F704e954931349Da37F60E39f515c11c1',
-  [OChainId.swell]: '0xecAc9C5F704e954931349Da37F60E39f515c11c1',
-
-  [OChainId.sonic]: '0xecAc9C5F704e954931349Da37F60E39f515c11c1',
-  [OChainId.sonicBlazeTestnet]: PLACEHOLDER_ADDRESS,
-
-  [OChainId.morph]: '0xecAc9C5F704e954931349Da37F60E39f515c11c1',
-  [OChainId.morphHolesky]: PLACEHOLDER_ADDRESS,
-
-  [OChainId.etherlink]: '0xecAc9C5F704e954931349Da37F60E39f515c11c1',
-};
-
-export function getLbtcAddressConfig(env: Env = defaultEnv): LbtcTokenConfig {
-  switch (env) {
-    case Env.prod:
-      return prodConfig;
-    case Env.testnet:
-      return testnetConfig;
-    default:
-      return stageConfig;
-  }
-}

package/src/web3Sdk/signLbtcDestionationAddr/signLbtcDestinationAddr.ts

@@ -1,23 +0,0 @@
-import { Provider } from '../../provider';
-import { IProviderBasedParams } from '../types';
-
-export type SignLbtcDestinationAddrParams = IProviderBasedParams;
-
-/**
- * Signs the destination address for the LBTC in active chain
- * in the current account. Signing is necessary for the
- * generation of the deposit address.
- *
- * @param {SignLbtcDestinationAddrParams} params
- *
- * @returns {Promise<string>} The signature of the message.
- */
-export async function signLbtcDestinationAddr(
-  params: SignLbtcDestinationAddrParams,
-): Promise<string> {
-  const provider = new Provider(params);
-
-  const message = `destination chain id is ${params.chainId}`;
-
-  return provider.signMessage(message);
-}

package/src/web3Sdk/signLbtcDestionationAddr/signLbtcDestionationAddr.stories.tsx

@@ -1,97 +0,0 @@
-import type { Meta } from '@storybook/react';
-import Web3, { FMT_BYTES, FMT_NUMBER } from 'web3';
-import { OChainId, TChainId } from '../../common/types/types';
-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 { fromCamelCase } from '../../stories/utils/fromCamelCase';
-import { signLbtcDestinationAddr } from './signLbtcDestinationAddr';
-
-const { name } = signLbtcDestinationAddr;
-const nameWithWhitespaces = fromCamelCase(name);
-
-const meta = {
-  title: 'Web3SDK/signLbtcDestionationAddr',
-  component: StoryView,
-  tags: ['autodocs'],
-} satisfies Meta<typeof StoryView>;
-
-export default meta;
-
-export function StoryView() {
-  const {
-    data: connectData,
-    error: connectError,
-    isLoading: isConnectLoading,
-    connect,
-  } = useConnect();
-
-  const request = async () => {
-    if (!connectData) {
-      return;
-    }
-
-    return signLbtcDestinationAddr(connectData);
-  };
-
-  const { data, error, isLoading, refetch } = useQuery(request, [], false);
-
-  const formattedConnectData = connectData && {
-    account: connectData.account,
-    chainId: connectData.chainId,
-  };
-
-  return (
-    <>
-      <p>
-        This method is used to get the signature of the Liquid BTC destination
-        address. The signature is used for generating the deposit address.
-      </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}
-      >
-        {nameWithWhitespaces}
-      </Button>
-
-      <CodeBlock text={error || data} />
-    </>
-  );
-}
-
-async function getWalletInfo(web3: Web3) {
-  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,
-  };
-}
-
-function isValidChain(chainId: number): chainId is TChainId {
-  return Object.values(OChainId).includes(chainId as TChainId);
-}

package/src/web3Sdk/signNetworkFee/signNetworkFee.stories.tsx

@@ -1,91 +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 { fromCamelCase } from '../../stories/utils/fromCamelCase';
-import { MS_PER_DAY } from '../const';
-import { ISignNetworkFeeParams, signNetworkFee } from './signNetworkFee';
-
-const { name } = signNetworkFee;
-const nameWithWhitespaces = fromCamelCase(name);
-
-const meta = {
-  title: 'Web3SDK/signNetworkFee',
-  component: StoryView,
-  tags: ['autodocs'],
-} satisfies Meta<typeof StoryView>;
-
-export default meta;
-
-type Story = StoryObj<typeof meta>;
-
-export const WithParams: Story = {
-  args: {
-    env: defaultEnv,
-  },
-};
-
-type SignNetworkFeeProps = Pick<ISignNetworkFeeParams, 'env'>;
-
-export function StoryView(props: SignNetworkFeeProps) {
-  const {
-    data: connectData,
-    error: connectError,
-    isLoading: isConnectLoading,
-    connect,
-  } = useConnect();
-
-  const request = async () => {
-    if (!connectData) {
-      return;
-    }
-
-    return signNetworkFee({
-      ...connectData,
-      ...props,
-      fee: '1100',
-      expiry: Date.now() + MS_PER_DAY,
-      address: connectData.account,
-    });
-  };
-
-  const { data, error, isLoading, refetch } = useQuery(request, [], false);
-
-  const formattedConnectData = connectData && {
-    account: connectData.account,
-    chainId: connectData.chainId,
-  };
-
-  return (
-    <>
-      <p>
-        This method is used to get the signature of the Liquid BTC destination
-        address. The signature is used for auto-mint feature.
-      </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}
-      >
-        {nameWithWhitespaces}
-      </Button>
-
-      <CodeBlock text={error || data} />
-    </>
-  );
-}

package/src/web3Sdk/signNetworkFee/signNetworkFee.ts

@@ -1,92 +0,0 @@
-import { IEnvParam } from '../../common/types/internalTypes';
-import { Provider } from '../../provider';
-import { SECONDS_PER_DAY } from '../const';
-import { IProviderBasedParams } from '../types';
-import { getLbtcTokenContract } from '../utils/getLbtcTokenContract';
-import { getTypedData } from './getTypedData';
-
-const NO_SIGNATURE_ERROR =
-  'Failed to obtain a valid signature. The response is undefined or invalid.';
-
-export interface ISignNetworkFeeParams
-  extends Pick<IProviderBasedParams, 'provider' | 'chainId'>,
-    IEnvParam {
-  /**
-   * User address
-   */
-  address: string;
-  /**
-   * Authorization fee
-   */
-  fee: string;
-  /**
-   * Expiration time
-   */
-  expiry: number;
-}
-
-export interface ISignNetworkFeeResponse {
-  /**
-   * signature
-   */
-  signature: string;
-  /**
-   * JSON typed data used for the signature
-   */
-  typedData: string;
-}
-
-const getDefaultExpiryUnix = () => {
-  return Math.floor(Date.now() / 1000 + SECONDS_PER_DAY);
-};
-
-/**
- * Signs the network fee transaction in the current account.
- * Signing is necessary for the auto-mint.
- *
- * @param {ISignNetworkFeeParams} params - The parameters for signing network fee
- * @returns {Promise<ISignNetworkFeeResponse>} A promise that resolves to the signature and typed data
- */
-export async function signNetworkFee({
-  address,
-  provider,
-  fee,
-  chainId,
-  env,
-  expiry = getDefaultExpiryUnix(),
-}: ISignNetworkFeeParams): Promise<ISignNetworkFeeResponse> {
-  const providerInstance = new Provider({
-    provider,
-    account: address,
-    chainId,
-  });
-
-  const tokenContract = getLbtcTokenContract(providerInstance, env);
-  const verifyingContract = tokenContract.options.address;
-  const typedData = JSON.stringify(
-    getTypedData({
-      chainId,
-      verifyingContract,
-      fee,
-      expiry,
-    }),
-  );
-
-  const signature = await providerInstance.web3?.currentProvider?.request<
-    'eth_signTypedData_v4',
-    string
-  >({
-    method: 'eth_signTypedData_v4',
-    params: [address, typedData],
-  });
-
-  if (typeof signature === 'string') {
-    return { signature, typedData: typedData };
-  }
-
-  if (!signature?.result) {
-    throw new Error(NO_SIGNATURE_ERROR);
-  }
-
-  return { signature: signature.result, typedData: typedData };
-}