Class UserMap

Hierarchy

UserMap

Implements

UserMapInterface

Constructors

constructor

new UserMap(config: UserMapConfig): UserMap
Constructs a new UserMap instance.
Parameters
- config: UserMapConfig
Returns UserMap
- Defined in sdk/src/userMap/userMap.ts:95

Properties

`Private` commitment

commitment: Commitment

`Private` connection

connection: Connection

`Private` decode

decode: any

`Private` disableSyncOnTotalAccountsChange

disableSyncOnTotalAccountsChange: boolean

driftClient

driftClient: DriftClient

`Private` includeIdle

includeIdle: boolean

`Private` lastNumberOfSubAccounts

lastNumberOfSubAccounts: BN

`Private` mostRecentSlot

mostRecentSlot: number = 0

`Private` subscription

subscription: PollingSubscription | WebsocketSubscription

`Private` syncConfig

syncConfig: SyncConfig

`Private` `Optional` syncPromise

syncPromise?: Promise<void>

`Private` syncPromiseResolver

syncPromiseResolver: (() => void)

Type declaration

- (): void
- Returns void

`Private` userMap

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

Methods

addPubkey

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

`Private` defaultSync

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

entries

entries(): IterableIterator<[string, User]>
Returns IterableIterator<[string, User]>
Implementation of UserMapInterface.entries
- Defined in sdk/src/userMap/userMap.ts:314

entriesWithSlot

entriesWithSlot(): IterableIterator<[string, DataAndSlot<User>]>
Returns IterableIterator<[string, DataAndSlot<User>]>
Implementation of UserMapInterface.entriesWithSlot
- Defined in sdk/src/userMap/userMap.ts:319

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:198

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:257

getSlot

getSlot(): number
Returns number
- Defined in sdk/src/userMap/userMap.ts:616

getUniqueAuthorities

getUniqueAuthorities(filterCriteria?: UserAccountFilterCriteria): PublicKey[]
Returns a unique list of authorities for all users in the UserMap that meet the filter criteria

Returns
Parameters
- Optional filterCriteria: UserAccountFilterCriteria
Returns PublicKey[]
- Defined in sdk/src/userMap/userMap.ts:332

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:244

getWithSlot

getWithSlot(key: string): DataAndSlot<User>
Parameters
- key: string
Returns DataAndSlot<User>
Implementation of UserMapInterface.getWithSlot
- Defined in sdk/src/userMap/userMap.ts:201

has

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

mustGet

mustGet(key: string, accountSubscription?: UserSubscriptionConfig): 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
- Optional accountSubscription: UserSubscriptionConfig
Returns Promise<User>
Implementation of UserMapInterface.mustGet
- Defined in sdk/src/userMap/userMap.ts:210

mustGetWithSlot

mustGetWithSlot(key: string, accountSubscription?: UserSubscriptionConfig): Promise<DataAndSlot<User>>
Parameters
- key: string
- Optional accountSubscription: UserSubscriptionConfig
Returns Promise<DataAndSlot<User>>
Implementation of UserMapInterface.mustGetWithSlot
- Defined in sdk/src/userMap/userMap.ts:224

`Private` paginatedSync

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

size

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

`Private` stateAccountUpdateCallback

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

subscribe

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

sync

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

unsubscribe

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

updateLatestSlot

updateLatestSlot(slot: number): void
Parameters
- slot: number
Returns void
- Defined in sdk/src/userMap/userMap.ts:612

updateUserAccount

updateUserAccount(key: string, userAccount: UserAccount, slot: number): Promise<void>
Parameters
- key: string
- userAccount: UserAccount
- slot: number
Returns Promise<void>
- Defined in sdk/src/userMap/userMap.ts:592

updateWithEventRecord

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

updateWithOrderRecord

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

values

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

valuesWithSlot

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

Generated using TypeDoc