zec
/
incrementalmerkletree
mirror of https://github.com/zcash/incrementalmerkletree.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

shardtree: Correct erroneous `ShardStore::get_checkpoint_at_depth` documentation

This commit is contained in:
Kris Nuttycombe 2023-11-03 11:09:11 -06:00
parent 8d301a14dd
commit b2c5cd9fc4
1 changed files with 3 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
shardtree/src/store.rs
View File

@ -96,9 +96,9 @@ pub trait ShardStore {
/// Returns the number of checkpoints maintained by the data store
fn checkpoint_count(&self) -> Result<usize, Self::Error>;
/// Returns the position of the checkpoint, if any, along with the number of subsequent
/// checkpoints at the same position. Returns `None` if `checkpoint_depth == 0` or if
/// insufficient checkpoints exist to seek back to the requested depth.
/// Returns the id and position of the checkpoint, if any. Returns `None` if
/// `checkpoint_depth == 0` or if insufficient checkpoints exist to seek back
/// to the requested depth.
fn get_checkpoint_at_depth(
&self,
checkpoint_depth: usize,