StarknetChainEventsBrowser

Defined in: atomiq-chain-starknet/src/starknet/events/StarknetChainEventsBrowser.ts:66

Starknet on-chain event handler for front-end systems without access to fs, uses WS or long-polling 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

• StarknetChainEvents

Implements

• ChainEvents<StarknetSwapData, StarknetEventListenerState[]>

Constructors

Constructor

new StarknetChainEventsBrowser(
   chainInterface, 
   starknetSwapContract, 
   starknetSpvVaultContract, 
   pollIntervalSeconds): StarknetChainEventsBrowser;

Defined in: atomiq-chain-starknet/src/starknet/events/StarknetChainEventsBrowser.ts:122

Parameters

Parameter	Type	Default value
chainInterface	StarknetChainInterface	undefined
starknetSwapContract	StarknetSwapContract	undefined
starknetSpvVaultContract	StarknetSpvVaultContract	undefined
pollIntervalSeconds	number	5

Returns

StarknetChainEventsBrowser

Methods

init()

init(noAutomaticPoll?): Promise<void>;

Defined in: atomiq-chain-starknet/src/starknet/events/StarknetChainEventsBrowser.ts:675

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(lastState?): Promise<StarknetEventListenerState[]>;

Defined in: atomiq-chain-starknet/src/starknet/events/StarknetChainEventsBrowser.ts:537

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

Returns

Promise<StarknetEventListenerState[]>

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-starknet/src/starknet/events/StarknetChainEventsBrowser.ts:704

Registers a new listener to listen for on-chain events

Parameters

Parameter	Type	Description
cbk	EventListener<StarknetSwapData>

Returns

void

Implementation of

ChainEvents.registerListener

---

stop()

stop(): Promise<void>;

Defined in: atomiq-chain-starknet/src/starknet/events/StarknetChainEventsBrowser.ts:691

Stops all event subscriptions and timers

Returns

Promise<void>

Implementation of

ChainEvents.stop

---

unregisterListener()

unregisterListener(cbk): boolean;

Defined in: atomiq-chain-starknet/src/starknet/events/StarknetChainEventsBrowser.ts:711

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

Parameters

Parameter	Type	Description
cbk	EventListener<StarknetSwapData>

Returns

boolean

Implementation of

ChainEvents.unregisterListener