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

docs: Complete missing stage descriptions in stages.md #14415

Merged
merged 1 commit into from
Feb 11, 2025

Conversation

VolodymyrBg
Copy link
Contributor

Description:
This PR completes the documentation for all pipeline stages in docs/crates/stages.md that were previously marked as TODO. The changes include:

  • Added detailed description for MerkleUnwindStage

    • Explains its role in handling chain reorganizations
    • Describes how it maintains state trie consistency
    • Documents its relationship with MerkleExecuteStage
  • Added comprehensive documentation for AccountHashingStage and StorageHashingStage

    • Explains their roles in state trie construction
    • Details how they handle account and storage hashing
    • Describes their importance for state verification
  • Documented MerkleExecuteStage

    • Explains its role in Merkle Patricia trie management
    • Details how it processes state changes
    • Describes state root maintenance
  • Added documentation for indexing stages:

    • TransactionLookupStage: Explains transaction indexing and lookup
    • IndexStorageHistoryStage: Documents storage state history tracking
    • IndexAccountHistoryStage: Details account state history indexing
  • Added documentation for FinishStage

    • Describes cleanup and verification tasks
    • Explains its role in maintaining node consistency
    • Documents metrics and status updates

These changes make the stages documentation complete and help developers better understand the pipeline architecture of Reth.

Related issue: #TODO (if there is one)

@VolodymyrBg VolodymyrBg requested a review from gakonst as a code owner February 11, 2025 16:01
Copy link
Collaborator

@mattsse mattsse left a comment

Choose a reason for hiding this comment

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

ty

@mattsse mattsse merged commit 3f680fd into paradigmxyz:main Feb 11, 2025
45 checks passed
18aaddy pushed a commit to 18aaddy/reth that referenced this pull request Feb 12, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants