Minor code improvements in qgb contracts
Opened this issue · 0 comments
dalmirel commented
Involved artifacts
- blobstream-contracts/src/QuantumGravityBridge.sol
- blobstream-contracts/src/lib/verifier/DAVerifier.sol
- blobstream-contracts/src/lib/tree/binary/BinaryMerkleTree.sol
- blobstream-contracts/src/lib/tree/namespace/NamespaceMerkleTree.sol
Description
The minor code improvements listed within this finding do not pose a security threat nor do they introduce an issue. The suggestions are shared to improve the code readability, keep consistency, optimize, and improve logging:
- Doubled the word “root“ within the comment.
- A comment that validators that did not signed the attestation will have nil value in sigs here should be added to improve readability of code, because looking at this part of the code it can be only assumed that all the validators have to sign the data. There is a similar comment in checkValidatorSignatures.
- Wrong comment placements (should be after the following if blocks):
Problem Scenarios
Findings listed above could not introduce any issues, they are suggestions for code improvements.
Recommendation
As described above.