State | @zero_one/client

The state account defines program-level parameters, and tracks listed markets and supported collaterals.

Hierarchy

default<Schema>
- State

Index

Constructors

constructor

Accessors

Constructors

Private constructor

new State(program: Program<Zo>, pubkey: PublicKey, data: Readonly<Schema>, signer: PublicKey, cache: Cache, commitment?: Commitment): State

Overrides BaseAccount<Schema>.constructor
- Defined in src/accounts/State.ts:63
Parameters
- program: Program<Zo>
- pubkey: PublicKey
- data: Readonly<Schema>
- signer: PublicKey
- cache: Cache
- Optional commitment: Commitment
Returns State

Properties

_eqEmitters

_eqEmitters: {} = {}

Event Queue listeners

Type declaration

[key: string]: EventEmitter<string, any>

_eqEmittersKeys

_eqEmittersKeys: {} = {}

Type declaration

[key: string]: number

_eqEmittersLocks

_eqEmittersLocks: {} = {}

Type declaration

[key: string]: AsyncLock

_obEmitters

_obEmitters: {} = {}

OB listeners

Type declaration

[key: string]: EventEmitter<string, any>

_obEmittersKeys

_obEmittersKeys: {} = {}

Type declaration

[key: string]: number

_obEmittersLocks

_obEmittersLocks: {} = {}

Type declaration

[key: string]: AsyncLock

assets

assets: {} = {}

Type declaration

[key: string]: AssetInfo

Protected backupSubscriberChannel

backupSubscriberChannel: undefined | number

Readonly cache

cache: Cache

Protected Readonly commitment

commitment: Commitment = "processed"

data

data: Readonly<Schema>

eventEmitter

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

Subscriptions

lastAccountSnapshotTime

lastAccountSnapshotTime: number = ...

Protected mainSubscriberChannel

mainSubscriberChannel: undefined | number

markets

markets: {} = {}

Type declaration

[key: string]: MarketInfo

Readonly pubkey

pubkey: PublicKey

Readonly signer

signer: PublicKey

slot

slot: number = -1

Protected subLock

subLock: AsyncLock = ...

subscribeLastUpdate

subscribeLastUpdate: number = ...

subscribeTimeLimit

subscribeTimeLimit: number = 0

zoMarketAccounts

zoMarketAccounts: {} = {}

zo market infos

Type declaration

[key: string]: { asks: Orderbook; bids: Orderbook; dexMarket: ZoMarket; eventQueue: Event[] }
- asks: Orderbook
- bids: Orderbook
- dexMarket: ZoMarket
- eventQueue: Event[]

Accessors

connection

get connection(): Connection

Inherited from BaseAccount.connection
- Defined in src/accounts/BaseAccount.ts:129
Returns Connection

indexToAssetKey

get indexToAssetKey(): string[]

- Defined in src/accounts/State.ts:77
map asset index to asset key

Returns string[]

indexToMarketKey

get indexToMarketKey(): string[]

- Defined in src/accounts/State.ts:88
map market index to market key

Returns string[]

program

get program(): Program<Zo>

Inherited from BaseAccount.program
- Defined in src/accounts/BaseAccount.ts:121
Returns Program<Zo>

provider

get provider(): default

Inherited from BaseAccount.provider
- Defined in src/accounts/BaseAccount.ts:125
Returns default

publicKey

get publicKey(): PublicKey

Inherited from BaseAccount.publicKey
- Defined in src/accounts/BaseAccount.ts:133
Returns PublicKey

Methods

_getMarketType

_getMarketType(perpType: any): Perp | EverCall | EverPut | SquaredPerp

- Defined in src/accounts/State.ts:559
gets market type

Parameters
- perpType: any
Returns Perp | EverCall | EverPut | SquaredPerp

Protected _subscribe

_subscribe(accountName: string, withBackup?: boolean, programPassed?: Program<any>): Promise<EventEmitter<string | symbol, any>>

Inherited from BaseAccount._subscribe
- Defined in src/accounts/BaseAccount.ts:76
Parameters
- accountName: string
- withBackup: boolean = false
- Optional programPassed: Program<any>
Returns Promise<EventEmitter<string | symbol, any>>

Protected _unsubscribe

_unsubscribe(): Promise<void>

Inherited from BaseAccount._unsubscribe
- Defined in src/accounts/BaseAccount.ts:61
Returns Promise<void>

cacheInterestRates

cacheInterestRates(start: number, end: number): Promise<string>

- Defined in src/accounts/State.ts:353
Called by the keepers to update the borrow and supply multipliers.

Parameters
- start: number
  
  The inclusive start index of the collateral array.
- end: number
  
  The exclusive end index of the collateral array.
Returns Promise<string>

cacheOracle

cacheOracle(mockPrices?: BN[]): Promise<string>

- Defined in src/accounts/State.ts:318
Called by the keepers regularly to cache the oracle prices.

Parameters
- Optional mockPrices: BN[]
  
  Only used for testing purposes. An array of user-set prices.
Returns Promise<string>

eqEmitter

eqEmitter(symbol: string): undefined | EventEmitter<string, any>

- Defined in src/accounts/State.ts:943
Parameters
- symbol: string
Returns undefined | EventEmitter<string, any>

getBestAsk

getBestAsk(marketKey: string): number

- Defined in src/accounts/State.ts:720
Parameters
- marketKey: string
Returns number

getBestBid

getBestBid(marketKey: string): number

- Defined in src/accounts/State.ts:726
Parameters
- marketKey: string
Returns number

getCollateralIndex

getCollateralIndex(mint: PublicKey): number

- Defined in src/accounts/State.ts:217
Get the index of the collateral in the State's collaterals list using the mint public key.

Parameters
- mint: PublicKey
  
  The mint's public key.
Returns number

getDexProgram

getDexProgram(): PublicKey

Inherited from BaseAccount.getDexProgram
- Defined in src/accounts/BaseAccount.ts:55
Returns PublicKey

getFundingInfo

getFundingInfo(symbol: string): FundingInfo

- Defined in src/accounts/State.ts:695
Gets the funding info object for a given market. Funding will be undefined in the first minute of the hour. Make sure to handle that case!

Parameters
- symbol: string
Returns FundingInfo

getMarketBySymbol

getMarketBySymbol(sym: string, withOrderbooks?: boolean, withEventQueues?: boolean): Promise<ZoMarket>

- Defined in src/accounts/State.ts:273
Parameters
- sym: string
- Optional withOrderbooks: boolean
- Optional withEventQueues: boolean
Returns Promise<ZoMarket>

getMarketImf

getMarketImf(marketKey: string): Decimal

- Defined in src/accounts/State.ts:732
Parameters
- marketKey: string
Returns Decimal

getMarketIndexBySymbol

getMarketIndexBySymbol(sym: string): number

- Defined in src/accounts/State.ts:258
Get the index of a market in the State's PerpMarkets list using the market symbol.

Parameters
- sym: string
  
  The market symbol. Ex:("BTC-PERP")
Returns number

getMarketKeyBySymbol

getMarketKeyBySymbol(sym: string): PublicKey

- Defined in src/accounts/State.ts:268
Parameters
- sym: string
Returns PublicKey

getMarketMmf

getMarketMmf(marketKey: string): Decimal

- Defined in src/accounts/State.ts:736
Parameters
- marketKey: string
Returns Decimal

getMintBySymbol

getMintBySymbol(symbol: string): PublicKey

- Defined in src/accounts/State.ts:227
Parameters
- symbol: string
Returns PublicKey

getVaultCollateralByMint

getVaultCollateralByMint(mint: PublicKey): [PublicKey, CollateralInfo]

- Defined in src/accounts/State.ts:244
Get the vault public key and the CollateralInfo object for a collateral using the mint public key.

Parameters
- mint: PublicKey
  
  The mint's public key.
Returns [PublicKey, CollateralInfo]
The vault public key and the CollateralInfo object.

getZoMarketAccounts

getZoMarketAccounts(__namedParameters: { market: MarketInfo; withEventQueues?: boolean; withOrderbooks?: boolean }): Promise<{ asks: Orderbook; bids: Orderbook; dexMarket: ZoMarket; eventQueue: Event[] }>

- Defined in src/accounts/State.ts:369
Get the ZoMarket DEX accounts for a market using the market object ( { dexMarket: ZoMarket; bids: Orderbook; asks: Orderbook } )

Parameters
- __namedParameters: { market: MarketInfo; withEventQueues?: boolean; withOrderbooks?: boolean }
  - market: MarketInfo
  - Optional withEventQueues?: boolean
  - Optional withOrderbooks?: boolean
Returns Promise<{ asks: Orderbook; bids: Orderbook; dexMarket: ZoMarket; eventQueue: Event[] }>

loadAssets

loadAssets(): StateBalanceChange[]

- Defined in src/accounts/State.ts:468
Load all assets

Returns StateBalanceChange[]

loadMarkets

loadMarkets(): (MarketPriceChange | MarketFundingChange)[]

- Defined in src/accounts/State.ts:575
Load all market infos

Returns (MarketPriceChange | MarketFundingChange)[]

loadZoMarkets

loadZoMarkets(withOrderbooks?: boolean, withEventQueues?: boolean): Promise<void>

- Defined in src/accounts/State.ts:448
Load all ZoMarket DEX Accounts

Parameters
- Optional withOrderbooks: boolean
- Optional withEventQueues: boolean
Returns Promise<void>

obEmitter

obEmitter(symbol: string): undefined | EventEmitter<string, any>

- Defined in src/accounts/State.ts:819
Parameters
- symbol: string
Returns undefined | EventEmitter<string, any>

Private processAssetChangeLog

processAssetChangeLog(symbol: string, assets: {}, changeLog: StateBalanceChange[]): void

- Defined in src/accounts/State.ts:524
Parameters
- symbol: string
- assets: {}
  - [p: string]: AssetInfo
- changeLog: StateBalanceChange[]
Returns void

Private processMarketChangeLog

processMarketChangeLog(symbol: string, markets: {}, changeLog: (MarketPriceChange | MarketFundingChange)[]): void

- Defined in src/accounts/State.ts:644
Parameters
- symbol: string
- markets: {}
  - [p: string]: MarketInfo
- changeLog: (MarketPriceChange | MarketFundingChange)[]
Returns void

refresh

refresh(): Promise<void>

Overrides BaseAccount.refresh
- Defined in src/accounts/State.ts:203
Returns Promise<void>

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

- Defined in src/accounts/State.ts:759
Parameters
- withBackup: boolean = false
  
  use a backup confirmed listener
- subscribeLimit: number = 1000
  
  minimum time difference between state updates, to prevent constant reloads
- cacheLimit: number = 5000
  
  minimum time difference between cache updates, to prevent constant reloads
Returns Promise<void>

subscribeToAllOrderbooks

subscribeToAllOrderbooks(): Promise<void>

- Defined in src/accounts/State.ts:909
Returns Promise<void>

subscribeToEventQueue

subscribeToEventQueue(symbol: string): Promise<void>

- Defined in src/accounts/State.ts:947
Parameters
- symbol: string
Returns Promise<void>

subscribeToOrderbook

subscribeToOrderbook(symbol: string): Promise<void>

- Defined in src/accounts/State.ts:823
Parameters
- symbol: string
Returns Promise<void>

unsubscribe

unsubscribe(): Promise<void>

- Defined in src/accounts/State.ts:798
Returns Promise<void>

unsubscribeFromAllOrderbooks

unsubscribeFromAllOrderbooks(): Promise<void>

- Defined in src/accounts/State.ts:922
Returns Promise<void>

unsubscribeFromEventQueue

unsubscribeFromEventQueue(symbol: string): Promise<void>

- Defined in src/accounts/State.ts:981
Parameters
- symbol: string
Returns Promise<void>

unsubscribeFromOrderbook

unsubscribeFromOrderbook(symbol: string): Promise<void>

- Defined in src/accounts/State.ts:886
Parameters
- symbol: string
Returns Promise<void>

updateAccountOnChange

updateAccountOnChange(processUpdate: any, that: default<T>): (account: any, snapshotTime?: any) => void

Inherited from BaseAccount.updateAccountOnChange
- Defined in src/accounts/BaseAccount.ts:16
Parameters
- processUpdate: any
- that: default<T>
Returns (account: any, snapshotTime?: any) => void
- - (account: any, snapshotTime?: any): void
  - Parameters
    - account: any
    - Optional snapshotTime: any
    Returns void

updatePerpFunding

updatePerpFunding(symbol: string): Promise<string>

- Defined in src/accounts/State.ts:299
Called by the keepers every hour to update the funding on each market.

Parameters
- symbol: string
  
  The market symbol. Ex:("BTC-PERP")
Returns Promise<string>

Static Private computeSupplyAndBorrowApys

computeSupplyAndBorrowApys(utilization: Decimal, optimalUtility: Decimal, maxRate: Decimal, optimalRate: Decimal): { borrowApy: any; supplyApy: any }

- Defined in src/accounts/State.ts:182
computes supply and borrow apys

Parameters
- utilization: Decimal
- optimalUtility: Decimal
- maxRate: Decimal
- optimalRate: Decimal
Returns { borrowApy: any; supplyApy: any }
- borrowApy: any
- supplyApy: any

Static Private fetch

fetch(program: Program<Zo>, k: PublicKey, commitment: Commitment): Promise<Schema>

- Defined in src/accounts/State.ts:133
Parameters
- program: Program<Zo>
- k: PublicKey
- commitment: Commitment
Returns Promise<Schema>

Static getEventQueueUpdateEventName

getEventQueueUpdateEventName(symbol: string): string

- Defined in src/accounts/State.ts:147
Parameters
- symbol: string
Returns string

Static getOrderbookUpdateEventName

getOrderbookUpdateEventName(symbol: string): string

- Defined in src/accounts/State.ts:740
Parameters
- symbol: string
Returns string

Static getSigner

getSigner(stateKey: PublicKey, programId: PublicKey): Promise<[PublicKey, number]>

- Defined in src/accounts/State.ts:100
Gets the state signer's pda account and bump.

Parameters
- stateKey: PublicKey
- programId: PublicKey
Returns Promise<[PublicKey, number]>
An array consisting of the state signer pda and bump.

Static load

load(program: Program<Zo>, k: PublicKey, commitment?: Commitment): Promise<State>

- Defined in src/accounts/State.ts:115
Parameters
- program: Program<Zo>
- k: PublicKey
  
  The state's public key.
- commitment: Commitment = ...
Returns Promise<State>

Static Private processRawStateData

processRawStateData(data: StateSchema): Schema

- Defined in src/accounts/State.ts:151
Parameters
- data: StateSchema
Returns Schema

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

Private constructor

Parameters

program: Program<Zo>

pubkey: PublicKey

data: Readonly<Schema>

signer: PublicKey

cache: Cache

Optional commitment: Commitment

Returns State

Properties

_eqEmitters

Type declaration

[key: string]: EventEmitter<string, any>

_eqEmittersKeys

Type declaration

[key: string]: number

_eqEmittersLocks

Type declaration

[key: string]: AsyncLock

_obEmitters

Type declaration

[key: string]: EventEmitter<string, any>

_obEmittersKeys

Type declaration

[key: string]: number

_obEmittersLocks

Type declaration

[key: string]: AsyncLock

assets

Type declaration

[key: string]: AssetInfo

Protected backupSubscriberChannel

Readonly cache

Protected Readonly commitment

data

eventEmitter

lastAccountSnapshotTime

Protected mainSubscriberChannel

markets

Type declaration

[key: string]: MarketInfo

Readonly pubkey

Readonly signer

slot

Protected subLock

subscribeLastUpdate

subscribeTimeLimit

zoMarketAccounts

Type declaration

[key: string]: { asks: Orderbook; bids: Orderbook; dexMarket: ZoMarket; eventQueue: Event[] }

asks: Orderbook

bids: Orderbook

dexMarket: ZoMarket

eventQueue: Event[]

Accessors

connection

Returns Connection

indexToAssetKey

Returns string[]

indexToMarketKey

Returns string[]

program

Returns Program<Zo>

provider

Returns default

publicKey

Returns PublicKey

Methods

_getMarketType

Parameters

perpType: any

Returns Perp | EverCall | EverPut | SquaredPerp

Protected _subscribe