Add docs for scan_block

ZcashFoundation · Nov 24, 2023 · 285a474 · 285a474
1 parent a43e806
commit 285a474
Showing 1 changed file with 6 additions and 0 deletions.
diff --git a/zebra-scan/src/tests.rs b/zebra-scan/src/tests.rs
@@ -510,6 +510,12 @@ fn random_compact_tx(mut rng: impl RngCore) -> CompactTx {
     ctx
 }
 
+/// Returns transactions belonging to any of the given [`ScanningKey`]s.
+///
+/// TODO:
+/// - Remove the `sapling_tree_size` parameter or turn it into an `Option` once we have access to
+/// Zebra's state, and we can retrieve the tree size ourselves.
+/// - Add prior block metadata once we have access to Zebra's state.
 fn scan_block<K: ScanningKey>(
     network: Network,
     block: Arc<Block>,