@lombard.finance/sdk 2.4.0 → 2.4.2

package/src/vaults/abi/VEDA_VAULT_LENS_ABI.json

@@ -0,0 +1,175 @@
+[
+  {
+    "inputs": [
+      { "internalType": "address", "name": "account", "type": "address" },
+      {
+        "internalType": "contract BoringVault",
+        "name": "boringVault",
+        "type": "address"
+      }
+    ],
+    "name": "balanceOf",
+    "outputs": [
+      { "internalType": "uint256", "name": "shares", "type": "uint256" }
+    ],
+    "stateMutability": "view",
+    "type": "function"
+  },
+  {
+    "inputs": [
+      { "internalType": "address", "name": "account", "type": "address" },
+      {
+        "internalType": "contract BoringVault",
+        "name": "boringVault",
+        "type": "address"
+      },
+      {
+        "internalType": "contract AccountantWithRateProviders",
+        "name": "accountant",
+        "type": "address"
+      }
+    ],
+    "name": "balanceOfInAssets",
+    "outputs": [
+      { "internalType": "uint256", "name": "assets", "type": "uint256" }
+    ],
+    "stateMutability": "view",
+    "type": "function"
+  },
+  {
+    "inputs": [
+      { "internalType": "address", "name": "account", "type": "address" },
+      {
+        "internalType": "contract ERC20",
+        "name": "depositAsset",
+        "type": "address"
+      },
+      { "internalType": "uint256", "name": "depositAmount", "type": "uint256" },
+      {
+        "internalType": "contract BoringVault",
+        "name": "boringVault",
+        "type": "address"
+      },
+      {
+        "internalType": "contract TellerWithMultiAssetSupport",
+        "name": "teller",
+        "type": "address"
+      }
+    ],
+    "name": "checkUserDeposit",
+    "outputs": [{ "internalType": "bool", "name": "", "type": "bool" }],
+    "stateMutability": "view",
+    "type": "function"
+  },
+  {
+    "inputs": [
+      { "internalType": "address", "name": "account", "type": "address" },
+      {
+        "internalType": "contract ERC20",
+        "name": "depositAsset",
+        "type": "address"
+      },
+      { "internalType": "uint256", "name": "depositAmount", "type": "uint256" },
+      {
+        "internalType": "contract TellerWithMultiAssetSupport",
+        "name": "teller",
+        "type": "address"
+      }
+    ],
+    "name": "checkUserDepositWithPermit",
+    "outputs": [{ "internalType": "bool", "name": "", "type": "bool" }],
+    "stateMutability": "view",
+    "type": "function"
+  },
+  {
+    "inputs": [
+      {
+        "internalType": "contract AccountantWithRateProviders",
+        "name": "accountant",
+        "type": "address"
+      }
+    ],
+    "name": "exchangeRate",
+    "outputs": [
+      { "internalType": "uint256", "name": "rate", "type": "uint256" }
+    ],
+    "stateMutability": "view",
+    "type": "function"
+  },
+  {
+    "inputs": [
+      {
+        "internalType": "contract TellerWithMultiAssetSupport",
+        "name": "teller",
+        "type": "address"
+      }
+    ],
+    "name": "isTellerPaused",
+    "outputs": [{ "internalType": "bool", "name": "", "type": "bool" }],
+    "stateMutability": "view",
+    "type": "function"
+  },
+  {
+    "inputs": [
+      {
+        "internalType": "contract ERC20",
+        "name": "depositAsset",
+        "type": "address"
+      },
+      { "internalType": "uint256", "name": "depositAmount", "type": "uint256" },
+      {
+        "internalType": "contract BoringVault",
+        "name": "boringVault",
+        "type": "address"
+      },
+      {
+        "internalType": "contract AccountantWithRateProviders",
+        "name": "accountant",
+        "type": "address"
+      }
+    ],
+    "name": "previewDeposit",
+    "outputs": [
+      { "internalType": "uint256", "name": "shares", "type": "uint256" }
+    ],
+    "stateMutability": "view",
+    "type": "function"
+  },
+  {
+    "inputs": [
+      {
+        "internalType": "contract BoringVault",
+        "name": "boringVault",
+        "type": "address"
+      },
+      {
+        "internalType": "contract AccountantWithRateProviders",
+        "name": "accountant",
+        "type": "address"
+      }
+    ],
+    "name": "totalAssets",
+    "outputs": [
+      { "internalType": "contract ERC20", "name": "asset", "type": "address" },
+      { "internalType": "uint256", "name": "assets", "type": "uint256" }
+    ],
+    "stateMutability": "view",
+    "type": "function"
+  },
+  {
+    "inputs": [
+      { "internalType": "address", "name": "account", "type": "address" },
+      {
+        "internalType": "contract TellerWithMultiAssetSupport",
+        "name": "teller",
+        "type": "address"
+      }
+    ],
+    "name": "userUnlockTime",
+    "outputs": [
+      { "internalType": "uint256", "name": "time", "type": "uint256" }
+    ],
+    "stateMutability": "view",
+    "type": "function"
+  }
+]

package/src/vaults/index.ts

@@ -0,0 +1,54 @@
+import { OChainId } from '../common/types/types';
+
+import VEDA_VAULT_ABI from './abi/VEDA_VAULT_ABI.json';
+import VEDA_VAULT_ACCOUNTANT_ABI from './abi/VEDA_VAULT_ACCOUNTANT_ABI.json';
+import VEDA_VAULT_LENS_ABI from './abi/VEDA_VAULT_LENS_ABI.json';
+
+export const VEDA_VAULT_CHAIN_ID = OChainId.ethereum;
+export const VEDA_VAULT_CONTRACT = '0x5401b8620E5FB570064CA9114fd1e135fd77D57c';
+export const VEDA_VAULT_ACCOUNTANT_CONTRACT =
+  '0x28634D0c5edC67CF2450E74deA49B90a4FF93dCE';
+export const VEDA_VAULT_LENS_CONTRACT =
+  '0x5232bc0F5999f8dA604c42E1748A13a170F94A1B';
+
+export const VEDA_VAULT_SPENDER_CONTRACTS = {
+  [OChainId.holesky]: '0x4A3cD83CEbb91E0Cd31EdA2Ee0F4AebfcCFCbBb6',
+  [OChainId.ethereum]: '0xC8bbF6153D7Ba105f1399D992ebd32B0541996ef',
+  [OChainId.binanceSmartChain]: '0xC8bbF6153D7Ba105f1399D992ebd32B0541996ef',
+  [OChainId.binanceSmartChainTestnet]:
+    '0x72143309A662bDB4aad5cA65Ab59eD8977D047C5',
+} as const;
+
+export enum Vault {
+  Veda = 'veda',
+}
+
+export const VaultNameMap = {
+  [Vault.Veda]: 'Veda / Lombard DeFi Vault',
+} as const;
+
+export const VAULTS = {
+  [Vault.Veda]: {
+    defaultChainId: VEDA_VAULT_CHAIN_ID,
+    chains: [
+      OChainId.base,
+      OChainId.binanceSmartChain,
+      OChainId.corn,
+      OChainId.ethereum,
+    ],
+    decimals: 8,
+    vaultContract: {
+      abi: VEDA_VAULT_ABI,
+      address: VEDA_VAULT_CONTRACT,
+    },
+    accountantContract: {
+      abi: VEDA_VAULT_ACCOUNTANT_ABI,
+      address: VEDA_VAULT_ACCOUNTANT_CONTRACT,
+    },
+    lensContract: {
+      abi: VEDA_VAULT_LENS_ABI,
+      address: VEDA_VAULT_LENS_CONTRACT,
+    },
+    spenderContracts: VEDA_VAULT_SPENDER_CONTRACTS,
+  },
+} as const;

package/src/web3Sdk/abi/index.ts

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

package/src/web3Sdk/getShareValue/getShareValue.stories.tsx

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

package/src/web3Sdk/getShareValue/getShareValue.ts

@@ -0,0 +1,58 @@
+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/getShareValue/index.ts

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

package/src/web3Sdk/getSharesByAddress/getSharesByAddress.stories.tsx

@@ -0,0 +1,60 @@
+import type { Meta, StoryObj } from '@storybook/react';
+
+import { OChainId } from '../../common/types/types';
+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 { CodeBlock } from '../../stories/components/CodeBlock';
+
+const meta = {
+  title: 'Web3SDK/getSharesByAddress',
+  component: StoryView,
+  tags: ['autodocs'],
+} satisfies Meta<typeof StoryView>;
+
+export default meta;
+
+type Story = StoryObj<typeof meta>;
+
+export const WithParams: Story = {
+  args: {
+    chainId: OChainId.ethereum,
+    address: exampleEvmAddress,
+    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}>
+        Get LBTCv shares owned
+      </Button>
+
+      <CodeBlock text={error || data} />
+
+      {data && (
+        <div className="mt-4 p-4 border rounded">
+          <h3 className="text-lg font-bold mb-2">LBTCv shares owned</h3>
+          <p>
+            <b>{data.balance.toString()}</b> LBTCv ={' '}
+            {data.balanceLbtc.toString()} LBTC
+          </p>
+        </div>
+      )}
+    </div>
+  );
+}

package/src/web3Sdk/getSharesByAddress/getSharesByAddress.ts

@@ -0,0 +1,84 @@
+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';
+import { getShareValue } from '../getShareValue';
+
+export interface IGetSharesByAddressParameters {
+  /**
+   * 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;
+  /**
+   * The address of the share holder.
+   */
+  address: string;
+  /**
+   * Optional vault key specifying the vault in use
+   * @default {string} - "veda"
+   */
+  vaultKey?: 'veda';
+}
+
+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.
+ */
+export async function getSharesByAddress({
+  chainId,
+  rpcUrl,
+  address,
+  vaultKey = 'veda',
+}: IGetSharesByAddressParameters): Promise<IGetSharesByAddressResponse> {
+  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 lensContract = provider.createContract<typeof vault.lensContract.abi>(
+      vault.lensContract.abi,
+      vault.lensContract.address,
+    );
+
+    const balanceValue = await lensContract.methods
+      .balanceOf(address, vault.vaultContract.address)
+      .call();
+    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/web3Sdk/getSharesByAddress/index.ts

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

package/src/web3Sdk/index.ts

@@ -13,3 +13,5 @@ export * from './unstakeLBTC';
 export * from './getBasculeDepositStatus';
 export * from './getLBTCTotalSupply';
 export * from './getStakeAndBakeFee';
+export * from './getShareValue';
+export * from './getSharesByAddress';

package/src/web3Sdk/signStakeAndBake/contracts.ts

@@ -1,3 +1,8 @@
+import {
+  Vault,
+  VaultNameMap,
+  VEDA_VAULT_SPENDER_CONTRACTS,
+} from '../../vaults';
 import { OChainId, TChainId } from '../../common/types/types';
 
 export interface IStakeAndBakeVault {
@@ -18,30 +23,30 @@ export interface IStakeAndBakeVault {
 export const STAKE_AND_BAKE_VAULTS: Record<number, IStakeAndBakeVault[]> = {
   [OChainId.holesky]: [
     {
-      key: 'veda',
-      name: 'Veda / Lombard DeFi Vault',
-      address: '0x4A3cD83CEbb91E0Cd31EdA2Ee0F4AebfcCFCbBb6',
+      key: Vault.Veda,
+      name: VaultNameMap[Vault.Veda],
+      address: VEDA_VAULT_SPENDER_CONTRACTS[OChainId.holesky],
     },
   ],
   [OChainId.ethereum]: [
     {
-      key: 'veda',
-      name: 'Veda / Lombard DeFi Vault',
-      address: '0xC8bbF6153D7Ba105f1399D992ebd32B0541996ef',
+      key: Vault.Veda,
+      name: VaultNameMap[Vault.Veda],
+      address: VEDA_VAULT_SPENDER_CONTRACTS[OChainId.ethereum],
     },
   ],
   [OChainId.binanceSmartChain]: [
     {
-      key: 'veda',
-      name: 'Veda / Lombard DeFi Vault',
-      address: '0xC8bbF6153D7Ba105f1399D992ebd32B0541996ef',
+      key: Vault.Veda,
+      name: VaultNameMap[Vault.Veda],
+      address: VEDA_VAULT_SPENDER_CONTRACTS[OChainId.binanceSmartChain],
     },
   ],
   [OChainId.binanceSmartChainTestnet]: [
     {
-      key: 'veda',
-      name: 'Veda / Lombard DeFi Vault',
-      address: '0x72143309A662bDB4aad5cA65Ab59eD8977D047C5',
+      key: Vault.Veda,
+      name: VaultNameMap[Vault.Veda],
+      address: VEDA_VAULT_SPENDER_CONTRACTS[OChainId.binanceSmartChainTestnet],
     },
   ],
 } as const;