feat: Add 'Get Latest X Events and Switch to Live Streaming' Method #133
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
This reverts commit 528bf86.
0xNeshi
commented
Oct 28, 2025
Comment on lines
-7
to
+8
| "examples/sync_scanning" | ||
| "examples/sync_from_latest_scanning", | ||
| "examples/sync_from_block_scanning", |
0xNeshi
commented
Oct 28, 2025
|
|
||
| See integration tests under `tests/live_mode`, `tests/historic_mode`, and `tests/historic_to_live` for concrete examples. | ||
|
|
||
| ### Scanning Latest Events |
Collaborator
Author
There was a problem hiding this comment.
Moved to the appropriate builder fn's doc comment
0xNeshi
commented
Oct 28, 2025
Comment on lines
+388
to
-399
| let get_start_block = async || -> Result<BlockNumber, ScannerError> { | ||
| let block = match start_height { | ||
| BlockNumberOrTag::Number(num) => num, | ||
| block_tag => provider | ||
| .get_block_by_number(block_tag) | ||
| .await? | ||
| .ok_or_else(|| ScannerError::BlockNotFound(block_tag))? | ||
| .header() | ||
| .number(), | ||
| }; | ||
| Ok(block) | ||
| }; | ||
|
|
||
| let get_latest_block = async || -> Result<BlockNumber, ScannerError> { | ||
| let block = provider | ||
| .get_block_by_number(BlockNumberOrTag::Latest) | ||
| .await? | ||
| .ok_or_else(|| ScannerError::BlockNotFound(BlockNumberOrTag::Latest))? | ||
| .header() | ||
| .number(); | ||
| Ok(block) | ||
| }; | ||
|
|
||
| // Step 1: | ||
| // Fetches the starting block and end block for historical sync in parallel | ||
| let (start_block, latest_block) = tokio::try_join!( | ||
| self.provider.get_block_by_number(start_height), | ||
| self.provider.get_block_by_number(BlockNumberOrTag::Latest) | ||
| )?; | ||
| let (start_block, latest_block) = tokio::try_join!(get_start_block(), get_latest_block())?; | ||
|
|
||
| let start_block_num = | ||
| start_block.ok_or_else(|| ScannerError::BlockNotFound(start_height))?.header().number(); | ||
| let latest_block = latest_block | ||
| .ok_or_else(|| ScannerError::BlockNotFound(BlockNumberOrTag::Latest))? | ||
| .header() | ||
| .number(); |
Collaborator
Author
There was a problem hiding this comment.
One of the big changes in this PR is the introduction of support for starting the stream from a future block, which is needed for implementing the PR's main feature (sync from latest). For more info, see How it works doc section.
Because the start_block logic changed a bit to accommodate this new requirement, I refactored the implementation to make it a bit easier to reason about.
Open to suggestions though
0xNeshi
commented
Oct 28, 2025
Comment on lines
-810
to
+827
| pub async fn stream_historical<N: Into<BlockNumberOrTag>>( | ||
| pub async fn stream_historical( | ||
| &self, | ||
| start_height: N, | ||
| end_height: N, | ||
| start_height: impl Into<BlockNumberOrTag>, | ||
| end_height: impl Into<BlockNumberOrTag>, |
Collaborator
Author
There was a problem hiding this comment.
Separating param types enables previously impossible invocations, like:
stream_historical(0, BlockNumberOrTag::Latest)
0xNeshi
commented
Oct 28, 2025
Comment on lines
24
to
29
| pub async fn handle_stream<N: Network>( | ||
| mut stream: ReceiverStream<BlockRangeMessage>, | ||
| // Note: assumes it is running in a separate tokio task, so as to be non-blocking. | ||
| pub async fn handle_stream<N: Network, S: Stream<Item = BlockRangeMessage> + Unpin>( | ||
| mut stream: S, |
Collaborator
Author
There was a problem hiding this comment.
Enables passing both ReceiverStream and Chain<ReceiverStream<...
0xNeshi
commented
Oct 28, 2025
| }, | ||
| }; | ||
|
|
||
| pub struct SyncFromBlockEventScannerBuilder { |
Collaborator
Author
There was a problem hiding this comment.
Except the builder name, nothing changed, just moved to the new file
LeoPatOZ
previously approved these changes
Oct 29, 2025
Co-authored-by: Leo <leonard.paturel@openzeppelin.com>
0xNeshi
commented
Oct 29, 2025
LeoPatOZ
approved these changes
Oct 29, 2025
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
Resolves #113
Resolves #72