Updated ReadMe with docs #30
Merged
Conversation
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
fix example
0xNeshi
reviewed
Sep 17, 2025
Collaborator
0xNeshi
left a comment
0xNeshi
left a comment
There was a problem hiding this comment.
Excellent work on the README!
First review iteration, left some small comments
| The library exposes two primary layers: | ||
|
|
||
| - `EventScannerBuilder` / `EventScanner` – the main module the application will interact with. | ||
| - `BlockScanner` – lower-level component that streams block ranges, handles reorg, batching, and provider subscriptions. This is exposed to the user but has many edge cases which will be documented in the future. For now interact with this via the `EventScanner` |
Collaborator
There was a problem hiding this comment.
We're not really scanning blocks, but block ranges. I'm thinking that maybe BlockRangeScanner is a better name?
That way this becomes a sort of a primitive that we can use to also potentially implement an actual BlockScanner in the future.
Wdyt?
Collaborator
Author
There was a problem hiding this comment.
I agree - we should change it both here and in the code. Happy to do it here unless you want to take over
0xNeshi
reviewed
Sep 17, 2025
0xNeshi
reviewed
Sep 17, 2025
d-carmo
requested changes
Sep 18, 2025
0xNeshi
reviewed
Sep 18, 2025
Co-authored-by: Nenad <[email protected]>
0xNeshi
approved these changes
Sep 18, 2025
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.
No description provided.