Merge pull request #961 from fluidvanadium/add_comments

add comments

zingolib/src/blaze/block_management_reorg_detection.rs

@@ -36,7 +36,7 @@ type Node<D> = <<D as DomainWalletExt>::WalletNote as ShieldedNoteInterface>::No
 const ORCHARD_START: &str = "000000";
 /// The data relating to the blocks in the current batch
 pub struct BlockManagementData {
-    // List of all downloaded blocks in the current batch and
+    // List of all downloaded Compact Blocks in the current batch and
     // their hashes/commitment trees. Stored with the tallest
     // block first, and the shortest last.
     blocks_in_current_batch: Arc<RwLock<Vec<BlockData>>>,
@@ -447,13 +447,19 @@ impl BlockManagementData {
         self.wait_for_block(after_height).await;
 
         {
-            // Read Lock
+            // Read Lock for the Block Cache
             let blocks = self.blocks_in_current_batch.read().await;
+            // take the height of the first/highest block in the batch and subtract target height to get index into the block list
             let pos = blocks.first().unwrap().height - after_height;
             match nf {
                 PoolNullifier::Sapling(nf) => {
                     let nf = nf.to_vec();
 
+                    // starting with a block and searching until the top of the batch
+                    //     if this block contains a transaction
+                    //         that contains a spent
+                    //             with the given nullifier
+                    //                 return its height
                     for i in (0..pos + 1).rev() {
                         let cb = &blocks.get(i as usize).unwrap().cb();
                         for compact_transaction in &cb.vtx {

zingolib/src/blaze/update_notes.rs

@@ -115,6 +115,8 @@ impl UpdateNotes {
                         .await
                     {
                         //info!("Note was spent, just add it as spent for TxId {}", txid);
+                        // we got the height the nullifier was spent at. now, we go back to the index because we need to read from that CompactTx.
+                        // This can only happen after BlazeSyncData has been downloaded into the LightClient from the server and stored asyncronously.
                         let (compact_transaction, ts) = bsync_data
                             .read()
                             .await

zingolib/src/wallet/transactions.rs

@@ -1,4 +1,7 @@
-//! Functionality for managing transactions
+//! This mod should be called tx_map_and_maybe_trees.rs. it contains
+//! struct TxMapAndMaybeTrees
+//! implementations for TxMapAndMaybeTrees
+//! associated types for TxMapAndMaybeTrees that have no relevance elsewhere.
 
 use crate::wallet::{data::WitnessTrees, transaction_records_by_id::TransactionRecordsById};
 

zingolib/src/wallet/transactions/get.rs

@@ -1,3 +1,6 @@
+//! contains associated methods for asking TxMapAndMaybeTrees about the data it contains
+//! Does not contain trait implementations
+
 use zcash_note_encryption::Domain;
 use zcash_primitives::{consensus::BlockHeight, transaction::TxId};
 

zingolib/src/wallet/transactions/read_write.rs

@@ -1,3 +1,5 @@
+//! contains associated methods for writing TxMapAndMaybeTrees to disk and reading TxMapAndMaybeTrees from disk
+
 use byteorder::{LittleEndian, ReadBytesExt, WriteBytesExt};
 use std::{
     collections::HashMap,

zingolib/src/wallet/transactions/recording.rs

@@ -1,3 +1,5 @@
+//! contains associated methods for modifying and updating TxMapAndMaybeTrees
+
 use incrementalmerkletree::Position;
 use orchard::note_encryption::OrchardDomain;
 use sapling_crypto::note_encryption::SaplingDomain;