feat(abci): impl Hashable for ValidatorSet #121
Conversation
WalkthroughThe pull request introduces cryptographic functionality to the ABCI library by adding a new module for Merkle tree implementation and enhancing signature-related operations. These changes are conditionally compiled under the "crypto" feature flag, allowing for optional inclusion of these components. The new module provides methods for calculating Merkle root hashes, implements the Changes
Sequence DiagramsequenceDiagram
participant Client
participant MerkleModule
participant SignaturesModule
Client->>MerkleModule: Calculate Merkle Root Hash
MerkleModule-->>Client: Return Hash
Client->>SignaturesModule: Calculate Validator Set Hash
SignaturesModule-->>Client: Return Hash
Poem
📜 Recent review detailsConfiguration used: CodeRabbit UI 📒 Files selected for processing (1)
🚧 Files skipped from review as they are similar to previous changes (1)
⏰ Context from checks skipped due to timeout of 90000ms (2)
Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media? 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (2)
abci/src/merkle.rs (1)
39-50: Add detailed documentation for the get_split_point function.The bit manipulation logic in this function would benefit from more detailed documentation explaining:
- Why the specific bit operations are used
- How it ensures a balanced tree structure
- The mathematical reasoning behind the implementation
abci/src/signatures.rs (1)
426-473: LGTM! Well-implemented ValidatorSet hashing with comprehensive error handling.The implementation correctly:
- Extracts and validates the threshold public key
- Handles all public key types (Bls12381, Ed25519, Secp256k1)
- Uses merkle_hash to combine the key with quorum hash
However, consider consolidating the error handling:
let threshold_public_key_enum = self .threshold_public_key .as_ref() - .ok_or(Error::Canonical("missing threshold public key".to_string()))?; + .and_then(|key| key.sum.as_ref()) + .ok_or_else(|| Error::Canonical("missing threshold public key".to_string()))?; - let threshold_public_key = match &threshold_public_key_enum.sum { - Some(Bls12381(pk)) => pk, - Some(Ed25519(pk)) => pk, - Some(Secp256k1(pk)) => pk, - None => return Err(Error::Canonical("missing threshold public key".to_string())), + let threshold_public_key = match threshold_public_key_enum { + Bls12381(pk) => pk, + Ed25519(pk) => pk, + Secp256k1(pk) => pk, };
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (3)
abci/src/lib.rs(1 hunks)abci/src/merkle.rs(1 hunks)abci/src/signatures.rs(4 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (5)
- GitHub Check: test-all
- GitHub Check: docs
- GitHub Check: build (debian)
- GitHub Check: build (alpine)
- GitHub Check: tenderdash
🔇 Additional comments (3)
abci/src/lib.rs (1)
28-32: LGTM!The new modules are properly feature-gated under the "crypto" flag and follow the codebase's module organization pattern.
abci/src/merkle.rs (1)
1-71: LGTM! Well-implemented Merkle tree functionality.The implementation correctly ports the Tenderdash Merkle tree logic with:
- Proper prefix handling for leaf and inner nodes
- Correct recursive structure for building the tree
- Comprehensive test coverage with vectors from Tenderdash
The code is well-structured and maintains consistency with the original implementation.
abci/src/signatures.rs (1)
655-684: LGTM! Comprehensive test coverage with real test vectors.The test case properly verifies the ValidatorSet hash implementation against known good values, ensuring compatibility with the Tenderdash implementation.
|
@coderabbitai review |
✅ Actions performedReview triggered.
|
|
@coderabbitai review |
✅ Actions performedReview triggered.
|
Issue being fixed or feature implemented
Hash of validators stored in Header.ValidatorsHash and Header.NextValidatorsHash is calculated from quorum
hash and threshold-recovered public key. We need a way to calculate this hash in ABCI app, in order to double-check
consistency of the validator set used in a block.
What was done?
How Has This Been Tested?
Added unit tests
Breaking Changes
None
Checklist:
For repository code-owners and collaborators only
Summary by CodeRabbit
New Features
Documentation