@lombard.finance/sdk 4.0.0 → 4.1.0

package/src/vaults/index.ts

@@ -1,46 +0,0 @@
-// Config:
-
-export { Vault, VEDA_VAULT_STAKE_AND_BAKE_CHAINS } from './lib/config';
-
-// Ops - Deposit:
-
-export { deposit, type DepositParameters } from './lib/ops/deposit';
-export {
-  getVaultDeposits,
-  getVaultDepositsAllChains,
-  type GetVaultDepositsAllChainsParameters,
-  type GetVaultDepositsParameters,
-  type VaultDeposit,
-} from './lib/ops/get-vault-deposits';
-
-// Ops - Withdraw:
-
-export {
-  getVaultWithdrawals,
-  getVaultWithdrawalsAllChains,
-  type GetVaultWithdrawalsAllChainsParameters,
-  type GetVaultWithdrawalsParameters,
-  type VaultWithdrawal,
-  type VaultWithdrawals,
-} from './lib/ops/get-vault-withdrawals';
-export {
-  cancelWithdraw,
-  type CancelWithdrawParameters,
-  queueWithdraw,
-  type QueueWithdrawParameters,
-} from './lib/ops/withdraw';
-
-// Metrics - Vault points:
-
-export {
-  getVaultApy,
-  type GetVaultApyParameters,
-} from './lib/metrics/get-vault-apy';
-export {
-  getVaultPoints,
-  type GetVaultPointsParameters,
-} from './lib/metrics/get-vault-points';
-export {
-  getVaultTVL,
-  type GetVaultTVLParameters,
-} from './lib/metrics/get-vault-tvl';

package/src/vaults/lib/config.ts

@@ -1,184 +0,0 @@
-import { Abi, Address } from 'viem';
-
-import { ChainId } from '../../common/chains';
-import { Token } from '../../tokens/token-addresses';
-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_BASE_ASSET_ABI from '../abi/VEDA_VAULT_BASE_ASSET_ABI.json';
-import VEDA_VAULT_BORING_WITHDRAW_QUEUE_ABI from '../abi/VEDA_VAULT_BORING_WITHDRAW_QUEUE_ABI.json';
-import VEDA_VAULT_LENS_ABI from '../abi/VEDA_VAULT_LENS_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';
-
-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,
-  // Testnets:
-  ChainId.sepolia,
-];
-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,
-  },
-  // Testnets:
-  [ChainId.sepolia]: {
-    abi: VEDA_VAULT_SPENDER_ABI as Abi,
-    address: '0x77eD6a84fEF665156e81247ECbd43A847B8A6398',
-    chainId: ChainId.sepolia,
-  },
-} 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.BTCBinance]: [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

@@ -1,58 +0,0 @@
-import type { Meta, StoryObj } from '@storybook/react';
-
-import { Button } from '../../../stories/components/Button';
-import { CodeBlock } from '../../../stories/components/CodeBlock';
-import {
-  functionType,
-  wagmiDecorator,
-} from '../../../stories/components/decorators';
-import { ErrorBlock } from '../../../stories/components/error-block';
-import useQuery from '../../../stories/hooks/useQuery';
-import { Vault } from '../config';
-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} />
-    </>
-  );
-}

package/src/vaults/lib/metrics/get-vault-apy.ts

@@ -1,176 +0,0 @@
-import axios from 'axios';
-import BigNumber from 'bignumber.js';
-
-import { getApiConfig } from '../../../common/api-config';
-import { ChainId } from '../../../common/chains';
-import { IEnvParam } from '../../../common/parameters';
-import { orderBy } from '../../../utils/array';
-import { isVedaVaultChain, Vault, VAULTS, VedaVaultChain } from '../config';
-
-type PerformanceEntry = {
-  aggregation_period: string;
-  apy: number;
-  chain_allocation: { [network: string]: number };
-  fees: number;
-  real_apy_breakdown: {
-    allocation: number;
-    apy: number;
-    /** network */
-    chain: string;
-    protocol: string;
-  }[];
-  timestamp: string;
-};
-
-type PerformancePayload =
-  | PerformanceEntry
-  | PerformanceEntry[]
-  | { Response: PerformanceEntry }
-  | { Response: PerformanceEntry[] };
-
-const normalizeSevenSeasPerformance = (
-  payload: PerformancePayload | undefined,
-): PerformanceEntry[] => {
-  if (!payload) {
-    return [];
-  }
-
-  if (Array.isArray(payload)) {
-    return payload;
-  }
-
-  if ('Response' in payload) {
-    const response = payload.Response;
-    if (Array.isArray(response)) {
-      return response;
-    }
-    if (response) {
-      return [response];
-    }
-    return [];
-  }
-
-  return [payload];
-};
-
-export type GetVaultApyParameters = IEnvParam & {
-  aggregationPeriod?: 7 | 14 | 30;
-  chainId?: ChainId;
-  vaultKey?: Vault;
-};
-
-/** Gets the trailing APY performance history. */
-export async function getVaultApy({
-  aggregationPeriod = 7,
-  chainId = ChainId.ethereum,
-  vaultKey = Vault.Veda,
-  env,
-}: GetVaultApyParameters) {
-  const response = await getVaultPerformance({
-    aggregationPeriod,
-    chainId,
-    vaultKey,
-    env,
-  });
-
-  const apys = response.map(r => {
-    const allocations = Object.entries(r.chain_allocation)
-      .map(([network, value]) => [
-        NETWORK_TO_CHAIN_ID_MAP[network],
-        BigNumber(value),
-      ])
-      .reduce(
-        (acc, cur) => {
-          const [chainId, value] = cur as [ChainId, BigNumber];
-          acc[chainId] = value;
-          return acc;
-        },
-        {} as Partial<Record<ChainId, BigNumber>>,
-      );
-
-    const breakdown = r.real_apy_breakdown.map(b => ({
-      allocations: BigNumber(b.allocation),
-      apy: BigNumber(b.apy),
-      chainId: NETWORK_TO_CHAIN_ID_MAP[b.chain],
-      protocol: b.protocol,
-    }));
-
-    return {
-      apy: BigNumber(r.apy),
-      allocations,
-      breakdown,
-      timestamp: new Date(r.timestamp),
-    };
-  });
-
-  return orderBy(apys, a => a.timestamp.getTime(), 'desc');
-}
-
-type GetVaultPerformanceParameters = {
-  aggregationPeriod?: 7 | 14 | 30;
-  chainId: ChainId;
-  vaultKey?: Vault;
-} & IEnvParam;
-
-const CHAIN_ID_TO_NETWORK_MAP: Record<VedaVaultChain, string> = {
-  // NOTE: For now only `ethereum` is supported by the API.
-  [ChainId.ethereum]: 'ethereum',
-
-  // NOTE: The following networks are not supported for now. The API is supposed
-  // to return the aggregated data for all vault chains.
-  [ChainId.base]: 'base',
-  [ChainId.binanceSmartChain]: 'bnb',
-  [ChainId.corn]: 'corn',
-};
-
-const NETWORK_TO_CHAIN_ID_MAP: Record<string, VedaVaultChain> = {
-  ethereum: ChainId.ethereum,
-  base: ChainId.base,
-  bnb: ChainId.binanceSmartChain,
-  corn: ChainId.corn,
-};
-
-/**
- * Gets the raw response of the performance apy api for the provided vault.
- */
-async function getVaultPerformance({
-  aggregationPeriod = 7,
-  chainId,
-  vaultKey = Vault.Veda,
-  env,
-}: GetVaultPerformanceParameters) {
-  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(', ')}`,
-    );
-  }
-
-  const network = CHAIN_ID_TO_NETWORK_MAP[chainId];
-  if (network !== 'ethereum') {
-    throw new Error(
-      `Unsupported network ${network}. Please switch to 'ethereum'.`,
-    );
-  }
-
-  const { bffApiUrl } = getApiConfig(env);
-  if (!bffApiUrl) {
-    throw new Error(
-      `Could not determine API endpoint for provided environment: ${env}`,
-    );
-  }
-
-  const params = new URLSearchParams({
-    aggregation_period: String(aggregationPeriod),
-    historical: 'true',
-  });
-  const url = `${bffApiUrl}/sevenseas-api/performance/${network}/${vault.vaultContract.address}?${params.toString()}`;
-
-  const { data } = await axios.get<PerformancePayload>(url);
-
-  return normalizeSevenSeasPerformance(data);
-}

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

@@ -1,60 +0,0 @@
-import type { Meta, StoryObj } from '@storybook/react';
-
-import { Button } from '../../../stories/components/Button';
-import { CodeBlock } from '../../../stories/components/CodeBlock';
-import {
-  functionType,
-  wagmiDecorator,
-} from '../../../stories/components/decorators';
-import { ErrorBlock } from '../../../stories/components/error-block';
-import { EXAMPLE_EVM_ADDRESS } from '../../../stories/constants';
-import useQuery from '../../../stories/hooks/useQuery';
-import { Vault } from '../config';
-import { getVaultPoints,GetVaultPointsParameters } from './get-vault-points';
-
-const meta = {
-  title: 'vault/metrics/getVaultPoints',
-  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: {
-    account: EXAMPLE_EVM_ADDRESS,
-    vaultKey: Vault.Veda,
-  },
-};
-
-type SignNetworkFeeProps = GetVaultPointsParameters;
-
-export function StoryView(props: SignNetworkFeeProps) {
-  const request = async () => {
-    return getVaultPoints({
-      ...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}
-        actionName={getVaultPoints.name}
-      />
-
-      <ErrorBlock>{error}</ErrorBlock>
-
-      <CodeBlock text={data} />
-    </>
-  );
-}

package/src/vaults/lib/metrics/get-vault-points.ts

@@ -1,74 +0,0 @@
-import axios from 'axios';
-import { Address } from 'viem';
-
-import { Vault, VAULTS } from '../config';
-
-export type GetVaultPointsParameters = {
-  /** The account address. */
-  account: Address;
-  /** The optional vault identifier */
-  vaultKey?: Vault;
-};
-
-const POINTS_URL = 'https://api.veda.tech/points/user/{account}';
-
-type Response = {
-  Response: {
-    [network: string]: {
-      userChainVedaPointsSum: number;
-      vaults: {
-        [vaultAddress: string]: {
-          name: string;
-          timestamp: string;
-          totalPoints: number;
-        };
-      };
-    };
-  };
-};
-
-/**
- * Gets the points earned by specified account in the DeFi vault.
- */
-export async function getVaultPoints({
-  account,
-  vaultKey = Vault.Veda,
-}: GetVaultPointsParameters) {
-  const vault = VAULTS[vaultKey];
-  if (!vault) {
-    throw new Error(`Unknown vault key: ${vaultKey}`);
-  }
-
-  const url = POINTS_URL.replace('{account}', account);
-  const { data } = await axios.get<Response>(url, {
-    headers: {
-      'Access-Control-Allow-Origin': '*',
-      'Content-Type': 'application/json',
-    },
-  });
-
-  const vedaPointsBreakdown: Record<string, number> = {};
-  const entries = Object.entries(data.Response);
-  for (const [network, points] of entries) {
-    if (network === 'userTotalVedaPointsSum') continue;
-
-    const vaultPoints = Object.entries(points.vaults).find(
-      ([v]) => v === vault.vaultContract.address,
-    );
-    if (vaultPoints) {
-      const [, data] = vaultPoints;
-      const p = Number.isNaN(data.totalPoints) ? 0 : data.totalPoints;
-      vedaPointsBreakdown[network] = p;
-    }
-  }
-
-  let totalPoints = 0;
-  for (const p of Object.values(vedaPointsBreakdown)) {
-    totalPoints += p;
-  }
-
-  return {
-    totalPoints,
-    pointsBreakdown: vedaPointsBreakdown,
-  };
-}

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

@@ -1,58 +0,0 @@
-import type { Meta, StoryObj } from '@storybook/react';
-
-import { Button } from '../../../stories/components/Button';
-import { CodeBlock } from '../../../stories/components/CodeBlock';
-import {
-  functionType,
-  wagmiDecorator,
-} from '../../../stories/components/decorators';
-import { ErrorBlock } from '../../../stories/components/error-block';
-import useQuery from '../../../stories/hooks/useQuery';
-import { Vault } from '../config';
-import { getVaultTVL,GetVaultTVLParameters } from './get-vault-tvl';
-
-const meta = {
-  title: 'vault/metrics/getVaultTVL',
-  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 = GetVaultTVLParameters;
-
-export function StoryView(props: SignNetworkFeeProps) {
-  const request = async () => {
-    return getVaultTVL({
-      ...props,
-    });
-  };
-
-  const { data, error, isLoading, refetch } = useQuery(request, [], false);
-
-  return (
-    <>
-      <p>This function gets the TVL of the DeFi vault.</p>
-
-      <Button
-        onClick={refetch}
-        disabled={isLoading}
-        isLoading={isLoading}
-        actionName={getVaultTVL.name}
-      />
-
-      <ErrorBlock>{error}</ErrorBlock>
-
-      <CodeBlock text={data} />
-    </>
-  );
-}