better docs, fixed typos

Author: schell

zcash_client_backend/src/data_api/testing/pool.rs

@@ -3203,7 +3203,7 @@ pub fn zip317_spend<T: ShieldedPoolTester, Dsf: DataStoreFactory>(
     // Add funds to the wallet
     st.add_notes([Some(Zatoshis::const_from_u64(50000))]);
 
-    // Add 10 dust notes to the wallet
+    // Add 10 uneconomic (dust) notes to the wallet
     for _ in 1..=10 {
         st.add_notes([Some(Zatoshis::const_from_u64(1000))]);
     }
@@ -4458,8 +4458,6 @@ pub fn scan_cached_blocks_finds_received_notes<T: ShieldedPoolTester, Dsf>(
     );
 }
 
-// TODO: This test can probably be entirely removed, as the following test duplicates it entirely.
-// TODO(schell): ^still a valid todo?
 pub fn scan_cached_blocks_finds_change_notes<T: ShieldedPoolTester, Dsf>(
     ds_factory: Dsf,
     cache: impl TestCache,
@@ -4478,14 +4476,6 @@ pub fn scan_cached_blocks_finds_change_notes<T: ShieldedPoolTester, Dsf>(
     // Create a fake CompactBlock sending value to the address
     let value = Zatoshis::const_from_u64(50000);
     let (_, _, nf) = st.add_a_single_note(value);
-    // let (received_height, _, nf) =
-    //     st.generate_next_block(&dfvk, AddressType::DefaultExternal, value);
-
-    // // Scan the cache
-    // st.scan_cached_blocks(received_height, 1);
-
-    // // Account balance should reflect the received note
-    // assert_eq!(st.get_total_balance(account.id()), value);
 
     // Create a second fake CompactBlock spending value from the address
     let not_our_key = T::sk_to_fvk(&T::sk(&[0xf5; 32]));

zcash_client_backend/src/data_api/testing/pool/dsl.rs

@@ -93,9 +93,11 @@ where
 /// A proxy for `FakeCompactOutput` that allows test code to omit the `fvk` and
 /// `address_type` fields, which can be derived from the `TestState` in most cases.
 pub struct TestNoteConfig<T: ShieldedPoolTester> {
+    /// The amount of the note.
     pub value: Zatoshis,
-    /// Diversifiable full viewing key of
+    /// Diversifiable full viewing key of the recipient.
     pub fvk: Option<T::Fvk>,
+    /// Address type of the recipient.
     pub address_type: Option<AddressType>,
 }
 
@@ -288,7 +290,7 @@ where
     ///
     /// This step also verifies that the test account contains the expected
     /// funds as part of the _total_. Keep in mind that these funds may not yet
-    /// be _spendable_ due to the number confirmations required.
+    /// be _spendable_ due to the number of confirmations required.
     ///
     /// Returns a summary of steps.
     ///
@@ -317,8 +319,8 @@ where
                 .map(|into_note_config| {
                     let note_config = into_note_config.into();
                     if note_config.value > zip317::MARGINAL_FEE {
-                        // Don't include dust in the expected total, as the balance
-                        // won't include it.
+                        // Don't include uneconomic (dust) notes in the expected
+                        // total, as the balance won't include them.
                         expected_total = (expected_total + note_config.value).unwrap();
                     }
                     (self.make_fake_output(&note_config), note_config)