// Tests adapted from https://github.com/worldcoin/semaphore-rs/blob/d462a4372f1fd9c27610f2acfe4841fab1d396aa/src/merkle_tree.rs #[cfg(test)] mod test { use std::{fmt::Display, str::FromStr}; use hex_literal::hex; use tiny_keccak::{Hasher as _, Keccak}; use zerokit_utils::{ FullMerkleConfig, FullMerkleTree, Hasher, OptimalMerkleConfig, OptimalMerkleTree, ZerokitMerkleProof, ZerokitMerkleTree, MIN_PARALLEL_NODES, }; #[derive(Clone, Copy, Eq, PartialEq)] struct Keccak256; #[derive(Clone, Copy, Eq, PartialEq, Debug, Default)] struct TestFr([u8; 32]); impl Hasher for Keccak256 { type Fr = TestFr; fn default_leaf() -> Self::Fr { TestFr([0; 32]) } fn hash(inputs: &[Self::Fr]) -> Self::Fr { let mut output = [0; 32]; let mut hasher = Keccak::v256(); for element in inputs { hasher.update(element.0.as_slice()); } hasher.finalize(&mut output); TestFr(output) } } impl Display for TestFr { fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result { write!(f, "{}", hex::encode(self.0.as_slice())) } } impl FromStr for TestFr { type Err = std::string::FromUtf8Error; fn from_str(s: &str) -> Result { Ok(TestFr(s.as_bytes().try_into().expect("Invalid length"))) } } impl From for TestFr { fn from(value: u32) -> Self { let mut bytes: Vec = vec![0; 28]; bytes.extend_from_slice(&value.to_be_bytes()); TestFr(bytes.as_slice().try_into().expect("Invalid length")) } } const DEFAULT_DEPTH: usize = 2; fn default_full_merkle_tree(depth: usize) -> FullMerkleTree { FullMerkleTree::::new(depth, TestFr([0; 32]), FullMerkleConfig::default()) .expect("Failed to create FullMerkleTree") } fn default_optimal_merkle_tree(depth: usize) -> OptimalMerkleTree { OptimalMerkleTree::::new(depth, TestFr([0; 32]), OptimalMerkleConfig::default()) .expect("Failed to create OptimalMerkleTree") } #[test] fn test_root() { let default_tree_root = TestFr(hex!( "b4c11951957c6f8f642c4af61cd6b24640fec6dc7fc607ee8206a99e92410d30" )); let roots = [ hex!("c1ba1812ff680ce84c1d5b4f1087eeb08147a4d510f3496b2849df3a73f5af95"), hex!("893760ec5b5bee236f29e85aef64f17139c3c1b7ff24ce64eb6315fca0f2485b"), hex!("222ff5e0b5877792c2bc1670e2ccd0c2c97cd7bb1672a57d598db05092d3d72c"), hex!("a9bb8c3f1f12e9aa903a50c47f314b57610a3ab32f2d463293f58836def38d36"), ] .map(TestFr); let nof_leaves = 4; let leaves: Vec = (1..=nof_leaves as u32).map(TestFr::from).collect(); let mut tree_full = default_full_merkle_tree(DEFAULT_DEPTH); assert_eq!(tree_full.root(), default_tree_root); for i in 0..nof_leaves { tree_full.set(i, leaves[i]).expect("Failed to set leaf"); assert_eq!(tree_full.root(), roots[i]); } let mut tree_opt = default_optimal_merkle_tree(DEFAULT_DEPTH); assert_eq!(tree_opt.root(), default_tree_root); for i in 0..nof_leaves { tree_opt.set(i, leaves[i]).expect("Failed to set leaf"); assert_eq!(tree_opt.root(), roots[i]); } } #[test] fn test_set_range() { let depth = 4; let leaves: Vec = (0..(1 << depth) as u32).map(TestFr::from).collect(); let mut tree_full = default_full_merkle_tree(depth); let root_before = tree_full.root(); tree_full .set_range(0, leaves.iter().cloned()) .expect("Failed to set leaves"); let root_after = tree_full.root(); assert_ne!(root_before, root_after); let mut tree_opt = default_optimal_merkle_tree(depth); let root_before = tree_opt.root(); tree_opt .set_range(0, leaves.iter().cloned()) .expect("Failed to set leaves"); let root_after = tree_opt.root(); assert_ne!(root_before, root_after); } #[test] fn test_update_next() { let mut tree_full = default_full_merkle_tree(DEFAULT_DEPTH); let mut tree_opt = default_optimal_merkle_tree(DEFAULT_DEPTH); for i in 0..4 { let leaf = TestFr::from(i as u32); tree_full.update_next(leaf).expect("Failed to update leaf"); tree_opt.update_next(leaf).expect("Failed to update leaf"); assert_eq!(tree_full.get(i).expect("Failed to get leaf"), leaf); assert_eq!(tree_opt.get(i).expect("Failed to get leaf"), leaf); } assert_eq!(tree_full.leaves_set(), 4); assert_eq!(tree_opt.leaves_set(), 4); } #[test] fn test_delete_and_reset() { let index = 1; let original_leaf = TestFr::from(42); let new_leaf = TestFr::from(99); let mut tree_full = default_full_merkle_tree(DEFAULT_DEPTH); tree_full .set(index, original_leaf) .expect("Failed to set leaf"); let root_with_original = tree_full.root(); tree_full.delete(index).expect("Failed to delete leaf"); let root_after_delete = tree_full.root(); assert_ne!(root_with_original, root_after_delete); tree_full.set(index, new_leaf).expect("Failed to set leaf"); let root_after_reset = tree_full.root(); assert_ne!(root_after_delete, root_after_reset); assert_ne!(root_with_original, root_after_reset); assert_eq!(tree_full.get(index).expect("Failed to get leaf"), new_leaf); let mut tree_opt = default_optimal_merkle_tree(DEFAULT_DEPTH); tree_opt .set(index, original_leaf) .expect("Failed to set leaf"); let root_with_original = tree_opt.root(); tree_opt.delete(index).expect("Failed to delete leaf"); let root_after_delete = tree_opt.root(); assert_ne!(root_with_original, root_after_delete); tree_opt.set(index, new_leaf).expect("Failed to set leaf"); let root_after_reset = tree_opt.root(); assert_ne!(root_after_delete, root_after_reset); assert_ne!(root_with_original, root_after_reset); assert_eq!(tree_opt.get(index).expect("Failed to get leaf"), new_leaf); } #[test] fn test_get_empty_leaves_indices() { let depth = 4; let nof_leaves: usize = 1 << (depth - 1); let leaves: Vec = (0..nof_leaves as u32).map(TestFr::from).collect(); let leaves_2: Vec = (0u32..2).map(TestFr::from).collect(); let leaves_4: Vec = (0u32..4).map(TestFr::from).collect(); let mut tree_full = default_full_merkle_tree(depth); let _ = tree_full.set_range(0, leaves.clone().into_iter()); assert!(tree_full.get_empty_leaves_indices().is_empty()); let mut vec_idxs = Vec::new(); for i in 0..nof_leaves { vec_idxs.push(i); let _ = tree_full.delete(i); assert_eq!(tree_full.get_empty_leaves_indices(), vec_idxs); } for i in (0..nof_leaves).rev() { vec_idxs.pop(); let _ = tree_full.set(i, leaves[i]); assert_eq!(tree_full.get_empty_leaves_indices(), vec_idxs); } // check situation when the number of items to insert is less than the number of items to delete tree_full .override_range(0, leaves_2.clone().into_iter(), [0, 1, 2, 3].into_iter()) .expect("Failed to override range"); // check if the indexes for write and delete are the same tree_full .override_range(0, leaves_4.clone().into_iter(), [0, 1, 2, 3].into_iter()) .expect("Failed to override range"); assert_eq!(tree_full.get_empty_leaves_indices(), Vec::::new()); // check if indexes for deletion are before indexes for overwriting tree_full .override_range(4, leaves_4.clone().into_iter(), [0, 1, 2, 3].into_iter()) .expect("Failed to override range"); assert_eq!(tree_full.get_empty_leaves_indices(), vec![0, 1, 2, 3]); // check if the indices for write and delete do not overlap completely tree_full .override_range(2, leaves_4.clone().into_iter(), [0, 1, 2, 3].into_iter()) .expect("Failed to override range"); assert_eq!(tree_full.get_empty_leaves_indices(), vec![0, 1]); let mut tree_opt = default_optimal_merkle_tree(depth); let _ = tree_opt.set_range(0, leaves.clone().into_iter()); assert!(tree_opt.get_empty_leaves_indices().is_empty()); let mut vec_idxs = Vec::new(); for i in 0..nof_leaves { vec_idxs.push(i); let _ = tree_opt.delete(i); assert_eq!(tree_opt.get_empty_leaves_indices(), vec_idxs); } for i in (0..nof_leaves).rev() { vec_idxs.pop(); let _ = tree_opt.set(i, leaves[i]); assert_eq!(tree_opt.get_empty_leaves_indices(), vec_idxs); } // check situation when the number of items to insert is less than the number of items to delete tree_opt .override_range(0, leaves_2.clone().into_iter(), [0, 1, 2, 3].into_iter()) .expect("Failed to override range"); // check if the indexes for write and delete are the same tree_opt .override_range(0, leaves_4.clone().into_iter(), [0, 1, 2, 3].into_iter()) .expect("Failed to override range"); assert_eq!(tree_opt.get_empty_leaves_indices(), Vec::::new()); // check if indexes for deletion are before indexes for overwriting tree_opt .override_range(4, leaves_4.clone().into_iter(), [0, 1, 2, 3].into_iter()) .expect("Failed to override range"); assert_eq!(tree_opt.get_empty_leaves_indices(), vec![0, 1, 2, 3]); // check if the indices for write and delete do not overlap completely tree_opt .override_range(2, leaves_4.clone().into_iter(), [0, 1, 2, 3].into_iter()) .expect("Failed to override range"); assert_eq!(tree_opt.get_empty_leaves_indices(), vec![0, 1]); } #[test] fn test_subtree_root() { let depth = 3; let nof_leaves: usize = 4; let leaves: Vec = (0..nof_leaves as u32).map(TestFr::from).collect(); let mut tree_full = default_full_merkle_tree(depth); let _ = tree_full.set_range(0, leaves.iter().cloned()); for i in 0..nof_leaves { // check leaves assert_eq!( tree_full.get(i).expect("Failed to get leaf"), tree_full .get_subtree_root(depth, i) .expect("Failed to get subtree root") ); // check root assert_eq!( tree_full.root(), tree_full .get_subtree_root(0, i) .expect("Failed to get subtree root") ); } // check intermediate nodes for n in (1..=depth).rev() { for i in (0..(1 << n)).step_by(2) { let idx_l = i * (1 << (depth - n)); let idx_r = (i + 1) * (1 << (depth - n)); let idx_sr = idx_l; let prev_l = tree_full .get_subtree_root(n, idx_l) .expect("Failed to get subtree root"); let prev_r = tree_full .get_subtree_root(n, idx_r) .expect("Failed to get subtree root"); let subroot = tree_full .get_subtree_root(n - 1, idx_sr) .expect("Failed to get subtree root"); // check intermediate nodes assert_eq!(Keccak256::hash(&[prev_l, prev_r]), subroot); } } let mut tree_opt = default_optimal_merkle_tree(depth); let _ = tree_opt.set_range(0, leaves.iter().cloned()); for i in 0..nof_leaves { // check leaves assert_eq!( tree_opt.get(i).expect("Failed to get leaf"), tree_opt .get_subtree_root(depth, i) .expect("Failed to get subtree root") ); // check root assert_eq!( tree_opt.root(), tree_opt .get_subtree_root(0, i) .expect("Failed to get subtree root") ); } // check intermediate nodes for n in (1..=depth).rev() { for i in (0..(1 << n)).step_by(2) { let idx_l = i * (1 << (depth - n)); let idx_r = (i + 1) * (1 << (depth - n)); let idx_sr = idx_l; let prev_l = tree_opt .get_subtree_root(n, idx_l) .expect("Failed to get subtree root"); let prev_r = tree_opt .get_subtree_root(n, idx_r) .expect("Failed to get subtree root"); let subroot = tree_opt .get_subtree_root(n - 1, idx_sr) .expect("Failed to get subtree root"); // check intermediate nodes assert_eq!(Keccak256::hash(&[prev_l, prev_r]), subroot); } } } #[test] fn test_proof() { let nof_leaves = 4; let leaves: Vec = (0..nof_leaves as u32).map(TestFr::from).collect(); // We test the FullMerkleTree implementation let mut tree_full = default_full_merkle_tree(DEFAULT_DEPTH); for i in 0..nof_leaves { // We set the leaves tree_full.set(i, leaves[i]).expect("Failed to set leaf"); // We compute a merkle proof let proof = tree_full.proof(i).expect("Failed to compute proof"); // We verify if the merkle proof corresponds to the right leaf index assert_eq!(proof.leaf_index(), i); // We verify the proof assert!(tree_full .verify(&leaves[i], &proof) .expect("Failed to verify proof")); // We ensure that the Merkle proof and the leaf generate the same root as the tree assert_eq!(proof.compute_root_from(&leaves[i]), tree_full.root()); // We check that the proof is not valid for another leaf assert!(!tree_full .verify(&leaves[(i + 1) % nof_leaves], &proof) .expect("Failed to verify proof")); } // We test the OptimalMerkleTree implementation let mut tree_opt = default_optimal_merkle_tree(DEFAULT_DEPTH); for i in 0..nof_leaves { // We set the leaves tree_opt.set(i, leaves[i]).expect("Failed to set leaf"); // We compute a merkle proof let proof = tree_opt.proof(i).expect("Failed to compute proof"); // We verify if the merkle proof corresponds to the right leaf index assert_eq!(proof.leaf_index(), i); // We verify the proof assert!(tree_opt .verify(&leaves[i], &proof) .expect("Failed to verify proof")); // We ensure that the Merkle proof and the leaf generate the same root as the tree assert_eq!(proof.compute_root_from(&leaves[i]), tree_opt.root()); // We check that the proof is not valid for another leaf assert!(!tree_opt .verify(&leaves[(i + 1) % nof_leaves], &proof) .expect("Failed to verify proof")); } } #[test] fn test_proof_fail() { let tree_full = default_full_merkle_tree(DEFAULT_DEPTH); let tree_opt = default_optimal_merkle_tree(DEFAULT_DEPTH); let invalid_leaf = TestFr::from(12345); let proof_full = tree_full.proof(0).expect("Failed to compute proof"); let proof_opt = tree_opt.proof(0).expect("Failed to compute proof"); // Should fail because no leaf was set assert!(!tree_full .verify(&invalid_leaf, &proof_full) .expect("Failed to verify proof")); assert!(!tree_opt .verify(&invalid_leaf, &proof_opt) .expect("Failed to verify proof")); } #[test] fn test_override_range() { let nof_leaves = 4; let leaves: Vec = (0..nof_leaves as u32).map(TestFr::from).collect(); let new_leaves = [ hex!("0000000000000000000000000000000000000000000000000000000000000005"), hex!("0000000000000000000000000000000000000000000000000000000000000006"), ] .map(TestFr); let to_delete_indices: [usize; 2] = [0, 1]; let mut tree_full = default_full_merkle_tree(DEFAULT_DEPTH); tree_full .set_range(0, leaves.iter().cloned()) .expect("Failed to set leaves"); tree_full .override_range( 0, new_leaves.iter().cloned(), to_delete_indices.iter().cloned(), ) .expect("Failed to override range"); for (i, &new_leaf) in new_leaves.iter().enumerate() { assert_eq!(tree_full.get(i).expect("Failed to get leaf"), new_leaf); } let mut tree_opt = default_optimal_merkle_tree(DEFAULT_DEPTH); tree_opt .set_range(0, leaves.iter().cloned()) .expect("Failed to set leaves"); tree_opt .override_range( 0, new_leaves.iter().cloned(), to_delete_indices.iter().cloned(), ) .expect("Failed to override range"); for (i, &new_leaf) in new_leaves.iter().enumerate() { assert_eq!(tree_opt.get(i).expect("Failed to get leaf"), new_leaf); } } #[test] fn test_override_range_parallel_triggered() { let depth = 13; let nof_leaves = 8192; // number of leaves larger than MIN_PARALLEL_NODES to trigger parallel hashing assert!(MIN_PARALLEL_NODES < nof_leaves); let leaves: Vec = (0..nof_leaves as u32).map(TestFr::from).collect(); let indices: Vec = (0..nof_leaves).collect(); let mut tree_full = default_full_merkle_tree(depth); tree_full .override_range(0, leaves.iter().cloned(), indices.iter().cloned()) .expect("Failed to override range"); for (i, &leaf) in leaves.iter().enumerate() { assert_eq!(tree_full.get(i).expect("Failed to get leaf"), leaf); } let mut tree_opt = default_optimal_merkle_tree(depth); tree_opt .override_range(0, leaves.iter().cloned(), indices.iter().cloned()) .expect("Failed to override range"); for (i, &leaf) in leaves.iter().enumerate() { assert_eq!(tree_opt.get(i).expect("Failed to get leaf"), leaf); } } }