1use anyhow::{Context, anyhow};
4use serde::{Deserialize, Serialize};
5use std::{
6 collections::{BTreeMap, BTreeSet, HashMap},
7 hash::Hash,
8 sync::Arc,
9};
10
11use crate::{StdError, StdResult};
12
13use super::{MKProof, MKTree, MKTreeNode, MKTreeStorer};
14
15pub trait MKMapKey: PartialEq + Eq + PartialOrd + Ord + Clone + Hash + Into<MKTreeNode> {}
17
18pub trait MKMapValue<K: MKMapKey>: Clone + TryInto<MKTreeNode> + TryFrom<MKTreeNode> {
20 fn compute_root(&self) -> StdResult<MKTreeNode>;
22
23 fn contains<T: Into<MKTreeNode> + Clone>(&self, leaf: &T) -> bool;
25
26 fn can_compute_proof(&self) -> bool;
28
29 fn compute_proof<T: Into<MKTreeNode> + Clone>(
31 &self,
32 leaves: &[T],
33 ) -> StdResult<Option<MKMapProof<K>>>;
34}
35
36pub struct MKMap<K: MKMapKey, V: MKMapValue<K>, S: MKTreeStorer> {
38 inner_map_values: BTreeMap<K, V>,
39 inner_merkle_tree: MKTree<S>,
40 provable_keys: BTreeSet<K>,
41}
42
43impl<K: MKMapKey, V: MKMapValue<K>, S: MKTreeStorer> MKMap<K, V, S> {
44 pub fn new(entries: &[(K, V)]) -> StdResult<Self> {
46 Self::new_from_iter(entries.to_vec())
47 }
48
49 pub fn new_from_iter<T: IntoIterator<Item = (K, V)>>(entries: T) -> StdResult<Self> {
51 let inner_map_values = BTreeMap::default();
52 let inner_merkle_tree = MKTree::<S>::new::<MKTreeNode>(&[])?;
53 let can_compute_proof_keys = BTreeSet::default();
54 let mut mk_map = Self {
55 inner_map_values,
56 inner_merkle_tree,
57 provable_keys: can_compute_proof_keys,
58 };
59 let sorted_entries = BTreeMap::from_iter(entries);
60 for (key, value) in sorted_entries {
61 mk_map.insert_unchecked(key, value)?;
62 }
63
64 Ok(mk_map)
65 }
66
67 pub fn insert(&mut self, key: K, value: V) -> StdResult<()> {
71 if let Some(existing_value) = self.inner_map_values.get(&key) {
72 if existing_value.compute_root()? != value.compute_root()? {
73 return Err(anyhow!(
74 "MKMap values should be replaced by entry with same root"
75 ));
76 }
77 return self.replace_unchecked(key, value);
78 } else {
79 let key_max = self.inner_map_values.keys().max();
80 if key_max > Some(&key) {
81 return Err(anyhow!("MKMap keys must be inserted in order"));
82 }
83 }
84
85 self.insert_unchecked(key, value)
86 }
87
88 fn insert_unchecked(&mut self, key: K, value: V) -> StdResult<()> {
90 self.update_provable_keys(&key, &value)?;
91 self.inner_map_values.insert(key.clone(), value.clone());
92 let mktree_node_value = value
93 .try_into()
94 .map_err(|_| anyhow!("MKMap could not convert value to NKTreeNode"))
95 .with_context(|| "MKMap could not convert insert value")?;
96 let mktree_node_key: MKTreeNode = key.into();
97 self.inner_merkle_tree
98 .append(&[mktree_node_key + mktree_node_value])?;
99
100 Ok(())
101 }
102
103 pub fn replace(&mut self, key: K, value: V) -> StdResult<()> {
105 match self.inner_map_values.get(&key) {
106 Some(existing_value) if existing_value.compute_root()? != value.compute_root()? => Err(
107 anyhow!("MKMap values should be replaced by entry with same root"),
108 ),
109 Some(_) => self.replace_unchecked(key, value),
110 None => Err(anyhow!("MKMap could not replace non-existing key")),
111 }
112 }
113
114 fn replace_unchecked(&mut self, key: K, value: V) -> StdResult<()> {
116 self.update_provable_keys(&key, &value)?;
117 self.inner_map_values.insert(key.clone(), value.clone());
118
119 Ok(())
120 }
121
122 fn update_provable_keys(&mut self, key: &K, value: &V) -> StdResult<()> {
124 if value.can_compute_proof() {
125 self.provable_keys.insert(key.clone());
126 } else if self.provable_keys.contains(key) {
127 self.provable_keys.remove(key);
128 }
129
130 Ok(())
131 }
132
133 #[cfg(test)]
134 pub fn get_provable_keys(&self) -> &BTreeSet<K> {
136 &self.provable_keys
137 }
138
139 pub fn contains(&self, leaf: &MKTreeNode) -> Option<(&K, &V)> {
141 self.iter().find(|(_, v)| v.contains(leaf))
142 }
143
144 pub fn get(&self, key: &K) -> Option<&V> {
146 self.inner_map_values.get(key)
147 }
148
149 pub fn iter(&self) -> impl Iterator<Item = (&K, &V)> {
151 self.inner_map_values.iter()
152 }
153
154 pub fn len(&self) -> usize {
156 self.inner_map_values.len()
157 }
158
159 pub fn is_empty(&self) -> bool {
161 self.inner_map_values.is_empty()
162 }
163
164 pub fn compress(&mut self) -> StdResult<()> {
166 let keys = self.provable_keys.clone();
167 for key in keys {
168 if let Some(value) = self.get(&key) {
169 let value = value
170 .compute_root()?
171 .try_into()
172 .map_err(|_| anyhow!("Merkle root could not be converted to V"))?;
173 self.replace_unchecked(key.to_owned(), value)?;
174 }
175 }
176
177 Ok(())
178 }
179
180 pub fn compute_root(&self) -> StdResult<MKTreeNode> {
182 self.inner_merkle_tree.compute_root()
183 }
184
185 pub fn compute_proof<T: Into<MKTreeNode> + Clone>(
187 &self,
188 leaves: &[T],
189 ) -> StdResult<MKMapProof<K>> {
190 if leaves.is_empty() {
191 return Err(anyhow!("MKMap could not compute proof for empty leaves"));
192 }
193
194 let leaves_by_keys = self.group_leaves_by_keys(leaves);
195 let mut sub_proofs = BTreeMap::<K, MKMapProof<K>>::default();
196 for (key, sub_leaves) in leaves_by_keys {
197 if let Some(value) = self.get(&key) {
198 if let Some(proof) = value.compute_proof(&sub_leaves)? {
199 sub_proofs.insert(key.to_owned(), proof);
200 }
201 }
202 }
203
204 let master_proof = self
205 .inner_merkle_tree
206 .compute_proof(
207 &sub_proofs
208 .iter()
209 .map(|(k, p)| k.to_owned().into() + p.compute_root().to_owned())
210 .collect::<Vec<MKTreeNode>>(),
211 )
212 .with_context(|| "MKMap could not compute master proof")?;
213
214 Ok(MKMapProof::new(master_proof, sub_proofs))
215 }
216
217 fn group_leaves_by_keys<T: Into<MKTreeNode> + Clone>(
219 &self,
220 leaves: &[T],
221 ) -> HashMap<K, Vec<MKTreeNode>> {
222 let can_compute_proof_map: HashMap<K, V> = self
223 .provable_keys
224 .iter()
225 .filter_map(|k| self.get(k).map(|v| (k.to_owned(), v.to_owned())))
226 .collect();
227 let leaves_by_keys: HashMap<K, Vec<MKTreeNode>> = can_compute_proof_map
228 .iter()
229 .map(|(key, value)| {
230 let leaves_found = leaves
231 .iter()
232 .filter_map(|leaf| value.contains(leaf).then_some(leaf.to_owned().into()))
233 .collect::<Vec<_>>();
234
235 (key.to_owned(), leaves_found)
236 })
237 .fold(HashMap::default(), |mut acc, (key, leaves)| {
238 leaves.into_iter().for_each(|leaf| {
239 acc.entry(key.to_owned()).or_default().push(leaf);
240 });
241
242 acc
243 });
244
245 leaves_by_keys
246 }
247}
248
249impl<K: MKMapKey, V: MKMapValue<K>, S: MKTreeStorer> Clone for MKMap<K, V, S> {
250 fn clone(&self) -> Self {
251 let mut clone = Self::new(&[]).unwrap();
253 for (k, v) in self.inner_map_values.iter() {
254 clone.insert(k.to_owned(), v.to_owned()).unwrap();
255 }
256
257 clone
258 }
259}
260
261impl<'a, K: MKMapKey, V: MKMapValue<K>, S: MKTreeStorer> From<&'a MKMap<K, V, S>>
262 for &'a MKTree<S>
263{
264 fn from(other: &'a MKMap<K, V, S>) -> Self {
265 &other.inner_merkle_tree
266 }
267}
268
269impl<K: MKMapKey, V: MKMapValue<K>, S: MKTreeStorer> TryFrom<MKMap<K, V, S>> for MKTreeNode {
270 type Error = StdError;
271 fn try_from(other: MKMap<K, V, S>) -> Result<Self, Self::Error> {
272 other.compute_root()
273 }
274}
275
276#[derive(Serialize, Deserialize, Clone, Debug, PartialEq, Eq)]
278pub struct MKMapProof<K: MKMapKey> {
279 master_proof: MKProof,
280 sub_proofs: Vec<(K, MKMapProof<K>)>,
281}
282
283impl<K: MKMapKey> MKMapProof<K> {
284 pub fn new(master_proof: MKProof, sub_proofs: BTreeMap<K, MKMapProof<K>>) -> Self {
286 let sub_proofs = sub_proofs.into_iter().collect();
287 Self {
288 master_proof,
289 sub_proofs,
290 }
291 }
292
293 pub fn compute_root(&self) -> MKTreeNode {
295 self.master_proof.root().to_owned()
296 }
297
298 pub fn verify(&self) -> StdResult<()> {
300 for (_key, proof) in &self.sub_proofs {
301 proof
302 .verify()
303 .with_context(|| "MKMapProof could not verify sub proof")?;
304 }
305
306 self.master_proof
307 .verify()
308 .with_context(|| "MKMapProof could not verify master proof")?;
309 if !self.sub_proofs.is_empty() {
310 self.master_proof
311 .contains(
312 &self
313 .sub_proofs
314 .iter()
315 .map(|(k, p)| k.to_owned().into() + p.compute_root().to_owned())
316 .collect::<Vec<_>>(),
317 )
318 .with_context(|| "MKMapProof could not match verified leaves of master proof")?;
319 }
320
321 Ok(())
322 }
323
324 pub fn contains(&self, leaf: &MKTreeNode) -> StdResult<()> {
326 let contains_leaf = {
327 self.master_proof.contains(&[leaf.to_owned()]).is_ok()
328 || self.sub_proofs.iter().any(|(_k, p)| p.contains(leaf).is_ok())
329 };
330
331 contains_leaf
332 .then_some(())
333 .ok_or(anyhow!("MKMapProof does not contain leaf {:?}", leaf))
334 }
335
336 pub fn leaves(&self) -> Vec<MKTreeNode> {
338 if self.sub_proofs.is_empty() {
339 self.master_proof.leaves()
340 } else {
341 let mut leaves = vec![];
342 self.sub_proofs.iter().for_each(|(_k, p)| {
343 leaves.extend(p.leaves());
344 });
345
346 leaves
347 }
348 }
349}
350
351impl<K: MKMapKey + Serialize + for<'de> Deserialize<'de>> MKMapProof<K> {
352 pub fn to_bytes(&self) -> StdResult<Vec<u8>> {
354 bincode::serde::encode_to_vec(self, bincode::config::standard()).map_err(|e| e.into())
355 }
356
357 pub fn from_bytes(bytes: &[u8]) -> StdResult<Self> {
359 let (res, _) =
360 bincode::serde::decode_from_slice::<Self, _>(bytes, bincode::config::standard())?;
361
362 Ok(res)
363 }
364}
365
366impl<K: MKMapKey> From<MKProof> for MKMapProof<K> {
367 fn from(other: MKProof) -> Self {
368 MKMapProof::new(other, BTreeMap::default())
369 }
370}
371
372#[derive(Clone)]
376pub enum MKMapNode<K: MKMapKey, S: MKTreeStorer> {
377 Map(Arc<MKMap<K, Self, S>>),
379
380 Tree(Arc<MKTree<S>>),
382
383 TreeNode(MKTreeNode),
385}
386
387impl<K: MKMapKey, S: MKTreeStorer> MKMapValue<K> for MKMapNode<K, S> {
388 fn compute_root(&self) -> StdResult<MKTreeNode> {
389 match self {
390 MKMapNode::Map(mk_map) => mk_map.compute_root(),
391 MKMapNode::Tree(merkle_tree) => merkle_tree.compute_root(),
392 MKMapNode::TreeNode(merkle_tree_node) => Ok(merkle_tree_node.to_owned()),
393 }
394 }
395
396 fn contains<T: Into<MKTreeNode> + Clone>(&self, leaf: &T) -> bool {
397 let leaf = leaf.to_owned().into();
398 match self {
399 MKMapNode::Map(mk_map) => mk_map.contains(&leaf).is_some(),
400 MKMapNode::Tree(merkle_tree) => merkle_tree.contains(&leaf),
401 MKMapNode::TreeNode(merkle_tree_node) => *merkle_tree_node == leaf,
402 }
403 }
404
405 fn can_compute_proof(&self) -> bool {
406 match self {
407 MKMapNode::Map(_) => true,
408 MKMapNode::Tree(_) => true,
409 MKMapNode::TreeNode(_) => false,
410 }
411 }
412
413 fn compute_proof<T: Into<MKTreeNode> + Clone>(
414 &self,
415 leaves: &[T],
416 ) -> StdResult<Option<MKMapProof<K>>> {
417 match self {
418 MKMapNode::Tree(value) => {
419 let proof = value
420 .compute_proof(
421 &leaves.iter().map(|leaf| leaf.to_owned().into()).collect::<Vec<_>>(),
422 )
423 .with_context(|| "MKMapValue could not compute sub proof for MKTree")?;
424 Ok(Some(proof.into()))
425 }
426 MKMapNode::Map(value) => {
427 let proof = value
428 .compute_proof(
429 &leaves.iter().map(|leaf| leaf.to_owned().into()).collect::<Vec<_>>(),
430 )
431 .with_context(|| "MKMapValue could not compute sub proof for MKMap")?;
432 Ok(Some(proof))
433 }
434 _ => Ok(None),
435 }
436 }
437}
438
439impl<K: MKMapKey, S: MKTreeStorer> From<MKMap<K, MKMapNode<K, S>, S>> for MKMapNode<K, S> {
440 fn from(other: MKMap<K, MKMapNode<K, S>, S>) -> Self {
441 MKMapNode::Map(Arc::new(other))
442 }
443}
444
445impl<K: MKMapKey, S: MKTreeStorer> From<MKTree<S>> for MKMapNode<K, S> {
446 fn from(other: MKTree<S>) -> Self {
447 MKMapNode::Tree(Arc::new(other))
448 }
449}
450
451impl<K: MKMapKey, S: MKTreeStorer> From<MKTreeNode> for MKMapNode<K, S> {
452 fn from(other: MKTreeNode) -> Self {
453 MKMapNode::TreeNode(other)
454 }
455}
456
457impl<K: MKMapKey, S: MKTreeStorer> TryFrom<MKMapNode<K, S>> for MKTreeNode {
458 type Error = StdError;
459 fn try_from(other: MKMapNode<K, S>) -> Result<Self, Self::Error> {
460 other.compute_root()
461 }
462}
463
464#[cfg(test)]
465mod tests {
466 use std::collections::BTreeSet;
467
468 use crate::{
469 crypto_helper::MKTreeStoreInMemory,
470 entities::{BlockNumber, BlockRange},
471 };
472
473 use super::*;
474
475 fn generate_merkle_trees(
476 total_leaves: u64,
477 block_range_length: u64,
478 ) -> Vec<(BlockRange, MKTree<MKTreeStoreInMemory>)> {
479 (0..total_leaves / block_range_length)
480 .map(|block_range_index| {
481 let block_range = BlockRange::from_block_number_and_length(
482 BlockNumber(block_range_index),
483 BlockNumber(block_range_length),
484 )
485 .unwrap();
486 let merkle_tree_block_range = generate_merkle_tree(&block_range);
487 (block_range, merkle_tree_block_range)
488 })
489 .collect::<Vec<_>>()
490 }
491
492 fn generate_merkle_tree(block_range: &BlockRange) -> MKTree<MKTreeStoreInMemory> {
493 let leaves = (*block_range.start..*block_range.end)
494 .map(|leaf_index| leaf_index.to_string())
495 .collect::<Vec<_>>();
496 MKTree::new(&leaves).unwrap()
497 }
498
499 fn generate_merkle_trees_for_ranges(
500 block_ranges: &[BlockRange],
501 ) -> Vec<(BlockRange, MKTree<MKTreeStoreInMemory>)> {
502 block_ranges
503 .iter()
504 .map(|block_range| (block_range.to_owned(), generate_merkle_tree(block_range)))
505 .collect()
506 }
507
508 fn into_mkmap_tree_entries(
509 entries: Vec<(BlockRange, MKTree<MKTreeStoreInMemory>)>,
510 ) -> Vec<(BlockRange, MKMapNode<BlockRange, MKTreeStoreInMemory>)> {
511 entries
512 .into_iter()
513 .map(|(range, mktree)| (range, MKMapNode::Tree(Arc::new(mktree))))
514 .collect()
515 }
516
517 fn into_mkmap_tree_node_entries(
518 entries: Vec<(BlockRange, MKTree<MKTreeStoreInMemory>)>,
519 ) -> Vec<(BlockRange, MKMapNode<BlockRange, MKTreeStoreInMemory>)> {
520 entries
521 .into_iter()
522 .map(|(range, mktree)| (range, MKMapNode::TreeNode(mktree.try_into().unwrap())))
523 .collect()
524 }
525
526 #[test]
527 fn test_mk_map_should_compute_same_root_when_replacing_entry_with_equivalent() {
528 let entries = generate_merkle_trees(10, 3);
529 let mk_map_nodes =
530 MKMap::<_, _, MKTreeStoreInMemory>::new(&into_mkmap_tree_node_entries(entries.clone()))
531 .unwrap();
532 let mk_map_full =
533 MKMap::<_, _, MKTreeStoreInMemory>::new(&into_mkmap_tree_entries(entries)).unwrap();
534
535 let mk_map_nodes_root = mk_map_nodes.compute_root().unwrap();
536 let mk_map_full_root = mk_map_full.compute_root().unwrap();
537
538 assert_eq!(mk_map_full_root, mk_map_nodes_root);
539 }
540
541 #[test]
542 fn test_mk_map_should_accept_replacement_with_same_root_value() {
543 let entries = generate_merkle_trees_for_ranges(&[
544 BlockRange::new(0, 3),
545 BlockRange::new(4, 6),
546 BlockRange::new(7, 9),
547 ]);
548 let mut mk_map =
549 MKMap::<_, _, MKTreeStoreInMemory>::new(&into_mkmap_tree_entries(entries)).unwrap();
550 let mk_map_root_expected = mk_map.compute_root().unwrap();
551 let block_range_replacement = BlockRange::new(0, 3);
552 let same_root_value = MKMapNode::TreeNode(
553 mk_map.get(&block_range_replacement).unwrap().compute_root().unwrap(),
554 );
555
556 mk_map.insert(block_range_replacement, same_root_value).unwrap();
557
558 assert_eq!(mk_map_root_expected, mk_map.compute_root().unwrap())
559 }
560
561 #[test]
562 fn test_mk_map_should_reject_replacement_with_different_root_value() {
563 let entries = generate_merkle_trees_for_ranges(&[
564 BlockRange::new(0, 3),
565 BlockRange::new(4, 6),
566 BlockRange::new(7, 9),
567 ]);
568 let mut mk_map =
569 MKMap::<_, _, MKTreeStoreInMemory>::new(&into_mkmap_tree_entries(entries)).unwrap();
570 let block_range_replacement = BlockRange::new(0, 3);
571 let value_replacement: MKTreeNode = "test-123".to_string().into();
572 let different_root_value = MKMapNode::TreeNode(value_replacement);
573
574 mk_map
575 .insert(block_range_replacement, different_root_value)
576 .expect_err("the MKMap should reject replacement with different root value");
577 }
578
579 #[test]
580 fn test_mk_map_replace_should_accept_replacement_with_same_root_value() {
581 let entries = generate_merkle_trees_for_ranges(&[
582 BlockRange::new(0, 3),
583 BlockRange::new(4, 6),
584 BlockRange::new(7, 9),
585 ]);
586 let mut mk_map =
587 MKMap::<_, _, MKTreeStoreInMemory>::new(&into_mkmap_tree_entries(entries)).unwrap();
588 let block_range_replacement = BlockRange::new(0, 3);
589 let same_root_value = MKMapNode::TreeNode(
590 mk_map.get(&block_range_replacement).unwrap().compute_root().unwrap(),
591 );
592 let mk_map_root_expected = mk_map.compute_root().unwrap();
593
594 assert!(matches!(
595 mk_map.get(&block_range_replacement).unwrap(),
596 MKMapNode::Tree(..)
597 ));
598
599 mk_map
600 .replace(block_range_replacement.clone(), same_root_value)
601 .unwrap();
602
603 assert_eq!(mk_map_root_expected, mk_map.compute_root().unwrap());
604 assert!(matches!(
605 mk_map.get(&block_range_replacement).unwrap(),
606 MKMapNode::TreeNode(..)
607 ));
608 }
609
610 #[test]
611 fn test_mk_map_replace_should_reject_replacement_if_key_doesnt_exist() {
612 let entries = generate_merkle_trees_for_ranges(&[
613 BlockRange::new(0, 3),
614 BlockRange::new(4, 6),
615 BlockRange::new(7, 9),
616 ]);
617 let mut mk_map =
618 MKMap::<_, _, MKTreeStoreInMemory>::new(&into_mkmap_tree_entries(entries)).unwrap();
619
620 let error = mk_map
621 .replace(
622 BlockRange::new(10, 12),
623 MKMapNode::TreeNode("whatever".into()),
624 )
625 .expect_err("the MKMap should reject replacement for nonexisting key");
626
627 assert!(
628 error.to_string().contains("MKMap could not replace non-existing key"),
629 "Invalid error message: `{error}`",
630 );
631 }
632
633 #[test]
634 fn test_mk_map_replace_should_reject_replacement_with_different_root_value() {
635 let entries = generate_merkle_trees_for_ranges(&[
636 BlockRange::new(0, 3),
637 BlockRange::new(4, 6),
638 BlockRange::new(7, 9),
639 ]);
640 let mut mk_map =
641 MKMap::<_, _, MKTreeStoreInMemory>::new(&into_mkmap_tree_entries(entries)).unwrap();
642
643 let error = mk_map
644 .replace(
645 BlockRange::new(0, 3),
646 MKMapNode::TreeNode("different_value".into()),
647 )
648 .expect_err("the MKMap should reject replacement with different root value");
649
650 assert!(
651 error
652 .to_string()
653 .contains("MKMap values should be replaced by entry with same root"),
654 "Invalid error message: `{error}`",
655 );
656 }
657
658 #[test]
659 fn test_mk_map_should_compress_correctly() {
660 let entries = generate_merkle_trees_for_ranges(&[
661 BlockRange::new(0, 3),
662 BlockRange::new(4, 6),
663 BlockRange::new(7, 9),
664 ]);
665 let mk_map =
666 MKMap::<_, _, MKTreeStoreInMemory>::new(&into_mkmap_tree_entries(entries)).unwrap();
667 let mk_map_root_expected = mk_map.compute_root().unwrap();
668 let mk_map_provable_keys = mk_map.get_provable_keys();
669 assert!(!mk_map_provable_keys.is_empty());
670
671 let mut mk_map_compressed = mk_map.clone();
672 mk_map_compressed.compress().unwrap();
673
674 let mk_map_compressed_root = mk_map_compressed.compute_root().unwrap();
675 let mk_map_compressed_provable_keys = mk_map_compressed.get_provable_keys();
676 assert_eq!(mk_map_root_expected, mk_map_compressed_root);
677 assert!(mk_map_compressed_provable_keys.is_empty());
678 }
679
680 #[test]
681 fn test_mk_map_should_reject_out_of_order_insertion() {
682 let entries = generate_merkle_trees_for_ranges(&[
683 BlockRange::new(0, 3),
684 BlockRange::new(4, 6),
685 BlockRange::new(7, 9),
686 ]);
687 let mut mk_map =
688 MKMap::<_, _, MKTreeStoreInMemory>::new(&into_mkmap_tree_node_entries(entries))
689 .unwrap();
690 let out_of_order_entry = (
691 BlockRange::new(0, 25),
692 MKMapNode::TreeNode("test-123".into()),
693 );
694
695 mk_map
696 .insert(out_of_order_entry.0, out_of_order_entry.1)
697 .expect_err("the MKMap should reject out of order insertion");
698 }
699
700 #[test]
701 fn test_mk_map_should_list_keys_correctly() {
702 let entries = generate_merkle_trees_for_ranges(&[
703 BlockRange::new(0, 3),
704 BlockRange::new(4, 6),
705 BlockRange::new(7, 9),
706 ]);
707 let merkle_tree_entries = &into_mkmap_tree_node_entries(entries);
708 let mk_map =
709 MKMap::<_, _, MKTreeStoreInMemory>::new(merkle_tree_entries.as_slice()).unwrap();
710
711 let keys = mk_map.iter().map(|(k, _v)| k.to_owned()).collect::<Vec<_>>();
712 let expected_keys = merkle_tree_entries
713 .iter()
714 .map(|(k, _)| k)
715 .cloned()
716 .collect::<Vec<_>>();
717
718 assert_eq!(expected_keys, keys);
719 }
720
721 #[test]
722 fn test_mk_map_should_list_values_correctly() {
723 let entries = generate_merkle_trees_for_ranges(&[
724 BlockRange::new(0, 3),
725 BlockRange::new(4, 6),
726 BlockRange::new(7, 9),
727 ]);
728 let merkle_tree_entries = &into_mkmap_tree_node_entries(entries);
729 let mk_map =
730 MKMap::<_, _, MKTreeStoreInMemory>::new(merkle_tree_entries.as_slice()).unwrap();
731
732 let values = mk_map.iter().map(|(_k, v)| v.to_owned()).collect::<Vec<_>>();
733 let expected_values = merkle_tree_entries
734 .iter()
735 .map(|(_, v)| v)
736 .cloned()
737 .collect::<Vec<_>>();
738
739 assert_eq!(
740 BTreeSet::from_iter(expected_values.iter().map(|v| v.compute_root().unwrap())),
741 BTreeSet::from_iter(values.iter().map(|v| v.compute_root().unwrap()))
742 );
743 }
744
745 #[test]
746 fn test_mk_map_should_find_value_correctly() {
747 let entries = generate_merkle_trees_for_ranges(&[
748 BlockRange::new(0, 3),
749 BlockRange::new(4, 6),
750 BlockRange::new(7, 9),
751 ]);
752 let mktree_node_to_certify = entries[2].1.leaves()[1].clone();
753 let mk_map_full =
754 MKMap::<_, _, MKTreeStoreInMemory>::new(&into_mkmap_tree_entries(entries)).unwrap();
755
756 mk_map_full.contains(&mktree_node_to_certify).unwrap();
757 }
758
759 #[test]
760 fn test_mk_map_should_clone_and_compute_same_root() {
761 let entries = generate_merkle_trees_for_ranges(&[
762 BlockRange::new(0, 3),
763 BlockRange::new(4, 6),
764 BlockRange::new(7, 9),
765 ]);
766 let mk_map =
767 MKMap::<_, _, MKTreeStoreInMemory>::new(&into_mkmap_tree_entries(entries)).unwrap();
768
769 let mk_map_clone = mk_map.clone();
770
771 assert_eq!(
772 mk_map.compute_root().unwrap(),
773 mk_map_clone.compute_root().unwrap(),
774 );
775 }
776
777 #[test]
778 fn test_mk_map_should_not_compute_proof_for_no_leaves() {
779 let entries = generate_merkle_trees(10, 3);
780 let mktree_nodes_to_certify: &[MKTreeNode] = &[];
781 let mk_map_full =
782 MKMap::<_, _, MKTreeStoreInMemory>::new(&into_mkmap_tree_entries(entries)).unwrap();
783
784 mk_map_full
785 .compute_proof(mktree_nodes_to_certify)
786 .expect_err("MKMap should not compute proof for no leaves");
787 }
788
789 #[test]
790 fn test_mk_map_should_compute_and_verify_valid_proof() {
791 let entries = generate_merkle_trees(10, 3);
792 let mktree_nodes_to_certify = [
793 entries[0].1.leaves()[0].clone(),
794 entries[1].1.leaves()[0].clone(),
795 entries[1].1.leaves()[1].clone(),
796 entries[2].1.leaves()[1].clone(),
797 ];
798 let mk_map_full =
799 MKMap::<_, _, MKTreeStoreInMemory>::new(&into_mkmap_tree_entries(entries)).unwrap();
800 let mk_map_proof = mk_map_full.compute_proof(&mktree_nodes_to_certify).unwrap();
801
802 mk_map_proof.verify().unwrap();
803
804 let map_proof_root = mk_map_proof.compute_root();
805 let map_proof_root_expected = mk_map_full.compute_root().unwrap();
806 assert_eq!(map_proof_root, map_proof_root_expected);
807
808 let mk_proof_leaves = mk_map_proof.leaves();
809 assert_eq!(mktree_nodes_to_certify.to_vec(), mk_proof_leaves);
810 }
811
812 #[test]
813 fn test_mk_map_should_serialize_deserialize_proof() {
814 let entries = generate_merkle_trees(10, 3);
815 let mktree_nodes_to_certify = [
816 entries[0].1.leaves()[0].clone(),
817 entries[1].1.leaves()[0].clone(),
818 entries[1].1.leaves()[1].clone(),
819 entries[2].1.leaves()[1].clone(),
820 ];
821 let mk_map_full =
822 MKMap::<_, _, MKTreeStoreInMemory>::new(&into_mkmap_tree_entries(entries)).unwrap();
823 let mk_map_proof = mk_map_full.compute_proof(&mktree_nodes_to_certify).unwrap();
824
825 let serialized_mk_map_proof =
826 mk_map_proof.to_bytes().expect("Serialization should not fail");
827 let deserialized_mk_map_proof =
828 MKMapProof::<BlockRange>::from_bytes(&serialized_mk_map_proof)
829 .expect("Deserialization should not fail");
830 assert_eq!(
831 mk_map_proof, deserialized_mk_map_proof,
832 "Deserialized proof should match the original"
833 );
834 }
835
836 #[test]
837 fn test_mk_map_should_compute_and_verify_valid_proof_recursively() {
838 let entries = generate_merkle_trees(100, 3);
839 let mktree_nodes_to_certify = [
840 entries[0].1.leaves()[0].clone(),
841 entries[2].1.leaves()[1].clone(),
842 entries[3].1.leaves()[2].clone(),
843 entries[20].1.leaves()[0].clone(),
844 entries[30].1.leaves()[0].clone(),
845 ];
846 let merkle_tree_node_entries = &into_mkmap_tree_entries(entries)
847 .chunks(10)
848 .map(|entries| {
849 (
850 entries.iter().fold(BlockRange::new(0, 0), |acc, (range, _)| {
851 acc.try_add(range).unwrap()
852 }),
853 MKMapNode::Map(Arc::new(MKMap::new(entries).unwrap())),
854 )
855 })
856 .collect::<Vec<_>>();
857
858 let mk_map_full =
859 MKMap::<_, _, MKTreeStoreInMemory>::new(merkle_tree_node_entries.as_slice()).unwrap();
860
861 let mk_map_proof = mk_map_full.compute_proof(&mktree_nodes_to_certify).unwrap();
862
863 mk_map_proof.verify().unwrap();
864
865 let map_proof_root = mk_map_proof.compute_root();
866 let map_proof_root_expected = mk_map_full.compute_root().unwrap();
867 assert_eq!(map_proof_root, map_proof_root_expected);
868 }
869}