add remove_partial_sigs to SignOptions

Author: kafaichoi

CHANGELOG.md

@@ -19,6 +19,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
   - Signing Taproot PSBTs (key spend and script spend)
   - Support for `tr()` descriptors in the `descriptor!()` macro
 - Add support for Bitcoin Core 23.0 when using the `rpc` blockchain
+- Added `remove_partial_sigs` to `SignOptions`
 
 ## [v0.18.0] - [v0.17.0]
 

src/wallet/mod.rs

@@ -1161,6 +1161,9 @@ where
                             let psbt_input = &mut psbt.inputs[n];
                             psbt_input.final_script_sig = Some(tmp_input.script_sig);
                             psbt_input.final_script_witness = Some(tmp_input.witness);
+                            if sign_options.remove_partial_sigs {
+                                psbt_input.partial_sigs.clear();
+                            }
                         }
                         Err(e) => {
                             debug!("satisfy error {:?} for input {}", e, n);
@@ -1745,6 +1748,15 @@ pub(crate) mod test {
     use crate::signer::{SignOptions, SignerError};
     use crate::wallet::AddressIndex::{LastUnused, New, Peek, Reset};
 
+    fn create_drain_all_and_consolidate_psbt(
+        wallet: &Wallet<AnyDatabase>,
+    ) -> psbt::PartiallySignedTransaction {
+        let addr = wallet.get_address(New).unwrap();
+        let mut builder = wallet.build_tx();
+        builder.drain_to(addr.script_pubkey()).drain_wallet();
+        builder.finish().unwrap().0
+    }
+
     #[test]
     fn test_cache_addresses_fixed() {
         let db = MemoryDatabase::new();
@@ -3878,6 +3890,34 @@ pub(crate) mod test {
         )
     }
 
+    #[test]
+    fn test_remove_partial_sigs_after_finalize_sign_option() {
+        let (wallet, _, _) = get_funded_wallet("wpkh(tprv8ZgxMBicQKsPd3EupYiPRhaMooHKUHJxNsTfYuScep13go8QFfHdtkG9nRkFGb7busX4isf6X9dURGCoKgitaApQ6MupRhZMcELAxTBRJgS/*)");
+
+        for remove_partial_sigs in &[true, false] {
+            let mut psbt_1 = create_drain_all_and_consolidate_psbt(&wallet);
+            assert!(wallet
+                .sign(
+                    &mut psbt_1,
+                    SignOptions {
+                        remove_partial_sigs: *remove_partial_sigs,
+                        ..Default::default()
+                    },
+                )
+                .unwrap());
+
+            psbt_1.inputs.iter().for_each(|input| {
+                // remove finalized input partial_sigs if remove_partial_sigs is set as true in SignOptions
+                // do not remove finalized input partial_sigs if remove_partial_sigs is set as false in SignOptions.
+                if *remove_partial_sigs {
+                    assert!(input.partial_sigs.is_empty())
+                } else {
+                    assert!(!input.partial_sigs.is_empty())
+                }
+            });
+        }
+    }
+
     #[test]
     fn test_sign_nonstandard_sighash() {
         let sighash = EcdsaSighashType::NonePlusAnyoneCanPay;

src/wallet/signer.rs

@@ -667,6 +667,10 @@ pub struct SignOptions {
     ///
     /// Defaults to `false` which will only allow signing using `SIGHASH_ALL`.
     pub allow_all_sighashes: bool,
+    /// Whether partial_sigs in input should be removed when the psbt inputs are signed in finalizing psbt.
+    ///
+    /// Defaults to `true` which will remove partial_sigs in inputs after signing.
+    pub remove_partial_sigs: bool,
 }
 
 #[allow(clippy::derivable_impls)]
@@ -676,6 +680,7 @@ impl Default for SignOptions {
             trust_witness_utxo: false,
             assume_height: None,
             allow_all_sighashes: false,
+            remove_partial_sigs: true,
         }
     }
 }