feat: Add list_locked_unspent

Author: ValuedMammal

wallet/src/wallet/mod.rs

@@ -2385,9 +2385,16 @@ impl Wallet {
         &self.chain
     }
 
-    /// List locked outpoints.
-    pub fn list_locked_outpoints(&self) -> impl Iterator<Item = UtxoLock> + '_ {
-        self.locked_outpoints.values().copied()
+    /// Get a reference to the locked outpoints.
+    pub fn locked_outpoints(&self) -> &BTreeMap<OutPoint, UtxoLock> {
+        &self.locked_outpoints
+    }
+
+    /// List unspent outpoints that are currently locked.
+    pub fn list_locked_unspent(&self) -> impl Iterator<Item = OutPoint> + '_ {
+        self.list_unspent()
+            .filter(|output| self.is_outpoint_locked(output.outpoint))
+            .map(|output| output.outpoint)
     }
 
     /// Whether the `outpoint` is currently locked. See [`Wallet::lock_outpoint`] for more.

wallet/tests/wallet.rs

@@ -64,8 +64,10 @@ fn test_lock_outpoint_persist() -> anyhow::Result<()> {
         .create_wallet(&mut conn)?;
 
     // Receive coins.
+    let mut outpoints = vec![];
     for i in 0..3 {
-        let _ = receive_output(&mut wallet, Amount::from_sat(10_000), ReceiveTo::Mempool(i));
+        let op = receive_output(&mut wallet, Amount::from_sat(10_000), ReceiveTo::Mempool(i));
+        outpoints.push(op);
     }
 
     // Test: lock outpoints
@@ -94,7 +96,8 @@ fn test_lock_outpoint_persist() -> anyhow::Result<()> {
                 "Expect recover lock value"
             );
         }
-        assert!(wallet.list_locked_outpoints().all(|u| u.is_locked));
+        let locked_unspent = wallet.list_locked_unspent().collect::<Vec<_>>();
+        assert_eq!(locked_unspent, outpoints);
 
         // Test: Locked outpoints are excluded from coin selection
         let addr = wallet.next_unused_address(KeychainKind::External).address;
@@ -127,7 +130,8 @@ fn test_lock_outpoint_persist() -> anyhow::Result<()> {
                 "Expect outpoint is not locked"
             );
         }
-        assert!(!wallet.list_locked_outpoints().any(|u| u.is_locked));
+        assert!(!wallet.locked_outpoints().values().any(|u| u.is_locked));
+        assert!(wallet.list_locked_unspent().next().is_none());
         wallet.persist(&mut conn)?;
 
         // Test: Update lock expiry