PerpPosition | @blockworks-foundation/mango-v4

Hierarchy

PerpPosition

Index

Constructors

constructor

Constructors

constructor

new PerpPosition(marketIndex: PerpMarketIndex, settlePnlLimitWindow: number, settlePnlLimitSettledInCurrentWindowNative: BN, basePositionLots: BN, quotePositionNative: I80F48, quoteRunningNative: BN, longSettledFunding: I80F48, shortSettledFunding: I80F48, bidsBaseLots: BN, asksBaseLots: BN, takerBaseLots: BN, takerQuoteLots: BN, cumulativeLongFunding: number, cumulativeShortFunding: number, makerVolume: BN, takerVolume: BN, perpSpotTransfers: BN, avgEntryPricePerBaseLot: number, realizedTradePnlNative: I80F48, realizedOtherPnlNative: I80F48, settlePnlLimitRealizedTrade: BN, realizedPnlForPositionNative: I80F48): PerpPosition

- Defined in accounts/mangoAccount.ts:1268
Parameters
- marketIndex: PerpMarketIndex
- settlePnlLimitWindow: number
- settlePnlLimitSettledInCurrentWindowNative: BN
- basePositionLots: BN
- quotePositionNative: I80F48
- quoteRunningNative: BN
- longSettledFunding: I80F48
- shortSettledFunding: I80F48
- bidsBaseLots: BN
- asksBaseLots: BN
- takerBaseLots: BN
- takerQuoteLots: BN
- cumulativeLongFunding: number
- cumulativeShortFunding: number
- makerVolume: BN
- takerVolume: BN
- perpSpotTransfers: BN
- avgEntryPricePerBaseLot: number
- realizedTradePnlNative: I80F48
- realizedOtherPnlNative: I80F48
- settlePnlLimitRealizedTrade: BN
- realizedPnlForPositionNative: I80F48
Returns PerpPosition

Properties

asksBaseLots

asksBaseLots: BN

avgEntryPricePerBaseLot

avgEntryPricePerBaseLot: number

basePositionLots

basePositionLots: BN

bidsBaseLots

bidsBaseLots: BN

cumulativeLongFunding

cumulativeLongFunding: number

cumulativeShortFunding

cumulativeShortFunding: number

longSettledFunding

longSettledFunding: I80F48

makerVolume

makerVolume: BN

marketIndex

marketIndex: PerpMarketIndex

perpSpotTransfers

perpSpotTransfers: BN

quotePositionNative

quotePositionNative: I80F48

quoteRunningNative

quoteRunningNative: BN

realizedOtherPnlNative

realizedOtherPnlNative: I80F48

realizedPnlForPositionNative

realizedPnlForPositionNative: I80F48

realizedTradePnlNative

realizedTradePnlNative: I80F48

settlePnlLimitRealizedTrade

settlePnlLimitRealizedTrade: BN

settlePnlLimitSettledInCurrentWindowNative

settlePnlLimitSettledInCurrentWindowNative: BN

settlePnlLimitWindow

settlePnlLimitWindow: number

shortSettledFunding

shortSettledFunding: I80F48

takerBaseLots

takerBaseLots: BN

takerQuoteLots

takerQuoteLots: BN

takerVolume

takerVolume: BN

Static PerpMarketIndexUnset

PerpMarketIndexUnset: number = 65535

Methods

applyPnlSettleLimit

applyPnlSettleLimit(pnl: I80F48, perpMarket: PerpMarket): I80F48

- Defined in accounts/mangoAccount.ts:1516
Parameters
- pnl: I80F48
- perpMarket: PerpMarket
Returns I80F48

availableSettleLimit

availableSettleLimit(perpMarket: PerpMarket): [BN, BN]

- Defined in accounts/mangoAccount.ts:1474
Parameters
- perpMarket: PerpMarket
Returns [BN, BN]

canSettlePnl

canSettlePnl(group: Group, perpMarket: PerpMarket, account: MangoAccount): boolean

- Defined in accounts/mangoAccount.ts:1563
Parameters
- group: Group
- perpMarket: PerpMarket
- account: MangoAccount
Returns boolean

cumulativePnlOverPositionLifetimeUi

cumulativePnlOverPositionLifetimeUi(perpMarket: PerpMarket): number

- Defined in accounts/mangoAccount.ts:1428
Parameters
- perpMarket: PerpMarket
Returns number

getAverageEntryPrice

getAverageEntryPrice(perpMarket: PerpMarket): I80F48

- Defined in accounts/mangoAccount.ts:1402
Parameters
- perpMarket: PerpMarket
Returns I80F48

getAverageEntryPriceUi

getAverageEntryPriceUi(perpMarket: PerpMarket): number

- Defined in accounts/mangoAccount.ts:1408
Parameters
- perpMarket: PerpMarket
Returns number

getBasePositionNative

getBasePositionNative(perpMarket: PerpMarket): I80F48

- Defined in accounts/mangoAccount.ts:1297
Parameters
- perpMarket: PerpMarket
Returns I80F48

getBasePositionUi

getBasePositionUi(perpMarket: PerpMarket, useEventQueue?: boolean): number

- Defined in accounts/mangoAccount.ts:1301
Parameters
- perpMarket: PerpMarket
- Optional useEventQueue: boolean
Returns number

getBreakEvenPriceUi

getBreakEvenPriceUi(perpMarket: PerpMarket): number

- Defined in accounts/mangoAccount.ts:1414
Parameters
- perpMarket: PerpMarket
Returns number

getEquity

getEquity(perpMarket: PerpMarket): I80F48

- Defined in accounts/mangoAccount.ts:1368
Parameters
- perpMarket: PerpMarket
Returns I80F48

getEquityUi

getEquityUi(perpMarket: PerpMarket): number

- Defined in accounts/mangoAccount.ts:1360
Parameters
- perpMarket: PerpMarket
Returns number

getNotionalValueUi

getNotionalValueUi(perpMarket: PerpMarket, useEventQueue?: boolean): number

- Defined in accounts/mangoAccount.ts:1331
Parameters
- perpMarket: PerpMarket
- Optional useEventQueue: boolean
Returns number

getQuotePositionUi

getQuotePositionUi(perpMarket: PerpMarket, useEventQueue?: boolean): number

- Defined in accounts/mangoAccount.ts:1316
Parameters
- perpMarket: PerpMarket
- Optional useEventQueue: boolean
Returns number

getSettleablePnl

getSettleablePnl(group: Group, perpMarket: PerpMarket, account: MangoAccount): I80F48

- Defined in accounts/mangoAccount.ts:1533
Parameters
- group: Group
- perpMarket: PerpMarket
- account: MangoAccount
Returns I80F48

getSettleablePnlUi

getSettleablePnlUi(group: Group, perpMarket: PerpMarket, account: MangoAccount): number

- Defined in accounts/mangoAccount.ts:1553
Parameters
- group: Group
- perpMarket: PerpMarket
- account: MangoAccount
Returns number

getUnsettledFunding

getUnsettledFunding(perpMarket: PerpMarket): I80F48

- Defined in accounts/mangoAccount.ts:1340
Parameters
- perpMarket: PerpMarket
Returns I80F48

getUnsettledFundingUi

getUnsettledFundingUi(perpMarket: PerpMarket): number

- Defined in accounts/mangoAccount.ts:1356
Parameters
- perpMarket: PerpMarket
Returns number

getUnsettledPnl

getUnsettledPnl(perpMarket: PerpMarket): I80F48

- Defined in accounts/mangoAccount.ts:1444
Parameters
- perpMarket: PerpMarket
Returns I80F48

getUnsettledPnlUi

getUnsettledPnlUi(perpMarket: PerpMarket): number

- Defined in accounts/mangoAccount.ts:1454
Parameters
- perpMarket: PerpMarket
Returns number

hasOpenOrders

hasOpenOrders(): boolean

- Defined in accounts/mangoAccount.ts:1392
Returns boolean

isActive

isActive(): boolean

- Defined in accounts/mangoAccount.ts:1293
Returns boolean

toString

toString(perpMarket?: PerpMarket): string

- Defined in accounts/mangoAccount.ts:1571
Parameters
- Optional perpMarket: PerpMarket
Returns string

updateSettleLimit

updateSettleLimit(perpMarket: PerpMarket): void

- Defined in accounts/mangoAccount.ts:1458
Parameters
- perpMarket: PerpMarket
Returns void

Static emptyFromPerpMarketIndex

emptyFromPerpMarketIndex(perpMarketIndex: PerpMarketIndex): PerpPosition

- Defined in accounts/mangoAccount.ts:1239
Parameters
- perpMarketIndex: PerpMarketIndex
Returns PerpPosition

Static from

from(dto: PerpPositionDto): PerpPosition

- Defined in accounts/mangoAccount.ts:1212
Parameters
- dto: PerpPositionDto
Returns PerpPosition

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

marketIndex: PerpMarketIndex

settlePnlLimitWindow: number

settlePnlLimitSettledInCurrentWindowNative: BN

basePositionLots: BN

quotePositionNative: I80F48

quoteRunningNative: BN

longSettledFunding: I80F48

shortSettledFunding: I80F48

bidsBaseLots: BN

asksBaseLots: BN

takerBaseLots: BN

takerQuoteLots: BN

cumulativeLongFunding: number

cumulativeShortFunding: number

makerVolume: BN

takerVolume: BN

perpSpotTransfers: BN

avgEntryPricePerBaseLot: number

realizedTradePnlNative: I80F48

realizedOtherPnlNative: I80F48

settlePnlLimitRealizedTrade: BN

realizedPnlForPositionNative: I80F48

Returns PerpPosition

Properties

asksBaseLots

avgEntryPricePerBaseLot

basePositionLots

bidsBaseLots

cumulativeLongFunding

cumulativeShortFunding

longSettledFunding

makerVolume

marketIndex

perpSpotTransfers

quotePositionNative

quoteRunningNative

realizedOtherPnlNative

realizedPnlForPositionNative

realizedTradePnlNative

settlePnlLimitRealizedTrade

settlePnlLimitSettledInCurrentWindowNative

settlePnlLimitWindow

shortSettledFunding

takerBaseLots

takerQuoteLots

takerVolume

Static PerpMarketIndexUnset

Methods

applyPnlSettleLimit

Parameters

pnl: I80F48

perpMarket: PerpMarket

Returns I80F48

availableSettleLimit

Parameters

perpMarket: PerpMarket

Returns [BN, BN]

canSettlePnl

Parameters

group: Group

perpMarket: PerpMarket

account: MangoAccount

Returns boolean

cumulativePnlOverPositionLifetimeUi

Parameters

perpMarket: PerpMarket

Returns number

getAverageEntryPrice

Parameters

perpMarket: PerpMarket

Returns I80F48

getAverageEntryPriceUi