add do_not_remove_partial_sigs to SignOptions

Author: kafaichoi

CHANGELOG.md

@@ -12,6 +12,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - Add traits to reuse `Blockchain`s across multiple wallets (`BlockchainFactory` and `StatelessBlockchain`).
 - Upgrade to rust-bitcoin `0.28`
 - If using the `sqlite-db` feature all cached wallet data is deleted due to a possible UTXO inconsistency, a wallet.sync will recreate it  
+- Added `do_not_remove_partial_sigs` to `SignOptions`
 
 ## [v0.18.0] - [v0.17.0]
 

src/wallet/mod.rs

@@ -1157,6 +1157,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.do_not_remove_partial_sigs {
+                                psbt_input.partial_sigs.clear();
+                            }
                         }
                         Err(e) => {
                             debug!("satisfy error {:?} for input {}", e, n);
@@ -3785,6 +3788,54 @@ pub(crate) mod test {
         )
     }
 
+    #[test]
+    fn test_do_not_remove_partial_sigs_after_finalize_sign_option() {
+        let (wallet, _, _) = get_funded_wallet("wpkh(tprv8ZgxMBicQKsPd3EupYiPRhaMooHKUHJxNsTfYuScep13go8QFfHdtkG9nRkFGb7busX4isf6X9dURGCoKgitaApQ6MupRhZMcELAxTBRJgS/*)");
+
+        fn create_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
+        }
+
+        // remove finalized input partial_sigs if do_not_remove_partial_sigs is set as false in SignOptions
+        let mut psbt_1 = create_psbt(&wallet);
+
+        assert!(wallet
+            .sign(
+                &mut psbt_1,
+                SignOptions {
+                    do_not_remove_partial_sigs: false,
+                    ..Default::default()
+                },
+            )
+            .unwrap());
+
+        psbt_1
+            .inputs
+            .iter()
+            .for_each(|input| assert!(input.partial_sigs.is_empty()));
+
+        // do not remove finalized input partial_sigs if do_not_remove_partial_sigs is set as true in SignOptions
+        let mut psbt_2 = create_psbt(&wallet);
+
+        assert!(!wallet
+            .sign(
+                &mut psbt_2,
+                SignOptions {
+                    do_not_remove_partial_sigs: true,
+                    ..Default::default()
+                },
+            )
+            .unwrap());
+
+        psbt_2
+            .inputs
+            .iter()
+            .for_each(|input| assert!(!input.partial_sigs.is_empty()));
+    }
+
     #[test]
     fn test_sign_nonstandard_sighash() {
         let sighash = EcdsaSighashType::NonePlusAnyoneCanPay;

src/wallet/signer.rs

@@ -492,8 +492,11 @@ pub struct SignOptions {
     /// Whether the signer should use the `sighash_type` set in the PSBT when signing, no matter
     /// what its value is
     ///
-    /// Defaults to `false` which will only allow signing using `SIGHASH_ALL`.
+    /// Defaults to `false` which will remove partial_sigs after input is signed
     pub allow_all_sighashes: bool,
+    /// Whether partial_sigs in input should be removed when the psbt_input is signed in finalizing psbt.
+    /// Defaults to `false` which will partial_sigs will be removed after signing.
+    pub do_not_remove_partial_sigs: bool,
 }
 
 #[allow(clippy::derivable_impls)]
@@ -503,6 +506,7 @@ impl Default for SignOptions {
             trust_witness_utxo: false,
             assume_height: None,
             allow_all_sighashes: false,
+            do_not_remove_partial_sigs: false,
         }
     }
 }