added docs to prunned_utreexo module and its submodules #401
+61
−3
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
Davidson-Souza
added
documentation
JoseSK999
suggested changes
Mar 7, 2025
| //! The chain state contains both the blocks and blockchain validation logic | ||
| //! | ||
| //! This module provides the implementation of Bitcoin's consensus rules and chain validation, | ||
| //! enabling verification of transactions and blocks. It maintains: |
There was a problem hiding this comment.
Technically this is not correct for the module, the consensus rules for validating transactions and blocks are not here but in consensus.rs.
You should explain here that this module is centered around the ChainState type, which implements BlockchainInterface and UpdatableChainstate, meaning it is a Chain backend for the node, which:
- Keeps track of the chain state, and uses a
ChainStorefor persisted storage - Updates such state with the help of the consensus functions implemented in
consensus.rs - Can interface with other components, and provide data about the current view of the chain
There was a problem hiding this comment.
Thanks for pointing this out!
lucad70
force-pushed
the
376-floresta-chain
branch
from
06ceb78 to
6ba5ba3
Compare
JoseSK999
suggested changes
Mar 8, 2025
lucad70
force-pushed
the
376-floresta-chain
branch
from
6ba5ba3 to
87dfa8a
Compare
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.
What is the purpose of this pull request?
Which crates are being modified?
Description
I added missing docs to Floresta Chain crate, prunned utreexo module and its submodules to help on #376 .
Notes to the reviewers
I avoided adding the docs for the structs inside each submodule to make it easier for review.
Checklist
just lintcargo testImages of differences bellow