Class UserStatsMap

Hierarchy

UserStatsMap

Index

Constructors

Properties

bulkAccountLoader driftClient userStatsMap

Methods

addUserStat get has mustGet size subscribe sync unsubscribe updateWithEventRecord updateWithOrderRecord values

Constructors

constructor

new UserStatsMap(driftClient: DriftClient, bulkAccountLoader?: BulkAccountLoader): UserStatsMap
Creates a new UserStatsMap instance.
Parameters
- driftClient: DriftClient
  
  The DriftClient instance.
- Optional bulkAccountLoader: BulkAccountLoader
  
  If not provided, a new BulkAccountLoader with polling disabled will be created.
Returns UserStatsMap
- Defined in sdk/src/userMap/userStatsMap.ts:37

Properties

`Private` bulkAccountLoader

bulkAccountLoader: BulkAccountLoader

`Private` driftClient

driftClient: DriftClient

`Private` userStatsMap

userStatsMap: Map<string, UserStats> = ...

map from authority pubkey to UserStats

Methods

addUserStat

addUserStat(authority: PublicKey, userStatsAccount?: UserStatsAccount, skipFetch?: boolean): Promise<void>
Parameters
- authority: PublicKey
  
  that owns the UserStatsAccount
- Optional userStatsAccount: UserStatsAccount
  
  optional UserStatsAccount to subscribe to, if undefined will be fetched later
- Optional skipFetch: boolean
  
  if true, will not immediately fetch the UserStatsAccount
Returns Promise<void>
- Defined in sdk/src/userMap/userStatsMap.ts:64

get

get(authorityPublicKey: string): UserStats
Parameters
- authorityPublicKey: string
Returns UserStats
- Defined in sdk/src/userMap/userStatsMap.ts:169

has

has(authorityPublicKey: string): boolean
Parameters
- authorityPublicKey: string
Returns boolean
- Defined in sdk/src/userMap/userStatsMap.ts:165

mustGet

mustGet(authorityPublicKey: string): Promise<UserStats>
Enforce that a UserStats will exist for the given authorityPublicKey, reading one from the blockchain if necessary.

Returns
Parameters
- authorityPublicKey: string
Returns Promise<UserStats>
- Defined in sdk/src/userMap/userStatsMap.ts:179

size

size(): number
Returns number
- Defined in sdk/src/userMap/userStatsMap.ts:194

subscribe

subscribe(authorities: PublicKey[]): Promise<void>
Parameters
- authorities: PublicKey[]
Returns Promise<void>
- Defined in sdk/src/userMap/userStatsMap.ts:49

sync

sync(authorities: PublicKey[]): Promise<void>
Sync the UserStatsMap
Parameters
- authorities: PublicKey[]
  
  list of authorities to derive UserStatsAccount public keys from. You may want to get this list from UserMap in order to filter out idle users
Returns Promise<void>
- Defined in sdk/src/userMap/userStatsMap.ts:203

unsubscribe

unsubscribe(): Promise<void>
Returns Promise<void>
- Defined in sdk/src/userMap/userStatsMap.ts:212

updateWithEventRecord

updateWithEventRecord(record: any, userMap?: UserMap): Promise<void>
Parameters
- record: any
- Optional userMap: UserMap
Returns Promise<void>
- Defined in sdk/src/userMap/userStatsMap.ts:98

updateWithOrderRecord

updateWithOrderRecord(record: OrderRecord, userMap: UserMap): Promise<void>
Parameters
- record: OrderRecord
- userMap: UserMap
Returns Promise<void>
- Defined in sdk/src/userMap/userStatsMap.ts:91

values

values(): IterableIterator<UserStats>
Returns IterableIterator<UserStats>
- Defined in sdk/src/userMap/userStatsMap.ts:190

Generated using TypeDoc