Class MarginManagerContract

MarginManagerContract class for managing MarginManager operations.

Index

Constructors

Methods

borrowBase borrowQuote depositBase depositDeep depositQuote liquidate newMarginManager newMarginManagerWithInitializer repayBase repayQuote shareMarginManager withdrawBase withdrawDeep withdrawQuote

Constructors

constructor

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

Methods

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

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

depositBase

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

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

depositDeep

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

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

depositQuote

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

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

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

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

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

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

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

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

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

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

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

Class MarginManagerContract

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns MarginManagerContract

Methods

borrowBase

Parameters

Returns (tx: Transaction) => TransactionResult

Description

borrowQuote

Parameters

Returns (tx: Transaction) => TransactionResult

Description

depositBase

Parameters

Returns (tx: Transaction) => void

Description

depositDeep

Parameters

Returns (tx: Transaction) => void

Description

depositQuote

Parameters

Returns (tx: Transaction) => void

Description

liquidate

Parameters

Returns (tx: Transaction) => TransactionResult

Description

newMarginManager

Parameters

Returns (tx: Transaction) => void

Description

newMarginManagerWithInitializer

Parameters

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

Description

repayBase

Parameters

Returns (tx: Transaction) => TransactionResult

Description

repayQuote

Parameters

Returns (tx: Transaction) => TransactionResult

Description

shareMarginManager

Parameters

Returns (tx: Transaction) => void

Description

withdrawBase

Parameters

Returns (tx: Transaction) => TransactionResult

Description

withdrawDeep

Parameters

Returns (tx: Transaction) => TransactionResult

Description

withdrawQuote

Parameters

Returns (tx: Transaction) => TransactionResult

Description

Settings

On This Page

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