docs(book): tracking state in ExExes #8804
Merged
Conversation
This file contains 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
Co-authored-by: Dan Cline <[email protected]>
Co-authored-by: Dan Cline <[email protected]>
Co-authored-by: Oliver <[email protected]>
Co-authored-by: Oliver <[email protected]>
Co-authored-by: Oliver <[email protected]>
Co-authored-by: Oliver <[email protected]>
Co-authored-by: Oliver <[email protected]>
shekhirin
commented
Jun 14, 2024
Comment on lines
+97
to
+176
| ```rust,norun,noplayground,ignore | ||
| use std::{ | ||
| future::Future, | ||
| pin::Pin, | ||
| task::{ready, Context, Poll}, | ||
| }; | ||
|
|
||
| use reth::{api::FullNodeComponents, primitives::BlockNumber}; | ||
| use reth_exex::{ExExContext, ExExEvent}; | ||
| use reth_node_ethereum::EthereumNode; | ||
| use reth_tracing::tracing::info; | ||
|
|
||
| struct MyExEx<Node: FullNodeComponents> { | ||
| ctx: ExExContext<Node>, | ||
| /// First block that was committed since the start of the ExEx. | ||
| first_block: Option<BlockNumber>, | ||
| /// Total number of transactions committed. | ||
| transactions: u64, | ||
| } | ||
|
|
||
| impl<Node: FullNodeComponents> MyExEx<Node> { | ||
| fn new(ctx: ExExContext<Node>) -> Self { | ||
| Self { | ||
| ctx, | ||
| first_block: None, | ||
| transactions: 0, | ||
| } | ||
| } | ||
| } | ||
|
|
||
| impl<Node: FullNodeComponents> Future for MyExEx<Node> { | ||
| type Output = eyre::Result<()>; | ||
|
|
||
| fn poll(self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<Self::Output> { | ||
| let this = self.get_mut(); | ||
|
|
||
| while let Some(notification) = ready!(this.ctx.notifications.poll_recv(cx)) { | ||
| if let Some(reverted_chain) = notification.reverted_chain() { | ||
| this.transactions = this.transactions.saturating_sub( | ||
| reverted_chain | ||
| .blocks_iter() | ||
| .map(|b| b.body.len() as u64) | ||
| .sum(), | ||
| ); | ||
| } | ||
|
|
||
| if let Some(committed_chain) = notification.committed_chain() { | ||
| this.first_block.get_or_insert(committed_chain.first().number); | ||
|
|
||
| this.transactions += committed_chain | ||
| .blocks_iter() | ||
| .map(|b| b.body.len() as u64) | ||
| .sum::<u64>(); | ||
|
|
||
| this.ctx | ||
| .events | ||
| .send(ExExEvent::FinishedHeight(committed_chain.tip().number))?; | ||
| } | ||
|
|
||
| if let Some(first_block) = this.first_block { | ||
| info!(%first_block, transactions = %this.transactions, "Total number of transactions"); | ||
| } | ||
| } | ||
|
|
||
| Poll::Ready(Ok(())) | ||
| } | ||
| } | ||
|
|
||
| fn main() -> eyre::Result<()> { | ||
| reth::cli::Cli::parse_args().run(|builder, _| async move { | ||
| let handle = builder | ||
| .node(EthereumNode::default()) | ||
| .install_exex("my-exex", |ctx| async move { Ok(MyExEx::new(ctx)) }) | ||
| .launch() | ||
| .await?; | ||
|
|
||
| handle.wait_for_node_exit().await | ||
| }) | ||
| } | ||
| ``` |
There was a problem hiding this comment.
I don't like that we basically repeat the whole snippet twice. How can we do it better?
There was a problem hiding this comment.
There was a problem hiding this comment.
we don't fully repeat the snippet but rather change some parts of it. I meant how we can do better at showing what changed in the code without repeating it all over again, but we can solve it later.
shekhirin
added
C-docs
gakonst
approved these changes
Jun 16, 2024
| impl<Node: FullNodeComponents> Future for MyExEx<Node> { | ||
| type Output = eyre::Result<()>; | ||
|
|
||
| fn poll(self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<Self::Output> { |
There was a problem hiding this comment.
We should also explain how you'd call out to other functions?
Prob we'd save most of the logic in async functions on the exex that the future loop calls?
Comment on lines
+97
to
+176
| ```rust,norun,noplayground,ignore | ||
| use std::{ | ||
| future::Future, | ||
| pin::Pin, | ||
| task::{ready, Context, Poll}, | ||
| }; | ||
|
|
||
| use reth::{api::FullNodeComponents, primitives::BlockNumber}; | ||
| use reth_exex::{ExExContext, ExExEvent}; | ||
| use reth_node_ethereum::EthereumNode; | ||
| use reth_tracing::tracing::info; | ||
|
|
||
| struct MyExEx<Node: FullNodeComponents> { | ||
| ctx: ExExContext<Node>, | ||
| /// First block that was committed since the start of the ExEx. | ||
| first_block: Option<BlockNumber>, | ||
| /// Total number of transactions committed. | ||
| transactions: u64, | ||
| } | ||
|
|
||
| impl<Node: FullNodeComponents> MyExEx<Node> { | ||
| fn new(ctx: ExExContext<Node>) -> Self { | ||
| Self { | ||
| ctx, | ||
| first_block: None, | ||
| transactions: 0, | ||
| } | ||
| } | ||
| } | ||
|
|
||
| impl<Node: FullNodeComponents> Future for MyExEx<Node> { | ||
| type Output = eyre::Result<()>; | ||
|
|
||
| fn poll(self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<Self::Output> { | ||
| let this = self.get_mut(); | ||
|
|
||
| while let Some(notification) = ready!(this.ctx.notifications.poll_recv(cx)) { | ||
| if let Some(reverted_chain) = notification.reverted_chain() { | ||
| this.transactions = this.transactions.saturating_sub( | ||
| reverted_chain | ||
| .blocks_iter() | ||
| .map(|b| b.body.len() as u64) | ||
| .sum(), | ||
| ); | ||
| } | ||
|
|
||
| if let Some(committed_chain) = notification.committed_chain() { | ||
| this.first_block.get_or_insert(committed_chain.first().number); | ||
|
|
||
| this.transactions += committed_chain | ||
| .blocks_iter() | ||
| .map(|b| b.body.len() as u64) | ||
| .sum::<u64>(); | ||
|
|
||
| this.ctx | ||
| .events | ||
| .send(ExExEvent::FinishedHeight(committed_chain.tip().number))?; | ||
| } | ||
|
|
||
| if let Some(first_block) = this.first_block { | ||
| info!(%first_block, transactions = %this.transactions, "Total number of transactions"); | ||
| } | ||
| } | ||
|
|
||
| Poll::Ready(Ok(())) | ||
| } | ||
| } | ||
|
|
||
| fn main() -> eyre::Result<()> { | ||
| reth::cli::Cli::parse_args().run(|builder, _| async move { | ||
| let handle = builder | ||
| .node(EthereumNode::default()) | ||
| .install_exex("my-exex", |ctx| async move { Ok(MyExEx::new(ctx)) }) | ||
| .launch() | ||
| .await?; | ||
|
|
||
| handle.wait_for_node_exit().await | ||
| }) | ||
| } | ||
| ``` |
There was a problem hiding this comment.
onbjerg
approved these changes
Jun 17, 2024
rkrasiuk
approved these changes
Jun 17, 2024
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.