Class UserMap

Hierarchy

UserMap

Implements

UserMapInterface

Index

Constructors

Properties

accountSubscription driftClient includeIdle lastNumberOfSubAccounts userMap

Methods

addPubkey get getDLOB getUserAuthority has mustGet size subscribe sync syncCallback unsubscribe updateWithEventRecord updateWithOrderRecord values

Constructors

constructor

new UserMap(driftClient: DriftClient, accountSubscription: UserSubscriptionConfig, includeIdle?: boolean): UserMap
Parameters
- driftClient: DriftClient
- accountSubscription: UserSubscriptionConfig
- includeIdle: boolean = false
  
  whether idle users are subscribed to. defaults to false to decrease # of user subscriptions
Returns UserMap
- Defined in sdk/src/userMap/userMap.ts:54

Properties

`Private` accountSubscription

accountSubscription: UserSubscriptionConfig

`Private` driftClient

driftClient: DriftClient

`Private` includeIdle

includeIdle: boolean

`Private` lastNumberOfSubAccounts

lastNumberOfSubAccounts: any

`Private` userMap

userMap: Map<string, User> = ...

Methods

addPubkey

addPubkey(userAccountPublicKey: PublicKey, userAccount?: UserAccount): Promise<void>
Parameters
- userAccountPublicKey: PublicKey
- Optional userAccount: UserAccount
Returns Promise<void>
Implementation of UserMapInterface.addPubkey
- Defined in sdk/src/userMap/userMap.ts:77

get

get(key: string): User
gets the User for a particular userAccountPublicKey, if no User exists, undefined is returned

Returns
user User | undefined
Parameters
- key: string
  
  userAccountPublicKey to get User for
Returns User
Implementation of UserMapInterface.get
- Defined in sdk/src/userMap/userMap.ts:99

getDLOB

getDLOB(slot: number): Promise<DLOB>
implements the DLOBSource interface create a DLOB from all the subscribed users
Parameters
- slot: number
Returns Promise<DLOB>
- Defined in sdk/src/userMap/userMap.ts:134

getUserAuthority

getUserAuthority(key: string): PublicKey
gets the Authority for a particular userAccountPublicKey, if no User exists, undefined is returned

Returns
authority PublicKey | undefined
Parameters
- key: string
  
  userAccountPublicKey to get User for
Returns PublicKey
Implementation of UserMapInterface.getUserAuthority
- Defined in sdk/src/userMap/userMap.ts:121

has

has(key: string): boolean
Parameters
- key: string
Returns boolean
Implementation of UserMapInterface.has
- Defined in sdk/src/userMap/userMap.ts:90

mustGet

mustGet(key: string): Promise<User>
gets the User for a particular userAccountPublicKey, if no User exists, new one is created

Returns
User
Parameters
- key: string
  
  userAccountPublicKey to get User for
Returns Promise<User>
Implementation of UserMapInterface.mustGet
- Defined in sdk/src/userMap/userMap.ts:108

size

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

subscribe

subscribe(): Promise<void>
Returns Promise<void>
Implementation of UserMapInterface.subscribe
- Defined in sdk/src/userMap/userMap.ts:64

sync

sync(): Promise<void>
Returns Promise<void>
- Defined in sdk/src/userMap/userMap.ts:190

`Private` syncCallback

syncCallback(state: StateAccount): Promise<void>
Parameters
- state: StateAccount
Returns Promise<void>
- Defined in sdk/src/userMap/userMap.ts:41

unsubscribe

unsubscribe(): Promise<void>
Returns Promise<void>
Implementation of UserMapInterface.unsubscribe
- Defined in sdk/src/userMap/userMap.ts:261

updateWithEventRecord

updateWithEventRecord(record: any): Promise<void>
Parameters
- record: any
Returns Promise<void>
- Defined in sdk/src/userMap/userMap.ts:146

updateWithOrderRecord

updateWithOrderRecord(record: OrderRecord): Promise<void>
Parameters
- record: OrderRecord
Returns Promise<void>
Implementation of UserMapInterface.updateWithOrderRecord
- Defined in sdk/src/userMap/userMap.ts:140

values

values(): IterableIterator<User>
Returns IterableIterator<User>
Implementation of UserMapInterface.values
- Defined in sdk/src/userMap/userMap.ts:182

Generated using TypeDoc