monotree 0.4.0

Rust implementation of an optimized Sparse Merkle Tree
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332

use monotree::database::{rocksdb::RocksDB, sled::Sled, MemoryDB};
use monotree::hasher::*;
use monotree::utils::*;
use monotree::*;
use std::fs;
extern crate paste;
extern crate scopeguard;

fn insert_keys_then_verify_values<D: Database, H: Hasher>(
    mut tree: Monotree<D, H>,
    _hasher: &H,
    mut root: Option<Hash>,
    keys: &[Hash],
    leaves: &[Hash],
) -> Result<()> {
    for (i, (key, value)) in keys.iter().zip(leaves.iter()).enumerate() {
        // insert a key into tree
        root = tree.insert(root.as_ref(), key, value)?;

        // check if the key-value pair was correctly inserted so far
        for (k, v) in keys.iter().zip(leaves.iter()).take(i + 1) {
            assert_eq!(tree.get(root.as_ref(), k)?, Some(*v));
        }
    }
    assert_ne!(root, None);
    Ok(())
}

fn insert_keys_then_gen_and_verify_proof<D: Database, H: Hasher>(
    mut tree: Monotree<D, H>,
    hasher: &H,
    mut root: Option<Hash>,
    keys: &[Hash],
    leaves: &[Hash],
) -> Result<()> {
    for (i, (key, value)) in keys.iter().zip(leaves.iter()).enumerate() {
        // insert a key into tree
        root = tree.insert(root.as_ref(), key, value)?;

        // generate and verify Merkle proof with all keys so far
        for (k, v) in keys.iter().zip(leaves.iter()).take(i + 1) {
            let proof = tree.get_merkle_proof(root.as_ref(), k)?;
            assert_eq!(
                tree::verify_proof(hasher, root.as_ref(), v, proof.as_ref()),
                true
            );
        }
    }
    assert_ne!(root, None);
    Ok(())
}

fn insert_keys_then_delete_keys_in_order<D: Database, H: Hasher>(
    mut tree: Monotree<D, H>,
    hasher: &H,
    mut root: Option<Hash>,
    keys: &[Hash],
    leaves: &[Hash],
) -> Result<()> {
    // pre-insertion for removal test
    root = tree.inserts(root.as_ref(), keys, leaves)?;

    // removal test with keys in order
    for (i, (key, _)) in keys.iter().zip(leaves.iter()).enumerate() {
        assert_ne!(root, None);
        // assert that all other values are fine after deletion
        for (k, v) in keys.iter().zip(leaves.iter()).skip(i) {
            assert_eq!(tree.get(root.as_ref(), k)?, Some(*v));
            let proof = tree.get_merkle_proof(root.as_ref(), k)?;
            assert_eq!(
                tree::verify_proof(hasher, root.as_ref(), v, proof.as_ref()),
                true
            );
        }

        // delete a key and check if it worked
        root = tree.remove(root.as_ref(), key)?;
        assert_eq!(tree.get(root.as_ref(), key)?, None);
    }
    // back to inital state of tree
    assert_eq!(root, None);
    Ok(())
}

fn insert_keys_then_delete_keys_reversely<D: Database, H: Hasher>(
    mut tree: Monotree<D, H>,
    hasher: &H,
    mut root: Option<Hash>,
    keys: &[Hash],
    leaves: &[Hash],
) -> Result<()> {
    // pre-insertion for removal test
    root = tree.inserts(root.as_ref(), keys, leaves)?;

    // removal test with keys in reverse order
    for (i, (key, _)) in keys.iter().zip(leaves.iter()).rev().enumerate() {
        assert_ne!(root, None);

        // assert that all other values are fine after deletion
        for (k, v) in keys.iter().zip(leaves.iter()).rev().skip(i) {
            assert_eq!(tree.get(root.as_ref(), k)?, Some(*v));
            let proof = tree.get_merkle_proof(root.as_ref(), k)?;
            assert_eq!(
                tree::verify_proof(hasher, root.as_ref(), v, proof.as_ref()),
                true
            );
        }

        // delete a key and check if it worked
        root = tree.remove(root.as_ref(), key)?;
        assert_eq!(tree.get(root.as_ref(), key)?, None);
    }
    // back to inital state of tree
    assert_eq!(root, None);
    Ok(())
}

fn insert_keys_then_delete_keys_randomly<D: Database, H: Hasher>(
    mut tree: Monotree<D, H>,
    hasher: &H,
    mut root: Option<Hash>,
    keys: &[Hash],
    leaves: &[Hash],
) -> Result<()> {
    // pre-insertion for removal test
    root = tree.inserts(root.as_ref(), keys, leaves)?;

    // shuffles keys/leaves' index for imitating random-access
    let mut idx: Vec<usize> = (0..keys.len()).collect();
    shuffle(&mut idx);

    //test with shuffled keys
    for (n, i) in idx.iter().enumerate() {
        assert_ne!(root, None);

        // assert that all values are fine after deletion
        for j in idx.iter().skip(n) {
            assert_eq!(tree.get(root.as_ref(), &keys[*j])?, Some(leaves[*j]));
            let proof = tree.get_merkle_proof(root.as_ref(), &keys[*j])?;
            assert_eq!(
                tree::verify_proof(hasher, root.as_ref(), &leaves[*j], proof.as_ref()),
                true
            );
        }
        // delete a key by random index and check if it worked
        root = tree.remove(root.as_ref(), &keys[*i])?;
        assert_eq!(tree.get(root.as_ref(), &leaves[*i])?, None);
    }
    // back to inital state of tree
    assert_eq!(root, None);
    Ok(())
}

fn insert_keys_then_delete_keys_immediately<D: Database, H: Hasher>(
    mut tree: Monotree<D, H>,
    _hasher: &H,
    mut root: Option<Hash>,
    keys: &[Hash],
    leaves: &[Hash],
) -> Result<()> {
    for (key, value) in keys.iter().zip(leaves.iter()) {
        // insert a key into tree
        root = tree.insert(root.as_ref(), key, value)?;
        // check if the key-value pair was correctly inserted
        assert_eq!(tree.get(root.as_ref(), key)?, Some(*value));

        // delete the key inserted just before
        root = tree.remove(root.as_ref(), key)?;
        // check if the key-value pair was correctly deleted
        assert_eq!(tree.get(root.as_ref(), key)?, None);
        // must be inital state of tree
        assert_eq!(root, None);
    }
    Ok(())
}

fn same_root_regardless_of_insertion_order<D: Database, H: Hasher>(
    mut tree: Monotree<D, H>,
    _hasher: &H,
    mut root: Option<Hash>,
    keys: &[Hash],
    leaves: &[Hash],
) -> Result<()> {
    for by in (1..64).chain(64..keys.len() + 1).step_by(10) {
        let k = &keys[0..by];
        let v = &leaves[0..by];

        // insert in original order
        root = tree.inserts(root.as_ref(), k, v)?;
        let root_inorder = root.unwrap();

        // remove all to get back to empty tree
        for key in k.iter() {
            root = tree.remove(root.as_ref(), key)?;
        }
        assert_eq!(root, None);

        // shuffle indices for different insertion order
        let mut idx: Vec<usize> = (0..k.len()).collect();
        shuffle(&mut idx);

        // insert in different order
        for &i in &idx {
            root = tree.insert(root.as_ref(), &k[i], &v[i])?;
        }
        let root_shuffled = root.unwrap();

        // assert same root regardless of insertion order
        assert_eq!(root_inorder, root_shuffled);

        // prepare for next test
        for key in k.iter() {
            root = tree.remove(root.as_ref(), key)?;
        }
        assert_eq!(root, None);
    }
    Ok(())
}
fn same_root_regardless_of_deletion_order<D: Database, H: Hasher>(
    mut tree: Monotree<D, H>,
    _hasher: &H,
    mut root: Option<Hash>,
    keys: &[Hash],
    leaves: &[Hash],
) -> Result<()> {
    // populate the trie for deletion test
    root = tree.inserts(root.as_ref(), keys, leaves)?;
    let root_orig = root;

    for by in (1..64).chain(64..keys.len() + 1).step_by(10) {
        let k = &keys[0..by];
        let v = &leaves[0..by];

        // remove keys in original order
        root = tree.removes(root.as_ref(), k)?;
        let root_inorder = root.unwrap();

        // back to the previous state
        root = tree.inserts(root.as_ref(), k, v)?;
        assert_eq!(root, root_orig);

        // shuffle indices for different deletion order
        let mut idx: Vec<usize> = (0..k.len()).collect();
        shuffle(&mut idx);

        // delete keys in different order
        for &i in &idx {
            root = tree.remove(root.as_ref(), &k[i])?;
        }
        let root_shuffled = root.unwrap();

        // assert same root regardless of deletion order
        assert_eq!(root_inorder, root_shuffled);

        // prepare for next test
        root = root_orig;
    }
    Ok(())
}

macro_rules! impl_integration_test {
    ($fn:ident, ($d:expr, $db:ident), ($h:expr, $hasher:ident), $n:expr) => {
        paste::item! {
            #[test]
            fn [<test_ $d _ $h _ $fn _ $n>]() -> Result<()> {
                let dbname = format!("/tmp/{}", hex!(random_bytes(4)));
                let _g = scopeguard::guard((), |_| {
                    if fs::metadata(&dbname).is_ok() {
                        fs::remove_dir_all(&dbname).unwrap()
                    }
                });
                let keys = random_hashes($n);
                let leaves = random_hashes($n);
                let tree = Monotree::<$db, $hasher>::new(&dbname);
                let hasher = $hasher::new();
                let root: Option<Hash> = None;
                $fn(tree, &hasher, root, &keys, &leaves)?;
                Ok(())
            }
        }
    };
}

macro_rules! impl_test_with_params {
    ([$($fn:tt)+], [$($db:tt)+], [$($hasher:tt)+], [$n:tt, $($ns:tt),*]) => {
        impl_test_with_params!([$($fn)+], [$($db)+], [$($hasher)+], [$n]);
        impl_test_with_params!([$($fn)+], [$($db)+], [$($hasher)+], [$($ns),*]);
    };

    ([$($fn:tt)+], [$($db:tt)+], [($($h:tt)+), $($hasher:tt),*], [$n:tt]) => {
        impl_test_with_params!([$($fn)+], [$($db)+], [($($h)+)], [$n]);
        impl_test_with_params!([$($fn)+], [$($db)+], [$($hasher),*], [$n]);
    };

    ([$($fn:tt)+], [($($d:tt)+), $($db:tt),*], [($($h:tt)+)], [$n:tt]) => {
        impl_test_with_params!([$($fn)+], [($($d)+)], [($($h)+)], [$n]);
        impl_test_with_params!([$($fn)+], [$($db),*], [($($h)+)], [$n]);
    };

    ([$f:tt, $($fn:tt),*], [($($d:tt)+)], [($($h:tt)+)], [$n:tt]) => {
        impl_integration_test!($f, ($($d)+), ($($h)+), $n);
        impl_test_with_params!([$($fn),*], [($($d)+)], [($($h)+)], [$n]);
    };

    ([$f:tt], [($($d:tt)+)], [($($h:tt)+)], [$n:tt]) => {
        impl_integration_test!($f, ($($d)+), ($($h)+), $n);
    };

    ($($other:tt)*) => {};
}

impl_test_with_params!(
    [
        insert_keys_then_verify_values,
        insert_keys_then_gen_and_verify_proof,
        insert_keys_then_delete_keys_immediately,
        insert_keys_then_delete_keys_in_order,
        insert_keys_then_delete_keys_reversely,
        insert_keys_then_delete_keys_randomly,
        same_root_regardless_of_insertion_order,
        same_root_regardless_of_deletion_order
    ],
    [("hashmap", MemoryDB), ("rocksdb", RocksDB), ("sled", Sled)],
    [
        ("blake3", Blake3),
        ("blake2s", Blake2s),
        ("blake2b", Blake2b),
        ("sha2", Sha2),
        ("sha3", Sha3)
    ],
    [100, 500, 1000]
);