EVMChainEvents

Defined in: atomiq-chain-evm/src/evm/events/EVMChainEvents.ts:14

Backend event listener with persisted polling cursor stored on filesystem.

Extends

• EVMChainEventsBrowser

Constructors

Constructor

new EVMChainEvents(
   directory, 
   chainInterface, 
   evmSwapContract, 
   evmSpvVaultContract, 
   pollIntervalSeconds?): EVMChainEvents;

Defined in: atomiq-chain-evm/src/evm/events/EVMChainEvents.ts:19

Parameters

Parameter	Type
directory	string
chainInterface	EVMChainInterface
evmSwapContract	EVMSwapContract
evmSpvVaultContract	EVMSpvVaultContract<any>
pollIntervalSeconds?	number

Returns

EVMChainEvents

Overrides

EVMChainEventsBrowser.constructor

Methods

init()

init(noAutomaticPoll?): Promise<void>;

Defined in: atomiq-chain-evm/src/evm/events/EVMChainEvents.ts:88

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

EVMChainEventsBrowser.init

---

poll()

poll(lastState?): Promise<object[]>;

Defined in: atomiq-chain-evm/src/evm/events/EVMChainEventsBrowser.ts:433

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
lastState?	object[]	The current state of the chain events

Returns

Promise<object[]>

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

Inherited from

EVMChainEventsBrowser.poll

---

registerListener()

registerListener(cbk): void;

Defined in: atomiq-chain-evm/src/evm/events/EVMChainEventsBrowser.ts:646

Registers a new listener to listen for on-chain events

Parameters

Parameter	Type	Description
cbk	EventListener<EVMSwapData>

Returns

void

Inherited from

EVMChainEventsBrowser.registerListener

---

stop()

stop(): Promise<void>;

Defined in: atomiq-chain-evm/src/evm/events/EVMChainEventsBrowser.ts:631

Stops the event listener's polling and websocket subscription

Returns

Promise<void>

Inherited from

EVMChainEventsBrowser.stop

---

unregisterListener()

unregisterListener(cbk): boolean;

Defined in: atomiq-chain-evm/src/evm/events/EVMChainEventsBrowser.ts:653

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

Parameters

Parameter	Type	Description
cbk	EventListener<EVMSwapData>

Returns

boolean

Inherited from

EVMChainEventsBrowser.unregisterListener