Class DeepBookClient

DeepBookClient class for managing DeepBook operations.

Index

Constructors

Properties

balanceManager deepBook deepBookAdmin flashLoans governance marginAdmin marginLiquidations marginMaintainer marginManager marginPool marginRegistry marginTPSL poolProxy

Methods

account accountExists accountOpenOrders balanceManagerReferralOwner balanceManagerReferralPoolId canPlaceLimitOrder canPlaceMarketOrder checkLimitOrderParams checkManagerBalance checkManagerBalancesWithAddress checkManagerBalanceWithAddress checkMarketOrderParams decodeOrderId getAccountOrderDetails getAllowedMaintainers getAllowedPauseCaps getBalanceManagerIds getBalanceManagerReferralId getBaseMarginPoolId getBaseQuantityIn getBaseQuantityOut getBaseQuantityOutInputFee getConditionalOrderIds getHighestTriggerBelowPrice getLevel2Range getLevel2TicksFromMid getLiquidationRiskRatio getLowestTriggerAbovePrice getMarginAccountOrderDetails getMarginManagerAssets getMarginManagerBalanceManagerId getMarginManagerBalances getMarginManagerBaseBalance getMarginManagerBorrowedBaseShares getMarginManagerBorrowedQuoteShares getMarginManagerBorrowedShares getMarginManagerDebts getMarginManagerDeepBalance getMarginManagerDeepbookPool getMarginManagerHasBaseDebt getMarginManagerIdsForOwner getMarginManagerMarginPoolId getMarginManagerOwner getMarginManagerQuoteBalance getMarginManagerState getMarginManagerStates getMarginPoolBorrowShares getMarginPoolId getMarginPoolInterestRate getMarginPoolLastUpdateTimestamp getMarginPoolMaxUtilizationRate getMarginPoolMinBorrow getMarginPoolProtocolSpread getMarginPoolSupplyCap getMarginPoolSupplyShares getMarginPoolTotalBorrow getMarginPoolTotalSupply getMinBorrowRiskRatio getMinWithdrawRiskRatio getOrder getOrderDeepRequired getOrderNormalized getOrders getPoolDeepPrice getPoolIdByAssets getPoolLiquidationReward getPoolReferralBalances getPriceInfoObject getPriceInfoObjectAge getPriceInfoObjects getQuantityOut getQuantityOutInputFee getQuoteMarginPoolId getQuoteQuantityIn getQuoteQuantityOut getQuoteQuantityOutInputFee getTargetLiquidationRiskRatio getUserLiquidationReward getUserSupplyAmount getUserSupplyShares isDeepbookPoolAllowed isPoolEnabledForMargin lockedBalance midPrice poolBookParams poolId poolReferralMultiplier poolTradeParams poolTradeParamsNext quorum registeredPool stablePool vaultBalances whitelisted

Constructors

constructor

new DeepBookClient(__namedParameters: DeepBookClientOptions): DeepBookClient
Creates a new DeepBookClient instance
Parameters
- __namedParameters: DeepBookClientOptions
Returns DeepBookClient
- Defined in packages/deepbook-v3/src/client.ts:100

Properties

marginLiquidations

marginLiquidations: MarginLiquidationsContract

marginMaintainer

marginMaintainer: MarginMaintainerContract

marginManager

marginManager: MarginManagerContract

marginPool

marginPool: MarginPoolContract

marginRegistry

marginRegistry: MarginRegistryContract

marginTPSL

marginTPSL: MarginTPSLContract

poolProxy

poolProxy: PoolProxyContract

Methods

account

account(
    poolKey: string,
    managerKey: string,
): Promise<
    {
        active_stake: number;
        created_proposal: boolean;
        epoch: string;
        inactive_stake: number;
        maker_volume: number;
        open_orders: { contents: string[] };
        owed_balances: { base: number; deep: number; quote: number };
        settled_balances: { base: number; deep: number; quote: number };
        taker_volume: number;
        unclaimed_rebates: { base: number; deep: number; quote: number };
        voted_proposal: string | null;
    },
>
Parameters
- poolKey: string
  Key of the pool
- managerKey: string
  The key of the BalanceManager
Returns Promise<
    {
        active_stake: number;
        created_proposal: boolean;
        epoch: string;
        inactive_stake: number;
        maker_volume: number;
        open_orders: { contents: string[] };
        owed_balances: { base: number; deep: number; quote: number };
        settled_balances: { base: number; deep: number; quote: number };
        taker_volume: number;
        unclaimed_rebates: { base: number; deep: number; quote: number };
        voted_proposal: string | null;
    },
>
A promise that resolves to an object containing the account information

Description
Get the account information for a given pool and balance manager
- Defined in packages/deepbook-v3/src/client.ts:710

accountExists

accountExists(poolKey: string, managerKey: string): Promise<boolean>
Parameters
- poolKey: string
  Key of the pool
- managerKey: string
  Key of the balance manager
Returns Promise<boolean>
Whether account exists

Description
Check if account exists for a balance manager
- Defined in packages/deepbook-v3/src/client.ts:2740

accountOpenOrders

accountOpenOrders(poolKey: string, managerKey: string): Promise<string[]>
Parameters
- poolKey: string
  Key of the pool
- managerKey: string
  Key of the balance manager
Returns Promise<string[]>
An array of open order IDs

Description
Get open orders for a balance manager in a pool
- Defined in packages/deepbook-v3/src/client.ts:388

balanceManagerReferralOwner

balanceManagerReferralOwner(referral: string): Promise<string>
Parameters
- referral: string
  The ID of the referral to get the owner of
Returns Promise<string>
The owner of the referral

Description
Get the owner of the referral (DeepBookPoolReferral)
- Defined in packages/deepbook-v3/src/client.ts:859

balanceManagerReferralPoolId

balanceManagerReferralPoolId(referral: string): Promise<string>
Parameters
- referral: string
  The referral (DeepBookPoolReferral) to get the pool ID for
Returns Promise<string>
The pool ID

Description
Get the pool ID associated with a referral (DeepBookPoolReferral)
- Defined in packages/deepbook-v3/src/client.ts:917

canPlaceLimitOrder

canPlaceLimitOrder(params: CanPlaceLimitOrderParams): Promise<boolean>
Parameters
- params: CanPlaceLimitOrderParams
  Parameters for checking limit order placement
Returns Promise<boolean>
Whether order can be placed

Description
Check if a limit order can be placed
- Defined in packages/deepbook-v3/src/client.ts:2820

canPlaceMarketOrder

canPlaceMarketOrder(params: CanPlaceMarketOrderParams): Promise<boolean>
Parameters
- params: CanPlaceMarketOrderParams
  Parameters for checking market order placement
Returns Promise<boolean>
Whether order can be placed

Description
Check if a market order can be placed
- Defined in packages/deepbook-v3/src/client.ts:2838

checkLimitOrderParams

checkLimitOrderParams(
    poolKey: string,
    price: number,
    quantity: number,
    expireTimestamp: number,
): Promise<boolean>
Parameters
- poolKey: string
  Key of the pool
- price: number
  Price
- quantity: number
  Quantity
- expireTimestamp: number
  Expiration timestamp
Returns Promise<boolean>
Whether params are valid

Description
Check if limit order params are valid
- Defined in packages/deepbook-v3/src/client.ts:2878

checkManagerBalance

checkManagerBalance(
managerKey: string,
coinKey: string,
): Promise<{ balance: number; coinType: string }>
Parameters
- managerKey: string
  Key of the balance manager
- coinKey: string
  Key of the coin
Returns Promise<{ balance: number; coinType: string }>
An object with coin type and balance

Description
Check the balance of a balance manager for a specific coin
- Defined in packages/deepbook-v3/src/client.ts:150

checkManagerBalancesWithAddress

checkManagerBalancesWithAddress(
managerAddresses: string[],
coinKeys: string[],
): Promise<Record<string, Record<string, number>>>
Parameters
- managerAddresses: string[]
  The on-chain addresses of the BalanceManagers
- coinKeys: string[]
  Keys of the coins to check balances for
Returns Promise<Record<string, Record<string, number>>>
Object keyed by manager address, mapping coinType to balance

Description
Check multiple coin balances for multiple balance managers by address in a single dry run call
- Defined in packages/deepbook-v3/src/client.ts:209

checkManagerBalanceWithAddress

checkManagerBalanceWithAddress(
managerAddress: string,
coinKey: string,
): Promise<{ balance: number; coinType: string }>
Parameters
- managerAddress: string
  The on-chain address of the BalanceManager
- coinKey: string
  Key of the coin
Returns Promise<{ balance: number; coinType: string }>
An object with coin type and balance

Description
Check the balance of a BalanceManager by its address directly
- Defined in packages/deepbook-v3/src/client.ts:177

checkMarketOrderParams

checkMarketOrderParams(poolKey: string, quantity: number): Promise<boolean>
Parameters
- poolKey: string
  Key of the pool
- quantity: number
  Quantity
Returns Promise<boolean>
Whether params are valid

Description
Check if market order params are valid
- Defined in packages/deepbook-v3/src/client.ts:2857

decodeOrderId

decodeOrderId(
encodedOrderId: bigint,
): { isBid: boolean; orderId: number; price: number }
Parameters
- encodedOrderId: bigint
  Encoded order ID
Returns { isBid: boolean; orderId: number; price: number }
Object containing isBid, price, and orderId

Description
Decode the order ID to get bid/ask status, price, and orderId
- Defined in packages/deepbook-v3/src/client.ts:826

getAccountOrderDetails

getAccountOrderDetails(
    poolKey: string,
    managerKey: string,
): Promise<
    {
        balance_manager_id: string;
        client_order_id: string;
        epoch: string;
        expire_timestamp: string;
        fee_is_deep: boolean;
        filled_quantity: string;
        order_deep_price: { asset_is_base: boolean; deep_per_asset: string };
        order_id: string;
        quantity: string;
        status: number;
    }[],
>
Parameters
- poolKey: string
  Key of the pool
- managerKey: string
  Key of the balance manager
Returns Promise<
    {
        balance_manager_id: string;
        client_order_id: string;
        epoch: string;
        expire_timestamp: string;
        fee_is_deep: boolean;
        filled_quantity: string;
        order_deep_price: { asset_is_base: boolean; deep_per_asset: string };
        order_id: string;
        quantity: string;
        status: number;
    }[],
>
Array of order details

Description
Get account order details for a balance manager
- Defined in packages/deepbook-v3/src/client.ts:2692

getAllowedMaintainers

getAllowedMaintainers(): Promise<string[]>
Returns Promise<string[]>
Array of allowed maintainer cap IDs

Description
Get all allowed maintainer cap IDs
- Defined in packages/deepbook-v3/src/client.ts:2466

getAllowedPauseCaps

getAllowedPauseCaps(): Promise<string[]>
Returns Promise<string[]>
Array of allowed pause cap IDs

Description
Get all allowed pause cap IDs
- Defined in packages/deepbook-v3/src/client.ts:2484

getBalanceManagerIds

getBalanceManagerIds(owner: string): Promise<string[]>
Parameters
- owner: string
  The owner address to get balance manager IDs for
Returns Promise<string[]>
Array of balance manager ID strings

Description
Get all balance manager IDs for a given owner
- Defined in packages/deepbook-v3/src/client.ts:839

getBalanceManagerReferralId

getBalanceManagerReferralId(
managerKey: string,
poolKey: string,
): Promise<string | null>
Parameters
- managerKey: string
  Key of the balance manager
- poolKey: string
  Key of the pool to get the referral for
Returns Promise<string | null>
The referral ID or null if not set

Description
Get the referral ID from a balance manager for a specific pool
- Defined in packages/deepbook-v3/src/client.ts:961

getBaseMarginPoolId

getBaseMarginPoolId(poolKey: string): Promise<string>
Parameters
- poolKey: string
  The key to identify the pool
Returns Promise<string>
The base margin pool ID

Description
Get the base margin pool ID for a deepbook pool
- Defined in packages/deepbook-v3/src/client.ts:2315

getBaseQuantityIn

getBaseQuantityIn(
    poolKey: string,
    targetQuoteQuantity: number,
    payWithDeep: boolean,
): Promise<{ baseIn: number; deepRequired: number; quoteOut: number }>
Parameters
- poolKey: string
  Key of the pool
- targetQuoteQuantity: number
  Target quote quantity
- payWithDeep: boolean
  Whether to pay fees with DEEP
Returns Promise<{ baseIn: number; deepRequired: number; quoteOut: number }>
Description
Get the base quantity needed to receive target quote quantity
- Defined in packages/deepbook-v3/src/client.ts:2633

getBaseQuantityOut

getBaseQuantityOut(
    poolKey: string,
    quoteQuantity: number,
): Promise<
    {
        baseOut: number;
        deepRequired: number;
        quoteOut: number;
        quoteQuantity: number;
    },
>
Parameters
- poolKey: string
  Key of the pool
- quoteQuantity: number
  Quote quantity to convert
Returns Promise<
    {
        baseOut: number;
        deepRequired: number;
        quoteOut: number;
        quoteQuantity: number;
    },
>
An object with quote quantity, base out, quote out, and deep required for the dry run

Description
Get the base quantity out for a given quote quantity
- Defined in packages/deepbook-v3/src/client.ts:325

getBaseQuantityOutInputFee

getBaseQuantityOutInputFee(
    poolKey: string,
    quoteQuantity: number,
): Promise<
    {
        baseOut: number;
        deepRequired: number;
        quoteOut: number;
        quoteQuantity: number;
    },
>
Parameters
- poolKey: string
  Key of the pool
- quoteQuantity: number
  Quote quantity
Returns Promise<
    {
        baseOut: number;
        deepRequired: number;
        quoteOut: number;
        quoteQuantity: number;
    },
>
Description
Get the base quantity out using input token as fee
- Defined in packages/deepbook-v3/src/client.ts:2570

getConditionalOrderIds

getConditionalOrderIds(marginManagerKey: string): Promise<string[]>
Parameters
- marginManagerKey: string
  The key to identify the margin manager
Returns Promise<string[]>
Array of conditional order IDs

Description
Get all conditional order IDs for a margin manager
- Defined in packages/deepbook-v3/src/client.ts:2186

getHighestTriggerBelowPrice

getHighestTriggerBelowPrice(marginManagerKey: string): Promise<bigint>
Parameters
- marginManagerKey: string
  The key to identify the margin manager
Returns Promise<bigint>
The highest trigger below price

Description
Get the highest trigger price for trigger_below orders Returns 0 if there are no trigger_below orders
- Defined in packages/deepbook-v3/src/client.ts:2247

getLevel2Range

getLevel2Range(
    poolKey: string,
    priceLow: number,
    priceHigh: number,
    isBid: boolean,
): Promise<{ prices: number[]; quantities: number[] }>
Parameters
- poolKey: string
  Key of the pool
- priceLow: number
  Lower bound of the price range
- priceHigh: number
  Upper bound of the price range
- isBid: boolean
  Whether to get bid or ask orders
Returns Promise<{ prices: number[]; quantities: number[] }>
An object with arrays of prices and quantities

Description
Get level 2 order book specifying range of price
- Defined in packages/deepbook-v3/src/client.ts:504

getLevel2TicksFromMid

getLevel2TicksFromMid(
    poolKey: string,
    ticks: number,
): Promise<
    {
        ask_prices: number[];
        ask_quantities: number[];
        bid_prices: number[];
        bid_quantities: number[];
    },
>
Parameters
- poolKey: string
  Key of the pool
- ticks: number
  Number of ticks from mid-price
Returns Promise<
    {
        ask_prices: number[];
        ask_quantities: number[];
        bid_prices: number[];
        bid_quantities: number[];
    },
>
An object with arrays of prices and quantities

Description
Get level 2 order book ticks from mid-price for a pool
- Defined in packages/deepbook-v3/src/client.ts:538

getLiquidationRiskRatio

getLiquidationRiskRatio(poolKey: string): Promise<number>
Parameters
- poolKey: string
  The key to identify the pool
Returns Promise<number>
The liquidation risk ratio as a decimal (e.g., 1.125 for 112.5%)

Description
Get the liquidation risk ratio for a deepbook pool
- Defined in packages/deepbook-v3/src/client.ts:2391

getLowestTriggerAbovePrice

getLowestTriggerAbovePrice(marginManagerKey: string): Promise<bigint>
Parameters
- marginManagerKey: string
  The key to identify the margin manager
Returns Promise<bigint>
The lowest trigger above price

Description
Get the lowest trigger price for trigger_above orders Returns MAX_U64 if there are no trigger_above orders
- Defined in packages/deepbook-v3/src/client.ts:2217

getMarginAccountOrderDetails

getMarginAccountOrderDetails(
    marginManagerKey: string,
): Promise<
    {
        balance_manager_id: string;
        client_order_id: string;
        epoch: string;
        expire_timestamp: string;
        fee_is_deep: boolean;
        filled_quantity: string;
        order_deep_price: { asset_is_base: boolean; deep_per_asset: string };
        order_id: string;
        quantity: string;
        status: number;
    }[],
>
Parameters
- marginManagerKey: string
  The key to identify the margin manager
Returns Promise<
    {
        balance_manager_id: string;
        client_order_id: string;
        epoch: string;
        expire_timestamp: string;
        fee_is_deep: boolean;
        filled_quantity: string;
        order_deep_price: { asset_is_base: boolean; deep_per_asset: string };
        order_id: string;
        quantity: string;
        status: number;
    }[],
>
Array of order details

Description
Get account order details for a margin manager. This retrieves the balance manager from the margin manager and returns order details.
- Defined in packages/deepbook-v3/src/client.ts:2149

getMarginManagerAssets

getMarginManagerAssets(
marginManagerKey: string,
decimals?: number,
): Promise<{ baseAsset: string; quoteAsset: string }>
Parameters
- marginManagerKey: string
  The key to identify the margin manager
- decimals: number = 6
  Number of decimal places to show (default: 6)
Returns Promise<{ baseAsset: string; quoteAsset: string }>
The base and quote assets

Description
Calculate assets (base and quote) for a margin manager
- Defined in packages/deepbook-v3/src/client.ts:1597

getMarginManagerBalanceManagerId

getMarginManagerBalanceManagerId(marginManagerKey: string): Promise<string>
Parameters
- marginManagerKey: string
  The key to identify the margin manager
Returns Promise<string>
The balance manager ID

Description
Get the balance manager ID for a margin manager
- Defined in packages/deepbook-v3/src/client.ts:1577

getMarginManagerBalances

getMarginManagerBalances(
marginManagers: Record<string, string>,
decimals?: number,
): Promise<Record<string, { base: string; deep: string; quote: string }>>
Parameters
- marginManagers: Record<string, string>
  Map of marginManagerId -> poolKey
- decimals: number = 9
  Number of decimal places for formatting (default: 9)
Returns Promise<Record<string, { base: string; deep: string; quote: string }>>
Object keyed by managerId

Description
Get base, quote, and DEEP balances for multiple margin managers in a single dry run call
- Defined in packages/deepbook-v3/src/client.ts:2071

getMarginManagerBaseBalance

getMarginManagerBaseBalance(
marginManagerKey: string,
decimals?: number,
): Promise<string>
Parameters
- marginManagerKey: string
  The key to identify the margin manager
- decimals: number = 9
  Number of decimal places to show (default: 6)
Returns Promise<string>
The base asset balance

Description
Get the base asset balance of a margin manager
- Defined in packages/deepbook-v3/src/client.ts:1964

getMarginManagerBorrowedBaseShares

getMarginManagerBorrowedBaseShares(marginManagerKey: string): Promise<string>
Parameters
- marginManagerKey: string
  The key to identify the margin manager
Returns Promise<string>
The borrowed base shares

Description
Get borrowed base shares
- Defined in packages/deepbook-v3/src/client.ts:1520

getMarginManagerBorrowedQuoteShares

getMarginManagerBorrowedQuoteShares(marginManagerKey: string): Promise<string>
Parameters
- marginManagerKey: string
  The key to identify the margin manager
Returns Promise<string>
The borrowed quote shares

Description
Get borrowed quote shares
- Defined in packages/deepbook-v3/src/client.ts:1539

getMarginManagerBorrowedShares

getMarginManagerBorrowedShares(
marginManagerKey: string,
): Promise<{ baseShares: string; quoteShares: string }>
Parameters
- marginManagerKey: string
  The key to identify the margin manager
Returns Promise<{ baseShares: string; quoteShares: string }>
The borrowed shares

Description
Get borrowed shares for both base and quote assets
- Defined in packages/deepbook-v3/src/client.ts:1495

getMarginManagerDebts

getMarginManagerDebts(
marginManagerKey: string,
decimals?: number,
): Promise<{ baseDebt: string; quoteDebt: string }>
Parameters
- marginManagerKey: string
  The key to identify the margin manager
- decimals: number = 6
  Number of decimal places to show (default: 6)
Returns Promise<{ baseDebt: string; quoteDebt: string }>
The base and quote debts

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.
- Defined in packages/deepbook-v3/src/client.ts:1638

getMarginManagerDeepBalance

getMarginManagerDeepBalance(
marginManagerKey: string,
decimals?: number,
): Promise<string>
Parameters
- marginManagerKey: string
  The key to identify the margin manager
- decimals: number = 6
  Number of decimal places to show (default: 6)
Returns Promise<string>
The DEEP token balance

Description
Get the DEEP token balance of a margin manager
- Defined in packages/deepbook-v3/src/client.ts:2036

getMarginManagerDeepbookPool

getMarginManagerDeepbookPool(marginManagerKey: string): Promise<string>
Parameters
- marginManagerKey: string
  The key to identify the margin manager
Returns Promise<string>
The DeepBook pool ID

Description
Get the DeepBook pool ID associated with a margin manager
- Defined in packages/deepbook-v3/src/client.ts:1456

getMarginManagerHasBaseDebt

getMarginManagerHasBaseDebt(marginManagerKey: string): Promise<boolean>
Parameters
- marginManagerKey: string
  The key to identify the margin manager
Returns Promise<boolean>
True if has base debt, false otherwise

Description
Check if margin manager has base asset debt
- Defined in packages/deepbook-v3/src/client.ts:1558

getMarginManagerIdsForOwner

getMarginManagerIdsForOwner(owner: string): Promise<string[]>
Parameters
- owner: string
  The owner address
Returns Promise<string[]>
Array of margin manager IDs

Description
Get the margin manager IDs for a given owner address
- Defined in packages/deepbook-v3/src/client.ts:2296

getMarginManagerMarginPoolId

getMarginManagerMarginPoolId(marginManagerKey: string): Promise<string | null>
Parameters
- marginManagerKey: string
  The key to identify the margin manager
Returns Promise<string | null>
The margin pool ID or null if no active loan

Description
Get the margin pool ID (if any) associated with a margin manager
- Defined in packages/deepbook-v3/src/client.ts:1475

getMarginManagerOwner

getMarginManagerOwner(marginManagerKey: string): Promise<string>
Parameters
- marginManagerKey: string
  The key to identify the margin manager
Returns Promise<string>
The owner address

Description
Get the owner address of a margin manager
- Defined in packages/deepbook-v3/src/client.ts:1437

getMarginManagerQuoteBalance

getMarginManagerQuoteBalance(
marginManagerKey: string,
decimals?: number,
): Promise<string>
Parameters
- marginManagerKey: string
  The key to identify the margin manager
- decimals: number = 9
  Number of decimal places to show (default: 6)
Returns Promise<string>
The quote asset balance

Description
Get the quote asset balance of a margin manager
- Defined in packages/deepbook-v3/src/client.ts:2000

getMarginManagerState

getMarginManagerState(
    marginManagerKey: string,
    decimals?: number,
): Promise<
    {
        baseAsset: string;
        baseDebt: string;
        basePythDecimals: number;
        basePythPrice: string;
        currentPrice: bigint;
        deepbookPoolId: string;
        highestTriggerBelowPrice: bigint;
        lowestTriggerAbovePrice: bigint;
        managerId: string;
        quoteAsset: string;
        quoteDebt: string;
        quotePythDecimals: number;
        quotePythPrice: string;
        riskRatio: number;
    },
>
Parameters
- marginManagerKey: string
  The key to identify the margin manager
- decimals: number = 6
  Number of decimal places to show (default: 6)
Returns Promise<
    {
        baseAsset: string;
        baseDebt: string;
        basePythDecimals: number;
        basePythPrice: string;
        currentPrice: bigint;
        deepbookPoolId: string;
        highestTriggerBelowPrice: bigint;
        lowestTriggerAbovePrice: bigint;
        managerId: string;
        quoteAsset: string;
        quoteDebt: string;
        quotePythDecimals: number;
        quotePythPrice: string;
        riskRatio: number;
    },
>
Comprehensive margin manager state

Description
Get comprehensive state information for a margin manager
- Defined in packages/deepbook-v3/src/client.ts:1706

getMarginManagerStates

getMarginManagerStates(
    marginManagers: Record<string, string>,
    decimals?: number,
): Promise<
    Record<
        string,
        {
            baseAsset: string;
            baseDebt: string;
            basePythDecimals: number;
            basePythPrice: string;
            currentPrice: bigint;
            deepbookPoolId: string;
            highestTriggerBelowPrice: bigint;
            lowestTriggerAbovePrice: bigint;
            managerId: string;
            quoteAsset: string;
            quoteDebt: string;
            quotePythDecimals: number;
            quotePythPrice: string;
            riskRatio: number;
        },
    >,
>
Parameters
- marginManagers: Record<string, string>
  Map of marginManagerId -> poolKey
- decimals: number = 6
  Number of decimal places for formatting (default: 6)
Returns Promise<
    Record<
        string,
        {
            baseAsset: string;
            baseDebt: string;
            basePythDecimals: number;
            basePythPrice: string;
            currentPrice: bigint;
            deepbookPoolId: string;
            highestTriggerBelowPrice: bigint;
            lowestTriggerAbovePrice: bigint;
            managerId: string;
            quoteAsset: string;
            quoteDebt: string;
            quotePythDecimals: number;
            quotePythPrice: string;
            riskRatio: number;
        },
    >,
>
Object keyed by managerId with state data

Description
Get comprehensive state information for multiple margin managers.
- Defined in packages/deepbook-v3/src/client.ts:1817

getMarginPoolBorrowShares

getMarginPoolBorrowShares(coinKey: string, decimals?: number): Promise<string>
Parameters
- coinKey: string
  The key to identify the margin pool
- decimals: number = 6
  Number of decimal places to show (default: 6)
Returns Promise<string>
The total borrow shares as a string

Description
Get the total borrow shares in the margin pool
- Defined in packages/deepbook-v3/src/client.ts:1246

getMarginPoolId

getMarginPoolId(coinKey: string): Promise<string>
Parameters
- coinKey: string
  The key to identify the margin pool
Returns Promise<string>
The margin pool ID

Description
Get the margin pool ID
- Defined in packages/deepbook-v3/src/client.ts:1145

getMarginPoolInterestRate

getMarginPoolInterestRate(coinKey: string): Promise<number>
Parameters
- coinKey: string
  The key to identify the margin pool
Returns Promise<number>
The current interest rate (as a decimal)

Description
Get the current interest rate of the margin pool
- Defined in packages/deepbook-v3/src/client.ts:1364

getMarginPoolLastUpdateTimestamp

getMarginPoolLastUpdateTimestamp(coinKey: string): Promise<number>
Parameters
- coinKey: string
  The key to identify the margin pool
Returns Promise<number>
The last update timestamp in milliseconds

Description
Get the last update timestamp of the margin pool
- Defined in packages/deepbook-v3/src/client.ts:1266

getMarginPoolMaxUtilizationRate

getMarginPoolMaxUtilizationRate(coinKey: string): Promise<number>
Parameters
- coinKey: string
  The key to identify the margin pool
Returns Promise<number>
The max utilization rate (as a decimal, e.g., 0.95 for 95%)

Description
Get the max utilization rate of the margin pool
- Defined in packages/deepbook-v3/src/client.ts:1305

getMarginPoolMinBorrow

getMarginPoolMinBorrow(coinKey: string, decimals?: number): Promise<string>
Parameters
- coinKey: string
  The key to identify the margin pool
- decimals: number = 6
  Number of decimal places to show (default: 6)
Returns Promise<string>
The minimum borrow amount as a string

Description
Get the minimum borrow amount for the margin pool
- Defined in packages/deepbook-v3/src/client.ts:1344

getMarginPoolProtocolSpread

getMarginPoolProtocolSpread(coinKey: string): Promise<number>
Parameters
- coinKey: string
  The key to identify the margin pool
Returns Promise<number>
The protocol spread (as a decimal)

Description
Get the protocol spread of the margin pool
- Defined in packages/deepbook-v3/src/client.ts:1324

getMarginPoolSupplyCap

getMarginPoolSupplyCap(coinKey: string, decimals?: number): Promise<string>
Parameters
- coinKey: string
  The key to identify the margin pool
- decimals: number = 6
  Number of decimal places to show (default: 6)
Returns Promise<string>
The supply cap as a string

Description
Get the supply cap of the margin pool
- Defined in packages/deepbook-v3/src/client.ts:1285

getMarginPoolSupplyShares

getMarginPoolSupplyShares(coinKey: string, decimals?: number): Promise<string>
Parameters
- coinKey: string
  The key to identify the margin pool
- decimals: number = 6
  Number of decimal places to show (default: 6)
Returns Promise<string>
The total supply shares as a string

Description
Get the total supply shares in the margin pool
- Defined in packages/deepbook-v3/src/client.ts:1204

getMarginPoolTotalBorrow

getMarginPoolTotalBorrow(coinKey: string, decimals?: number): Promise<string>
Parameters
- coinKey: string
  The key to identify the margin pool
- decimals: number = 6
  Number of decimal places to show (default: 6)
Returns Promise<string>
The total borrow amount as a string

Description
Get the total borrow amount in the margin pool
- Defined in packages/deepbook-v3/src/client.ts:1225

getMarginPoolTotalSupply

getMarginPoolTotalSupply(coinKey: string, decimals?: number): Promise<string>
Parameters
- coinKey: string
  The key to identify the margin pool
- decimals: number = 6
  Number of decimal places to show (default: 6)
Returns Promise<string>
The total supply amount as a string

Description
Get the total supply amount in the margin pool
- Defined in packages/deepbook-v3/src/client.ts:1183

getMinBorrowRiskRatio

getMinBorrowRiskRatio(poolKey: string): Promise<number>
Parameters
- poolKey: string
  The key to identify the pool
Returns Promise<number>
The minimum borrow risk ratio as a decimal (e.g., 1.25 for 125%)

Description
Get the minimum borrow risk ratio for a deepbook pool
- Defined in packages/deepbook-v3/src/client.ts:2372

getMinWithdrawRiskRatio

getMinWithdrawRiskRatio(poolKey: string): Promise<number>
Parameters
- poolKey: string
  The key to identify the pool
Returns Promise<number>
The minimum withdraw risk ratio as a decimal (e.g., 1.5 for 150%)

Description
Get the minimum withdraw risk ratio for a deepbook pool
- Defined in packages/deepbook-v3/src/client.ts:2353

getOrder

getOrder(
    poolKey: string,
    orderId: string,
): Promise<
    | {
        balance_manager_id: string;
        client_order_id: string;
        epoch: string;
        expire_timestamp: string;
        fee_is_deep: boolean;
        filled_quantity: string;
        order_deep_price: { asset_is_base: boolean; deep_per_asset: string };
        order_id: string;
        quantity: string;
        status: number;
    }
    | null,
>
Parameters
- poolKey: string
  Key of the pool
- orderId: string
  Order ID
Returns Promise<
    | {
        balance_manager_id: string;
        client_order_id: string;
        epoch: string;
        expire_timestamp: string;
        fee_is_deep: boolean;
        filled_quantity: string;
        order_deep_price: { asset_is_base: boolean; deep_per_asset: string };
        order_id: string;
        quantity: string;
        status: number;
    }
    | null,
>
A promise that resolves to an object containing the order information

Description
Get the order information for a specific order in a pool
- Defined in packages/deepbook-v3/src/client.ts:408

getOrderDeepRequired

getOrderDeepRequired(
    poolKey: string,
    baseQuantity: number,
    price: number,
): Promise<{ deepRequiredMaker: number; deepRequiredTaker: number }>
Parameters
- poolKey: string
  Key of the pool
- baseQuantity: number
  Base quantity
- price: number
  Price
Returns Promise<{ deepRequiredMaker: number; deepRequiredTaker: number }>
Description
Get the DEEP required for an order
- Defined in packages/deepbook-v3/src/client.ts:2716

getOrderNormalized

getOrderNormalized(
    poolKey: string,
    orderId: string,
): Promise<
    | {
        balance_manager_id: string;
        client_order_id: string;
        epoch: string;
        expire_timestamp: string;
        fee_is_deep: boolean;
        filled_quantity: string;
        isBid: boolean;
        normalized_price: string;
        order_deep_price: { asset_is_base: boolean; deep_per_asset: string };
        order_id: string;
        quantity: string;
        status: number;
    }
    | null,
>
Parameters
- poolKey: string
  Key of the pool
- orderId: string
  Order ID
Returns Promise<
    | {
        balance_manager_id: string;
        client_order_id: string;
        epoch: string;
        expire_timestamp: string;
        fee_is_deep: boolean;
        filled_quantity: string;
        isBid: boolean;
        normalized_price: string;
        order_deep_price: { asset_is_base: boolean; deep_per_asset: string };
        order_id: string;
        quantity: string;
        status: number;
    }
    | null,
>
A promise that resolves to an object containing the order information with normalized price

Description
Get the order information for a specific order in a pool, with normalized price
- Defined in packages/deepbook-v3/src/client.ts:431

getOrders

getOrders(
    poolKey: string,
    orderIds: string[],
): Promise<
    | {
        balance_manager_id: string;
        client_order_id: string;
        epoch: string;
        expire_timestamp: string;
        fee_is_deep: boolean;
        filled_quantity: string;
        order_deep_price: { asset_is_base: boolean; deep_per_asset: string };
        order_id: string;
        quantity: string;
        status: number;
    }[]
    | null,
>
Parameters
- poolKey: string
  The key identifying the pool from which to retrieve order information.
- orderIds: string[]
  List of order IDs to retrieve information for.
Returns Promise<
    | {
        balance_manager_id: string;
        client_order_id: string;
        epoch: string;
        expire_timestamp: string;
        fee_is_deep: boolean;
        filled_quantity: string;
        order_deep_price: { asset_is_base: boolean; deep_per_asset: string };
        order_id: string;
        quantity: string;
        status: number;
    }[]
    | 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.

Description
Retrieves information for multiple specific orders in a pool.
- Defined in packages/deepbook-v3/src/client.ts:478

getPoolDeepPrice

getPoolDeepPrice(
    poolKey: string,
): Promise<
    | {
        asset_is_base: true;
        deep_per_base: number;
        deep_per_quote?: undefined;
    }
    | {
        asset_is_base: false;
        deep_per_base?: undefined;
        deep_per_quote: number;
    },
>
Parameters
- poolKey: string
  Key of the pool
Returns Promise<
    | {
        asset_is_base: true;
        deep_per_base: number;
        deep_per_quote?: undefined;
    }
    | {
        asset_is_base: false;
        deep_per_base?: undefined;
        deep_per_quote: number;
    },
>
Deep price conversion

Description
Get the DEEP price conversion for a pool
- Defined in packages/deepbook-v3/src/client.ts:787

getPoolIdByAssets

getPoolIdByAssets(baseType: string, quoteType: string): Promise<string>
Parameters
- baseType: string
  Type of the base asset
- quoteType: string
  Type of the quote asset
Returns Promise<string>
The address of the pool

Description
Get the pool ID by asset types
- Defined in packages/deepbook-v3/src/client.ts:611

getPoolLiquidationReward

getPoolLiquidationReward(poolKey: string): Promise<number>
Parameters
- poolKey: string
  The key to identify the pool
Returns Promise<number>
The pool liquidation reward as a decimal (e.g., 0.05 for 5%)

Description
Get the pool liquidation reward for a deepbook pool
- Defined in packages/deepbook-v3/src/client.ts:2448

getPoolReferralBalances

getPoolReferralBalances(
poolKey: string,
referral: string,
): Promise<{ base: number; deep: number; quote: number }>
Parameters
- poolKey: string
  Key of the pool
- referral: string
  The referral ID to get balances for
Returns Promise<{ base: number; deep: number; quote: number }>
Object with base, quote, and deep balances

Description
Get the referral balances for a pool and referral (DeepBookPoolReferral)
- Defined in packages/deepbook-v3/src/client.ts:880

getPriceInfoObject

getPriceInfoObject(tx: Transaction, coinKey: string): Promise<string>
Parameters
- tx: Transaction
- coinKey: string
Returns Promise<string>
- Defined in packages/deepbook-v3/src/client.ts:982

getPriceInfoObjectAge

getPriceInfoObjectAge(coinKey: string): Promise<number>
Parameters
- coinKey: string
  Key of the coin
Returns Promise<number>
The arrival time of the price info object

Description
Get the age of the price info object for a specific coin
- Defined in packages/deepbook-v3/src/client.ts:1121

getPriceInfoObjects

getPriceInfoObjects(
tx: Transaction,
coinKeys: string[],
): Promise<Record<string, string>>
Parameters
- tx: Transaction
  Transaction to add price update commands to
- coinKeys: string[]
  Array of coin keys to update prices for
Returns Promise<Record<string, string>>
Map of coinKey -> priceInfoObjectId
Description
Batch update price info objects for multiple coins. Only updates stale feeds. This is more efficient than calling getPriceInfoObject multiple times as it:
1. Batch fetches all price info object ages in one RPC call
2. Fetches all stale price updates from Pyth in a single API call
- Defined in packages/deepbook-v3/src/client.ts:1026

getQuantityOut

getQuantityOut(
    poolKey: string,
    baseQuantity: number,
    quoteQuantity: number,
): Promise<
    {
        baseOut: number;
        baseQuantity: number;
        deepRequired: number;
        quoteOut: number;
        quoteQuantity: number;
    },
>
Parameters
- poolKey: string
  Key of the pool
- baseQuantity: number
  Base quantity to convert
- quoteQuantity: number
  Quote quantity to convert
Returns Promise<
    {
        baseOut: number;
        baseQuantity: number;
        deepRequired: number;
        quoteOut: number;
        quoteQuantity: number;
    },
>
An object with base quantity, quote quantity, base out, quote out, and deep required for the dry run

Description
Get the output quantities for given base and quote quantities. Only one quantity can be non-zero
- Defined in packages/deepbook-v3/src/client.ts:357

getQuantityOutInputFee

getQuantityOutInputFee(
    poolKey: string,
    baseQuantity: number,
    quoteQuantity: number,
): Promise<
    {
        baseOut: number;
        baseQuantity: number;
        deepRequired: number;
        quoteOut: number;
        quoteQuantity: number;
    },
>
Parameters
- poolKey: string
  Key of the pool
- baseQuantity: number
  Base quantity
- quoteQuantity: number
  Quote quantity
Returns Promise<
    {
        baseOut: number;
        baseQuantity: number;
        deepRequired: number;
        quoteOut: number;
        quoteQuantity: number;
    },
>
Description
Get the quantity out using input token as fee
- Defined in packages/deepbook-v3/src/client.ts:2601

getQuoteMarginPoolId

getQuoteMarginPoolId(poolKey: string): Promise<string>
Parameters
- poolKey: string
  The key to identify the pool
Returns Promise<string>
The quote margin pool ID

Description
Get the quote margin pool ID for a deepbook pool
- Defined in packages/deepbook-v3/src/client.ts:2334

getQuoteQuantityIn

getQuoteQuantityIn(
    poolKey: string,
    targetBaseQuantity: number,
    payWithDeep: boolean,
): Promise<{ baseOut: number; deepRequired: number; quoteIn: number }>
Parameters
- poolKey: string
  Key of the pool
- targetBaseQuantity: number
  Target base quantity
- payWithDeep: boolean
  Whether to pay fees with DEEP
Returns Promise<{ baseOut: number; deepRequired: number; quoteIn: number }>
Description
Get the quote quantity needed to receive target base quantity
- Defined in packages/deepbook-v3/src/client.ts:2663

getQuoteQuantityOut

getQuoteQuantityOut(
    poolKey: string,
    baseQuantity: number,
): Promise<
    {
        baseOut: number;
        baseQuantity: number;
        deepRequired: number;
        quoteOut: number;
    },
>
Parameters
- poolKey: string
  Key of the pool
- baseQuantity: number
  Base quantity to convert
Returns Promise<
    {
        baseOut: number;
        baseQuantity: number;
        deepRequired: number;
        quoteOut: number;
    },
>
An object with base quantity, base out, quote out, and deep required for the dry run

Description
Get the quote quantity out for a given base quantity
- Defined in packages/deepbook-v3/src/client.ts:294

getQuoteQuantityOutInputFee

getQuoteQuantityOutInputFee(
    poolKey: string,
    baseQuantity: number,
): Promise<
    {
        baseOut: number;
        baseQuantity: number;
        deepRequired: number;
        quoteOut: number;
    },
>
Parameters
- poolKey: string
  Key of the pool
- baseQuantity: number
  Base quantity
Returns Promise<
    {
        baseOut: number;
        baseQuantity: number;
        deepRequired: number;
        quoteOut: number;
    },
>
Description
Get the quote quantity out using input token as fee
- Defined in packages/deepbook-v3/src/client.ts:2540

getTargetLiquidationRiskRatio

getTargetLiquidationRiskRatio(poolKey: string): Promise<number>
Parameters
- poolKey: string
  The key to identify the pool
Returns Promise<number>
The target liquidation risk ratio as a decimal (e.g., 1.25 for 125%)

Description
Get the target liquidation risk ratio for a deepbook pool
- Defined in packages/deepbook-v3/src/client.ts:2410

getUserLiquidationReward

getUserLiquidationReward(poolKey: string): Promise<number>
Parameters
- poolKey: string
  The key to identify the pool
Returns Promise<number>
The user liquidation reward as a decimal (e.g., 0.05 for 5%)

Description
Get the user liquidation reward for a deepbook pool
- Defined in packages/deepbook-v3/src/client.ts:2429

getUserSupplyAmount

getUserSupplyAmount(
    coinKey: string,
    supplierCapId: string,
    decimals?: number,
): Promise<string>
Parameters
- coinKey: string
  The key to identify the margin pool
- supplierCapId: string
  The ID of the supplier cap
- decimals: number = 6
  Number of decimal places to show (default: 6)
Returns Promise<string>
The user's supply amount as a string

Description
Get user supply amount for a supplier cap
- Defined in packages/deepbook-v3/src/client.ts:1411

getUserSupplyShares

getUserSupplyShares(
    coinKey: string,
    supplierCapId: string,
    decimals?: number,
): Promise<string>
Parameters
- coinKey: string
  The key to identify the margin pool
- supplierCapId: string
  The ID of the supplier cap
- decimals: number = 6
  Number of decimal places to show (default: 6)
Returns Promise<string>
The user's supply shares as a string

Description
Get user supply shares for a supplier cap
- Defined in packages/deepbook-v3/src/client.ts:1385

isDeepbookPoolAllowed

isDeepbookPoolAllowed(coinKey: string, deepbookPoolId: string): Promise<boolean>
Parameters
- coinKey: string
  The key to identify the margin pool
- deepbookPoolId: string
  The ID of the deepbook pool
Returns Promise<boolean>
Whether the deepbook pool is allowed

Description
Check if a deepbook pool is allowed for borrowing from margin pool
- Defined in packages/deepbook-v3/src/client.ts:1164

isPoolEnabledForMargin

isPoolEnabledForMargin(poolKey: string): Promise<boolean>
Parameters
- poolKey: string
  The key to identify the pool
Returns Promise<boolean>
True if the pool is enabled for margin trading

Description
Check if a deepbook pool is enabled for margin trading
- Defined in packages/deepbook-v3/src/client.ts:2278

lockedBalance

lockedBalance(
poolKey: string,
balanceManagerKey: string,
): Promise<{ base: number; deep: number; quote: number }>
Parameters
- poolKey: string
  Key of the pool
- balanceManagerKey: string
Returns Promise<{ base: number; deep: number; quote: number }>
An object with base, quote, and deep locked for the balance manager in the pool

Description
Get the locked balances for a pool and balance manager
- Defined in packages/deepbook-v3/src/client.ts:759

midPrice

midPrice(poolKey: string): Promise<number>
Parameters
- poolKey: string
  Key of the pool
Returns Promise<number>
The mid price

Description
Get the mid price for a pool
- Defined in packages/deepbook-v3/src/client.ts:630

poolBookParams

poolBookParams(
poolKey: string,
): Promise<{ lotSize: number; minSize: number; tickSize: number }>
Parameters
- poolKey: string
  Key of the pool
Returns Promise<{ lotSize: number; minSize: number; tickSize: number }>
Description
Get the trade parameters for a given pool, including tick size, lot size, and min size.
- Defined in packages/deepbook-v3/src/client.ts:681

poolId

poolId(poolKey: string): Promise<string>
Parameters
- poolKey: string
  Key of the pool
Returns Promise<string>
The pool ID

Description
Get the pool ID
- Defined in packages/deepbook-v3/src/client.ts:2802

poolReferralMultiplier

poolReferralMultiplier(poolKey: string, referral: string): Promise<number>
Parameters
- poolKey: string
  Key of the pool
- referral: string
  The referral (DeepBookPoolReferral) to get the multiplier for
Returns Promise<number>
The multiplier value

Description
Get the multiplier for a referral (DeepBookPoolReferral)
- Defined in packages/deepbook-v3/src/client.ts:939

poolTradeParams

poolTradeParams(
poolKey: string,
): Promise<{ makerFee: number; stakeRequired: number; takerFee: number }>
Parameters
- poolKey: string
  Key of the pool
Returns Promise<{ makerFee: number; stakeRequired: number; takerFee: number }>
Description
Get the trade parameters for a given pool, including taker fee, maker fee, and stake required.
- Defined in packages/deepbook-v3/src/client.ts:656

poolTradeParamsNext

poolTradeParamsNext(
poolKey: string,
): Promise<{ makerFee: number; stakeRequired: number; takerFee: number }>
Parameters
- poolKey: string
  Key of the pool
Returns Promise<{ makerFee: number; stakeRequired: number; takerFee: number }>
Description
Get the next epoch trade parameters
- Defined in packages/deepbook-v3/src/client.ts:2758

quorum

quorum(poolKey: string): Promise<number>
Parameters
- poolKey: string
  Key of the pool
Returns Promise<number>
The quorum amount in DEEP

Description
Get the quorum for a pool
- Defined in packages/deepbook-v3/src/client.ts:2783

registeredPool

registeredPool(poolKey: string): Promise<boolean>
Parameters
- poolKey: string
  Key of the pool
Returns Promise<boolean>
Whether the pool is registered

Description
Check if a pool is registered
- Defined in packages/deepbook-v3/src/client.ts:2521

stablePool

stablePool(poolKey: string): Promise<boolean>
Parameters
- poolKey: string
  Key of the pool
Returns Promise<boolean>
Whether the pool is a stable pool

Description
Check if a pool is a stable pool
- Defined in packages/deepbook-v3/src/client.ts:2503

vaultBalances

vaultBalances(
poolKey: string,
): Promise<{ base: number; deep: number; quote: number }>
Parameters
- poolKey: string
  Key of the pool
Returns Promise<{ base: number; deep: number; quote: number }>
An object with base, quote, and deep balances in the vault

Description
Get the vault balances for a pool
- Defined in packages/deepbook-v3/src/client.ts:582

whitelisted

whitelisted(poolKey: string): Promise<boolean>
Parameters
- poolKey: string
  Key of the pool
Returns Promise<boolean>
Boolean indicating if the pool is whitelisted

Description
Check if a pool is whitelisted
- Defined in packages/deepbook-v3/src/client.ts:272

Class DeepBookClient

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns DeepBookClient

Properties

balanceManager

deepBook

deepBookAdmin

flashLoans

governance

marginAdmin

marginLiquidations

marginMaintainer

marginManager

marginPool

marginRegistry

marginTPSL

poolProxy

Methods

account

Parameters

Description

accountExists

Parameters

Returns Promise<boolean>

Description

accountOpenOrders

Parameters

Returns Promise<string[]>

Description

balanceManagerReferralOwner

Parameters

Returns Promise<string>

Description

balanceManagerReferralPoolId

Parameters

Returns Promise<string>

Description

canPlaceLimitOrder

Parameters

Returns Promise<boolean>

Description

canPlaceMarketOrder

Parameters

Returns Promise<boolean>

Description

checkLimitOrderParams

Parameters

Returns Promise<boolean>

Description

checkManagerBalance

Parameters

Returns Promise<{ balance: number; coinType: string }>

Description

checkManagerBalancesWithAddress

Parameters

Returns Promise<Record<string, Record<string, number>>>

Description

checkManagerBalanceWithAddress

Parameters

Returns Promise<{ balance: number; coinType: string }>

Description

checkMarketOrderParams

Parameters

Returns Promise<boolean>

Description

decodeOrderId

Parameters

Returns { isBid: boolean; orderId: number; price: number }

Description

getAccountOrderDetails

Parameters

Returns Promise< { balance_manager_id: string; client_order_id: string; epoch: string; expire_timestamp: string; fee_is_deep: boolean; filled_quantity: string; order_deep_price: { asset_is_base: boolean; deep_per_asset: string }; order_id: string; quantity: string; status: number; }[],>

Description

getAllowedMaintainers

Returns Promise<
{
balance_manager_id: string;
client_order_id: string;
epoch: string;
expire_timestamp: string;
fee_is_deep: boolean;
filled_quantity: string;
order_deep_price: { asset_is_base: boolean; deep_per_asset: string };
order_id: string;
quantity: string;
status: number;
}[],
>

Returns Promise<
{
baseOut: number;
deepRequired: number;
quoteOut: number;
quoteQuantity: number;
},
>

Returns Promise<
{
baseOut: number;
deepRequired: number;
quoteOut: number;
quoteQuantity: number;
},
>

Returns Promise<
{
ask_prices: number[];
ask_quantities: number[];
bid_prices: number[];
bid_quantities: number[];
},
>

Returns Promise<
{
balance_manager_id: string;
client_order_id: string;
epoch: string;
expire_timestamp: string;
fee_is_deep: boolean;
filled_quantity: string;
order_deep_price: { asset_is_base: boolean; deep_per_asset: string };
order_id: string;
quantity: string;
status: number;
}[],
>