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 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 getMinOpenRiskRatio 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:134

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<AccountInfo>
Parameters
- poolKey: string
- managerKey: string
Returns Promise<AccountInfo>
- Defined in packages/deepbook-v3/src/client.ts:395

accountExists

accountExists(poolKey: string, managerKey: string): Promise<boolean>
Parameters
- poolKey: string
- managerKey: string
Returns Promise<boolean>
- Defined in packages/deepbook-v3/src/client.ts:223

accountOpenOrders

accountOpenOrders(poolKey: string, managerKey: string): Promise<string[]>
Parameters
- poolKey: string
- managerKey: string
Returns Promise<string[]>
- Defined in packages/deepbook-v3/src/client.ts:360

balanceManagerReferralOwner

balanceManagerReferralOwner(referral: string): Promise<string>
Parameters
- referral: string
Returns Promise<string>
- Defined in packages/deepbook-v3/src/client.ts:409

balanceManagerReferralPoolId

balanceManagerReferralPoolId(referral: string): Promise<string>
Parameters
- referral: string
Returns Promise<string>
- Defined in packages/deepbook-v3/src/client.ts:417

canPlaceLimitOrder

canPlaceLimitOrder(params: CanPlaceLimitOrderParams): Promise<boolean>
Parameters
- params: CanPlaceLimitOrderParams
Returns Promise<boolean>
- Defined in packages/deepbook-v3/src/client.ts:273

canPlaceMarketOrder

canPlaceMarketOrder(params: CanPlaceMarketOrderParams): Promise<boolean>
Parameters
- params: CanPlaceMarketOrderParams
Returns Promise<boolean>
- Defined in packages/deepbook-v3/src/client.ts:277

checkLimitOrderParams

checkLimitOrderParams(
    poolKey: string,
    price: number | bigint,
    quantity: number | bigint,
    expireTimestamp: number,
): Promise<boolean>
Parameters
- poolKey: string
- price: number | bigint
- quantity: number | bigint
- expireTimestamp: number
Returns Promise<boolean>
- Defined in packages/deepbook-v3/src/client.ts:285

checkManagerBalance

checkManagerBalance(
managerKey: string,
coinKey: string,
): Promise<ManagerBalance>
Parameters
- managerKey: string
- coinKey: string
Returns Promise<ManagerBalance>
- Defined in packages/deepbook-v3/src/client.ts:204

checkManagerBalancesWithAddress

checkManagerBalancesWithAddress(
managerAddresses: string[],
coinKeys: string[],
): Promise<Record<string, Record<string, number>>>
Parameters
- managerAddresses: string[]
- coinKeys: string[]
Returns Promise<Record<string, Record<string, number>>>
- Defined in packages/deepbook-v3/src/client.ts:212

checkManagerBalanceWithAddress

checkManagerBalanceWithAddress(
managerAddress: string,
coinKey: string,
): Promise<ManagerBalance>
Parameters
- managerAddress: string
- coinKey: string
Returns Promise<ManagerBalance>
- Defined in packages/deepbook-v3/src/client.ts:208

checkMarketOrderParams

checkMarketOrderParams(
poolKey: string,
quantity: number | bigint,
): Promise<boolean>
Parameters
- poolKey: string
- quantity: number | bigint
Returns Promise<boolean>
- Defined in packages/deepbook-v3/src/client.ts:281

decodeOrderId

decodeOrderId(encodedOrderId: bigint): DecodedOrderId
Parameters
- encodedOrderId: bigint
Returns DecodedOrderId
- Defined in packages/deepbook-v3/src/client.ts:664

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
- managerKey: string
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;
    }[],
>
- Defined in packages/deepbook-v3/src/client.ts:389

getAllowedMaintainers

getAllowedMaintainers(): Promise<string[]>
Returns Promise<string[]>
- Defined in packages/deepbook-v3/src/client.ts:654

getAllowedPauseCaps

getAllowedPauseCaps(): Promise<string[]>
Returns Promise<string[]>
- Defined in packages/deepbook-v3/src/client.ts:658

getBalanceManagerIds

getBalanceManagerIds(owner: string): Promise<string[]>
Parameters
- owner: string
Returns Promise<string[]>
- Defined in packages/deepbook-v3/src/client.ts:219

getBalanceManagerReferralId

getBalanceManagerReferralId(
managerKey: string,
poolKey: string,
): Promise<string | null>
Parameters
- managerKey: string
- poolKey: string
Returns Promise<string | null>
- Defined in packages/deepbook-v3/src/client.ts:425

getBaseMarginPoolId

getBaseMarginPoolId(poolKey: string): Promise<string>
Parameters
- poolKey: string
Returns Promise<string>
- Defined in packages/deepbook-v3/src/client.ts:614

getBaseQuantityIn

getBaseQuantityIn(
    poolKey: string,
    targetQuoteQuantity: number | bigint,
    payWithDeep: boolean,
): Promise<BaseQuantityIn>
Parameters
- poolKey: string
- targetQuoteQuantity: number | bigint
- payWithDeep: boolean
Returns Promise<BaseQuantityIn>
- Defined in packages/deepbook-v3/src/client.ts:334

getBaseQuantityOut

getBaseQuantityOut(
poolKey: string,
quoteQuantity: number | bigint,
): Promise<BaseQuantityOut>
Parameters
- poolKey: string
- quoteQuantity: number | bigint
Returns Promise<BaseQuantityOut>
- Defined in packages/deepbook-v3/src/client.ts:300

getBaseQuantityOutInputFee

getBaseQuantityOutInputFee(
poolKey: string,
quoteQuantity: number | bigint,
): Promise<BaseQuantityOut>
Parameters
- poolKey: string
- quoteQuantity: number | bigint
Returns Promise<BaseQuantityOut>
- Defined in packages/deepbook-v3/src/client.ts:319

getConditionalOrderIds

getConditionalOrderIds(marginManagerKey: string): Promise<string[]>
Parameters
- marginManagerKey: string
Returns Promise<string[]>
- Defined in packages/deepbook-v3/src/client.ts:592

getHighestTriggerBelowPrice

getHighestTriggerBelowPrice(marginManagerKey: string): Promise<bigint>
Parameters
- marginManagerKey: string
Returns Promise<bigint>
- Defined in packages/deepbook-v3/src/client.ts:600

getLevel2Range

getLevel2Range(
    poolKey: string,
    priceLow: number | bigint,
    priceHigh: number | bigint,
    isBid: boolean,
): Promise<Level2Range>
Parameters
- poolKey: string
- priceLow: number | bigint
- priceHigh: number | bigint
- isBid: boolean
Returns Promise<Level2Range>
- Defined in packages/deepbook-v3/src/client.ts:376

getLevel2TicksFromMid

getLevel2TicksFromMid(
poolKey: string,
ticks: number,
): Promise<Level2TicksFromMid>
Parameters
- poolKey: string
- ticks: number
Returns Promise<Level2TicksFromMid>
- Defined in packages/deepbook-v3/src/client.ts:385

getLiquidationRiskRatio

getLiquidationRiskRatio(poolKey: string): Promise<number>
Parameters
- poolKey: string
Returns Promise<number>
- Defined in packages/deepbook-v3/src/client.ts:638

getLowestTriggerAbovePrice

getLowestTriggerAbovePrice(marginManagerKey: string): Promise<bigint>
Parameters
- marginManagerKey: string
Returns Promise<bigint>
- Defined in packages/deepbook-v3/src/client.ts:596

getMarginManagerAssets

getMarginManagerAssets(
marginManagerKey: string,
decimals?: number,
): Promise<MarginManagerAssets>
Parameters
- marginManagerKey: string
- decimals: number = 6
Returns Promise<MarginManagerAssets>
- Defined in packages/deepbook-v3/src/client.ts:543

getMarginManagerBalanceManagerId

getMarginManagerBalanceManagerId(marginManagerAddress: string): Promise<string>
Parameters
- marginManagerAddress: string
Returns Promise<string>
- Defined in packages/deepbook-v3/src/client.ts:539

getMarginManagerBalances

getMarginManagerBalances(
marginManagers: Record<string, string>,
decimals?: number,
): Promise<Record<string, MarginManagerBalancesResult>>
Parameters
- marginManagers: Record<string, string>
- decimals: number = 9
Returns Promise<Record<string, MarginManagerBalancesResult>>
- Defined in packages/deepbook-v3/src/client.ts:583

getMarginManagerBaseBalance

getMarginManagerBaseBalance(
marginManagerKey: string,
decimals?: number,
): Promise<string>
Parameters
- marginManagerKey: string
- decimals: number = 9
Returns Promise<string>
- Defined in packages/deepbook-v3/src/client.ts:571

getMarginManagerBorrowedBaseShares

getMarginManagerBorrowedBaseShares(marginManagerKey: string): Promise<string>
Parameters
- marginManagerKey: string
Returns Promise<string>
- Defined in packages/deepbook-v3/src/client.ts:527

getMarginManagerBorrowedQuoteShares

getMarginManagerBorrowedQuoteShares(marginManagerKey: string): Promise<string>
Parameters
- marginManagerKey: string
Returns Promise<string>
- Defined in packages/deepbook-v3/src/client.ts:531

getMarginManagerBorrowedShares

getMarginManagerBorrowedShares(
marginManagerKey: string,
): Promise<BorrowedShares>
Parameters
- marginManagerKey: string
Returns Promise<BorrowedShares>
- Defined in packages/deepbook-v3/src/client.ts:523

getMarginManagerDebts

getMarginManagerDebts(
marginManagerKey: string,
decimals?: number,
): Promise<MarginManagerDebts>
Parameters
- marginManagerKey: string
- decimals: number = 6
Returns Promise<MarginManagerDebts>
- Defined in packages/deepbook-v3/src/client.ts:550

getMarginManagerDeepBalance

getMarginManagerDeepBalance(
marginManagerKey: string,
decimals?: number,
): Promise<string>
Parameters
- marginManagerKey: string
- decimals: number = 6
Returns Promise<string>
- Defined in packages/deepbook-v3/src/client.ts:579

getMarginManagerDeepbookPool

getMarginManagerDeepbookPool(marginManagerKey: string): Promise<string>
Parameters
- marginManagerKey: string
Returns Promise<string>
- Defined in packages/deepbook-v3/src/client.ts:515

getMarginManagerHasBaseDebt

getMarginManagerHasBaseDebt(marginManagerKey: string): Promise<boolean>
Parameters
- marginManagerKey: string
Returns Promise<boolean>
- Defined in packages/deepbook-v3/src/client.ts:535

getMarginManagerIdsForOwner

getMarginManagerIdsForOwner(owner: string): Promise<string[]>
Parameters
- owner: string
Returns Promise<string[]>
- Defined in packages/deepbook-v3/src/client.ts:610

getMarginManagerMarginPoolId

getMarginManagerMarginPoolId(marginManagerKey: string): Promise<string | null>
Parameters
- marginManagerKey: string
Returns Promise<string | null>
- Defined in packages/deepbook-v3/src/client.ts:519

getMarginManagerOwner

getMarginManagerOwner(marginManagerKey: string): Promise<string>
Parameters
- marginManagerKey: string
Returns Promise<string>
- Defined in packages/deepbook-v3/src/client.ts:511

getMarginManagerQuoteBalance

getMarginManagerQuoteBalance(
marginManagerKey: string,
decimals?: number,
): Promise<string>
Parameters
- marginManagerKey: string
- decimals: number = 9
Returns Promise<string>
- Defined in packages/deepbook-v3/src/client.ts:575

getMarginManagerState

getMarginManagerState(
marginManagerKey: string,
decimals?: number,
): Promise<MarginManagerState>
Parameters
- marginManagerKey: string
- decimals: number = 6
Returns Promise<MarginManagerState>
- Defined in packages/deepbook-v3/src/client.ts:557

getMarginManagerStates

getMarginManagerStates(
marginManagers: Record<string, string>,
decimals?: number,
): Promise<Record<string, MarginManagerState>>
Parameters
- marginManagers: Record<string, string>
- decimals: number = 6
Returns Promise<Record<string, MarginManagerState>>
- Defined in packages/deepbook-v3/src/client.ts:564

getMarginPoolBorrowShares

getMarginPoolBorrowShares(coinKey: string, decimals?: number): Promise<string>
Parameters
- coinKey: string
- decimals: number = 6
Returns Promise<string>
- Defined in packages/deepbook-v3/src/client.ts:465

getMarginPoolId

getMarginPoolId(coinKey: string): Promise<string>
Parameters
- coinKey: string
Returns Promise<string>
- Defined in packages/deepbook-v3/src/client.ts:445

getMarginPoolInterestRate

getMarginPoolInterestRate(coinKey: string): Promise<number>
Parameters
- coinKey: string
Returns Promise<number>
- Defined in packages/deepbook-v3/src/client.ts:489

getMarginPoolLastUpdateTimestamp

getMarginPoolLastUpdateTimestamp(coinKey: string): Promise<number>
Parameters
- coinKey: string
Returns Promise<number>
- Defined in packages/deepbook-v3/src/client.ts:469

getMarginPoolMaxUtilizationRate

getMarginPoolMaxUtilizationRate(coinKey: string): Promise<number>
Parameters
- coinKey: string
Returns Promise<number>
- Defined in packages/deepbook-v3/src/client.ts:477

getMarginPoolMinBorrow

getMarginPoolMinBorrow(coinKey: string, decimals?: number): Promise<string>
Parameters
- coinKey: string
- decimals: number = 6
Returns Promise<string>
- Defined in packages/deepbook-v3/src/client.ts:485

getMarginPoolProtocolSpread

getMarginPoolProtocolSpread(coinKey: string): Promise<number>
Parameters
- coinKey: string
Returns Promise<number>
- Defined in packages/deepbook-v3/src/client.ts:481

getMarginPoolSupplyCap

getMarginPoolSupplyCap(coinKey: string, decimals?: number): Promise<string>
Parameters
- coinKey: string
- decimals: number = 6
Returns Promise<string>
- Defined in packages/deepbook-v3/src/client.ts:473

getMarginPoolSupplyShares

getMarginPoolSupplyShares(coinKey: string, decimals?: number): Promise<string>
Parameters
- coinKey: string
- decimals: number = 6
Returns Promise<string>
- Defined in packages/deepbook-v3/src/client.ts:457

getMarginPoolTotalBorrow

getMarginPoolTotalBorrow(coinKey: string, decimals?: number): Promise<string>
Parameters
- coinKey: string
- decimals: number = 6
Returns Promise<string>
- Defined in packages/deepbook-v3/src/client.ts:461

getMarginPoolTotalSupply

getMarginPoolTotalSupply(coinKey: string, decimals?: number): Promise<string>
Parameters
- coinKey: string
- decimals: number = 6
Returns Promise<string>
- Defined in packages/deepbook-v3/src/client.ts:453

getMinBorrowRiskRatio

getMinBorrowRiskRatio(poolKey: string): Promise<number>
Parameters
- poolKey: string
Returns Promise<number>
- Defined in packages/deepbook-v3/src/client.ts:626

getMinOpenRiskRatio

getMinOpenRiskRatio(poolKey: string): Promise<number>
Minimum risk ratio required to open a new position on the pool. Gates position opening, unlike getMinBorrowRiskRatio, which gates borrowing.
Parameters
- poolKey: string
Returns Promise<number>
- Defined in packages/deepbook-v3/src/client.ts:634

getMinWithdrawRiskRatio

getMinWithdrawRiskRatio(poolKey: string): Promise<number>
Parameters
- poolKey: string
Returns Promise<number>
- Defined in packages/deepbook-v3/src/client.ts:622

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
- orderId: string
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,
>
- Defined in packages/deepbook-v3/src/client.ts:364

getOrderDeepRequired

getOrderDeepRequired(
    poolKey: string,
    baseQuantity: number | bigint,
    price: number | bigint,
): Promise<OrderDeepRequiredResult>
Parameters
- poolKey: string
- baseQuantity: number | bigint
- price: number | bigint
Returns Promise<OrderDeepRequiredResult>
- Defined in packages/deepbook-v3/src/client.ts:350

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
- orderId: string
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,
>
- Defined in packages/deepbook-v3/src/client.ts:368

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
- orderIds: string[]
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,
>
- Defined in packages/deepbook-v3/src/client.ts:372

getPoolDeepPrice

getPoolDeepPrice(poolKey: string): Promise<PoolDeepPrice>
Parameters
- poolKey: string
Returns Promise<PoolDeepPrice>
- Defined in packages/deepbook-v3/src/client.ts:403

getPoolIdByAssets

getPoolIdByAssets(baseType: string, quoteType: string): Promise<string>
Parameters
- baseType: string
- quoteType: string
Returns Promise<string>
- Defined in packages/deepbook-v3/src/client.ts:237

getPoolLiquidationReward

getPoolLiquidationReward(poolKey: string): Promise<number>
Parameters
- poolKey: string
Returns Promise<number>
- Defined in packages/deepbook-v3/src/client.ts:650

getPoolReferralBalances

getPoolReferralBalances(
poolKey: string,
referral: string,
): Promise<ReferralBalances>
Parameters
- poolKey: string
- referral: string
Returns Promise<ReferralBalances>
- Defined in packages/deepbook-v3/src/client.ts:413

getPriceInfoObject

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

getPriceInfoObjectAge

getPriceInfoObjectAge(coinKey: string): Promise<number>
Parameters
- coinKey: string
Returns Promise<number>
- Defined in packages/deepbook-v3/src/client.ts:439

getPriceInfoObjects

getPriceInfoObjects(
tx: Transaction,
coinKeys: string[],
): Promise<Record<string, string>>
Parameters
- tx: Transaction
- coinKeys: string[]
Returns Promise<Record<string, string>>
- Defined in packages/deepbook-v3/src/client.ts:435

getQuantityOut

getQuantityOut(
    poolKey: string,
    baseQuantity: number | bigint,
    quoteQuantity: number | bigint,
): Promise<QuantityOut>
Parameters
- poolKey: string
- baseQuantity: number | bigint
- quoteQuantity: number | bigint
Returns Promise<QuantityOut>
- Defined in packages/deepbook-v3/src/client.ts:304

getQuantityOutInputFee

getQuantityOutInputFee(
    poolKey: string,
    baseQuantity: number | bigint,
    quoteQuantity: number | bigint,
): Promise<QuantityOut>
Parameters
- poolKey: string
- baseQuantity: number | bigint
- quoteQuantity: number | bigint
Returns Promise<QuantityOut>
- Defined in packages/deepbook-v3/src/client.ts:326

getQuoteMarginPoolId

getQuoteMarginPoolId(poolKey: string): Promise<string>
Parameters
- poolKey: string
Returns Promise<string>
- Defined in packages/deepbook-v3/src/client.ts:618

getQuoteQuantityIn

getQuoteQuantityIn(
    poolKey: string,
    targetBaseQuantity: number | bigint,
    payWithDeep: boolean,
): Promise<QuoteQuantityIn>
Parameters
- poolKey: string
- targetBaseQuantity: number | bigint
- payWithDeep: boolean
Returns Promise<QuoteQuantityIn>
- Defined in packages/deepbook-v3/src/client.ts:342

getQuoteQuantityOut

getQuoteQuantityOut(
poolKey: string,
baseQuantity: number | bigint,
): Promise<QuoteQuantityOut>
Parameters
- poolKey: string
- baseQuantity: number | bigint
Returns Promise<QuoteQuantityOut>
- Defined in packages/deepbook-v3/src/client.ts:296

getQuoteQuantityOutInputFee

getQuoteQuantityOutInputFee(
poolKey: string,
baseQuantity: number | bigint,
): Promise<QuoteQuantityOut>
Parameters
- poolKey: string
- baseQuantity: number | bigint
Returns Promise<QuoteQuantityOut>
- Defined in packages/deepbook-v3/src/client.ts:312

getTargetLiquidationRiskRatio

getTargetLiquidationRiskRatio(poolKey: string): Promise<number>
Parameters
- poolKey: string
Returns Promise<number>
- Defined in packages/deepbook-v3/src/client.ts:642

getUserLiquidationReward

getUserLiquidationReward(poolKey: string): Promise<number>
Parameters
- poolKey: string
Returns Promise<number>
- Defined in packages/deepbook-v3/src/client.ts:646

getUserSupplyAmount

getUserSupplyAmount(
    coinKey: string,
    supplierCapId: string,
    decimals?: number,
): Promise<string>
Parameters
- coinKey: string
- supplierCapId: string
- decimals: number = 6
Returns Promise<string>
- Defined in packages/deepbook-v3/src/client.ts:501

getUserSupplyShares

getUserSupplyShares(
    coinKey: string,
    supplierCapId: string,
    decimals?: number,
): Promise<string>
Parameters
- coinKey: string
- supplierCapId: string
- decimals: number = 6
Returns Promise<string>
- Defined in packages/deepbook-v3/src/client.ts:493

isDeepbookPoolAllowed

isDeepbookPoolAllowed(coinKey: string, deepbookPoolId: string): Promise<boolean>
Parameters
- coinKey: string
- deepbookPoolId: string
Returns Promise<boolean>
- Defined in packages/deepbook-v3/src/client.ts:449

isPoolEnabledForMargin

isPoolEnabledForMargin(poolKey: string): Promise<boolean>
Parameters
- poolKey: string
Returns Promise<boolean>
- Defined in packages/deepbook-v3/src/client.ts:606

lockedBalance

lockedBalance(
poolKey: string,
balanceManagerKey: string,
): Promise<LockedBalances>
Parameters
- poolKey: string
- balanceManagerKey: string
Returns Promise<LockedBalances>
- Defined in packages/deepbook-v3/src/client.ts:399

midPrice

midPrice(poolKey: string): Promise<number>
Parameters
- poolKey: string
Returns Promise<number>
- Defined in packages/deepbook-v3/src/client.ts:241

poolBookParams

poolBookParams(poolKey: string): Promise<PoolBookParams>
Parameters
- poolKey: string
Returns Promise<PoolBookParams>
- Defined in packages/deepbook-v3/src/client.ts:249

poolId

poolId(poolKey: string): Promise<string>
Parameters
- poolKey: string
Returns Promise<string>
- Defined in packages/deepbook-v3/src/client.ts:269

poolReferralMultiplier

poolReferralMultiplier(poolKey: string, referral: string): Promise<number>
Parameters
- poolKey: string
- referral: string
Returns Promise<number>
- Defined in packages/deepbook-v3/src/client.ts:421

poolTradeParams

poolTradeParams(poolKey: string): Promise<PoolTradeParams>
Parameters
- poolKey: string
Returns Promise<PoolTradeParams>
- Defined in packages/deepbook-v3/src/client.ts:245

poolTradeParamsNext

poolTradeParamsNext(poolKey: string): Promise<PoolTradeParams>
Parameters
- poolKey: string
Returns Promise<PoolTradeParams>
- Defined in packages/deepbook-v3/src/client.ts:261

quorum

quorum(poolKey: string): Promise<number>
Parameters
- poolKey: string
Returns Promise<number>
- Defined in packages/deepbook-v3/src/client.ts:265

registeredPool

registeredPool(poolKey: string): Promise<boolean>
Parameters
- poolKey: string
Returns Promise<boolean>
- Defined in packages/deepbook-v3/src/client.ts:257

stablePool

stablePool(poolKey: string): Promise<boolean>
Parameters
- poolKey: string
Returns Promise<boolean>
- Defined in packages/deepbook-v3/src/client.ts:253

vaultBalances

vaultBalances(poolKey: string): Promise<VaultBalances>
Parameters
- poolKey: string
Returns Promise<VaultBalances>
- Defined in packages/deepbook-v3/src/client.ts:233

whitelisted

whitelisted(poolKey: string): Promise<boolean>
Parameters
- poolKey: string
Returns Promise<boolean>
- Defined in packages/deepbook-v3/src/client.ts:229

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

Returns Promise<AccountInfo>

accountExists

Parameters

Returns Promise<boolean>

accountOpenOrders

Parameters

Returns Promise<string[]>

balanceManagerReferralOwner

Parameters

Returns Promise<string>

balanceManagerReferralPoolId

Parameters

Returns Promise<string>

canPlaceLimitOrder

Parameters

Returns Promise<boolean>

canPlaceMarketOrder

Parameters

Returns Promise<boolean>

checkLimitOrderParams

Parameters

Returns Promise<boolean>

checkManagerBalance

Parameters

Returns Promise<ManagerBalance>

checkManagerBalancesWithAddress

Parameters

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

checkManagerBalanceWithAddress

Parameters

Returns Promise<ManagerBalance>

checkMarketOrderParams

Parameters

Returns Promise<boolean>

decodeOrderId

Parameters

Returns DecodedOrderId

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; }[],>

getAllowedMaintainers

Returns Promise<string[]>

getAllowedPauseCaps

Returns Promise<string[]>

getBalanceManagerIds

Parameters

Returns Promise<string[]>

getBalanceManagerReferralId

Parameters

Returns Promise<string | null>

getBaseMarginPoolId

Parameters

Returns Promise<string>

getBaseQuantityIn

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;
}[],
>