@cetusprotocol/sui-clmm-sdk 1.2.7 → 1.3.0

package/dist/index.d.mts

@@ -3,6 +3,7 @@ import { TransactionArgument, TransactionObjectArgument, Transaction } from '@my
 import BN from 'bn.js';
 import Decimal from 'decimal.js';
 import { DevInspectResults, SuiObjectResponse, SuiTransactionBlockResponse } from '@mysten/sui/client';
+import * as _mysten_sui_dist_cjs_transactions from '@mysten/sui/dist/cjs/transactions';
 
 type BasePath = {
     direction: boolean;
@@ -720,6 +721,10 @@ type RemoveLiquidityParams = CoinPairType & CommonParams & {
      * Coin types associated with rewarder contracts.
      */
     rewarder_coin_types: string[];
+    /**
+     * Indicates whether to return the coins.
+     */
+    is_return_coins?: boolean;
 };
 /**
  * Parameters for closing a position within a liquidity pool.
@@ -768,6 +773,23 @@ type CollectRewarderParams = {
      */
     rewarder_coin_types: SuiAddressType[];
 } & CoinPairType;
+/**
+ * Represents parameters for collecting rewarder and return coin.
+ */
+type CollectRewarderAndReturnCoinParams = {
+    /**
+     * The identifier of the pool.
+     */
+    pool_id: SuiObjectIdType;
+    /**
+     * The identifier of the position.
+     */
+    pos_id: SuiObjectIdType;
+    /**
+     * An array of rewarder coin types.
+     */
+    rewarder_coin_type: SuiAddressType;
+} & CoinPairType;
 /**
  * Represents the amount owned by a rewarder.
  */
@@ -1781,7 +1803,10 @@ declare class PositionModule implements IModule<CetusClmmSDK> {
      * @param {RemoveLiquidityParams} params
      * @returns {TransactionBlock}
      */
-    removeLiquidityPayload(params: RemoveLiquidityParams, tx?: Transaction): Promise<Transaction>;
+    removeLiquidityPayload(params: RemoveLiquidityParams, tx?: Transaction): Promise<Transaction | {
+        coin_a: TransactionObjectArgument;
+        coin_b: TransactionObjectArgument;
+    }>;
     /**
      * Close position and remove all liquidity and collect_reward
      * @param {ClosePositionParams} params
@@ -1829,6 +1854,16 @@ declare class PositionModule implements IModule<CetusClmmSDK> {
      */
     createAddLiquidityFixCoinWithPricePayload(params: AddLiquidityWithPriceRangeParams, tx?: Transaction, input_coin_a?: TransactionObjectArgument, input_coin_b?: TransactionObjectArgument): Promise<Transaction>;
     createCollectFeeNoSendPayload(params: CollectFeeParams, tx: Transaction, primary_coin_a_input: TransactionObjectArgument, primary_coin_b_input: TransactionObjectArgument): Transaction;
+    createCollectFeeAndReturnCoinsPayload(params: CollectFeeParams, tx: Transaction): {
+        fee_a: {
+            $kind: "NestedResult";
+            NestedResult: [number, number];
+        };
+        fee_b: {
+            $kind: "NestedResult";
+            NestedResult: [number, number];
+        };
+    };
 }
 
 /**
@@ -1911,6 +1946,7 @@ declare class RewarderModule implements IModule<CetusClmmSDK> {
     batchCollectRewardsPayload(params: CollectRewarderParams[], tx?: Transaction, input_coin_a?: TransactionObjectArgument, input_coin_b?: TransactionObjectArgument): Promise<Transaction>;
     createCollectRewarderPayload(params: CollectRewarderParams, tx: Transaction, primary_coin_inputs: TransactionArgument[]): Transaction;
     createCollectRewarderNoSendPayload(params: CollectRewarderParams, tx: Transaction, primary_coin_inputs: TransactionArgument[]): Transaction;
+    createCollectRewarderAndReturnCoinPayload(params: CollectRewarderAndReturnCoinParams, tx: Transaction): _mysten_sui_dist_cjs_transactions.TransactionResult;
 }
 
 declare const AMM_SWAP_MODULE = "amm_swap";
@@ -2399,4 +2435,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, 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 PoolStatus, 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, eventMainnetContractMaps, eventTestnetContractMaps, findAdjustCoin, getDefaultSuiInputType, getLowerSqrtPriceFromCoinA, getLowerSqrtPriceFromCoinB, getUpperSqrtPriceFromCoinA, getUpperSqrtPriceFromCoinB, handleError, handleMessageError, newBits, poolFilterEvenTypes, poolLiquiditySnapshotType, 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 CollectRewarderAndReturnCoinParams, 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 PoolStatus, 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, eventMainnetContractMaps, eventTestnetContractMaps, findAdjustCoin, getDefaultSuiInputType, getLowerSqrtPriceFromCoinA, getLowerSqrtPriceFromCoinB, getUpperSqrtPriceFromCoinA, getUpperSqrtPriceFromCoinB, handleError, handleMessageError, newBits, poolFilterEvenTypes, poolLiquiditySnapshotType, transClmmpoolDataWithoutTicks };

package/dist/index.d.ts

@@ -3,6 +3,7 @@ import { TransactionArgument, TransactionObjectArgument, Transaction } from '@my
 import BN from 'bn.js';
 import Decimal from 'decimal.js';
 import { DevInspectResults, SuiObjectResponse, SuiTransactionBlockResponse } from '@mysten/sui/client';
+import * as _mysten_sui_dist_cjs_transactions from '@mysten/sui/dist/cjs/transactions';
 
 type BasePath = {
     direction: boolean;
@@ -720,6 +721,10 @@ type RemoveLiquidityParams = CoinPairType & CommonParams & {
      * Coin types associated with rewarder contracts.
      */
     rewarder_coin_types: string[];
+    /**
+     * Indicates whether to return the coins.
+     */
+    is_return_coins?: boolean;
 };
 /**
  * Parameters for closing a position within a liquidity pool.
@@ -768,6 +773,23 @@ type CollectRewarderParams = {
      */
     rewarder_coin_types: SuiAddressType[];
 } & CoinPairType;
+/**
+ * Represents parameters for collecting rewarder and return coin.
+ */
+type CollectRewarderAndReturnCoinParams = {
+    /**
+     * The identifier of the pool.
+     */
+    pool_id: SuiObjectIdType;
+    /**
+     * The identifier of the position.
+     */
+    pos_id: SuiObjectIdType;
+    /**
+     * An array of rewarder coin types.
+     */
+    rewarder_coin_type: SuiAddressType;
+} & CoinPairType;
 /**
  * Represents the amount owned by a rewarder.
  */
@@ -1781,7 +1803,10 @@ declare class PositionModule implements IModule<CetusClmmSDK> {
      * @param {RemoveLiquidityParams} params
      * @returns {TransactionBlock}
      */
-    removeLiquidityPayload(params: RemoveLiquidityParams, tx?: Transaction): Promise<Transaction>;
+    removeLiquidityPayload(params: RemoveLiquidityParams, tx?: Transaction): Promise<Transaction | {
+        coin_a: TransactionObjectArgument;
+        coin_b: TransactionObjectArgument;
+    }>;
     /**
      * Close position and remove all liquidity and collect_reward
      * @param {ClosePositionParams} params
@@ -1829,6 +1854,16 @@ declare class PositionModule implements IModule<CetusClmmSDK> {
      */
     createAddLiquidityFixCoinWithPricePayload(params: AddLiquidityWithPriceRangeParams, tx?: Transaction, input_coin_a?: TransactionObjectArgument, input_coin_b?: TransactionObjectArgument): Promise<Transaction>;
     createCollectFeeNoSendPayload(params: CollectFeeParams, tx: Transaction, primary_coin_a_input: TransactionObjectArgument, primary_coin_b_input: TransactionObjectArgument): Transaction;
+    createCollectFeeAndReturnCoinsPayload(params: CollectFeeParams, tx: Transaction): {
+        fee_a: {
+            $kind: "NestedResult";
+            NestedResult: [number, number];
+        };
+        fee_b: {
+            $kind: "NestedResult";
+            NestedResult: [number, number];
+        };
+    };
 }
 
 /**
@@ -1911,6 +1946,7 @@ declare class RewarderModule implements IModule<CetusClmmSDK> {
     batchCollectRewardsPayload(params: CollectRewarderParams[], tx?: Transaction, input_coin_a?: TransactionObjectArgument, input_coin_b?: TransactionObjectArgument): Promise<Transaction>;
     createCollectRewarderPayload(params: CollectRewarderParams, tx: Transaction, primary_coin_inputs: TransactionArgument[]): Transaction;
     createCollectRewarderNoSendPayload(params: CollectRewarderParams, tx: Transaction, primary_coin_inputs: TransactionArgument[]): Transaction;
+    createCollectRewarderAndReturnCoinPayload(params: CollectRewarderAndReturnCoinParams, tx: Transaction): _mysten_sui_dist_cjs_transactions.TransactionResult;
 }
 
 declare const AMM_SWAP_MODULE = "amm_swap";
@@ -2399,4 +2435,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, 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 PoolStatus, 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, eventMainnetContractMaps, eventTestnetContractMaps, findAdjustCoin, getDefaultSuiInputType, getLowerSqrtPriceFromCoinA, getLowerSqrtPriceFromCoinB, getUpperSqrtPriceFromCoinA, getUpperSqrtPriceFromCoinB, handleError, handleMessageError, newBits, poolFilterEvenTypes, poolLiquiditySnapshotType, 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 CollectRewarderAndReturnCoinParams, 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 PoolStatus, 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, eventMainnetContractMaps, eventTestnetContractMaps, findAdjustCoin, getDefaultSuiInputType, getLowerSqrtPriceFromCoinA, getLowerSqrtPriceFromCoinB, getUpperSqrtPriceFromCoinA, getUpperSqrtPriceFromCoinB, handleError, handleMessageError, newBits, poolFilterEvenTypes, poolLiquiditySnapshotType, transClmmpoolDataWithoutTicks };