Skip to content

Commit

Permalink
ref(fmt): add wrap-comments rustfmt nightly opt (#5)
Browse files Browse the repository at this point in the history
  • Loading branch information
alexfertel authored Mar 23, 2024
1 parent 336d051 commit 6ad9e1f
Show file tree
Hide file tree
Showing 2 changed files with 11 additions and 9 deletions.
19 changes: 10 additions & 9 deletions lib/crypto/src/merkle.rs
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,6 @@
//! of internal nodes in the Merkle tree could be reinterpreted as a
//! leaf value. OpenZeppelin's JavaScript library generates Merkle trees
//! that are safe against this attack out of the box.
//!
use alloc::vec::Vec;

type Bytes32 = [u8; 32];
Expand Down Expand Up @@ -213,13 +212,15 @@ pub fn verify_multi_proof<H: Hasher<Hash = Bytes32>>(
// `hashes` represents a queue of hashes, our "main queue".
let mut hashes = Vec::with_capacity(total_hashes + leaves.len());
hashes.extend(leaves);
// The `xxx_pos` values are "pointers" to the next value to consume in each queue.
// We use them to mimic a queue's pop operation.
// The `xxx_pos` values are "pointers" to the next value to consume in each
// queue. We use them to mimic a queue's pop operation.
let mut proof_pos = 0;
let mut hashes_pos = 0;
// At each step, we compute the next hash using two values:
// - A value from the "main queue". Consume all the leaves, then all the hashes but the root.
// - A value from the "main queue" (merging branches) or a member of the `proof`, depending on `flag`.
// - A value from the "main queue". Consume all the leaves, then all the
// hashes but the root.
// - A value from the "main queue" (merging branches) or a member of the
// `proof`, depending on `flag`.
for &flag in proof_flags {
let a = hashes[hashes_pos];
hashes_pos += 1;
Expand Down Expand Up @@ -280,7 +281,6 @@ mod tests {
#[test]
fn verifies_valid_proofs() {
// These values are generated using https://github.com/OpenZeppelin/merkle-tree.
// They correspond to:
//
// ```js
// const merkleTree = StandardMerkleTree.of(
Expand Down Expand Up @@ -323,7 +323,6 @@ mod tests {
#[test]
fn rejects_invalid_proofs() {
// These values are generated using https://github.com/OpenZeppelin/merkle-tree.
// They correspond to:
//
// ```js
// const correctMerkleTree = StandardMerkleTree.of(toElements('abc'), ['string']);
Expand All @@ -348,9 +347,10 @@ mod tests {
#[test]
fn rejects_proofs_with_invalid_length() {
// These values are generated using https://github.com/OpenZeppelin/merkle-tree.
// const merkleTree = StandardMerkleTree.of(toElements('abc'), ['string']);
//
// ```js
// const merkleTree = StandardMerkleTree.of(toElements('abc'), ['string']);
//
// const root = merkleTree.root;
// const leaf = merkleTree.leafHash(['a']);
// const proof = merkleTree.getProof(['a']);
Expand Down Expand Up @@ -564,7 +564,8 @@ mod tests {

#[test]
#[should_panic]
/// Panics when processing manipulated proofs with a zero-value node at depth 1.
/// Panics when processing manipulated proofs with a zero-value node at
/// depth 1.
fn panics_manipulated_multi_proof() {
// These values are generated using https://github.com/OpenZeppelin/merkle-tree.
//
Expand Down
1 change: 1 addition & 0 deletions rustfmt.toml
Original file line number Diff line number Diff line change
Expand Up @@ -5,3 +5,4 @@ imports_granularity = "Crate"
reorder_impl_items = true
use_field_init_shorthand = true
use_small_heuristics = "Max"
wrap_comments = true

0 comments on commit 6ad9e1f

Please sign in to comment.