zcash_client_sqlite: Align handling of transparent UTXOs with that of shielded notes.

zcash_client_backend/CHANGELOG.md

@@ -10,13 +10,14 @@ and this library adheres to Rust's notion of
 ### Added
 - `zcash_client_backend::data_api`:
   - `chain::BlockCache` trait, behind the `sync` feature flag.
+  - `WalletRead::get_spendable_transparent_outputs`.
 - `zcash_client_backend::fees`:
   - `ChangeValue::{transparent, shielded}`
   - `sapling::EmptyBundleView`
   - `orchard::EmptyBundleView`
 - `zcash_client_backend::scanning`:
   - `testing` module
-- `zcash_client_backend::sync` module, behind the `sync` feature flag.
+- `zcash_client_backend::sync` module, behind the `sync` feature flag
 
 ### Changed
 - MSRV is now 1.70.0.
@@ -52,6 +53,12 @@ and this library adheres to Rust's notion of
   `zcash_address::ZcashAddress`. This simplifies the process of tracking the
   original address to which value was sent.
 
+### Removed
+- `zcash_client_backend::data_api`:
+  - `WalletRead::get_unspent_transparent_outputs` has been removed because its
+    semantics were unclear and could not be clarified. Use
+    `WalletRead::get_spendable_transparent_outputs` instead.
+
 ## [0.12.1] - 2024-03-27
 
 ### Fixed

zcash_client_backend/src/data_api.rs

@@ -665,10 +665,10 @@
         exclude: &[Self::NoteRef],
     ) -> Result<SpendableNotes<Self::NoteRef>, Self::Error>;
 
-    /// Fetches a spendable transparent output.
+    /// Fetches the transparent output corresponding to the provided `outpoint`.
     ///
     /// Returns `Ok(None)` if the UTXO is not known to belong to the wallet or is not
-    /// spendable.
+    /// spendable as of the chain tip height.
     #[cfg(feature = "transparent-inputs")]
     fn get_unspent_transparent_output(
         &self,
@@ -677,14 +677,18 @@
         Ok(None)
     }
 
-    /// Returns a list of unspent transparent UTXOs that appear in the chain at heights up to and
-    /// including `max_height`.
+    /// Returns the list of transparent outputs received at `address` such that:
+    /// * The transaction that produced these outputs is mined or mineable as of `max_height`.
+    /// * Each returned output is unspent as of the current chain tip.
+    ///
+    /// The caller should filter these outputs to ensure they respect the desired number of
+    /// confirmations before attempting to spend them.
     #[cfg(feature = "transparent-inputs")]
-    fn get_unspent_transparent_outputs(
+    fn get_spendable_transparent_outputs(
         &self,
         _address: &TransparentAddress,
-        _max_height: BlockHeight,
-        _exclude: &[OutPoint],
+        _target_height: BlockHeight,
+        _min_confirmations: u32,
     ) -> Result<Vec<WalletTransparentOutput>, Self::Error> {
         Ok(vec![])
     }

zcash_client_backend/src/data_api/wallet/input_selection.rs

@@ -580,11 +580,7 @@ where
         let mut transparent_inputs: Vec<WalletTransparentOutput> = source_addrs
             .iter()
             .map(|taddr| {
-                wallet_db.get_unspent_transparent_outputs(
-                    taddr,
-                    target_height - min_confirmations,
-                    &[],
-                )
+                wallet_db.get_spendable_transparent_outputs(taddr, target_height, min_confirmations)
             })
             .collect::<Result<Vec<Vec<_>>, _>>()
             .map_err(InputSelectorError::DataSource)?

zcash_client_sqlite/CHANGELOG.md

@@ -11,6 +11,7 @@ and this library adheres to Rust's notion of
 - `zcash_client_sqlite::error::SqliteClientError` has changed variants:
   - Removed `HdwalletError`.
   - Added `TransparentDerivation`.
+- The `block` column of the `v_transactions` view has been renamed to `mined_height`.
 
 ## [0.10.3] - 2024-04-08
 

zcash_client_sqlite/src/lib.rs

@@ -272,22 +272,22 @@
         &self,
         outpoint: &OutPoint,
     ) -> Result<Option<WalletTransparentOutput>, Self::Error> {
-        wallet::get_unspent_transparent_output(self.conn.borrow(), outpoint)
+        wallet::transparent::get_unspent_transparent_output(self.conn.borrow(), outpoint)
     }
 
     #[cfg(feature = "transparent-inputs")]
-    fn get_unspent_transparent_outputs(
+    fn get_spendable_transparent_outputs(
         &self,
         address: &TransparentAddress,
-        max_height: BlockHeight,
-        exclude: &[OutPoint],
+        target_height: BlockHeight,
+        min_confirmations: u32,
     ) -> Result<Vec<WalletTransparentOutput>, Self::Error> {
-        wallet::get_unspent_transparent_outputs(
+        wallet::transparent::get_spendable_transparent_outputs(
             self.conn.borrow(),
             &self.params,
             address,
-            max_height,
-            exclude,
+            target_height,
+            min_confirmations,
         )
     }
 }
@@ -430,9 +430,7 @@
     }
 
     fn chain_height(&self) -> Result<Option<BlockHeight>, Self::Error> {
-        wallet::scan_queue_extrema(self.conn.borrow())
-            .map(|h| h.map(|range| *range.end()))
-            .map_err(SqliteClientError::from)
+        wallet::chain_tip_height(self.conn.borrow()).map_err(SqliteClientError::from)
     }
 
     fn get_block_hash(&self, block_height: BlockHeight) -> Result<Option<BlockHash>, Self::Error> {
@@ -516,7 +514,7 @@
         &self,
         account: AccountId,
     ) -> Result<HashMap<TransparentAddress, Option<TransparentAddressMetadata>>, Self::Error> {
-        wallet::get_transparent_receivers(self.conn.borrow(), &self.params, account)
+        wallet::transparent::get_transparent_receivers(self.conn.borrow(), &self.params, account)
     }
 
     #[cfg(feature = "transparent-inputs")]
@@ -525,7 +523,12 @@
         account: AccountId,
         max_height: BlockHeight,
     ) -> Result<HashMap<TransparentAddress, NonNegativeAmount>, Self::Error> {
-        wallet::get_transparent_balances(self.conn.borrow(), &self.params, account, max_height)
+        wallet::transparent::get_transparent_address_balances(
+            self.conn.borrow(),
+            &self.params,
+            account,
+            max_height,
+        )
     }
 }
 
@@ -1034,7 +1037,11 @@
         _output: &WalletTransparentOutput,
     ) -> Result<Self::UtxoRef, Self::Error> {
         #[cfg(feature = "transparent-inputs")]
-        return wallet::put_received_transparent_utxo(&self.conn, &self.params, _output);
+        return wallet::transparent::put_received_transparent_utxo(
+            &self.conn,
+            &self.params,
+            _output,
+        );
 
         #[cfg(not(feature = "transparent-inputs"))]
         panic!(
@@ -1228,7 +1235,7 @@
                 .iter()
                 .flat_map(|b| b.vin.iter())
             {
-                wallet::mark_transparent_utxo_spent(wdb.conn.0, tx_ref, &txin.prevout)?;
+                wallet::transparent::mark_transparent_utxo_spent(wdb.conn.0, tx_ref, &txin.prevout)?;
             }
 
             // If we have some transparent outputs:
@@ -1337,7 +1344,11 @@
 
             #[cfg(feature = "transparent-inputs")]
             for utxo_outpoint in sent_tx.utxos_spent() {
-                wallet::mark_transparent_utxo_spent(wdb.conn.0, tx_ref, utxo_outpoint)?;
+                wallet::transparent::mark_transparent_utxo_spent(
+                    wdb.conn.0,
+                    tx_ref,
+                    utxo_outpoint,
+                )?;
             }
 
             for output in sent_tx.outputs() {