Interface PoolPosition

A description of a position associated with a MarginAccount and Pool

Hierarchy

  • PoolPosition

Properties

buyingPower: TokenAmount
depositBalance: TokenAmount

The deposit balance in the Pool. An undefined depositPosition leads to a balance of 0.

depositPosition: undefined | AccountPosition

The underlying AccountPosition that stores the deposit balance.

depositValue: number

The deposit value in the Pool denominated in USD. An undefined depositPosition leads to a value of 0.

liquidationEndingCollateral: TokenAmount

An estimate of the amount of MarginTokenConfig collateral required to make it possible to end liquidation.

loanBalance: TokenAmount

The loan balance in the Pool. An undefined loanPosition leads to a balance of 0.

loanPosition: undefined | AccountPosition

The underlying AccountPosition that stores the loan balance.

loanValue: number

The loan value in the Pool denominated in USD. An undefined loanPosition leads to a balance of 0.

maxTradeAmounts: Record<PoolAction, TokenAmount>

An estimate of the maximum trade amounts possible. The estimates factor in available wallet balances, Pool liquidity, margin requirements and SETUP_LEVERAGE_FRACTION.

pool?: Pool

The Pool that the position is associated with.

tokenConfig: MarginTokenConfig

The MarginTokenConfig associated with the Pool token.

Generated using TypeDoc