add try_finalize to SignOptions

Author: kafaichoi

CHANGELOG.md

@@ -19,7 +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`
+- Added `remove_partial_sigs` and `try_finalize` to `SignOptions`
 
 ## [v0.18.0] - [v0.17.0]
 

src/wallet/mod.rs

@@ -1050,7 +1050,11 @@ where
         }
 
         // attempt to finalize
-        self.finalize_psbt(psbt, sign_options)
+        if sign_options.try_finalize {
+            self.finalize_psbt(psbt, sign_options)
+        } else {
+            Ok(false)
+        }
     }
 
     /// Return the spending policies for the wallet's descriptor
@@ -3895,18 +3899,18 @@ pub(crate) mod test {
         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);
+            let mut psbt = create_drain_all_and_consolidate_psbt(&wallet);
             assert!(wallet
                 .sign(
-                    &mut psbt_1,
+                    &mut psbt,
                     SignOptions {
                         remove_partial_sigs: *remove_partial_sigs,
                         ..Default::default()
                     },
                 )
                 .unwrap());
 
-            psbt_1.inputs.iter().for_each(|input| {
+            psbt.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 {
@@ -3918,6 +3922,39 @@ pub(crate) mod test {
         }
     }
 
+    #[test]
+    fn test_try_finalize_sign_option() {
+        let (wallet, _, _) = get_funded_wallet("wpkh(tprv8ZgxMBicQKsPd3EupYiPRhaMooHKUHJxNsTfYuScep13go8QFfHdtkG9nRkFGb7busX4isf6X9dURGCoKgitaApQ6MupRhZMcELAxTBRJgS/*)");
+
+        for try_finalize in &[true, false] {
+            let mut psbt = create_drain_all_and_consolidate_psbt(&wallet);
+
+            let finalized = wallet
+                .sign(
+                    &mut psbt,
+                    SignOptions {
+                        try_finalize: *try_finalize,
+                        ..Default::default()
+                    },
+                )
+                .unwrap();
+
+            // sign but do not finalize if try_finalize is set as false in SignOptions
+            // sign and do finalize if try_finalize is set as true in SignOptions
+            psbt.inputs.iter().for_each(|input| {
+                if *try_finalize {
+                    assert!(finalized);
+                    assert!(input.final_script_sig.is_some());
+                    assert!(input.final_script_witness.is_some());
+                } else {
+                    assert!(!finalized);
+                    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

@@ -671,6 +671,11 @@ pub struct SignOptions {
     ///
     /// Defaults to `true` which will remove partial_sigs in inputs after signing.
     pub remove_partial_sigs: bool,
+    /// Whether the wallet should try to finalize psbt input should be removed after the inputs are
+    /// signed.
+    ///
+    /// Defaults to `true` which will try to fianlize psbt after inputs are signed.
+    pub try_finalize: bool,
 }
 
 #[allow(clippy::derivable_impls)]
@@ -681,6 +686,7 @@ impl Default for SignOptions {
             assume_height: None,
             allow_all_sighashes: false,
             remove_partial_sigs: true,
+            try_finalize: true,
         }
     }
 }