feat: Fully update consensus module with documentation and README #7
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
- Enhanced `src/lib.rs` with comprehensive in-code documentation using Rust doc comments (`///`) for all public items, including traits, structs, and methods. - Added doctests to `src/lib.rs` for `ConsensusError`, `ConsensusEngine`, `Block`, `PosygDcsEngine`, and `Network`, providing executable examples that verify behavior and serve as documentation. - Fixed integration test in `tests/integration_test.rs` by increasing rounds to 10, ensuring honest validators (`v1`, `v2`) consistently surpass the malicious validator (`v3`) in synergy score, addressing previous test failures. - Added public getter and increment methods to `PosygDcsEngine` (`is_malicious`, `stake`, `increment_proposed_blocks`, `increment_accepted_blocks`) to resolve private field access errors in tests. - Reworked `Network::run_consensus_round` to avoid borrow checker conflicts by scoping mutable borrows appropriately. - Removed unused `rand::seq::SliceRandom` import from `src/lib.rs`. - Introduced `README.md` in the `consensus` directory with professional documentation, including installation instructions, usage examples, and contribution guidelines. - Ensured all changes align with the PoSyg + DCS consensus mechanism as per the PeoChain white paper, maintaining weighted random proposer selection and dynamic scoring.
|
No applications have been configured for previews targeting branch: main. To do so go to restack console and configure your applications for previews. |
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.
src/lib.rswith comprehensive in-code documentation using Rust doc comments (///) for all public items, including traits, structs, and methods.src/lib.rsforConsensusError,ConsensusEngine,Block,PosygDcsEngine, andNetwork, providing executable examples that verify behavior and serve as documentation.tests/integration_test.rsby increasing rounds to 10, ensuring honest validators (v1,v2) consistently surpass the malicious validator (v3) in synergy score, addressing previous test failures.PosygDcsEngine(is_malicious,stake,increment_proposed_blocks,increment_accepted_blocks) to resolve private field access errors in tests.Network::run_consensus_roundto avoid borrow checker conflicts by scoping mutable borrows appropriately.rand::seq::SliceRandomimport fromsrc/lib.rs.README.mdin theconsensusdirectory with professional documentation, including installation instructions, usage examples, and contribution guidelines.