Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

docs(tree): state root task #14400

Merged
merged 26 commits into from
Feb 12, 2025
Merged

docs(tree): state root task #14400

merged 26 commits into from
Feb 12, 2025
+403 −0

Conversation

shekhirin
Copy link
Collaborator

@shekhirin shekhirin commented Feb 11, 2025 •
edited by DaniPopes
Loading

Closes #14271

Rendered

@shekhirin shekhirin force-pushed the alexey/state-root-task-diagrams branch from 54c638e to 78fc034 Compare February 11, 2025 11:40
@shekhirin shekhirin added C-docs An addition or correction to our documentation A-engine Related to the engine implementation labels Feb 11, 2025
@shekhirin shekhirin marked this pull request as ready for review February 11, 2025 17:24
@shekhirin shekhirin changed the title docs(tree): mermaid diagrams for state root task docs(tree): state root task Feb 11, 2025
@shekhirin shekhirin requested a review from jenpaff February 11, 2025 18:04
Rjected
Rjected reviewed Feb 11, 2025
View reviewed changes
Copy link
Member

@Rjected Rjected left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

so far just read the text, was easy to follow

shekhirin and others added 4 commits February 11, 2025 19:10
@shekhirin @Rjected
Update root.md
ed47538 
Co-authored-by: Dan Cline <[email protected]>
@shekhirin @Rjected
Update root.md
db553b0 
Co-authored-by: Dan Cline <[email protected]>
@shekhirin @Rjected
Update root.md
62309be 
Co-authored-by: Dan Cline <[email protected]>
@shekhirin @Rjected
Update root.md
0699a60 
Co-authored-by: Dan Cline <[email protected]>
jenpaff
jenpaff reviewed Feb 12, 2025
View reviewed changes
crates/engine/tree/docs/root.md

It has the following responsibilities:
1. On empty proof targets, immediately send `StateRootMessage::EmptyProof` to the [State Root Task](#state-root-task).
2. If the number of maximum concurrent proof calculations is reached, push the proof request to the pending queue.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

what do we base the max num of concurrent proofs on ?

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

clarified how we calculate it

DaniPopes
DaniPopes reviewed Feb 12, 2025
View reviewed changes
@shekhirin shekhirin force-pushed the alexey/state-root-task-diagrams branch from a7207bd to fbfeb2b Compare February 12, 2025 10:25
jenpaff
jenpaff approved these changes Feb 12, 2025
View reviewed changes
Copy link
Collaborator

@jenpaff jenpaff left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

great work on the docs !

@shekhirin shekhirin force-pushed the alexey/state-root-task-diagrams branch from 2d6d3af to 787a88c Compare February 12, 2025 12:14
@shekhirin shekhirin enabled auto-merge February 12, 2025 12:15
@shekhirin shekhirin added this pull request to the merge queue Feb 12, 2025
Merged via the queue into main with commit ac7b595 Feb 12, 2025
44 checks passed
@shekhirin shekhirin deleted the alexey/state-root-task-diagrams branch February 12, 2025 12:42
frankudoags pushed a commit to frankudoags/reth that referenced this pull request Feb 13, 2025
@shekhirin @Rjected @frankudoags
docs(tree): state root task (paradigmxyz#14400)
4e2dddb 
Co-authored-by: Dan Cline <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@Rjected Rjected Rjected left review comments

@DaniPopes DaniPopes DaniPopes left review comments

@jenpaff jenpaff jenpaff approved these changes

@rkrasiuk rkrasiuk Awaiting requested review from rkrasiuk rkrasiuk is a code owner

@mattsse mattsse Awaiting requested review from mattsse mattsse is a code owner

@fgimenez fgimenez Awaiting requested review from fgimenez fgimenez is a code owner

Assignees
No one assigned
Labels
A-engine Related to the engine implementation C-docs An addition or correction to our documentation
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Improve engine and state root task docs
4 participants
@shekhirin @jenpaff @Rjected @DaniPopes