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:18

Methods

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:626

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:712

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:317

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:575

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:592

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:558

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:345

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:643

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:662

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:746

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:524

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:128

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:192

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:91

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:160

getMarginAccountOrderDetails

getMarginAccountOrderDetails(
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 account order details for a margin manager. This retrieves the balance manager from the margin manager and calls get_account_order_details.
- Defined in packages/deepbook-v3/src/transactions/marginManager.ts:765

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:609

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:432

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:684

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:541

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:27

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:48

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:507

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:729

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:373

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:401

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:467

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:73

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:486

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:226

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:286

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:256

Class MarginManagerContract

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns MarginManagerContract

Methods

balanceManager

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

deepBalance

Parameters

Returns (tx: Transaction) => TransactionResult

Description

deepbookPool

Parameters

Returns (tx: Transaction) => TransactionResult

Description

depositBase

Parameters

Returns (tx: Transaction) => void

Description

depositDeep

Parameters

Returns (tx: Transaction) => void

Description

depositDuringInitialization

Parameters

Returns (tx: Transaction) => void

Description

depositQuote

Parameters

Returns (tx: Transaction) => void

Description

getMarginAccountOrderDetails

Parameters

Returns (tx: Transaction) => TransactionResult

Description

hasBaseDebt

Parameters

Returns (tx: Transaction) => TransactionResult

Description

liquidate

Parameters

Returns (tx: Transaction) => TransactionResult

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