@cetusprotocol/sui-clmm-sdk 1.4.2 → 1.4.4

package/dist/index.d.ts

@@ -1615,6 +1615,19 @@ declare class PoolModule implements IModule<CetusClmmSDK> {
     protected _sdk: CetusClmmSDK;
     constructor(sdk: CetusClmmSDK);
     get sdk(): CetusClmmSDK;
+    /**
+     * Computes the pool key ID for (coin_type_a, coin_type_b, tick_spacing).
+     * Matches `cetus_clmm::factory::new_pool_key`. Coin types must satisfy coin_type_a > coin_type_b.
+     */
+    buildPoolKey(coin_type_a: string, coin_type_b: string, tick_spacing: number): string;
+    /**
+     * Resolves a pool object ID from coin types and tick spacing via the factory pools indexer.
+     */
+    getPoolAddress(coin_type_a: string, coin_type_b: string, tick_spacing: number): Promise<string | undefined>;
+    /**
+     * Returns the linked table handle that indexes pools by pool key.
+     */
+    private getPoolsListHandle;
     /**
      * Gets a list of positions for the given positionHandle.
      * @param {string} position_handle The handle for the position.
@@ -2288,6 +2301,12 @@ declare class PositionUtils {
     static checkCoinThreshold(sdk: CetusClmmSDK, by_amount_in: boolean, tx: Transaction, coin: TransactionObjectArgument, amount_limit: number, coin_type: string): void;
 }
 
+/**
+ * Computes the CLMM pool key ID, matching `cetus_clmm::factory::new_pool_key`.
+ * Coin types must be in canonical order: coin_type_a > coin_type_b (lexicographic).
+ */
+declare function buildPoolKey(coin_type_a: string, coin_type_b: string, tick_spacing: number): string;
+
 declare class SwapUtils {
     /**
      * Get the default sqrt price limit for a swap.
@@ -2530,6 +2549,32 @@ declare const FetchPositionFeesEventRaw: _mysten_sui_bcs.BcsStruct<{
     fee_owned_a: _mysten_sui_bcs.BcsType<string, string | number | bigint, "u64">;
     fee_owned_b: _mysten_sui_bcs.BcsType<string, string | number | bigint, "u64">;
 }, string>;
+declare const PoolSimpleInfoRaw: _mysten_sui_bcs.BcsStruct<{
+    pool_id: _mysten_sui_bcs.BcsType<string, string | Uint8Array<ArrayBufferLike>, "bytes[32]">;
+    pool_key: _mysten_sui_bcs.BcsType<string, string | Uint8Array<ArrayBufferLike>, "bytes[32]">;
+    coin_type_a: _mysten_sui_bcs.BcsStruct<{
+        name: _mysten_sui_bcs.BcsType<string, string, "string">;
+    }, string>;
+    coin_type_b: _mysten_sui_bcs.BcsStruct<{
+        name: _mysten_sui_bcs.BcsType<string, string, "string">;
+    }, string>;
+    tick_spacing: _mysten_sui_bcs.BcsType<number, number, "u32">;
+}, string>;
+declare const NodeIDPoolSimpleInfo: _mysten_sui_bcs.BcsStruct<{
+    prev: _mysten_sui_bcs.BcsType<Uint8Array<ArrayBufferLike> | null, Iterable<number> | null | undefined, "Option<bytes[32]>">;
+    next: _mysten_sui_bcs.BcsType<Uint8Array<ArrayBufferLike> | null, Iterable<number> | null | undefined, "Option<bytes[32]>">;
+    value: _mysten_sui_bcs.BcsStruct<{
+        pool_id: _mysten_sui_bcs.BcsType<string, string | Uint8Array<ArrayBufferLike>, "bytes[32]">;
+        pool_key: _mysten_sui_bcs.BcsType<string, string | Uint8Array<ArrayBufferLike>, "bytes[32]">;
+        coin_type_a: _mysten_sui_bcs.BcsStruct<{
+            name: _mysten_sui_bcs.BcsType<string, string, "string">;
+        }, string>;
+        coin_type_b: _mysten_sui_bcs.BcsStruct<{
+            name: _mysten_sui_bcs.BcsType<string, string, "string">;
+        }, string>;
+        tick_spacing: _mysten_sui_bcs.BcsType<number, number, "u32">;
+    }, string>;
+}, string>;
 declare const CalculatedSwapResultEventRaw: _mysten_sui_bcs.BcsStruct<{
     data: _mysten_sui_bcs.BcsStruct<{
         amount_in: _mysten_sui_bcs.BcsType<string, string | number | bigint, "u64">;
@@ -2619,6 +2664,7 @@ declare enum PositionErrorCode {
     FetchError = "FetchError"
 }
 declare enum PoolErrorCode {
+    SameCoinType = "SameCoinType",
     InvalidCoinTypeSequence = "InvalidCoinTypeSequence",
     InvalidTickIndex = "InvalidTickIndex",
     InvalidPoolObject = "InvalidPoolObject",
@@ -2669,4 +2715,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, CalculatedSwapResultEventRaw, CetusClmmSDK, type CetusConfigs, type ClmmConfig, ClmmError, type ClmmErrorCode, ClmmExpectSwapModule, ClmmFetcherModule, ClmmIntegratePoolModule, ClmmIntegratePoolV2Module, ClmmIntegratePoolV3Module, ClmmIntegrateRouterModule, ClmmIntegrateRouterWithPartnerModule, ClmmIntegrateUtilsModule, ClmmPartnerModule, ClmmPool, type ClmmPoolConfig, ClmmPositionStatus, type ClmmVestInfo, type ClmmpoolData, type ClosePositionParams, Coin, 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, FetchPositionFeesEventRaw, FetchPositionRewardsEventRaw, FetchPositionsEventRaw, FetchTicksResultEventRaw, type FullRangeParams, type GetPositionInfoListParams, type GetPositionVestOption, GetPositionsVestingEventRaw, type GlobalVestingPeriod, LaunchpadPool, type LaunchpadPoolConfig, MediaInfo, type NFT, NodeIDPositionInfo, 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, PositionInfoRaw, PositionModule, PositionRewardRaw, 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, TickRaw, 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, CalculatedSwapResultEventRaw, CetusClmmSDK, type CetusConfigs, type ClmmConfig, ClmmError, type ClmmErrorCode, ClmmExpectSwapModule, ClmmFetcherModule, ClmmIntegratePoolModule, ClmmIntegratePoolV2Module, ClmmIntegratePoolV3Module, ClmmIntegrateRouterModule, ClmmIntegrateRouterWithPartnerModule, ClmmIntegrateUtilsModule, ClmmPartnerModule, ClmmPool, type ClmmPoolConfig, ClmmPositionStatus, type ClmmVestInfo, type ClmmpoolData, type ClosePositionParams, Coin, 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, FetchPositionFeesEventRaw, FetchPositionRewardsEventRaw, FetchPositionsEventRaw, FetchTicksResultEventRaw, type FullRangeParams, type GetPositionInfoListParams, type GetPositionVestOption, GetPositionsVestingEventRaw, type GlobalVestingPeriod, LaunchpadPool, type LaunchpadPoolConfig, MediaInfo, type NFT, NodeIDPoolSimpleInfo, NodeIDPositionInfo, type OpenPositionParams, type OpenPositionWithPriceParams, POOL_STRUCT, PartnerErrorCode, type PeriodDetail, type Pool, PoolErrorCode, type PoolImmutables, type PoolLiquiditySnapshot, PoolModule, PoolSimpleInfoRaw, type PoolStatus, type PoolTransactionInfo, type PosRewarderResult, type Position, PositionErrorCode, type PositionInfo, PositionInfoRaw, PositionModule, PositionRewardRaw, 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, TickRaw, type TransPreSwapWithMultiPoolParams, TypesErrorCode, UtilsErrorCode, type VestConfigs, VestErrorCode, VestModule, VestUtils, buildClmmPositionName, buildPool, buildPoolKey, 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 };