@mysten/deepbook-v3 0.28.2 → 1.0.0

package/dist/client.d.mts

@@ -0,0 +1,897 @@
+import { BalanceManager, CanPlaceLimitOrderParams, CanPlaceMarketOrderParams, MarginManager } from "./types/index.mjs";
+import { CoinMap, PoolMap } from "./utils/constants.mjs";
+import { BalanceManagerContract } from "./transactions/balanceManager.mjs";
+import { DeepBookContract } from "./transactions/deepbook.mjs";
+import { DeepBookAdminContract } from "./transactions/deepbookAdmin.mjs";
+import { FlashLoanContract } from "./transactions/flashLoans.mjs";
+import { GovernanceContract } from "./transactions/governance.mjs";
+import { MarginAdminContract } from "./transactions/marginAdmin.mjs";
+import { MarginMaintainerContract } from "./transactions/marginMaintainer.mjs";
+import { MarginPoolContract } from "./transactions/marginPool.mjs";
+import { MarginManagerContract } from "./transactions/marginManager.mjs";
+import { MarginRegistryContract } from "./transactions/marginRegistry.mjs";
+import { MarginLiquidationsContract } from "./transactions/marginLiquidations.mjs";
+import { PoolProxyContract } from "./transactions/poolProxy.mjs";
+import { MarginTPSLContract } from "./transactions/marginTPSL.mjs";
+import { Transaction } from "@mysten/sui/transactions";
+import { ClientWithCoreApi, SuiClientRegistration, SuiClientTypes } from "@mysten/sui/client";
+
+//#region src/client.d.ts
+interface DeepBookCompatibleClient extends ClientWithCoreApi {}
+interface DeepBookOptions<Name = 'deepbook'> {
+  address: string;
+  balanceManagers?: {
+    [key: string]: BalanceManager;
+  };
+  marginManagers?: {
+    [key: string]: MarginManager;
+  };
+  coins?: CoinMap;
+  pools?: PoolMap;
+  adminCap?: string;
+  marginAdminCap?: string;
+  marginMaintainerCap?: string;
+  name?: Name;
+}
+interface DeepBookClientOptions extends DeepBookOptions {
+  client: DeepBookCompatibleClient;
+  network: SuiClientTypes.Network;
+}
+declare function deepbook<Name extends string = 'deepbook'>({
+  name,
+  ...options
+}: DeepBookOptions<Name>): SuiClientRegistration<DeepBookCompatibleClient, Name, DeepBookClient>;
+/**
+ * DeepBookClient class for managing DeepBook operations.
+ */
+declare class DeepBookClient {
+  #private;
+  balanceManager: BalanceManagerContract;
+  deepBook: DeepBookContract;
+  deepBookAdmin: DeepBookAdminContract;
+  flashLoans: FlashLoanContract;
+  governance: GovernanceContract;
+  marginAdmin: MarginAdminContract;
+  marginMaintainer: MarginMaintainerContract;
+  marginPool: MarginPoolContract;
+  marginManager: MarginManagerContract;
+  marginRegistry: MarginRegistryContract;
+  marginLiquidations: MarginLiquidationsContract;
+  poolProxy: PoolProxyContract;
+  marginTPSL: MarginTPSLContract;
+  /**
+   * Creates a new DeepBookClient instance
+   */
+  constructor({
+    client,
+    address,
+    network,
+    balanceManagers,
+    marginManagers,
+    coins,
+    pools,
+    adminCap,
+    marginAdminCap,
+    marginMaintainerCap
+  }: DeepBookClientOptions);
+  /**
+   * @description Check the balance of a balance manager for a specific coin
+   * @param {string} managerKey Key of the balance manager
+   * @param {string} coinKey Key of the coin
+   * @returns {Promise<{ coinType: string, balance: number }>} An object with coin type and balance
+   */
+  checkManagerBalance(managerKey: string, coinKey: string): Promise<{
+    coinType: string;
+    balance: number;
+  }>;
+  /**
+   * @description Check if a pool is whitelisted
+   * @param {string} poolKey Key of the pool
+   * @returns {Promise<boolean>} Boolean indicating if the pool is whitelisted
+   */
+  whitelisted(poolKey: string): Promise<boolean>;
+  /**
+   * @description Get the quote quantity out for a given base quantity
+   * @param {string} poolKey Key of the pool
+   * @param {number} baseQuantity Base quantity to convert
+   * @returns {Promise<{ baseQuantity: number, baseOut: number, quoteOut: number, deepRequired: number }>}
+   * An object with base quantity, base out, quote out, and deep required for the dry run
+   */
+  getQuoteQuantityOut(poolKey: string, baseQuantity: number): Promise<{
+    baseQuantity: number;
+    baseOut: number;
+    quoteOut: number;
+    deepRequired: number;
+  }>;
+  /**
+   * @description Get the base quantity out for a given quote quantity
+   * @param {string} poolKey Key of the pool
+   * @param {number} quoteQuantity Quote quantity to convert
+   * @returns {Promise<{ quoteQuantity: number, baseOut: number, quoteOut: number, deepRequired: number }>}
+   * An object with quote quantity, base out, quote out, and deep required for the dry run
+   */
+  getBaseQuantityOut(poolKey: string, quoteQuantity: number): Promise<{
+    quoteQuantity: number;
+    baseOut: number;
+    quoteOut: number;
+    deepRequired: number;
+  }>;
+  /**
+   * @description Get the output quantities for given base and quote quantities. Only one quantity can be non-zero
+   * @param {string} poolKey Key of the pool
+   * @param {number} baseQuantity Base quantity to convert
+   * @param {number} quoteQuantity Quote quantity to convert
+   * @returns {Promise<{ baseQuantity: number, quoteQuantity: number, baseOut: number, quoteOut: number, deepRequired: number }>}
+   * An object with base quantity, quote quantity, base out, quote out, and deep required for the dry run
+   */
+  getQuantityOut(poolKey: string, baseQuantity: number, quoteQuantity: number): Promise<{
+    baseQuantity: number;
+    quoteQuantity: number;
+    baseOut: number;
+    quoteOut: number;
+    deepRequired: number;
+  }>;
+  /**
+   * @description Get open orders for a balance manager in a pool
+   * @param {string} poolKey Key of the pool
+   * @param {string} managerKey Key of the balance manager
+   * @returns {Promise<Array>} An array of open order IDs
+   */
+  accountOpenOrders(poolKey: string, managerKey: string): Promise<string[]>;
+  /**
+   * @description Get the order information for a specific order in a pool
+   * @param {string} poolKey Key of the pool
+   * @param {string} orderId Order ID
+   * @returns {Promise<Object>} A promise that resolves to an object containing the order information
+   */
+  getOrder(poolKey: string, orderId: string): Promise<{
+    balance_manager_id: string;
+    order_id: string;
+    client_order_id: string;
+    quantity: string;
+    filled_quantity: string;
+    fee_is_deep: boolean;
+    order_deep_price: {
+      asset_is_base: boolean;
+      deep_per_asset: string;
+    };
+    epoch: string;
+    status: number;
+    expire_timestamp: string;
+  } | null>;
+  /**
+   * @description Get the order information for a specific order in a pool, with normalized price
+   * @param {string} poolKey Key of the pool
+   * @param {string} orderId Order ID
+   * @returns {Promise<Object>} A promise that resolves to an object containing the order information with normalized price
+   */
+  getOrderNormalized(poolKey: string, orderId: string): Promise<{
+    quantity: string;
+    filled_quantity: string;
+    order_deep_price: {
+      deep_per_asset: string;
+      asset_is_base: boolean;
+    };
+    isBid: boolean;
+    normalized_price: string;
+    balance_manager_id: string;
+    order_id: string;
+    client_order_id: string;
+    fee_is_deep: boolean;
+    epoch: string;
+    status: number;
+    expire_timestamp: string;
+  } | null>;
+  /**
+   * @description Retrieves information for multiple specific orders in a pool.
+   * @param {string} poolKey - The key identifying the pool from which to retrieve order information.
+   * @param {string[]} orderIds - List of order IDs to retrieve information for.
+   * @returns {Promise<Object[] | null>} A promise that resolves to an array of order objects, each containing details such as
+   * balance manager ID, order ID, client order ID, quantity, filled quantity, fee information, order price, epoch, status,
+   * and expiration timestamp. Returns `null` if the retrieval fails.
+   */
+  getOrders(poolKey: string, orderIds: string[]): Promise<{
+    balance_manager_id: string;
+    order_id: string;
+    client_order_id: string;
+    quantity: string;
+    filled_quantity: string;
+    fee_is_deep: boolean;
+    order_deep_price: {
+      asset_is_base: boolean;
+      deep_per_asset: string;
+    };
+    epoch: string;
+    status: number;
+    expire_timestamp: string;
+  }[] | null>;
+  /**
+   * @description Get level 2 order book specifying range of price
+   * @param {string} poolKey Key of the pool
+   * @param {number} priceLow Lower bound of the price range
+   * @param {number} priceHigh Upper bound of the price range
+   * @param {boolean} isBid Whether to get bid or ask orders
+   * @returns {Promise<{ prices: Array<number>, quantities: Array<number> }>}
+   * An object with arrays of prices and quantities
+   */
+  getLevel2Range(poolKey: string, priceLow: number, priceHigh: number, isBid: boolean): Promise<{
+    prices: number[];
+    quantities: number[];
+  }>;
+  /**
+   * @description Get level 2 order book ticks from mid-price for a pool
+   * @param {string} poolKey Key of the pool
+   * @param {number} ticks Number of ticks from mid-price
+   * @returns {Promise<{ bid_prices: Array<number>, bid_quantities: Array<number>, ask_prices: Array<number>, ask_quantities: Array<number> }>}
+   * An object with arrays of prices and quantities
+   */
+  getLevel2TicksFromMid(poolKey: string, ticks: number): Promise<{
+    bid_prices: number[];
+    bid_quantities: number[];
+    ask_prices: number[];
+    ask_quantities: number[];
+  }>;
+  /**
+   * @description Get the vault balances for a pool
+   * @param {string} poolKey Key of the pool
+   * @returns {Promise<{ base: number, quote: number, deep: number }>}
+   * An object with base, quote, and deep balances in the vault
+   */
+  vaultBalances(poolKey: string): Promise<{
+    base: number;
+    quote: number;
+    deep: number;
+  }>;
+  /**
+   * @description Get the pool ID by asset types
+   * @param {string} baseType Type of the base asset
+   * @param {string} quoteType Type of the quote asset
+   * @returns {Promise<string>} The address of the pool
+   */
+  getPoolIdByAssets(baseType: string, quoteType: string): Promise<string>;
+  /**
+   * @description Get the mid price for a pool
+   * @param {string} poolKey Key of the pool
+   * @returns {Promise<number>} The mid price
+   */
+  midPrice(poolKey: string): Promise<number>;
+  /**
+   * @description Get the trade parameters for a given pool, including taker fee, maker fee, and stake required.
+   * @param {string} poolKey Key of the pool
+   * @returns {Promise<{ takerFee: number, makerFee: number, stakeRequired: number }>}
+   */
+  poolTradeParams(poolKey: string): Promise<{
+    takerFee: number;
+    makerFee: number;
+    stakeRequired: number;
+  }>;
+  /**
+   * @description Get the trade parameters for a given pool, including tick size, lot size, and min size.
+   * @param {string} poolKey Key of the pool
+   * @returns {Promise<{ tickSize: number, lotSize: number, minSize: number }>}
+   */
+  poolBookParams(poolKey: string): Promise<{
+    tickSize: number;
+    lotSize: number;
+    minSize: number;
+  }>;
+  /**
+   * @description Get the account information for a given pool and balance manager
+   * @param {string} poolKey Key of the pool
+   * @param {string} managerKey The key of the BalanceManager
+   * @returns {Promise<Object>} A promise that resolves to an object containing the account information
+   */
+  account(poolKey: string, managerKey: string): Promise<{
+    epoch: string;
+    open_orders: {
+      contents: string[];
+    };
+    taker_volume: number;
+    maker_volume: number;
+    active_stake: number;
+    inactive_stake: number;
+    created_proposal: boolean;
+    voted_proposal: string | null;
+    unclaimed_rebates: {
+      base: number;
+      quote: number;
+      deep: number;
+    };
+    settled_balances: {
+      base: number;
+      quote: number;
+      deep: number;
+    };
+    owed_balances: {
+      base: number;
+      quote: number;
+      deep: number;
+    };
+  }>;
+  /**
+   * @description Get the locked balances for a pool and balance manager
+   * @param {string} poolKey Key of the pool
+   * @param {string} managerKey The key of the BalanceManager
+   * @returns {Promise<{ base: number, quote: number, deep: number }>}
+   * An object with base, quote, and deep locked for the balance manager in the pool
+   */
+  lockedBalance(poolKey: string, balanceManagerKey: string): Promise<{
+    base: number;
+    quote: number;
+    deep: number;
+  }>;
+  /**
+   * @description Get the DEEP price conversion for a pool
+   * @param {string} poolKey Key of the pool
+   * @returns {Promise<{ asset_is_base: bool, deep_per_quote: number }>} Deep price conversion
+   */
+  getPoolDeepPrice(poolKey: string): Promise<{
+    asset_is_base: true;
+    deep_per_base: number;
+    deep_per_quote?: undefined;
+  } | {
+    asset_is_base: false;
+    deep_per_quote: number;
+    deep_per_base?: undefined;
+  }>;
+  /**
+   * @description Decode the order ID to get bid/ask status, price, and orderId
+   * @param {bigint} encodedOrderId Encoded order ID
+   * @returns {Object} Object containing isBid, price, and orderId
+   */
+  decodeOrderId(encodedOrderId: bigint): {
+    isBid: boolean;
+    price: number;
+    orderId: number;
+  };
+  /**
+   * @description Get all balance manager IDs for a given owner
+   * @param {string} owner The owner address to get balance manager IDs for
+   * @returns {Promise<string[]>} Array of balance manager ID strings
+   */
+  getBalanceManagerIds(owner: string): Promise<string[]>;
+  /**
+   * @description Get the owner of the referral (DeepBookPoolReferral)
+   * @param {string} referral The ID of the referral to get the owner of
+   * @returns {Promise<string>} The owner of the referral
+   */
+  balanceManagerReferralOwner(referral: string): Promise<string>;
+  /**
+   * @description Get the referral balances for a pool and referral (DeepBookPoolReferral)
+   * @param {string} poolKey Key of the pool
+   * @param {string} referral The referral ID to get balances for
+   * @returns {Promise<{ base: number, quote: number, deep: number }>} Object with base, quote, and deep balances
+   */
+  getPoolReferralBalances(poolKey: string, referral: string): Promise<{
+    base: number;
+    quote: number;
+    deep: number;
+  }>;
+  /**
+   * @description Get the pool ID associated with a referral (DeepBookPoolReferral)
+   * @param {string} referral The referral (DeepBookPoolReferral) to get the pool ID for
+   * @returns {Promise<string>} The pool ID
+   */
+  balanceManagerReferralPoolId(referral: string): Promise<string>;
+  /**
+   * @description Get the multiplier for a referral (DeepBookPoolReferral)
+   * @param {string} poolKey Key of the pool
+   * @param {string} referral The referral (DeepBookPoolReferral) to get the multiplier for
+   * @returns {Promise<number>} The multiplier value
+   */
+  poolReferralMultiplier(poolKey: string, referral: string): Promise<number>;
+  /**
+   * @description Get the referral ID from a balance manager for a specific pool
+   * @param {string} managerKey Key of the balance manager
+   * @param {string} poolKey Key of the pool to get the referral for
+   * @returns {Promise<string | null>} The referral ID or null if not set
+   */
+  getBalanceManagerReferralId(managerKey: string, poolKey: string): Promise<string | null>;
+  getPriceInfoObject(tx: Transaction, coinKey: string): Promise<string>;
+  /**
+   * @description Get the age of the price info object for a specific coin
+   * @param {string} coinKey Key of the coin
+   * @returns {Promise<number>} The arrival time of the price info object
+   */
+  getPriceInfoObjectAge(coinKey: string): Promise<number>;
+  /**
+   * @description Get the margin pool ID
+   * @param {string} coinKey The key to identify the margin pool
+   * @returns {Promise<string>} The margin pool ID
+   */
+  getMarginPoolId(coinKey: string): Promise<string>;
+  /**
+   * @description Check if a deepbook pool is allowed for borrowing from margin pool
+   * @param {string} coinKey The key to identify the margin pool
+   * @param {string} deepbookPoolId The ID of the deepbook pool
+   * @returns {Promise<boolean>} Whether the deepbook pool is allowed
+   */
+  isDeepbookPoolAllowed(coinKey: string, deepbookPoolId: string): Promise<boolean>;
+  /**
+   * @description Get the total supply amount in the margin pool
+   * @param {string} coinKey The key to identify the margin pool
+   * @param {number} decimals Number of decimal places to show (default: 6)
+   * @returns {Promise<string>} The total supply amount as a string
+   */
+  getMarginPoolTotalSupply(coinKey: string, decimals?: number): Promise<string>;
+  /**
+   * @description Get the total supply shares in the margin pool
+   * @param {string} coinKey The key to identify the margin pool
+   * @param {number} decimals Number of decimal places to show (default: 6)
+   * @returns {Promise<string>} The total supply shares as a string
+   */
+  getMarginPoolSupplyShares(coinKey: string, decimals?: number): Promise<string>;
+  /**
+   * @description Get the total borrow amount in the margin pool
+   * @param {string} coinKey The key to identify the margin pool
+   * @param {number} decimals Number of decimal places to show (default: 6)
+   * @returns {Promise<string>} The total borrow amount as a string
+   */
+  getMarginPoolTotalBorrow(coinKey: string, decimals?: number): Promise<string>;
+  /**
+   * @description Get the total borrow shares in the margin pool
+   * @param {string} coinKey The key to identify the margin pool
+   * @param {number} decimals Number of decimal places to show (default: 6)
+   * @returns {Promise<string>} The total borrow shares as a string
+   */
+  getMarginPoolBorrowShares(coinKey: string, decimals?: number): Promise<string>;
+  /**
+   * @description Get the last update timestamp of the margin pool
+   * @param {string} coinKey The key to identify the margin pool
+   * @returns {Promise<number>} The last update timestamp in milliseconds
+   */
+  getMarginPoolLastUpdateTimestamp(coinKey: string): Promise<number>;
+  /**
+   * @description Get the supply cap of the margin pool
+   * @param {string} coinKey The key to identify the margin pool
+   * @param {number} decimals Number of decimal places to show (default: 6)
+   * @returns {Promise<string>} The supply cap as a string
+   */
+  getMarginPoolSupplyCap(coinKey: string, decimals?: number): Promise<string>;
+  /**
+   * @description Get the max utilization rate of the margin pool
+   * @param {string} coinKey The key to identify the margin pool
+   * @returns {Promise<number>} The max utilization rate (as a decimal, e.g., 0.95 for 95%)
+   */
+  getMarginPoolMaxUtilizationRate(coinKey: string): Promise<number>;
+  /**
+   * @description Get the protocol spread of the margin pool
+   * @param {string} coinKey The key to identify the margin pool
+   * @returns {Promise<number>} The protocol spread (as a decimal)
+   */
+  getMarginPoolProtocolSpread(coinKey: string): Promise<number>;
+  /**
+   * @description Get the minimum borrow amount for the margin pool
+   * @param {string} coinKey The key to identify the margin pool
+   * @param {number} decimals Number of decimal places to show (default: 6)
+   * @returns {Promise<string>} The minimum borrow amount as a string
+   */
+  getMarginPoolMinBorrow(coinKey: string, decimals?: number): Promise<string>;
+  /**
+   * @description Get the current interest rate of the margin pool
+   * @param {string} coinKey The key to identify the margin pool
+   * @returns {Promise<number>} The current interest rate (as a decimal)
+   */
+  getMarginPoolInterestRate(coinKey: string): Promise<number>;
+  /**
+   * @description Get user supply shares for a supplier cap
+   * @param {string} coinKey The key to identify the margin pool
+   * @param {string} supplierCapId The ID of the supplier cap
+   * @param {number} decimals Number of decimal places to show (default: 6)
+   * @returns {Promise<string>} The user's supply shares as a string
+   */
+  getUserSupplyShares(coinKey: string, supplierCapId: string, decimals?: number): Promise<string>;
+  /**
+   * @description Get user supply amount for a supplier cap
+   * @param {string} coinKey The key to identify the margin pool
+   * @param {string} supplierCapId The ID of the supplier cap
+   * @param {number} decimals Number of decimal places to show (default: 6)
+   * @returns {Promise<string>} The user's supply amount as a string
+   */
+  getUserSupplyAmount(coinKey: string, supplierCapId: string, decimals?: number): Promise<string>;
+  /**
+   * @description Get the owner address of a margin manager
+   * @param {string} marginManagerKey The key to identify the margin manager
+   * @returns {Promise<string>} The owner address
+   */
+  getMarginManagerOwner(marginManagerKey: string): Promise<string>;
+  /**
+   * @description Get the DeepBook pool ID associated with a margin manager
+   * @param {string} marginManagerKey The key to identify the margin manager
+   * @returns {Promise<string>} The DeepBook pool ID
+   */
+  getMarginManagerDeepbookPool(marginManagerKey: string): Promise<string>;
+  /**
+   * @description Get the margin pool ID (if any) associated with a margin manager
+   * @param {string} marginManagerKey The key to identify the margin manager
+   * @returns {Promise<string | null>} The margin pool ID or null if no active loan
+   */
+  getMarginManagerMarginPoolId(marginManagerKey: string): Promise<string | null>;
+  /**
+   * @description Get borrowed shares for both base and quote assets
+   * @param {string} marginManagerKey The key to identify the margin manager
+   * @returns {Promise<{baseShares: string, quoteShares: string}>} The borrowed shares
+   */
+  getMarginManagerBorrowedShares(marginManagerKey: string): Promise<{
+    baseShares: string;
+    quoteShares: string;
+  }>;
+  /**
+   * @description Get borrowed base shares
+   * @param {string} marginManagerKey The key to identify the margin manager
+   * @returns {Promise<string>} The borrowed base shares
+   */
+  getMarginManagerBorrowedBaseShares(marginManagerKey: string): Promise<string>;
+  /**
+   * @description Get borrowed quote shares
+   * @param {string} marginManagerKey The key to identify the margin manager
+   * @returns {Promise<string>} The borrowed quote shares
+   */
+  getMarginManagerBorrowedQuoteShares(marginManagerKey: string): Promise<string>;
+  /**
+   * @description Check if margin manager has base asset debt
+   * @param {string} marginManagerKey The key to identify the margin manager
+   * @returns {Promise<boolean>} True if has base debt, false otherwise
+   */
+  getMarginManagerHasBaseDebt(marginManagerKey: string): Promise<boolean>;
+  /**
+   * @description Get the balance manager ID for a margin manager
+   * @param {string} marginManagerKey The key to identify the margin manager
+   * @returns {Promise<string>} The balance manager ID
+   */
+  getMarginManagerBalanceManagerId(marginManagerKey: string): Promise<string>;
+  /**
+   * @description Calculate assets (base and quote) for a margin manager
+   * @param {string} marginManagerKey The key to identify the margin manager
+   * @param {number} decimals Number of decimal places to show (default: 6)
+   * @returns {Promise<{baseAsset: string, quoteAsset: string}>} The base and quote assets
+   */
+  getMarginManagerAssets(marginManagerKey: string, decimals?: number): Promise<{
+    baseAsset: string;
+    quoteAsset: string;
+  }>;
+  /**
+   * @description Calculate debts (base and quote) for a margin manager
+   * NOTE: This function automatically determines whether to use base or quote margin pool
+   * based on hasBaseDebt. You don't need to specify the debt coin type.
+   * @param {string} marginManagerKey The key to identify the margin manager
+   * @param {number} decimals Number of decimal places to show (default: 6)
+   * @returns {Promise<{baseDebt: string, quoteDebt: string}>} The base and quote debts
+   */
+  getMarginManagerDebts(marginManagerKey: string, decimals?: number): Promise<{
+    baseDebt: string;
+    quoteDebt: string;
+  }>;
+  /**
+   * @description Get comprehensive state information for a margin manager
+   * @param {string} marginManagerKey The key to identify the margin manager
+   * @param {number} decimals Number of decimal places to show (default: 6)
+   * @returns {Promise<{
+   *   managerId: string,
+   *   deepbookPoolId: string,
+   *   riskRatio: number,
+   *   baseAsset: string,
+   *   quoteAsset: string,
+   *   baseDebt: string,
+   *   quoteDebt: string,
+   *   basePythPrice: string,
+   *   basePythDecimals: number,
+   *   quotePythPrice: string,
+   *   quotePythDecimals: number
+   * }>} Comprehensive margin manager state
+   */
+  getMarginManagerState(marginManagerKey: string, decimals?: number): Promise<{
+    managerId: string;
+    deepbookPoolId: string;
+    riskRatio: number;
+    baseAsset: string;
+    quoteAsset: string;
+    baseDebt: string;
+    quoteDebt: string;
+    basePythPrice: string;
+    basePythDecimals: number;
+    quotePythPrice: string;
+    quotePythDecimals: number;
+    currentPrice: bigint;
+    lowestTriggerAbovePrice: bigint;
+    highestTriggerBelowPrice: bigint;
+  }>;
+  /**
+   * @description Get the base asset balance of a margin manager
+   * @param {string} marginManagerKey The key to identify the margin manager
+   * @param {number} decimals Number of decimal places to show (default: 6)
+   * @returns {Promise<string>} The base asset balance
+   */
+  getMarginManagerBaseBalance(marginManagerKey: string, decimals?: number): Promise<string>;
+  /**
+   * @description Get the quote asset balance of a margin manager
+   * @param {string} marginManagerKey The key to identify the margin manager
+   * @param {number} decimals Number of decimal places to show (default: 6)
+   * @returns {Promise<string>} The quote asset balance
+   */
+  getMarginManagerQuoteBalance(marginManagerKey: string, decimals?: number): Promise<string>;
+  /**
+   * @description Get the DEEP token balance of a margin manager
+   * @param {string} marginManagerKey The key to identify the margin manager
+   * @param {number} decimals Number of decimal places to show (default: 6)
+   * @returns {Promise<string>} The DEEP token balance
+   */
+  getMarginManagerDeepBalance(marginManagerKey: string, decimals?: number): Promise<string>;
+  /**
+   * @description Get account order details for a margin manager.
+   * This retrieves the balance manager from the margin manager and returns order details.
+   * @param {string} marginManagerKey The key to identify the margin manager
+   * @returns {Promise<Array>} Array of order details
+   */
+  getMarginAccountOrderDetails(marginManagerKey: string): Promise<{
+    balance_manager_id: string;
+    order_id: string;
+    client_order_id: string;
+    quantity: string;
+    filled_quantity: string;
+    fee_is_deep: boolean;
+    order_deep_price: {
+      asset_is_base: boolean;
+      deep_per_asset: string;
+    };
+    epoch: string;
+    status: number;
+    expire_timestamp: string;
+  }[]>;
+  /**
+   * @description Get all conditional order IDs for a margin manager
+   * @param {string} marginManagerKey The key to identify the margin manager
+   * @returns {Promise<string[]>} Array of conditional order IDs
+   */
+  getConditionalOrderIds(marginManagerKey: string): Promise<string[]>;
+  /**
+   * @description Get the lowest trigger price for trigger_above orders
+   * Returns MAX_U64 if there are no trigger_above orders
+   * @param {string} marginManagerKey The key to identify the margin manager
+   * @returns {Promise<bigint>} The lowest trigger above price
+   */
+  getLowestTriggerAbovePrice(marginManagerKey: string): Promise<bigint>;
+  /**
+   * @description Get the highest trigger price for trigger_below orders
+   * Returns 0 if there are no trigger_below orders
+   * @param {string} marginManagerKey The key to identify the margin manager
+   * @returns {Promise<bigint>} The highest trigger below price
+   */
+  getHighestTriggerBelowPrice(marginManagerKey: string): Promise<bigint>;
+  /**
+   * @description Check if a deepbook pool is enabled for margin trading
+   * @param {string} poolKey The key to identify the pool
+   * @returns {Promise<boolean>} True if the pool is enabled for margin trading
+   */
+  isPoolEnabledForMargin(poolKey: string): Promise<boolean>;
+  /**
+   * @description Get the margin manager IDs for a given owner address
+   * @param {string} owner The owner address
+   * @returns {Promise<string[]>} Array of margin manager IDs
+   */
+  getMarginManagerIdsForOwner(owner: string): Promise<string[]>;
+  /**
+   * @description Get the base margin pool ID for a deepbook pool
+   * @param {string} poolKey The key to identify the pool
+   * @returns {Promise<string>} The base margin pool ID
+   */
+  getBaseMarginPoolId(poolKey: string): Promise<string>;
+  /**
+   * @description Get the quote margin pool ID for a deepbook pool
+   * @param {string} poolKey The key to identify the pool
+   * @returns {Promise<string>} The quote margin pool ID
+   */
+  getQuoteMarginPoolId(poolKey: string): Promise<string>;
+  /**
+   * @description Get the minimum withdraw risk ratio for a deepbook pool
+   * @param {string} poolKey The key to identify the pool
+   * @returns {Promise<number>} The minimum withdraw risk ratio as a decimal (e.g., 1.5 for 150%)
+   */
+  getMinWithdrawRiskRatio(poolKey: string): Promise<number>;
+  /**
+   * @description Get the minimum borrow risk ratio for a deepbook pool
+   * @param {string} poolKey The key to identify the pool
+   * @returns {Promise<number>} The minimum borrow risk ratio as a decimal (e.g., 1.25 for 125%)
+   */
+  getMinBorrowRiskRatio(poolKey: string): Promise<number>;
+  /**
+   * @description Get the liquidation risk ratio for a deepbook pool
+   * @param {string} poolKey The key to identify the pool
+   * @returns {Promise<number>} The liquidation risk ratio as a decimal (e.g., 1.125 for 112.5%)
+   */
+  getLiquidationRiskRatio(poolKey: string): Promise<number>;
+  /**
+   * @description Get the target liquidation risk ratio for a deepbook pool
+   * @param {string} poolKey The key to identify the pool
+   * @returns {Promise<number>} The target liquidation risk ratio as a decimal (e.g., 1.25 for 125%)
+   */
+  getTargetLiquidationRiskRatio(poolKey: string): Promise<number>;
+  /**
+   * @description Get the user liquidation reward for a deepbook pool
+   * @param {string} poolKey The key to identify the pool
+   * @returns {Promise<number>} The user liquidation reward as a decimal (e.g., 0.05 for 5%)
+   */
+  getUserLiquidationReward(poolKey: string): Promise<number>;
+  /**
+   * @description Get the pool liquidation reward for a deepbook pool
+   * @param {string} poolKey The key to identify the pool
+   * @returns {Promise<number>} The pool liquidation reward as a decimal (e.g., 0.05 for 5%)
+   */
+  getPoolLiquidationReward(poolKey: string): Promise<number>;
+  /**
+   * @description Get all allowed maintainer cap IDs
+   * @returns {Promise<string[]>} Array of allowed maintainer cap IDs
+   */
+  getAllowedMaintainers(): Promise<string[]>;
+  /**
+   * @description Get all allowed pause cap IDs
+   * @returns {Promise<string[]>} Array of allowed pause cap IDs
+   */
+  getAllowedPauseCaps(): Promise<string[]>;
+  /**
+   * @description Check if a pool is a stable pool
+   * @param {string} poolKey Key of the pool
+   * @returns {Promise<boolean>} Whether the pool is a stable pool
+   */
+  stablePool(poolKey: string): Promise<boolean>;
+  /**
+   * @description Check if a pool is registered
+   * @param {string} poolKey Key of the pool
+   * @returns {Promise<boolean>} Whether the pool is registered
+   */
+  registeredPool(poolKey: string): Promise<boolean>;
+  /**
+   * @description Get the quote quantity out using input token as fee
+   * @param {string} poolKey Key of the pool
+   * @param {number} baseQuantity Base quantity
+   * @returns {Promise<{baseQuantity: number, baseOut: number, quoteOut: number, deepRequired: number}>}
+   */
+  getQuoteQuantityOutInputFee(poolKey: string, baseQuantity: number): Promise<{
+    baseQuantity: number;
+    baseOut: number;
+    quoteOut: number;
+    deepRequired: number;
+  }>;
+  /**
+   * @description Get the base quantity out using input token as fee
+   * @param {string} poolKey Key of the pool
+   * @param {number} quoteQuantity Quote quantity
+   * @returns {Promise<{quoteQuantity: number, baseOut: number, quoteOut: number, deepRequired: number}>}
+   */
+  getBaseQuantityOutInputFee(poolKey: string, quoteQuantity: number): Promise<{
+    quoteQuantity: number;
+    baseOut: number;
+    quoteOut: number;
+    deepRequired: number;
+  }>;
+  /**
+   * @description Get the quantity out using input token as fee
+   * @param {string} poolKey Key of the pool
+   * @param {number} baseQuantity Base quantity
+   * @param {number} quoteQuantity Quote quantity
+   * @returns {Promise<{baseQuantity: number, quoteQuantity: number, baseOut: number, quoteOut: number, deepRequired: number}>}
+   */
+  getQuantityOutInputFee(poolKey: string, baseQuantity: number, quoteQuantity: number): Promise<{
+    baseQuantity: number;
+    quoteQuantity: number;
+    baseOut: number;
+    quoteOut: number;
+    deepRequired: number;
+  }>;
+  /**
+   * @description Get the base quantity needed to receive target quote quantity
+   * @param {string} poolKey Key of the pool
+   * @param {number} targetQuoteQuantity Target quote quantity
+   * @param {boolean} payWithDeep Whether to pay fees with DEEP
+   * @returns {Promise<{baseIn: number, quoteOut: number, deepRequired: number}>}
+   */
+  getBaseQuantityIn(poolKey: string, targetQuoteQuantity: number, payWithDeep: boolean): Promise<{
+    baseIn: number;
+    quoteOut: number;
+    deepRequired: number;
+  }>;
+  /**
+   * @description Get the quote quantity needed to receive target base quantity
+   * @param {string} poolKey Key of the pool
+   * @param {number} targetBaseQuantity Target base quantity
+   * @param {boolean} payWithDeep Whether to pay fees with DEEP
+   * @returns {Promise<{baseOut: number, quoteIn: number, deepRequired: number}>}
+   */
+  getQuoteQuantityIn(poolKey: string, targetBaseQuantity: number, payWithDeep: boolean): Promise<{
+    baseOut: number;
+    quoteIn: number;
+    deepRequired: number;
+  }>;
+  /**
+   * @description Get account order details for a balance manager
+   * @param {string} poolKey Key of the pool
+   * @param {string} managerKey Key of the balance manager
+   * @returns {Promise<Array>} Array of order details
+   */
+  getAccountOrderDetails(poolKey: string, managerKey: string): Promise<{
+    balance_manager_id: string;
+    order_id: string;
+    client_order_id: string;
+    quantity: string;
+    filled_quantity: string;
+    fee_is_deep: boolean;
+    order_deep_price: {
+      asset_is_base: boolean;
+      deep_per_asset: string;
+    };
+    epoch: string;
+    status: number;
+    expire_timestamp: string;
+  }[]>;
+  /**
+   * @description Get the DEEP required for an order
+   * @param {string} poolKey Key of the pool
+   * @param {number} baseQuantity Base quantity
+   * @param {number} price Price
+   * @returns {Promise<{deepRequiredTaker: number, deepRequiredMaker: number}>}
+   */
+  getOrderDeepRequired(poolKey: string, baseQuantity: number, price: number): Promise<{
+    deepRequiredTaker: number;
+    deepRequiredMaker: number;
+  }>;
+  /**
+   * @description Check if account exists for a balance manager
+   * @param {string} poolKey Key of the pool
+   * @param {string} managerKey Key of the balance manager
+   * @returns {Promise<boolean>} Whether account exists
+   */
+  accountExists(poolKey: string, managerKey: string): Promise<boolean>;
+  /**
+   * @description Get the next epoch trade parameters
+   * @param {string} poolKey Key of the pool
+   * @returns {Promise<{takerFee: number, makerFee: number, stakeRequired: number}>}
+   */
+  poolTradeParamsNext(poolKey: string): Promise<{
+    takerFee: number;
+    makerFee: number;
+    stakeRequired: number;
+  }>;
+  /**
+   * @description Get the quorum for a pool
+   * @param {string} poolKey Key of the pool
+   * @returns {Promise<number>} The quorum amount in DEEP
+   */
+  quorum(poolKey: string): Promise<number>;
+  /**
+   * @description Get the pool ID
+   * @param {string} poolKey Key of the pool
+   * @returns {Promise<string>} The pool ID
+   */
+  poolId(poolKey: string): Promise<string>;
+  /**
+   * @description Check if a limit order can be placed
+   * @param {CanPlaceLimitOrderParams} params Parameters for checking limit order placement
+   * @returns {Promise<boolean>} Whether order can be placed
+   */
+  canPlaceLimitOrder(params: CanPlaceLimitOrderParams): Promise<boolean>;
+  /**
+   * @description Check if a market order can be placed
+   * @param {CanPlaceMarketOrderParams} params Parameters for checking market order placement
+   * @returns {Promise<boolean>} Whether order can be placed
+   */
+  canPlaceMarketOrder(params: CanPlaceMarketOrderParams): Promise<boolean>;
+  /**
+   * @description Check if market order params are valid
+   * @param {string} poolKey Key of the pool
+   * @param {number} quantity Quantity
+   * @returns {Promise<boolean>} Whether params are valid
+   */
+  checkMarketOrderParams(poolKey: string, quantity: number): Promise<boolean>;
+  /**
+   * @description Check if limit order params are valid
+   * @param {string} poolKey Key of the pool
+   * @param {number} price Price
+   * @param {number} quantity Quantity
+   * @param {number} expireTimestamp Expiration timestamp
+   * @returns {Promise<boolean>} Whether params are valid
+   */
+  checkLimitOrderParams(poolKey: string, price: number, quantity: number, expireTimestamp: number): Promise<boolean>;
+}
+//#endregion
+export { DeepBookClient, DeepBookClientOptions, DeepBookCompatibleClient, DeepBookOptions, deepbook };
+//# sourceMappingURL=client.d.mts.map