@cetusprotocol/sui-clmm-sdk 1.0.2 → 1.1.1

package/dist/index.d.mts

@@ -168,6 +168,7 @@ declare function computeSwapStep(currentSqrtPrice: BN, targetSqrtPrice: BN, liqu
  */
 declare function computeSwap(aToB: boolean, byAmountIn: boolean, amount: BN, poolData: ClmmpoolData, swapTicks: Array<TickData>): SwapResult;
 
+declare const poolLiquiditySnapshotType = "position_liquidity_snapshot";
 /**
  * Enumerates the possible status values of a position within a liquidity mining module.
  */
@@ -233,11 +234,11 @@ type Position = {
      * The address type of the second coin in the position.
      */
     coin_type_b: SuiAddressType;
-} & NFT$1 & PositionReward;
+} & NFT$1 & PositionInfo;
 /**
  * Represents reward information associated with a liquidity mining position.
  */
-type PositionReward = {
+type PositionInfo = {
     /**
      * The unique identifier of the position object.
      */
@@ -1038,6 +1039,29 @@ type SwapGasEstimateArg = {
     swap_ticks: Array<TickData>;
     current_pool: Pool;
 };
+type GetPositionInfoListParams = {
+    position_handle: string;
+    position_ids: string[];
+};
+type PoolLiquiditySnapshot = {
+    current_sqrt_price: string;
+    remove_percent: string;
+    snapshots: {
+        id: string;
+        size: string;
+    };
+    position_snapshots?: PositionSnapshot[];
+};
+type PositionSnapshot = {
+    position_id: string;
+    liquidity: string;
+    tick_lower_index: number;
+    tick_upper_index: number;
+    fee_owned_a: string;
+    fee_owned_b: string;
+    value_cut: string;
+    rewards: string[];
+};
 
 /**
  * Represents configurations specific to the Cetus protocol.
@@ -1320,6 +1344,55 @@ type SuiInputTypes = 'object' | SuiBasicTypes;
  */
 declare const getDefaultSuiInputType: (value: any) => SuiInputTypes;
 
+type VestConfigs = {
+    versioned_id: string;
+    clmm_vest_id: string;
+    cetus_coin_type: string;
+};
+type GlobalVestingPeriod = {
+    period: number;
+    release_time: string;
+    redeemed_amount: string;
+    percentage: string;
+};
+type ClmmVestInfo = {
+    id: string;
+    balance: string;
+    global_vesting_periods: GlobalVestingPeriod[];
+    total_value: string;
+    total_cetus_amount: string;
+    redeemed_amount: string;
+    start_time: string;
+    type: string;
+    positions: {
+        id: string;
+        size: string;
+    };
+};
+type PeriodDetail = {
+    period: number;
+    cetus_amount: string;
+    is_redeemed: boolean;
+};
+type PositionVesting = {
+    position_id: string;
+    cetus_amount: string;
+    redeemed_amount: string;
+    is_paused: boolean;
+    impaired_a: string;
+    impaired_b: string;
+    period_details: PeriodDetail[];
+} & CoinPairType;
+type RedeemOption = {
+    clmm_pool_id: string;
+    clmm_position_id: string;
+    period: number;
+} & CoinPairType;
+type GetPositionVestOption = {
+    clmm_pool_id: string;
+    clmm_position_ids: string[];
+} & CoinPairType;
+
 type BigNumber = Decimal.Value | number | string;
 
 /**
@@ -1439,6 +1512,13 @@ declare class PoolModule implements IModule<CetusClmmSDK> {
      * @returns {Promise<Pool[]>} An array of Pool objects.
      */
     getPoolsWithPage(pagination_args?: PaginationArgs, force_refresh?: boolean): Promise<DataPage<Pool>>;
+    /**
+     * Get the liquidity snapshot of a pool.
+     * @param pool_id The ID of the pool.
+     * @returns The liquidity snapshot of the pool.
+     */
+    getPoolLiquiditySnapshot(pool_id: string, show_details?: boolean): Promise<PoolLiquiditySnapshot>;
+    getPositionSnapshot(snapshot_handle: string, pos_ids: string[]): Promise<PositionSnapshot[]>;
     /**
      * Gets a list of pools.
      * @param {string[]} assign_pools An array of pool ID to get.
@@ -1512,7 +1592,7 @@ declare class PoolModule implements IModule<CetusClmmSDK> {
      * @param {FetchParams} params The parameters for the fetch.
      * @returns {Promise<PositionReward[]>} A promise that resolves to an array of position rewards.
      */
-    fetchPositionRewardList(params: FetchParams): Promise<PositionReward[]>;
+    fetchPoolPositionInfoList(params: FetchParams): Promise<PositionInfo[]>;
     /**
      * Fetches ticks from the fullnode using the RPC API.
      * @param {string} tick_handle The handle for the tick. Get tick handle from `sdk.Pool.getPool()`
@@ -1626,19 +1706,20 @@ declare class PositionModule implements IModule<CetusClmmSDK> {
      */
     getSimplePositionList(position_ids: SuiObjectIdType[], show_display?: boolean): Promise<Position[]>;
     /**
-     * Updates the rewarders of position
+     * Updates the position info
      * @param {string} position_handle Position handle
      * @param {Position} position Position object
      * @returns {Promise<Position>} A promise that resolves to an array of Position objects.
      */
-    private updatePositionRewarders;
+    updatePositionInfo(position_handle: string, position: Position): Promise<Position>;
     /**
-     * Gets the position rewarders for the given position handle and position object ID.
+     * Gets the position info for the given position handle and position object ID.
      * @param {string} position_handle The handle of the position.
      * @param {string} position_id The ID of the position object.
-     * @returns {Promise<PositionReward | undefined>} PositionReward object.
+     * @returns {Promise<PositionInfo>} PositionInfo object.
      */
-    getPositionRewarders(position_handle: string, position_id: string): Promise<PositionReward | undefined>;
+    getPositionInfo(position_handle: string, position_id: string): Promise<PositionInfo>;
+    getPositionInfoList(options: GetPositionInfoListParams[]): Promise<PositionInfo[]>;
     buildFetchPosFee(params: FetchPosFeeParams, tx: Transaction): void;
     parsedPosFeeData(simulate_res: DevInspectResults): Record<string, {
         position_id: string;
@@ -1888,6 +1969,30 @@ declare class SwapModule implements IModule<CetusClmmSDK> {
     }>;
 }
 
+declare class VestModule implements IModule<CetusClmmSDK> {
+    protected _sdk: CetusClmmSDK;
+    constructor(sdk: CetusClmmSDK);
+    get sdk(): CetusClmmSDK;
+    /**
+     * Get the clmm vest info list
+     * @returns {Promise<ClmmVestInfo[]>} The clmm vest info list
+     */
+    getClmmVestInfoList(): Promise<ClmmVestInfo[]>;
+    /**
+     * Get the clmm vest info
+     * @param vest_id - The vest id
+     * @returns {Promise<ClmmVestInfo>} The clmm vest info
+     */
+    getClmmVestInfo(force_refresh?: boolean): Promise<ClmmVestInfo>;
+    getPositionVesting(options: GetPositionVestOption[]): Promise<PositionVesting[]>;
+    /**
+     * Build the redeem payload
+     * @param options - The redeem options
+     * @returns {Transaction} The redeem payload
+     */
+    buildRedeemPayload(options: RedeemOption[], tx?: Transaction): Transaction;
+}
+
 /**
  * Represents options and configurations for an SDK.
  */
@@ -1908,6 +2013,7 @@ interface SdkOptions extends BaseSdkOptions {
      * The URL for the swap count
      */
     stats_pools_url?: string;
+    clmm_vest?: Package<VestConfigs>;
 }
 /**
  * The entry class of CetusClmmSDK, which is almost responsible for all interactions with CLMM.
@@ -1933,6 +2039,10 @@ declare class CetusClmmSDK extends SdkWrapper<SdkOptions> {
      * Provide  interact with clmm pool and coin and launchpad pool config
      */
     protected _config: ConfigModule;
+    /**
+     * Provide interact with clmm claim
+     */
+    protected _vest: VestModule;
     constructor(options: SdkOptions);
     /**
      * Getter for the Pool property.
@@ -1959,6 +2069,11 @@ declare class CetusClmmSDK extends SdkWrapper<SdkOptions> {
      * @returns {SwapModule} The Swap property value.
      */
     get Swap(): SwapModule;
+    /**
+     * Getter for the Vest property.
+     * @returns {VestModule} The Vest property value.
+     */
+    get Vest(): VestModule;
     static createSDK(options: BaseSdkOptions): CetusClmmSDK;
     /**
      * Create a custom SDK instance with the given options
@@ -1984,7 +2099,7 @@ declare function buildPosition(object: SuiObjectResponse): Position;
  * @param {any} fields - The response containing information about the reward.
  * @returns {PositionReward} - The built PositionReward object.
  */
-declare function buildPositionReward(fields: any): PositionReward;
+declare function buildPositionInfo(fields: any): PositionInfo;
 /**
  * Builds a TickData object based on a response containing information about tick data.
  * It must check if the response contains the required fields.
@@ -2170,6 +2285,14 @@ declare function getLowerSqrtPriceFromCoinB(amount: BN, liquidity: BN, sqrt_pric
  */
 declare function getUpperSqrtPriceFromCoinB(amount: BN, liquidity: BN, sqrt_price_x64: BN): BN;
 
+declare const BPS = 10000;
+declare class VestUtils {
+    static parseClmmVestInfo(res: SuiObjectResponse): ClmmVestInfo;
+    static parsePositionVesting(fields: any): PositionVesting;
+    static parsePoolLiquiditySnapshot(res: SuiObjectResponse): PoolLiquiditySnapshot;
+    static parsePositionSnapshot(res: SuiObjectResponse): PositionSnapshot;
+}
+
 declare function estPoolAPR(pre_block_reward: BN, reward_price: BN, total_trading_fee: BN, total_liquidity_value: BN): BN;
 type estPosAPRResult = {
     fee_apr: Decimal;
@@ -2199,7 +2322,8 @@ declare enum PositionErrorCode {
     InvalidTickEvent = "InvalidTickEvent",
     InvalidPositionObject = "InvalidPositionObject",
     InvalidPositionRewardObject = "InvalidPositionRewardObject",
-    InvalidParams = "InvalidParams"
+    InvalidParams = "InvalidParams",
+    FetchError = "FetchError"
 }
 declare enum PoolErrorCode {
     InvalidCoinTypeSequence = "InvalidCoinTypeSequence",
@@ -2212,6 +2336,10 @@ declare enum PoolErrorCode {
     StatsPoolsUrlNotSet = "StatsPoolsUrlNotSet",
     FetchError = "FetchError"
 }
+declare enum VestErrorCode {
+    ClmmVestNotSet = "ClmmVestNotSet",
+    ClmmVestFetchError = "ClmmVestFetchError"
+}
 declare enum PartnerErrorCode {
     NotFoundPartnerObject = "NotFoundPartnerObject",
     InvalidPartnerRefFeeFields = "InvalidPartnerRefFeeFields"
@@ -2240,7 +2368,7 @@ declare enum RouterErrorCode {
 declare enum TypesErrorCode {
     InvalidType = "InvalidType"
 }
-type ClmmErrorCode = SwapErrorCode | PoolErrorCode | PositionErrorCode | PartnerErrorCode | ConfigErrorCode | UtilsErrorCode | RouterErrorCode | TypesErrorCode;
+type ClmmErrorCode = SwapErrorCode | PoolErrorCode | PositionErrorCode | PartnerErrorCode | ConfigErrorCode | UtilsErrorCode | RouterErrorCode | TypesErrorCode | VestErrorCode;
 declare class ClmmError extends BaseError {
     constructor(message: string, errorCode?: ClmmErrorCode, details?: Record<string, any>);
     static isVaultsErrorCode(e: any, code: ClmmErrorCode): boolean;
@@ -2248,4 +2376,4 @@ declare class ClmmError extends BaseError {
 declare const handleError: (code: ClmmErrorCode, error: Error, details?: Record<string, any>) => never;
 declare const handleMessageError: (code: ClmmErrorCode, message: string, details?: Record<string, any>) => never;
 
-export { AMM_SWAP_MODULE, type AddLiquidityCommonParams, type AddLiquidityFixTokenParams, type AddLiquidityParams, type AddLiquidityWithPriceRangeParams, type AdjustResult, type BasePath, type BigNumber, type Bits, type CalculateAddLiquidityFixCoinWithPriceParams, type CalculateAddLiquidityResult, type CalculateAddLiquidityWithPriceParams, type CalculateCreatePoolResult, type CalculateCreatePoolWithPriceParams, type CalculateRatesParams, type CalculateRatesResult, CetusClmmSDK, type CetusConfigs, type ClmmConfig, ClmmError, type ClmmErrorCode, ClmmExpectSwapModule, ClmmFetcherModule, ClmmIntegratePoolModule, ClmmIntegratePoolV2Module, ClmmIntegratePoolV3Module, ClmmIntegrateRouterModule, ClmmIntegrateRouterWithPartnerModule, ClmmIntegrateUtilsModule, ClmmPartnerModule, type ClmmPoolConfig, ClmmPositionStatus, type ClmmpoolData, type ClosePositionParams, type CoinConfig, type CollectFeeParams, type CollectFeesQuote, type CollectRewarderParams, ConfigErrorCode, ConfigModule, type CreatePartnerEvent, type CreatePoolAddLiquidityParams, type CreatePoolAddLiquidityWithPriceParams, type CreatePoolAndAddLiquidityRowResult, type CreatePoolCustomRangeParams, type CreatePoolParams, type CustomRangeParams, DeepbookClobV2Module, DeepbookCustodianV2Module, DeepbookEndpointsV2Module, type FetchParams, type FetchPosFeeParams, type FetchPosRewardParams, type FullRangeParams, type LaunchpadPoolConfig, type NFT, type OpenPositionParams, type OpenPositionWithPriceParams, POOL_STRUCT, PartnerErrorCode, type Pool, PoolErrorCode, type PoolImmutables, PoolModule, type PoolTransactionInfo, type PosRewarderResult, type Position, PositionErrorCode, PositionModule, type PositionReward, type PositionTransactionInfo, PositionUtils, type PreSwapLpChangeParams, type PreSwapParams, type PreSwapWithMultiPoolParams, type RemoveLiquidityParams, type Rewarder, type RewarderAmountOwned, RewarderModule, RouterErrorCode, type SdkOptions, type SplitPath, type SuiBasicTypes, type SuiInputTypes, type SuiStructTag, type SuiTxArg, SwapErrorCode, type SwapGasEstimateArg, SwapModule, type SwapParams, type SwapResult, type SwapStepResult, SwapUtils, type Tick, type TickData, type TransPreSwapWithMultiPoolParams, TypesErrorCode, UtilsErrorCode, buildClmmPositionName, buildPool, buildPoolTransactionInfo, buildPosition, buildPositionReward, buildPositionTransactionInfo, buildTickData, buildTickDataByEvent, buildTransferCoin, buildTransferCoinToSender, clmmMainnet, clmmTestnet, computeSwap, computeSwapStep, CetusClmmSDK as default, estPoolAPR, type estPosAPRResult, estPositionAPRWithDeltaMethod, estPositionAPRWithMultiMethod, findAdjustCoin, getDefaultSuiInputType, getLowerSqrtPriceFromCoinA, getLowerSqrtPriceFromCoinB, getUpperSqrtPriceFromCoinA, getUpperSqrtPriceFromCoinB, handleError, handleMessageError, newBits, poolFilterEvenTypes, transClmmpoolDataWithoutTicks };
+export { AMM_SWAP_MODULE, type AddLiquidityCommonParams, type AddLiquidityFixTokenParams, type AddLiquidityParams, type AddLiquidityWithPriceRangeParams, type AdjustResult, BPS, type BasePath, type BigNumber, type Bits, type CalculateAddLiquidityFixCoinWithPriceParams, type CalculateAddLiquidityResult, type CalculateAddLiquidityWithPriceParams, type CalculateCreatePoolResult, type CalculateCreatePoolWithPriceParams, type CalculateRatesParams, type CalculateRatesResult, CetusClmmSDK, type CetusConfigs, type ClmmConfig, ClmmError, type ClmmErrorCode, ClmmExpectSwapModule, ClmmFetcherModule, ClmmIntegratePoolModule, ClmmIntegratePoolV2Module, ClmmIntegratePoolV3Module, ClmmIntegrateRouterModule, ClmmIntegrateRouterWithPartnerModule, ClmmIntegrateUtilsModule, ClmmPartnerModule, type ClmmPoolConfig, ClmmPositionStatus, type ClmmVestInfo, type ClmmpoolData, type ClosePositionParams, type CoinConfig, type CollectFeeParams, type CollectFeesQuote, type CollectRewarderParams, ConfigErrorCode, ConfigModule, type CreatePartnerEvent, type CreatePoolAddLiquidityParams, type CreatePoolAddLiquidityWithPriceParams, type CreatePoolAndAddLiquidityRowResult, type CreatePoolCustomRangeParams, type CreatePoolParams, type CustomRangeParams, DeepbookClobV2Module, DeepbookCustodianV2Module, DeepbookEndpointsV2Module, type FetchParams, type FetchPosFeeParams, type FetchPosRewardParams, type FullRangeParams, type GetPositionInfoListParams, type GetPositionVestOption, type GlobalVestingPeriod, type LaunchpadPoolConfig, type NFT, type OpenPositionParams, type OpenPositionWithPriceParams, POOL_STRUCT, PartnerErrorCode, type PeriodDetail, type Pool, PoolErrorCode, type PoolImmutables, type PoolLiquiditySnapshot, PoolModule, type PoolTransactionInfo, type PosRewarderResult, type Position, PositionErrorCode, type PositionInfo, PositionModule, type PositionSnapshot, type PositionTransactionInfo, PositionUtils, type PositionVesting, type PreSwapLpChangeParams, type PreSwapParams, type PreSwapWithMultiPoolParams, type RedeemOption, type RemoveLiquidityParams, type Rewarder, type RewarderAmountOwned, RewarderModule, RouterErrorCode, type SdkOptions, type SplitPath, type SuiBasicTypes, type SuiInputTypes, type SuiStructTag, type SuiTxArg, SwapErrorCode, type SwapGasEstimateArg, SwapModule, type SwapParams, type SwapResult, type SwapStepResult, SwapUtils, type Tick, type TickData, type TransPreSwapWithMultiPoolParams, TypesErrorCode, UtilsErrorCode, type VestConfigs, VestErrorCode, VestModule, VestUtils, buildClmmPositionName, buildPool, buildPoolTransactionInfo, buildPosition, buildPositionInfo, buildPositionTransactionInfo, buildTickData, buildTickDataByEvent, buildTransferCoin, buildTransferCoinToSender, clmmMainnet, clmmTestnet, computeSwap, computeSwapStep, CetusClmmSDK as default, estPoolAPR, type estPosAPRResult, estPositionAPRWithDeltaMethod, estPositionAPRWithMultiMethod, findAdjustCoin, getDefaultSuiInputType, getLowerSqrtPriceFromCoinA, getLowerSqrtPriceFromCoinB, getUpperSqrtPriceFromCoinA, getUpperSqrtPriceFromCoinB, handleError, handleMessageError, newBits, poolFilterEvenTypes, poolLiquiditySnapshotType, transClmmpoolDataWithoutTicks };

package/dist/index.d.ts

@@ -168,6 +168,7 @@ declare function computeSwapStep(currentSqrtPrice: BN, targetSqrtPrice: BN, liqu
  */
 declare function computeSwap(aToB: boolean, byAmountIn: boolean, amount: BN, poolData: ClmmpoolData, swapTicks: Array<TickData>): SwapResult;
 
+declare const poolLiquiditySnapshotType = "position_liquidity_snapshot";
 /**
  * Enumerates the possible status values of a position within a liquidity mining module.
  */
@@ -233,11 +234,11 @@ type Position = {
      * The address type of the second coin in the position.
      */
     coin_type_b: SuiAddressType;
-} & NFT$1 & PositionReward;
+} & NFT$1 & PositionInfo;
 /**
  * Represents reward information associated with a liquidity mining position.
  */
-type PositionReward = {
+type PositionInfo = {
     /**
      * The unique identifier of the position object.
      */
@@ -1038,6 +1039,29 @@ type SwapGasEstimateArg = {
     swap_ticks: Array<TickData>;
     current_pool: Pool;
 };
+type GetPositionInfoListParams = {
+    position_handle: string;
+    position_ids: string[];
+};
+type PoolLiquiditySnapshot = {
+    current_sqrt_price: string;
+    remove_percent: string;
+    snapshots: {
+        id: string;
+        size: string;
+    };
+    position_snapshots?: PositionSnapshot[];
+};
+type PositionSnapshot = {
+    position_id: string;
+    liquidity: string;
+    tick_lower_index: number;
+    tick_upper_index: number;
+    fee_owned_a: string;
+    fee_owned_b: string;
+    value_cut: string;
+    rewards: string[];
+};
 
 /**
  * Represents configurations specific to the Cetus protocol.
@@ -1320,6 +1344,55 @@ type SuiInputTypes = 'object' | SuiBasicTypes;
  */
 declare const getDefaultSuiInputType: (value: any) => SuiInputTypes;
 
+type VestConfigs = {
+    versioned_id: string;
+    clmm_vest_id: string;
+    cetus_coin_type: string;
+};
+type GlobalVestingPeriod = {
+    period: number;
+    release_time: string;
+    redeemed_amount: string;
+    percentage: string;
+};
+type ClmmVestInfo = {
+    id: string;
+    balance: string;
+    global_vesting_periods: GlobalVestingPeriod[];
+    total_value: string;
+    total_cetus_amount: string;
+    redeemed_amount: string;
+    start_time: string;
+    type: string;
+    positions: {
+        id: string;
+        size: string;
+    };
+};
+type PeriodDetail = {
+    period: number;
+    cetus_amount: string;
+    is_redeemed: boolean;
+};
+type PositionVesting = {
+    position_id: string;
+    cetus_amount: string;
+    redeemed_amount: string;
+    is_paused: boolean;
+    impaired_a: string;
+    impaired_b: string;
+    period_details: PeriodDetail[];
+} & CoinPairType;
+type RedeemOption = {
+    clmm_pool_id: string;
+    clmm_position_id: string;
+    period: number;
+} & CoinPairType;
+type GetPositionVestOption = {
+    clmm_pool_id: string;
+    clmm_position_ids: string[];
+} & CoinPairType;
+
 type BigNumber = Decimal.Value | number | string;
 
 /**
@@ -1439,6 +1512,13 @@ declare class PoolModule implements IModule<CetusClmmSDK> {
      * @returns {Promise<Pool[]>} An array of Pool objects.
      */
     getPoolsWithPage(pagination_args?: PaginationArgs, force_refresh?: boolean): Promise<DataPage<Pool>>;
+    /**
+     * Get the liquidity snapshot of a pool.
+     * @param pool_id The ID of the pool.
+     * @returns The liquidity snapshot of the pool.
+     */
+    getPoolLiquiditySnapshot(pool_id: string, show_details?: boolean): Promise<PoolLiquiditySnapshot>;
+    getPositionSnapshot(snapshot_handle: string, pos_ids: string[]): Promise<PositionSnapshot[]>;
     /**
      * Gets a list of pools.
      * @param {string[]} assign_pools An array of pool ID to get.
@@ -1512,7 +1592,7 @@ declare class PoolModule implements IModule<CetusClmmSDK> {
      * @param {FetchParams} params The parameters for the fetch.
      * @returns {Promise<PositionReward[]>} A promise that resolves to an array of position rewards.
      */
-    fetchPositionRewardList(params: FetchParams): Promise<PositionReward[]>;
+    fetchPoolPositionInfoList(params: FetchParams): Promise<PositionInfo[]>;
     /**
      * Fetches ticks from the fullnode using the RPC API.
      * @param {string} tick_handle The handle for the tick. Get tick handle from `sdk.Pool.getPool()`
@@ -1626,19 +1706,20 @@ declare class PositionModule implements IModule<CetusClmmSDK> {
      */
     getSimplePositionList(position_ids: SuiObjectIdType[], show_display?: boolean): Promise<Position[]>;
     /**
-     * Updates the rewarders of position
+     * Updates the position info
      * @param {string} position_handle Position handle
      * @param {Position} position Position object
      * @returns {Promise<Position>} A promise that resolves to an array of Position objects.
      */
-    private updatePositionRewarders;
+    updatePositionInfo(position_handle: string, position: Position): Promise<Position>;
     /**
-     * Gets the position rewarders for the given position handle and position object ID.
+     * Gets the position info for the given position handle and position object ID.
      * @param {string} position_handle The handle of the position.
      * @param {string} position_id The ID of the position object.
-     * @returns {Promise<PositionReward | undefined>} PositionReward object.
+     * @returns {Promise<PositionInfo>} PositionInfo object.
      */
-    getPositionRewarders(position_handle: string, position_id: string): Promise<PositionReward | undefined>;
+    getPositionInfo(position_handle: string, position_id: string): Promise<PositionInfo>;
+    getPositionInfoList(options: GetPositionInfoListParams[]): Promise<PositionInfo[]>;
     buildFetchPosFee(params: FetchPosFeeParams, tx: Transaction): void;
     parsedPosFeeData(simulate_res: DevInspectResults): Record<string, {
         position_id: string;
@@ -1888,6 +1969,30 @@ declare class SwapModule implements IModule<CetusClmmSDK> {
     }>;
 }
 
+declare class VestModule implements IModule<CetusClmmSDK> {
+    protected _sdk: CetusClmmSDK;
+    constructor(sdk: CetusClmmSDK);
+    get sdk(): CetusClmmSDK;
+    /**
+     * Get the clmm vest info list
+     * @returns {Promise<ClmmVestInfo[]>} The clmm vest info list
+     */
+    getClmmVestInfoList(): Promise<ClmmVestInfo[]>;
+    /**
+     * Get the clmm vest info
+     * @param vest_id - The vest id
+     * @returns {Promise<ClmmVestInfo>} The clmm vest info
+     */
+    getClmmVestInfo(force_refresh?: boolean): Promise<ClmmVestInfo>;
+    getPositionVesting(options: GetPositionVestOption[]): Promise<PositionVesting[]>;
+    /**
+     * Build the redeem payload
+     * @param options - The redeem options
+     * @returns {Transaction} The redeem payload
+     */
+    buildRedeemPayload(options: RedeemOption[], tx?: Transaction): Transaction;
+}
+
 /**
  * Represents options and configurations for an SDK.
  */
@@ -1908,6 +2013,7 @@ interface SdkOptions extends BaseSdkOptions {
      * The URL for the swap count
      */
     stats_pools_url?: string;
+    clmm_vest?: Package<VestConfigs>;
 }
 /**
  * The entry class of CetusClmmSDK, which is almost responsible for all interactions with CLMM.
@@ -1933,6 +2039,10 @@ declare class CetusClmmSDK extends SdkWrapper<SdkOptions> {
      * Provide  interact with clmm pool and coin and launchpad pool config
      */
     protected _config: ConfigModule;
+    /**
+     * Provide interact with clmm claim
+     */
+    protected _vest: VestModule;
     constructor(options: SdkOptions);
     /**
      * Getter for the Pool property.
@@ -1959,6 +2069,11 @@ declare class CetusClmmSDK extends SdkWrapper<SdkOptions> {
      * @returns {SwapModule} The Swap property value.
      */
     get Swap(): SwapModule;
+    /**
+     * Getter for the Vest property.
+     * @returns {VestModule} The Vest property value.
+     */
+    get Vest(): VestModule;
     static createSDK(options: BaseSdkOptions): CetusClmmSDK;
     /**
      * Create a custom SDK instance with the given options
@@ -1984,7 +2099,7 @@ declare function buildPosition(object: SuiObjectResponse): Position;
  * @param {any} fields - The response containing information about the reward.
  * @returns {PositionReward} - The built PositionReward object.
  */
-declare function buildPositionReward(fields: any): PositionReward;
+declare function buildPositionInfo(fields: any): PositionInfo;
 /**
  * Builds a TickData object based on a response containing information about tick data.
  * It must check if the response contains the required fields.
@@ -2170,6 +2285,14 @@ declare function getLowerSqrtPriceFromCoinB(amount: BN, liquidity: BN, sqrt_pric
  */
 declare function getUpperSqrtPriceFromCoinB(amount: BN, liquidity: BN, sqrt_price_x64: BN): BN;
 
+declare const BPS = 10000;
+declare class VestUtils {
+    static parseClmmVestInfo(res: SuiObjectResponse): ClmmVestInfo;
+    static parsePositionVesting(fields: any): PositionVesting;
+    static parsePoolLiquiditySnapshot(res: SuiObjectResponse): PoolLiquiditySnapshot;
+    static parsePositionSnapshot(res: SuiObjectResponse): PositionSnapshot;
+}
+
 declare function estPoolAPR(pre_block_reward: BN, reward_price: BN, total_trading_fee: BN, total_liquidity_value: BN): BN;
 type estPosAPRResult = {
     fee_apr: Decimal;
@@ -2199,7 +2322,8 @@ declare enum PositionErrorCode {
     InvalidTickEvent = "InvalidTickEvent",
     InvalidPositionObject = "InvalidPositionObject",
     InvalidPositionRewardObject = "InvalidPositionRewardObject",
-    InvalidParams = "InvalidParams"
+    InvalidParams = "InvalidParams",
+    FetchError = "FetchError"
 }
 declare enum PoolErrorCode {
     InvalidCoinTypeSequence = "InvalidCoinTypeSequence",
@@ -2212,6 +2336,10 @@ declare enum PoolErrorCode {
     StatsPoolsUrlNotSet = "StatsPoolsUrlNotSet",
     FetchError = "FetchError"
 }
+declare enum VestErrorCode {
+    ClmmVestNotSet = "ClmmVestNotSet",
+    ClmmVestFetchError = "ClmmVestFetchError"
+}
 declare enum PartnerErrorCode {
     NotFoundPartnerObject = "NotFoundPartnerObject",
     InvalidPartnerRefFeeFields = "InvalidPartnerRefFeeFields"
@@ -2240,7 +2368,7 @@ declare enum RouterErrorCode {
 declare enum TypesErrorCode {
     InvalidType = "InvalidType"
 }
-type ClmmErrorCode = SwapErrorCode | PoolErrorCode | PositionErrorCode | PartnerErrorCode | ConfigErrorCode | UtilsErrorCode | RouterErrorCode | TypesErrorCode;
+type ClmmErrorCode = SwapErrorCode | PoolErrorCode | PositionErrorCode | PartnerErrorCode | ConfigErrorCode | UtilsErrorCode | RouterErrorCode | TypesErrorCode | VestErrorCode;
 declare class ClmmError extends BaseError {
     constructor(message: string, errorCode?: ClmmErrorCode, details?: Record<string, any>);
     static isVaultsErrorCode(e: any, code: ClmmErrorCode): boolean;
@@ -2248,4 +2376,4 @@ declare class ClmmError extends BaseError {
 declare const handleError: (code: ClmmErrorCode, error: Error, details?: Record<string, any>) => never;
 declare const handleMessageError: (code: ClmmErrorCode, message: string, details?: Record<string, any>) => never;
 
-export { AMM_SWAP_MODULE, type AddLiquidityCommonParams, type AddLiquidityFixTokenParams, type AddLiquidityParams, type AddLiquidityWithPriceRangeParams, type AdjustResult, type BasePath, type BigNumber, type Bits, type CalculateAddLiquidityFixCoinWithPriceParams, type CalculateAddLiquidityResult, type CalculateAddLiquidityWithPriceParams, type CalculateCreatePoolResult, type CalculateCreatePoolWithPriceParams, type CalculateRatesParams, type CalculateRatesResult, CetusClmmSDK, type CetusConfigs, type ClmmConfig, ClmmError, type ClmmErrorCode, ClmmExpectSwapModule, ClmmFetcherModule, ClmmIntegratePoolModule, ClmmIntegratePoolV2Module, ClmmIntegratePoolV3Module, ClmmIntegrateRouterModule, ClmmIntegrateRouterWithPartnerModule, ClmmIntegrateUtilsModule, ClmmPartnerModule, type ClmmPoolConfig, ClmmPositionStatus, type ClmmpoolData, type ClosePositionParams, type CoinConfig, type CollectFeeParams, type CollectFeesQuote, type CollectRewarderParams, ConfigErrorCode, ConfigModule, type CreatePartnerEvent, type CreatePoolAddLiquidityParams, type CreatePoolAddLiquidityWithPriceParams, type CreatePoolAndAddLiquidityRowResult, type CreatePoolCustomRangeParams, type CreatePoolParams, type CustomRangeParams, DeepbookClobV2Module, DeepbookCustodianV2Module, DeepbookEndpointsV2Module, type FetchParams, type FetchPosFeeParams, type FetchPosRewardParams, type FullRangeParams, type LaunchpadPoolConfig, type NFT, type OpenPositionParams, type OpenPositionWithPriceParams, POOL_STRUCT, PartnerErrorCode, type Pool, PoolErrorCode, type PoolImmutables, PoolModule, type PoolTransactionInfo, type PosRewarderResult, type Position, PositionErrorCode, PositionModule, type PositionReward, type PositionTransactionInfo, PositionUtils, type PreSwapLpChangeParams, type PreSwapParams, type PreSwapWithMultiPoolParams, type RemoveLiquidityParams, type Rewarder, type RewarderAmountOwned, RewarderModule, RouterErrorCode, type SdkOptions, type SplitPath, type SuiBasicTypes, type SuiInputTypes, type SuiStructTag, type SuiTxArg, SwapErrorCode, type SwapGasEstimateArg, SwapModule, type SwapParams, type SwapResult, type SwapStepResult, SwapUtils, type Tick, type TickData, type TransPreSwapWithMultiPoolParams, TypesErrorCode, UtilsErrorCode, buildClmmPositionName, buildPool, buildPoolTransactionInfo, buildPosition, buildPositionReward, buildPositionTransactionInfo, buildTickData, buildTickDataByEvent, buildTransferCoin, buildTransferCoinToSender, clmmMainnet, clmmTestnet, computeSwap, computeSwapStep, CetusClmmSDK as default, estPoolAPR, type estPosAPRResult, estPositionAPRWithDeltaMethod, estPositionAPRWithMultiMethod, findAdjustCoin, getDefaultSuiInputType, getLowerSqrtPriceFromCoinA, getLowerSqrtPriceFromCoinB, getUpperSqrtPriceFromCoinA, getUpperSqrtPriceFromCoinB, handleError, handleMessageError, newBits, poolFilterEvenTypes, transClmmpoolDataWithoutTicks };
+export { AMM_SWAP_MODULE, type AddLiquidityCommonParams, type AddLiquidityFixTokenParams, type AddLiquidityParams, type AddLiquidityWithPriceRangeParams, type AdjustResult, BPS, type BasePath, type BigNumber, type Bits, type CalculateAddLiquidityFixCoinWithPriceParams, type CalculateAddLiquidityResult, type CalculateAddLiquidityWithPriceParams, type CalculateCreatePoolResult, type CalculateCreatePoolWithPriceParams, type CalculateRatesParams, type CalculateRatesResult, CetusClmmSDK, type CetusConfigs, type ClmmConfig, ClmmError, type ClmmErrorCode, ClmmExpectSwapModule, ClmmFetcherModule, ClmmIntegratePoolModule, ClmmIntegratePoolV2Module, ClmmIntegratePoolV3Module, ClmmIntegrateRouterModule, ClmmIntegrateRouterWithPartnerModule, ClmmIntegrateUtilsModule, ClmmPartnerModule, type ClmmPoolConfig, ClmmPositionStatus, type ClmmVestInfo, type ClmmpoolData, type ClosePositionParams, type CoinConfig, type CollectFeeParams, type CollectFeesQuote, type CollectRewarderParams, ConfigErrorCode, ConfigModule, type CreatePartnerEvent, type CreatePoolAddLiquidityParams, type CreatePoolAddLiquidityWithPriceParams, type CreatePoolAndAddLiquidityRowResult, type CreatePoolCustomRangeParams, type CreatePoolParams, type CustomRangeParams, DeepbookClobV2Module, DeepbookCustodianV2Module, DeepbookEndpointsV2Module, type FetchParams, type FetchPosFeeParams, type FetchPosRewardParams, type FullRangeParams, type GetPositionInfoListParams, type GetPositionVestOption, type GlobalVestingPeriod, type LaunchpadPoolConfig, type NFT, type OpenPositionParams, type OpenPositionWithPriceParams, POOL_STRUCT, PartnerErrorCode, type PeriodDetail, type Pool, PoolErrorCode, type PoolImmutables, type PoolLiquiditySnapshot, PoolModule, type PoolTransactionInfo, type PosRewarderResult, type Position, PositionErrorCode, type PositionInfo, PositionModule, type PositionSnapshot, type PositionTransactionInfo, PositionUtils, type PositionVesting, type PreSwapLpChangeParams, type PreSwapParams, type PreSwapWithMultiPoolParams, type RedeemOption, type RemoveLiquidityParams, type Rewarder, type RewarderAmountOwned, RewarderModule, RouterErrorCode, type SdkOptions, type SplitPath, type SuiBasicTypes, type SuiInputTypes, type SuiStructTag, type SuiTxArg, SwapErrorCode, type SwapGasEstimateArg, SwapModule, type SwapParams, type SwapResult, type SwapStepResult, SwapUtils, type Tick, type TickData, type TransPreSwapWithMultiPoolParams, TypesErrorCode, UtilsErrorCode, type VestConfigs, VestErrorCode, VestModule, VestUtils, buildClmmPositionName, buildPool, buildPoolTransactionInfo, buildPosition, buildPositionInfo, buildPositionTransactionInfo, buildTickData, buildTickDataByEvent, buildTransferCoin, buildTransferCoinToSender, clmmMainnet, clmmTestnet, computeSwap, computeSwapStep, CetusClmmSDK as default, estPoolAPR, type estPosAPRResult, estPositionAPRWithDeltaMethod, estPositionAPRWithMultiMethod, findAdjustCoin, getDefaultSuiInputType, getLowerSqrtPriceFromCoinA, getLowerSqrtPriceFromCoinB, getUpperSqrtPriceFromCoinA, getUpperSqrtPriceFromCoinB, handleError, handleMessageError, newBits, poolFilterEvenTypes, poolLiquiditySnapshotType, transClmmpoolDataWithoutTicks };