Class BookSide

Hierarchy

BookSide

Index

Constructors

constructor

new BookSide(client: MangoClient, perpMarket: PerpMarket, type: BookSideType, rootFixed: OrderTreeRoot, rootOraclePegged: OrderTreeRoot, orderTreeNodes: OrderTreeNodes, maxBookDelay?: number): BookSide

- Defined in accounts/perp.ts:600
Parameters
- client: MangoClient
- perpMarket: PerpMarket
- type: BookSideType
- rootFixed: OrderTreeRoot
- rootOraclePegged: OrderTreeRoot
- orderTreeNodes: OrderTreeNodes
- Optional maxBookDelay: number
Returns BookSide

Properties

client

client: MangoClient

now

now: BN

orderTreeNodes

orderTreeNodes: OrderTreeNodes

perpMarket

perpMarket: PerpMarket

rootFixed

rootFixed: OrderTreeRoot

rootOraclePegged

rootOraclePegged: OrderTreeRoot

type

type: BookSideType

Static Private INNER_NODE_TAG

INNER_NODE_TAG: number = 1

Static Private LEAF_NODE_TAG

LEAF_NODE_TAG: number = 2

Methods

best

best(): undefined | PerpOrder

- Defined in accounts/perp.ts:759
Returns undefined | PerpOrder

fixedItems

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

- Defined in accounts/perp.ts:698
Returns Generator<PerpOrder, any, unknown>

getImpactPriceUi

getImpactPriceUi(baseLots: BN): undefined | number

- Defined in accounts/perp.ts:763
Parameters
- baseLots: BN
Returns undefined | number

getL2

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

- Defined in accounts/perp.ts:774
Parameters
- depth: number
Returns [number, number, BN, BN][]

getL2Ui

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

- Defined in accounts/perp.ts:793
Parameters
- depth: number
Returns [number, number][]

items

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

- Defined in accounts/perp.ts:633
iterates over all orders

Returns Generator<PerpOrder, any, unknown>

itemsValid

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

- Defined in accounts/perp.ts:678
iterates over all orders, skips oracle pegged orders which are invalid due to oracle price crossing the peg limit, skips tif orders which are invalid due to tif having elapsed,

Returns Generator<PerpOrder, any, unknown>

oraclePeggedItems

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

- Defined in accounts/perp.ts:728
Returns Generator<PerpOrder, any, unknown>

Static from

from(client: MangoClient, perpMarket: PerpMarket, bookSideType: BookSideType, obj: { nodes: OrderTreeNodes; roots: OrderTreeRoot[] }): BookSide

- Defined in accounts/perp.ts:581
Parameters
- client: MangoClient
- perpMarket: PerpMarket
- bookSideType: BookSideType
- obj: { nodes: OrderTreeNodes; roots: OrderTreeRoot[] }
  - nodes: OrderTreeNodes
  - roots: OrderTreeRoot[]
Returns BookSide

Static getPriceFromKey

getPriceFromKey(key: BN): BN

- Defined in accounts/perp.ts:626
Parameters
- key: BN
Returns BN

Static toInnerNode

toInnerNode(client: MangoClient, data: [number]): InnerNode

- Defined in accounts/perp.ts:807
Parameters
- client: MangoClient
- data: [number]
Returns InnerNode

Static toLeafNode

toLeafNode(client: MangoClient, data: [number]): LeafNode

- Defined in accounts/perp.ts:812
Parameters
- client: MangoClient
- data: [number]
Returns LeafNode

Generated using TypeDoc