test(psbt): update to use new SignerWrapper util

- updates the existing tests which use `Wallet::sign` API, to get the
  signer implementation with: `get_wallet_signer_single` or
`get_wallet_signer`.
- FIXME: there are two tests which requires further refactoring,
  discussion and update, being: `test_psbt_sign_with_finalized` and
`test_psbt_multiple_internalkey_signers`.

Author: oleonardolima

wallet/src/test_utils.rs

@@ -116,7 +116,6 @@ impl GetKey for SignerWrapper {
     }
 }
 
-
 /// Create the [`CreateParams`] for the provided testing `descriptor` and `change_descriptor`.
 pub fn get_wallet_params(descriptor: &str, change_descriptor: Option<&str>) -> crate::CreateParams {
     if let Some(change_desc) = change_descriptor {

wallet/tests/psbt.rs

@@ -1,13 +1,14 @@
 use bdk_wallet::bitcoin::{Amount, FeeRate, Psbt, TxIn};
 use bdk_wallet::test_utils::*;
 use bdk_wallet::{psbt, KeychainKind, SignOptions};
+use bitcoin::key::Secp256k1;
 use core::str::FromStr;
 
 // from bip 174
 const PSBT_STR: &str = "cHNidP8BAKACAAAAAqsJSaCMWvfEm4IS9Bfi8Vqz9cM9zxU4IagTn4d6W3vkAAAAAAD+////qwlJoIxa98SbghL0F+LxWrP1wz3PFTghqBOfh3pbe+QBAAAAAP7///8CYDvqCwAAAAAZdqkUdopAu9dAy+gdmI5x3ipNXHE5ax2IrI4kAAAAAAAAGXapFG9GILVT+glechue4O/p+gOcykWXiKwAAAAAAAEHakcwRAIgR1lmF5fAGwNrJZKJSGhiGDR9iYZLcZ4ff89X0eURZYcCIFMJ6r9Wqk2Ikf/REf3xM286KdqGbX+EhtdVRs7tr5MZASEDXNxh/HupccC1AaZGoqg7ECy0OIEhfKaC3Ibi1z+ogpIAAQEgAOH1BQAAAAAXqRQ1RebjO4MsRwUPJNPuuTycA5SLx4cBBBYAFIXRNTfy4mVAWjTbr6nj3aAfuCMIAAAA";
 
 #[test]
-#[should_panic(expected = "InputIndexOutOfRange")]
+#[should_panic(expected = "IndexOutOfBounds")]
 fn test_psbt_malformed_psbt_input_legacy() {
     let psbt_bip = Psbt::from_str(PSBT_STR).unwrap();
     let (mut wallet, _) = get_funded_wallet_single(get_test_wpkh());
@@ -16,15 +17,14 @@ fn test_psbt_malformed_psbt_input_legacy() {
     builder.add_recipient(send_to.script_pubkey(), Amount::from_sat(10_000));
     let mut psbt = builder.finish().unwrap();
     psbt.inputs.push(psbt_bip.inputs[0].clone());
-    let options = SignOptions {
-        trust_witness_utxo: true,
-        ..Default::default()
-    };
-    let _ = wallet.sign(&mut psbt, options).unwrap();
+
+    let secp = Secp256k1::new();
+    let signer = get_wallet_signer_single(get_test_wpkh());
+    let _ = psbt.sign(&signer, &secp).unwrap();
 }
 
 #[test]
-#[should_panic(expected = "InputIndexOutOfRange")]
+#[should_panic(expected = "IndexOutOfBounds")]
 fn test_psbt_malformed_psbt_input_segwit() {
     let psbt_bip = Psbt::from_str(PSBT_STR).unwrap();
     let (mut wallet, _) = get_funded_wallet_single(get_test_wpkh());
@@ -33,13 +33,13 @@ fn test_psbt_malformed_psbt_input_segwit() {
     builder.add_recipient(send_to.script_pubkey(), Amount::from_sat(10_000));
     let mut psbt = builder.finish().unwrap();
     psbt.inputs.push(psbt_bip.inputs[1].clone());
-    let options = SignOptions {
-        trust_witness_utxo: true,
-        ..Default::default()
-    };
-    let _ = wallet.sign(&mut psbt, options).unwrap();
+
+    let secp = Secp256k1::new();
+    let signer = get_wallet_signer_single(get_test_wpkh());
+    let _ = psbt.sign(&signer, &secp).unwrap();
 }
 
+// FIXME: (@leonardo) this expect an error from `finalize_psbt` method, should be fixed when removing the `SignerErrors`
 #[test]
 #[should_panic(expected = "InputIndexOutOfRange")]
 fn test_psbt_malformed_tx_input() {
@@ -53,13 +53,24 @@ fn test_psbt_malformed_tx_input() {
         trust_witness_utxo: true,
         ..Default::default()
     };
-    let _ = wallet.sign(&mut psbt, options).unwrap();
+
+    let secp = Secp256k1::new();
+    let signer = get_wallet_signer_single(get_test_wpkh());
+    let _ = psbt.sign(&signer, &secp).unwrap();
+
+    let _ = wallet.finalize_psbt(&mut psbt, options).unwrap();
 }
 
+// FIXME: (@leonardo) this test needs a refactoring, it fails due to rust-bitcoin's `spend_utxo` method while signing,
+// it adds an input field from BIP-174 PSBT which is missing the `witness_utxo` field. If this input field is not added
+// the signing works successfully.
+// see: https://github.com/rust-bitcoin/rust-bitcoin/blob/ef5e3256dfafd84d40cabb0c09dd3f49ea117c61/bitcoin/src/psbt/mod.rs#L621-L633
 #[test]
+#[ignore = "FIXME: it needs refactoring, in order to properly use a finalized input and not one missing `witness_utxo` field."]
 fn test_psbt_sign_with_finalized() {
     let psbt_bip = Psbt::from_str(PSBT_STR).unwrap();
-    let (mut wallet, _) = get_funded_wallet_wpkh();
+    let (descriptor, change_descriptor) = get_test_wpkh_and_change_desc();
+    let (mut wallet, _) = get_funded_wallet(descriptor, change_descriptor);
     let send_to = wallet.peek_address(KeychainKind::External, 0);
     let mut builder = wallet.build_tx();
     builder.add_recipient(send_to.script_pubkey(), Amount::from_sat(10_000));
@@ -71,7 +82,11 @@ fn test_psbt_sign_with_finalized() {
         .input
         .push(psbt_bip.unsigned_tx.input[0].clone());
 
-    let _ = wallet.sign(&mut psbt, SignOptions::default()).unwrap();
+    // let _ = wallet.sign(&mut psbt, SignOptions::default()).unwrap();
+
+    let secp = Secp256k1::new();
+    let signer = get_wallet_signer(descriptor, Some(change_descriptor));
+    let _ = psbt.sign(&signer, &secp).unwrap();
 }
 
 #[test]
@@ -80,7 +95,8 @@ fn test_psbt_fee_rate_with_witness_utxo() {
 
     let expected_fee_rate = FeeRate::from_sat_per_kwu(310);
 
-    let (mut wallet, _) = get_funded_wallet_single("wpkh(tprv8ZgxMBicQKsPd3EupYiPRhaMooHKUHJxNsTfYuScep13go8QFfHdtkG9nRkFGb7busX4isf6X9dURGCoKgitaApQ6MupRhZMcELAxTBRJgS/*)");
+    let descriptor = "wpkh(tprv8ZgxMBicQKsPd3EupYiPRhaMooHKUHJxNsTfYuScep13go8QFfHdtkG9nRkFGb7busX4isf6X9dURGCoKgitaApQ6MupRhZMcELAxTBRJgS/*)";
+    let (mut wallet, _) = get_funded_wallet_single(descriptor);
     let addr = wallet.peek_address(KeychainKind::External, 0);
     let mut builder = wallet.build_tx();
     builder.drain_to(addr.script_pubkey()).drain_wallet();
@@ -91,7 +107,12 @@ fn test_psbt_fee_rate_with_witness_utxo() {
 
     let unfinalized_fee_rate = psbt.fee_rate().unwrap();
 
-    let finalized = wallet.sign(&mut psbt, Default::default()).unwrap();
+    let secp = Secp256k1::new();
+    let signer = get_wallet_signer_single(descriptor);
+    let _ = psbt.sign(&signer, &secp).unwrap();
+
+    // let finalized = wallet.sign(&mut psbt, Default::default()).unwrap();
+    let finalized = wallet.finalize_psbt(&mut psbt, Default::default()).unwrap();
     assert!(finalized);
 
     let finalized_fee_rate = psbt.fee_rate().unwrap();
@@ -105,7 +126,8 @@ fn test_psbt_fee_rate_with_nonwitness_utxo() {
 
     let expected_fee_rate = FeeRate::from_sat_per_kwu(310);
 
-    let (mut wallet, _) = get_funded_wallet_single("pkh(tprv8ZgxMBicQKsPd3EupYiPRhaMooHKUHJxNsTfYuScep13go8QFfHdtkG9nRkFGb7busX4isf6X9dURGCoKgitaApQ6MupRhZMcELAxTBRJgS/*)");
+    let descriptor = "pkh(tprv8ZgxMBicQKsPd3EupYiPRhaMooHKUHJxNsTfYuScep13go8QFfHdtkG9nRkFGb7busX4isf6X9dURGCoKgitaApQ6MupRhZMcELAxTBRJgS/*)";
+    let (mut wallet, _) = get_funded_wallet_single(descriptor);
     let addr = wallet.peek_address(KeychainKind::External, 0);
     let mut builder = wallet.build_tx();
     builder.drain_to(addr.script_pubkey()).drain_wallet();
@@ -115,7 +137,12 @@ fn test_psbt_fee_rate_with_nonwitness_utxo() {
     assert!(fee_amount.is_some());
     let unfinalized_fee_rate = psbt.fee_rate().unwrap();
 
-    let finalized = wallet.sign(&mut psbt, Default::default()).unwrap();
+    let secp = Secp256k1::new();
+    let signer = get_wallet_signer_single(descriptor);
+    let _ = psbt.sign(&signer, &secp).unwrap();
+
+    // let finalized = wallet.sign(&mut psbt, Default::default()).unwrap();
+    let finalized = wallet.finalize_psbt(&mut psbt, Default::default()).unwrap();
     assert!(finalized);
 
     let finalized_fee_rate = psbt.fee_rate().unwrap();
@@ -156,6 +183,7 @@ fn test_psbt_fee_rate_with_missing_txout() {
 }
 
 #[test]
+// #[ignore = "FIXME: it needs refactoring, how should we handle the expected behavior of adding external signers, and usage of wrong internal key ?"]
 fn test_psbt_multiple_internalkey_signers() {
     use bdk_wallet::signer::{SignerContext, SignerOrdering, SignerWrapper};
     use bdk_wallet::KeychainKind;
@@ -192,7 +220,16 @@ fn test_psbt_multiple_internalkey_signers() {
             },
         )),
     );
-    let finalized = wallet.sign(&mut psbt, SignOptions::default()).unwrap();
+
+    // FIXME: (@leonardo) how should we approach the update of this test ?
+    // considering that there's an additional/external signer, should we still test this scenario ?
+
+    let secp = Secp256k1::new();
+    let signer = get_wallet_signer(&desc, Some(change_desc));
+    let _ = psbt.sign(&signer, &secp).unwrap();
+
+    // let finalized = wallet.sign(&mut psbt, SignOptions::default()).unwrap();
+    let finalized = wallet.finalize_psbt(&mut psbt, SignOptions::default()).unwrap();
     assert!(finalized);
 
     // To verify, we need the signature, message, and pubkey