haedal-vault-sdk 1.0.2 → 1.1.0

package/dist/index.d.ts

@@ -1,8 +1,8 @@
-import { CoinBalance } from '@mysten/sui/client';
+import { CoinBalance, SuiObjectResponse } from '@mysten/sui/client';
 import { AggregatorClient } from '@cetusprotocol/aggregator-sdk';
-import { PaginationArgs, DataPage, SuiAddressType, FullClient, CoinAsset, SuiResource } from '@cetusprotocol/common-sdk';
+import { PaginationArgs, DataPage, CoinPairType, IModule as IModule$1, Package, SuiAddressType, FullClient, CoinAsset, SuiResource } from '@cetusprotocol/common-sdk';
 import { Pool as Pool$1, CetusClmmSDK } from '@cetusprotocol/sui-clmm-sdk';
-import { Transaction, TransactionObjectArgument } from '@mysten/sui/transactions';
+import { TransactionObjectArgument, Transaction } from '@mysten/sui/transactions';
 import * as _pythnetwork_price_service_sdk from '@pythnetwork/price-service-sdk';
 import { SuiPriceServiceConnection, SuiPythClient } from '@pythnetwork/pyth-sui-js';
 import BN from 'bn.js';
@@ -150,6 +150,10 @@ type WithdrawOptions = {
     mode: WithdrawMode;
     slippage?: number;
     partner?: string;
+    extra_burn?: {
+        lp_burn_coin: TransactionObjectArgument;
+        burn_lp_amount: string;
+    };
 };
 type WithdrawMode = 'FixedOneSide' | 'OnlyCoinA' | 'OnlyCoinB';
 type WithdrawCalculationOptions = {
@@ -500,8 +504,120 @@ declare class PythPriceModule implements IModule {
     getFeedInfo(coinType: string, forceRefresh: boolean): Promise<FeedInfo>;
 }
 
+type VestConfigs = {
+    versioned_id: string;
+    create_event_list: VestCreateEvent[];
+};
+type GlobalVestingPeriod = {
+    period: number;
+    release_time: string;
+    cetus_amount: string;
+    redeemed_amount: string;
+};
+type VaultsVestInfo = {
+    id: string;
+    vault_id: string;
+    index: number;
+    lp_coin_type: string;
+    position: VaultsPosition;
+    balance: string;
+    total_supply: string;
+    impaired_a: string;
+    impaired_b: string;
+    cetus_amount: string;
+    redeemed_amount: string;
+    allocated_lp_amount: string;
+    start_time: string;
+    global_vesting_periods: GlobalVestingPeriod[];
+    vest_infos: {
+        id: string;
+        size: string;
+    };
+    url: string;
+} & CoinPairType;
+type VaultsPosition = {
+    description: string;
+    id: string;
+    index: number;
+    liquidity: string;
+    name: string;
+    pool_id: string;
+    tick_lower_index: number;
+    tick_upper_index: number;
+    url: string;
+} & CoinPairType;
+type PeriodInfo = {
+    period: number;
+    cetus_amount: string;
+    is_redeemed: boolean;
+};
+type VestCreateEvent = {
+    clmm_vester_id: string;
+    lp_coin_type: string;
+    pool_id: string;
+    position_id: string;
+    vault_id: string;
+    vault_vester_id: string;
+};
+type VaultVestNFT = {
+    id: string;
+    index: number;
+    vault_id: string;
+    lp_amount: string;
+    redeemed_amount: string;
+    impaired_a: string;
+    impaired_b: string;
+    period_infos: PeriodInfo[];
+    url: string;
+    name: string;
+    vester_id: string;
+};
+type RedeemOption = {
+    vault_id: string;
+    vesting_nft_id: string;
+    period: number;
+} & CoinPairType;
+
 type BigNumber = Decimal.Value | number | string;
 
+declare class VestModule implements IModule$1<VolatileVaultsSDK> {
+    protected _sdk: VolatileVaultsSDK;
+    constructor(sdk: VolatileVaultsSDK);
+    get sdk(): VolatileVaultsSDK;
+    vestNftIsAvailable(vest_nft_id: string, vester_infos_handle: string): Promise<boolean>;
+    /**
+     * Get the vest create event list
+     * @returns {Promise<VestCreateEvent[]>} The vest create event list
+     */
+    getVestCreateEventList(): Promise<VestCreateEvent[]>;
+    getVaultsVestInfoList(vault_ids: string[]): Promise<VaultsVestInfo[]>;
+    /**
+     * Get the vaults vest info
+     * @param vault_id - The vault id
+     * @param force_refresh - Whether to force refresh the cache
+     * @returns {Promise<VaultsVestInfo>} The vaults vest info
+     */
+    getVaultsVestInfo(vault_id: string, force_refresh?: boolean): Promise<VaultsVestInfo>;
+    /**
+     * Get the vault vest event
+     * @param vault_id - The vault id
+     * @returns {VestCreateEvent} The vault vest event
+     */
+    getVaultVestEvent(vault_id: string): Promise<VestCreateEvent>;
+    /**
+     * Get the vault vest nft list
+     * @param owner - The owner address
+     * @returns {Promise<VaultVestNFT[]>} The vault vest nft list
+     */
+    getOwnerVaultVestNFT(owner: string): Promise<VaultVestNFT[]>;
+    /**
+     * Build the redeem payload
+     * @param options - The redeem options
+     * @returns {Transaction} The redeem payload
+     */
+    buildRedeemPayload(options: RedeemOption[], tx?: Transaction): Promise<Transaction>;
+}
+
 /**
  * Represents options and configurations for an SDK.
  */
@@ -526,6 +642,10 @@ type SdkOptions = {
      * Vaults configuration.
      */
     vaults: VaultsConfigs;
+    /**
+     * Vest configuration.
+     */
+    vest?: Package<VestConfigs>;
 };
 /**
  * The entry class of VolatileVaultsSDK, which is almost responsible for all interactions with Vaults.
@@ -552,6 +672,10 @@ declare class VolatileVaultsSDK {
      * Client for interacting with the Aggregator service.
      */
     protected _aggregatorClient: AggregatorClient;
+    /**
+     * Module for interacting with vest.
+     */
+    protected _vest: VestModule;
     /**
      * SDK for interacting with Cetus CLMM (Constant Product Automated Market Maker).
      */
@@ -597,6 +721,11 @@ declare class VolatileVaultsSDK {
      * @returns {CetusClmmSDK} The CetusClmmSDK instance.
      */
     get CetusClmmSDK(): CetusClmmSDK;
+    /**
+     * Getter for the VestModule instance.
+     * @returns {VestModule} The VestModule instance.
+     */
+    get Vest(): VestModule;
     /**
      * Verifies if the sender address is valid.
      * @throws Error if the sender address is invalid.
@@ -799,6 +928,18 @@ declare function getPositionPriceRange(tick_lower_index: number, tick_upper_inde
     minPrice: string;
     maxPrice: string;
 };
+/**
+ * Parses the vault vest info from the Sui object response.
+ * @param res - The Sui object response containing the vault vest info.
+ * @returns The parsed vault vest info.
+ */
+declare function parseVaultsVestInfo(res: SuiObjectResponse): VaultsVestInfo;
+/**
+ * Parses the vault vest NFT from the Sui object response.
+ * @param res - The Sui object response containing the vault vest NFT.
+ * @returns The parsed vault vest NFT.
+ */
+declare function parseVaultVestNFT(res: SuiObjectResponse): VaultVestNFT;
 
 declare const checkIsMinOrMaxIndex: (tick: number, type: "min" | "max", tickSpacing: number) => boolean;
 declare function convertU64BytesToDecimal(bytes: number[]): string;
@@ -862,4 +1003,4 @@ interface InitSDKOptions {
 declare function initVaultSDK(options: InitSDKOptions): VolatileVaultsSDK;
 declare const defaultProvider: string[];
 
-export { Balances, BigNumber, ClmmPoolBalance, ClmmVault, CollectFeeOptions, CollectRewardOptions, DepositCalculationOptions, DepositCalculationResult, DepositCalculationValueOptions, DepositMode, DepositOptions, FeedInfo, LiquidityRange, LpCallback, PackageConfigs, Pool, PoolCoinTypes, Price, PythNodeError, PythPriceModule, SdkEnv, SdkOptions, VaultsBalance, VaultsConfigs, VaultsModule, VolatileVaultsSDK, WithdrawCalculationOptions, WithdrawCalculationResult, WithdrawMode, WithdrawOptions, WrapperPosition, buildPoolData, buildVaultsBalance, calculateAum, calculateDepositRatioFixTokenA, calculateTotalAumBasedOnQuote, checkIsMinOrMaxIndex, convertU64BytesToDecimal, VolatileVaultsSDK as default, defaultProvider, estCoinAmountsFromTotalAmount, feed_map_mainnet, feed_map_testnet, getCoinAmountsFromRatio, getPositionPriceRange, getPriceWithFormattedDecimals, getPrimitivePricesFromBaseQuote, getQuotePerBaseAndBasePerQuote, getShareBufferAssets, getUpdatePriceType, getVaultValidBalances, get_lp_amount_by_liquidity, get_lp_amount_by_tvl, get_share_liquidity_by_amount, initMainnetSDK, initTestnetSDK, initVaultSDK, oraclePriceMultiplierDecimal, printTransaction, toSuiObjectId, vaults_mainnet, vaults_testnet };
+export { Balances, BigNumber, ClmmPoolBalance, ClmmVault, CollectFeeOptions, CollectRewardOptions, DepositCalculationOptions, DepositCalculationResult, DepositCalculationValueOptions, DepositMode, DepositOptions, FeedInfo, GlobalVestingPeriod, LiquidityRange, LpCallback, PackageConfigs, PeriodInfo, Pool, PoolCoinTypes, Price, PythNodeError, PythPriceModule, RedeemOption, SdkEnv, SdkOptions, VaultVestNFT, VaultsBalance, VaultsConfigs, VaultsModule, VaultsPosition, VaultsVestInfo, VestConfigs, VestCreateEvent, VestModule, VolatileVaultsSDK, WithdrawCalculationOptions, WithdrawCalculationResult, WithdrawMode, WithdrawOptions, WrapperPosition, buildPoolData, buildVaultsBalance, calculateAum, calculateDepositRatioFixTokenA, calculateTotalAumBasedOnQuote, checkIsMinOrMaxIndex, convertU64BytesToDecimal, VolatileVaultsSDK as default, defaultProvider, estCoinAmountsFromTotalAmount, feed_map_mainnet, feed_map_testnet, getCoinAmountsFromRatio, getPositionPriceRange, getPriceWithFormattedDecimals, getPrimitivePricesFromBaseQuote, getQuotePerBaseAndBasePerQuote, getShareBufferAssets, getUpdatePriceType, getVaultValidBalances, get_lp_amount_by_liquidity, get_lp_amount_by_tvl, get_share_liquidity_by_amount, initMainnetSDK, initTestnetSDK, initVaultSDK, oraclePriceMultiplierDecimal, parseVaultVestNFT, parseVaultsVestInfo, printTransaction, toSuiObjectId, vaults_mainnet, vaults_testnet };