Class DeepBookContract

DeepBookContract class for managing DeepBook operations.

Constructors

constructor

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

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 deepbook-v3/src/transactions/deepbook.ts:668

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 deepbook-v3/src/transactions/deepbook.ts:444

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 deepbook-v3/src/transactions/deepbook.ts:239

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 deepbook-v3/src/transactions/deepbook.ts:323

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 deepbook-v3/src/transactions/deepbook.ts:193

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 deepbook-v3/src/transactions/deepbook.ts:166

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 deepbook-v3/src/transactions/deepbook.ts:268

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 deepbook-v3/src/transactions/deepbook.ts:722

getBaseQuantityOut

getBaseQuantityOut(
poolKey: string,
quoteQuantity: number,
): (tx: Transaction) => void
Parameters
- poolKey: string
  The key to identify the pool
- quoteQuantity: number
  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 deepbook-v3/src/transactions/deepbook.ts:395

getLevel2Range

getLevel2Range(
    poolKey: string,
    priceLow: number,
    priceHigh: number,
    isBid: boolean,
): (tx: Transaction) => void
Parameters
- poolKey: string
  The key to identify 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 (tx: Transaction) => void
A function that takes a Transaction object

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

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 deepbook-v3/src/transactions/deepbook.ts:490

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 deepbook-v3/src/transactions/deepbook.ts:288

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 deepbook-v3/src/transactions/deepbook.ts:306

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 deepbook-v3/src/transactions/deepbook.ts:705

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 deepbook-v3/src/transactions/deepbook.ts:529

getQuantityOut

getQuantityOut(
    poolKey: string,
    baseQuantity: number,
    quoteQuantity: number,
): (tx: Transaction) => void
Parameters
- poolKey: string
  The key to identify the pool
- baseQuantity: number
  Base quantity to convert
- quoteQuantity: number
  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 deepbook-v3/src/transactions/deepbook.ts:420

getQuoteQuantityOut

getQuoteQuantityOut(
poolKey: string,
baseQuantity: number,
): (tx: Transaction) => void
Parameters
- poolKey: string
  The key to identify the pool
- baseQuantity: number
  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 deepbook-v3/src/transactions/deepbook.ts:373

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 deepbook-v3/src/transactions/deepbook.ts:687

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 deepbook-v3/src/transactions/deepbook.ts:339

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 deepbook-v3/src/transactions/deepbook.ts:135

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 deepbook-v3/src/transactions/deepbook.ts:41

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 deepbook-v3/src/transactions/deepbook.ts:90

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 deepbook-v3/src/transactions/deepbook.ts:650

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 deepbook-v3/src/transactions/deepbook.ts:633

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 deepbook-v3/src/transactions/deepbook.ts:542

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 deepbook-v3/src/transactions/deepbook.ts:586

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 deepbook-v3/src/transactions/deepbook.ts:511

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 deepbook-v3/src/transactions/deepbook.ts:356

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 deepbook-v3/src/transactions/deepbook.ts:219

Class DeepBookContract

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns DeepBookContract

Methods

account

Parameters

Returns (tx: Transaction) => void

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

cancelOrder

Parameters

Returns (tx: Transaction) => void

Description

claimRebates

Parameters

Returns (tx: Transaction) => void

Description

createPermissionlessPool

Parameters

Returns (tx: Transaction) => void

Description

getBaseQuantityOut

Parameters

Returns (tx: Transaction) => void

Description

getLevel2Range

Parameters

Returns (tx: Transaction) => void

Description

getLevel2TicksFromMid

Parameters

Returns (tx: Transaction) => void

Description

getOrder

Parameters

Returns (tx: Transaction) => void

Description

getOrders

Parameters

Returns (tx: Transaction) => void

Description

getPoolDeepPrice

Parameters

Returns (tx: Transaction) => void

Description

getPoolIdByAssets

Parameters

Returns (tx: Transaction) => void

Description

getQuantityOut

Parameters

Returns (tx: Transaction) => void

Description

getQuoteQuantityOut

Parameters

Returns (tx: Transaction) => void

Description

lockedBalance

Parameters

Returns (tx: Transaction) => void

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

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