1use crate::{crh::FixedLengthCRH, Error};
  2use algebra::bytes::ToBytes;
  3use std::{fmt, rc::Rc};
  4
  5#[cfg(feature = "r1cs")]
  6pub mod constraints;
  7
  8pub trait MerkleTreeConfig {
  9    const HEIGHT: usize;
 10    type H: FixedLengthCRH;
 11}
 12
 13/// Stores the hashes of a particular path (in order) from leaf to root.
 14/// Our path `is_left_child()` if the boolean in `path` is true.
 15#[derive(Derivative)]
 16#[derivative(
 17    Clone(bound = "P: MerkleTreeConfig"),
 18    Debug(bound = "P: MerkleTreeConfig, <P::H as FixedLengthCRH>::Output: fmt::Debug")
 19)]
 20pub struct MerkleTreePath<P: MerkleTreeConfig> {
 21    pub(crate) path: Vec<(
 22        <P::H as FixedLengthCRH>::Output,
 23        <P::H as FixedLengthCRH>::Output,
 24    )>,
 25}
 26
 27pub type MerkleTreeParams<P> = <<P as MerkleTreeConfig>::H as FixedLengthCRH>::Parameters;
 28pub type MerkleTreeDigest<P> = <<P as MerkleTreeConfig>::H as FixedLengthCRH>::Output;
 29
 30impl<P: MerkleTreeConfig> Default for MerkleTreePath<P> {
 31    fn default() -> Self {
 32        let mut path = Vec::with_capacity(P::HEIGHT as usize);
 33        for _i in 1..P::HEIGHT as usize {
 34            path.push((
 35                <P::H as FixedLengthCRH>::Output::default(),
 36                <P::H as FixedLengthCRH>::Output::default(),
 37            ));
 38        }
 39        Self { path }
 40    }
 41}
 42
 43impl<P: MerkleTreeConfig> MerkleTreePath<P> {
 44    pub fn verify<L: ToBytes>(
 45        &self,
 46        parameters: &<P::H as FixedLengthCRH>::Parameters,
 47        root_hash: &<P::H as FixedLengthCRH>::Output,
 48        leaf: &L,
 49    ) -> Result<bool, Error> {
 50        if self.path.len() != (P::HEIGHT - 1) as usize {
 51            return Ok(false);
 52        }
 53        // Check that the given leaf matches the leaf in the membership proof.
 54        let mut buffer = [0u8; 128];
 55
 56        if !self.path.is_empty() {
 57            let claimed_leaf_hash = hash_leaf::<P::H, L>(parameters, leaf, &mut buffer)?;
 58
 59            // Check if leaf is one of the bottom-most siblings.
 60            if claimed_leaf_hash != self.path[0].0 && claimed_leaf_hash != self.path[0].1 {
 61                return Ok(false);
 62            };
 63
 64            let mut prev = claimed_leaf_hash;
 65            // Check levels between leaf level and root.
 66            for &(ref hash, ref sibling_hash) in &self.path {
 67                // Check if the previous hash matches the correct current hash.
 68                if &prev != hash && &prev != sibling_hash {
 69                    return Ok(false);
 70                };
 71                prev = hash_inner_node::<P::H>(parameters, hash, sibling_hash, &mut buffer)?;
 72            }
 73
 74            if root_hash != &prev {
 75                return Ok(false);
 76            }
 77            Ok(true)
 78        } else {
 79            Ok(false)
 80        }
 81    }
 82}
 83
 84pub struct MerkleHashTree<P: MerkleTreeConfig> {
 85    tree:         Vec<<P::H as FixedLengthCRH>::Output>,
 86    padding_tree: Vec<(
 87        <P::H as FixedLengthCRH>::Output,
 88        <P::H as FixedLengthCRH>::Output,
 89    )>,
 90    parameters:   Rc<<P::H as FixedLengthCRH>::Parameters>,
 91    root:         Option<<P::H as FixedLengthCRH>::Output>,
 92}
 93
 94impl<P: MerkleTreeConfig> MerkleHashTree<P> {
 95    pub const HEIGHT: u8 = P::HEIGHT as u8;
 96
 97    pub fn blank(parameters: Rc<<P::H as FixedLengthCRH>::Parameters>) -> Self {
 98        MerkleHashTree {
 99            tree: Vec::new(),
100            padding_tree: Vec::new(),
101            root: None,
102            parameters,
103        }
104    }
105
106    pub fn new<L: ToBytes>(
107        parameters: Rc<<P::H as FixedLengthCRH>::Parameters>,
108        leaves: &[L],
109    ) -> Result<Self, Error> {
110        let new_time = start_timer!(|| "MerkleTree::New");
111
112        let last_level_size = leaves.len().next_power_of_two();
113        let tree_size = 2 * last_level_size - 1;
114        let tree_height = tree_height(tree_size);
115        assert!(tree_height as u8 <= Self::HEIGHT);
116
117        // Initialize the merkle tree.
118        let mut tree = Vec::with_capacity(tree_size);
119        let empty_hash = hash_empty::<P::H>(&parameters)?;
120        for _ in 0..tree_size {
121            tree.push(empty_hash.clone());
122        }
123
124        // Compute the starting indices for each level of the tree.
125        let mut index = 0;
126        let mut level_indices = Vec::with_capacity(tree_height);
127        for _ in 0..tree_height {
128            level_indices.push(index);
129            index = left_child(index);
130        }
131
132        // Compute and store the hash values for each leaf.
133        let last_level_index = level_indices.pop().unwrap();
134        let mut buffer = [0u8; 128];
135        for (i, leaf) in leaves.iter().enumerate() {
136            tree[last_level_index + i] = hash_leaf::<P::H, _>(&parameters, leaf, &mut buffer)?;
137        }
138
139        // Compute the hash values for every node in the tree.
140        let mut upper_bound = last_level_index;
141        let mut buffer = [0u8; 128];
142        level_indices.reverse();
143        for &start_index in &level_indices {
144            // Iterate over the current level.
145            for current_index in start_index..upper_bound {
146                let left_index = left_child(current_index);
147                let right_index = right_child(current_index);
148
149                // Compute Hash(left || right).
150                tree[current_index] = hash_inner_node::<P::H>(
151                    &parameters,
152                    &tree[left_index],
153                    &tree[right_index],
154                    &mut buffer,
155                )?;
156            }
157            upper_bound = start_index;
158        }
159        // Finished computing actual tree.
160        // Now, we compute the dummy nodes until we hit our HEIGHT goal.
161        let mut cur_height = tree_height;
162        let mut padding_tree = Vec::new();
163        let mut cur_hash = tree[0].clone();
164        while cur_height < (Self::HEIGHT - 1) as usize {
165            cur_hash = hash_inner_node::<P::H>(&parameters, &cur_hash, &empty_hash, &mut buffer)?;
166            padding_tree.push((cur_hash.clone(), empty_hash.clone()));
167            cur_height += 1;
168        }
169
170        let root_hash = hash_inner_node::<P::H>(&parameters, &cur_hash, &empty_hash, &mut buffer)?;
171
172        end_timer!(new_time);
173
174        Ok(MerkleHashTree {
175            tree,
176            padding_tree,
177            parameters,
178            root: Some(root_hash),
179        })
180    }
181
182    #[inline]
183    pub fn root(&self) -> <P::H as FixedLengthCRH>::Output {
184        self.root.clone().unwrap()
185    }
186
187    pub fn generate_proof<L: ToBytes>(
188        &self,
189        index: usize,
190        leaf: &L,
191    ) -> Result<MerkleTreePath<P>, Error> {
192        let prove_time = start_timer!(|| "MerkleTree::GenProof");
193        let mut path = Vec::new();
194
195        let mut buffer = [0u8; 128];
196        let leaf_hash = hash_leaf::<P::H, _>(&self.parameters, leaf, &mut buffer)?;
197        let tree_height = tree_height(self.tree.len());
198        let tree_index = convert_index_to_last_level(index, tree_height);
199        let empty_hash = hash_empty::<P::H>(&self.parameters)?;
200
201        // Check that the given index corresponds to the correct leaf.
202        if leaf_hash != self.tree[tree_index] {
203            return Err(MerkleTreeError::IncorrectLeafIndex(tree_index).into())
204        }
205
206        // Iterate from the leaf up to the root, storing all intermediate hash values.
207        let mut current_node = tree_index;
208        while !is_root(current_node) {
209            let sibling_node = sibling(current_node).unwrap();
210            let (curr_hash, sibling_hash) = (
211                self.tree[current_node].clone(),
212                self.tree[sibling_node].clone(),
213            );
214            if is_left_child(current_node) {
215                path.push((curr_hash, sibling_hash));
216            } else {
217                path.push((sibling_hash, curr_hash));
218            }
219            current_node = parent(current_node).unwrap();
220        }
221
222        // Store the root node. Set boolean as true for consistency with digest
223        // location.
224        assert!(path.len() < Self::HEIGHT as usize);
225        if path.len() != (Self::HEIGHT - 1) as usize {
226            path.push((self.tree[0].clone(), empty_hash));
227            for &(ref hash, ref sibling_hash) in &self.padding_tree {
228                path.push((hash.clone(), sibling_hash.clone()));
229            }
230        }
231        end_timer!(prove_time);
232        if path.len() != (Self::HEIGHT - 1) as usize {
233            return Err(MerkleTreeError::IncorrectPathLength(path.len()).into())
234        } else {
235            Ok(MerkleTreePath { path })
236        }
237    }
238}
239
240#[derive(Debug)]
241pub enum MerkleTreeError {
242    IncorrectLeafIndex(usize),
243    IncorrectPathLength(usize),
244}
245
246impl std::fmt::Display for MerkleTreeError {
247    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
248        let msg = match self {
249            MerkleTreeError::IncorrectLeafIndex(index) => {
250                format!("incorrect leaf index: {}", index)
251            },
252            MerkleTreeError::IncorrectPathLength(len) => format!("incorrect path length: {}", len),
253        };
254        write!(f, "{}", msg)
255    }
256}
257
258impl std::error::Error for MerkleTreeError {
259    #[inline]
260    fn source(&self) -> Option<&(dyn std::error::Error + 'static)> {
261        None
262    }
263}
264
265/// Returns the log2 value of the given number.
266#[inline]
267fn log2(number: usize) -> usize {
268    (number as f64).log2() as usize
269}
270
271/// Returns the height of the tree, given the size of the tree.
272#[inline]
273fn tree_height(tree_size: usize) -> usize {
274    log2(tree_size + 1)
275}
276
277/// Returns true iff the index represents the root.
278#[inline]
279fn is_root(index: usize) -> bool {
280    index == 0
281}
282
283/// Returns the index of the left child, given an index.
284#[inline]
285fn left_child(index: usize) -> usize {
286    2 * index + 1
287}
288
289/// Returns the index of the right child, given an index.
290#[inline]
291fn right_child(index: usize) -> usize {
292    2 * index + 2
293}
294
295/// Returns the index of the sibling, given an index.
296#[inline]
297fn sibling(index: usize) -> Option<usize> {
298    if index == 0 {
299        None
300    } else if is_left_child(index) {
301        Some(index + 1)
302    } else {
303        Some(index - 1)
304    }
305}
306
307/// Returns true iff the given index represents a left child.
308#[inline]
309fn is_left_child(index: usize) -> bool {
310    index % 2 == 1
311}
312
313/// Returns the index of the parent, given an index.
314#[inline]
315fn parent(index: usize) -> Option<usize> {
316    if index > 0 {
317        Some((index - 1) >> 1)
318    } else {
319        None
320    }
321}
322
323#[inline]
324fn convert_index_to_last_level(index: usize, tree_height: usize) -> usize {
325    index + (1 << (tree_height - 1)) - 1
326}
327
328/// Returns the output hash, given a left and right hash value.
329pub(crate) fn hash_inner_node<H: FixedLengthCRH>(
330    parameters: &H::Parameters,
331    left: &H::Output,
332    right: &H::Output,
333    buffer: &mut [u8],
334) -> Result<H::Output, Error> {
335    use std::io::Cursor;
336    let mut writer = Cursor::new(buffer);
337    // Construct left input.
338    left.write(&mut writer)?;
339
340    // Construct right input.
341    right.write(&mut writer)?;
342
343    let buffer = writer.into_inner();
344    H::evaluate(parameters, &buffer[..(H::INPUT_SIZE_BITS / 8)])
345}
346
347/// Returns the hash of a leaf.
348pub(crate) fn hash_leaf<H: FixedLengthCRH, L: ToBytes>(
349    parameters: &H::Parameters,
350    leaf: &L,
351    buffer: &mut [u8],
352) -> Result<H::Output, Error> {
353    use std::io::Cursor;
354    let mut writer = Cursor::new(buffer);
355    leaf.write(&mut writer)?;
356
357    let buffer = writer.into_inner();
358    H::evaluate(parameters, &buffer[..(H::INPUT_SIZE_BITS / 8)])
359}
360
361pub(crate) fn hash_empty<H: FixedLengthCRH>(
362    parameters: &H::Parameters,
363) -> Result<H::Output, Error> {
364    let empty_buffer = vec![0u8; H::INPUT_SIZE_BITS / 8];
365    H::evaluate(parameters, &empty_buffer)
366}
367
368#[cfg(test)]
369mod test {
370    use crate::{
371        crh::{pedersen::*, *},
372        merkle_tree::*,
373    };
374    use algebra::curves::jubjub::JubJubAffine as JubJub;
375    use rand::SeedableRng;
376    use rand_xorshift::XorShiftRng;
377
378    #[derive(Clone)]
379    pub(super) struct Window4x256;
380    impl PedersenWindow for Window4x256 {
381        const WINDOW_SIZE: usize = 4;
382        const NUM_WINDOWS: usize = 256;
383    }
384
385    type H = PedersenCRH<JubJub, Window4x256>;
386
387    struct JubJubMerkleTreeParams;
388
389    impl MerkleTreeConfig for JubJubMerkleTreeParams {
390        const HEIGHT: usize = 32;
391        type H = H;
392    }
393    type JubJubMerkleTree = MerkleHashTree<JubJubMerkleTreeParams>;
394
395    fn generate_merkle_tree<L: ToBytes + Clone + Eq>(leaves: &[L]) -> () {
396        let mut rng = XorShiftRng::seed_from_u64(9174123u64);
397
398        let crh_parameters = Rc::new(H::setup(&mut rng).unwrap());
399        let tree = JubJubMerkleTree::new(crh_parameters.clone(), &leaves).unwrap();
400        let root = tree.root();
401        for (i, leaf) in leaves.iter().enumerate() {
402            let proof = tree.generate_proof(i, &leaf).unwrap();
403            assert!(proof.verify(&crh_parameters, &root, &leaf).unwrap());
404        }
405    }
406
407    #[test]
408    fn good_root_test() {
409        let mut leaves = Vec::new();
410        for i in 0..4u8 {
411            leaves.push([i, i, i, i, i, i, i, i]);
412        }
413        generate_merkle_tree(&leaves);
414        let mut leaves = Vec::new();
415        for i in 0..100u8 {
416            leaves.push([i, i, i, i, i, i, i, i]);
417        }
418        generate_merkle_tree(&leaves);
419    }
420
421    fn bad_merkle_tree_verify<L: ToBytes + Clone + Eq>(leaves: &[L]) -> () {
422        use algebra::groups::Group;
423        let mut rng = XorShiftRng::seed_from_u64(13423423u64);
424
425        let crh_parameters = Rc::new(H::setup(&mut rng).unwrap());
426        let tree = JubJubMerkleTree::new(crh_parameters.clone(), &leaves).unwrap();
427        let root = JubJub::zero();
428        for (i, leaf) in leaves.iter().enumerate() {
429            let proof = tree.generate_proof(i, &leaf).unwrap();
430            assert!(proof.verify(&crh_parameters, &root, &leaf).unwrap());
431        }
432    }
433
434    #[should_panic]
435    #[test]
436    fn bad_root_test() {
437        let mut leaves = Vec::new();
438        for i in 0..4u8 {
439            leaves.push([i, i, i, i, i, i, i, i]);
440        }
441        generate_merkle_tree(&leaves);
442        let mut leaves = Vec::new();
443        for i in 0..100u8 {
444            leaves.push([i, i, i, i, i, i, i, i]);
445        }
446        bad_merkle_tree_verify(&leaves);
447    }
448}