@lombard.finance/sdk 3.1.0 → 3.2.0

package/src/tokens/lbtc-addresses.ts

@@ -46,6 +46,7 @@ export function getLbtcContractAddresses(
   switch (env) {
     case Env.testnet:
       return TESTNET_LBTC_CONTRACTS;
+    case Env.dev:
     case Env.stage:
       return STAGE_LBTC_CONTRACTS;
     case Env.prod:

package/src/tokens/token-addresses.ts

@@ -0,0 +1,32 @@
+import { Address } from 'viem';
+import { ChainId } from '../common/chains';
+
+export enum Token {
+  LBTC = 'LBTC',
+  BTCB = 'BTCB',
+  cbBTC = 'cbBTC',
+  eBTC = 'eBTC',
+  wBTC = 'wBTC',
+  wBTCN = 'wBTCN',
+}
+
+export const TOKEN_ADDRESSES: Partial<
+  Record<Token, Partial<Record<ChainId, Address>>>
+> = {
+  [Token.BTCB]: {
+    [ChainId.binanceSmartChain]: '0x7130d2a12b9bcbfae4f2634d864a1ee1ce3ead9c',
+  },
+  [Token.cbBTC]: {
+    [ChainId.ethereum]: '0xcbb7c0000ab88b473b1f5afd9ef808440eed33bf',
+    [ChainId.base]: '0xcbb7c0000ab88b473b1f5afd9ef808440eed33bf',
+  },
+  [Token.eBTC]: {
+    [ChainId.ethereum]: '0x657e8c867d8b37dcc18fa4caead9c45eb088c642',
+  },
+  [Token.wBTC]: {
+    [ChainId.ethereum]: '0x2260fac5e5542a773aa44fbcfedf7c193bc2c599',
+  },
+  [Token.wBTCN]: {
+    [ChainId.corn]: '0xda5dDd7270381A7C2717aD10D1c0ecB19e3CDFb2',
+  },
+};

package/src/tokens/tokens.ts

@@ -1,11 +1,11 @@
 import { Env } from '@lombard.finance/sdk-common';
-import { getLBTCContractInfo } from './lbtc-contract';
 import { ChainId } from '../common/chains';
 import { makePublicClient } from '../clients/public-client';
 import BigNumber from 'bignumber.js';
-import { Abi, Address, erc20Abi } from 'viem';
-
-export type Token = 'LBTC';
+import { Abi, Address, erc20Abi, PublicClient } from 'viem';
+import { TOKEN_ADDRESSES, Token } from './token-addresses';
+import { getLbtcContractAddresses } from './lbtc-addresses';
+import { LBTC_ABI } from './abi/LBTC_ABI';
 
 export type TokenInfo = {
   address: Address;
@@ -19,21 +19,35 @@ export function getTokenContractInfo(
   chainId: ChainId,
   env?: Env,
 ) {
-  if (token === 'LBTC') {
-    return getLBTCContractInfo(chainId, env);
+  if (token === Token.LBTC) {
+    const addresses = getLbtcContractAddresses(env);
+    const contractAddress = addresses[chainId];
+    if (!contractAddress) {
+      throw new Error(
+        `Could not determine the LBTC contract address for given chain id: ${chainId} (env: ${env})`,
+      );
+    }
+    return { abi: LBTC_ABI, address: contractAddress, chainId };
   }
-}
 
-export async function getTokenInfo(
-  token: Token,
-  chainId: ChainId,
-  env?: Env,
-  rpcUrl?: string,
-): Promise<TokenInfo | undefined> {
-  const tokenContractInfo = getTokenContractInfo(token, chainId, env);
-  if (!tokenContractInfo) return;
+  const address = TOKEN_ADDRESSES[token]?.[chainId];
+  if (!address) {
+    throw new Error(
+      `Could not determine the ${token} contract address for given chain id: ${chainId}`,
+    );
+  }
 
-  const publicClient = makePublicClient({ chainId, rpcUrl });
+  return {
+    abi: erc20Abi,
+    address,
+    chainId,
+  };
+}
+
+export const retrieveTokenProperties = async (
+  publicClient: PublicClient,
+  tokenContractInfo: { abi: Abi; address: Address; chainId: ChainId },
+) => {
   const [symbolResult, decimalsResult] = await publicClient.multicall({
     contracts: [
       {
@@ -58,8 +72,37 @@ export async function getTokenInfo(
       decimals: Number(decimalsResult.result),
     };
   }
+};
+
+export async function getTokenInfo(
+  token: Token,
+  chainId: ChainId,
+  env?: Env,
+  rpcUrl?: string,
+): Promise<TokenInfo | undefined> {
+  const tokenContractInfo = getTokenContractInfo(token, chainId, env);
+  if (!tokenContractInfo) return;
+
+  const publicClient = makePublicClient({ chainId, rpcUrl });
+  return retrieveTokenProperties(publicClient, tokenContractInfo);
+}
+
+export async function getAssetInfo(
+  address: Address,
+  chainId: ChainId,
+  rpcUrl?: string,
+): Promise<TokenInfo | undefined> {
+  const publicClient = makePublicClient({ chainId, rpcUrl });
+  return retrieveTokenProperties(publicClient, {
+    abi: erc20Abi,
+    address,
+    chainId,
+  });
 }
 
+// Utils:
+// TODO: Move to utils
+
 export function toBaseDenomination(
   input: BigNumber.Value,
   decimalPlaces: number,
@@ -75,37 +118,3 @@ export function fromBaseDenomination(
 ) {
   return BigNumber(input).dividedBy(BigNumber(10).pow(decimalPlaces));
 }
-
-export async function getAssetInfo(
-  address: Address,
-  chainId: ChainId,
-  rpcUrl?: string,
-): Promise<TokenInfo | undefined> {
-  const publicClient = makePublicClient({ chainId, rpcUrl });
-  const [symbolResult, decimalsResult] = await publicClient.multicall({
-    contracts: [
-      {
-        address,
-        abi: erc20Abi,
-        functionName: 'symbol',
-      },
-      {
-        address,
-        abi: erc20Abi,
-        functionName: 'decimals',
-      },
-    ],
-  });
-
-  if (
-    symbolResult.status === 'success' &&
-    decimalsResult.status === 'success'
-  ) {
-    return {
-      address,
-      abi: erc20Abi,
-      symbol: String(symbolResult.result),
-      decimals: Number(decimalsResult.result),
-    };
-  }
-}

package/src/utils/numbers.ts

@@ -1,5 +1,8 @@
 import BigNumber from 'bignumber.js';
 
+export const ZERO = BigNumber(0);
+export const ONE = BigNumber(1);
+
 export default function toBigInt(input: BigNumber.Value) {
   return BigInt(BigNumber(input).toFixed());
 }

package/src/vaults/index.ts

@@ -1,187 +1,46 @@
-import { ChainId } from '../common/chains';
-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';
-import VEDA_VAULT_BASE_ASSET_ABI from './abi/VEDA_VAULT_BASE_ASSET_ABI.json';
-import VEDA_VAULT_SPENDER_ABI from './abi/VEDA_VAULT_SPENDER_ABI.json';
-import VEDA_VAULT_TELLER_ABI from './abi/VEDA_VAULT_TELLER_ABI.json';
-import VEDA_VAULT_BORING_WITHDRAW_QUEUE_ABI from './abi/VEDA_VAULT_BORING_WITHDRAW_QUEUE_ABI.json';
-import { Abi, Address } from 'viem';
+// Config:
 
-type ContractInfo = {
-  abi: Abi;
-  address: Address;
-  chainId: ChainId;
-};
+export { Vault } from './lib/config';
 
-export const VEDA_VAULT_CHAINS = [
-  ChainId.ethereum,
-  ChainId.base,
-  ChainId.binanceSmartChain,
-  ChainId.corn,
-] as const;
+// Ops - Deposit:
 
-export type VedaVaultChain = (typeof VEDA_VAULT_CHAINS)[number];
-export const isVedaVaultChain = (chainId: number): chainId is VedaVaultChain =>
-  VEDA_VAULT_CHAINS.includes(chainId as VedaVaultChain);
+export {
+  deposit,
+  type DepositParameters,
+} from './lib/ops/deposit';
 
-export const VEDA_VAULT_CHAIN_TO_NETWORK_MAP: Record<VedaVaultChain, string> = {
-  [ChainId.ethereum]: 'ethereum',
-  [ChainId.base]: 'base',
-  [ChainId.corn]: 'corn',
-  [ChainId.binanceSmartChain]: 'bnb',
-};
+export {
+  getVaultDeposits,
+  type GetVaultDepositsParameters,
+} from './lib/ops/get-vault-deposits';
 
-export const NETWORK_TO_VEDA_VAULT_CHAIN_MAP: Record<string, VedaVaultChain> = {
-  ethereum: ChainId.ethereum,
-  base: ChainId.base,
-  corn: ChainId.corn,
-  bnb: ChainId.binanceSmartChain,
-};
+// Ops - Withdraw:
 
-/** A list of chains where stake and bake is enabled */
-export const VEDA_VAULT_STAKE_AND_BAKE_CHAINS = [
-  ChainId.ethereum,
-  ChainId.binanceSmartChain,
-  // Testnets:
-  ChainId.binanceSmartChainTestnet,
-  ChainId.holesky,
-];
-export type VedaVaultStakeAndBakeChain =
-  (typeof VEDA_VAULT_STAKE_AND_BAKE_CHAINS)[number];
-export const isVedaVaultStakeAndBakeChain = (
-  chainId: number,
-): chainId is VedaVaultStakeAndBakeChain =>
-  VEDA_VAULT_STAKE_AND_BAKE_CHAINS.includes(
-    chainId as VedaVaultStakeAndBakeChain,
-  );
+export {
+  queueWithdraw,
+  type QueueWithdrawParameters,
+  cancelWithdraw,
+  type CancelWithdrawParameters,
+} from './lib/ops/withdraw';
 
-export const VEDA_VAULT_DEFAULT_CHAIN_ID: VedaVaultChain = ChainId.ethereum;
+export {
+  getVaultWithdrawals,
+  type GetVaultWithdrawalsParameters,
+} from './lib/ops/get-vault-withdrawals';
 
-export const VEDA_VAULT_CONTRACT = '0x5401b8620E5FB570064CA9114fd1e135fd77D57c';
-export const VEDA_VAULT_ACCOUNTANT_CONTRACT =
-  '0x28634D0c5edC67CF2450E74deA49B90a4FF93dCE';
-export const VEDA_VAULT_LENS_CONTRACT =
-  '0x5232bc0F5999f8dA604c42E1748A13a170F94A1B';
+// Metrics - Vault points:
 
-export const VEDA_VAULT_TELLER_CONTRACTS: Record<VedaVaultChain, ContractInfo> =
-  {
-    [ChainId.ethereum]: {
-      abi: VEDA_VAULT_TELLER_ABI as Abi,
-      address: '0x4E8f5128F473C6948127f9Cbca474a6700F99bab',
-      chainId: ChainId.ethereum,
-    },
-    [ChainId.base]: {
-      abi: VEDA_VAULT_TELLER_ABI as Abi,
-      address: '0x2eA43384F1A98765257bc6Cb26c7131dEbdEB9B3',
-      chainId: ChainId.base,
-    },
-    [ChainId.binanceSmartChain]: {
-      abi: VEDA_VAULT_TELLER_ABI as Abi,
-      address: '0x2eA43384F1A98765257bc6Cb26c7131dEbdEB9B3',
-      chainId: ChainId.binanceSmartChain,
-    },
-    [ChainId.corn]: {
-      abi: VEDA_VAULT_TELLER_ABI as Abi,
-      address: '0x2eA43384F1A98765257bc6Cb26c7131dEbdEB9B3',
-      chainId: ChainId.corn,
-    },
-  } as const;
+export {
+  getVaultPoints,
+  type GetVaultPointsParameters,
+} from './lib/metrics/get-vault-points';
 
-/** Stake and bake contracts */
-export const VEDA_VAULT_SPENDER_CONTRACTS: Record<
-  VedaVaultStakeAndBakeChain,
-  ContractInfo
-> = {
-  [ChainId.ethereum]: {
-    abi: VEDA_VAULT_SPENDER_ABI as Abi,
-    address: '0xC8bbF6153D7Ba105f1399D992ebd32B0541996ef',
-    chainId: ChainId.ethereum,
-  },
+export {
+  getVaultTVL,
+  type GetVaultTVLParameters,
+} from './lib/metrics/get-vault-tvl';
 
-  [ChainId.binanceSmartChain]: {
-    abi: VEDA_VAULT_SPENDER_ABI as Abi,
-    address: '0xC8bbF6153D7Ba105f1399D992ebd32B0541996ef',
-    chainId: ChainId.binanceSmartChain,
-  },
-  // Testnets:
-  [ChainId.holesky]: {
-    abi: VEDA_VAULT_SPENDER_ABI as Abi,
-    address: '0x4A3cD83CEbb91E0Cd31EdA2Ee0F4AebfcCFCbBb6',
-    chainId: ChainId.holesky,
-  },
-  [ChainId.binanceSmartChainTestnet]: {
-    abi: VEDA_VAULT_SPENDER_ABI as Abi,
-    address: '0x72143309A662bDB4aad5cA65Ab59eD8977D047C5',
-    chainId: ChainId.binanceSmartChainTestnet,
-  },
-} as const;
-
-export const VEDA_VAULT_WITHDRAW_QUEUE_CONTRACTS: Record<
-  VedaVaultChain,
-  ContractInfo
-> = {
-  [ChainId.ethereum]: {
-    abi: VEDA_VAULT_BORING_WITHDRAW_QUEUE_ABI as Abi,
-    address: '0x3b4aCd8879fb60586cCd74bC2F831A4C5E7DbBf8',
-    chainId: ChainId.ethereum,
-  },
-  [ChainId.base]: {
-    abi: VEDA_VAULT_BORING_WITHDRAW_QUEUE_ABI as Abi,
-    address: '0x3b4aCd8879fb60586cCd74bC2F831A4C5E7DbBf8',
-    chainId: ChainId.ethereum,
-  },
-  [ChainId.binanceSmartChain]: {
-    abi: VEDA_VAULT_BORING_WITHDRAW_QUEUE_ABI as Abi,
-    address: '0x3b4aCd8879fb60586cCd74bC2F831A4C5E7DbBf8',
-    chainId: ChainId.ethereum,
-  },
-  [ChainId.corn]: {
-    abi: VEDA_VAULT_BORING_WITHDRAW_QUEUE_ABI as Abi,
-    address: '0x3b4aCd8879fb60586cCd74bC2F831A4C5E7DbBf8',
-    chainId: ChainId.ethereum,
-  },
-};
-
-export const VEDA_VAULT_BASE_ASSET = {
-  abi: VEDA_VAULT_BASE_ASSET_ABI,
-  symbol: 'WBTC',
-  displayName: 'wBTC',
-  address: '0x2260FAC5E5542a773Aa44fBCfeDf7C193bc2C599',
-  decimals: 8,
-};
-
-export enum Vault {
-  Veda = 'veda',
-}
-
-export const VaultNameMap = {
-  [Vault.Veda]: 'Veda / Lombard DeFi Vault',
-} as const;
-
-export const VAULTS = {
-  [Vault.Veda]: {
-    defaultChainId: VEDA_VAULT_DEFAULT_CHAIN_ID,
-    chains: VEDA_VAULT_CHAINS,
-    stakeAndBakeChains: VEDA_VAULT_STAKE_AND_BAKE_CHAINS,
-    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,
-    tellerContracts: VEDA_VAULT_TELLER_CONTRACTS,
-    withdrawQueueContracts: VEDA_VAULT_WITHDRAW_QUEUE_CONTRACTS,
-
-    queueWithdrawDiscountPercent: '0.01',
-    queueWithdrawDaysValid: '3',
-  },
-} as const;
+export {
+  getVaultApy,
+  type GetVaultApyParameters,
+} from './lib/metrics/get-vault-apy';

package/src/vaults/lib/config.ts

@@ -0,0 +1,196 @@
+import { ChainId } from '../../common/chains';
+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';
+import VEDA_VAULT_BASE_ASSET_ABI from '../abi/VEDA_VAULT_BASE_ASSET_ABI.json';
+import VEDA_VAULT_SPENDER_ABI from '../abi/VEDA_VAULT_SPENDER_ABI.json';
+import VEDA_VAULT_TELLER_ABI from '../abi/VEDA_VAULT_TELLER_ABI.json';
+import VEDA_VAULT_BORING_WITHDRAW_QUEUE_ABI from '../abi/VEDA_VAULT_BORING_WITHDRAW_QUEUE_ABI.json';
+import { Abi, Address } from 'viem';
+import { Token } from '../../tokens/token-addresses';
+
+type ContractInfo = {
+  abi: Abi;
+  address: Address;
+  chainId: ChainId;
+};
+
+export const VEDA_VAULT_CHAINS = [
+  ChainId.ethereum,
+  ChainId.base,
+  ChainId.binanceSmartChain,
+  ChainId.corn,
+] as const;
+
+export type VedaVaultChain = (typeof VEDA_VAULT_CHAINS)[number];
+export const isVedaVaultChain = (chainId: number): chainId is VedaVaultChain =>
+  VEDA_VAULT_CHAINS.includes(chainId as VedaVaultChain);
+
+export const VEDA_VAULT_CHAIN_TO_NETWORK_MAP: Record<VedaVaultChain, string> = {
+  [ChainId.ethereum]: 'ethereum',
+  [ChainId.base]: 'base',
+  [ChainId.corn]: 'corn',
+  [ChainId.binanceSmartChain]: 'bnb',
+};
+
+export const NETWORK_TO_VEDA_VAULT_CHAIN_MAP: Record<string, VedaVaultChain> = {
+  ethereum: ChainId.ethereum,
+  base: ChainId.base,
+  corn: ChainId.corn,
+  bnb: ChainId.binanceSmartChain,
+};
+
+/** A list of chains where stake and bake is enabled */
+export const VEDA_VAULT_STAKE_AND_BAKE_CHAINS = [
+  ChainId.ethereum,
+  ChainId.binanceSmartChain,
+  // Testnets:
+  ChainId.binanceSmartChainTestnet,
+  ChainId.holesky,
+];
+export type VedaVaultStakeAndBakeChain =
+  (typeof VEDA_VAULT_STAKE_AND_BAKE_CHAINS)[number];
+export const isVedaVaultStakeAndBakeChain = (
+  chainId: number,
+): chainId is VedaVaultStakeAndBakeChain =>
+  VEDA_VAULT_STAKE_AND_BAKE_CHAINS.includes(
+    chainId as VedaVaultStakeAndBakeChain,
+  );
+
+export const VEDA_VAULT_DEFAULT_CHAIN_ID: VedaVaultChain = ChainId.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_TELLER_CONTRACTS: Record<VedaVaultChain, ContractInfo> =
+  {
+    [ChainId.ethereum]: {
+      abi: VEDA_VAULT_TELLER_ABI as Abi,
+      address: '0x4E8f5128F473C6948127f9Cbca474a6700F99bab',
+      chainId: ChainId.ethereum,
+    },
+    [ChainId.base]: {
+      abi: VEDA_VAULT_TELLER_ABI as Abi,
+      address: '0x2eA43384F1A98765257bc6Cb26c7131dEbdEB9B3',
+      chainId: ChainId.base,
+    },
+    [ChainId.binanceSmartChain]: {
+      abi: VEDA_VAULT_TELLER_ABI as Abi,
+      address: '0x2eA43384F1A98765257bc6Cb26c7131dEbdEB9B3',
+      chainId: ChainId.binanceSmartChain,
+    },
+    [ChainId.corn]: {
+      abi: VEDA_VAULT_TELLER_ABI as Abi,
+      address: '0x2eA43384F1A98765257bc6Cb26c7131dEbdEB9B3',
+      chainId: ChainId.corn,
+    },
+  } as const;
+
+/** Stake and bake contracts */
+export const VEDA_VAULT_SPENDER_CONTRACTS: Record<
+  VedaVaultStakeAndBakeChain,
+  ContractInfo
+> = {
+  [ChainId.ethereum]: {
+    abi: VEDA_VAULT_SPENDER_ABI as Abi,
+    address: '0xC8bbF6153D7Ba105f1399D992ebd32B0541996ef',
+    chainId: ChainId.ethereum,
+  },
+
+  [ChainId.binanceSmartChain]: {
+    abi: VEDA_VAULT_SPENDER_ABI as Abi,
+    address: '0xC8bbF6153D7Ba105f1399D992ebd32B0541996ef',
+    chainId: ChainId.binanceSmartChain,
+  },
+  // Testnets:
+  [ChainId.holesky]: {
+    abi: VEDA_VAULT_SPENDER_ABI as Abi,
+    address: '0x4A3cD83CEbb91E0Cd31EdA2Ee0F4AebfcCFCbBb6',
+    chainId: ChainId.holesky,
+  },
+  [ChainId.binanceSmartChainTestnet]: {
+    abi: VEDA_VAULT_SPENDER_ABI as Abi,
+    address: '0x72143309A662bDB4aad5cA65Ab59eD8977D047C5',
+    chainId: ChainId.binanceSmartChainTestnet,
+  },
+} as const;
+
+export const VEDA_VAULT_WITHDRAW_QUEUE_CONTRACTS: Record<
+  VedaVaultChain,
+  ContractInfo
+> = {
+  [ChainId.ethereum]: {
+    abi: VEDA_VAULT_BORING_WITHDRAW_QUEUE_ABI as Abi,
+    address: '0x3b4aCd8879fb60586cCd74bC2F831A4C5E7DbBf8',
+    chainId: ChainId.ethereum,
+  },
+  [ChainId.base]: {
+    abi: VEDA_VAULT_BORING_WITHDRAW_QUEUE_ABI as Abi,
+    address: '0x3b4aCd8879fb60586cCd74bC2F831A4C5E7DbBf8',
+    chainId: ChainId.ethereum,
+  },
+  [ChainId.binanceSmartChain]: {
+    abi: VEDA_VAULT_BORING_WITHDRAW_QUEUE_ABI as Abi,
+    address: '0x3b4aCd8879fb60586cCd74bC2F831A4C5E7DbBf8',
+    chainId: ChainId.ethereum,
+  },
+  [ChainId.corn]: {
+    abi: VEDA_VAULT_BORING_WITHDRAW_QUEUE_ABI as Abi,
+    address: '0x3b4aCd8879fb60586cCd74bC2F831A4C5E7DbBf8',
+    chainId: ChainId.ethereum,
+  },
+};
+
+export const VEDA_VAULT_BASE_ASSET = {
+  abi: VEDA_VAULT_BASE_ASSET_ABI,
+  symbol: 'WBTC',
+  displayName: 'wBTC',
+  address: '0x2260FAC5E5542a773Aa44fBCfeDf7C193bc2C599',
+  decimals: 8,
+};
+
+export enum Vault {
+  Veda = 'veda',
+}
+
+export const VaultNameMap = {
+  [Vault.Veda]: 'Veda / Lombard DeFi Vault',
+} as const;
+
+export const VAULTS = {
+  [Vault.Veda]: {
+    defaultChainId: VEDA_VAULT_DEFAULT_CHAIN_ID,
+    chains: VEDA_VAULT_CHAINS,
+    tokens: {
+      [Token.LBTC]: VEDA_VAULT_CHAINS,
+      [Token.BTCB]: [ChainId.binanceSmartChain],
+      [Token.cbBTC]: [ChainId.ethereum, ChainId.base],
+      [Token.eBTC]: [ChainId.ethereum],
+      [Token.wBTC]: [ChainId.ethereum],
+      [Token.wBTCN]: [ChainId.corn],
+    },
+    stakeAndBakeChains: VEDA_VAULT_STAKE_AND_BAKE_CHAINS,
+    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,
+    tellerContracts: VEDA_VAULT_TELLER_CONTRACTS,
+    withdrawQueueContracts: VEDA_VAULT_WITHDRAW_QUEUE_CONTRACTS,
+
+    queueWithdrawDiscountPercent: '0.01',
+    queueWithdrawDaysValid: '3',
+  },
+} as const;

package/src/vaults/lib/metrics/get-vault-apy.stories.tsx

@@ -0,0 +1,57 @@
+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 {
+  functionType,
+  wagmiDecorator,
+} from '../../../stories/components/decorators';
+import { Vault } from '../config';
+import { ErrorBlock } from '../../../stories/components/error-block';
+import { getVaultApy, GetVaultApyParameters } from './get-vault-apy';
+
+const meta = {
+  title: 'vault/metrics/getVaultApy',
+  component: StoryView,
+  tags: ['autodocs'],
+  decorators: [wagmiDecorator, functionType('api-get')],
+} satisfies Meta<typeof StoryView>;
+
+export default meta;
+
+type Story = StoryObj<typeof meta>;
+
+export const WithParams: Story = {
+  args: {
+    vaultKey: Vault.Veda,
+  },
+};
+
+type SignNetworkFeeProps = GetVaultApyParameters;
+
+export function StoryView(props: SignNetworkFeeProps) {
+  const request = async () => {
+    return getVaultApy({
+      ...props,
+    });
+  };
+
+  const { data, error, isLoading, refetch } = useQuery(request, [], false);
+
+  return (
+    <>
+      <p>This function gets the APY entries of the DeFi vault.</p>
+
+      <Button
+        onClick={refetch}
+        disabled={isLoading}
+        isLoading={isLoading}
+        actionName={getVaultApy.name}
+      />
+
+      <ErrorBlock>{error}</ErrorBlock>
+
+      <CodeBlock text={data} />
+    </>
+  );
+}