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.

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

Improve engine and state root task docs #14271

Closed
Tracked by #11169
mattsse opened this issue Feb 6, 2025 · 0 comments · Fixed by #14400
Closed
Tracked by #11169

Improve engine and state root task docs #14271

mattsse opened this issue Feb 6, 2025 · 0 comments · Fixed by #14400
Assignees
Labels
A-engine Related to the engine implementation C-docs An addition or correction to our documentation C-perf A change motivated by improving speed, memory usage or disk footprint
Milestone

Comments

@mattsse
Copy link
Collaborator

mattsse commented Feb 6, 2025

Describe the change

the section after

let (state_root_handle, state_root_task_config, state_root_sender, state_hook) =

is lacking useful docs/notes and is not trivial to follow for someone unfamiliar

especially

fn run(mut self, sparse_trie_tx: Sender<SparseTrieUpdate>) -> StateRootResult {

which currently doesn't have any docs

TODO

  • document all parties involved in StateRootTask::run and how message passing works
  • annotate block insertion steps with docs

Additional context

No response

@mattsse mattsse added the C-docs An addition or correction to our documentation label Feb 6, 2025
@mattsse mattsse added the C-perf A change motivated by improving speed, memory usage or disk footprint label Feb 6, 2025
@mattsse mattsse added the A-engine Related to the engine implementation label Feb 6, 2025
@jenpaff jenpaff added this to the Release 1.2.0 milestone Feb 7, 2025
@shekhirin shekhirin changed the title Improve engine and parallel state root docs Improve engine and state root task docs Feb 7, 2025
@github-project-automation github-project-automation bot moved this from Todo to Done in Reth Tracker Feb 12, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
A-engine Related to the engine implementation C-docs An addition or correction to our documentation C-perf A change motivated by improving speed, memory usage or disk footprint
Projects
Status: Done
Development

Successfully merging a pull request may close this issue.

3 participants