add do_not_finalize to SignOptions

Author: kafaichoi

CHANGELOG.md

@@ -12,7 +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`
+- Added `do_not_remove_partial_sigs` and `do_not_finalize` to `SignOptions`
 
 ## [v0.18.0] - [v0.17.0]
 

src/wallet/mod.rs

@@ -1046,7 +1046,11 @@ where
         }
 
         // attempt to finalize
-        self.finalize_psbt(psbt, sign_options)
+        if sign_options.do_not_finalize {
+            Ok(false)
+        } else {
+            self.finalize_psbt(psbt, sign_options)
+        }
     }
 
     /// Return the spending policies for the wallet's descriptor
@@ -3836,6 +3840,56 @@ pub(crate) mod test {
             .for_each(|input| assert!(!input.partial_sigs.is_empty()));
     }
 
+    #[test]
+    fn test_do_not_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();
+            // only sign and finalize if do_not_finalize is set as false in SignOptions
+            let mut builder = wallet.build_tx();
+            builder.drain_to(addr.script_pubkey()).drain_wallet();
+            builder.finish().unwrap().0
+        }
+
+        let mut psbt_1 = create_psbt(&wallet);
+
+        let finalized = wallet
+            .sign(
+                &mut psbt_1,
+                SignOptions {
+                    do_not_finalize: false,
+                    ..Default::default()
+                },
+            )
+            .unwrap();
+        assert!(finalized);
+
+        psbt_1.inputs.iter().for_each(|input| {
+            assert!(input.final_script_sig.is_some());
+            assert!(input.final_script_witness.is_some());
+        });
+
+        // only sign and do not finalize if do_not_finalize is set as true in SignOptions
+        let mut psbt_2 = create_psbt(&wallet);
+
+        let finalized = wallet
+            .sign(
+                &mut psbt_2,
+                SignOptions {
+                    do_not_finalize: true,
+                    ..Default::default()
+                },
+            )
+            .unwrap();
+        assert!(!finalized);
+
+        psbt_2.inputs.iter().for_each(|input| {
+            assert!(input.final_script_sig.is_none());
+            assert!(input.final_script_witness.is_none());
+        });
+    }
+
     #[test]
     fn test_sign_nonstandard_sighash() {
         let sighash = EcdsaSighashType::NonePlusAnyoneCanPay;

src/wallet/signer.rs

@@ -497,6 +497,10 @@ pub struct SignOptions {
     /// 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,
+    /// Whether the wallet should try to finalize psbt input should be removed when the psbt_input is signed after
+    ///
+    /// Defaults to `false` which will partial_sigs after input is signed
+    pub do_not_finalize: bool,
 }
 
 #[allow(clippy::derivable_impls)]
@@ -507,6 +511,7 @@ impl Default for SignOptions {
             assume_height: None,
             allow_all_sighashes: false,
             do_not_remove_partial_sigs: false,
+            do_not_finalize: false,
         }
     }
 }