@lombard.finance/sdk 3.1.0 → 3.4.0

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

@@ -0,0 +1,132 @@
+import axios from 'axios';
+import { ChainId } from '../../../common/chains';
+import { isVedaVaultChain, Vault, VAULTS, VedaVaultChain } from '../config';
+import BigNumber from 'bignumber.js';
+import { orderBy } from '../../../utils/array';
+
+export type GetVaultApyParameters = {
+  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,
+}: GetVaultApyParameters) {
+  const response = await getVaultPerformance({
+    aggregationPeriod,
+    chainId,
+    vaultKey,
+  });
+
+  const apys = response.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;
+};
+
+type Response = {
+  Response: {
+    aggregation_period: string;
+    apy: number;
+    chain_allocation: { [network: string]: number };
+    fees: number;
+    // omitted prop: global_apy_breakdown
+    // omitted prop: maturity_apy_breakdown
+    real_apy_breakdown: {
+      allocation: number;
+      apy: number;
+      /** network */
+      chain: string;
+      protocol: string;
+    }[];
+    timestamp: string;
+  }[];
+};
+
+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,
+}: 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 url = `https://api.sevenseas.capital/performance/${network}/${vault.vaultContract.address}?historical=true&aggregation_period=${aggregationPeriod}`;
+
+  const { data } = await axios.get<Response>(url);
+
+  return data;
+}

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

@@ -1,18 +1,18 @@
 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 { 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 '..';
-import { ErrorBlock } from '../../stories/components/error-block';
-import { EXAMPLE_EVM_ADDRESS } from '../../stories/constants';
+} from '../../../stories/components/decorators';
+import { Vault } from '../config';
+import { ErrorBlock } from '../../../stories/components/error-block';
+import { EXAMPLE_EVM_ADDRESS } from '../../../stories/constants';
 import { getVaultPoints, GetVaultPointsParameters } from './get-vault-points';
 
 const meta = {
-  title: 'vault/getVaultPoints',
+  title: 'vault/metrics/getVaultPoints',
   component: StoryView,
   tags: ['autodocs'],
   decorators: [wagmiDecorator, functionType('api-get')],

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

@@ -1,5 +1,5 @@
 import { Address } from 'viem';
-import { Vault, VAULTS } from '..';
+import { Vault, VAULTS } from '../config';
 import axios from 'axios';
 
 export type GetVaultPointsParameters = {

package/src/vaults/lib/metrics/get-vault-tvl.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 { 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} />
+    </>
+  );
+}

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

@@ -0,0 +1,119 @@
+import BigNumber from 'bignumber.js';
+import { makePublicClient } from '../../../clients/public-client';
+import { Vault, VAULTS, VedaVaultChain } from '../config';
+import {
+  fromBaseDenomination,
+  getTokenContractInfo,
+  retrieveTokenProperties,
+} from '../../../tokens/tokens';
+import { Token } from '../../../tokens/token-addresses';
+import { extractChain, PublicClient } from 'viem';
+import * as chains from 'viem/chains';
+import { IEnvParam } from '../../../common/parameters';
+import { getApiConfig } from '../../../common/api-config';
+import axios from 'axios';
+
+export type GetVaultBtcHolding = {
+  vaultKey?: Vault;
+  rpcUrls?: Record<VedaVaultChain, string>;
+};
+export async function getVaultBtcHolding({
+  vaultKey = Vault.Veda,
+  rpcUrls,
+}: GetVaultBtcHolding) {
+  const vault = VAULTS[vaultKey];
+  if (!vault) {
+    throw new Error(`Unknown vault key: ${vaultKey}`);
+  }
+
+  const clients: Partial<Record<VedaVaultChain, PublicClient>> = {};
+  for (const chainId of vault.chains) {
+    const publicClient = makePublicClient({
+      chainId: chainId,
+      rpcUrl: rpcUrls?.[chainId],
+    });
+    clients[chainId] = publicClient;
+  }
+
+  const balances = [];
+
+  for (const [token, chainIds] of Object.entries(vault.tokens)) {
+    for (const chainId of chainIds) {
+      const tokenContract = getTokenContractInfo(token as Token, chainId);
+      const publicClient = clients[chainId];
+      if (!publicClient) continue;
+
+      const tokenInfo = await retrieveTokenProperties(
+        publicClient,
+        tokenContract,
+      );
+
+      if (!tokenInfo) continue;
+
+      const balanceRaw = await publicClient.readContract({
+        abi: tokenContract.abi,
+        address: tokenContract.address,
+        functionName: 'balanceOf',
+        args: [vault.vaultContract.address],
+      });
+
+      const balance = fromBaseDenomination(
+        balanceRaw ? String(balanceRaw) : 0,
+        tokenInfo.decimals,
+      );
+
+      const ch = extractChain({ chains: Object.values(chains), id: chainId });
+      console.info(`Balance of ${token} on ${ch.name}: ${balance}`);
+
+      balances.push(balance);
+    }
+  }
+
+  return BigNumber.sum.apply(null, balances);
+}
+
+export type GetVaultTVLParameters = {
+  vaultKey?: Vault;
+} & IEnvParam;
+
+type DuneQueryResult = {
+  net_btc_balance: number;
+  price: number;
+  vault_tvl: number;
+};
+
+type Response = {
+  /** The TVL represented in BTC locked in the vault */
+  btcBalance: BigNumber;
+  /** The BTC price in US dollars */
+  btcPrice: BigNumber;
+  /** The TVL represented us US dollars */
+  tvl: BigNumber;
+};
+export async function getVaultTVL({
+  vaultKey = Vault.Veda,
+  env,
+}: GetVaultTVLParameters) {
+  const vault = VAULTS[vaultKey];
+  if (!vault) {
+    throw new Error(`Unknown vault key: ${vaultKey}`);
+  }
+
+  const { bffApiUrl } = getApiConfig(env);
+  if (!bffApiUrl) {
+    throw new Error(
+      `Could not determine API endpoint for provided environment: ${env}`,
+    );
+  }
+
+  const url = `${bffApiUrl}/dune-api/query/vault-tvl`;
+  const { data } = await axios.get<DuneQueryResult>(url);
+
+  const response: Response = {
+    btcBalance: BigNumber(data.net_btc_balance),
+    btcPrice: BigNumber(data.price),
+    tvl: BigNumber(data.vault_tvl),
+  };
+
+  return response;
+}

package/src/vaults/lib/{cancel-withdraw.stories.tsx → ops/cancel-withdraw.stories.tsx}

@@ -1,22 +1,22 @@
 import type { Meta, StoryObj } from '@storybook/react';
-import { Button } from '../../stories/components/Button';
-import { CodeBlock } from '../../stories/components/CodeBlock';
+import { Button } from '../../../stories/components/Button';
+import { CodeBlock } from '../../../stories/components/CodeBlock';
 import {
   canPerformAction,
   useConnection,
-} from '../../stories/hooks/useConnection';
-import useQuery from '../../stories/hooks/useQuery';
-import { ConnectButton } from '../../stories/components/ConnectButton';
+} from '../../../stories/hooks/useConnection';
+import useQuery from '../../../stories/hooks/useQuery';
+import { ConnectButton } from '../../../stories/components/ConnectButton';
 import {
   functionType,
   wagmiDecorator,
-} from '../../stories/components/decorators';
-import { Vault } from '..';
-import { ErrorBlock } from '../../stories/components/error-block';
+} from '../../../stories/components/decorators';
+import { Vault } from '../config';
+import { ErrorBlock } from '../../../stories/components/error-block';
 import { CancelWithdrawParameters, cancelWithdraw } from './withdraw';
 
 const meta = {
-  title: 'vault/cancelWithdraw',
+  title: 'vault/ops/cancelWithdraw',
   component: StoryView,
   tags: ['autodocs'],
   decorators: [wagmiDecorator, functionType('write')],

package/src/vaults/lib/{deposit.stories.tsx → ops/deposit.stories.tsx}

@@ -1,22 +1,22 @@
 import type { Meta, StoryObj } from '@storybook/react';
-import { Button } from '../../stories/components/Button';
-import { CodeBlock } from '../../stories/components/CodeBlock';
+import { Button } from '../../../stories/components/Button';
+import { CodeBlock } from '../../../stories/components/CodeBlock';
 import {
   canPerformAction,
   useConnection,
-} from '../../stories/hooks/useConnection';
-import useQuery from '../../stories/hooks/useQuery';
-import { ConnectButton } from '../../stories/components/ConnectButton';
+} from '../../../stories/hooks/useConnection';
+import useQuery from '../../../stories/hooks/useQuery';
+import { ConnectButton } from '../../../stories/components/ConnectButton';
 import {
   functionType,
   wagmiDecorator,
-} from '../../stories/components/decorators';
+} from '../../../stories/components/decorators';
 import { deposit, DepositParameters } from './deposit';
-import { Vault } from '..';
-import { ErrorBlock } from '../../stories/components/error-block';
+import { Vault } from '../config';
+import { ErrorBlock } from '../../../stories/components/error-block';
 
 const meta = {
-  title: 'vault/deposit',
+  title: 'vault/ops/deposit',
   component: StoryView,
   tags: ['autodocs'],
   decorators: [wagmiDecorator, functionType('write')],

package/src/vaults/lib/{deposit.ts → ops/deposit.ts}

@@ -1,17 +1,17 @@
 import BigNumber from 'bignumber.js';
-import { isVedaVaultChain, Vault, VAULTS } from '..';
-import { CommonWriteParameters } from '../../common/parameters';
-import { makePublicClient } from '../../clients/public-client';
-import { makeWalletClient } from '../../clients/wallet-client';
-import toBigInt from '../../utils/numbers';
-import { CHAIN_ID_TO_VIEM_CHAIN_MAP } from '../../common/chains';
-import { getErrorMessage } from '../../utils/err';
+import { isVedaVaultChain, Vault, VAULTS } from '../config';
+import { CommonWriteParameters } from '../../../common/parameters';
+import { makePublicClient } from '../../../clients/public-client';
+import { makeWalletClient } from '../../../clients/wallet-client';
+import toBigInt from '../../../utils/numbers';
+import { CHAIN_ID_TO_VIEM_CHAIN_MAP } from '../../../common/chains';
+import { getErrorMessage } from '../../../utils/err';
 import {
   fromBaseDenomination,
   getTokenInfo,
   toBaseDenomination,
-  Token,
-} from '../../tokens/tokens';
+} from '../../../tokens/tokens';
+import { Token } from '../../../tokens/token-addresses';
 
 export type DepositParameters = {
   /** The amount to be deposited into the DeFi vault. */
@@ -45,7 +45,7 @@ export type DepositParameters = {
 export async function deposit({
   amount: amountRaw,
   approve = true,
-  token = 'LBTC',
+  token = Token.LBTC,
   vaultKey = Vault.Veda,
   account,
   chainId,

package/src/vaults/lib/{get-vault-deposits.stories.tsx → ops/get-vault-deposits.stories.tsx}

@@ -1,22 +1,22 @@
 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 { 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 '..';
-import { ErrorBlock } from '../../stories/components/error-block';
+} from '../../../stories/components/decorators';
+import { Vault } from '../config';
+import { ErrorBlock } from '../../../stories/components/error-block';
 import {
   getVaultDeposits,
   GetVaultDepositsParameters,
 } from './get-vault-deposits';
-import { EXAMPLE_EVM_ADDRESS } from '../../stories/constants';
-import { ChainId } from '../../common/chains';
+import { EXAMPLE_EVM_ADDRESS } from '../../../stories/constants';
+import { ChainId } from '../../../common/chains';
 
 const meta = {
-  title: 'vault/getVaultDeposits',
+  title: 'vault/ops/getVaultDeposits',
   component: StoryView,
   tags: ['autodocs'],
   decorators: [wagmiDecorator, functionType('api-get')],

package/src/vaults/lib/{get-vault-deposits.ts → ops/get-vault-deposits.ts}

@@ -1,5 +1,5 @@
 import { Address, Hash } from 'viem';
-import { ChainId } from '../../common/chains';
+import { ChainId } from '../../../common/chains';
 import {
   isVedaVaultChain,
   NETWORK_TO_VEDA_VAULT_CHAIN_MAP,
@@ -7,16 +7,16 @@ import {
   VAULTS,
   VEDA_VAULT_CHAIN_TO_NETWORK_MAP,
   VedaVaultChain,
-} from '..';
+} from '../config';
 import axios from 'axios';
 import BigNumber from 'bignumber.js';
 import {
   fromBaseDenomination,
   getAssetInfo,
   TokenInfo,
-} from '../../tokens/tokens';
-import { ensureHex } from '../../utils/hex';
-import { orderBy, unique } from '../../utils/array';
+} from '../../../tokens/tokens';
+import { ensureHex } from '../../../utils/hex';
+import { orderBy, unique } from '../../../utils/array';
 
 const DEPOSITS_URL =
   'https://api.sevenseas.capital/deposits/{network}/{vault}/{account}';

package/src/vaults/lib/{get-vault-withdrawals.stories.tsx → ops/get-vault-withdrawals.stories.tsx}

@@ -1,22 +1,22 @@
 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 { 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 '..';
-import { ErrorBlock } from '../../stories/components/error-block';
-import { EXAMPLE_EVM_ADDRESS } from '../../stories/constants';
-import { ChainId } from '../../common/chains';
+} from '../../../stories/components/decorators';
+import { Vault } from '../config';
+import { ErrorBlock } from '../../../stories/components/error-block';
+import { EXAMPLE_EVM_ADDRESS } from '../../../stories/constants';
+import { ChainId } from '../../../common/chains';
 import {
   getVaultWithdrawals,
   GetVaultWithdrawalsParameters,
 } from './get-vault-withdrawals';
 
 const meta = {
-  title: 'vault/getVaultWithdrawals',
+  title: 'vault/ops/getVaultWithdrawals',
   component: StoryView,
   tags: ['autodocs'],
   decorators: [wagmiDecorator, functionType('api-get')],

package/src/vaults/lib/{get-vault-withdrawals.ts → ops/get-vault-withdrawals.ts}

@@ -4,17 +4,17 @@ import {
   Vault,
   VAULTS,
   VEDA_VAULT_CHAIN_TO_NETWORK_MAP,
-} from '..';
-import { ChainId } from '../../common/chains';
+} from '../config';
+import { ChainId } from '../../../common/chains';
 import {
   fromBaseDenomination,
   getAssetInfo,
   TokenInfo,
-} from '../../tokens/tokens';
+} from '../../../tokens/tokens';
 import BigNumber from 'bignumber.js';
 import axios from 'axios';
-import { orderBy, unique } from '../../utils/array';
-import { ensureHex } from '../../utils/hex';
+import { orderBy, unique } from '../../../utils/array';
+import { ensureHex } from '../../../utils/hex';
 
 export type GetVaultWithdrawalsParameters = {
   account: Address;

package/src/vaults/lib/{withdraw.stories.tsx → ops/withdraw.stories.tsx}

@@ -1,22 +1,22 @@
 import type { Meta, StoryObj } from '@storybook/react';
-import { Button } from '../../stories/components/Button';
-import { CodeBlock } from '../../stories/components/CodeBlock';
+import { Button } from '../../../stories/components/Button';
+import { CodeBlock } from '../../../stories/components/CodeBlock';
 import {
   canPerformAction,
   useConnection,
-} from '../../stories/hooks/useConnection';
-import useQuery from '../../stories/hooks/useQuery';
-import { ConnectButton } from '../../stories/components/ConnectButton';
+} from '../../../stories/hooks/useConnection';
+import useQuery from '../../../stories/hooks/useQuery';
+import { ConnectButton } from '../../../stories/components/ConnectButton';
 import {
   functionType,
   wagmiDecorator,
-} from '../../stories/components/decorators';
-import { Vault } from '..';
-import { ErrorBlock } from '../../stories/components/error-block';
+} from '../../../stories/components/decorators';
+import { Vault } from '../config';
+import { ErrorBlock } from '../../../stories/components/error-block';
 import { queueWithdraw, QueueWithdrawParameters } from './withdraw';
 
 const meta = {
-  title: 'vault/withdraw',
+  title: 'vault/ops/withdraw',
   component: StoryView,
   tags: ['autodocs'],
   decorators: [wagmiDecorator, functionType('write')],

package/src/vaults/lib/{withdraw.ts → ops/withdraw.ts}

@@ -1,18 +1,18 @@
 import BigNumber from 'bignumber.js';
-import { isVedaVaultChain, Vault, VAULTS } from '..';
-import { CommonWriteParameters } from '../../common/parameters';
-import { makePublicClient } from '../../clients/public-client';
-import { makeWalletClient } from '../../clients/wallet-client';
+import { isVedaVaultChain, Vault, VAULTS } from '../config';
+import { CommonWriteParameters } from '../../../common/parameters';
+import { makePublicClient } from '../../../clients/public-client';
+import { makeWalletClient } from '../../../clients/wallet-client';
 import {
   fromBaseDenomination,
   getTokenInfo,
   toBaseDenomination,
-  Token,
-} from '../../tokens/tokens';
-import toBigInt from '../../utils/numbers';
-import { CHAIN_ID_TO_VIEM_CHAIN_MAP } from '../../common/chains';
-import { getErrorMessage } from '../../utils/err';
-import { DAY } from '../../utils/time';
+} from '../../../tokens/tokens';
+import toBigInt from '../../../utils/numbers';
+import { CHAIN_ID_TO_VIEM_CHAIN_MAP } from '../../../common/chains';
+import { getErrorMessage } from '../../../utils/err';
+import { DAY } from '../../../utils/time';
+import { Token } from '../../../tokens/token-addresses';
 
 export type QueueWithdrawParameters = {
   /** The amount to be withdrawn from the DeFi vault. */
@@ -46,7 +46,7 @@ export type QueueWithdrawParameters = {
 export async function queueWithdraw({
   amount: amountRaw,
   approve = true,
-  token = 'LBTC',
+  token = Token.LBTC,
   vaultKey = Vault.Veda,
   account,
   chainId,
@@ -178,7 +178,7 @@ export type CancelWithdrawParameters = Pick<
  * @returns
  */
 export async function cancelWithdraw({
-  token = 'LBTC',
+  token = Token.LBTC,
   vaultKey = Vault.Veda,
   account,
   chainId,