miden-crypto/src/merkle/simple_smt/tests.rs
src/merkle/simple_smt/tests.rsRaw
1use super::{
2 super::{MerkleTree, RpoDigest, SimpleSmt},
3 Rpo256, Vec, Word,
4};
5use crate::{Felt, FieldElement};
6use core::iter;
7use proptest::prelude::*;
8use rand_utils::prng_array;
9
10const KEYS4: [u64; 4] = [0, 1, 2, 3];
11const KEYS8: [u64; 8] = [0, 1, 2, 3, 4, 5, 6, 7];
12
13const VALUES4: [Word; 4] = [
14 int_to_node(1),
15 int_to_node(2),
16 int_to_node(3),
17 int_to_node(4),
18];
19
20const VALUES8: [Word; 8] = [
21 int_to_node(1),
22 int_to_node(2),
23 int_to_node(3),
24 int_to_node(4),
25 int_to_node(5),
26 int_to_node(6),
27 int_to_node(7),
28 int_to_node(8),
29];
30
31const ZERO_VALUES8: [Word; 8] = [int_to_node(0); 8];
32
33#[test]
34fn build_empty_tree() {
35 let smt = SimpleSmt::new(iter::empty(), 3).unwrap();
36 let mt = MerkleTree::new(ZERO_VALUES8.to_vec()).unwrap();
37 assert_eq!(mt.root(), smt.root());
38}
39
40#[test]
41fn empty_digests_are_consistent() {
42 let depth = 5;
43 let root = SimpleSmt::new(iter::empty(), depth).unwrap().root();
44 let computed: [RpoDigest; 2] = (0..depth).fold([Default::default(); 2], |state, _| {
45 let digest = Rpo256::merge(&state);
46 [digest; 2]
47 });
48
49 assert_eq!(Word::from(computed[0]), root);
50}
51
52#[test]
53fn build_sparse_tree() {
54 let mut smt = SimpleSmt::new(iter::empty(), 3).unwrap();
55 let mut values = ZERO_VALUES8.to_vec();
56
57 // insert single value
58 let key = 6;
59 let new_node = int_to_node(7);
60 values[key as usize] = new_node;
61 smt.insert_leaf(key, new_node)
62 .expect("Failed to insert leaf");
63 let mt2 = MerkleTree::new(values.clone()).unwrap();
64 assert_eq!(mt2.root(), smt.root());
65 assert_eq!(mt2.get_path(3, 6).unwrap(), smt.get_path(3, 6).unwrap());
66
67 // insert second value at distinct leaf branch
68 let key = 2;
69 let new_node = int_to_node(3);
70 values[key as usize] = new_node;
71 smt.insert_leaf(key, new_node)
72 .expect("Failed to insert leaf");
73 let mt3 = MerkleTree::new(values).unwrap();
74 assert_eq!(mt3.root(), smt.root());
75 assert_eq!(mt3.get_path(3, 2).unwrap(), smt.get_path(3, 2).unwrap());
76}
77
78#[test]
79fn build_full_tree() {
80 let tree = SimpleSmt::new(KEYS4.into_iter().zip(VALUES4.into_iter()), 2).unwrap();
81
82 let (root, node2, node3) = compute_internal_nodes();
83 assert_eq!(root, tree.root());
84 assert_eq!(node2, tree.get_node(1, 0).unwrap());
85 assert_eq!(node3, tree.get_node(1, 1).unwrap());
86}
87
88#[test]
89fn get_values() {
90 let tree = SimpleSmt::new(KEYS4.into_iter().zip(VALUES4.into_iter()), 2).unwrap();
91
92 // check depth 2
93 assert_eq!(VALUES4[0], tree.get_node(2, 0).unwrap());
94 assert_eq!(VALUES4[1], tree.get_node(2, 1).unwrap());
95 assert_eq!(VALUES4[2], tree.get_node(2, 2).unwrap());
96 assert_eq!(VALUES4[3], tree.get_node(2, 3).unwrap());
97}
98
99#[test]
100fn get_path() {
101 let tree = SimpleSmt::new(KEYS4.into_iter().zip(VALUES4.into_iter()), 2).unwrap();
102
103 let (_, node2, node3) = compute_internal_nodes();
104
105 // check depth 2
106 assert_eq!(vec![VALUES4[1], node3], tree.get_path(2, 0).unwrap());
107 assert_eq!(vec![VALUES4[0], node3], tree.get_path(2, 1).unwrap());
108 assert_eq!(vec![VALUES4[3], node2], tree.get_path(2, 2).unwrap());
109 assert_eq!(vec![VALUES4[2], node2], tree.get_path(2, 3).unwrap());
110
111 // check depth 1
112 assert_eq!(vec![node3], tree.get_path(1, 0).unwrap());
113 assert_eq!(vec![node2], tree.get_path(1, 1).unwrap());
114}
115
116#[test]
117fn update_leaf() {
118 let mut tree = SimpleSmt::new(KEYS8.into_iter().zip(VALUES8.into_iter()), 3).unwrap();
119
120 // update one value
121 let key = 3;
122 let new_node = int_to_node(9);
123 let mut expected_values = VALUES8.to_vec();
124 expected_values[key] = new_node;
125 let expected_tree = SimpleSmt::new(
126 KEYS8.into_iter().zip(expected_values.clone().into_iter()),
127 3,
128 )
129 .unwrap();
130
131 tree.update_leaf(key as u64, new_node).unwrap();
132 assert_eq!(expected_tree.root, tree.root);
133
134 // update another value
135 let key = 6;
136 let new_node = int_to_node(10);
137 expected_values[key] = new_node;
138 let expected_tree =
139 SimpleSmt::new(KEYS8.into_iter().zip(expected_values.into_iter()), 3).unwrap();
140
141 tree.update_leaf(key as u64, new_node).unwrap();
142 assert_eq!(expected_tree.root, tree.root);
143}
144
145#[test]
146fn small_tree_opening_is_consistent() {
147 // ____k____
148 // / \
149 // _i_ _j_
150 // / \ / \
151 // e f g h
152 // / \ / \ / \ / \
153 // a b 0 0 c 0 0 d
154
155 let z = Word::from(RpoDigest::default());
156
157 let a = Word::from(Rpo256::merge(&[z.into(); 2]));
158 let b = Word::from(Rpo256::merge(&[a.into(); 2]));
159 let c = Word::from(Rpo256::merge(&[b.into(); 2]));
160 let d = Word::from(Rpo256::merge(&[c.into(); 2]));
161
162 let e = Word::from(Rpo256::merge(&[a.into(), b.into()]));
163 let f = Word::from(Rpo256::merge(&[z.into(), z.into()]));
164 let g = Word::from(Rpo256::merge(&[c.into(), z.into()]));
165 let h = Word::from(Rpo256::merge(&[z.into(), d.into()]));
166
167 let i = Word::from(Rpo256::merge(&[e.into(), f.into()]));
168 let j = Word::from(Rpo256::merge(&[g.into(), h.into()]));
169
170 let k = Word::from(Rpo256::merge(&[i.into(), j.into()]));
171
172 let depth = 3;
173 let entries = vec![(0, a), (1, b), (4, c), (7, d)];
174 let tree = SimpleSmt::new(entries, depth).unwrap();
175
176 assert_eq!(tree.root(), Word::from(k));
177
178 let cases: Vec<(u32, u64, Vec<Word>)> = vec![
179 (3, 0, vec![b, f, j]),
180 (3, 1, vec![a, f, j]),
181 (3, 4, vec![z, h, i]),
182 (3, 7, vec![z, g, i]),
183 (2, 0, vec![f, j]),
184 (2, 1, vec![e, j]),
185 (2, 2, vec![h, i]),
186 (2, 3, vec![g, i]),
187 (1, 0, vec![j]),
188 (1, 1, vec![i]),
189 ];
190
191 for (depth, key, path) in cases {
192 let opening = tree.get_path(depth, key).unwrap();
193
194 assert_eq!(path, opening);
195 }
196}
197
198proptest! {
199 #[test]
200 fn arbitrary_openings_single_leaf(
201 depth in SimpleSmt::MIN_DEPTH..SimpleSmt::MAX_DEPTH,
202 key in prop::num::u64::ANY,
203 leaf in prop::num::u64::ANY,
204 ) {
205 let mut tree = SimpleSmt::new(iter::empty(), depth).unwrap();
206
207 let key = key % (1 << depth as u64);
208 let leaf = int_to_node(leaf);
209
210 tree.insert_leaf(key, leaf.into()).unwrap();
211 tree.get_leaf_path(key).unwrap();
212
213 // traverse to root, fetching all paths
214 for d in 1..depth {
215 let k = key >> (depth - d);
216 tree.get_path(d, k).unwrap();
217 }
218 }
219
220 #[test]
221 fn arbitrary_openings_multiple_leaves(
222 depth in SimpleSmt::MIN_DEPTH..SimpleSmt::MAX_DEPTH,
223 count in 2u8..10u8,
224 ref seed in any::<[u8; 32]>()
225 ) {
226 let mut tree = SimpleSmt::new(iter::empty(), depth).unwrap();
227 let mut seed = *seed;
228 let leaves = (1 << depth) - 1;
229
230 for _ in 0..count {
231 seed = prng_array(seed);
232
233 let mut key = [0u8; 8];
234 let mut leaf = [0u8; 8];
235
236 key.copy_from_slice(&seed[..8]);
237 leaf.copy_from_slice(&seed[8..16]);
238
239 let key = u64::from_le_bytes(key);
240 let key = key % leaves;
241 let leaf = u64::from_le_bytes(leaf);
242 let leaf = int_to_node(leaf);
243
244 tree.insert_leaf(key, leaf).unwrap();
245 tree.get_leaf_path(key).unwrap();
246 }
247 }
248}
249
250// HELPER FUNCTIONS
251// --------------------------------------------------------------------------------------------
252
253fn compute_internal_nodes() -> (Word, Word, Word) {
254 let node2 = Rpo256::hash_elements(&[VALUES4[0], VALUES4[1]].concat());
255 let node3 = Rpo256::hash_elements(&[VALUES4[2], VALUES4[3]].concat());
256 let root = Rpo256::merge(&[node2, node3]);
257
258 (root.into(), node2.into(), node3.into())
259}
260
261const fn int_to_node(value: u64) -> Word {
262 [Felt::new(value), Felt::ZERO, Felt::ZERO, Felt::ZERO]
263}