@lombard.finance/sdk 2.5.2 → 3.1.0

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

@@ -1,3 +1,5 @@
+import { Address, Hash } from 'viem';
+import { ChainId } from '../../common/chains';
 import {
   isVedaVaultChain,
   NETWORK_TO_VEDA_VAULT_CHAIN_MAP,
@@ -5,24 +7,25 @@ import {
   VAULTS,
   VEDA_VAULT_CHAIN_TO_NETWORK_MAP,
   VedaVaultChain,
-} from "..";
-import axios from "axios";
-import BigNumber from "bignumber.js";
-import { ensureHex } from "../../utils/hex";
-import { orderBy } from "../../utils/array";
-import { TChainId } from "../../common/types/types";
-import { fromSatoshi } from "../../common/utils/convertSatoshi";
-
-type Address = `0x${string}`;
-type Hash = `0x${string}`;
+} from '..';
+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';
 
 const DEPOSITS_URL =
-  "https://api.sevenseas.capital/deposits/{network}/{vault}/{account}";
+  'https://api.sevenseas.capital/deposits/{network}/{vault}/{account}';
 
 export type GetVaultDepositsParameters = {
   account: Address;
-  chainId: TChainId;
+  chainId: ChainId;
   vaultKey?: Vault;
+  rpcUrl?: string;
 };
 
 type ResponseEntry = {
@@ -48,7 +51,7 @@ export type VaultDeposit = {
   /** The amount of shares received */
   shareAmount: BigNumber;
   /** The deposit token */
-  token?: string;
+  token?: Omit<TokenInfo, 'abi'>;
 };
 
 /**
@@ -57,6 +60,7 @@ export type VaultDeposit = {
  * @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[]>}
  */
@@ -64,6 +68,7 @@ export async function getVaultDeposits({
   account,
   chainId,
   vaultKey = Vault.Veda,
+  rpcUrl,
 }: GetVaultDepositsParameters) {
   const vault = VAULTS[vaultKey];
   if (!vault) {
@@ -72,21 +77,39 @@ export async function getVaultDeposits({
 
   if (!isVedaVaultChain(chainId)) {
     throw new Error(
-      `Unsupported chain id: ${chainId}. Please switch to one of the supported chains: ${vault.chains.join(", ")}`
+      `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 url = DEPOSITS_URL.replace("{network}", network)
-    .replace("{vault}", vault.vaultContract.address)
-    .replace("{account}", account);
+  const url = DEPOSITS_URL.replace('{network}', network)
+    .replace('{vault}', vault.vaultContract.address)
+    .replace('{account}', account);
 
   const { data } = await axios.get<ResponseEntry[]>(url);
 
-  const deposits = data.map((d) => {
-    const token = ensureHex(d.deposit_asset);
-    const amount = fromSatoshi(d.deposit_amount);
-    const shareAmount = fromSatoshi(d.share_amount);
+  const depositAssetsAddresses = unique(
+    data.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 = data.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),
@@ -100,5 +123,5 @@ export async function getVaultDeposits({
     return vaultDeposit;
   });
 
-  return orderBy(deposits, (d) => d.blockNumber, "desc");
+  return orderBy(deposits, d => d.blockNumber, 'desc');
 }

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

@@ -2,14 +2,20 @@ 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 '..';
+import { ErrorBlock } from '../../stories/components/error-block';
+import { EXAMPLE_EVM_ADDRESS } from '../../stories/constants';
 import { getVaultPoints, GetVaultPointsParameters } from './get-vault-points';
-import { exampleEvmAddress } from '../../stories/const';
 
 const meta = {
   title: 'vault/getVaultPoints',
   component: StoryView,
   tags: ['autodocs'],
+  decorators: [wagmiDecorator, functionType('api-get')],
 } satisfies Meta<typeof StoryView>;
 
 export default meta;
@@ -18,7 +24,7 @@ type Story = StoryObj<typeof meta>;
 
 export const WithParams: Story = {
   args: {
-    account: exampleEvmAddress,
+    account: EXAMPLE_EVM_ADDRESS,
     vaultKey: Vault.Veda,
   },
 };
@@ -42,11 +48,12 @@ export function StoryView(props: SignNetworkFeeProps) {
         onClick={refetch}
         disabled={isLoading}
         isLoading={isLoading}
-      >
-        {getVaultPoints.name}
-      </Button>
+        actionName={getVaultPoints.name}
+      />
 
-      <CodeBlock text={error || data} />
+      <ErrorBlock>{error}</ErrorBlock>
+
+      <CodeBlock text={data} />
     </>
   );
 }

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

@@ -1,14 +1,15 @@
-import { Vault, VAULTS } from "..";
-import axios from "axios";
-
-type Address = `0x${string}`;
+import { Address } from 'viem';
+import { Vault, VAULTS } from '..';
+import axios from 'axios';
 
 export type GetVaultPointsParameters = {
+  /** The account address. */
   account: Address;
+  /** The optional vault identifier */
   vaultKey?: Vault;
 };
 
-const POINTS_URL = "https://api.veda.tech/points/user/{account}";
+const POINTS_URL = 'https://api.veda.tech/points/user/{account}';
 
 type Response = {
   Response: {
@@ -25,6 +26,9 @@ type Response = {
   };
 };
 
+/**
+ * Gets the points earned by specified account in the DeFi vault.
+ */
 export async function getVaultPoints({
   account,
   vaultKey = Vault.Veda,
@@ -34,21 +38,21 @@ export async function getVaultPoints({
     throw new Error(`Unknown vault key: ${vaultKey}`);
   }
 
-  const url = POINTS_URL.replace("{account}", account);
+  const url = POINTS_URL.replace('{account}', account);
   const { data } = await axios.get<Response>(url, {
     headers: {
-      "Access-Control-Allow-Origin": "*",
-      "Content-Type": "application/json",
+      '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;
+    if (network === 'userTotalVedaPointsSum') continue;
 
     const vaultPoints = Object.entries(points.vaults).find(
-      ([v]) => v === vault.vaultContract.address
+      ([v]) => v === vault.vaultContract.address,
     );
     if (vaultPoints) {
       const [, data] = vaultPoints;

package/src/vaults/lib/get-vault-withdrawals.stories.tsx

@@ -2,18 +2,24 @@ 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 '..';
+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';
-import { exampleEvmAddress } from '../../stories/const';
-import { OChainId } from '../../common/types/types';
 
 const meta = {
   title: 'vault/getVaultWithdrawals',
   component: StoryView,
   tags: ['autodocs'],
+  decorators: [wagmiDecorator, functionType('api-get')],
 } satisfies Meta<typeof StoryView>;
 
 export default meta;
@@ -22,8 +28,8 @@ type Story = StoryObj<typeof meta>;
 
 export const WithParams: Story = {
   args: {
-    account: exampleEvmAddress,
-    chainId: OChainId.ethereum,
+    account: EXAMPLE_EVM_ADDRESS,
+    chainId: ChainId.ethereum,
     vaultKey: Vault.Veda,
   },
 };
@@ -49,11 +55,12 @@ export function StoryView(props: SignNetworkFeeProps) {
         onClick={refetch}
         disabled={isLoading}
         isLoading={isLoading}
-      >
-        {getVaultWithdrawals.name}
-      </Button>
+        actionName={getVaultWithdrawals.name}
+      />
+
+      <ErrorBlock>{error}</ErrorBlock>
 
-      <CodeBlock text={error || data} />
+      <CodeBlock text={data} />
     </>
   );
 }

package/src/vaults/lib/get-vault-withdrawals.ts

@@ -1,28 +1,30 @@
+import { Address, Hash } from 'viem';
 import {
   isVedaVaultChain,
   Vault,
   VAULTS,
   VEDA_VAULT_CHAIN_TO_NETWORK_MAP,
-} from "..";
-
-import BigNumber from "bignumber.js";
-import axios from "axios";
-import { orderBy } from "../../utils/array";
-import { ensureHex } from "../../utils/hex";
-import { TChainId } from "../../common/types/types";
-import { fromSatoshi } from "../../common/utils/convertSatoshi";
-
-type Address = `0x${string}`;
-type Hash = `0x${string}`;
+} from '..';
+import { ChainId } from '../../common/chains';
+import {
+  fromBaseDenomination,
+  getAssetInfo,
+  TokenInfo,
+} from '../../tokens/tokens';
+import BigNumber from 'bignumber.js';
+import axios from 'axios';
+import { orderBy, unique } from '../../utils/array';
+import { ensureHex } from '../../utils/hex';
 
 export type GetVaultWithdrawalsParameters = {
   account: Address;
-  chainId: TChainId;
+  chainId: ChainId;
   vaultKey?: Vault;
+  rpcUrl?: string;
 };
 
 export type VaultWithdrawal = {
-  token?: string;
+  token?: Omit<TokenInfo, 'abi'>;
   /** The amount of shares withdrawn */
   shareAmount: BigNumber;
   /** The amount of funds withdrawn */
@@ -85,7 +87,7 @@ type Response = {
 };
 
 const WITHDRAWALS_URL =
-  "https://api.sevenseas.capital/withdrawRequests/{network}/{vault}/{account}?historical=true";
+  'https://api.sevenseas.capital/withdrawRequests/{network}/{vault}/{account}?historical=true';
 
 /**
  * Retrieves the withdrawals made by specified address.
@@ -93,6 +95,7 @@ const WITHDRAWALS_URL =
  * @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<VaultWithdrawals>}
  */
@@ -100,6 +103,7 @@ export async function getVaultWithdrawals({
   account,
   chainId,
   vaultKey = Vault.Veda,
+  rpcUrl,
 }: GetVaultWithdrawalsParameters) {
   const vault = VAULTS[vaultKey];
   if (!vault) {
@@ -108,84 +112,114 @@ export async function getVaultWithdrawals({
 
   if (!isVedaVaultChain(chainId)) {
     throw new Error(
-      `Unsupported chain id: ${chainId}. Please switch to one of the supported chains: ${vault.chains.join(", ")}`
+      `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 url = WITHDRAWALS_URL.replace("{network}", network)
-    .replace("{vault}", vault.vaultContract.address)
-    .replace("{account}", account);
+  const url = WITHDRAWALS_URL.replace('{network}', network)
+    .replace('{vault}', vault.vaultContract.address)
+    .replace('{account}', account);
 
   const { data } = await axios.get<Response>(url);
 
-  const cancelled = data.Response.cancelled_requests.map((w) => {
-    const token = ensureHex(w.wantToken);
+  const withdrawAssetsAddresses = unique([
+    ...data.Response.cancelled_requests.map(a => ensureHex(a.wantToken)),
+    ...data.Response.expired_requests.map(a => ensureHex(a.wantToken)),
+    ...data.Response.fulfilled_requests.map(a =>
+      ensureHex(a.Request.wantToken),
+    ),
+    ...data.Response.open_requests.map(a => ensureHex(a.wantToken)),
+  ]);
+
+  const withdrawAssets: Record<Address, Omit<TokenInfo, 'abi'> | undefined> =
+    {};
+  for (const asset of withdrawAssetsAddresses) {
+    const assetInfo = await getAssetInfo(asset, chainId, rpcUrl);
+    if (assetInfo) {
+      withdrawAssets[asset] = {
+        address: assetInfo.address,
+        decimals: assetInfo.decimals,
+        symbol: assetInfo.symbol,
+      };
+    } else {
+      withdrawAssets[asset] = undefined;
+    }
+  }
+
+  const cancelled = data.Response.cancelled_requests.map(w => {
+    const token = withdrawAssets[ensureHex(w.wantToken)];
     const withdrawal: VaultWithdrawal = {
       amount: undefined,
       blockNumber: w.blockNumber,
       deadline: w.deadline,
-      shareAmount: fromSatoshi(w.amount),
+      shareAmount: fromBaseDenomination(w.amount, vault.decimals),
       timestamp: w.timestamp,
       txHash: ensureHex(w.transactionHash),
       token,
     };
     return withdrawal;
   });
-  const expired = data.Response.expired_requests.map((w) => {
-    const token = ensureHex(w.wantToken);
+  const expired = data.Response.expired_requests.map(w => {
+    const token = withdrawAssets[ensureHex(w.wantToken)];
     const withdrawal: VaultWithdrawal = {
       amount: undefined,
       blockNumber: w.blockNumber,
       deadline: w.deadline,
-      shareAmount: fromSatoshi(w.amount),
+      shareAmount: fromBaseDenomination(w.amount, vault.decimals),
       timestamp: w.timestamp,
       txHash: ensureHex(w.transactionHash),
       token,
     };
     return withdrawal;
   });
-  const fulfilled = data.Response.fulfilled_requests.map((w) => {
-    const token = ensureHex(w.Request.wantToken);
+  const fulfilled = data.Response.fulfilled_requests.map(w => {
+    const token = withdrawAssets[ensureHex(w.Request.wantToken)];
     const withdrawal: VaultWithdrawal = {
-      amount: fromSatoshi(w.Fulfillment.wantAmountReceived),
+      amount: fromBaseDenomination(
+        w.Fulfillment.wantAmountReceived,
+        token?.decimals || 0,
+      ),
       blockNumber: w.Request.blockNumber,
       deadline: w.Request.deadline,
-      shareAmount: fromSatoshi(w.Fulfillment.offerAmountSpent),
+      shareAmount: fromBaseDenomination(
+        w.Fulfillment.offerAmountSpent,
+        vault.decimals,
+      ),
       timestamp: w.Request.timestamp,
       txHash: ensureHex(w.Request.transactionHash),
       token,
       fulfilledBlockNumber: w.Fulfillment.blockNumber,
       fulfilledTimestamp: w.Fulfillment.timestamp,
       fulfilledTxHash: ensureHex(w.Fulfillment.transactionHash),
-      minPrice: fromSatoshi(w.Request.minPrice),
+      minPrice: fromBaseDenomination(w.Request.minPrice, token?.decimals || 0),
     };
     return withdrawal;
   });
-  const open = data.Response.open_requests.map((w) => {
-    const token = ensureHex(w.wantToken);
+  const open = data.Response.open_requests.map(w => {
+    const token = withdrawAssets[ensureHex(w.wantToken)];
     const withdrawal: VaultWithdrawal = {
       amount: undefined,
       blockNumber: w.blockNumber,
       deadline: w.deadline,
-      shareAmount: fromSatoshi(w.amount),
+      shareAmount: fromBaseDenomination(w.amount, vault.decimals),
       timestamp: w.timestamp,
       txHash: ensureHex(w.transactionHash),
       token,
-      minPrice: fromSatoshi(w.minPrice),
+      minPrice: fromBaseDenomination(w.minPrice, token?.decimals || 0),
     };
     return withdrawal;
   });
 
   const wihdrawals: VaultWithdrawals = {
-    cancelled: orderBy(cancelled, (a) => a.timestamp, "desc"),
-    expired: orderBy(expired, (a) => a.timestamp, "desc"),
+    cancelled: orderBy(cancelled, a => a.timestamp, 'desc'),
+    expired: orderBy(expired, a => a.timestamp, 'desc'),
     fulfilled: orderBy(
       fulfilled,
-      (a) => a.fulfilledTimestamp || a.timestamp,
-      "desc"
+      a => a.fulfilledTimestamp || a.timestamp,
+      'desc',
     ),
-    open: orderBy(open, (a) => a.timestamp, "desc"),
+    open: orderBy(open, a => a.timestamp, 'desc'),
   };
 
   return wihdrawals;

package/src/vaults/lib/withdraw.stories.tsx

@@ -0,0 +1,81 @@
+import type { Meta, StoryObj } from '@storybook/react';
+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';
+import {
+  functionType,
+  wagmiDecorator,
+} from '../../stories/components/decorators';
+import { Vault } from '..';
+import { ErrorBlock } from '../../stories/components/error-block';
+import { queueWithdraw, QueueWithdrawParameters } from './withdraw';
+
+const meta = {
+  title: 'vault/withdraw',
+  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<
+  QueueWithdrawParameters,
+  'account' | 'chainId' | 'provider'
+>;
+
+export function StoryView(props: SignNetworkFeeProps) {
+  const connection = useConnection();
+
+  const request = async () => {
+    if (!canPerformAction(connection)) {
+      return;
+    }
+
+    return queueWithdraw({
+      ...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={queueWithdraw.name}
+      />
+
+      <ErrorBlock>{error}</ErrorBlock>
+
+      <CodeBlock text={data} />
+    </>
+  );
+}