Class DeepBookClient

DeepBookClient class for managing DeepBook operations.

Index

Constructors

Properties

balanceManager client deepBook deepBookAdmin flashLoans governance marginAdmin marginMaintainer marginManager marginPool marginRegistry poolProxy

Methods

account accountOpenOrders checkManagerBalance decodeOrderId getAllowedMaintainers getAllowedPauseCaps getBalanceManagerIds getBaseMarginPoolId getBaseQuantityOut getLevel2Range getLevel2TicksFromMid getLiquidationRiskRatio getMarginManagerAssets getMarginManagerBalanceManagerId getMarginManagerBorrowedBaseShares getMarginManagerBorrowedQuoteShares getMarginManagerBorrowedShares getMarginManagerDebts getMarginManagerDeepbookPool getMarginManagerHasBaseDebt getMarginManagerIdsForOwner getMarginManagerMarginPoolId getMarginManagerOwner getMarginPoolBorrowShares getMarginPoolId getMarginPoolInterestRate getMarginPoolLastUpdateTimestamp getMarginPoolMaxUtilizationRate getMarginPoolMinBorrow getMarginPoolProtocolSpread getMarginPoolSupplyCap getMarginPoolSupplyShares getMarginPoolTotalBorrow getMarginPoolTotalSupply getMinBorrowRiskRatio getMinWithdrawRiskRatio getOrder getOrderNormalized getOrders getPoolDeepPrice getPoolIdByAssets getPoolLiquidationReward getPriceInfoObject getPriceInfoObjectAge getQuantityOut getQuoteMarginPoolId getQuoteQuantityOut getReferralBalances getTargetLiquidationRiskRatio getUserLiquidationReward getUserSupplyAmount getUserSupplyShares isDeepbookPoolAllowed isPoolEnabledForMargin lockedBalance midPrice poolBookParams poolTradeParams referralOwner vaultBalances whitelisted

Constructors

constructor

new DeepBookClient(
    __namedParameters: {
        address: string;
        adminCap?: string;
        balanceManagers?: { [key: string]: BalanceManager };
        client: SuiJsonRpcClient;
        coins?: CoinMap;
        env: Environment;
        marginAdminCap?: string;
        marginMaintainerCap?: string;
        marginManagers?: { [key: string]: MarginManager };
        pools?: PoolMap;
    },
): DeepBookClient
Parameters
- __namedParameters: {
      address: string;
      adminCap?: string;
      balanceManagers?: { [key: string]: BalanceManager };
      client: SuiJsonRpcClient;
      coins?: CoinMap;
      env: Environment;
      marginAdminCap?: string;
      marginMaintainerCap?: string;
      marginManagers?: { [key: string]: MarginManager };
      pools?: PoolMap;
  }
Returns DeepBookClient
- Defined in deepbook-v3/src/client.ts:62

Properties

balanceManager

balanceManager: BalanceManagerContract

client

client: SuiJsonRpcClient

marginRegistry

marginRegistry: MarginRegistryContract

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: null | string;
    },
>
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: null | string;
    },
>
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 deepbook-v3/src/client.ts:583

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 deepbook-v3/src/client.ts:259

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 deepbook-v3/src/client.ts:117

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 deepbook-v3/src/client.ts:699

getAllowedMaintainers

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

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

getAllowedPauseCaps

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

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

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 deepbook-v3/src/client.ts:712

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 deepbook-v3/src/client.ts:1449

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 deepbook-v3/src/client.ts:196

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 deepbook-v3/src/client.ts:375

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 deepbook-v3/src/client.ts:409

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 deepbook-v3/src/client.ts:1525

getMarginManagerAssets

getMarginManagerAssets(
    poolKey: string,
    marginManagerId: string,
    decimals?: number,
): Promise<{ baseAsset: string; quoteAsset: string }>
Parameters
- poolKey: string
  The key to identify the pool
- marginManagerId: string
  The ID of 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 deepbook-v3/src/client.ts:1316

getMarginManagerBalanceManagerId

getMarginManagerBalanceManagerId(
poolKey: string,
marginManagerId: string,
): Promise<string>
Parameters
- poolKey: string
  The key to identify the pool
- marginManagerId: string
  The ID of the margin manager
Returns Promise<string>
The balance manager ID

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

getMarginManagerBorrowedBaseShares

getMarginManagerBorrowedBaseShares(
poolKey: string,
marginManagerId: string,
): Promise<string>
Parameters
- poolKey: string
  The key to identify the pool
- marginManagerId: string
  The ID of the margin manager
Returns Promise<string>
The borrowed base shares

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

getMarginManagerBorrowedQuoteShares

getMarginManagerBorrowedQuoteShares(
poolKey: string,
marginManagerId: string,
): Promise<string>
Parameters
- poolKey: string
  The key to identify the pool
- marginManagerId: string
  The ID of the margin manager
Returns Promise<string>
The borrowed quote shares

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

getMarginManagerBorrowedShares

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

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

getMarginManagerDebts

getMarginManagerDebts(
    poolKey: string,
    marginManagerId: string,
    decimals?: number,
): Promise<{ baseDebt: string; quoteDebt: string }>
Parameters
- poolKey: string
  The key to identify the pool
- marginManagerId: string
  The ID of 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 deepbook-v3/src/client.ts:1358

getMarginManagerDeepbookPool

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

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

getMarginManagerHasBaseDebt

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

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

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 deepbook-v3/src/client.ts:1430

getMarginManagerMarginPoolId

getMarginManagerMarginPoolId(
poolKey: string,
marginManagerId: string,
): Promise<null | string>
Parameters
- poolKey: string
  The key to identify the pool
- marginManagerId: string
  The ID of the margin manager
Returns Promise<null | string>
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 deepbook-v3/src/client.ts:1181

getMarginManagerOwner

getMarginManagerOwner(poolKey: string, marginManagerId: string): Promise<string>
Parameters
- poolKey: string
  The key to identify the pool
- marginManagerId: string
  The ID of the margin manager
Returns Promise<string>
The owner address

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

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 deepbook-v3/src/client.ts:951

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 deepbook-v3/src/client.ts:850

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 deepbook-v3/src/client.ts:1069

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 deepbook-v3/src/client.ts:971

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 deepbook-v3/src/client.ts:1010

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 deepbook-v3/src/client.ts:1049

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 deepbook-v3/src/client.ts:1029

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 deepbook-v3/src/client.ts:990

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 deepbook-v3/src/client.ts:909

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 deepbook-v3/src/client.ts:930

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 deepbook-v3/src/client.ts:888

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 deepbook-v3/src/client.ts:1506

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 deepbook-v3/src/client.ts:1487

getOrder

getOrder(
    poolKey: string,
    orderId: string,
): Promise<
    | null
    | {
        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
- orderId: string
  Order ID
Returns Promise<
    | null
    | {
        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;
    },
>
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 deepbook-v3/src/client.ts:279

getOrderNormalized

getOrderNormalized(
    poolKey: string,
    orderId: string,
): Promise<
    | null
    | {
        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;
    },
>
Parameters
- poolKey: string
  Key of the pool
- orderId: string
  Order ID
Returns Promise<
    | null
    | {
        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;
    },
>
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 deepbook-v3/src/client.ts:302

getOrders

getOrders(
    poolKey: string,
    orderIds: string[],
): Promise<
    | null
    | {
        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
  The key identifying the pool from which to retrieve order information.
- orderIds: string[]
  List of order IDs to retrieve information for.
Returns Promise<
    | null
    | {
        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;
    }[],
>
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 deepbook-v3/src/client.ts:349

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 deepbook-v3/src/client.ts:660

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 deepbook-v3/src/client.ts:482

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 deepbook-v3/src/client.ts:1582

getPriceInfoObject

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

getPriceInfoObjectAge

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

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

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 deepbook-v3/src/client.ts:228

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 deepbook-v3/src/client.ts:1468

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 deepbook-v3/src/client.ts:165

getReferralBalances

getReferralBalances(
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
- Defined in deepbook-v3/src/client.ts:753

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 deepbook-v3/src/client.ts:1544

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 deepbook-v3/src/client.ts:1563

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 deepbook-v3/src/client.ts:1116

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 deepbook-v3/src/client.ts:1090

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 deepbook-v3/src/client.ts:869

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 deepbook-v3/src/client.ts:1412

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 deepbook-v3/src/client.ts:632

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 deepbook-v3/src/client.ts:501

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 deepbook-v3/src/client.ts:554

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 deepbook-v3/src/client.ts:527

referralOwner

referralOwner(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
- Defined in deepbook-v3/src/client.ts:732

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 deepbook-v3/src/client.ts:453

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 deepbook-v3/src/client.ts:143

Class DeepBookClient

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns DeepBookClient

Properties

balanceManager

client

deepBook

deepBookAdmin

flashLoans

governance

marginAdmin

marginMaintainer

marginManager

marginPool

marginRegistry

poolProxy

Methods

account

Parameters

Description

accountOpenOrders

Parameters

Returns Promise<string[]>

Description

checkManagerBalance

Parameters

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

Description

decodeOrderId

Parameters

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

Description

getAllowedMaintainers

Returns Promise<string[]>

Description

getAllowedPauseCaps

Returns Promise<string[]>

Description

getBalanceManagerIds

Parameters

Returns Promise<string[]>

Description

getBaseMarginPoolId

Parameters

Returns Promise<string>

Description

getBaseQuantityOut

Parameters

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

Description

getLevel2Range

Parameters

Returns Promise<{ prices: number[]; quantities: number[] }>

Description

getLevel2TicksFromMid

Parameters

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

Description

getLiquidationRiskRatio

Parameters

Returns Promise<number>

Description

getMarginManagerAssets

Parameters

Returns Promise<{ baseAsset: string; quoteAsset: string }>

Description

getMarginManagerBalanceManagerId

Parameters

Returns Promise<string>

Description

getMarginManagerBorrowedBaseShares

Parameters

Returns Promise<string>

Description

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

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