Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Cache

The Cache account stores and tracks oracle prices, mark prices, funding and borrow lending multipliers.

Hierarchy

  • default<Schema>
    • Cache

Index

Constructors

Properties

Accessors

Methods

Constructors

Private constructor

  • new Cache(program: Program<Zo>, k: PublicKey, data: Schema, _st: Schema, commitment?: Commitment): Cache

  • Parameters

    • program: Program<Zo>
    • k: PublicKey
    • data: Schema
    • _st: Schema
    • Optional commitment: Commitment

    Returns Cache

Properties

Protected backupSubscriberChannel

backupSubscriberChannel: undefined | number

Protected Readonly commitment

commitment: Commitment = "processed"

data

data: Readonly<Schema>

eventEmitter

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

lastAccountSnapshotTime

lastAccountSnapshotTime: number = ...

Protected mainSubscriberChannel

mainSubscriberChannel: undefined | number

Readonly pubkey

pubkey: PublicKey

slot

slot: number = -1

Protected subLock

subLock: AsyncLock = ...

subscribeLastUpdate

subscribeLastUpdate: number = ...

subscribeTimeLimit

subscribeTimeLimit: number = 0

Accessors

connection

  • get connection(): Connection

program

  • get program(): Program<Zo>

provider

  • get provider(): default

publicKey

  • get publicKey(): PublicKey

Methods

Protected _subscribe

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

  • Parameters

    • accountName: string
    • withBackup: boolean = false
    • Optional programPassed: Program<any>

    Returns Promise<EventEmitter<string | symbol, any>>

Protected _unsubscribe

  • _unsubscribe(): Promise<void>

getDexProgram

  • getDexProgram(): PublicKey

getOracleBySymbol

  • getOracleBySymbol(sym: string): OracleCache

  • Parameters

    • sym: string

      The collateral symbol. Ex: ("BTC")

    Returns OracleCache

    The oracle cache for the given collateral.

refresh

  • refresh(): Promise<void>

subscribe

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

  • Parameters

    • withBackup: boolean = false

      use a backup confirmed listener

    • subscribeLimit: number = 5000

      minimum time difference between cache updates, to prevent constant reloads

    Returns Promise<void>

unsubscribe

  • unsubscribe(): Promise<void>

updateAccountOnChange

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

  • 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

updateState

  • updateState(st: Schema): Promise<void>

Static Private fetch

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

  • Parameters

    • program: Program<Zo>
    • k: PublicKey
    • st: Schema
    • commitment: Commitment

    Returns Promise<Schema>

Static load

  • load(program: Program<Zo>, k: PublicKey, st: Schema, commitment?: Commitment): Promise<Cache>

  • Loads a new Cache object from its public key.

    Parameters

    • program: Program<Zo>
    • k: PublicKey

      The cache account's public key.

    • st: Schema
    • commitment: Commitment = ...

    Returns Promise<Cache>

Static Private processRawCacheData

  • processRawCacheData(data: CacheSchema, st: Schema): Schema

Generated using TypeDoc