feat: implement event listeners#155
Open
FarajiOranj wants to merge 1 commit into
Open
Conversation
Add polling-based event listeners that fire callbacks as new contract events, blocks, or signer changes are observed: - `client.onEvent` / `contract.onEvent` fire with new logs as matching contract events are emitted (future-only by default; pass `fromBlock` for history, and `contract.onEvent` applies `epochBlock`). - `client.onBlock` fires with the latest block number as blocks are created. - `client.onSignerChange` fires when the signer changes. Each listener polls the adapter directly (bypassing the client cache) on a configurable interval via a shared `createPoller` utility, and returns a function that stops it. A guard prevents callbacks firing after unsubscribe.
🦋 Changeset detectedLatest commit: fbd5956 The changes in this PR will be included in the next version bump. This PR includes changesets to release 5 packages
Not sure what this means? Click here to learn what changesets are. Click here if you're a maintainer who wants to add another changeset to this PR |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Closes #121.
Adds event listeners: callbacks that fire as new contract events, blocks, or
signer changes are observed. Each listener polls the underlying adapter on an
interval (as suggested in the issue) and returns a function that stops it.
API
fromBlockto also receivehistorical events on the first poll.
contract.onEventapplies the contract'sepochBlockthe same waygetEventsdoes.pollingIntervalandonErrorare configurable per listener; the intervaldefaults to the adapter's
pollingInterval, then4000ms.Client/createDriftwiring were needed.Implementation notes
getEvents),since the cache is keyed and would return stale data to a live listener.
setTimeout(createPoller) so polls never overlap,and a guard prevents any callback from firing after
unsubscribe(), evenmid-poll.
Tests
New
createPoller.test.tsandeventListeners.test.ts(block/event/signerlisteners,
fromBlockhistory, in-flight-unsubscribe, throwing-onErrorresilience) plus a
Contract.onEvent+epochBlocktest. Also updated theREADME and added a changeset.
Known limitation / follow-ups
onEventpolls forward by block number and does not handle chainreorganizations, so events in blocks re-mined after a reorg may be missed (as
scoped by the issue's "initial implementation"). This is documented on the
methods. A reorg-aware mode (confirmations / re-scan window with dedup) would
make a good follow-up, as would wallet-native
signer changedevents(e.g.
accountsChanged) instead of polling.