Rename must_use_utxos to required_utxos

diff --git a/src/wallet/coin_selection.rs b/src/wallet/coin_selection.rs
index 7de2b0a24cdb18db7206bb6a18296d9d0bfefefd..bd96d34585b78845b01258603b309befa16a4a56 100644 (file)
--- a/src/wallet/coin_selection.rs
+++ b/src/wallet/coin_selection.rs
@@ -53,7 +53,7 @@
 //!     fn coin_select(
 //!         &self,
 //!         database: &D,
-//!         must_use_utxos: Vec<(UTXO, usize)>,
+//!         required_utxos: Vec<(UTXO, usize)>,
 //!         may_use_utxos: Vec<(UTXO, usize)>,
 //!         fee_rate: FeeRate,
 //!         amount_needed: u64,
@@ -61,7 +61,7 @@
 //!     ) -> Result<CoinSelectionResult, bdk::Error> {
 //!         let mut selected_amount = 0;
 //!         let mut additional_weight = 0;
-//!         let all_utxos_selected = must_use_utxos
+//!         let all_utxos_selected = required_utxos
 //!             .into_iter().chain(may_use_utxos)
 //!             .scan((&mut selected_amount, &mut additional_weight), |(selected_amount, additional_weight), (utxo, weight)| {
 //!                 let txin = TxIn {
@@ -139,7 +139,7 @@ pub trait CoinSelectionAlgorithm<D: Database>: std::fmt::Debug {
     ///
     /// - `database`: a reference to the wallet's database that can be used to lookup additional
     ///               details for a specific UTXO
-    /// - `must_use_utxos`: the utxos that must be spent regardless of `amount_needed` with their
+    /// - `required_utxos`: the utxos that must be spent regardless of `amount_needed` with their
     ///                     weight cost
     /// - `may_be_spent`: the utxos that may be spent to satisfy `amount_needed` with their weight
     ///                   cost
@@ -150,7 +150,7 @@ pub trait CoinSelectionAlgorithm<D: Database>: std::fmt::Debug {
     fn coin_select(
         &self,
         database: &D,
-        must_use_utxos: Vec<(UTXO, usize)>,
+        required_utxos: Vec<(UTXO, usize)>,
         may_use_utxos: Vec<(UTXO, usize)>,
         fee_rate: FeeRate,
         amount_needed: u64,
@@ -169,7 +169,7 @@ impl<D: Database> CoinSelectionAlgorithm<D> for DumbCoinSelection {
     fn coin_select(
         &self,
         _database: &D,
-        must_use_utxos: Vec<(UTXO, usize)>,
+        required_utxos: Vec<(UTXO, usize)>,
         mut may_use_utxos: Vec<(UTXO, usize)>,
         fee_rate: FeeRate,
         amount_needed: u64,
@@ -188,7 +188,7 @@ impl<D: Database> CoinSelectionAlgorithm<D> for DumbCoinSelection {
         // smallest to largest, before being reversed with `.rev()`.
         let utxos = {
             may_use_utxos.sort_unstable_by_key(|(utxo, _)| utxo.txout.value);
-            must_use_utxos
+            required_utxos
                 .into_iter()
                 .map(|utxo| (true, utxo))
                 .chain(may_use_utxos.into_iter().rev().map(|utxo| (false, utxo)))

diff --git a/src/wallet/mod.rs b/src/wallet/mod.rs
index 845da0f0e2a05817fee33af31472579a870b2ad3..0ea263b1a0fa7a1c4e57c3e6304375a95b801fbe 100644 (file)
--- a/src/wallet/mod.rs
+++ b/src/wallet/mod.rs
@@ -348,7 +348,7 @@ where
             ));
         }
 
-        let (must_use_utxos, may_use_utxos) = self.get_must_may_use_utxos(
+        let (required_utxos, may_use_utxos) = self.get_must_may_use_utxos(
             builder.change_policy,
             &builder.unspendable,
             &builder.utxos,
@@ -363,7 +363,7 @@ where
             mut fee_amount,
         } = builder.coin_selection.coin_select(
             self.database.borrow().deref(),
-            must_use_utxos,
+            required_utxos,
             may_use_utxos,
             fee_rate,
             outgoing,
@@ -604,7 +604,7 @@ where
             .cloned()
             .collect::<Vec<_>>();
 
-        let (mut must_use_utxos, may_use_utxos) = self.get_must_may_use_utxos(
+        let (mut required_utxos, may_use_utxos) = self.get_must_may_use_utxos(
             builder.change_policy,
             &builder.unspendable,
             &builder_extra_utxos[..],
@@ -613,7 +613,7 @@ where
             true, // we only want confirmed transactions for RBF
         )?;
 
-        must_use_utxos.append(&mut original_utxos);
+        required_utxos.append(&mut original_utxos);
 
         let amount_needed = tx.output.iter().fold(0, |acc, out| acc + out.value);
         let (new_feerate, initial_fee) = match builder
@@ -645,7 +645,7 @@ where
             fee_amount,
         } = builder.coin_selection.coin_select(
             self.database.borrow().deref(),
-            must_use_utxos,
+            required_utxos,
             may_use_utxos,
             new_feerate,
             amount_needed,