add comment to verify function

keep-starknet-strange · Oct 14, 2024 · 7790977 · 7790977
1 parent c0e4469
commit 7790977
Showing 1 changed file with 2 additions and 1 deletion.
diff --git a/packages/utreexo/src/stump/accumulator.cairo b/packages/utreexo/src/stump/accumulator.cairo
@@ -3,13 +3,14 @@ use crate::stump::proof::{UtreexoBatchProof, UtreexoBatchProofTrait};
 
 #[generate_trait]
 pub impl StumpUtreexoAccumulatorImpl of StumpUtreexoAccumulator {
-    /// Adds multiple items to the accumulator
+    /// Adds multiple items to the accumulator.
     fn add(self: @UtreexoStumpState, hashes: Span<felt252>) -> UtreexoStumpState {
         // TODO: check if vanilla implementation is compatible with rustreexo, add tests
         // https://github.com/mit-dci/rustreexo/blob/6a8fe53fa545df8f1a30733fa6ca9f7b0077d051/src/accumulator/stump.rs#L252
         *self
     }
 
+    /// Verifies that one or multiple leaves hashes are part of the utreexo forest given a proof.
     fn verify(
         self: @UtreexoStumpState, proof: @UtreexoBatchProof, del_hashes: Span<felt252>
     ) -> Result<(), ByteArray> {