Class BookSide

Hierarchy

BookSide

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new BookSide(publicKey: PublicKey, perpMarket: PerpMarket, decoded: any, includeExpired?: boolean, maxBookDelay?: number): BookSide

- Defined in src/book.ts:39
Parameters
- publicKey: PublicKey
- perpMarket: PerpMarket
- decoded: any
- includeExpired: boolean = false
- Optional maxBookDelay: number
Returns BookSide

Properties

bumpIndex

bumpIndex: number

freeListLen

freeListLen: number

freelistHead

freelistHead: number

includeExpired

includeExpired: boolean

isBids

isBids: boolean

leafCount

leafCount: number

nodes

nodes: any[]

now

now: BN

perpMarket

perpMarket: PerpMarket

publicKey

publicKey: PublicKey

rootNode

rootNode: number

Methods

[iterator]

[iterator](): Generator<PerpOrder, any, unknown>

- Defined in src/book.ts:164
Returns Generator<PerpOrder, any, unknown>

getBest

getBest(): undefined | PerpOrder

- Defined in src/book.ts:121
Returns undefined | PerpOrder

getImpactPriceUi

getImpactPriceUi(quantity: BN): undefined | number

- Defined in src/book.ts:111
Return the ui price reached at quantity lots up the book; return undefined if quantity not on book

Parameters
- quantity: BN
Returns undefined | number

getL2

getL2(depth: number): [number, number, BN, BN][]

- Defined in src/book.ts:182
Parameters
- depth: number
Returns [number, number, BN, BN][]

getL2Ui

getL2Ui(depth: number): [number, number][]

- Defined in src/book.ts:168
Parameters
- depth: number
Returns [number, number][]

items

items(): Generator<PerpOrder, any, unknown>

- Defined in src/book.ts:64
Returns Generator<PerpOrder, any, unknown>

Generated using TypeDoc