Class MarginPoolContract

MarginPoolContract class for managing MarginPool operations.

Constructors

constructor

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

Methods

borrowShares

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

Description
Get the total borrow shares
- Defined in packages/deepbook-v3/src/transactions/marginPool.ts:216

deepbookPoolAllowed

deepbookPoolAllowed(
coinKey: string,
deepbookPoolId: string,
): (tx: Transaction) => TransactionResult
Parameters
- coinKey: string
  The key to identify the margin pool
- deepbookPoolId: string
  The ID of the deepbook pool
Returns (tx: Transaction) => TransactionResult
A function that takes a Transaction object

Description
Check if a deepbook pool is allowed for borrowing
- Defined in packages/deepbook-v3/src/transactions/marginPool.ts:160

getId

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

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

interestRate

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

Description
Get the current interest rate
- Defined in packages/deepbook-v3/src/transactions/marginPool.ts:300

lastUpdateTimestamp

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

Description
Get the last update timestamp
- Defined in packages/deepbook-v3/src/transactions/marginPool.ts:230

maxUtilizationRate

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

Description
Get the max utilization rate
- Defined in packages/deepbook-v3/src/transactions/marginPool.ts:258

minBorrow

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

Description
Get the minimum borrow amount
- Defined in packages/deepbook-v3/src/transactions/marginPool.ts:286

mintSupplierCap

mintSupplierCap(): (tx: Transaction) => TransactionResult
Returns (tx: Transaction) => TransactionResult
A function that takes a Transaction object

Description
Mint a supplier cap for margin pool
- Defined in packages/deepbook-v3/src/transactions/marginPool.ts:25

mintSupplyReferral

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

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

protocolSpread

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

Description
Get the protocol spread
- Defined in packages/deepbook-v3/src/transactions/marginPool.ts:272

supplyCap

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

Description
Get the supply cap
- Defined in packages/deepbook-v3/src/transactions/marginPool.ts:244

supplyShares

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

Description
Get the total supply shares
- Defined in packages/deepbook-v3/src/transactions/marginPool.ts:188

supplyToMarginPool

supplyToMarginPool(
    coinKey: string,
    supplierCap: TransactionObjectArgument,
    amountToDeposit: number,
    referralId?: string,
): (tx: Transaction) => void
Parameters
- coinKey: string
  The key to identify the pool
- supplierCap: TransactionObjectArgument
  The supplier cap object
- amountToDeposit: number
  The amount to deposit
- OptionalreferralId: string
  The ID of the referral
Returns (tx: Transaction) => void
A function that takes a Transaction object

Description
Supply to a margin pool
- Defined in packages/deepbook-v3/src/transactions/marginPool.ts:41

totalBorrow

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

Description
Get the total borrow amount
- Defined in packages/deepbook-v3/src/transactions/marginPool.ts:202

totalSupply

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

Description
Get the total supply amount
- Defined in packages/deepbook-v3/src/transactions/marginPool.ts:174

userSupplyAmount

userSupplyAmount(
coinKey: string,
supplierCapId: string,
): (tx: Transaction) => TransactionResult
Parameters
- coinKey: string
  The key to identify the pool
- supplierCapId: string
  The ID of the supplier cap
Returns (tx: Transaction) => TransactionResult
A function that takes a Transaction object

Description
Get user supply amount for a supplier cap
- Defined in packages/deepbook-v3/src/transactions/marginPool.ts:330

userSupplyShares

userSupplyShares(
coinKey: string,
supplierCapId: string,
): (tx: Transaction) => TransactionResult
Parameters
- coinKey: string
  The key to identify the pool
- supplierCapId: string
  The ID of the supplier cap
Returns (tx: Transaction) => TransactionResult
A function that takes a Transaction object

Description
Get user supply shares for a supplier cap
- Defined in packages/deepbook-v3/src/transactions/marginPool.ts:315

withdrawFromMarginPool

withdrawFromMarginPool(
    coinKey: string,
    supplierCap: TransactionObjectArgument,
    amountToWithdraw?: number,
): (tx: Transaction) => TransactionResult
Parameters
- coinKey: string
  The key to identify the pool
- supplierCap: TransactionObjectArgument
  The supplier cap object
- OptionalamountToWithdraw: number
  The amount to withdraw. If omitted, withdraws all.
Returns (tx: Transaction) => TransactionResult
A function that takes a Transaction object

Description
Withdraw from a margin pool. If amountToWithdraw is not provided, withdraws all.
- Defined in packages/deepbook-v3/src/transactions/marginPool.ts:82

withdrawReferralFees

withdrawReferralFees(
coinKey: string,
referralId: string,
): (tx: Transaction) => TransactionResult
Parameters
- coinKey: string
  The key to identify the pool
- referralId: string
  The ID of the referral
Returns (tx: Transaction) => TransactionResult
A function that takes a Transaction object

Description
Withdraw referral fees from a margin pool
- Defined in packages/deepbook-v3/src/transactions/marginPool.ts:125

Class MarginPoolContract

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns MarginPoolContract

Methods

borrowShares

Parameters

Returns (tx: Transaction) => TransactionResult

Description

deepbookPoolAllowed

Parameters

Returns (tx: Transaction) => TransactionResult

Description

getId

Parameters

Returns (tx: Transaction) => TransactionResult

Description

interestRate

Parameters

Returns (tx: Transaction) => TransactionResult

Description

lastUpdateTimestamp

Parameters

Returns (tx: Transaction) => TransactionResult

Description

maxUtilizationRate

Parameters

Returns (tx: Transaction) => TransactionResult

Description

minBorrow

Parameters

Returns (tx: Transaction) => TransactionResult

Description

mintSupplierCap

Returns (tx: Transaction) => TransactionResult

Description

mintSupplyReferral

Parameters

Returns (tx: Transaction) => void

Description

protocolSpread

Parameters

Returns (tx: Transaction) => TransactionResult

Description

supplyCap

Parameters

Returns (tx: Transaction) => TransactionResult

Description

supplyShares

Parameters

Returns (tx: Transaction) => TransactionResult

Description

supplyToMarginPool

Parameters

Returns (tx: Transaction) => void

Description

totalBorrow

Parameters

Returns (tx: Transaction) => TransactionResult

Description

totalSupply

Parameters

Returns (tx: Transaction) => TransactionResult

Description

userSupplyAmount

Parameters

Returns (tx: Transaction) => TransactionResult

Description

userSupplyShares

Parameters

Returns (tx: Transaction) => TransactionResult

Description

withdrawFromMarginPool

Parameters

Returns (tx: Transaction) => TransactionResult

Description