Class MarginPoolContract

MarginPoolContract class for managing MarginPool operations.

Index

Constructors

Methods

mintReferral supplyToMarginPool withdrawFromMarginPool withdrawReferralFees

Constructors

constructor

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

Methods

mintReferral

mintReferral(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 deepbook-v3/src/transactions/marginPool.ts:82

supplyToMarginPool

supplyToMarginPool(
    coinKey: string,
    amountToDeposit: number,
    referralId?: string,
): (tx: Transaction) => void
Parameters
- coinKey: string
  The key to identify the pool
- 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 deepbook-v3/src/transactions/marginPool.ts:29

withdrawFromMarginPool

withdrawFromMarginPool(
coinKey: string,
amountToWithdraw?: number,
): (tx: Transaction) => TransactionResult
Parameters
- coinKey: string
  The key to identify the pool
- OptionalamountToWithdraw: number
  The amount to withdraw
Returns (tx: Transaction) => TransactionResult
A function that takes a Transaction object

Description
Withdraw from a margin pool
- Defined in deepbook-v3/src/transactions/marginPool.ts:59

withdrawReferralFees

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

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