SolanaChainEvents

Defined in: atomiq-chain-solana/src/solana/events/SolanaChainEvents.ts:13

Event handler for backend Node.js systems with access to fs, uses HTTP polling in combination with WS to not miss any events

Extends

• SolanaChainEventsBrowser

Constructors

Constructor

new SolanaChainEvents(
   directory, 
   connection, 
   solanaSwapProgram, 
   logFetchInterval?): SolanaChainEvents;

Defined in: atomiq-chain-solana/src/solana/events/SolanaChainEvents.ts:21

Parameters

Parameter	Type
directory	string
connection	Connection
solanaSwapProgram	SolanaSwapProgram
logFetchInterval?	number

Returns

SolanaChainEvents

Overrides

SolanaChainEventsBrowser.constructor

Methods

init()

init(noAutomaticPoll?): Promise<void>;

Defined in: atomiq-chain-solana/src/solana/events/SolanaChainEvents.ts:97

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>

Overrides

SolanaChainEventsBrowser.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

Inherited from

SolanaChainEventsBrowser.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

Inherited from

SolanaChainEventsBrowser.registerListener

---

stop()

stop(): Promise<void>;

Defined in: atomiq-chain-solana/src/solana/events/SolanaChainEvents.ts:110

Stops the event listener's polling and websocket subscription

Returns

Promise<void>

Overrides

SolanaChainEventsBrowser.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

Inherited from

SolanaChainEventsBrowser.unregisterListener