Class MarginManagerContract

MarginManagerContract class for managing MarginManager operations.

Constructors

constructor

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

Methods

account

account(
poolKey: string,
marginManagerId: string,
): (tx: Transaction) => TransactionResult
Parameters
- poolKey: string
  The key to identify the pool
- marginManagerId: string
  The ID of the margin manager
Returns (tx: Transaction) => TransactionResult
A function that takes a Transaction object

Description
Get the pool account data for the margin manager.
- Defined in packages/deepbook-v3/src/transactions/marginManager.ts:855

accountExists

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

Description
Check if the margin manager's account exists in the pool.
- Defined in packages/deepbook-v3/src/transactions/marginManager.ts:838

accountOpenOrders

accountOpenOrders(
poolKey: string,
marginManagerId: string,
): (tx: Transaction) => TransactionResult
Parameters
- poolKey: string
  The key to identify the pool
- marginManagerId: string
  The ID of the margin manager
Returns (tx: Transaction) => TransactionResult
A function that takes a Transaction object

Description
Get the open order IDs for the margin manager's account in the pool.
- Defined in packages/deepbook-v3/src/transactions/marginManager.ts:873

balanceManager

balanceManager(
poolKey: string,
marginManagerId: string,
): (tx: Transaction) => TransactionResult
Parameters
- poolKey: string
  The key to identify the pool
- marginManagerId: string
  The ID of the margin manager
Returns (tx: Transaction) => TransactionResult
A function that takes a Transaction object

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

balanceManagerId

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

Description
Get the underlying BalanceManager ID for a margin manager. Returns an ID (not a &BalanceManager), so it composes in PTBs unlike balanceManager.
- Defined in packages/deepbook-v3/src/transactions/marginManager.ts:804

baseBalance

baseBalance(
poolKey: string,
marginManagerId: string,
): (tx: Transaction) => TransactionResult
Parameters
- poolKey: string
  The key to identify the pool
- marginManagerId: string
  The ID of the margin manager
Returns (tx: Transaction) => TransactionResult
A function that takes a Transaction object

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

borrowBase

borrowBase(
managerKey: string,
amount: number,
): (tx: Transaction) => TransactionResult
Parameters
- managerKey: string
  The key to identify the manager
- amount: number
  The amount to borrow
Returns (tx: Transaction) => TransactionResult
A function that takes a Transaction object

Description
Borrow base from a margin manager
- Defined in packages/deepbook-v3/src/transactions/marginManager.ts:356

borrowedBaseShares

borrowedBaseShares(
poolKey: string,
marginManagerId: string,
): (tx: Transaction) => TransactionResult
Parameters
- poolKey: string
  The key to identify the pool
- marginManagerId: string
  The ID of the margin manager
Returns (tx: Transaction) => TransactionResult
A function that takes a Transaction object

Description
Get borrowed base shares
- Defined in packages/deepbook-v3/src/transactions/marginManager.ts:614

borrowedQuoteShares

borrowedQuoteShares(
poolKey: string,
marginManagerId: string,
): (tx: Transaction) => TransactionResult
Parameters
- poolKey: string
  The key to identify the pool
- marginManagerId: string
  The ID of the margin manager
Returns (tx: Transaction) => TransactionResult
A function that takes a Transaction object

Description
Get borrowed quote shares
- Defined in packages/deepbook-v3/src/transactions/marginManager.ts:631

borrowedShares

borrowedShares(
poolKey: string,
marginManagerId: string,
): (tx: Transaction) => TransactionResult
Parameters
- poolKey: string
  The key to identify the pool
- marginManagerId: string
  The ID of the margin manager
Returns (tx: Transaction) => TransactionResult
A function that takes a Transaction object

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

borrowQuote

borrowQuote(
managerKey: string,
amount: number,
): (tx: Transaction) => TransactionResult
Parameters
- managerKey: string
  The key to identify the manager
- amount: number
  The amount to borrow
Returns (tx: Transaction) => TransactionResult
A function that takes a Transaction object

Description
Borrow quote from a margin manager
- Defined in packages/deepbook-v3/src/transactions/marginManager.ts:384

calculateAssets

calculateAssets(
poolKey: string,
marginManagerId: string,
): (tx: Transaction) => TransactionResult
Parameters
- poolKey: string
  The key to identify the pool
- marginManagerId: string
  The ID of the margin manager
Returns (tx: Transaction) => TransactionResult
A function that takes a Transaction object

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

calculateDebts

calculateDebts(
    poolKey: string,
    coinKey: string,
    marginManagerId: string,
): (tx: Transaction) => TransactionResult
Parameters
- poolKey: string
  The key to identify the pool
- coinKey: string
  The key to identify the debt coin (base or quote)
- marginManagerId: string
  The ID of the margin manager
Returns (tx: Transaction) => TransactionResult
A function that takes a Transaction object

Description
Calculate debts (base and quote) for a margin manager
- Defined in packages/deepbook-v3/src/transactions/marginManager.ts:701

canPlaceLimitOrder

canPlaceLimitOrder(
    poolKey: string,
    marginManagerId: string,
    price: number | bigint,
    quantity: number | bigint,
    isBid: boolean,
    payWithDeep: boolean,
    expireTimestamp: number | bigint,
): (tx: Transaction) => TransactionResult
Parameters
- poolKey: string
  The key to identify the pool
- marginManagerId: string
  The ID of the margin manager
- price: number | bigint
  Limit price
- quantity: number | bigint
  Order quantity (base units)
- isBid: boolean
  True for bid, false for ask
- payWithDeep: boolean
  Whether to pay fees in DEEP
- expireTimestamp: number | bigint
  Order expiration timestamp (ms)
Returns (tx: Transaction) => TransactionResult
A function that takes a Transaction object

Description
Check whether a limit order can be placed given the manager's current state.
- Defined in packages/deepbook-v3/src/transactions/marginManager.ts:933

canPlaceMarketOrder

canPlaceMarketOrder(
    poolKey: string,
    marginManagerId: string,
    quantity: number | bigint,
    isBid: boolean,
    payWithDeep: boolean,
): (tx: Transaction) => TransactionResult
Parameters
- poolKey: string
  The key to identify the pool
- marginManagerId: string
  The ID of the margin manager
- quantity: number | bigint
  Order quantity (base units)
- isBid: boolean
  True for bid, false for ask
- payWithDeep: boolean
  Whether to pay fees in DEEP
Returns (tx: Transaction) => TransactionResult
A function that takes a Transaction object

Description
Check whether a market order can be placed given the manager's current state.
- Defined in packages/deepbook-v3/src/transactions/marginManager.ts:975

deepBalance

deepBalance(
poolKey: string,
marginManagerId: string,
): (tx: Transaction) => TransactionResult
Parameters
- poolKey: string
  The key to identify the pool
- marginManagerId: string
  The ID of the margin manager
Returns (tx: Transaction) => TransactionResult
A function that takes a Transaction object

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

deepbookPool

deepbookPool(
poolKey: string,
marginManagerId: string,
): (tx: Transaction) => TransactionResult
Parameters
- poolKey: string
  The key to identify the pool
- marginManagerId: string
  The ID of the margin manager
Returns (tx: Transaction) => TransactionResult
A function that takes a Transaction object

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

depositBase

depositBase(params: DepositParams): (tx: Transaction) => void
Parameters
- params: DepositParams
  The deposit parameters
Returns (tx: Transaction) => void
A function that takes a Transaction object

Description
Deposit base into a margin manager
- Defined in packages/deepbook-v3/src/transactions/marginManager.ts:167

depositDeep

depositDeep(params: DepositParams): (tx: Transaction) => void
Parameters
- params: DepositParams
  The deposit parameters
Returns (tx: Transaction) => void
A function that takes a Transaction object

Description
Deposit deep into a margin manager
- Defined in packages/deepbook-v3/src/transactions/marginManager.ts:231

depositDuringInitialization

depositDuringInitialization(
params: DepositDuringInitParams,
): (tx: Transaction) => void
Parameters
- params: DepositDuringInitParams
  The deposit parameters
Returns (tx: Transaction) => void
A function that takes a Transaction object

Description
Deposit into a margin manager during initialization (before sharing). Use this when you need to deposit funds into a newly created manager in the same transaction.
- Defined in packages/deepbook-v3/src/transactions/marginManager.ts:130

depositQuote

depositQuote(params: DepositParams): (tx: Transaction) => void
Parameters
- params: DepositParams
  The deposit parameters
Returns (tx: Transaction) => void
A function that takes a Transaction object

Description
Deposit quote into a margin manager
- Defined in packages/deepbook-v3/src/transactions/marginManager.ts:199

getAccountOrderDetails

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

Description
Get full order details for the margin manager's account in the pool.
- Defined in packages/deepbook-v3/src/transactions/marginManager.ts:891

getBalanceManagerReferralId

getBalanceManagerReferralId(
poolKey: string,
marginManagerId: string,
): (tx: Transaction) => TransactionResult
Parameters
- poolKey: string
  The key to identify the pool
- marginManagerId: string
  The ID of the margin manager
Returns (tx: Transaction) => TransactionResult
A function that takes a Transaction object

Description
Get the BalanceManager referral ID for a pool (Option).
- Defined in packages/deepbook-v3/src/transactions/marginManager.ts:821

hasBaseDebt

hasBaseDebt(
poolKey: string,
marginManagerId: string,
): (tx: Transaction) => TransactionResult
Parameters
- poolKey: string
  The key to identify the pool
- marginManagerId: string
  The ID of the margin manager
Returns (tx: Transaction) => TransactionResult
A function that takes a Transaction object

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

liquidate

liquidate(
    managerAddress: string,
    poolKey: string,
    debtIsBase: boolean,
    repayCoin: TransactionArgument,
): (tx: Transaction) => TransactionResult
Parameters
- managerAddress: string
  The address of the manager to liquidate
- poolKey: string
  The key to identify the pool
- debtIsBase: boolean
  Whether the debt is in base
- repayCoin: TransactionArgument
  The coin to repay
Returns (tx: Transaction) => TransactionResult
A function that takes a Transaction object

Description
Liquidate a margin manager
- Defined in packages/deepbook-v3/src/transactions/marginManager.ts:471

lockedBalance

lockedBalance(
poolKey: string,
marginManagerId: string,
): (tx: Transaction) => TransactionResult
Parameters
- poolKey: string
  The key to identify the pool
- marginManagerId: string
  The ID of the margin manager
Returns (tx: Transaction) => TransactionResult
A function that takes a Transaction object

Description
Get locked balances (base, quote, deep) for the margin manager's account in the pool.
- Defined in packages/deepbook-v3/src/transactions/marginManager.ts:909

managerState

managerState(
poolKey: string,
marginManagerId: string,
): (tx: Transaction) => TransactionResult
Parameters
- poolKey: string
  The key to identify the pool
- marginManagerId: string
  The ID of the margin manager
Returns (tx: Transaction) => TransactionResult
A function that takes a Transaction object

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

marginPoolId

marginPoolId(
poolKey: string,
marginManagerId: string,
): (tx: Transaction) => TransactionResult
Parameters
- poolKey: string
  The key to identify the pool
- marginManagerId: string
  The ID of the margin manager
Returns (tx: Transaction) => TransactionResult
A function that takes a Transaction object

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

newMarginManager

newMarginManager(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
Create a new margin manager
- Defined in packages/deepbook-v3/src/transactions/marginManager.ts:29

newMarginManagerWithInitializer

newMarginManagerWithInitializer(
    poolKey: string,
): (
    tx: Transaction,
) => {
    initializer: { $kind: "NestedResult"; NestedResult: [number, number] };
    manager: { $kind: "NestedResult"; NestedResult: [number, number] };
}
Parameters
- poolKey: string
  The key to identify the pool
Returns (
    tx: Transaction,
) => {
    initializer: { $kind: "NestedResult"; NestedResult: [number, number] };
    manager: { $kind: "NestedResult"; NestedResult: [number, number] };
}
A function that takes a Transaction object

Description
Create a new margin manager with an initializer
- Defined in packages/deepbook-v3/src/transactions/marginManager.ts:50

ownerByPoolKey

ownerByPoolKey(
poolKey: string,
marginManagerId: string,
): (tx: Transaction) => TransactionResult
Parameters
- poolKey: string
  The key to identify the pool
- marginManagerId: string
  The ID of the margin manager
Returns (tx: Transaction) => TransactionResult
A function that takes a Transaction object

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

quoteBalance

quoteBalance(
poolKey: string,
marginManagerId: string,
): (tx: Transaction) => TransactionResult
Parameters
- poolKey: string
  The key to identify the pool
- marginManagerId: string
  The ID of the margin manager
Returns (tx: Transaction) => TransactionResult
A function that takes a Transaction object

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

registerMarginManager

registerMarginManager(managerKey: string): (tx: Transaction) => void
Parameters
- managerKey: string
  The key to identify the margin manager
Returns (tx: Transaction) => void
A function that takes a Transaction object

Description
Register a margin manager back to the margin registry. Lets owners restore visibility of a manager that was unregistered by another platform.
- Defined in packages/deepbook-v3/src/transactions/marginManager.ts:94

repayBase

repayBase(
managerKey: string,
amount?: number,
): (tx: Transaction) => TransactionResult
Parameters
- managerKey: string
  The key to identify the manager
- Optionalamount: number
  The amount to repay
Returns (tx: Transaction) => TransactionResult
A function that takes a Transaction object

Description
Repay base from a margin manager
- Defined in packages/deepbook-v3/src/transactions/marginManager.ts:412

repayQuote

repayQuote(
managerKey: string,
amount?: number,
): (tx: Transaction) => TransactionResult
Parameters
- managerKey: string
  The key to identify the manager
- Optionalamount: number
  The amount to repay
Returns (tx: Transaction) => TransactionResult
A function that takes a Transaction object

Description
Repay quote from a margin manager
- Defined in packages/deepbook-v3/src/transactions/marginManager.ts:440

setMarginManagerReferral

setMarginManagerReferral(
managerKey: string,
referral: string,
): (tx: Transaction) => void
Parameters
- managerKey: string
  The key to identify the margin manager
- referral: string
  The referral (DeepBookPoolReferral) to set
Returns (tx: Transaction) => void
A function that takes a Transaction object

Description
Set the referral for a margin manager (DeepBookPoolReferral)
- Defined in packages/deepbook-v3/src/transactions/marginManager.ts:506

shareMarginManager

shareMarginManager(
    poolKey: string,
    manager: TransactionArgument,
    initializer: TransactionArgument,
): (tx: Transaction) => void
Parameters
- poolKey: string
  The key to identify the pool
- manager: TransactionArgument
  The margin manager to share
- initializer: TransactionArgument
  The initializer for the manager
Returns (tx: Transaction) => void
A function that takes a Transaction object

Description
Share a margin manager
- Defined in packages/deepbook-v3/src/transactions/marginManager.ts:75

unregisterMarginManager

unregisterMarginManager(managerKey: string): (tx: Transaction) => void
Parameters
- managerKey: string
  The key to identify the margin manager
Returns (tx: Transaction) => void
A function that takes a Transaction object

Description
Unregister a margin manager from the margin registry. Aborts if the manager holds any outstanding debt or base/quote/DEEP balance.
- Defined in packages/deepbook-v3/src/transactions/marginManager.ts:112

unsetMarginManagerReferral

unsetMarginManagerReferral(
managerKey: string,
poolKey: string,
): (tx: Transaction) => void
Parameters
- managerKey: string
  The key to identify the margin manager
- poolKey: string
  The key of the pool to unset the referral for
Returns (tx: Transaction) => void
A function that takes a Transaction object

Description
Unset the referral for a margin manager
- Defined in packages/deepbook-v3/src/transactions/marginManager.ts:525

withdrawBase

withdrawBase(
managerKey: string,
amount: number,
): (tx: Transaction) => TransactionResult
Parameters
- managerKey: string
  The key to identify the manager
- amount: number
  The amount to withdraw
Returns (tx: Transaction) => TransactionResult
A function that takes a Transaction object

Description
Withdraw base from a margin manager
- Defined in packages/deepbook-v3/src/transactions/marginManager.ts:265

withdrawDeep

withdrawDeep(
managerKey: string,
amount: number,
): (tx: Transaction) => TransactionResult
Parameters
- managerKey: string
  The key to identify the manager
- amount: number
  The amount to withdraw
Returns (tx: Transaction) => TransactionResult
A function that takes a Transaction object

Description
Withdraw deep from a margin manager
- Defined in packages/deepbook-v3/src/transactions/marginManager.ts:325

withdrawQuote

withdrawQuote(
managerKey: string,
amount: number,
): (tx: Transaction) => TransactionResult
Parameters
- managerKey: string
  The key to identify the manager
- amount: number
  The amount to withdraw
Returns (tx: Transaction) => TransactionResult
A function that takes a Transaction object

Description
Withdraw quote from a margin manager
- Defined in packages/deepbook-v3/src/transactions/marginManager.ts:295

Class MarginManagerContract

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns MarginManagerContract

Methods

account

Parameters

Returns (tx: Transaction) => TransactionResult

Description

accountExists

Parameters

Returns (tx: Transaction) => TransactionResult

Description

accountOpenOrders

Parameters

Returns (tx: Transaction) => TransactionResult

Description

balanceManager

Parameters

Returns (tx: Transaction) => TransactionResult

Description

balanceManagerId

Parameters

Returns (tx: Transaction) => TransactionResult

Description

baseBalance

Parameters

Returns (tx: Transaction) => TransactionResult

Description

borrowBase

Parameters

Returns (tx: Transaction) => TransactionResult

Description

borrowedBaseShares

Parameters

Returns (tx: Transaction) => TransactionResult

Description

borrowedQuoteShares

Parameters

Returns (tx: Transaction) => TransactionResult

Description

borrowedShares

Parameters

Returns (tx: Transaction) => TransactionResult

Description

borrowQuote

Parameters

Returns (tx: Transaction) => TransactionResult

Description

calculateAssets

Parameters

Returns (tx: Transaction) => TransactionResult

Description

calculateDebts

Parameters

Returns (tx: Transaction) => TransactionResult

Description

canPlaceLimitOrder

Parameters

Returns (tx: Transaction) => TransactionResult

Description

canPlaceMarketOrder

Parameters

Returns (tx: Transaction) => TransactionResult

Description

deepBalance

Parameters

Returns (tx: Transaction) => TransactionResult

Description

deepbookPool

Parameters

Returns (tx: Transaction) => TransactionResult

Description

depositBase

Parameters

Returns (tx: Transaction) => void

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