Merge pull request #122 from zcash/release/shardtree-v0.3.2

Release `shardtree v0.3.2`
zcash · Dec 10, 2024 · 9ea3466 · 9ea3466
2 parents c8ce5ef + 63cbc0a
commit 9ea3466
Show file tree

Hide file tree

Showing 5 changed files with 13 additions and 2 deletions.
diff --git a/Cargo.lock b/Cargo.lock
diff --git a/shardtree/CHANGELOG.md b/shardtree/CHANGELOG.md
@@ -7,6 +7,9 @@ and this project adheres to Rust's notion of
 
 ## Unreleased
 
+## [0.3.2] - 2024-12-09
+- Replaces `unwrap` calls with `expect` calls & documents panics.
+
 ## [0.3.1] - 2024-04-03
 
 ### Fixed

diff --git a/shardtree/Cargo.toml b/shardtree/Cargo.toml
@@ -1,6 +1,6 @@
 [package]
 name = "shardtree"
-version = "0.3.1"
+version = "0.3.2"
 authors = [
     "Kris Nuttycombe <[email protected]>",
 ]

diff --git a/shardtree/src/legacy.rs b/shardtree/src/legacy.rs
@@ -167,6 +167,10 @@ impl<H: Hashable + Clone + PartialEq> LocatedPrunableTree<H> {
     ///
     /// Returns a copy of this tree updated to include the witness nodes, any partial supertree that is
     /// produced from nodes "higher" in the witness tree
+    ///
+    /// # Panics
+    ///
+    /// Panics if `witness` corresponds to the empty tree.
     pub fn insert_witness_nodes<C, const DEPTH: u8>(
         &self,
         witness: IncrementalWitness<H, DEPTH>,

diff --git a/shardtree/src/lib.rs b/shardtree/src/lib.rs
@@ -391,6 +391,10 @@ impl<
     }
 
     /// Adds a checkpoint at the rightmost leaf state of the tree.
+    ///
+    /// # Panics
+    ///
+    /// Panics if `root` represents a parent node but `root_addr` is a depth-0 leaf address.
     pub fn checkpoint(&mut self, checkpoint_id: C) -> Result<bool, ShardTreeError<S::Error>> {
         /// Pre-condition: `root_addr` must be the address of `root`.
         fn go<H: Hashable + Clone + PartialEq>(