Class PerpMarket

Hierarchy

PerpMarket

Constructors

constructor

new PerpMarket(publicKey: PublicKey, baseDecimals: number, quoteDecimals: number, decoded: any): PerpMarket

- Defined in src/PerpMarket.ts:63
Parameters
- publicKey: PublicKey
- baseDecimals: number
- quoteDecimals: number
- decoded: any
Returns PerpMarket

Properties

_minOrderSize

_minOrderSize: undefined | number

_tickSize

_tickSize: undefined | number

asks

asks: PublicKey

baseDecimals

baseDecimals: number

baseLotSize

baseLotSize: BN

baseLotsToUiConvertor

baseLotsToUiConvertor: number

bids

bids: PublicKey

eventQueue

eventQueue: PublicKey

feesAccrued

feesAccrued: I80F48

lastUpdated

lastUpdated: BN

liquidityMiningInfo

liquidityMiningInfo: { maxDepthBps: I80F48; mngoLeft: BN; mngoPerPeriod: BN; periodStart: BN; rate: I80F48; targetPeriodLength: BN }

Type declaration

maxDepthBps: I80F48
mngoLeft: BN
mngoPerPeriod: BN
periodStart: BN
rate: I80F48
targetPeriodLength: BN

longFunding

longFunding: I80F48

mangoGroup

mangoGroup: PublicKey

metaData

metaData: MetaData

mngoVault

mngoVault: PublicKey

openInterest

openInterest: BN

priceLotsToUiConvertor

priceLotsToUiConvertor: number

publicKey

publicKey: PublicKey

quoteDecimals

quoteDecimals: number

quoteLotSize

quoteLotSize: BN

seqNum

seqNum: BN

shortFunding

shortFunding: I80F48

Accessors

minOrderSize

get minOrderSize(): number

- Defined in src/PerpMarket.ts:103
Returns number

tickSize

get tickSize(): number

- Defined in src/PerpMarket.ts:110
Returns number

Methods

baseLotsToNative

baseLotsToNative(quantity: BN): I80F48

- Defined in src/PerpMarket.ts:91
Parameters
- quantity: BN
Returns I80F48

baseLotsToNumber

baseLotsToNumber(quantity: BN): number

- Defined in src/PerpMarket.ts:99
Parameters
- quantity: BN
Returns number

getCurrentFundingRate

getCurrentFundingRate(group: MangoGroup, cache: MangoCache, marketIndex: number, bids: BookSide, asks: BookSide): number

- Defined in src/PerpMarket.ts:122
Calculate the instantaneous funding rate using the bids and asks Reported as an hourly number Make sure cache, bids and asks are up to date

Parameters
- group: MangoGroup
- cache: MangoCache
- marketIndex: number
- bids: BookSide
- asks: BookSide
Returns number

loadAsks

loadAsks(connection: Connection, includeExpired?: boolean): Promise<BookSide>

- Defined in src/PerpMarket.ts:190
Parameters
- connection: Connection
- includeExpired: boolean = false
Returns Promise<BookSide>

loadBids

loadBids(connection: Connection, includeExpired?: boolean): Promise<BookSide>

- Defined in src/PerpMarket.ts:177
Parameters
- connection: Connection
- includeExpired: boolean = false
Returns Promise<BookSide>

loadEventQueue

loadEventQueue(connection: Connection): Promise<PerpEventQueue>

- Defined in src/PerpMarket.ts:150
Parameters
- connection: Connection
Returns Promise<PerpEventQueue>

loadFills

loadFills(connection: Connection): Promise<ParsedFillEvent[]>

- Defined in src/PerpMarket.ts:156
Parameters
- connection: Connection
Returns Promise<ParsedFillEvent[]>

loadOrdersForAccount

loadOrdersForAccount(connection: Connection, account: MangoAccount, includeExpired?: boolean): Promise<PerpOrder[]>

- Defined in src/PerpMarket.ts:203
Parameters
- connection: Connection
- account: MangoAccount
- includeExpired: boolean = false
Returns Promise<PerpOrder[]>

parseFillEvent

parseFillEvent(event: any): any

- Defined in src/PerpMarket.ts:166
Parameters
- event: any
Returns any

priceLotsToNative

priceLotsToNative(price: BN): I80F48

- Defined in src/PerpMarket.ts:85
Parameters
- price: BN
Returns I80F48

priceLotsToNumber

priceLotsToNumber(price: BN): number

- Defined in src/PerpMarket.ts:95
Parameters
- price: BN
Returns number

toPrettyString

toPrettyString(group: MangoGroup, perpMarketConfig: PerpMarketConfig): string

- Defined in src/PerpMarket.ts:232
Parameters
- group: MangoGroup
- perpMarketConfig: PerpMarketConfig
Returns string

uiQuoteToLots

uiQuoteToLots(uiQuote: number): BN

- Defined in src/PerpMarket.ts:228
Parameters
- uiQuote: number
Returns BN

uiToNativePriceQuantity

uiToNativePriceQuantity(price: number, quantity: number): [BN, BN]

- Defined in src/PerpMarket.ts:217
Parameters
- price: number
- quantity: number
Returns [BN, BN]

Generated using TypeDoc