github/darkfi
1
1
Fork 0
mirror of https://github.com/darkrenaissance/darkfi.git synced 2026-01-09 14:48:08 -05:00
Code Issues Packages Projects Releases Wiki Activity

smt: add terminology doc

Browse Source
This commit is contained in:
zero
2024-03-12 13:10:21 +01:00
parent 24212a6f77
commit f92b55d16e
1 changed files with 10 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
src/sdk/src/crypto/smt.rs
View File

@@ -47,6 +47,16 @@
//! is our Sparse Merkle tree, and `a` through `g` are field elements stored at
//! the nodes. Then the merkle proof path `e-b-a` from leaf `e` to root `a` is
//! stored as `[(d,e), (b,c)]`
//!
//! # Terminology
//!
//! * **level** - the depth in the tree. Type: `u32`
//! * **location** - a `(level, position)` tuple
//! * **position** - the leaf index, or equivalently the binary direction through the tree
//! with type `F`.
//! * **index** - the internal index used in the DB which is `BigUint`. Leaf node indexes are
//! calculated as `leaf_idx = final_level_start_idx + position`.
//! * **node** - either the leaf values or parent nodes `hash(left, right)`.
use core::marker::PhantomData;
use std::collections::{BTreeMap, BTreeSet};