@cetusprotocol/deepbook-utils 1.1.3 → 1.3.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;
 
@@ -1298,12 +1379,22 @@ declare class MarginUtilsModule implements IModule {
         maintainer_fees: any;
         protocol_fees: any;
     }[]>;
+    getBaseQuantityIn(poolInfo: any, quantity: string, payWithDeep: boolean, slippage?: number): Promise<{
+        quantityOut: string;
+        quantityInLeft: string;
+        deep_fee_amount: string;
+    }>;
+    getQuoteQuantityIn(poolInfo: any, quantity: string, payWithDeep: boolean, slippage?: number): Promise<{
+        quantityOut: string;
+        quantityInLeft: string;
+        deep_fee_amount: string;
+    }>;
     getBaseQuantityOutInput(poolInfo: any, quantity: string, payWithDeep: boolean): Promise<{
         base_amount: string;
         quote_amount: string;
         deep_fee_amount: string;
     }>;
-    getQuoteQuantityOutInput(poolInfo: any, quantity: string): Promise<{
+    getQuoteQuantityOutInput(poolInfo: any, quantity: string, payWithDeep: boolean): Promise<{
         base_amount: string;
         quote_amount: string;
         deep_fee_amount: string;
@@ -1351,6 +1442,69 @@ declare class MarginUtilsModule implements IModule {
      * @returns {Promise<bigint>} The current chain timestamp in milliseconds
      */
     getChainTimestamp(): Promise<bigint>;
+    batchGetBorrowedShares({ account, marginManagerList, }: {
+        account: string;
+        marginManagerList: {
+            marginManagerId: string;
+            baseCoinType: string;
+            quoteCoinType: string;
+        }[];
+    }): Promise<any>;
+    betchGetOpenOrders({ account, marginManagerList, }: {
+        account: string;
+        marginManagerList: {
+            marginManagerId: string;
+            poolId: string;
+            baseCoinType: string;
+            quoteCoinType: string;
+            baseMarginPool: string;
+            quoteMarginPool: string;
+        }[];
+    }, tx?: Transaction, isReturnTx?: boolean): Promise<{
+        openOrders: any;
+        settledBalances: any;
+        lockedBalances: any;
+    }>;
+    getSingleMarginManagerOpenOrders({ account, marginManagerId, poolId, baseCoinType, quoteCoinType, baseMarginPool, quoteMarginPool, }: {
+        account: string;
+        marginManagerId: string;
+        poolId: string;
+        baseCoinType: string;
+        quoteCoinType: string;
+        baseMarginPool: string;
+        quoteMarginPool: string;
+    }): Promise<{
+        openOrders: any;
+        settledBalances: {
+            base: string;
+            quote: string;
+            deep: string;
+        }[];
+        lockedBalances: {
+            marginManagerId: string;
+            base: string;
+            quote: string;
+            deep: string;
+        }[];
+    }>;
+    getAllPosRelevantData({ account, marginManagerList, }: {
+        account: string;
+        marginManagerList: {
+            marginManagerId: string;
+            poolId: string;
+            baseCoinType: string;
+            quoteCoinType: string;
+            baseMarginPool: string;
+            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;
 }
 
 /**
@@ -1954,4 +2108,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 };