@cetusprotocol/deepbook-utils 1.4.1 → 1.4.3

package/dist/index.d.ts

@@ -1,11 +1,11 @@
-import { SuiTransactionBlockResponse, SuiClient, SuiEventFilter, SuiObjectResponseQuery, SuiObjectDataOptions, CoinBalance, SuiObjectResponse, SuiObjectData, SuiObjectRef, OwnedObjectRef, SuiMoveObject, ObjectOwner, DisplayFieldsResponse, SuiParsedData } from '@mysten/sui/client';
+import { PythPriceModule as PythPriceModule$1, FullClient } from '@cetusprotocol/common-sdk';
 import { SuiGraphQLClient } from '@mysten/sui/graphql';
-import * as _mysten_sui_dist_cjs_transactions from '@mysten/sui/dist/cjs/transactions';
-import { TransactionArgument, Transaction, TransactionResult, TransactionObjectArgument } from '@mysten/sui/transactions';
-import { SuiPriceServiceConnection, SuiPythClient } from '@pythnetwork/pyth-sui-js';
+import { SuiTransactionBlockResponse, CoinBalance, SuiObjectResponse, SuiObjectData, SuiObjectRef, OwnedObjectRef, SuiMoveObject, ObjectOwner, DisplayFieldsResponse, SuiParsedData } from '@mysten/sui/jsonRpc';
+import * as _mysten_sui_transactions from '@mysten/sui/transactions';
+import { TransactionArgument, Transaction, TransactionObjectArgument, TransactionResult } from '@mysten/sui/transactions';
+import Decimal from 'decimal.js';
 import { Ed25519Keypair } from '@mysten/sui/keypairs/ed25519';
 import { Secp256k1Keypair } from '@mysten/sui/keypairs/secp256k1';
-import Decimal from 'decimal.js';
 
 interface IModule {
     readonly sdk: DeepbookUtilsSDK;
@@ -424,7 +424,7 @@ declare class DeepbookUtilsModule implements IModule {
         amountToWithdraw: string;
         returnAssets?: boolean;
         txb?: Transaction;
-    }): Transaction | _mysten_sui_dist_cjs_transactions.TransactionResult;
+    }): Transaction | _mysten_sui_transactions.TransactionResult;
     /**
      * Withdraws free balances from multiple managers into the owner account.
      */
@@ -527,7 +527,7 @@ declare class DeepbookUtilsModule implements IModule {
     /**
      * Builds coin assets for the requested amount, sourcing from the owner's coins.
      */
-    getCoinAssets(coin: string, amount: string, allCoinAsset: any, txb: any): TransactionArgument;
+    getCoinAssets(coin: string, amount: string, txb: any): TransactionObjectArgument;
     /**
      * Retrieves balances related to an upcoming transaction to determine deposit needs.
      */
@@ -539,7 +539,7 @@ declare class DeepbookUtilsModule implements IModule {
     /**
      * Determines the fee asset to use and whether additional deposits are required.
      */
-    getFeeAsset(maxFee: string, feeCoin: string, baseAmount: string, quoteAmount: string, feeManaerBalance: string, quoteIsDeep: boolean, baseIsDeep: boolean, allCoinAsset: any, payWithDeep: boolean, txb: Transaction): {
+    getFeeAsset(maxFee: string, feeCoin: string, baseAmount: string, quoteAmount: string, feeManaerBalance: string, quoteIsDeep: boolean, baseIsDeep: boolean, payWithDeep: boolean, txb: Transaction): {
         feeAsset: any;
         haveDepositFee: string;
     };
@@ -741,9 +741,8 @@ type Price = {
 };
 declare class PythPriceModule implements IModule {
     protected _sdk: DeepbookUtilsSDK;
-    protected connection: SuiPriceServiceConnection;
-    protected suiPythClient: SuiPythClient;
     protected hasChangeConnection: boolean;
+    protected _commonPythPrice: PythPriceModule$1;
     private readonly _cache;
     constructor(sdk: DeepbookUtilsSDK);
     get sdk(): DeepbookUtilsSDK;
@@ -807,23 +806,23 @@ declare class MarginUtilsModule implements IModule {
     createAndShareMarginManager(poolInfo: MarginPoolInfo, tx?: Transaction): {
         tx: Transaction;
         margin_manager: {
-            $kind: "NestedResult";
             NestedResult: [number, number];
+            $kind: "NestedResult";
         };
         initializer: {
-            $kind: "NestedResult";
             NestedResult: [number, number];
+            $kind: "NestedResult";
         };
     };
     createMarginManager(poolInfo: MarginPoolInfo, tx?: Transaction): {
         tx: Transaction;
         margin_manager: {
-            $kind: "NestedResult";
             NestedResult: [number, number];
+            $kind: "NestedResult";
         };
         initializer: {
-            $kind: "NestedResult";
             NestedResult: [number, number];
+            $kind: "NestedResult";
         };
     };
     shareMarginManager({ marginManager, initializer, baseCoin, quoteCoin, }: {
@@ -995,6 +994,34 @@ declare class MarginUtilsModule implements IModule {
         lowestTriggerAbovePrice: bigint;
         highestTriggerBelowPrice: bigint;
     }>;
+    /**
+     * Detects whether `price` is exactly on the tolerance boundary used by margin price checks.
+     *
+     * Mapping (from `getManagerState`):
+     * - For bids (`is_bid=true`): the relevant boundary is `lowestTriggerAbovePrice` (upper bound).
+     * - For asks (`is_bid=false`): the relevant boundary is `highestTriggerBelowPrice` (lower bound).
+     *
+     * NOTE: `price` must be in the same scaled `u64` units used by the on-chain margin module.
+     */
+    detectPriceBoundary({ account, marginManager, baseCoin, quoteCoin, pool, baseMarginPool, quoteMarginPool, price, is_bid, decimals, }: {
+        account: string;
+        marginManager: string;
+        baseCoin: MarginCoinInfo;
+        quoteCoin: MarginCoinInfo;
+        pool: string;
+        baseMarginPool: string;
+        quoteMarginPool: string;
+        price: bigint | string | number;
+        is_bid: boolean;
+        decimals?: number;
+    }): Promise<{
+        is_bid: boolean;
+        price: bigint;
+        lower_bound: bigint;
+        upper_bound: bigint;
+        is_within: boolean;
+        is_boundary: boolean;
+    }>;
     /**
      * Calculates the current assets (base and quote) for a margin manager.
      *
@@ -1511,57 +1538,14 @@ declare class MarginUtilsModule implements IModule {
     getConditionalOrders(options: GetConditionalOrdersOptions[], tx: Transaction): Promise<ConditionalOrder[]>;
     getConditionalOrderIds(options: GetConditionalIdsOptions[], tx?: Transaction): Promise<Record<string, GetConditionalOrderIdsResponse>>;
     private normalizeConditionalOrder;
-}
-
-/**
- * Represents a module for making RPC (Remote Procedure Call) requests.
- */
-declare class RpcModule extends SuiClient {
-    /**
-     * Get events for a given query criteria
-     * @param query
-     * @param paginationArgs
-     * @returns
-     */
-    queryEventsByPage(query: SuiEventFilter, paginationArgs?: PaginationArgs): Promise<DataPage<any>>;
-    /**
-     * Get all objects owned by an address
-     * @param owner
-     * @param query
-     * @param paginationArgs
-     * @returns
-     */
-    getOwnedObjectsByPage(owner: string, query: SuiObjectResponseQuery, paginationArgs?: PaginationArgs): Promise<DataPage<any>>;
-    /**
-     * Return the list of dynamic field objects owned by an object
-     * @param parentId
-     * @param paginationArgs
-     * @returns
-     */
-    getDynamicFieldsByPage(parentId: SuiObjectIdType, paginationArgs?: PaginationArgs): Promise<DataPage<any>>;
-    /**
-     * Batch get details about a list of objects. If any of the object ids are duplicates the call will fail
-     * @param ids
-     * @param options
-     * @param limit
-     * @returns
-     */
-    batchGetObjects(ids: SuiObjectIdType[], options?: SuiObjectDataOptions, limit?: number): Promise<any[]>;
-    /**
-     * Calculates the gas cost of a transaction block.
-     * @param {Transaction} tx - The transaction block to calculate gas for.
-     * @returns {Promise<number>} - The estimated gas cost of the transaction block.
-     * @throws {Error} - Throws an error if the sender is empty.
-     */
-    calculationTxGas(tx: Transaction): Promise<number>;
-    /**
-     * Sends a transaction block after signing it with the provided keypair.
-     *
-     * @param {Ed25519Keypair | Secp256k1Keypair} keypair - The keypair used for signing the transaction.
-     * @param {Transaction} tx - The transaction block to send.
-     * @returns {Promise<SuiTransactionBlockResponse | undefined>} - The response of the sent transaction block.
-     */
-    sendTransaction(keypair: Ed25519Keypair | Secp256k1Keypair, tx: Transaction): Promise<SuiTransactionBlockResponse | undefined>;
+    getPoolsPriceBounds(poolInfos: {
+        poolId: string;
+        baseDecimals: number;
+        quoteDecimals: number;
+    }[]): Promise<{
+        priceBounds: any;
+        priceBoundsMap: Map<string, any>;
+    }>;
 }
 
 /**
@@ -1628,7 +1612,7 @@ declare class DeepbookUtilsSDK {
     /**
      * RPC provider on the SUI chain
      */
-    protected _rpcModule: RpcModule;
+    protected _rpcModule: FullClient;
     protected _deepbookUtils: any;
     protected _marginUtils: any;
     protected _pythPrice: PythPriceModule;
@@ -1657,9 +1641,9 @@ declare class DeepbookUtilsSDK {
     get PythPrice(): PythPriceModule;
     /**
      * Getter for the fullClient property.
-     * @returns {RpcModule} The fullClient property value.
+     * @returns {FullClient} The fullClient property value.
      */
-    get fullClient(): RpcModule;
+    get fullClient(): FullClient;
     get graphqlClient(): SuiGraphQLClient;
     /**
      * Getter for the sdkOptions property.
@@ -1796,7 +1780,7 @@ declare class TransactionUtil {
     private static buildCoin;
     private static buildZeroValueCoin;
     static buildCoinForAmountInterval(tx: Transaction, allCoins: CoinAsset[], amounts: CoinInputInterval, coinType: string, buildVector?: boolean): BuildCoinResult;
-    static callMintZeroValueCoin: (txb: Transaction, coinType: string) => _mysten_sui_dist_cjs_transactions.TransactionResult;
+    static callMintZeroValueCoin: (txb: Transaction, coinType: string) => _mysten_sui_transactions.TransactionResult;
     static buildCoinTypePair(coinTypes: string[], partitionQuantities: number[]): string[][];
 }
 
@@ -2114,4 +2098,4 @@ declare class CoinAssist {
     static buildCoinWithBalance(amount: bigint, coin_type: string, tx: Transaction): TransactionObjectArgument;
 }
 
-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 };
+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, 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 };