added docs to prunned_utreexo module and its submodules #401
+63
−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
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
2 times, most recently
from
87dfa8a to
c82587b
Compare
|
Thanks for the throughout review @JoseSK999 ! I believe I have resolved every request, if there is any other just let me know and I'll fix it right away. |
|
The comment on the |
|
My bad. I will pay more attention in the next PRs and I appreciate your patience. |
lucad70
force-pushed
the
376-floresta-chain
branch
from
c82587b to
d8653de
Compare
|
No problem! The CI error is unrelated, could you push again to trigger a new CI run? |
lucad70
force-pushed
the
376-floresta-chain
branch
from
d8653de to
11bc843
Compare
JoseSK999
reviewed
Mar 10, 2025
Comment on lines
+1
to
+9
| //! The pruned utreexo module is where the full blockchain logic is handled (validation, state tracking and interfacing). It uses a pruned chain, which does not keep the historical blocks. | ||
| //! | ||
| //! This module contains the main traits and types for interacting with an utreexo-enabled blockchain. | ||
| //! It also provides some utilities for inspecting the utxo set and managing chain state. | ||
| //! | ||
| //! The key components are: | ||
| //! - [BlockchainInterface]: The main interface for interacting with the blockchain | ||
| //! - [UpdatableChainstate]: Handles updates to the chain state including blocks and transactions | ||
| //! - [ChainStore]: It defines persistence and retrieval of blockchain data |
There was a problem hiding this comment.
A final nit, can you do something like this:
//! The pruned utreexo module handles the full blockchain logic: validation, state tracking and
//! interfacing. This blockchain backend does not store the historical blocks, it's pruned.
//!
//! This module file defines the main traits for an utreexo-enabled chain backend:
//!
//! - [BlockchainInterface]: The main interface for interacting with the backend
//! - [UpdatableChainstate]: Trait defining methods for updating the chain state
//! - [ChainStore]: Trait for persisting and retrieving blockchain data (headers, block hashes,
//! the best chain data, and the accumulator)
Davidson-Souza
requested changes
Mar 10, 2025
| @@ -21,6 +21,9 @@ pub use pruned_utreexo::error::*; | |||
| pub use pruned_utreexo::udata::*; | |||
| pub use pruned_utreexo::Notification; | |||
|
|
|||
| /// Simple enum representing the network type. | |||
| /// | |||
| /// Possible values are Bitcoin, Testnet, Regtest, and Signet. | |||
| #[derive(Debug, Clone, Copy, PartialEq, Eq)] | |||
There was a problem hiding this comment.
As per the contributing.md:
If you need an attribute, use the attribute before the docstring
Please swap the attributes (this #[derive]) with the comment
| //! | ||
| //! Key types: | ||
| //! - [ChainState]: The high-level chain backend | ||
| //! - [ChainStateInner]: Inner `ChainState` type that is guarded by a lock |
There was a problem hiding this comment.
This struct doesn't leaks from our API. I'm not sure it should be here?
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