@cetusprotocol/deepbook-utils 1.2.0 → 1.4.0

package/dist/index.d.ts

@@ -270,6 +270,87 @@ type MarginPoolInfo = {
     baseCoin: MarginCoinInfo;
     quoteCoin: MarginCoinInfo;
 };
+type PendingMarketOrderOptions = {
+    client_order_id: string;
+    self_matching_option: SelfMatchingOption;
+    quantity: string;
+    is_bid: boolean;
+    pay_with_deep: boolean;
+};
+type PendingLimitOrderOptions = {
+    client_order_id: string;
+    order_type: OrderType;
+    self_matching_option: SelfMatchingOption;
+    price: string;
+    quantity: string;
+    is_bid: boolean;
+    pay_with_deep: boolean;
+    expire_timestamp: string;
+};
+type AddConditionalOrderOptions = {
+    margin_manager_id: string;
+    pool_id: string;
+    base_coin: MarginCoinInfo;
+    quote_coin: MarginCoinInfo;
+    conditional_order_id: string;
+    is_trigger_below_price: boolean;
+    trigger_price: string;
+    pending_order: PendingMarketOrderOptions | PendingLimitOrderOptions;
+};
+type CancelAllConditionalOrdersOptions = {
+    margin_manager_id: string;
+    base_coin_type: string;
+    quote_coin_type: string;
+};
+type CancelConditionalOrdersOptions = {
+    margin_manager_id: string;
+    base_coin_type: string;
+    quote_coin_type: string;
+    conditional_order_id: string;
+};
+type GetConditionalOrdersOptions = {
+    margin_manager_id: string;
+    conditional_order_ids: string[];
+    base_coin_type: string;
+    quote_coin_type: string;
+};
+type GetConditionalIdsOptions = {
+    margin_manager_id: string;
+    base_coin_type: string;
+    quote_coin_type: string;
+};
+type GetConditionalOrderIdsResponse = {
+    margin_manager_id: string;
+    base_coin_type: string;
+    quote_coin_type: string;
+    conditional_order_ids: string[];
+};
+/** Condition for triggering a conditional order (trigger_below_price, trigger_price). */
+type Condition = {
+    trigger_below_price: boolean;
+    trigger_price: string;
+};
+/** Pending order embedded in a conditional order (matches Move PendingOrder). */
+type PendingOrder = {
+    is_limit_order: boolean;
+    client_order_id: string;
+    order_type?: OrderType;
+    self_matching_option: SelfMatchingOption;
+    price?: string;
+    quantity: string;
+    is_bid: boolean;
+    pay_with_deep: boolean;
+    expire_timestamp?: string;
+};
+/** Conditional order (matches Move ConditionalOrder). */
+type ConditionalOrder = {
+    margin_manager_id: string;
+    base_coin_type: string;
+    quote_coin_type: string;
+    conditional_order_id: string;
+    condition: Condition;
+    pending_order: PendingOrder;
+};
 
 type BigNumber = Decimal.Value | number | string;
 
@@ -768,7 +849,10 @@ declare class MarginUtilsModule implements IModule {
      * @returns {Promise<any[]>} Array of margin manager information
      * @throws {Error} If account is invalid or query fails
      */
-    getMarginManagerByAccount(account: string): Promise<any[]>;
+    getMarginManagerByAccount(account: string): Promise<never[] | {
+        finalResult: any[];
+        referralMap: Map<string, any>;
+    }>;
     /**
      * Gets the base coin balance for a margin manager.
      *
@@ -1104,6 +1188,7 @@ declare class MarginUtilsModule implements IModule {
         isBase: boolean;
         amount?: string;
     }, tx?: Transaction): Promise<Transaction>;
+    removeReferralKey: (marginManager: string | TransactionArgument, poolId: string, baseCoinType: string, quoteCoinType: string, tx?: Transaction) => TransactionResult;
     /**
      * Places a market order for margin trading.
      * Market orders are executed immediately at the current market price.
@@ -1119,7 +1204,7 @@ declare class MarginUtilsModule implements IModule {
      * @returns {Promise<Transaction>} The transaction object with market order operation
      * @throws {Error} If parameters are invalid or decimals are missing
      */
-    placeMarginMarketOrder({ marginManager, poolInfo, selfMatchingOption, quantity, amountLimit, isBid, payWithDeep, exactBase, }: {
+    placeMarginMarketOrder({ marginManager, poolInfo, selfMatchingOption, quantity, amountLimit, isBid, payWithDeep, exactBase, referralKey, }: {
         marginManager: string | TransactionArgument;
         poolInfo: MarginPoolInfo;
         selfMatchingOption: SelfMatchingOption;
@@ -1128,6 +1213,7 @@ declare class MarginUtilsModule implements IModule {
         isBid: boolean;
         payWithDeep: boolean;
         exactBase?: boolean;
+        referralKey?: string;
     }, tx?: Transaction): Promise<Transaction>;
     /**
      * Places a limit order for margin trading.
@@ -1147,7 +1233,7 @@ declare class MarginUtilsModule implements IModule {
      * @returns {Promise<Transaction>} The transaction object with limit order operation
      * @throws {Error} If parameters are invalid or decimals are missing
      */
-    placeMarginLimitOrder({ marginManager, poolInfo, orderType, selfMatchingOption, priceInput, quantity, isBid, payWithDeep, expirationTimestamp, }: {
+    placeMarginLimitOrder({ marginManager, poolInfo, orderType, selfMatchingOption, priceInput, quantity, isBid, payWithDeep, expirationTimestamp, referralKey, }: {
         marginManager: string;
         poolInfo: MarginPoolInfo;
         orderType: OrderType;
@@ -1157,6 +1243,7 @@ declare class MarginUtilsModule implements IModule {
         isBid: boolean;
         payWithDeep: boolean;
         expirationTimestamp?: number;
+        referralKey?: string;
     }, tx?: Transaction): Promise<Transaction>;
     /**
      * Modifies an existing margin order by updating its quantity.
@@ -1417,6 +1504,13 @@ declare class MarginUtilsModule implements IModule {
             quoteMarginPool: string;
         }[];
     }): Promise<any>;
+    addConditionalOrder(options: AddConditionalOrderOptions, tx: Transaction): Promise<void>;
+    private newPendingOrder;
+    cancelAllConditionalOrders(options: CancelAllConditionalOrdersOptions, tx: Transaction): void;
+    cancelConditionalOrders(options: CancelConditionalOrdersOptions, tx: Transaction): void;
+    getConditionalOrders(options: GetConditionalOrdersOptions[], tx: Transaction): Promise<ConditionalOrder[]>;
+    getConditionalOrderIds(options: GetConditionalIdsOptions[], tx?: Transaction): Promise<Record<string, GetConditionalOrderIdsResponse>>;
+    private normalizeConditionalOrder;
 }
 
 /**
@@ -2020,4 +2114,4 @@ declare class CoinAssist {
     static buildCoinWithBalance(amount: bigint, coin_type: string, tx: Transaction): TransactionObjectArgument;
 }
 
-export { AdjustResult, Balances, BigNumber, BuildCoinResult, CLOCK_ADDRESS, CachedContent, DeepbookUtilsSDK as CetusClmmSDK, ClmmExpectSwapModule, ClmmFetcherModule, ClmmIntegratePoolModule, ClmmIntegratePoolV2Module, ClmmIntegrateRouterModule, ClmmIntegrateRouterWithPartnerModule, ClmmIntegrateUtilsModule, CoinAsset, CoinAssist, CoinConfig, CoinInfoAddress, CoinStoreAddress, DEEP_SCALAR, DEFAULT_GAS_BUDGET_FOR_MERGE, DEFAULT_GAS_BUDGET_FOR_SPLIT, DEFAULT_GAS_BUDGET_FOR_STAKE, DEFAULT_GAS_BUDGET_FOR_TRANSFER, DEFAULT_GAS_BUDGET_FOR_TRANSFER_SUI, DEFAULT_NFT_TRANSFER_GAS_FEE, DataPage, DebtDetail, DeepCoin, DeepbookClobV2Moudle, DeepbookCustodianV2Moudle, DeepbookEndpointsV2Moudle, DeepbookUtilsModule, FLOAT_SCALAR, FLOAT_SCALING, GAS_SYMBOL, GAS_TYPE_ARG, GAS_TYPE_ARG_LONG, InterestConfig, MarginCoinInfo, MarginPoolConfig, MarginPoolInfo, MarginUtilsModule, NFT, NORMALIZED_SUI_COIN_TYPE, OrderDeepPrice, OrderFee, OrderType, Package, PageQuery, PaginationArgs, PoolInfo, PoolState, RpcModule, SUI_SYSTEM_STATE_OBJECT_ID, SdkOptions, SelfMatchingOption, StateAccount, SuiAddressType, SuiBasicTypes, SuiInputTypes, SuiObjectDataWithContent, SuiObjectIdType, SuiResource, SuiStructTag, SuiTxArg, Token, TransactionUtil, UserBorrowInfo, YEAR_MS, addHexPrefix, asIntN, asUintN, bufferToHex, cacheTime1min, cacheTime24h, cacheTime5min, calc100PercentRepay, calcDebtDetail, calcInterestRate, calcUtilizationRate, calculateRiskRatio, checkAddress, composeType, d, decimalsMultiplier, DeepbookUtilsSDK as default, extractAddressFromType, extractStructTagFromType, fixCoinType, fixDown, fixSuiObjectId, fromDecimalsAmount, getDefaultSuiInputType, getFutureTime, getMoveObject, getMoveObjectType, getMovePackageContent, getObjectDeletedResponse, getObjectDisplay, getObjectFields, getObjectId, getObjectNotExistsResponse, getObjectOwner, getObjectPreviousTransactionDigest, getObjectReference, getObjectType, getObjectVersion, getSuiObjectData, hasPublicTransfer, hexToNumber, hexToString, isSortedSymbols, isSuiObjectResponse, maxDecimal, mulRoundUp, normalizeCoinType, patchFixSuiObjectId, printTransaction, removeHexPrefix, secretKeyToEd25519Keypair, secretKeyToSecp256k1Keypair, shortAddress, shortString, sleepTime, toBuffer, toDecimalsAmount, utf8to16, wrapDeepBookMarginPoolInfo, wrapDeepBookPoolInfo };
+export { AddConditionalOrderOptions, AdjustResult, Balances, BigNumber, BuildCoinResult, CLOCK_ADDRESS, CachedContent, CancelAllConditionalOrdersOptions, CancelConditionalOrdersOptions, DeepbookUtilsSDK as CetusClmmSDK, ClmmExpectSwapModule, ClmmFetcherModule, ClmmIntegratePoolModule, ClmmIntegratePoolV2Module, ClmmIntegrateRouterModule, ClmmIntegrateRouterWithPartnerModule, ClmmIntegrateUtilsModule, CoinAsset, CoinAssist, CoinConfig, CoinInfoAddress, CoinStoreAddress, Condition, ConditionalOrder, DEEP_SCALAR, DEFAULT_GAS_BUDGET_FOR_MERGE, DEFAULT_GAS_BUDGET_FOR_SPLIT, DEFAULT_GAS_BUDGET_FOR_STAKE, DEFAULT_GAS_BUDGET_FOR_TRANSFER, DEFAULT_GAS_BUDGET_FOR_TRANSFER_SUI, DEFAULT_NFT_TRANSFER_GAS_FEE, DataPage, DebtDetail, DeepCoin, DeepbookClobV2Moudle, DeepbookCustodianV2Moudle, DeepbookEndpointsV2Moudle, DeepbookUtilsModule, FLOAT_SCALAR, FLOAT_SCALING, GAS_SYMBOL, GAS_TYPE_ARG, GAS_TYPE_ARG_LONG, GetConditionalIdsOptions, GetConditionalOrderIdsResponse, GetConditionalOrdersOptions, InterestConfig, MarginCoinInfo, MarginPoolConfig, MarginPoolInfo, MarginUtilsModule, NFT, NORMALIZED_SUI_COIN_TYPE, OrderDeepPrice, OrderFee, OrderType, Package, PageQuery, PaginationArgs, PendingLimitOrderOptions, PendingMarketOrderOptions, PendingOrder, PoolInfo, PoolState, RpcModule, SUI_SYSTEM_STATE_OBJECT_ID, SdkOptions, SelfMatchingOption, StateAccount, SuiAddressType, SuiBasicTypes, SuiInputTypes, SuiObjectDataWithContent, SuiObjectIdType, SuiResource, SuiStructTag, SuiTxArg, Token, TransactionUtil, UserBorrowInfo, YEAR_MS, addHexPrefix, asIntN, asUintN, bufferToHex, cacheTime1min, cacheTime24h, cacheTime5min, calc100PercentRepay, calcDebtDetail, calcInterestRate, calcUtilizationRate, calculateRiskRatio, checkAddress, composeType, d, decimalsMultiplier, DeepbookUtilsSDK as default, extractAddressFromType, extractStructTagFromType, fixCoinType, fixDown, fixSuiObjectId, fromDecimalsAmount, getDefaultSuiInputType, getFutureTime, getMoveObject, getMoveObjectType, getMovePackageContent, getObjectDeletedResponse, getObjectDisplay, getObjectFields, getObjectId, getObjectNotExistsResponse, getObjectOwner, getObjectPreviousTransactionDigest, getObjectReference, getObjectType, getObjectVersion, getSuiObjectData, hasPublicTransfer, hexToNumber, hexToString, isSortedSymbols, isSuiObjectResponse, maxDecimal, mulRoundUp, normalizeCoinType, patchFixSuiObjectId, printTransaction, removeHexPrefix, secretKeyToEd25519Keypair, secretKeyToSecp256k1Keypair, shortAddress, shortString, sleepTime, toBuffer, toDecimalsAmount, utf8to16, wrapDeepBookMarginPoolInfo, wrapDeepBookPoolInfo };