Class EventSubscriber

Hierarchy

EventSubscriber

Constructors

constructor

new EventSubscriber(connection: Connection, program: Program<Idl>, options?: EventSubscriptionOptions): EventSubscriber
Parameters
- connection: Connection
- program: Program<Idl>
- options: EventSubscriptionOptions = DefaultEventSubscriptionOptions
Returns EventSubscriber
- Defined in sdk/src/events/eventSubscriber.ts:41

Properties

`Private` address

address: PublicKey

`Private` awaitTxPromises

awaitTxPromises: Map<string, Promise<void>> = ...

`Private` awaitTxResolver

awaitTxResolver: Map<string, (() => void)> = ...

`Private` connection

connection: Connection

`Private` currentProviderType

currentProviderType: LogProviderType

eventEmitter

eventEmitter: StrictEventEmitter<EventEmitter<DefaultEventMap>, EventSubscriberEvents, EventSubscriberEvents, "addEventListener" | "removeEventListener", "on" | "addListener" | "removeListener" | "once" | "emit">

`Private` eventListMap

eventListMap: Map<keyof EventMap, EventList<keyof EventMap>>

`Private` lastSeenBlockTime

lastSeenBlockTime: number

`Private` lastSeenSlot

lastSeenSlot: number

lastSeenTxSig

lastSeenTxSig: string

`Private` logProvider

logProvider: LogProvider

`Private` options

options: EventSubscriptionOptions = DefaultEventSubscriptionOptions

`Private` program

program: Program<Idl>

`Private` txEventCache

txEventCache: TxEventCache

Methods

awaitTx

awaitTx(txSig: string): Promise<void>
Parameters
- txSig: string
Returns Promise<void>
- Defined in sdk/src/events/eventSubscriber.ts:327

fetchPreviousTx

fetchPreviousTx(fetchMax?: boolean): Promise<void>
Parameters
- Optional fetchMax: boolean
Returns Promise<void>
- Defined in sdk/src/events/eventSubscriber.ts:261

getEventList

getEventList<Type>(eventType: Type): EventList<Type>
Type Parameters
- Type extends keyof EventMap
Parameters
- eventType: Type
Returns EventList<Type>
- Defined in sdk/src/events/eventSubscriber.ts:343

getEventsArray

getEventsArray<Type>(eventType: Type): EventMap[Type][]
This requires the EventList be cast to an array, which requires reallocation of memory. Would bias to using getEventList over getEvents
Type Parameters
- Type extends keyof EventMap
Parameters
- eventType: Type
Returns EventMap[Type][]
- Defined in sdk/src/events/eventSubscriber.ts:355

getEventsByTx

getEventsByTx(txSig: string): WrappedEvents
Parameters
- txSig: string
Returns WrappedEvents
- Defined in sdk/src/events/eventSubscriber.ts:361

`Private` handleTxLogs

handleTxLogs(txSig: string, slot: number, logs: string[], mostRecentBlockTime: number, fromEventsServer?: boolean, txSigIndex?: number): void
Parameters
- txSig: string
- slot: number
- logs: string[]
- mostRecentBlockTime: number
- fromEventsServer: boolean = false
- txSigIndex: number = undefined
Returns void
- Defined in sdk/src/events/eventSubscriber.ts:212

`Private` initializeLogProvider

initializeLogProvider(subscribe?: boolean): void
Parameters
- subscribe: boolean = false
Returns void
- Defined in sdk/src/events/eventSubscriber.ts:56

`Private` parseEventsFromLogs

parseEventsFromLogs(txSig: string, slot: number, logs: string[], txSigIndex: number): WrappedEvents
Parameters
- txSig: string
- slot: number
- logs: string[]
- txSigIndex: number
Returns WrappedEvents
- Defined in sdk/src/events/eventSubscriber.ts:301

`Private` populateInitialEventListMap

populateInitialEventListMap(): void
Returns void
- Defined in sdk/src/events/eventSubscriber.ts:114

subscribe

subscribe(): Promise<boolean>
Returns Promise<boolean>
- Defined in sdk/src/events/eventSubscriber.ts:155

unsubscribe

unsubscribe(): Promise<boolean>
Returns Promise<boolean>
- Defined in sdk/src/events/eventSubscriber.ts:292

`Private` updateFallbackProviderType

updateFallbackProviderType(reconnectAttempts: number, maxReconnectAttempts: number): void
Implements fallback logic for reconnecting to LogProvider. Currently terminates at polling, could be improved to try the original type again after some cooldown.
Parameters
- reconnectAttempts: number
- maxReconnectAttempts: number
Returns void
- Defined in sdk/src/events/eventSubscriber.ts:132

Generated using TypeDoc