From 89e93e5a9897bc30c0cb7788a0400d79cd68fa81 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Grzegorz=20=C5=9Awirski?= Date: Wed, 16 Apr 2025 11:33:16 +0200 Subject: [PATCH] clarify that SparseMerklePath can store up to SMT_MAX_DEPTH nodes total --- miden-crypto/src/merkle/sparse_path.rs | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/miden-crypto/src/merkle/sparse_path.rs b/miden-crypto/src/merkle/sparse_path.rs index 8095452..cad3f04 100644 --- a/miden-crypto/src/merkle/sparse_path.rs +++ b/miden-crypto/src/merkle/sparse_path.rs @@ -14,10 +14,10 @@ use super::{ /// with empty nodes. /// /// Empty nodes in the path are stored only as their position, represented with a bitmask. A -/// maximum of 64 nodes in the path can be empty. The more nodes in a path are empty, the less -/// memory this struct will use. This type calculates empty nodes on-demand when iterated through, -/// converted to a [MerklePath], or an empty node is retrieved with [`SparseMerklePath::at_idx()`] -/// or [`SparseMerklePath::at_depth()`], which will incur overhead. +/// maximum of 64 nodes (`SMT_MAX_DEPTH`) can be stored (empty and non-empty). The more nodes in a +/// path are empty, the less memory this struct will use. This type calculates empty nodes on-demand +/// when iterated through, converted to a [MerklePath], or an empty node is retrieved with +/// [`SparseMerklePath::at_idx()`] or [`SparseMerklePath::at_depth()`], which will incur overhead. /// /// NOTE: This type assumes that Merkle paths always span from the root of the tree to a leaf. /// Partial paths are not supported.