haedal-vault-sdk 2.0.0 → 2.1.1

package/dist/index.d.ts

@@ -1,11 +1,11 @@
 import { CoinBalance, SuiObjectResponse } from '@mysten/sui/client';
 import { PreSwapLpChangeParams, AggregatorClient } from '@cetusprotocol/aggregator-sdk';
-import { PaginationArgs, DataPage, CoinPairType, TableHandle, IModule as IModule$1, Package, SuiAddressType, FullClient, CoinAsset, SuiResource } from '@cetusprotocol/common-sdk';
+import { TableHandle, 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 { TransactionObjectArgument, Transaction } from '@mysten/sui/transactions';
-import { SuiPriceServiceConnection, SuiPythClient, PriceUpdate } from '@pythnetwork/pyth-sui-js';
 import * as CetusDlmmSDK from '@cetusprotocol/dlmm-sdk';
 import CetusDlmmSDK__default, { DlmmPosition, BinLiquidityInfo, DlmmPool } from '@cetusprotocol/dlmm-sdk';
+import { SuiPriceServiceConnection, SuiPythClient, PriceUpdate } from '@pythnetwork/pyth-sui-js';
 import BN from 'bn.js';
 import Decimal from 'decimal.js';
 
@@ -13,6 +13,155 @@ interface IModule {
     readonly sdk: VolatileVaultsSDK;
 }
 
+type VaultsV2Configs = {
+    package_id: string;
+    published_at: string;
+    configs: {
+        registry_id: string;
+        pools_handle: string;
+        global_config_id: string;
+        versioned_id: string;
+        pyth_oracle_id: string;
+        oracle_infos_handle: string;
+    };
+};
+type ActionAcl = {
+    is_deposit_allowed: boolean;
+    is_withdraw_allowed: boolean;
+};
+type DLMMMarketPosition = {
+    id: string;
+    position: DlmmPosition;
+    valid_lower_bin_id: number;
+    valid_upper_bin_id: number;
+    amounts: Balances;
+};
+type DLMMMarket = {
+    id: string;
+    vault_id: string;
+    certified_pools: string[];
+    positions_handle: TableHandle;
+    position_list: DLMMMarketPosition[];
+    position_keys: string[];
+} & PoolCoinTypes;
+type VaultPool = {
+    id: string;
+    lp_token_treasury: string;
+    quote_type?: string;
+    buffer_assets: Balances[];
+    hard_cap: string;
+    markets_handle: TableHandle;
+    markets: DLMMMarket[];
+    protocol_fees_handle: TableHandle;
+    lp_token_type: string;
+    action_status: ActionAcl;
+    last_aum: string;
+    protocol_fee_rate: string;
+} & PoolCoinTypes;
+type CollectRewardOptionsV2 = {
+    reward_coin_types: string[];
+    lp_token_type: string;
+    pool_id: string;
+    certified_pool_id: string;
+    position_id: string;
+    withdraw_cert?: TransactionObjectArgument;
+} & PoolCoinTypes;
+type CollectFeeOptionsV2 = {
+    lp_token_type: string;
+    pool_id: string;
+    certified_pool_id: string;
+    position_id: string;
+    withdraw_cert?: TransactionObjectArgument;
+} & PoolCoinTypes;
+type DepositCalculationOptionsV2 = {
+    uuid?: string;
+    pool_id: string;
+    mode: DepositMode;
+} & ({
+    mode: 'FixedOneSide';
+    fixed_amount: string;
+    fixed_coin_a: boolean;
+} | {
+    mode: 'FlexibleBoth';
+    coin_amount_a: string;
+    coin_amount_b: string;
+} | {
+    mode: 'OnlyCoinA';
+    coin_amount_a: string;
+    re_balance?: boolean;
+} | {
+    mode: 'OnlyCoinB';
+    coin_amount_b: string;
+    re_balance?: boolean;
+});
+type DepositCalculationResultV2 = {
+    deposit_amount_a: string;
+    deposit_amount_b: string;
+    lp_amount?: string;
+    uuid?: string;
+    mode: DepositMode;
+    re_balance?: {
+        swap_result: SwapResult;
+        coin_amount: string;
+        mode: 'OnlyCoinA' | 'OnlyCoinB';
+    };
+};
+type WithdrawCalculationResultV2 = {
+    burn_lp_amount: string;
+    receive_amount_a: string;
+    receive_amount_b: string;
+    mode: DepositMode;
+    swap?: {
+        swap_amount_in: string;
+        swap_amount_out: string;
+        remove_amount_a: string;
+        remove_amount_b: string;
+    };
+};
+type VaultsBalanceV2 = {
+    vault_id: string;
+    certified_pool_id: string;
+    owner: string;
+    lp_token_type: string;
+    lp_token_balance: string;
+    liquidity_shares: string[];
+    valid_lower_bin_id: number;
+    valid_upper_bin_id: number;
+    original_lower_bin_id: number;
+    original_upper_bin_id: number;
+    amount_a: string;
+    amount_b: string;
+    position_amount_a: string;
+    position_amount_b: string;
+    coin_type_a: string;
+    coin_type_b: string;
+    bin_infos?: BinLiquidityInfo;
+};
+type DepositCalculationValueOptionsV2 = {
+    uuid?: string;
+    pool_id: string;
+    mode: 'FlexibleBoth' | 'OnlyCoinA' | 'OnlyCoinB';
+    amount_usd: string;
+    re_balance?: boolean;
+};
+type SwapResult = {
+    swap_in_amount: string;
+    swap_out_amount: string;
+    route_obj?: any;
+};
+type DepositOptionsV2 = {
+    pool_id: string;
+    amount_a: string;
+    amount_b: string;
+    return_lp_coin?: boolean;
+    re_balance?: {
+        swap_result: SwapResult;
+        coin_amount: string;
+        mode: 'OnlyCoinA' | 'OnlyCoinB';
+        swap_slippage: number;
+    };
+};
+
 type PythConfigs = {
     pyth_package_id: string;
     pyth_published_at: string;
@@ -109,6 +258,12 @@ type DepositOptions = {
     amount_a: string;
     amount_b: string;
     return_lp_coin?: boolean;
+    re_balance?: {
+        swap_result: SwapResult;
+        coin_amount: string;
+        mode: 'OnlyCoinA' | 'OnlyCoinB';
+        swap_slippage: number;
+    };
 };
 type DepositMode = 'FixedOneSide' | 'FlexibleBoth' | 'OnlyCoinA' | 'OnlyCoinB';
 type LpCallback = {
@@ -130,9 +285,11 @@ type DepositCalculationOptions = {
 } | {
     mode: 'OnlyCoinA';
     coin_amount_a: string;
+    re_balance?: boolean;
 } | {
     mode: 'OnlyCoinB';
     coin_amount_b: string;
+    re_balance?: boolean;
 });
 type DepositCalculationValueOptions = {
     uuid?: string;
@@ -144,6 +301,11 @@ type DepositCalculationResult = {
     deposit_amount_a: string;
     deposit_amount_b: string;
     mode: DepositMode;
+    lp_amount?: string;
+    re_balance?: {
+        swap_result: SwapResult;
+        coin_amount: string;
+    };
 };
 type WithdrawOptions = {
     pool_id: string;
@@ -330,6 +492,7 @@ declare class VaultsModule implements IModule {
      * @returns A paginated list of pools.
      */
     getPoolList(paginationArgs?: PaginationArgs): Promise<DataPage<Pool>>;
+    getAssignPoolList(assign_pool_ids: string[]): Promise<Pool[]>;
     /**
      * Retrieves details of a specific pool by ID.
      * @param poolId - The unique identifier of the pool.
@@ -409,6 +572,7 @@ declare class VaultsModule implements IModule {
      */
     private buildWithdrawBufferReward;
     preCalculateDepositValue(options: DepositCalculationValueOptions, lpCallback?: LpCallback): Promise<DepositCalculationResult>;
+    private calculateBalanceSwapAmount;
     /**
      * Pre-calculates the deposit amounts for a liquidity pool based on different deposit modes.
      * The method calculates how much of each coin to deposit and how much LP (liquidity provider) tokens the user will receive.
@@ -417,7 +581,7 @@ declare class VaultsModule implements IModule {
      *
      * @returns {Promise<DepositCalculationResult>} A promise that resolves to the calculated deposit amounts and the LP tokens to be received.
      */
-    preCalculateDepositAmount(options: DepositCalculationOptions, lpCallback: LpCallback): Promise<DepositCalculationResult>;
+    preCalculateDepositAmount(options: DepositCalculationOptions, lpCallback?: LpCallback): Promise<DepositCalculationResult>;
     /**
      * Retrieves the vault and pool information based on the provided pool_id.
      * It first fetches the vault details, then retrieves the associated CLMM (Constant Product Market Maker) pool details.
@@ -599,155 +763,6 @@ type RedeemOption = {
     period: number;
 } & CoinPairType;
 
-type VaultsV2Configs = {
-    package_id: string;
-    published_at: string;
-    configs: {
-        registry_id: string;
-        pools_handle: string;
-        global_config_id: string;
-        versioned_id: string;
-        pyth_oracle_id: string;
-        oracle_infos_handle: string;
-    };
-};
-type ActionAcl = {
-    is_deposit_allowed: boolean;
-    is_withdraw_allowed: boolean;
-};
-type DLMMMarketPosition = {
-    id: string;
-    position: DlmmPosition;
-    valid_lower_bin_id: number;
-    valid_upper_bin_id: number;
-    amounts: Balances;
-};
-type DLMMMarket = {
-    id: string;
-    vault_id: string;
-    certified_pools: string[];
-    positions_handle: TableHandle;
-    position_list: DLMMMarketPosition[];
-    position_keys: string[];
-} & PoolCoinTypes;
-type VaultPool = {
-    id: string;
-    lp_token_treasury: string;
-    quote_type?: string;
-    buffer_assets: Balances[];
-    hard_cap: string;
-    markets_handle: TableHandle;
-    markets: DLMMMarket[];
-    protocol_fees_handle: TableHandle;
-    lp_token_type: string;
-    action_status: ActionAcl;
-    last_aum: string;
-    protocol_fee_rate: string;
-} & PoolCoinTypes;
-type CollectRewardOptionsV2 = {
-    reward_coin_types: string[];
-    lp_token_type: string;
-    pool_id: string;
-    certified_pool_id: string;
-    position_id: string;
-    withdraw_cert?: TransactionObjectArgument;
-} & PoolCoinTypes;
-type CollectFeeOptionsV2 = {
-    lp_token_type: string;
-    pool_id: string;
-    certified_pool_id: string;
-    position_id: string;
-    withdraw_cert?: TransactionObjectArgument;
-} & PoolCoinTypes;
-type DepositCalculationOptionsV2 = {
-    uuid?: string;
-    pool_id: string;
-    mode: DepositMode;
-} & ({
-    mode: 'FixedOneSide';
-    fixed_amount: string;
-    fixed_coin_a: boolean;
-} | {
-    mode: 'FlexibleBoth';
-    coin_amount_a: string;
-    coin_amount_b: string;
-} | {
-    mode: 'OnlyCoinA';
-    coin_amount_a: string;
-    re_balance?: boolean;
-} | {
-    mode: 'OnlyCoinB';
-    coin_amount_b: string;
-    re_balance?: boolean;
-});
-type DepositCalculationResultV2 = {
-    deposit_amount_a: string;
-    deposit_amount_b: string;
-    lp_amount?: string;
-    uuid?: string;
-    mode: DepositMode;
-    re_balance?: {
-        swap_result: SwapResult;
-        coin_amount: string;
-        mode: 'OnlyCoinA' | 'OnlyCoinB';
-    };
-};
-type WithdrawCalculationResultV2 = {
-    burn_lp_amount: string;
-    receive_amount_a: string;
-    receive_amount_b: string;
-    mode: DepositMode;
-    swap?: {
-        swap_amount_in: string;
-        swap_amount_out: string;
-        remove_amount_a: string;
-        remove_amount_b: string;
-    };
-};
-type VaultsBalanceV2 = {
-    vault_id: string;
-    certified_pool_id: string;
-    owner: string;
-    lp_token_type: string;
-    lp_token_balance: string;
-    liquidity_shares: string[];
-    valid_lower_bin_id: number;
-    valid_upper_bin_id: number;
-    original_lower_bin_id: number;
-    original_upper_bin_id: number;
-    amount_a: string;
-    amount_b: string;
-    position_amount_a: string;
-    position_amount_b: string;
-    coin_type_a: string;
-    coin_type_b: string;
-    bin_infos?: BinLiquidityInfo;
-};
-type DepositCalculationValueOptionsV2 = {
-    uuid?: string;
-    pool_id: string;
-    mode: 'FlexibleBoth' | 'OnlyCoinA' | 'OnlyCoinB';
-    amount_usd: string;
-    re_balance?: boolean;
-};
-type SwapResult = {
-    swap_in_amount: string;
-    swap_out_amount: string;
-    route_obj?: any;
-};
-type DepositOptionsV2 = {
-    pool_id: string;
-    amount_a: string;
-    amount_b: string;
-    return_lp_coin?: boolean;
-    re_balance?: {
-        swap_result: SwapResult;
-        coin_amount: string;
-        mode: 'OnlyCoinA' | 'OnlyCoinB';
-        swap_slippage: number;
-    };
-};
-
 type BigNumber = Decimal.Value | number | string;
 
 declare class VestModule implements IModule$1<VolatileVaultsSDK> {