@lombard.finance/sdk 4.0.0 → 4.1.2

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

@@ -1,225 +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 { DAY } from '../../../utils/time';
-import { isVedaVaultChain, Vault, VAULTS } from '../config';
-
-export type QueueWithdrawParameters = {
-  /** The amount to be withdrawn from 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 withdraw amount exceeds allowance.
-   */
-  approve?: boolean;
-  /** The optional deposit asset. */
-  token?: Token;
-  /** The vault identifier. */
-  vaultKey?: Vault;
-} & CommonWriteParameters;
-
-/**
- * Queues withdrawal from the DeFi vault.
- * @param {QueueWithdrawParameters} parameters - The 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 queueWithdraw({
-  amount: amountRaw,
-  approve = true,
-  token = Token.LBTC,
-  vaultKey = Vault.Veda,
-  account,
-  chainId,
-  provider,
-  rpcUrl,
-  env,
-}: QueueWithdrawParameters) {
-  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 withdrawToken = await getTokenInfo(token, chainId, env, rpcUrl);
-  if (!withdrawToken) {
-    throw new Error(`Unknown withdraw token: ${token}`);
-  }
-
-  const amount = BigNumber(amountRaw);
-  const amountBase = toBigInt(toBaseDenomination(amount, vault.decimals));
-
-  const balanceRaw = await publicClient.readContract({
-    address: vault.lensContract.address,
-    abi: vault.lensContract.abi,
-    functionName: 'balanceOf',
-    args: [account, vault.vaultContract.address],
-  });
-  const balance = fromBaseDenomination(String(balanceRaw), vault.decimals);
-
-  const allowanceRaw = await publicClient.readContract({
-    address: vault.vaultContract.address,
-    abi: vault.vaultContract.abi,
-    functionName: 'allowance',
-    args: [account, vault.withdrawQueueContracts[chainId].address],
-  });
-  const allowance = fromBaseDenomination(String(allowanceRaw), vault.decimals);
-
-  // check if amount exceeds balance
-  if (amount.isGreaterThan(balance)) {
-    throw new Error(
-      `The withdraw amount exceeds the account's balance. \nWithdraw amount: ${amount.toFixed()} \nBalance: ${balance.toFixed()}`,
-    );
-  }
-
-  // check if amount exceeds allowance
-  if (amount.isGreaterThan(allowance)) {
-    const exceededMessage = `The withdraw amount exceeds allowance. \nWithdraw amount: ${amount.toFixed()} \nAllowance: ${allowance.toFixed()}`;
-    if (!approve) {
-      throw new Error(exceededMessage);
-    }
-
-    // try to approve new amount
-    try {
-      console.info(`Trying to approve ${amountBase}`);
-      const { request } = await publicClient.simulateContract({
-        account,
-        chain: CHAIN_ID_TO_VIEM_CHAIN_MAP[chainId],
-        address: vault.vaultContract.address,
-        abi: vault.vaultContract.abi,
-        functionName: 'approve',
-        args: [vault.withdrawQueueContracts[chainId].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}`,
-      );
-    }
-  }
-
-  // queue withdraw vault token to wihdraw token via the withdraw queue contract
-  const expiry = BigNumber(Date.now())
-    .dividedBy(1000)
-    .plus(BigNumber(vault.queueWithdrawDaysValid).multipliedBy(DAY / 1000))
-    .decimalPlaces(0, BigNumber.ROUND_DOWN); // expiry = now(seconds) + days(seconds)
-
-  const discount = BigNumber(vault.queueWithdrawDiscountPercent).multipliedBy(
-    10000, // 1% = 10000
-  );
-
-  const { request } = await publicClient.simulateContract({
-    account,
-    chain: CHAIN_ID_TO_VIEM_CHAIN_MAP[chainId],
-    address: vault.withdrawQueueContracts[chainId].address,
-    abi: vault.withdrawQueueContracts[chainId].abi,
-    functionName: 'safeUpdateAtomicRequest',
-    args: [
-      vault.vaultContract.address,
-      withdrawToken.address,
-      [expiry.toFixed(0), 0n, amountBase, false],
-      vault.accountantContract.address,
-      discount.toFixed(0),
-    ],
-  });
-
-  const txHash = await walletClient.writeContract(request);
-  return txHash;
-}
-
-export type CancelWithdrawParameters = Pick<
-  QueueWithdrawParameters,
-  'token' | 'vaultKey'
-> &
-  CommonWriteParameters;
-
-/**
- * Cancels queued withdrawal.
- * @param {CancelWithdrawParameters} parameters - The parameters.
- * @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>}
- * @returns
- */
-export async function cancelWithdraw({
-  token = Token.LBTC,
-  vaultKey = Vault.Veda,
-  account,
-  chainId,
-  provider,
-  rpcUrl,
-  env,
-}: CancelWithdrawParameters) {
-  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 withdrawToken = await getTokenInfo(token, chainId, env, rpcUrl);
-  if (!withdrawToken) {
-    throw new Error(`Unknown withdraw token: ${token}`);
-  }
-
-  // cancel withdrawal via withdraw queue contract
-  const { request } = await publicClient.simulateContract({
-    account,
-    chain: CHAIN_ID_TO_VIEM_CHAIN_MAP[chainId],
-    address: vault.withdrawQueueContracts[chainId].address,
-    abi: vault.withdrawQueueContracts[chainId].abi,
-    functionName: 'updateAtomicRequest',
-    args: [
-      vault.vaultContract.address,
-      withdrawToken.address,
-      [0, 0, 0, false],
-    ],
-  });
-
-  const txHash = await walletClient.writeContract(request);
-  return txHash;
-}

package/src/version.ts

@@ -1,56 +0,0 @@
-/**
- * SDK Version and Metadata
- *
- * Provides SDK version information for:
- * - HTTP request headers (X-SDK-Version)
- * - Error context for debugging
- * - User-agent identification
- *
- * The SDK_VERSION is injected at build time by Vite's `define` config.
- * In development/tests, it falls back to 'development'.
- *
- * @module version
- */
-
-/**
- * SDK version string
- *
- * Injected at build time from package.json via Vite define.
- * Format: semver (e.g., "3.7.4")
- *
- * @example
- * ```typescript
- * import { SDK_VERSION } from '@lombard.finance/sdk';
- * console.log(`Using Lombard SDK v${SDK_VERSION}`);
- * ```
- */
-declare const __SDK_VERSION__: string;
-export const SDK_VERSION: string =
-  typeof __SDK_VERSION__ !== 'undefined' ? __SDK_VERSION__ : 'development';
-
-/**
- * SDK package name
- *
- * The npm package name for the SDK.
- */
-export const SDK_NAME = '@lombard.finance/sdk';
-
-/**
- * SDK runtime environment
- *
- * Detects whether running in browser, Node.js, or unknown environment.
- */
-export const SDK_RUNTIME: 'browser' | 'node' | 'unknown' = (() => {
-  if (typeof window !== 'undefined' && typeof window.document !== 'undefined') {
-    return 'browser';
-  }
-  if (
-    typeof process !== 'undefined' &&
-    process.versions &&
-    process.versions.node
-  ) {
-    return 'node';
-  }
-  return 'unknown';
-})();
-

package/src/vite-env.d.ts

@@ -1 +0,0 @@
-/// <reference types="vite/client" />