@lombard.finance/sdk 4.0.0 → 4.1.0

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

@@ -1,51 +0,0 @@
-import type { Meta, StoryObj } from '@storybook/react';
-
-import { ChainId } from '../../common/chains';
-import { chainSelector, envSelector } from '../../stories/arg-types';
-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 { getLBTCTotalSupply } from './getLBTCTotalSupply';
-
-const meta = {
-  title: 'read/getLBTCTotalSupply',
-  component: StoryView,
-  tags: ['autodocs'],
-  decorators: [functionType('read')],
-  argTypes: { ...chainSelector, ...envSelector },
-} satisfies Meta<typeof StoryView>;
-
-export default meta;
-
-type Story = StoryObj<typeof meta>;
-
-export const WithParams: Story = {
-  args: {
-    chainId: ChainId.ethereum,
-    env: undefined,
-  },
-};
-
-type TotalSupplyLBTCProps = Parameters<typeof getLBTCTotalSupply>[0];
-
-export function StoryView(props: TotalSupplyLBTCProps) {
-  const request = async () => {
-    return getLBTCTotalSupply(props);
-  };
-
-  const { data, error, isLoading, refetch } = useQuery(request, [], false);
-
-  return (
-    <>
-      <Button
-        onClick={refetch}
-        disabled={isLoading}
-        isLoading={isLoading}
-        actionName={getLBTCTotalSupply.name}
-      />
-
-      <CodeBlock text={error || data} />
-    </>
-  );
-}

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

@@ -1,40 +0,0 @@
-import BigNumber from 'bignumber.js';
-
-import { makePublicClient } from '../../clients/public-client';
-import { CommonParameters } from '../../common/parameters';
-import { Token } from '../../tokens/token-addresses';
-import { getTokenContractInfo } from '../../tokens/tokens';
-import { determineEnv } from '../../utils/env';
-import { fromSatoshi } from '../../utils/satoshi';
-
-/**
- * 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,
-}: CommonParameters): Promise<BigNumber> {
-  const environment = env || determineEnv(chainId);
-  const publicClient = makePublicClient({ chainId, rpcUrl, env: environment });
-  const lbtcContract = await getTokenContractInfo(
-    Token.LBTC,
-    chainId,
-    environment,
-  );
-
-  const totalSupplyRaw = await publicClient.readContract({
-    abi: lbtcContract.abi,
-    address: lbtcContract.address,
-    functionName: 'totalSupply',
-  });
-
-  return fromSatoshi(String(totalSupplyRaw));
-}

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

@@ -1 +0,0 @@
-export * from './getLBTCTotalSupply';

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

@@ -1,56 +0,0 @@
-import type { Meta, StoryObj } from '@storybook/react';
-
-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 { getPermitNonce } from './getPermitNonce';
-
-const meta = {
-  title: 'read/getPermitNonce',
-  component: StoryView,
-  tags: ['autodocs'],
-  decorators: [functionType('read')],
-} satisfies Meta<typeof StoryView>;
-
-export default meta;
-
-type Story = StoryObj<typeof meta>;
-
-export const WithParams: Story = {
-  args: {
-    owner: '0x1234567890123456789012345678901234567890',
-    chainId: 1,
-  },
-};
-
-type GetPermitNonceProps = Parameters<typeof getPermitNonce>[0];
-
-export function StoryView(props: GetPermitNonceProps) {
-  const request = async () => {
-    return getPermitNonce(props);
-  };
-
-  const { data, error, isLoading, refetch } = useQuery(request, [], false);
-
-  return (
-    <>
-      <Button
-        onClick={refetch}
-        disabled={isLoading}
-        isLoading={isLoading}
-        actionName={getPermitNonce.name}
-      />
-
-      <CodeBlock text={error || data} />
-
-      {data && (
-        <div className="mt-4 p-4 border rounded">
-          <h3 className="text-lg font-bold mb-2">Permit Nonce Details</h3>
-          <p>Owner: {props.owner}</p>
-          <p>Nonce: {data}</p>
-        </div>
-      )}
-    </>
-  );
-}

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

@@ -1,50 +0,0 @@
-import { DEFAULT_ENV } from '@lombard.finance/sdk-common';
-import { Address } from 'viem';
-
-import { makePublicClient } from '../../clients/public-client';
-import { CommonParameters } from '../../common/parameters';
-import { Token } from '../../tokens/token-addresses';
-import { getTokenContractInfo } from '../../tokens/tokens';
-import { determineEnv } from '../../utils/env';
-
-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 = await 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/contract-functions/getPermitNonce/index.ts

@@ -1 +0,0 @@
-export * from './getPermitNonce';

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

@@ -1,58 +0,0 @@
-import type { Meta, StoryObj } from '@storybook/react';
-
-import { ChainId } from '../../common/chains';
-import { Button } from '../../stories/components/Button';
-import { functionType } from '../../stories/components/decorators';
-import useQuery from '../../stories/hooks/useQuery';
-import { Vault } from '../../vaults/lib/config';
-import { getShareValue,IGetShareValueParameters } from './getShareValue';
-
-const meta = {
-  title: 'read/getShareValue',
-  component: StoryView,
-  tags: ['autodocs'],
-  decorators: [functionType('read')],
-} satisfies Meta<typeof StoryView>;
-
-export default meta;
-
-type Story = StoryObj<typeof meta>;
-
-export const WithParams: Story = {
-  args: {
-    chainId: ChainId.ethereum,
-    vaultKey: Vault.Veda,
-  },
-};
-
-export function StoryView(props: IGetShareValueParameters) {
-  const request = async () => {
-    return getShareValue({
-      ...props,
-    });
-  };
-
-  const { data, error: _error, isLoading, refetch } = useQuery(request, [], false);
-
-  const value = data?.toString();
-
-  return (
-    <div>
-      <Button
-        onClick={refetch}
-        disabled={isLoading}
-        isLoading={isLoading}
-        actionName={getShareValue.name}
-      />
-
-      {data && (
-        <div className="mt-4 p-4 border rounded">
-          <h3 className="text-lg font-bold mb-2">
-            LBTCv (Vault shares) share value
-          </h3>
-          <p>1 LBTCv (Vault shares) = {value} LBTC</p>
-        </div>
-      )}
-    </div>
-  );
-}

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

@@ -1,59 +0,0 @@
-import BigNumber from 'bignumber.js';
-import { getContract } from 'viem';
-
-import { makePublicClient } from '../../clients/public-client';
-import { CommonParameters } from '../../common/parameters';
-import { getErrorMessage } from '../../utils/err';
-import { fromSatoshi } from '../../utils/satoshi';
-import { isVedaVaultChain, Vault, VAULTS } from '../../vaults/lib/config';
-
-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/contract-functions/getShareValue/index.ts

@@ -1 +0,0 @@
-export { getShareValue, type IGetShareValueParameters } from './getShareValue';

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

@@ -1,65 +0,0 @@
-import type { Meta, StoryObj } from '@storybook/react';
-
-import { ChainId } from '../../common/chains';
-import { Button } from '../../stories/components/Button';
-import { CodeBlock } from '../../stories/components/CodeBlock';
-import { functionType } from '../../stories/components/decorators';
-import { EXAMPLE_EVM_ADDRESS } from '../../stories/constants';
-import useQuery from '../../stories/hooks/useQuery';
-import { Vault } from '../../vaults/lib/config';
-import {
-  getSharesByAddress,
-  IGetSharesByAddressParameters,
-} from './getSharesByAddress';
-
-const meta = {
-  title: 'read/getSharesByAddress',
-  component: StoryView,
-  tags: ['autodocs'],
-  decorators: [functionType('read')],
-} satisfies Meta<typeof StoryView>;
-
-export default meta;
-
-type Story = StoryObj<typeof meta>;
-
-export const WithParams: Story = {
-  args: {
-    chainId: ChainId.ethereum,
-    address: EXAMPLE_EVM_ADDRESS,
-    vaultKey: Vault.Veda,
-  },
-};
-
-export function StoryView(props: IGetSharesByAddressParameters) {
-  const request = async () => {
-    return getSharesByAddress({
-      ...props,
-    });
-  };
-
-  const { data, error, isLoading, refetch } = useQuery(request, [], false);
-
-  return (
-    <div>
-      <Button
-        onClick={refetch}
-        disabled={isLoading}
-        isLoading={isLoading}
-        actionName={getSharesByAddress.name}
-      />
-
-      <CodeBlock text={error || data} />
-
-      {data && (
-        <div className="mt-4 p-4 border rounded">
-          <h3 className="text-lg font-bold mb-2">Vault shares owned</h3>
-          <p>
-            <b>{data.balance.toString()}</b> Vault shares ={' '}
-            {data.balanceLbtc.toString()} LBTC
-          </p>
-        </div>
-      )}
-    </div>
-  );
-}

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

@@ -1,86 +0,0 @@
-import BigNumber from 'bignumber.js';
-import { getContract } from 'viem';
-
-import { makePublicClient } from '../../clients/public-client';
-import { CommonParameters } from '../../common/parameters';
-import { getErrorMessage } from '../../utils/err';
-import { fromSatoshi } from '../../utils/satoshi';
-import { isVedaVaultChain, Vault, VAULTS } from '../../vaults/lib/config';
-import { getShareValue } from '../getShareValue';
-
-export interface IGetSharesByAddressParameters extends CommonParameters {
-  /**
-   * The address of the share holder.
-   */
-  address: string;
-  /**
-   * Optional vault key specifying the vault in use
-   * @default {string} - "veda"
-   */
-  vaultKey?: Vault;
-}
-
-interface IGetSharesByAddressResponse {
-  /** The amount of share owned. */
-  balance: BigNumber;
-  /** The value of a single share unit */
-  exchangeRate: BigNumber;
-  /** The balance represented in BTC. */
-  balanceLbtc: BigNumber;
-}
-
-/**
- * Gets the amount of shares (LBTCv) owned by the provided address.
- *
- * @param {IGetSharesByAddressParameters} 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.
- *
- * @return {Promise<IGetSharesByAddressResponse>}
- */
-export async function getSharesByAddress({
-  chainId,
-  rpcUrl,
-  address,
-  vaultKey = Vault.Veda,
-}: IGetSharesByAddressParameters): Promise<IGetSharesByAddressResponse> {
-  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 lensContract = getContract({
-      abi: vault.lensContract.abi,
-      address: vault.lensContract.address,
-      client,
-    });
-
-    const balanceValue = await lensContract.read.balanceOf([
-      address,
-      vault.vaultContract.address,
-    ]);
-
-    const balance = fromSatoshi(String(balanceValue));
-
-    const exchangeRate = await getShareValue({ chainId, rpcUrl, vaultKey });
-
-    return {
-      balance,
-      exchangeRate,
-      balanceLbtc: balance.multipliedBy(exchangeRate),
-    };
-  } catch (error) {
-    const errorMessage = getErrorMessage(error);
-    throw new Error(errorMessage);
-  }
-}

package/src/contract-functions/getSharesByAddress/index.ts

@@ -1,4 +0,0 @@
-export {
-  getSharesByAddress,
-  type IGetSharesByAddressParameters,
-} from './getSharesByAddress';

package/src/contract-functions/getStakeAndBakeFee/__tests__/getStakeAndBakeFee.test.ts

@@ -1,167 +0,0 @@
-import { Env } from '@lombard.finance/sdk-common';
-import { describe, expect, it, vi } from 'vitest';
-
-import { ChainId } from '../../../common/chains';
-import { DefiProtocol } from '../../../defi/defi-registry';
-import { Token } from '../../../tokens/token-addresses';
-import { getStakeAndBakeFee } from '../getStakeAndBakeFee';
-
-// Mock dependencies
-vi.mock('../../../clients/public-client', () => ({
-  makePublicClient: vi.fn(() => ({})),
-}));
-
-vi.mock('viem', async importOriginal => {
-  const actual = await importOriginal<typeof import('viem')>();
-  return {
-    ...actual,
-    getContract: vi.fn(() => ({
-      read: {
-        getStakeAndBakeFee: vi.fn(async () => BigInt(1000000)), // 0.01 LBTC in satoshi
-      },
-    })),
-  };
-});
-
-vi.mock('../../signStakeAndBake/validation', () => ({
-  getStakeAndBakeConfig: vi.fn((protocol, token, chainId, env) => {
-    // Simulate validation - throw for unsupported combinations
-    if (protocol === DefiProtocol.Silo && token !== Token.BTCb) {
-      throw new Error(
-        `Token ${token} is not supported for stake and bake on vault Silo`,
-      );
-    }
-    if (protocol === DefiProtocol.Veda && token === Token.BTCb) {
-      throw new Error(
-        `Token ${token} is not supported for stake and bake on vault Veda`,
-      );
-    }
-
-    return {
-      protocol,
-      token,
-      chainId,
-      env,
-      amountStrategy: 'identity',
-      approval: {
-        mode: 'permit',
-        domainName: 'Test',
-        domainVersion: '1',
-        deadlineStrategy: 'expiry',
-        nonceStrategy: 'chain',
-      },
-      spenderContract: {
-        address: '0x1234567890123456789012345678901234567890',
-        abi: [],
-        chainId,
-      },
-    };
-  }),
-}));
-
-describe('getStakeAndBakeFee', () => {
-  describe('Protocol-aware default tokens', () => {
-    it('should use LBTC as default token for Veda', async () => {
-      const result = await getStakeAndBakeFee({
-        protocol: DefiProtocol.Veda,
-        chainId: ChainId.ethereum,
-        env: Env.prod,
-      });
-
-      expect(result.toString()).toBe('0.01');
-    });
-
-    it('should use BTCb as default token for Silo', async () => {
-      const result = await getStakeAndBakeFee({
-        protocol: DefiProtocol.Silo,
-        chainId: ChainId.avalancheFuji,
-        env: Env.testnet,
-      });
-
-      expect(result.toString()).toBe('0.01');
-    });
-  });
-
-  describe('Explicit token parameter', () => {
-    it('should use explicitly provided token for Veda (LBTC)', async () => {
-      const result = await getStakeAndBakeFee({
-        protocol: DefiProtocol.Veda,
-        token: Token.LBTC,
-        chainId: ChainId.ethereum,
-        env: Env.prod,
-      });
-
-      expect(result.toString()).toBe('0.01');
-    });
-
-    it('should use explicitly provided token for Silo (BTCb)', async () => {
-      const result = await getStakeAndBakeFee({
-        protocol: DefiProtocol.Silo,
-        token: Token.BTCb,
-        chainId: ChainId.avalancheFuji,
-        env: Env.testnet,
-      });
-
-      expect(result.toString()).toBe('0.01');
-    });
-
-    it('should use explicitly provided BTC token for Veda', async () => {
-      const result = await getStakeAndBakeFee({
-        protocol: DefiProtocol.Veda,
-        token: 'BTC',
-        chainId: ChainId.ethereum,
-        env: Env.prod,
-      });
-
-      expect(result.toString()).toBe('0.01');
-    });
-  });
-
-  describe('Error handling - invalid token/protocol combinations', () => {
-    it('should throw error when using BTCb with Veda (explicit)', async () => {
-      await expect(
-        getStakeAndBakeFee({
-          protocol: DefiProtocol.Veda,
-          token: Token.BTCb,
-          chainId: ChainId.ethereum,
-          env: Env.prod,
-        }),
-      ).rejects.toThrow(
-        'Token BTC.b is not supported for stake and bake on vault Veda',
-      );
-    });
-
-    it('should throw error when using LBTC with Silo (explicit)', async () => {
-      await expect(
-        getStakeAndBakeFee({
-          protocol: DefiProtocol.Silo,
-          token: Token.LBTC,
-          chainId: ChainId.avalancheFuji,
-          env: Env.testnet,
-        }),
-      ).rejects.toThrow(
-        'Token LBTC is not supported for stake and bake on vault Silo',
-      );
-    });
-  });
-
-  describe('Default protocol behavior', () => {
-    it('should default to Veda protocol when not specified', async () => {
-      const result = await getStakeAndBakeFee({
-        chainId: ChainId.ethereum,
-        env: Env.prod,
-      });
-
-      expect(result.toString()).toBe('0.01');
-    });
-
-    it('should default to LBTC token when protocol and token not specified', async () => {
-      const result = await getStakeAndBakeFee({
-        chainId: ChainId.ethereum,
-        env: Env.prod,
-      });
-
-      expect(result.toString()).toBe('0.01');
-    });
-  });
-});