Class OneShotUserAccountSubscriber

Simple implementation of UserAccountSubscriber. It will fetch the UserAccount date on subscribe (or call to fetch) if no account data is provided on init. Expect to use only 1 RPC call unless you call fetch repeatedly.

Hierarchy

BasicUserAccountSubscriber
- OneShotUserAccountSubscriber

Implements

UserAccountSubscriber

Index

Constructors

constructor

new OneShotUserAccountSubscriber(program: Program<Idl>, userAccountPublicKey: PublicKey, data?: UserAccount, slot?: number, commitment?: Commitment): OneShotUserAccountSubscriber
Parameters
- program: Program<Idl>
- userAccountPublicKey: PublicKey
- Optional data: UserAccount
- Optional slot: number
- Optional commitment: Commitment
Returns OneShotUserAccountSubscriber
Overrides BasicUserAccountSubscriber.constructor
- Defined in sdk/src/accounts/oneShotUserAccountSubscriber.ts:19

Properties

`Optional` callbackId

callbackId?: string

commitment

commitment: Commitment

`Optional` errorCallbackId

errorCallbackId?: string

eventEmitter

isSubscribed

isSubscribed: boolean

program

program: Program<Idl>

user

user: DataAndSlot<UserAccount>

userAccountPublicKey

userAccountPublicKey: PublicKey

Methods

addToAccountLoader

addToAccountLoader(): Promise<void>
Returns Promise<void>
Inherited from BasicUserAccountSubscriber.addToAccountLoader
- Defined in sdk/src/accounts/basicUserAccountSubscriber.ts:36

assertIsSubscribed

assertIsSubscribed(): void
Returns void
Inherited from BasicUserAccountSubscriber.assertIsSubscribed
- Defined in sdk/src/accounts/basicUserAccountSubscriber.ts:46

doesAccountExist

doesAccountExist(): boolean
Returns boolean
Inherited from BasicUserAccountSubscriber.doesAccountExist
- Defined in sdk/src/accounts/basicUserAccountSubscriber.ts:40

fetch

fetch(): Promise<void>
Returns Promise<void>
Implementation of UserAccountSubscriber.fetch

Overrides BasicUserAccountSubscriber.fetch
- Defined in sdk/src/accounts/oneShotUserAccountSubscriber.ts:50

fetchIfUnloaded

fetchIfUnloaded(): Promise<void>
Returns Promise<void>
- Defined in sdk/src/accounts/oneShotUserAccountSubscriber.ts:44

getUserAccountAndSlot

getUserAccountAndSlot(): DataAndSlot<UserAccount>
Returns DataAndSlot<UserAccount>
Implementation of UserAccountSubscriber.getUserAccountAndSlot

Inherited from BasicUserAccountSubscriber.getUserAccountAndSlot
- Defined in sdk/src/accounts/basicUserAccountSubscriber.ts:48

subscribe(userAccount?: UserAccount): Promise<boolean>
Parameters
- Optional userAccount: UserAccount
Returns Promise<boolean>
Implementation of UserAccountSubscriber.subscribe

Overrides BasicUserAccountSubscriber.subscribe
- Defined in sdk/src/accounts/oneShotUserAccountSubscriber.ts:31

unsubscribe

unsubscribe(): Promise<void>
Returns Promise<void>
Implementation of UserAccountSubscriber.unsubscribe

Inherited from BasicUserAccountSubscriber.unsubscribe
- Defined in sdk/src/accounts/basicUserAccountSubscriber.ts:44

updateData

updateData(userAccount: UserAccount, slot: number): void
Parameters
- userAccount: UserAccount
- slot: number
Returns void
Implementation of UserAccountSubscriber.updateData

Inherited from BasicUserAccountSubscriber.updateData
- Defined in sdk/src/accounts/basicUserAccountSubscriber.ts:52

Class OneShotUserAccountSubscriber

Hierarchy

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

program: Program<Idl>

userAccountPublicKey: PublicKey

Optional data: UserAccount

Optional slot: number

Optional commitment: Commitment

Returns OneShotUserAccountSubscriber

Properties

Optional callbackId

commitment

Optional errorCallbackId

eventEmitter

isSubscribed

program

user

userAccountPublicKey

Methods

addToAccountLoader

Returns Promise<void>

assertIsSubscribed

Returns void

doesAccountExist

Returns boolean

fetch

Returns Promise<void>

fetchIfUnloaded

Returns Promise<void>

getUserAccountAndSlot

Returns DataAndSlot<UserAccount>

subscribe

Parameters

Optional userAccount: UserAccount

Returns Promise<boolean>

unsubscribe

Returns Promise<void>

updateData

Parameters

userAccount: UserAccount

slot: number

Returns void

Settings

Member Visibility

Theme

`Optional` data: UserAccount

`Optional` slot: number

`Optional` commitment: Commitment

`Optional` callbackId

`Optional` errorCallbackId

`Optional` userAccount: UserAccount