haedal-vault-sdk 1.8.2 → 1.8.4

package/README.md

@@ -250,9 +250,11 @@ const tx = await sdk.Vaults.buildDepositPayload({
 ```typescript
 const poolId="0x..."
 
+// Example 1: Single coin deposit without rebalancing (re_balance = false or undefined)
 const result = await sdk.VaultsV2.preCalculateDepositAmount( {
     mode: 'OnlyCoinA',
     coin_amount_a: toDecimalsAmount(1, 6).toString(), // Deposit only asset A
+    re_balance: false, // Optional: false for single coin deposit only
 })
 
 // Build the deposit transaction payload
@@ -261,8 +263,42 @@ const tx = await sdk.VaultsV2.buildDepositPayload({
     amount_a: result.deposit_amount_a,
     amount_b: result.deposit_amount_b,
 })    
+
+// Example 2: Single coin deposit with automatic rebalancing (re_balance = true)
+const resultWithRebalance = await sdk.VaultsV2.preCalculateDepositAmount( {
+    mode: 'OnlyCoinA',
+    coin_amount_a: toDecimalsAmount(1, 6).toString(), // Deposit amount for asset A
+    re_balance: true, // Enable automatic rebalancing to match coin A and coin B
+})
+
+// Build the deposit transaction payload with rebalance information
+const txWithRebalance = await sdk.VaultsV2.buildDepositPayload({
+    pool_id: poolId,
+    amount_a: resultWithRebalance.deposit_amount_a,
+    amount_b: resultWithRebalance.deposit_amount_b,
+    re_balance: resultWithRebalance.re_balance, // Include rebalance swap information
+})    
+
+
+// Example 3: OnlyCoinB mode with rebalancing
+const resultOnlyCoinB = await sdk.VaultsV2.preCalculateDepositAmount( {
+    mode: 'OnlyCoinB',
+    coin_amount_b: toDecimalsAmount(1, 9).toString(), // Deposit amount for asset B
+    re_balance: true, // Enable automatic rebalancing
+})
+
+const txOnlyCoinB = await sdk.VaultsV2.buildDepositPayload({
+    pool_id: poolId,
+    amount_a: resultOnlyCoinB.deposit_amount_a,
+    amount_b: resultOnlyCoinB.deposit_amount_b,
+    re_balance: resultOnlyCoinB.re_balance,
+})    
 ```
 
+**Note on `re_balance` parameter (VaultsV2 only):**
+- When `re_balance` is `true`: The system will automatically calculate and swap a portion of the deposited coin to balance both coin A and coin B according to the pool's ratio. This ensures optimal liquidity provision.
+- When `re_balance` is `false` or `undefined`: Only the specified single coin will be deposited, with the other coin amount set to 0. This is a pure single-coin deposit without rebalancing.
+
 ### 3. Withdrawal
 Withdrawals can be performed in different modes, similar to deposits.
 

package/dist/index.d.ts

@@ -172,6 +172,8 @@ type WithdrawCalculationResult = {
     swap?: {
         swap_amount_in: string;
         swap_amount_out: string;
+        remove_amount_a: string;
+        remove_amount_b: string;
     };
 };
 type VaultsBalance = {
@@ -658,12 +660,38 @@ type CollectFeeOptionsV2 = {
     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;
@@ -673,6 +701,8 @@ type WithdrawCalculationResultV2 = {
     swap?: {
         swap_amount_in: string;
         swap_amount_out: string;
+        remove_amount_a: string;
+        remove_amount_b: string;
     };
 };
 type VaultsBalanceV2 = {
@@ -699,6 +729,24 @@ type DepositCalculationValueOptionsV2 = {
     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;
@@ -799,7 +847,7 @@ declare class VaultsModuleV2 implements IModule {
      * @param tx - An optional transaction object to append to, or a new one if not provided.
      * @returns return_lp_coin is true, return lp_coin, otherwise return undefined
      */
-    buildDepositPayload(options: DepositOptions, tx: Transaction): Promise<TransactionObjectArgument | undefined>;
+    buildDepositPayload(options: DepositOptionsV2, tx: Transaction): Promise<TransactionObjectArgument | undefined>;
     /**
      * Builds a transaction payload to withdraw from a pool.
      * @param options - The options required to withdraw.
@@ -842,6 +890,7 @@ declare class VaultsModuleV2 implements IModule {
      */
     private buildWithdrawBufferReward;
     preCalculateDepositValue(options: DepositCalculationValueOptionsV2, lpCallback?: LpCallback): Promise<DepositCalculationResultV2>;
+    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.
@@ -850,14 +899,13 @@ declare class VaultsModuleV2 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<DepositCalculationResultV2>;
+    preCalculateDepositAmount(options: DepositCalculationOptionsV2, lpCallback?: LpCallback): Promise<DepositCalculationResultV2>;
     getVaultAndPool(pool_id: string, refreshPool?: boolean): Promise<{
         dlmmPool: DlmmPool;
         pool: VaultPool;
     }>;
     private calculatePositionValueRates;
     private calculateDepositAmountsV2;
-    private calculateDepositAmounts;
     private calculateDepositOtherSide;
     private calculateDepositFlexibleBoth;
     private calculateDepositLpAmountBoth;
@@ -875,6 +923,7 @@ declare class VaultsModuleV2 implements IModule {
     private calculateWithdrawOnlyCoin;
     private calculateWithdrawOnlyCoinByLpAmount;
     getPackageConfigs(): Promise<SdkOptions>;
+    findRouters(from: string, target: string, amount: string): Promise<SwapResult>;
 }
 
 /**
@@ -1218,6 +1267,33 @@ declare function getAmountBalanceByLpAmount(sdk: VolatileVaultsSDK, lp_token_amo
 }>;
 declare function buildDLMMMarketId(vaultId: string): string;
 declare function buildDLMMPositionId(positionTableId: string, posId: string): string;
+/**
+ * Calculate the swap amount needed to achieve target ratio
+ * @param coin_amount - Total coin amount available
+ * @param fix_amount_a - Whether to fix token A amount (true) or token B amount (false)
+ * @param current_price - Current price:
+ *   - When fix_amount_a = true: current_price = B/A (price of B in terms of A)
+ *   - When fix_amount_a = false: current_price = A/B (price of A in terms of B)
+ * @param target_ratio - Target ratio to achieve:
+ *   - When fix_amount_a = true: target_ratio = B/A
+ *   - When fix_amount_a = false: target_ratio = A/B
+ * @param tolerance - Tolerance for the target ratio (default: 0.01)
+ * @returns Object containing:
+ *   - swap_amount: Amount to swap
+ *   - final_amount_a: Final amount of token A (remaining A when fix_amount_a=true, obtained A when fix_amount_a=false)
+ *   - final_amount_b: Final amount of token B (obtained B when fix_amount_a=true, remaining B when fix_amount_a=false)
+ */
+declare function calcExactSwapAmount(coin_amount: string, fix_amount_a: boolean, current_price: string, target_ratio: string): {
+    swap_amount: string;
+    final_amount_a: string;
+    final_amount_b: string;
+    best?: undefined;
+} | {
+    swap_amount: string;
+    final_amount_a: string;
+    final_amount_b: string;
+    best: string;
+};
 
 declare const checkIsMinOrMaxIndex: (tick: number, type: "min" | "max", tickSpacing: number) => boolean;
 declare function convertU64BytesToDecimal(bytes: number[]): string;
@@ -1281,4 +1357,4 @@ interface InitSDKOptions {
 declare function initVaultSDK(options: InitSDKOptions): VolatileVaultsSDK;
 declare const defaultProvider: string[];
 
-export { ActionAcl, Balances, BigNumber, ClmmPoolBalance, ClmmVault, CollectFeeOptions, CollectFeeOptionsV2, CollectRewardOptions, CollectRewardOptionsV2, DLMMMarket, DLMMMarketPosition, DepositCalculationOptions, DepositCalculationResult, DepositCalculationResultV2, DepositCalculationValueOptions, DepositCalculationValueOptionsV2, DepositMode, DepositOptions, FeedInfo, GlobalVestingPeriod, LiquidityRange, LpCallback, PackageConfigs, PeriodInfo, Pool, PoolCoinTypes, Price, PythConfigs, PythNodeError, PythPriceModule, RedeemOption, SdkEnv, SdkOptions, VaultPool, VaultVestNFT, VaultsBalance, VaultsBalanceV2, VaultsConfigs, VaultsModule, VaultsModuleV2, VaultsPosition, VaultsV2Configs, VaultsVestInfo, VestConfigs, VestCreateEvent, VestModule, VolatileVaultsSDK, WithdrawCalculationOptions, WithdrawCalculationResult, WithdrawCalculationResultV2, WithdrawMode, WithdrawOptions, WrapperPosition, buildDLMMMarket, buildDLMMMarketId, buildDLMMMarketPosition, buildDLMMPositionId, buildPoolData, buildPoolV2Data, buildVaultsBalance, buildVaultsBalanceV2, calculateAum, calculateAumV2, calculateDepositRatioFixTokenA, calculateTotalAumBasedOnQuote, checkIsMinOrMaxIndex, convertU64BytesToDecimal, VolatileVaultsSDK as default, defaultProvider, estCoinAmountsFromTotalAmount, feed_map_mainnet, feed_map_testnet, getAmountBalanceByLpAmount, 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 };
+export { ActionAcl, Balances, BigNumber, ClmmPoolBalance, ClmmVault, CollectFeeOptions, CollectFeeOptionsV2, CollectRewardOptions, CollectRewardOptionsV2, DLMMMarket, DLMMMarketPosition, DepositCalculationOptions, DepositCalculationOptionsV2, DepositCalculationResult, DepositCalculationResultV2, DepositCalculationValueOptions, DepositCalculationValueOptionsV2, DepositMode, DepositOptions, DepositOptionsV2, FeedInfo, GlobalVestingPeriod, LiquidityRange, LpCallback, PackageConfigs, PeriodInfo, Pool, PoolCoinTypes, Price, PythConfigs, PythNodeError, PythPriceModule, RedeemOption, SdkEnv, SdkOptions, SwapResult, VaultPool, VaultVestNFT, VaultsBalance, VaultsBalanceV2, VaultsConfigs, VaultsModule, VaultsModuleV2, VaultsPosition, VaultsV2Configs, VaultsVestInfo, VestConfigs, VestCreateEvent, VestModule, VolatileVaultsSDK, WithdrawCalculationOptions, WithdrawCalculationResult, WithdrawCalculationResultV2, WithdrawMode, WithdrawOptions, WrapperPosition, buildDLMMMarket, buildDLMMMarketId, buildDLMMMarketPosition, buildDLMMPositionId, buildPoolData, buildPoolV2Data, buildVaultsBalance, buildVaultsBalanceV2, calcExactSwapAmount, calculateAum, calculateAumV2, calculateDepositRatioFixTokenA, calculateTotalAumBasedOnQuote, checkIsMinOrMaxIndex, convertU64BytesToDecimal, VolatileVaultsSDK as default, defaultProvider, estCoinAmountsFromTotalAmount, feed_map_mainnet, feed_map_testnet, getAmountBalanceByLpAmount, 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 };