ZoUser | @zero_one/client

Hierarchy

ZoDBUser
- ZoUser

Index

Constructors

constructor

Constructors

constructor

new ZoUser(margin: Margin, realm?: any, realmConnected?: boolean): ZoUser

Inherited from ZoDBUser.constructor
- Defined in src/user/ZoBaseUser.ts:17
Parameters
- margin: Margin
- Optional realm: any
- Optional realmConnected: boolean
Returns ZoUser

Properties

balanceHistory

balanceHistory: {} = {}

Type declaration

[key: string]: TradeHistoryEntry[]

eventEmitter

eventEmitter: null | EventEmitter<UpdateEvents, ChangeEvent<any>> = null

fundingHistory

fundingHistory: {} = {}

Type declaration

[key: string]: any[]

fundingPagesParsed

fundingPagesParsed: {} = {}

Type declaration

[key: string]: number

fundingParsed

fundingParsed: {} = {}

Type declaration

[key: string]: boolean

margin

margin: Margin

internal info

perpLiqCurrentPage

perpLiqCurrentPage: {} = {}

Type declaration

[key: string]: number

perpLiqHistory

perpLiqHistory: {} = {}

Type declaration

[key: string]: PerpLiqHistoryEntry[]

perpLiqPagesParsed

perpLiqPagesParsed: {} = {}

Type declaration

[key: string]: number

pnlCurrentPage

pnlCurrentPage: {} = {}

Type declaration

[key: string]: number

pnlHistory

pnlHistory: {} = {}

Type declaration

[key: string]: PnlHistoryEntry[]

pnlPagesParsed

pnlPagesParsed: {} = {}

Type declaration

[key: string]: number

positionsArr

positionsArr: PositionInfo[] = []

realm

realm: any

realmConnected

realmConnected: boolean

spotLiqCurrentPage

spotLiqCurrentPage: number = 0

spotLiqHistory

spotLiqHistory: SpotLiqHistoryEntry[] = []

spotLiqPagesParsed

spotLiqPagesParsed: number = 0

subLock

subLock: AsyncLock = ...

swapCurrentPage

swapCurrentPage: number = 0

swapHistory

swapHistory: SwapHistoryEntry[] = []

swapPagesParsed

swapPagesParsed: number = 0

tradesCurrentPage

tradesCurrentPage: {} = {}

Type declaration

[key: string]: number

tradesPagesParsed

tradesPagesParsed: {} = {}

Type declaration

[key: string]: number

tradesParsed

tradesParsed: {} = {}

Type declaration

[key: string]: boolean

transferCurrentPage

transferCurrentPage: number = 0

transferHistory

transferHistory: TransferHistoryEntry[] = []

transferPagesParsed

transferPagesParsed: number = 0

Accessors

assets

get assets(): {}

- Defined in src/user/ZoUser.ts:64
Returns {}
- [key: string]: AssetInfo

balances

get balances(): {}

- Defined in src/user/ZoUser.ts:48
Returns {}
- [key: string]: Num

cache

get cache(): Cache

- Defined in src/user/ZoUser.ts:28
Returns Cache

connection

get connection(): Connection

- Defined in src/user/ZoUser.ts:36
Returns Connection

control

get control(): Control

- Defined in src/user/ZoUser.ts:32
Returns Control

cumulativeUnrealizedPnL

get cumulativeUnrealizedPnL(): Decimal

- Defined in src/user/ZoUser.ts:145
Returns Decimal

freeCollateralValue

get freeCollateralValue(): Decimal

- Defined in src/user/ZoUser.ts:141
Returns Decimal

funding

get funding(): Decimal

- Defined in src/user/ZoUser.ts:68
Returns Decimal

maintenanceMarginFraction

get maintenanceMarginFraction(): Decimal

- Defined in src/user/ZoUser.ts:105
Returns Decimal

marginFraction

get marginFraction(): Decimal

- Defined in src/user/ZoUser.ts:113
Returns Decimal

markets

get markets(): {}

- Defined in src/user/ZoUser.ts:60
Returns {}
- [key: string]: MarketInfo

openMarginFraction

get openMarginFraction(): Decimal

- Defined in src/user/ZoUser.ts:109
Returns Decimal

orders

get orders(): OrderInfo[]

- Defined in src/user/ZoUser.ts:44
Returns OrderInfo[]

positions

get positions(): PositionInfo[]

- Defined in src/user/ZoUser.ts:52
Returns PositionInfo[]

program

get program(): Program<Zo>

- Defined in src/user/ZoUser.ts:20
Returns Program<Zo>

provider

get provider(): default

- Defined in src/user/ZoUser.ts:24
Returns default

state

get state(): State

- Defined in src/user/ZoUser.ts:40
Returns State

tiedCollateral

get tiedCollateral(): Decimal

- Defined in src/user/ZoUser.ts:137
Returns Decimal

totalOpenPositionNotional

get totalOpenPositionNotional(): Decimal

- Defined in src/user/ZoUser.ts:133
Returns Decimal

totalPositionNotional

get totalPositionNotional(): Decimal

- Defined in src/user/ZoUser.ts:117
Returns Decimal

unweightedAccountValue

get unweightedAccountValue(): Decimal

- Defined in src/user/ZoUser.ts:101
Returns Decimal

unweightedCollateralValue

get unweightedCollateralValue(): Decimal

- Defined in src/user/ZoUser.ts:97
Returns Decimal

Methods

_getPerpLiqs

_getPerpLiqs(page: number, marketKey: string): Promise<any>

Inherited from ZoDBUser._getPerpLiqs
- Defined in src/user/zoDBUser/ZoDBPerpLiqUser.ts:22
Parameters
- page: number
- marketKey: string
Returns Promise<any>

_getPnls

_getPnls(page: number, marketKey: string): Promise<any>

Inherited from ZoDBUser._getPnls
- Defined in src/user/zoDBUser/ZoDBPnlUser.ts:28
Parameters
- page: number
- marketKey: string
Returns Promise<any>

_getSpotLiqs

_getSpotLiqs(page: number): Promise<any>

Inherited from ZoDBUser._getSpotLiqs
- Defined in src/user/zoDBUser/ZoDBSpotLiqUser.ts:18
Parameters
- page: number
Returns Promise<any>

_getSwaps

_getSwaps(page: number): Promise<any>

Inherited from ZoDBUser._getSwaps
- Defined in src/user/zoDBUser/ZoDBSwapUser.ts:18
Parameters
- page: number
Returns Promise<any>

_getTrades

_getTrades(page: number, marketKey: string): Promise<any>

Inherited from ZoDBUser._getTrades
- Defined in src/user/zoDBUser/ZoDBTradeUser.ts:37
Parameters
- page: number
- marketKey: string
Returns Promise<any>

_getTransfers

_getTransfers(page: number): Promise<any>

Inherited from ZoDBUser._getTransfers
- Defined in src/user/zoDBUser/ZoDBTransferUser.ts:17
Parameters
- page: number
Returns Promise<any>

_insertPerpLiqs

_insertPerpLiqs(marketsDecoder: (string: any) => MarketInfo, marketKey: any): Promise<void>

Inherited from ZoDBUser._insertPerpLiqs
- Defined in src/user/zoDBUser/ZoDBPerpLiqUser.ts:34
Parameters
- marketsDecoder: (string: any) => MarketInfo
  - - (string: any): MarketInfo
    - Parameters
      - string: any
      Returns MarketInfo
- marketKey: any
Returns Promise<void>

_insertPnls

_insertPnls(marketKey: string, assetDecimalsDecoder: (sym: any) => number): Promise<void>

Inherited from ZoDBUser._insertPnls
- Defined in src/user/zoDBUser/ZoDBPnlUser.ts:43
Parameters
- marketKey: string
- assetDecimalsDecoder: (sym: any) => number
  - - (sym: any): number
    - Parameters
      - sym: any
      Returns number
Returns Promise<void>

_insertSpotLiqs

_insertSpotLiqs(assets: {}): Promise<void>

Inherited from ZoDBUser._insertSpotLiqs
- Defined in src/user/zoDBUser/ZoDBSpotLiqUser.ts:28
Parameters
- assets: {}
  - [key: string]: AssetInfo
Returns Promise<void>

_insertSwaps

_insertSwaps(assets: {}): Promise<void>

Inherited from ZoDBUser._insertSwaps
- Defined in src/user/zoDBUser/ZoDBSwapUser.ts:28
Parameters
- assets: {}
  - [key: string]: AssetInfo
Returns Promise<void>

_insertTrades

_insertTrades(marketKey: string): Promise<void>

Inherited from ZoDBUser._insertTrades
- Defined in src/user/zoDBUser/ZoDBTradeUser.ts:48
Parameters
- marketKey: string
Returns Promise<void>

_insertTransfers

_insertTransfers(assets: {}): Promise<void>

Inherited from ZoDBUser._insertTransfers
- Defined in src/user/zoDBUser/ZoDBTransferUser.ts:27
Parameters
- assets: {}
  - [key: string]: AssetInfo
Returns Promise<void>

collateralWithdrawable

collateralWithdrawable(marketKey: string): Decimal

- Defined in src/user/ZoUser.ts:149
Parameters
- marketKey: string
Returns Decimal

collateralWithdrawableWithBorrow

collateralWithdrawableWithBorrow(marketKey: string): Decimal

- Defined in src/user/ZoUser.ts:153
Parameters
- marketKey: string
Returns Decimal

getBestAsk

getBestAsk(marketKey: string): number

- Defined in src/user/ZoUser.ts:161
Parameters
- marketKey: string
Returns number

getBestBid

getBestBid(marketKey: string): number

- Defined in src/user/ZoUser.ts:165
Parameters
- marketKey: string
Returns number

getFunding

getFunding(marketKey: string): Promise<undefined | any[]>

Inherited from ZoDBUser.getFunding
- Defined in src/user/zoDBUser/ZoDBTradeUser.ts:319
Parameters
- marketKey: string
Returns Promise<undefined | any[]>

getFundingByPage

getFundingByPage(marketKey: string, page: number): Promise<any>

Inherited from ZoDBUser.getFundingByPage
- Defined in src/user/zoDBUser/ZoDBTradeUser.ts:370
Parameters
- marketKey: string
- page: number
Returns Promise<any>

getOrderByOrderId

getOrderByOrderId(orderId: any): null | OrderInfo

- Defined in src/user/ZoUser.ts:157
Parameters
- orderId: any
Returns null | OrderInfo

getOrderbook

getOrderbook(marketKey: string): Promise<{ asks: number[][]; bids: number[][] }>

- Defined in src/user/ZoUser.ts:169
Parameters
- marketKey: string
Returns Promise<{ asks: number[][]; bids: number[][] }>

getPerpLiqHistory

getPerpLiqHistory(page: number, marketsDecoder: (string: any) => MarketInfo, allMarkets: boolean, currentMarketKey: string): Promise<any[]>

Inherited from ZoDBUser.getPerpLiqHistory
- Defined in src/user/zoDBUser/ZoDBPerpLiqUser.ts:64
Parameters
- page: number
- marketsDecoder: (string: any) => MarketInfo
  - - (string: any): MarketInfo
    - Parameters
      - string: any
      Returns MarketInfo
- allMarkets: boolean
- currentMarketKey: string
Returns Promise<any[]>

getPnlHistory

getPnlHistory(page: number, currentMarketKey: string, assetDecimalsDecoder: (sym: any) => number, allMarkets: boolean, allHistory?: boolean): Promise<any[]>

Inherited from ZoDBUser.getPnlHistory
- Defined in src/user/zoDBUser/ZoDBPnlUser.ts:87
Parameters
- page: number
- currentMarketKey: string
- assetDecimalsDecoder: (sym: any) => number
  - - (sym: any): number
    - Parameters
      - sym: any
      Returns number
- allMarkets: boolean
- Optional allHistory: boolean
Returns Promise<any[]>

getSpotLiqHistory

getSpotLiqHistory(page: number, assets: {}): Promise<any>

Inherited from ZoDBUser.getSpotLiqHistory
- Defined in src/user/zoDBUser/ZoDBSpotLiqUser.ts:51
Parameters
- page: number
- assets: {}
  - [key: string]: AssetInfo
Returns Promise<any>

getSwapHistory

getSwapHistory(page: number, assets: {}): Promise<any>

Inherited from ZoDBUser.getSwapHistory
- Defined in src/user/zoDBUser/ZoDBSwapUser.ts:53
Parameters
- page: number
- assets: {}
  - [key: string]: AssetInfo
Returns Promise<any>

getTradesAndFunding

getTradesAndFunding(page: number, currentMarketKey: string, fundingOnly: boolean, allTrades: boolean): Promise<any[]>

Inherited from ZoDBUser.getTradesAndFunding
- Defined in src/user/zoDBUser/ZoDBTradeUser.ts:86
Parameters
- page: number
- currentMarketKey: string
- fundingOnly: boolean
- allTrades: boolean
Returns Promise<any[]>

getTransferHistory

getTransferHistory(page: number, assets: {}, entriesPerPage?: number): Promise<TransferHistoryEntry[]>

Inherited from ZoDBUser.getTransferHistory
- Defined in src/user/zoDBUser/ZoDBTransferUser.ts:48
Parameters
- page: number
- assets: {}
  - [key: string]: AssetInfo
- Optional entriesPerPage: number
Returns Promise<TransferHistoryEntry[]>

loadPositionsArr

loadPositionsArr(markets: {}, indexToMarketKey: {}): PositionInfo[]

Inherited from ZoDBUser.loadPositionsArr
- Defined in src/user/ZoBaseUser.ts:35
loading positions, note that markets have to be loaded in the correct order. It also removes the sign from coins & pCoins.

Parameters
- markets: {}
  - [key: string]: MarketInfo
- indexToMarketKey: {}
  - [key: number]: string
Returns PositionInfo[]

longOrderSize

longOrderSize(marketKey: string): Decimal

- Defined in src/user/ZoUser.ts:121
Parameters
- marketKey: string
Returns Decimal

openSize

openSize(marketKey: string): Decimal

- Defined in src/user/ZoUser.ts:129
Parameters
- marketKey: string
Returns Decimal

position

position(marketKey: string): PositionInfo

- Defined in src/user/ZoUser.ts:56
Parameters
- marketKey: string
Returns PositionInfo

positionFunding

positionFunding(positionOrMarketKey: string | PositionInfo): Decimal

- Defined in src/user/ZoUser.ts:88
Parameters
- positionOrMarketKey: string | PositionInfo
Returns Decimal

positionPnL

positionPnL(positionOrMarketKey: string | PositionInfo): Decimal

- Defined in src/user/ZoUser.ts:72
Parameters
- positionOrMarketKey: string | PositionInfo
Returns Decimal

positionPnLBasedOnMarkPrice

positionPnLBasedOnMarkPrice(positionOrMarketKey: string | PositionInfo): Decimal

- Defined in src/user/ZoUser.ts:79
Parameters
- positionOrMarketKey: string | PositionInfo
Returns Decimal

shortOrderSize

shortOrderSize(marketKey: string): Decimal

- Defined in src/user/ZoUser.ts:125
Parameters
- marketKey: string
Returns Decimal

subscribe(withBackup?: boolean, stateLimit?: number, cacheLimit?: number): Promise<void>

- Defined in src/user/ZoUser.ts:183
Parameters
- withBackup: boolean = false
- stateLimit: number = 1000
- cacheLimit: number = 5000
Returns Promise<void>

unsubscribe

unsubscribe(): Promise<void>

- Defined in src/user/ZoUser.ts:236
Returns Promise<void>

Static load

load(account: Keypair | Wallet, cluster: Cluster, opts: { commitment?: Commitment; rpcUrl: string; skipPreflight?: boolean; withRealm: boolean }): Promise<ZoUser>

- Defined in src/user/ZoUser.ts:244
Parameters
- account: Keypair | Wallet
- cluster: Cluster
- opts: { commitment?: Commitment; rpcUrl: string; skipPreflight?: boolean; withRealm: boolean }
  - Optional commitment?: Commitment
  - rpcUrl: string
  - Optional skipPreflight?: boolean
  - withRealm: boolean
Returns Promise<ZoUser>

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

margin: Margin

Optional realm: any

Optional realmConnected: boolean

Returns ZoUser

Properties

balanceHistory

Type declaration

[key: string]: TradeHistoryEntry[]

eventEmitter

fundingHistory

Type declaration

[key: string]: any[]

fundingPagesParsed

Type declaration

[key: string]: number

fundingParsed

Type declaration

[key: string]: boolean

margin

perpLiqCurrentPage

Type declaration

[key: string]: number

perpLiqHistory

Type declaration

[key: string]: PerpLiqHistoryEntry[]

perpLiqPagesParsed

Type declaration

[key: string]: number

pnlCurrentPage

Type declaration

[key: string]: number

pnlHistory

Type declaration

[key: string]: PnlHistoryEntry[]

pnlPagesParsed

Type declaration

[key: string]: number

positionsArr

realm

realmConnected

spotLiqCurrentPage

spotLiqHistory

spotLiqPagesParsed

subLock

swapCurrentPage

swapHistory

swapPagesParsed

tradesCurrentPage

Type declaration

[key: string]: number

tradesPagesParsed

Type declaration

[key: string]: number

tradesParsed

Type declaration

[key: string]: boolean

transferCurrentPage

transferHistory

transferPagesParsed

Accessors

assets

Returns {}

[key: string]: AssetInfo

balances

Returns {}

[key: string]: Num

cache

Returns Cache

connection

Returns Connection

control