@lombard.finance/sdk 2.5.2 → 3.2.0

package/src/contract-functions/getBasculeDepositStatus/getBasculeDepositStatus.stories.tsx

@@ -0,0 +1,50 @@
+import type { Meta, StoryObj } from '@storybook/react';
+import { Button } from '../../stories/components/Button';
+import { CodeBlock } from '../../stories/components/CodeBlock';
+import useQuery from '../../stories/hooks/useQuery';
+import {
+  getBasculeDepositStatus,
+  IGetBasculeDepositStatusParameters,
+} from './getBasculeDepositStatus';
+import { ChainId } from '../../common/chains';
+import { functionType } from '../../stories/components/decorators';
+
+const meta = {
+  title: 'read/getBasculeDepositStatus',
+  component: StoryView,
+  tags: ['autodocs'],
+  decorators: [functionType('read')],
+} satisfies Meta<typeof StoryView>;
+
+export default meta;
+
+type Story = StoryObj<typeof meta>;
+
+export const WithParams: Story = {
+  args: {
+    rawPayload:
+      'f2e73f7c00000000000000000000000000000000000000000000000000000000000000010000000000000000000000004f3128be175467a35ec1f430264cbc36ab272f83000000000000000000000000000000000000000000000000000000000000c3500c870b82581beb090f8ee4e6a36ece9ea67df8d993c0962dd25e650d46f824bc0000000000000000000000000000000000000000000000000000000000000003',
+    chainId: ChainId.ethereum,
+  },
+};
+
+export function StoryView(props: IGetBasculeDepositStatusParameters) {
+  const request = async () => {
+    return getBasculeDepositStatus(props);
+  };
+
+  const { data, error, isLoading, refetch } = useQuery(request, [], false);
+
+  return (
+    <>
+      <Button
+        onClick={refetch}
+        disabled={isLoading}
+        isLoading={isLoading}
+        actionName={getBasculeDepositStatus.name}
+      />
+
+      <CodeBlock text={error || data} />
+    </>
+  );
+}

package/src/contract-functions/getBasculeDepositStatus/getBasculeDepositStatus.ts

@@ -0,0 +1,127 @@
+import { CommonOptionalWriteParameters } from '../../common/parameters';
+import { getErrorMessage } from '../../utils/err';
+import { DEFAULT_ENV } from '@lombard.finance/sdk-common';
+import { IDeposit } from '../../api-functions/getDepositsByAddress/getDepositsByAddress';
+import {
+  ByteArray,
+  Client,
+  getContract,
+  keccak256,
+  PublicClient,
+  zeroAddress,
+} from 'viem';
+import { makePublicClient } from '../../clients/public-client';
+import { makeWalletClient } from '../../clients/wallet-client';
+import LBTC_BASCULE_ABI from '../../tokens/abi/LBTC_BASCULE_ABI.json';
+import { getTokenContractInfo } from '../../tokens/tokens';
+import { Token } from '../../tokens/token-addresses';
+
+/**
+ * The bascule drawbridge deposit status.
+ */
+export enum BasculeDepositStatus {
+  /**
+   * The value representing that the deposit is unreported or potentially
+   * still pending.
+   */
+  UNREPORTED = 0,
+  /**
+   * The value representing that the deposit is reported.
+   */
+  REPORTED = 1,
+  /**
+   * The value representing that the deposit has already been withdrawn.
+   */
+  WITHDRAWN = 2,
+}
+
+export interface IGetBasculeDepositStatusParameters
+  extends CommonOptionalWriteParameters {
+  /**
+   * The deposit for which the bascule status will be checked.
+   * You can omit `rawPayload` parameter if `deposit` is provided.
+   */
+  deposit?: IDeposit;
+  /**
+   * The `rawPayload` of the deposit for which the bascule status
+   * will be checked.
+   * You can omit `deposit` parameter if `rawPayload` is provided.
+   */
+  rawPayload?: string;
+}
+
+/**
+ * Gets the Bascule drawbridge deposit status for given deposit.
+ * @param {IGetBasculeDepositStatusParameters} parameters - The parameters.
+ * @param {IDeposit} parameters.deposit - The deposit for which the bascule status will be checked. You can omit `rawPayload` parameter if `deposit` is provided.
+ * @param {string} parameters.rawPayload - The `rawPayload` of the deposit for which the bascule status will be checked. You can omit `deposit` parameter if `rawPayload` is provided.
+ * @param {ChainId} parameters.chainId - The chain id.
+ * @param {EIP1193Provider} parameters.provider - The optional EIP1193 provider.
+ * @param {string} parameters.rpcUrl - The optional rpc url.
+ * @param {Env} parameters.env - The optional environment identifier.
+ *
+ * @returns {Promise<BasculeDepositStatus>}
+ */
+export async function getBasculeDepositStatus({
+  deposit,
+  rawPayload,
+  provider,
+  chainId,
+  rpcUrl,
+  env = DEFAULT_ENV,
+}: IGetBasculeDepositStatusParameters) {
+  const payload = deposit?.rawPayload || rawPayload;
+
+  if (!payload) {
+    throw new Error(
+      "No 'rawPayload' or 'deposit' data provided. Please provide 'rawPayload' or 'deposit' parameter.",
+    );
+  }
+
+  const publicClient = makePublicClient({ chainId, rpcUrl });
+  const lbtcContract = getTokenContractInfo(Token.LBTC, chainId, env);
+
+  const basculeContractAddress = await publicClient.readContract({
+    abi: lbtcContract.abi,
+    address: lbtcContract.address,
+    functionName: 'Bascule',
+  });
+
+  // If there's no bascule contract address on the LBTC contract then return
+  // the the deposit is ok (REPORTED).
+  if (basculeContractAddress === zeroAddress) {
+    return BasculeDepositStatus.REPORTED;
+  }
+
+  let client: PublicClient | Client | undefined = undefined;
+  if (!provider) {
+    client = makePublicClient({ chainId, rpcUrl });
+  } else {
+    client = makeWalletClient({ provider, chainId });
+  }
+
+  if (!client) {
+    throw new Error(
+      "Could not determine the client for the contract interactions. Please provide the 'provider' and 'chainId' parameters or 'chainId' and optionally the 'rpcUrl' parameter.",
+    );
+  }
+
+  try {
+    const basculeContract = getContract({
+      abi: LBTC_BASCULE_ABI,
+      address: basculeContractAddress,
+      client,
+    });
+
+    const basculeDepositId = keccak256(
+      Buffer.from(payload.slice(8), 'hex') as unknown as ByteArray,
+    );
+
+    const status = await basculeContract.read.depositHistory([
+      basculeDepositId,
+    ]);
+    return status as BasculeDepositStatus;
+  } catch (err) {
+    throw new Error(getErrorMessage(err));
+  }
+}

package/src/{web3Sdk → contract-functions}/getLBTCMintingFee/getLBTCMintingFee.stories.tsx

@@ -1,15 +1,16 @@
 import type { Meta, StoryObj } from '@storybook/react';
-
-import { OChainId, TChainId } from '../../common/types/types';
+import { ChainId } from '../../common/chains';
 import { Button } from '../../stories/components/Button';
 import { CodeBlock } from '../../stories/components/CodeBlock';
+import { functionType } from '../../stories/components/decorators';
 import useQuery from '../../stories/hooks/useQuery';
 import { getLBTCMintingFee } from './getLBTCMintingFee';
 
 const meta = {
-  title: 'Web3SDK/getLBTCMintingFee',
+  title: 'read/getLBTCMintingFee',
   component: StoryView,
   tags: ['autodocs'],
+  decorators: [functionType('read')],
 } satisfies Meta<typeof StoryView>;
 
 export default meta;
@@ -18,18 +19,18 @@ type Story = StoryObj<typeof meta>;
 
 export const Holesky: Story = {
   args: {
-    chainId: OChainId.holesky,
+    chainId: ChainId.holesky,
   },
 };
 
 export const Ethereum: Story = {
   args: {
-    chainId: OChainId.ethereum,
+    chainId: ChainId.ethereum,
   },
 };
 
 type GetLBTCMintingFeeProps = {
-  chainId: TChainId;
+  chainId: ChainId;
 };
 
 export function StoryView(props: GetLBTCMintingFeeProps) {
@@ -43,16 +44,19 @@ export function StoryView(props: GetLBTCMintingFeeProps) {
 
   return (
     <div>
-      <Button onClick={refetch} disabled={isLoading} isLoading={isLoading}>
-        Get LBTC Minting Fee
-      </Button>
+      <Button
+        onClick={refetch}
+        disabled={isLoading}
+        isLoading={isLoading}
+        actionName={getLBTCMintingFee.name}
+      />
 
-      <CodeBlock text={error || data?.toString()} />
+      <CodeBlock text={error || data?.toFormat()} />
 
       {data && (
         <div className="mt-4 p-4 border rounded">
           <h3 className="text-lg font-bold mb-2">Fee Details</h3>
-          <p>Minting Fee: {data.toString()} BTC</p>
+          <p>Minting Fee: {data.toFormat()} BTC</p>
         </div>
       )}
     </div>

package/src/contract-functions/getLBTCMintingFee/getLBTCMintingFee.tsx

@@ -0,0 +1,37 @@
+import BigNumber from 'bignumber.js';
+import { CommonParameters } from '../../common/parameters';
+import { determineEnv } from '../../utils/env';
+import { fromSatoshi } from '../../utils/satoshi';
+import { makePublicClient } from '../../clients/public-client';
+import { getTokenContractInfo } from '../../tokens/tokens';
+import { Token } from '../../tokens/token-addresses';
+
+/**
+ * Gets LBTC minting fee amount.
+ *
+ * @param {CommonParameters} parameters - The parameters.
+ * @param {ChainId} parameters.chainId - The chain id.
+ * @param {string} parameters.rpcUrl - The optional rpc url.
+ * @param {Env} parameters.env - The optional environment identifier.
+ *
+ * @return {Promise<BigNumber>}
+ */
+export async function getLBTCMintingFee({
+  chainId,
+  rpcUrl,
+  env,
+}: CommonParameters): Promise<BigNumber> {
+  const environment = env || determineEnv(chainId);
+
+  const publicClient = makePublicClient({ chainId, rpcUrl });
+  const lbtcContract = getTokenContractInfo(Token.LBTC, chainId, environment);
+
+  const rawFeeValue = await publicClient.readContract({
+    abi: lbtcContract.abi,
+    address: lbtcContract.address,
+    functionName: 'getMintFee',
+  });
+
+  const lbtcMintFee = fromSatoshi(String(rawFeeValue));
+  return lbtcMintFee;
+}

package/src/{vaults/lib/get-vault-points.stories.tsx → contract-functions/getLBTCTotalSupply/getLBTCTotalSupply.stories.tsx}

@@ -1,15 +1,17 @@
 import type { Meta, StoryObj } from '@storybook/react';
+import { DEFAULT_ENV } from '@lombard.finance/sdk-common';
 import { Button } from '../../stories/components/Button';
 import { CodeBlock } from '../../stories/components/CodeBlock';
 import useQuery from '../../stories/hooks/useQuery';
-import { Vault } from '..';
-import { getVaultPoints, GetVaultPointsParameters } from './get-vault-points';
-import { exampleEvmAddress } from '../../stories/const';
+import { getLBTCTotalSupply } from './getLBTCTotalSupply';
+import { ChainId } from '../../common/chains';
+import { functionType } from '../../stories/components/decorators';
 
 const meta = {
-  title: 'vault/getVaultPoints',
+  title: 'read/getLBTCTotalSupply',
   component: StoryView,
   tags: ['autodocs'],
+  decorators: [functionType('read')],
 } satisfies Meta<typeof StoryView>;
 
 export default meta;
@@ -18,33 +20,28 @@ type Story = StoryObj<typeof meta>;
 
 export const WithParams: Story = {
   args: {
-    account: exampleEvmAddress,
-    vaultKey: Vault.Veda,
+    chainId: ChainId.ethereum,
+    env: DEFAULT_ENV,
   },
 };
 
-type SignNetworkFeeProps = GetVaultPointsParameters;
+type TotalSupplyLBTCProps = Parameters<typeof getLBTCTotalSupply>[0];
 
-export function StoryView(props: SignNetworkFeeProps) {
+export function StoryView(props: TotalSupplyLBTCProps) {
   const request = async () => {
-    return getVaultPoints({
-      ...props,
-    });
+    return getLBTCTotalSupply(props);
   };
 
   const { data, error, isLoading, refetch } = useQuery(request, [], false);
 
   return (
     <>
-      <p>This function gets the points earned by a user in the DeFi vault.</p>
-
       <Button
         onClick={refetch}
         disabled={isLoading}
         isLoading={isLoading}
-      >
-        {getVaultPoints.name}
-      </Button>
+        actionName={getLBTCTotalSupply.name}
+      />
 
       <CodeBlock text={error || data} />
     </>

package/src/contract-functions/getLBTCTotalSupply/getLBTCTotalSupply.ts

@@ -0,0 +1,34 @@
+import { CommonParameters } from '../../common/parameters';
+import { DEFAULT_ENV } from '@lombard.finance/sdk-common';
+import BigNumber from 'bignumber.js';
+import { fromSatoshi } from '../../utils/satoshi';
+import { makePublicClient } from '../../clients/public-client';
+import { getTokenContractInfo } from '../../tokens/tokens';
+import { Token } from '../../tokens/token-addresses';
+
+/**
+ * Get the total supply of LBTC tokens.
+ *
+ * @param {CommonParameters} parameters - The parameters.
+ * @param {ChainId} parameters.chainId - The chain id.
+ * @param {string} parameters.rpcUrl - The optional rpc url.
+ * @param {Env} parameters.env - The optional environment identifier.
+ *
+ * @return {Promise<BigNumber>}
+ */
+export async function getLBTCTotalSupply({
+  chainId,
+  rpcUrl,
+  env = DEFAULT_ENV,
+}: CommonParameters): Promise<BigNumber> {
+  const publicClient = makePublicClient({ chainId, rpcUrl });
+  const lbtcContract = getTokenContractInfo(Token.LBTC, chainId, env);
+
+  const totalSupplyRaw = await publicClient.readContract({
+    abi: lbtcContract.abi,
+    address: lbtcContract.address,
+    functionName: 'totalSupply',
+  });
+
+  return fromSatoshi(String(totalSupplyRaw));
+}

package/src/{web3Sdk → contract-functions}/getPermitNonce/getPermitNonce.stories.tsx

@@ -1,14 +1,15 @@
 import type { Meta, StoryObj } from '@storybook/react';
 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 { getPermitNonce, IGetPermitNonceParams } from './getPermitNonce';
+import { functionType } from '../../stories/components/decorators';
 
 const meta = {
-  title: 'Web3SDK/getPermitNonce',
+  title: 'read/getPermitNonce',
   component: StoryView,
   tags: ['autodocs'],
+  decorators: [functionType('read')],
 } satisfies Meta<typeof StoryView>;
 
 export default meta;
@@ -18,38 +19,27 @@ type Story = StoryObj<typeof meta>;
 export const WithParams: Story = {
   args: {
     owner: '0x1234567890123456789012345678901234567890',
+    chainId: 1,
   },
 };
 
-type GetPermitNonceProps = Pick<IGetPermitNonceParams, 'owner'>;
+type GetPermitNonceProps = Parameters<typeof getPermitNonce>[0];
 
 export function StoryView(props: GetPermitNonceProps) {
-  const { data: connectData, error: connectError } = useConnect();
-
   const request = async () => {
-    return getPermitNonce({
-      chainId: 1, // Ethereum mainnet
-      rpcUrl: 'https://rpc.ankr.com/eth',
-      ...props,
-    });
+    return getPermitNonce(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 Permit Nonce
-      </Button>
+      <Button
+        onClick={refetch}
+        disabled={isLoading}
+        isLoading={isLoading}
+        actionName={getPermitNonce.name}
+      />
 
       <CodeBlock text={error || data} />
 

package/src/contract-functions/getPermitNonce/getPermitNonce.ts

@@ -0,0 +1,45 @@
+import { CommonParameters } from '../../common/parameters';
+import { determineEnv } from '../../utils/env';
+import { DEFAULT_ENV } from '@lombard.finance/sdk-common';
+import { Address } from 'viem';
+import { makePublicClient } from '../../clients/public-client';
+import { getTokenContractInfo } from '../../tokens/tokens';
+import { Token } from '../../tokens/token-addresses';
+
+export interface IGetPermitNonceParams extends CommonParameters {
+  /**
+   * Owner address to check permit nonce for
+   */
+  owner: Address;
+}
+
+/**
+ * Get permit nonce for a specific owner address from LBTC contract.
+ * This nonce is used in EIP-2612 permit operations.
+ *
+ * @param {IGetPermitNonceParams} parameters - The parameters.
+ * @param {Address} parameters.owner - The account address.
+ * @param {ChainId} parameters.chainId - The chain id.
+ * @param {string} parameters.rpcUrl - The optional rpc url.
+ * @param {Env} parameters.env - The optional environment identifier.
+ */
+export async function getPermitNonce({
+  owner,
+  chainId,
+  rpcUrl,
+  env = DEFAULT_ENV,
+}: IGetPermitNonceParams): Promise<string> {
+  const environment = env || determineEnv(chainId);
+
+  const publicClient = makePublicClient({ chainId, rpcUrl });
+  const lbtcContract = getTokenContractInfo(Token.LBTC, chainId, environment);
+
+  const nonce = await publicClient.readContract({
+    abi: lbtcContract.abi,
+    address: lbtcContract.address,
+    functionName: 'nonces',
+    args: [owner],
+  });
+
+  return String(nonce);
+}

package/src/{web3Sdk → contract-functions}/getShareValue/getShareValue.stories.tsx

@@ -1,15 +1,17 @@
 import type { Meta, StoryObj } from '@storybook/react';
 
-import { OChainId } from '../../common/types/types';
+import { ChainId } from '../../common/chains';
 import { Button } from '../../stories/components/Button';
 import useQuery from '../../stories/hooks/useQuery';
 import { getShareValue, IGetShareValueParameters } from './getShareValue';
-import { Vault } from '../../vaults';
+import { Vault } from '../../vaults/lib/config';
+import { functionType } from '../../stories/components/decorators';
 
 const meta = {
-  title: 'Web3SDK/getShareValue',
+  title: 'read/getShareValue',
   component: StoryView,
   tags: ['autodocs'],
+  decorators: [functionType('read')],
 } satisfies Meta<typeof StoryView>;
 
 export default meta;
@@ -18,7 +20,7 @@ type Story = StoryObj<typeof meta>;
 
 export const WithParams: Story = {
   args: {
-    chainId: OChainId.ethereum,
+    chainId: ChainId.ethereum,
     vaultKey: Vault.Veda,
   },
 };
@@ -36,9 +38,12 @@ export function StoryView(props: IGetShareValueParameters) {
 
   return (
     <div>
-      <Button onClick={refetch} disabled={isLoading} isLoading={isLoading}>
-        Get LBTCv value
-      </Button>
+      <Button
+        onClick={refetch}
+        disabled={isLoading}
+        isLoading={isLoading}
+        actionName={getShareValue.name}
+      />
 
       {data && (
         <div className="mt-4 p-4 border rounded">

package/src/contract-functions/getShareValue/getShareValue.ts

@@ -0,0 +1,58 @@
+import BigNumber from 'bignumber.js';
+import { getErrorMessage } from '../../utils/err';
+import { isVedaVaultChain, Vault, VAULTS } from '../../vaults/lib/config';
+import { fromSatoshi } from '../../utils/satoshi';
+import { makePublicClient } from '../../clients/public-client';
+import { getContract } from 'viem';
+import { CommonParameters } from '../../common/parameters';
+
+export interface IGetShareValueParameters extends CommonParameters {
+  /**
+   * Optional DeFi vault identifier specifying the vault in use
+   * @default {string} - "veda"
+   */
+  vaultKey?: Vault;
+}
+
+/**
+ * Gets the value of a single share unit (in LBTC) from the specified vault.
+ *
+ * @param {IGetShareValueParameters} parameters - The parameters.
+ * @param {Vault} parameters.vaultKey - The optional DeFi vault identifier.
+ * @param {ChainId} parameters.chainId - The chain id.
+ * @param {string} parameters.rpcUrl - The optional rpc url.
+ *
+ * @returns {Promise<BigNumber>}
+ */
+export async function getShareValue({
+  chainId,
+  rpcUrl,
+  vaultKey = Vault.Veda,
+}: IGetShareValueParameters): Promise<BigNumber> {
+  const vault = VAULTS[vaultKey];
+  if (!vault) {
+    throw new Error(`Unknown vault key: ${vaultKey}`);
+  }
+
+  if (!isVedaVaultChain(chainId)) {
+    throw new Error(
+      `Unsupported chain id: ${chainId}. Please switch to one of the supported chains: ${vault.chains.join(', ')}`,
+    );
+  }
+
+  try {
+    const client = makePublicClient({ chainId, rpcUrl });
+
+    const accountantContract = getContract({
+      abi: vault.accountantContract.abi,
+      address: vault.accountantContract.address,
+      client,
+    });
+
+    const exchangeRate = await accountantContract.read.getRate();
+    return fromSatoshi(String(exchangeRate));
+  } catch (err) {
+    const errorMessage = getErrorMessage(err);
+    throw new Error(errorMessage);
+  }
+}

package/src/{web3Sdk → contract-functions}/getSharesByAddress/getSharesByAddress.stories.tsx

@@ -1,20 +1,22 @@
 import type { Meta, StoryObj } from '@storybook/react';
 
-import { OChainId } from '../../common/types/types';
+import { ChainId } from '../../common/chains';
 import { Button } from '../../stories/components/Button';
 import useQuery from '../../stories/hooks/useQuery';
 import {
   getSharesByAddress,
   IGetSharesByAddressParameters,
 } from './getSharesByAddress';
-import { Vault } from '../../vaults';
-import { exampleEvmAddress } from '../../stories/const';
+import { Vault } from '../../vaults/lib/config';
+import { EXAMPLE_EVM_ADDRESS } from '../../stories/constants';
 import { CodeBlock } from '../../stories/components/CodeBlock';
+import { functionType } from '../../stories/components/decorators';
 
 const meta = {
-  title: 'Web3SDK/getSharesByAddress',
+  title: 'read/getSharesByAddress',
   component: StoryView,
   tags: ['autodocs'],
+  decorators: [functionType('read')],
 } satisfies Meta<typeof StoryView>;
 
 export default meta;
@@ -23,8 +25,8 @@ type Story = StoryObj<typeof meta>;
 
 export const WithParams: Story = {
   args: {
-    chainId: OChainId.ethereum,
-    address: exampleEvmAddress,
+    chainId: ChainId.ethereum,
+    address: EXAMPLE_EVM_ADDRESS,
     vaultKey: Vault.Veda,
   },
 };
@@ -40,9 +42,12 @@ export function StoryView(props: IGetSharesByAddressParameters) {
 
   return (
     <div>
-      <Button onClick={refetch} disabled={isLoading} isLoading={isLoading}>
-        Get LBTCv shares owned
-      </Button>
+      <Button
+        onClick={refetch}
+        disabled={isLoading}
+        isLoading={isLoading}
+        actionName={getSharesByAddress.name}
+      />
 
       <CodeBlock text={error || data} />