Class DeepBookContract

DeepBookContract class for managing DeepBook operations.

Index

Constructors

Methods

account accountExists accountOpenOrders addDeepPricePoint burnDeep cancelAllOrders cancelLiveOrder cancelLiveOrders cancelOrder cancelOrders canPlaceLimitOrder canPlaceMarketOrder checkLimitOrderParams checkMarketOrderParams claimPoolReferralRewards claimRebates createPermissionlessPool getAccountOrderDetails getBalanceManagerIds getBaseQuantityIn getBaseQuantityOut getBaseQuantityOutInputFee getLevel2Range getLevel2TicksFromMid getOrder getOrderDeepRequired getOrders getPoolDeepPrice getPoolIdByAssets getPoolReferralBalances getQuantityOut getQuantityOutInputFee getQuoteQuantityIn getQuoteQuantityOut getQuoteQuantityOutInputFee lockedBalance midPrice mintReferral modifyOrder placeLimitOrder placeMarketOrder poolBookParams poolId poolReferralMultiplier poolTradeParams poolTradeParamsNext quorum registeredPool stablePool swapExactBaseForQuote swapExactBaseForQuoteWithManager swapExactQuantity swapExactQuantityWithManager swapExactQuoteForBase swapExactQuoteForBaseWithManager updatePoolAllowedVersions updatePoolReferralMultiplier vaultBalances whitelisted withdrawSettledAmounts withdrawSettledAmountsManagerID withdrawSettledAmountsPermissionless

Constructors

constructor

new DeepBookContract(config: DeepBookConfig): DeepBookContract
Parameters
- config: DeepBookConfig
  Configuration for DeepBookContract
Returns DeepBookContract
- Defined in packages/deepbook-v3/src/transactions/deepbook.ts:35

Methods

account

account(poolKey: string, managerKey: string): (tx: Transaction) => void
Parameters
- poolKey: string
  Key of the pool
- managerKey: string
  The key of the BalanceManager
Returns (tx: Transaction) => void
A function that takes a Transaction object

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

accountExists

accountExists(
poolKey: string,
managerKey: string,
): (tx: Transaction) => TransactionResult
Parameters
- poolKey: string
  The key to identify the pool
- managerKey: string
  Key of the balance manager
Returns (tx: Transaction) => TransactionResult
A function that takes a Transaction object

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

accountOpenOrders

accountOpenOrders(
poolKey: string,
managerKey: string,
): (tx: Transaction) => void
Parameters
- poolKey: string
  The key to identify the pool
- managerKey: string
  Key of the balance manager
Returns (tx: Transaction) => void
A function that takes a Transaction object

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

addDeepPricePoint

addDeepPricePoint(
targetPoolKey: string,
referencePoolKey: string,
): (tx: Transaction) => void
Parameters
- targetPoolKey: string
  The key to identify the target pool
- referencePoolKey: string
  The key to identify the reference pool
Returns (tx: Transaction) => void
A function that takes a Transaction object

Description
Add a deep price point for a target pool using a reference pool
- Defined in packages/deepbook-v3/src/transactions/deepbook.ts:374

burnDeep

burnDeep(poolKey: string): (tx: Transaction) => void
Parameters
- poolKey: string
  The key to identify the pool
Returns (tx: Transaction) => void
A function that takes a Transaction object

Description
Burn DEEP tokens from the pool
- Defined in packages/deepbook-v3/src/transactions/deepbook.ts:534

cancelAllOrders

cancelAllOrders(
poolKey: string,
balanceManagerKey: string,
): (tx: Transaction) => void
Parameters
- poolKey: string
  The key to identify the pool
- balanceManagerKey: string
  The key to identify the BalanceManager
Returns (tx: Transaction) => void
A function that takes a Transaction object

Description
Cancel all open orders for a balance manager
- Defined in packages/deepbook-v3/src/transactions/deepbook.ts:289

cancelLiveOrder

cancelLiveOrder(
    poolKey: string,
    balanceManagerKey: string,
    orderId: string,
): (tx: Transaction) => void
Parameters
- poolKey: string
  The key to identify the pool
- balanceManagerKey: string
  The key to identify the BalanceManager
- orderId: string
  Order ID to cancel
Returns (tx: Transaction) => void
A function that takes a Transaction object

Description
Cancel an existing order, no-op if the order is not currently in the balance manager's open orders (e.g. already filled, cancelled, expired-and-swept, or not owned by this balance manager). Unlike cancelOrder, this will not abort on unknown order ids.
- Defined in packages/deepbook-v3/src/transactions/deepbook.ts:230

cancelLiveOrders

cancelLiveOrders(
    poolKey: string,
    balanceManagerKey: string,
    orderIds: string[],
): (tx: Transaction) => void
Parameters
- poolKey: string
  The key to identify the pool
- balanceManagerKey: string
  The key to identify the BalanceManager
- orderIds: string[]
  Array of order IDs to cancel
Returns (tx: Transaction) => void
A function that takes a Transaction object

Description
Cancel multiple orders, skipping any order_id that is not currently in the balance manager's open orders (e.g. already filled, cancelled, expired-and-swept, or not owned by this balance manager). Duplicate ids in the input vector are handled gracefully. Unlike cancelOrders, this will not abort on unknown order ids.
- Defined in packages/deepbook-v3/src/transactions/deepbook.ts:262

cancelOrder

cancelOrder(
    poolKey: string,
    balanceManagerKey: string,
    orderId: string,
): (tx: Transaction) => void
Parameters
- poolKey: string
  The key to identify the pool
- balanceManagerKey: string
  The key to identify the BalanceManager
- orderId: string
  Order ID to cancel
Returns (tx: Transaction) => void
A function that takes a Transaction object

Description
Cancel an existing order
- Defined in packages/deepbook-v3/src/transactions/deepbook.ts:169

cancelOrders

cancelOrders(
    poolKey: string,
    balanceManagerKey: string,
    orderIds: string[],
): (tx: Transaction) => void
Parameters
- poolKey: string
  The key to identify the pool
- balanceManagerKey: string
  The key to identify the BalanceManager
- orderIds: string[]
  Array of order IDs to cancel
Returns (tx: Transaction) => void
A function that takes a Transaction object

Description
Cancel multiple orders
- Defined in packages/deepbook-v3/src/transactions/deepbook.ts:198

canPlaceLimitOrder

canPlaceLimitOrder(
params: CanPlaceLimitOrderParams,
): (tx: Transaction) => TransactionResult
Parameters
- params: CanPlaceLimitOrderParams
  Parameters for checking limit order validity
Returns (tx: Transaction) => TransactionResult
A function that takes a Transaction object

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

canPlaceMarketOrder

canPlaceMarketOrder(
params: CanPlaceMarketOrderParams,
): (tx: Transaction) => TransactionResult
Parameters
- params: CanPlaceMarketOrderParams
  Parameters for checking market order validity
Returns (tx: Transaction) => TransactionResult
A function that takes a Transaction object

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

checkLimitOrderParams

checkLimitOrderParams(
    poolKey: string,
    price: number | bigint,
    quantity: number | bigint,
    expireTimestamp: number,
): (tx: Transaction) => TransactionResult
Parameters
- poolKey: string
  The key to identify the pool
- price: number | bigint
  Price
- quantity: number | bigint
  Quantity
- expireTimestamp: number
  Expiration timestamp
Returns (tx: Transaction) => TransactionResult
A function that takes a Transaction object

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

checkMarketOrderParams

checkMarketOrderParams(
poolKey: string,
quantity: number | bigint,
): (tx: Transaction) => TransactionResult
Parameters
- poolKey: string
  The key to identify the pool
- quantity: number | bigint
  Quantity
Returns (tx: Transaction) => TransactionResult
A function that takes a Transaction object

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

claimPoolReferralRewards

claimPoolReferralRewards(
    poolKey: string,
    referral: string,
): (
    tx: Transaction,
) => {
    baseRewards: { $kind: "NestedResult"; NestedResult: [number, number] };
    deepRewards: { $kind: "NestedResult"; NestedResult: [number, number] };
    quoteRewards: { $kind: "NestedResult"; NestedResult: [number, number] };
}
Parameters
- poolKey: string
  The key to identify the pool
- referral: string
  The referral (DeepBookPoolReferral) to claim the rewards for
Returns (
    tx: Transaction,
) => {
    baseRewards: { $kind: "NestedResult"; NestedResult: [number, number] };
    deepRewards: { $kind: "NestedResult"; NestedResult: [number, number] };
    quoteRewards: { $kind: "NestedResult"; NestedResult: [number, number] };
}
A function that takes a Transaction object

Description
Claim the rewards for a referral (DeepBookPoolReferral)
- Defined in packages/deepbook-v3/src/transactions/deepbook.ts:463

claimRebates

claimRebates(
poolKey: string,
balanceManagerKey: string,
): (tx: Transaction) => void
Parameters
- poolKey: string
  The key to identify the pool
- balanceManagerKey: string
  The key to identify the BalanceManager
Returns (tx: Transaction) => void
A function that takes a Transaction object

Description
Claim rebates for a balance manager
- Defined in packages/deepbook-v3/src/transactions/deepbook.ts:403

createPermissionlessPool

createPermissionlessPool(
params: CreatePermissionlessPoolParams,
): (tx: Transaction) => void
Parameters
- params: CreatePermissionlessPoolParams
  Parameters for creating permissionless pool
Returns (tx: Transaction) => void
A function that takes a Transaction object

Description
Create a new pool permissionlessly
- Defined in packages/deepbook-v3/src/transactions/deepbook.ts:1067

getAccountOrderDetails

getAccountOrderDetails(
poolKey: string,
managerKey: string,
): (tx: Transaction) => TransactionResult
Parameters
- poolKey: string
  The key to identify the pool
- managerKey: string
  Key of the balance manager
Returns (tx: Transaction) => TransactionResult
A function that takes a Transaction object

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

getBalanceManagerIds

getBalanceManagerIds(owner: string): (tx: Transaction) => void
Parameters
- owner: string
  The owner address to get balance manager IDs for
Returns (tx: Transaction) => void
A function that takes a Transaction object

Description
Get the balance manager IDs for a given owner
- Defined in packages/deepbook-v3/src/transactions/deepbook.ts:1195

getBaseQuantityIn

getBaseQuantityIn(
    poolKey: string,
    targetQuoteQuantity: number | bigint,
    payWithDeep: boolean,
): (tx: Transaction) => TransactionResult
Parameters
- poolKey: string
  The key to identify the pool
- targetQuoteQuantity: number | bigint
  Target quote quantity
- payWithDeep: boolean
  Whether to pay fees with DEEP
Returns (tx: Transaction) => TransactionResult
A function that takes a Transaction object

Description
Get the base quantity needed to receive a target quote quantity
- Defined in packages/deepbook-v3/src/transactions/deepbook.ts:1352

getBaseQuantityOut

getBaseQuantityOut(
poolKey: string,
quoteQuantity: number | bigint,
): (tx: Transaction) => void
Parameters
- poolKey: string
  The key to identify the pool
- quoteQuantity: number | bigint
  Quote quantity to convert
Returns (tx: Transaction) => void
A function that takes a Transaction object

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

getBaseQuantityOutInputFee

getBaseQuantityOutInputFee(
poolKey: string,
quoteQuantity: number | bigint,
): (tx: Transaction) => TransactionResult
Parameters
- poolKey: string
  The key to identify the pool
- quoteQuantity: number | bigint
  Quote quantity to convert
Returns (tx: Transaction) => TransactionResult
A function that takes a Transaction object

Description
Get the base quantity out for a given quote quantity using input token as fee
- Defined in packages/deepbook-v3/src/transactions/deepbook.ts:1302

getLevel2Range

getLevel2Range(
    poolKey: string,
    priceLow: number | bigint,
    priceHigh: number | bigint,
    isBid: boolean,
): (tx: Transaction) => void
Parameters
- poolKey: string
  The key to identify the pool
- priceLow: number | bigint
  Lower bound of the price range
- priceHigh: number | bigint
  Upper bound of the price range
- isBid: boolean
  Whether to get bid or ask orders
Returns (tx: Transaction) => void
A function that takes a Transaction object

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

getLevel2TicksFromMid

getLevel2TicksFromMid(
poolKey: string,
tickFromMid: number,
): (tx: Transaction) => void
Parameters
- poolKey: string
  The key to identify the pool
- tickFromMid: number
  Number of ticks from mid-price
Returns (tx: Transaction) => void
A function that takes a Transaction object

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

getOrder

getOrder(poolKey: string, orderId: string): (tx: Transaction) => void
Parameters
- poolKey: string
  The key to identify the pool
- orderId: string
  Order ID to get
Returns (tx: Transaction) => void
A function that takes a Transaction object

Description
Gets an order
- Defined in packages/deepbook-v3/src/transactions/deepbook.ts:499

getOrderDeepRequired

getOrderDeepRequired(
    poolKey: string,
    baseQuantity: number | bigint,
    price: number | bigint,
): (tx: Transaction) => TransactionResult
Parameters
- poolKey: string
  The key to identify the pool
- baseQuantity: number | bigint
  Base quantity
- price: number | bigint
  Price
Returns (tx: Transaction) => TransactionResult
A function that takes a Transaction object

Description
Get the DEEP required for an order
- Defined in packages/deepbook-v3/src/transactions/deepbook.ts:1423

getOrders

getOrders(poolKey: string, orderIds: string[]): (tx: Transaction) => void
Parameters
- poolKey: string
  The identifier key for the pool to retrieve orders from.
- orderIds: string[]
  Array of order IDs to retrieve.
Returns (tx: Transaction) => void
A function that takes a Transaction object

Description
Prepares a transaction to retrieve multiple orders from a specified pool.
- Defined in packages/deepbook-v3/src/transactions/deepbook.ts:517

getPoolDeepPrice

getPoolDeepPrice(poolKey: string): (tx: Transaction) => void
Parameters
- poolKey: string
  The key to identify the pool
Returns (tx: Transaction) => void
A function that takes a Transaction object

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

getPoolIdByAssets

getPoolIdByAssets(
baseType: string,
quoteType: string,
): (tx: Transaction) => void
Parameters
- baseType: string
  Type of the base asset
- quoteType: string
  Type of the quote asset
Returns (tx: Transaction) => void
A function that takes a Transaction object

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

getPoolReferralBalances

getPoolReferralBalances(
poolKey: string,
referral: string,
): (tx: Transaction) => TransactionResult
Parameters
- poolKey: string
  The key to identify the pool
- referral: string
  The referral (DeepBookPoolReferral) to get the balances for
Returns (tx: Transaction) => TransactionResult
A function that takes a Transaction object

Description
Get the balances for a referral (DeepBookPoolReferral)
- Defined in packages/deepbook-v3/src/transactions/deepbook.ts:1208

getQuantityOut

getQuantityOut(
    poolKey: string,
    baseQuantity: number | bigint,
    quoteQuantity: number | bigint,
): (tx: Transaction) => void
Parameters
- poolKey: string
  The key to identify the pool
- baseQuantity: number | bigint
  Base quantity to convert
- quoteQuantity: number | bigint
  Quote quantity to convert
Returns (tx: Transaction) => void
A function that takes a Transaction object

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

getQuantityOutInputFee

getQuantityOutInputFee(
    poolKey: string,
    baseQuantity: number | bigint,
    quoteQuantity: number | bigint,
): (tx: Transaction) => TransactionResult
Parameters
- poolKey: string
  The key to identify the pool
- baseQuantity: number | bigint
  Base quantity to convert
- quoteQuantity: number | bigint
  Quote quantity to convert
Returns (tx: Transaction) => TransactionResult
A function that takes a Transaction object

Description
Get the quantity out for a given base or quote quantity using input token as fee
- Defined in packages/deepbook-v3/src/transactions/deepbook.ts:1326

getQuoteQuantityIn

getQuoteQuantityIn(
    poolKey: string,
    targetBaseQuantity: number | bigint,
    payWithDeep: boolean,
): (tx: Transaction) => TransactionResult
Parameters
- poolKey: string
  The key to identify the pool
- targetBaseQuantity: number | bigint
  Target base quantity
- payWithDeep: boolean
  Whether to pay fees with DEEP
Returns (tx: Transaction) => TransactionResult
A function that takes a Transaction object

Description
Get the quote quantity needed to receive a target base quantity
- Defined in packages/deepbook-v3/src/transactions/deepbook.ts:1378

getQuoteQuantityOut

getQuoteQuantityOut(
poolKey: string,
baseQuantity: number | bigint,
): (tx: Transaction) => void
Parameters
- poolKey: string
  The key to identify the pool
- baseQuantity: number | bigint
  Base quantity to convert
Returns (tx: Transaction) => void
A function that takes a Transaction object

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

getQuoteQuantityOutInputFee

getQuoteQuantityOutInputFee(
poolKey: string,
baseQuantity: number | bigint,
): (tx: Transaction) => TransactionResult
Parameters
- poolKey: string
  The key to identify the pool
- baseQuantity: number | bigint
  Base quantity to convert
Returns (tx: Transaction) => TransactionResult
A function that takes a Transaction object

Description
Get the quote quantity out for a given base quantity using input token as fee
- Defined in packages/deepbook-v3/src/transactions/deepbook.ts:1279

lockedBalance

lockedBalance(poolKey: string, managerKey: string): (tx: Transaction) => void
Parameters
- poolKey: string
  Key of the pool
- managerKey: string
  The key of the BalanceManager
Returns (tx: Transaction) => void
A function that takes a Transaction object

Description
Get the locked balance for a given pool and balance manager
- Defined in packages/deepbook-v3/src/transactions/deepbook.ts:1160

midPrice

midPrice(poolKey: string): (tx: Transaction) => void
Parameters
- poolKey: string
  The key to identify the pool
Returns (tx: Transaction) => void
A function that takes a Transaction object

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

mintReferral

mintReferral(poolKey: string, multiplier: number): (tx: Transaction) => void
Parameters
- poolKey: string
  The key to identify the pool
- multiplier: number
  The multiplier for the referral
Returns (tx: Transaction) => void
A function that takes a Transaction object

Description
Mint a referral for a pool
- Defined in packages/deepbook-v3/src/transactions/deepbook.ts:423

modifyOrder

modifyOrder(
    poolKey: string,
    balanceManagerKey: string,
    orderId: string,
    newQuantity: number,
): (tx: Transaction) => void
Parameters
- poolKey: string
  The key to identify the pool
- balanceManagerKey: string
  The key to identify the BalanceManager
- orderId: string
  Order ID to modify
- newQuantity: number
  New quantity for the order
Returns (tx: Transaction) => void
A function that takes a Transaction object

Description
Modify an existing order
- Defined in packages/deepbook-v3/src/transactions/deepbook.ts:138

placeLimitOrder

placeLimitOrder(params: PlaceLimitOrderParams): (tx: Transaction) => void
Parameters
- params: PlaceLimitOrderParams
  Parameters for placing a limit order
Returns (tx: Transaction) => void
A function that takes a Transaction object

Description
Place a limit order
- Defined in packages/deepbook-v3/src/transactions/deepbook.ts:44

placeMarketOrder

placeMarketOrder(params: PlaceMarketOrderParams): (tx: Transaction) => void
Parameters
- params: PlaceMarketOrderParams
  Parameters for placing a market order
Returns (tx: Transaction) => void
A function that takes a Transaction object

Description
Place a market order
- Defined in packages/deepbook-v3/src/transactions/deepbook.ts:93

poolBookParams

poolBookParams(poolKey: string): (tx: Transaction) => void
Parameters
- poolKey: string
  Key of the pool
Returns (tx: Transaction) => void
A function that takes a Transaction object

Description
Get the book parameters for a given pool, including tick size, lot size, and min size.
- Defined in packages/deepbook-v3/src/transactions/deepbook.ts:1123

poolId

poolId(poolKey: string): (tx: Transaction) => TransactionResult
Parameters
- poolKey: string
  The key to identify the pool
Returns (tx: Transaction) => TransactionResult
A function that takes a Transaction object

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

poolReferralMultiplier

poolReferralMultiplier(
poolKey: string,
referral: string,
): (tx: Transaction) => TransactionResult
Parameters
- poolKey: string
  The key to identify the pool
- referral: string
  The referral (DeepBookPoolReferral) to get the multiplier for
Returns (tx: Transaction) => TransactionResult
A function that takes a Transaction object

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

poolTradeParams

poolTradeParams(poolKey: string): (tx: Transaction) => void
Parameters
- poolKey: string
  Key of the pool
Returns (tx: Transaction) => void
A function that takes a Transaction object

Description
Get the trade parameters for a given pool, including taker fee, maker fee, and stake required.
- Defined in packages/deepbook-v3/src/transactions/deepbook.ts:1106

poolTradeParamsNext

poolTradeParamsNext(poolKey: string): (tx: Transaction) => TransactionResult
Parameters
- poolKey: string
  The key to identify the pool
Returns (tx: Transaction) => TransactionResult
A function that takes a Transaction object

Description
Get the next epoch trade parameters for a pool
- Defined in packages/deepbook-v3/src/transactions/deepbook.ts:1462

quorum

quorum(poolKey: string): (tx: Transaction) => TransactionResult
Parameters
- poolKey: string
  The key to identify the pool
Returns (tx: Transaction) => TransactionResult
A function that takes a Transaction object

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

registeredPool

registeredPool(poolKey: string): (tx: Transaction) => TransactionResult
Parameters
- poolKey: string
  The key to identify the pool
Returns (tx: Transaction) => TransactionResult
A function that takes a Transaction object

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

stablePool

stablePool(poolKey: string): (tx: Transaction) => TransactionResult
Parameters
- poolKey: string
  The key to identify the pool
Returns (tx: Transaction) => TransactionResult
A function that takes a Transaction object

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

swapExactBaseForQuote

swapExactBaseForQuote(
    params: SwapParams,
): (
    tx: Transaction,
) => readonly [
    { $kind: "NestedResult"; NestedResult: [number, number] },
    { $kind: "NestedResult"; NestedResult: [number, number] },
    { $kind: "NestedResult"; NestedResult: [number, number] },
]
Parameters
- params: SwapParams
  Parameters for the swap
Returns (
    tx: Transaction,
) => readonly [
    { $kind: "NestedResult"; NestedResult: [number, number] },
    { $kind: "NestedResult"; NestedResult: [number, number] },
    { $kind: "NestedResult"; NestedResult: [number, number] },
]
A function that takes a Transaction object

Description
Swap exact base amount for quote amount
- Defined in packages/deepbook-v3/src/transactions/deepbook.ts:751

swapExactBaseForQuoteWithManager

swapExactBaseForQuoteWithManager(
    params: SwapWithManagerParams,
): (
    tx: Transaction,
) => readonly [
    { $kind: "NestedResult"; NestedResult: [number, number] },
    { $kind: "NestedResult"; NestedResult: [number, number] },
]
Parameters
- params: SwapWithManagerParams
  Parameters for the swap
Returns (
    tx: Transaction,
) => readonly [
    { $kind: "NestedResult"; NestedResult: [number, number] },
    { $kind: "NestedResult"; NestedResult: [number, number] },
]
A function that takes a Transaction object

Description
Swap exact base for quote with a balance manager
- Defined in packages/deepbook-v3/src/transactions/deepbook.ts:903

swapExactQuantity

swapExactQuantity(
    params: SwapParams & { isBaseToCoin: boolean },
): (
    tx: Transaction,
) => readonly [
    { $kind: "NestedResult"; NestedResult: [number, number] },
    { $kind: "NestedResult"; NestedResult: [number, number] },
    { $kind: "NestedResult"; NestedResult: [number, number] },
]
Parameters
- params: SwapParams & { isBaseToCoin: boolean }
  Parameters for the swap
Returns (
    tx: Transaction,
) => readonly [
    { $kind: "NestedResult"; NestedResult: [number, number] },
    { $kind: "NestedResult"; NestedResult: [number, number] },
    { $kind: "NestedResult"; NestedResult: [number, number] },
]
A function that takes a Transaction object

Description
Swap exact quantity without a balance manager
- Defined in packages/deepbook-v3/src/transactions/deepbook.ts:845

swapExactQuantityWithManager

swapExactQuantityWithManager(
    params: SwapWithManagerParams & { isBaseToCoin: boolean },
): (
    tx: Transaction,
) => readonly [
    { $kind: "NestedResult"; NestedResult: [number, number] },
    { $kind: "NestedResult"; NestedResult: [number, number] },
]
Parameters
- params: SwapWithManagerParams & { isBaseToCoin: boolean }
  Parameters for the swap
Returns (
    tx: Transaction,
) => readonly [
    { $kind: "NestedResult"; NestedResult: [number, number] },
    { $kind: "NestedResult"; NestedResult: [number, number] },
]
A function that takes a Transaction object

Description
Swap exact quantity (base or quote) with a balance manager
- Defined in packages/deepbook-v3/src/transactions/deepbook.ts:1002

swapExactQuoteForBase

swapExactQuoteForBase(
    params: SwapParams,
): (
    tx: Transaction,
) => readonly [
    { $kind: "NestedResult"; NestedResult: [number, number] },
    { $kind: "NestedResult"; NestedResult: [number, number] },
    { $kind: "NestedResult"; NestedResult: [number, number] },
]
Parameters
- params: SwapParams
  Parameters for the swap
Returns (
    tx: Transaction,
) => readonly [
    { $kind: "NestedResult"; NestedResult: [number, number] },
    { $kind: "NestedResult"; NestedResult: [number, number] },
    { $kind: "NestedResult"; NestedResult: [number, number] },
]
A function that takes a Transaction object

Description
Swap exact quote amount for base amount
- Defined in packages/deepbook-v3/src/transactions/deepbook.ts:798

swapExactQuoteForBaseWithManager

swapExactQuoteForBaseWithManager(
    params: SwapWithManagerParams,
): (
    tx: Transaction,
) => readonly [
    { $kind: "NestedResult"; NestedResult: [number, number] },
    { $kind: "NestedResult"; NestedResult: [number, number] },
]
Parameters
- params: SwapWithManagerParams
  Parameters for the swap
Returns (
    tx: Transaction,
) => readonly [
    { $kind: "NestedResult"; NestedResult: [number, number] },
    { $kind: "NestedResult"; NestedResult: [number, number] },
]
A function that takes a Transaction object

Description
Swap exact quote for base with a balance manager
- Defined in packages/deepbook-v3/src/transactions/deepbook.ts:952

updatePoolAllowedVersions

updatePoolAllowedVersions(poolKey: string): (tx: Transaction) => void
Parameters
- poolKey: string
  The key of the pool to be updated
Returns (tx: Transaction) => void
A function that takes a Transaction object

Description
Update the allowed versions for a pool
- Defined in packages/deepbook-v3/src/transactions/deepbook.ts:482

updatePoolReferralMultiplier

updatePoolReferralMultiplier(
    poolKey: string,
    referral: string,
    multiplier: number,
): (tx: Transaction) => void
Parameters
- poolKey: string
  The key to identify the pool
- referral: string
  The referral (DeepBookPoolReferral) to update
- multiplier: number
  The multiplier for the referral
Returns (tx: Transaction) => void
A function that takes a Transaction object

Description
Update the referral multiplier for a pool (DeepBookPoolReferral)
- Defined in packages/deepbook-v3/src/transactions/deepbook.ts:444

vaultBalances

vaultBalances(poolKey: string): (tx: Transaction) => void
Parameters
- poolKey: string
  The key to identify the pool
Returns (tx: Transaction) => void
A function that takes a Transaction object

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

whitelisted

whitelisted(poolKey: string): (tx: Transaction) => void
Parameters
- poolKey: string
  The key to identify the pool
Returns (tx: Transaction) => void
A function that takes a Transaction object

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

withdrawSettledAmounts

withdrawSettledAmounts(
poolKey: string,
balanceManagerKey: string,
): (tx: Transaction) => void
Parameters
- poolKey: string
  The key to identify the pool
- balanceManagerKey: string
  The key to identify the BalanceManager
Returns (tx: Transaction) => void
A function that takes a Transaction object

Description
Withdraw settled amounts for a balance manager
- Defined in packages/deepbook-v3/src/transactions/deepbook.ts:315

withdrawSettledAmountsManagerID

withdrawSettledAmountsManagerID(
poolKey: string,
balanceManagerId: string,
): (tx: Transaction) => void
Parameters
- poolKey: string
  The key to identify the pool
- balanceManagerId: string
  The object ID of the BalanceManager
Returns (tx: Transaction) => void
A function that takes a Transaction object

Description
Withdraw settled amounts permissionlessly for a balance manager by ID
- Defined in packages/deepbook-v3/src/transactions/deepbook.ts:356

withdrawSettledAmountsPermissionless

withdrawSettledAmountsPermissionless(
poolKey: string,
balanceManagerKey: string,
): (tx: Transaction) => void
Parameters
- poolKey: string
  The key to identify the pool
- balanceManagerKey: string
  The key to identify the BalanceManager
Returns (tx: Transaction) => void
A function that takes a Transaction object

Description
Withdraw settled amounts permissionlessly for a balance manager
- Defined in packages/deepbook-v3/src/transactions/deepbook.ts:336

Class DeepBookContract

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns DeepBookContract

Methods

account

Parameters

Returns (tx: Transaction) => void

Description

accountExists

Parameters

Returns (tx: Transaction) => TransactionResult

Description

accountOpenOrders

Parameters

Returns (tx: Transaction) => void

Description

addDeepPricePoint

Parameters

Returns (tx: Transaction) => void

Description

burnDeep

Parameters

Returns (tx: Transaction) => void

Description

cancelAllOrders

Parameters

Returns (tx: Transaction) => void

Description

cancelLiveOrder

Parameters

Returns (tx: Transaction) => void

Description

cancelLiveOrders

Parameters

Returns (tx: Transaction) => void

Description

cancelOrder

Parameters

Returns (tx: Transaction) => void

Description

cancelOrders

Parameters

Returns (tx: Transaction) => void

Description

canPlaceLimitOrder

Parameters

Returns (tx: Transaction) => TransactionResult

Description

canPlaceMarketOrder

Parameters

Returns (tx: Transaction) => TransactionResult

Description

checkLimitOrderParams

Parameters

Returns (tx: Transaction) => TransactionResult

Description

checkMarketOrderParams

Parameters

Returns (tx: Transaction) => TransactionResult

Description

claimPoolReferralRewards

Parameters

Returns ( tx: Transaction,) => { baseRewards: { $kind: "NestedResult"; NestedResult: [number, number] }; deepRewards: { $kind: "NestedResult"; NestedResult: [number, number] }; quoteRewards: { $kind: "NestedResult"; NestedResult: [number, number] };}

Description

claimRebates

Parameters

Returns (tx: Transaction) => void

Description

createPermissionlessPool

Parameters

Returns (tx: Transaction) => void

Description

getAccountOrderDetails

Parameters

Returns (tx: Transaction) => TransactionResult

Returns (
tx: Transaction,
) => {
baseRewards: { $kind: "NestedResult"; NestedResult: [number, number] };
deepRewards: { $kind: "NestedResult"; NestedResult: [number, number] };
quoteRewards: { $kind: "NestedResult"; NestedResult: [number, number] };
}