@lombard.finance/sdk 4.0.0 → 4.1.0

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

@@ -1,121 +0,0 @@
-import axios from 'axios';
-import BigNumber from 'bignumber.js';
-import { extractChain, PublicClient } from 'viem';
-import * as chains from 'viem/chains';
-
-import { makePublicClient } from '../../../clients/public-client';
-import { getApiConfig } from '../../../common/api-config';
-import { IEnvParam } from '../../../common/parameters';
-import { Token } from '../../../tokens/token-addresses';
-import {
-  fromBaseDenomination,
-  getTokenContractInfo,
-  retrieveTokenProperties,
-} from '../../../tokens/tokens';
-import { Vault, VAULTS, VedaVaultChain } from '../config';
-
-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 = await 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/ops/cancel-withdraw.stories.tsx

@@ -1,80 +0,0 @@
-import type { Meta, StoryObj } from '@storybook/react';
-
-import { Button } from '../../../stories/components/Button';
-import { CodeBlock } from '../../../stories/components/CodeBlock';
-import { ConnectButton } from '../../../stories/components/ConnectButton';
-import {
-  functionType,
-  wagmiDecorator,
-} from '../../../stories/components/decorators';
-import { ErrorBlock } from '../../../stories/components/error-block';
-import {
-  canPerformAction,
-  useConnection,
-} from '../../../stories/hooks/useConnection';
-import useQuery from '../../../stories/hooks/useQuery';
-import { Vault } from '../config';
-import { cancelWithdraw,CancelWithdrawParameters } from './withdraw';
-
-const meta = {
-  title: 'vault/ops/cancelWithdraw',
-  component: StoryView,
-  tags: ['autodocs'],
-  decorators: [wagmiDecorator, functionType('write')],
-} satisfies Meta<typeof StoryView>;
-
-export default meta;
-
-type Story = StoryObj<typeof meta>;
-
-export const WithParams: Story = {
-  args: {
-    vaultKey: Vault.Veda,
-  },
-};
-
-type SignNetworkFeeProps = Omit<
-  CancelWithdrawParameters,
-  'account' | 'chainId' | 'provider'
->;
-
-export function StoryView(props: SignNetworkFeeProps) {
-  const connection = useConnection();
-
-  const request = async () => {
-    if (!canPerformAction(connection)) {
-      return;
-    }
-
-    return cancelWithdraw({
-      ...props,
-
-      account: connection.account.address,
-      chainId: connection.account.chainId,
-      provider: connection.provider,
-    });
-  };
-
-  const { data, error, isLoading, refetch } = useQuery(request, [], false);
-
-  return (
-    <>
-      <p>This method queues withdraw from the chosen DeFi vault.</p>
-
-      <div className="mb-4">
-        <ConnectButton />
-      </div>
-
-      <Button
-        onClick={refetch}
-        disabled={isLoading || !connection.account.address}
-        isLoading={isLoading}
-        actionName={cancelWithdraw.name}
-      />
-
-      <ErrorBlock>{error}</ErrorBlock>
-
-      <CodeBlock text={data} />
-    </>
-  );
-}

package/src/vaults/lib/ops/deposit.stories.tsx

@@ -1,82 +0,0 @@
-import type { Meta, StoryObj } from '@storybook/react';
-
-import { Button } from '../../../stories/components/Button';
-import { CodeBlock } from '../../../stories/components/CodeBlock';
-import { ConnectButton } from '../../../stories/components/ConnectButton';
-import {
-  functionType,
-  wagmiDecorator,
-} from '../../../stories/components/decorators';
-import { ErrorBlock } from '../../../stories/components/error-block';
-import {
-  canPerformAction,
-  useConnection,
-} from '../../../stories/hooks/useConnection';
-import useQuery from '../../../stories/hooks/useQuery';
-import { Vault } from '../config';
-import { deposit,DepositParameters } from './deposit';
-
-const meta = {
-  title: 'vault/ops/deposit',
-  component: StoryView,
-  tags: ['autodocs'],
-  decorators: [wagmiDecorator, functionType('write')],
-} satisfies Meta<typeof StoryView>;
-
-export default meta;
-
-type Story = StoryObj<typeof meta>;
-
-export const WithParams: Story = {
-  args: {
-    vaultKey: Vault.Veda,
-    amount: '0.0001',
-    approve: true,
-  },
-};
-
-type SignNetworkFeeProps = Omit<
-  DepositParameters,
-  'account' | 'chainId' | 'provider'
->;
-
-export function StoryView(props: SignNetworkFeeProps) {
-  const connection = useConnection();
-
-  const request = async () => {
-    if (!canPerformAction(connection)) {
-      return;
-    }
-
-    return deposit({
-      ...props,
-
-      account: connection.account.address,
-      chainId: connection.account.chainId,
-      provider: connection.provider,
-    });
-  };
-
-  const { data, error, isLoading, refetch } = useQuery(request, [], false);
-
-  return (
-    <>
-      <p>This method deposits funds to the chosen DeFi vault.</p>
-
-      <div className="mb-4">
-        <ConnectButton />
-      </div>
-
-      <Button
-        onClick={refetch}
-        disabled={isLoading || !connection.account.address}
-        isLoading={isLoading}
-        actionName={deposit.name}
-      />
-
-      <ErrorBlock>{error}</ErrorBlock>
-
-      <CodeBlock text={data} />
-    </>
-  );
-}

package/src/vaults/lib/ops/deposit.ts

@@ -1,152 +0,0 @@
-import BigNumber from 'bignumber.js';
-
-import { makePublicClient } from '../../../clients/public-client';
-import { makeWalletClient } from '../../../clients/wallet-client';
-import { CHAIN_ID_TO_VIEM_CHAIN_MAP } from '../../../common/chains';
-import { CommonWriteParameters } from '../../../common/parameters';
-import { Token } from '../../../tokens/token-addresses';
-import {
-  fromBaseDenomination,
-  getTokenInfo,
-  toBaseDenomination,
-} from '../../../tokens/tokens';
-import { getErrorMessage } from '../../../utils/err';
-import toBigInt from '../../../utils/numbers';
-import { isVedaVaultChain, Vault, VAULTS } from '../config';
-
-export type DepositParameters = {
-  /** The amount to be deposited into the DeFi vault. */
-  amount: BigNumber.Value;
-  /**
-   * A flag determining whether the amount should be approved within
-   * the execution of this function. If set to `false` it will
-   * throw an error when the deposit amount exceeds allowance.
-   */
-  approve?: boolean;
-  /** The optional deposit asset. */
-  token?: Token;
-  /** The vault identifier. */
-  vaultKey?: Vault;
-} & CommonWriteParameters;
-
-/**
- * Deposits specified amount to the chosen DeFi vault.
- * @param {DepositParameters} parameters
- * @param {BigNumber.Value} parameters.amount - The deposit amount.
- * @param {boolean} parameters.approve - The optional flag determining whether approve actions should be performed.
- * @param {Token} parameters.token - The optional deposit asset.
- * @param {Vault} parameters.vaultKey - The vault identifier.
- * @param {Address} parameters.account - The EVM account address.
- * @param {ChainId} parameters.chainId - The chain id.
- * @param {EIP1193Provider} parameters.provider - The EIP1193 provider.
- * @param {string} parameters.rpcUrl - The optional rpc url.
- *
- * @returns {Promise<Hash>}
- */
-export async function deposit({
-  amount: amountRaw,
-  approve = true,
-  token = Token.LBTC,
-  vaultKey = Vault.Veda,
-  account,
-  chainId,
-  provider,
-  rpcUrl,
-  env,
-}: DepositParameters) {
-  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 publicClient = makePublicClient({ chainId, rpcUrl });
-  const walletClient = makeWalletClient({ provider, chainId });
-
-  const depositToken = await getTokenInfo(token, chainId, env, rpcUrl);
-  if (!depositToken) {
-    throw new Error(`Unknown deposit token: ${token}`);
-  }
-
-  const amount = BigNumber(amountRaw);
-  const amountBase = toBigInt(
-    toBaseDenomination(amount, depositToken.decimals),
-  );
-
-  const allowanceRaw = await publicClient.readContract({
-    address: depositToken.address,
-    abi: depositToken.abi,
-    functionName: 'allowance',
-    args: [account, vault.vaultContract.address],
-  });
-  const allowance = fromBaseDenomination(
-    String(allowanceRaw),
-    depositToken.decimals,
-  );
-
-  const balanceRaw = await publicClient.readContract({
-    address: depositToken.address,
-    abi: depositToken.abi,
-    functionName: 'balanceOf',
-    args: [account],
-  });
-  const balance = fromBaseDenomination(
-    String(balanceRaw),
-    depositToken.decimals,
-  );
-
-  // check if amount exceeds balance
-  if (amount.isGreaterThan(balance)) {
-    throw new Error(
-      `The deposit amount exceeds the account's balance. \nDeposit amount: ${amount.toFixed()} \nBalance: ${balance.toFixed()}`,
-    );
-  }
-
-  // check if amount exceeds allowance
-  if (amount.isGreaterThan(allowance)) {
-    const exceededMessage = `The deposit amount exceeds allowance. \nDeposit amount: ${amount.toFixed()} \nAllowance: ${allowance.toFixed()}`;
-    if (!approve) {
-      throw new Error(exceededMessage);
-    }
-
-    // try to approve new amount
-    console.info(exceededMessage);
-    try {
-      console.info(`Trying to approve ${amountBase}`);
-      const { request } = await publicClient.simulateContract({
-        account,
-        chain: CHAIN_ID_TO_VIEM_CHAIN_MAP[chainId],
-        address: depositToken.address,
-        abi: depositToken.abi,
-        functionName: 'approve',
-        args: [vault.vaultContract.address, amountBase],
-      });
-
-      const txHash = await walletClient.writeContract(request);
-      console.info(`Approve tx hash: ${txHash}`);
-      console.info(`Approved ${amountBase} for ${vault.vaultContract.address}`);
-    } catch (err) {
-      const msg = getErrorMessage(err);
-      throw new Error(
-        `Could not approve ${amountBase} for ${vault.vaultContract.address}. \nReason: ${msg}`,
-      );
-    }
-  }
-
-  // deposit funds via the teller contract
-  const { request } = await publicClient.simulateContract({
-    account,
-    chain: CHAIN_ID_TO_VIEM_CHAIN_MAP[chainId],
-    address: vault.tellerContracts[chainId].address,
-    abi: vault.tellerContracts[chainId].abi,
-    functionName: 'deposit',
-    args: [depositToken.address, amountBase, 0n],
-  });
-  const txHash = await walletClient.writeContract(request);
-  return txHash;
-}

package/src/vaults/lib/ops/get-vault-deposits.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,
-  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 {
-  getVaultDeposits,
-  GetVaultDepositsParameters,
-} from './get-vault-deposits';
-
-const meta = {
-  title: 'vault/ops/getVaultDeposits',
-  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,
-    chainId: ChainId.ethereum,
-    vaultKey: Vault.Veda,
-  },
-};
-
-type SignNetworkFeeProps = GetVaultDepositsParameters;
-
-export function StoryView(props: SignNetworkFeeProps) {
-  const request = async () => {
-    return getVaultDeposits({
-      ...props,
-    });
-  };
-
-  const { data, error, isLoading, refetch } = useQuery(request, [], false);
-
-  return (
-    <>
-      <p>This function gets the deposits made by a user to the DeFi vault.</p>
-
-      <Button
-        onClick={refetch}
-        disabled={isLoading}
-        isLoading={isLoading}
-        actionName={getVaultDeposits.name}
-      />
-
-      <ErrorBlock>{error}</ErrorBlock>
-
-      <CodeBlock text={data} />
-    </>
-  );
-}

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

@@ -1,209 +0,0 @@
-import axios from 'axios';
-import BigNumber from 'bignumber.js';
-import { Address, Hash } from 'viem';
-
-import { getApiConfig } from '../../../common/api-config';
-import { ChainId } from '../../../common/chains';
-import { IEnvParam } from '../../../common/parameters';
-import {
-  fromBaseDenomination,
-  getAssetInfo,
-  TokenInfo,
-} from '../../../tokens/tokens';
-import { orderBy, unique } from '../../../utils/array';
-import { ensureHex } from '../../../utils/hex';
-import {
-  isVedaVaultChain,
-  NETWORK_TO_VEDA_VAULT_CHAIN_MAP,
-  Vault,
-  VAULTS,
-  VEDA_VAULT_CHAIN_TO_NETWORK_MAP,
-  VedaVaultChain,
-} from '../config';
-
-type SevenSeasDepositEntry = {
-  block_number: number;
-  chain: string;
-  deposit_amount: number;
-  deposit_asset: string;
-  share_amount: number;
-  tx_hash: string;
-  user: string;
-  vault_address: string;
-};
-
-type SevenSeasDepositsPayload =
-  | SevenSeasDepositEntry
-  | SevenSeasDepositEntry[]
-  | { Response: SevenSeasDepositEntry }
-  | { Response: SevenSeasDepositEntry[] };
-
-const normalizeSevenSeasDeposits = (
-  payload: SevenSeasDepositsPayload | undefined,
-): SevenSeasDepositEntry[] => {
-  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 GetVaultDepositsParameters = IEnvParam & {
-  account: Address;
-  chainId: ChainId;
-  vaultKey?: Vault;
-  rpcUrl?: string;
-};
-
-export type VaultDeposit = {
-  /** The transaction hash */
-  txHash: Hash;
-  /** The transaction's block number */
-  blockNumber: number;
-  /** The chain id */
-  chainId: VedaVaultChain;
-  /** The deposited amount */
-  amount: BigNumber;
-  /** The amount of shares received */
-  shareAmount: BigNumber;
-  /** The deposit token */
-  token?: Omit<TokenInfo, 'abi'>;
-  /** The user wallet address that made the deposit */
-  toAddress: Address;
-};
-
-/**
- * Retrieves the deposits made by specified address.
- * @param parameters - The parameters.
- * @param parameters.account - The account address.
- * @param parameters.chainId - The chain id.
- * @param parameters.vaultKey - The optional vault identifier.
- * @param parameters.rpcUrl - The optional RPC url.
- *
- * @returns {Promise<VaultDeposit[]>}
- */
-export async function getVaultDeposits({
-  account,
-  chainId,
-  vaultKey = Vault.Veda,
-  rpcUrl,
-  env,
-}: GetVaultDepositsParameters) {
-  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 = VEDA_VAULT_CHAIN_TO_NETWORK_MAP[chainId];
-  const { bffApiUrl } = getApiConfig(env);
-  if (!bffApiUrl) {
-    throw new Error(
-      `Could not determine API endpoint for provided environment: ${env}`,
-    );
-  }
-  const url = `${bffApiUrl}/sevenseas-api/deposits/${network}/${vault.vaultContract.address}/${account}`;
-
-  const { data } = await axios.get<SevenSeasDepositsPayload>(url);
-  const entries = normalizeSevenSeasDeposits(data);
-
-  const depositAssetsAddresses = unique(
-    entries.map(d => ensureHex(d.deposit_asset)),
-  );
-
-  const depositAssets: Record<Address, Omit<TokenInfo, 'abi'> | undefined> = {};
-  for (const asset of depositAssetsAddresses) {
-    const assetInfo = await getAssetInfo(asset, chainId, rpcUrl);
-    if (assetInfo) {
-      depositAssets[asset] = {
-        address: assetInfo.address,
-        decimals: assetInfo.decimals,
-        symbol: assetInfo.symbol,
-      };
-    } else {
-      depositAssets[asset] = undefined;
-    }
-  }
-
-  const deposits = entries.map(d => {
-    const token = depositAssets[ensureHex(d.deposit_asset)];
-    const amount = fromBaseDenomination(d.deposit_amount, token?.decimals || 0);
-    const shareAmount = fromBaseDenomination(d.share_amount, vault.decimals);
-
-    const vaultDeposit: VaultDeposit = {
-      txHash: ensureHex(d.tx_hash),
-      blockNumber: d.block_number,
-      chainId: NETWORK_TO_VEDA_VAULT_CHAIN_MAP[d.chain],
-      amount,
-      shareAmount,
-      token,
-      toAddress: ensureHex(d.user),
-    };
-
-    return vaultDeposit;
-  });
-
-  return orderBy(deposits, d => d.blockNumber, 'desc');
-}
-
-export type GetVaultDepositsAllChainsParameters = {
-  account: Address;
-  vaultKey?: Vault;
-  rpcUrl?: string;
-};
-
-/**
- * Retrieves the deposits made by specified address across all supported chains for a vault.
- * This is useful for getting a complete view of all deposits regardless of the currently connected chain.
- *
- * @param parameters - The parameters.
- * @param parameters.account - The account address.
- * @param parameters.vaultKey - The optional vault identifier (defaults to Veda).
- * @param parameters.rpcUrl - The optional RPC url.
- *
- * @returns {Promise<VaultDeposit[]>} All deposits across all supported chains, sorted by block number (newest first)
- */
-export async function getVaultDepositsAllChains({
-  account,
-  vaultKey = Vault.Veda,
-  rpcUrl,
-}: GetVaultDepositsAllChainsParameters): Promise<VaultDeposit[]> {
-  const vault = VAULTS[vaultKey];
-  if (!vault) {
-    throw new Error(`Unknown vault key: ${vaultKey}`);
-  }
-
-  // Fetch deposits from all supported chains in parallel
-  const depositsPromises = vault.chains.map(chainId =>
-    getVaultDeposits({ account, chainId, vaultKey, rpcUrl }).catch(error => {
-      console.error(`Failed to fetch deposits for chain ${chainId}:`, error);
-      return []; // Return empty array on error to not break the entire query
-    }),
-  );
-
-  const depositsArrays = await Promise.all(depositsPromises);
-
-  // Flatten and sort all deposits by block number (newest first)
-  const allDeposits = depositsArrays.flat();
-  return orderBy(allDeposits, d => d.blockNumber, 'desc');
-}