SolanaChainEventsBrowser

Defined in: atomiq-chain-solana/src/solana/events/SolanaChainEventsBrowser.ts:56

Solana on-chain event handler for front-end systems without access to fs, uses pure WS to subscribe, might lose out on some events if the network is unreliable, front-end systems should take this into consideration and not rely purely on events

Extended by

• SolanaChainEvents

Implements

• ChainEvents<SolanaSwapData, SolanaEventListenerState>

Constructors

Constructor

new SolanaChainEventsBrowser(
   connection, 
   solanaSwapContract, 
   logFetchLimit?): SolanaChainEventsBrowser;

Defined in: atomiq-chain-solana/src/solana/events/SolanaChainEventsBrowser.ts:86

Parameters

Parameter	Type
connection	Connection
solanaSwapContract	SolanaSwapProgram
logFetchLimit?	number

Returns

SolanaChainEventsBrowser

Methods

init()

init(noAutomaticPoll?): Promise<void>;

Defined in: atomiq-chain-solana/src/solana/events/SolanaChainEventsBrowser.ts:418

Initializes the chains event listener, by default this initiates a websocket events subscription or HTTP polling for new events.

Parameters

Parameter	Type	Description
noAutomaticPoll?	boolean	When this flag is passed the listener doesn't initiate the websocket events subscription or HTTP polling, instead it relies on the implementor calling the ChainEvents.poll to fetch new events

Returns

Promise<void>

Implementation of

ChainEvents.init

---

poll()

poll(lastSignature?): Promise<SolanaEventListenerState>;

Defined in: atomiq-chain-solana/src/solana/events/SolanaChainEventsBrowser.ts:404

Triggers a single poll on the events instance, usually ran automatically, but should be called manually when initiated with noAutomaticPoll=true

Parameters

Parameter	Type	Description
lastSignature?	SolanaEventListenerState	The current state of the chain events

Returns

Promise<SolanaEventListenerState>

The new state that should be saved, persisted and passed to the subsequent poll() call

Implementation of

ChainEvents.poll

---

registerListener()

registerListener(cbk): void;

Defined in: atomiq-chain-solana/src/solana/events/SolanaChainEventsBrowser.ts:437

Registers a new listener to listen for on-chain events

Parameters

Parameter	Type	Description
cbk	EventListener<SolanaSwapData>

Returns

void

Implementation of

ChainEvents.registerListener

---

stop()

stop(): Promise<void>;

Defined in: atomiq-chain-solana/src/solana/events/SolanaChainEventsBrowser.ts:427

Stops the event listener's polling and websocket subscription

Returns

Promise<void>

Implementation of

ChainEvents.stop

---

unregisterListener()

unregisterListener(cbk): boolean;

Defined in: atomiq-chain-solana/src/solana/events/SolanaChainEventsBrowser.ts:444

Unregisters a previously registered events listener, returning true if success, false if failed

Parameters

Parameter	Type	Description
cbk	EventListener<SolanaSwapData>

Returns

boolean

Implementation of

ChainEvents.unregisterListener