fix: minimize PR changes, return BuilderResult

Author: Gyan Ranjan Panda

examples/electrum.rs

@@ -124,7 +124,7 @@ fn main() -> Result<(), anyhow::Error> {
     let mut builder = wallet.build_fee_bump(txid).expect("failed to bump tx");
     builder.fee_rate(feerate);
     let mut bumped_psbt = builder.finish().unwrap();
-    let finalize_btx = wallet.sign(&mut bumped_psbt, SignOptions::default())?;
+    let finalize_btx = wallet.sign(&mut bumped_psbt.psbt, SignOptions::default())?;
     assert!(finalize_btx);
     let new_fee = bumped_psbt.psbt.fee_amount().unwrap();
     let bumped_tx = bumped_psbt.psbt.extract_tx()?;

examples/esplora_async.rs

@@ -117,7 +117,7 @@ async fn main() -> Result<(), anyhow::Error> {
     let mut builder = wallet.build_fee_bump(txid).expect("failed to bump tx");
     builder.fee_rate(feerate);
     let mut bumped_psbt = builder.finish().unwrap();
-    let finalize_btx = wallet.sign(&mut bumped_psbt, SignOptions::default())?;
+    let finalize_btx = wallet.sign(&mut bumped_psbt.psbt, SignOptions::default())?;
     assert!(finalize_btx);
     let new_fee = bumped_psbt.psbt.fee_amount().unwrap();
     let bumped_tx = bumped_psbt.psbt.extract_tx()?;

examples/esplora_blocking.rs

@@ -113,7 +113,7 @@ fn main() -> Result<(), anyhow::Error> {
     let mut builder = wallet.build_fee_bump(txid).unwrap();
     builder.fee_rate(feerate);
     let mut new_psbt = builder.finish().unwrap();
-    let finalize_tx = wallet.sign(&mut new_psbt, SignOptions::default())?;
+    let finalize_tx = wallet.sign(&mut new_psbt.psbt, SignOptions::default())?;
     assert!(finalize_tx);
     let new_fee = new_psbt.psbt.fee_amount().unwrap();
     let bumped_tx = new_psbt.psbt.extract_tx()?;

src/wallet/mod.rs

@@ -1679,10 +1679,7 @@ impl Wallet {
             }
         }
 
-        Ok(tx_builder::BuilderResult {
-            psbt,
-            fee_rate,
-        })
+        Ok(tx_builder::BuilderResult { psbt, fee_rate })
     }
 
     /// Bump the fee of a transaction previously created with this wallet.
@@ -1710,8 +1707,8 @@ impl Wallet {
     ///         .add_recipient(to_address.script_pubkey(), Amount::from_sat(50_000));
     ///     builder.finish()?
     /// };
-    /// let _ = wallet.sign(&mut psbt, SignOptions::default())?;
-    /// let tx = psbt.clone().extract_tx().expect("tx");
+    /// let _ = wallet.sign(&mut psbt.psbt, SignOptions::default())?;
+    /// let tx = psbt.psbt.clone().extract_tx().expect("tx");
     /// // broadcast tx but it's taking too long to confirm so we want to bump the fee
     /// let mut psbt =  {
     ///     let mut builder = wallet.build_fee_bump(tx.compute_txid())?;
@@ -1720,8 +1717,8 @@ impl Wallet {
     ///     builder.finish()?
     /// };
     ///
-    /// let _ = wallet.sign(&mut psbt, SignOptions::default())?;
-    /// let fee_bumped_tx = psbt.extract_tx();
+    /// let _ = wallet.sign(&mut psbt.psbt, SignOptions::default())?;
+    /// let fee_bumped_tx = psbt.psbt.extract_tx();
     /// // broadcast fee_bumped_tx to replace original
     /// # Ok::<(), anyhow::Error>(())
     /// ```
@@ -1886,7 +1883,7 @@ impl Wallet {
     ///     builder.add_recipient(to_address.script_pubkey(), Amount::from_sat(50_000));
     ///     builder.finish()?
     /// };
-    /// let finalized = wallet.sign(&mut psbt, SignOptions::default())?;
+    /// let finalized = wallet.sign(&mut psbt.psbt, SignOptions::default())?;
     /// assert!(finalized, "we should have signed all the inputs");
     /// # Ok::<(),anyhow::Error>(())
     pub fn sign(&self, psbt: &mut Psbt, sign_options: SignOptions) -> Result<bool, SignerError> {

src/wallet/tx_builder.rs

@@ -95,7 +95,7 @@ use crate::{KeychainKind, LocalOutput, Utxo, WeightedUtxo};
 ///     builder.finish()?
 /// };
 ///
-/// assert_eq!(psbt1.unsigned_tx.output[..2], psbt2.unsigned_tx.output[..2]);
+/// assert_eq!(psbt1.psbt.unsigned_tx.output[..2], psbt2.psbt.unsigned_tx.output[..2]);
 /// # Ok::<(), anyhow::Error>(())
 /// ```
 ///
@@ -773,7 +773,10 @@ impl<Cs: CoinSelectionAlgorithm> TxBuilder<'_, Cs> {
     ///
     /// **WARNING**: To avoid change address reuse you must persist the changes resulting from one
     /// or more calls to this method before closing the wallet. See [`Wallet::reveal_next_address`].
-    pub fn finish_with_aux_rand(self, rng: &mut impl RngCore) -> Result<BuilderResult, CreateTxError> {
+    pub fn finish_with_aux_rand(
+        self,
+        rng: &mut impl RngCore,
+    ) -> Result<BuilderResult, CreateTxError> {
         self.wallet.create_tx(self.coin_selection, self.params, rng)
     }
 }
@@ -1235,7 +1238,12 @@ mod test {
                 .drain_wallet()
                 .drain_to(recipient.script_pubkey());
             let tx = builder.finish().unwrap();
-            let output = tx.unsigned_tx.output.first().expect("must have one output");
+            let output = tx
+                .psbt
+                .unsigned_tx
+                .output
+                .first()
+                .expect("must have one output");
             assert_eq!(output.value, Amount::ONE_BTC * 6);
         }
 
@@ -1248,7 +1256,12 @@ mod test {
                 .drain_wallet()
                 .drain_to(recipient.script_pubkey());
             let tx = builder.finish().unwrap();
-            let output = tx.unsigned_tx.output.first().expect("must have one output");
+            let output = tx
+                .psbt
+                .unsigned_tx
+                .output
+                .first()
+                .expect("must have one output");
             assert_eq!(output.value, Amount::ONE_BTC * 3);
         }
 
@@ -1261,7 +1274,12 @@ mod test {
                 .drain_wallet()
                 .drain_to(recipient.script_pubkey());
             let tx = builder.finish().unwrap();
-            let output = tx.unsigned_tx.output.first().expect("must have one output");
+            let output = tx
+                .psbt
+                .unsigned_tx
+                .output
+                .first()
+                .expect("must have one output");
             assert_eq!(output.value, Amount::ONE_BTC);
         }
     }
@@ -1297,7 +1315,7 @@ mod test {
         builder.fee_absolute(Amount::from_sat(1_000));
         let psbt = builder.finish().unwrap();
 
-        let tx = psbt.extract_tx().unwrap();
+        let tx = psbt.psbt.extract_tx().unwrap();
         let txid = tx.compute_txid();
         let feerate = wallet.calculate_fee_rate(&tx).unwrap().to_sat_per_kwu();
         insert_tx(&mut wallet, tx);

tests/add_foreign_utxo.rs

@@ -38,8 +38,13 @@ fn test_add_foreign_utxo() {
     let mut psbt = builder.finish().unwrap();
     wallet1.insert_txout(utxo.outpoint, utxo.txout);
     let fee = check_fee!(wallet1, psbt);
-    let (sent, received) =
-        wallet1.sent_and_received(&psbt.clone().psbt.extract_tx().expect("failed to extract tx"));
+    let (sent, received) = wallet1.sent_and_received(
+        &psbt
+            .psbt
+            .clone()
+            .extract_tx()
+            .expect("failed to extract tx"),
+    );
 
     assert_eq!(
         (sent - received),
@@ -48,7 +53,8 @@ fn test_add_foreign_utxo() {
     );
 
     assert!(
-        psbt.psbt.unsigned_tx
+        psbt.psbt
+            .unsigned_tx
             .input
             .iter()
             .any(|input| input.previous_output == utxo.outpoint),
@@ -57,7 +63,7 @@ fn test_add_foreign_utxo() {
 
     let finished = wallet1
         .sign(
-            &mut psbt,
+            &mut psbt.psbt,
             SignOptions {
                 trust_witness_utxo: true,
                 ..Default::default()
@@ -72,7 +78,7 @@ fn test_add_foreign_utxo() {
 
     let finished = wallet2
         .sign(
-            &mut psbt,
+            &mut psbt.psbt,
             SignOptions {
                 trust_witness_utxo: true,
                 ..Default::default()
@@ -271,8 +277,13 @@ fn test_taproot_foreign_utxo() {
         .add_foreign_utxo(utxo.outpoint, psbt_input, foreign_utxo_satisfaction)
         .unwrap();
     let psbt = builder.finish().unwrap();
-    let (sent, received) =
-        wallet1.sent_and_received(&psbt.clone().psbt.extract_tx().expect("failed to extract tx"));
+    let (sent, received) = wallet1.sent_and_received(
+        &psbt
+            .psbt
+            .clone()
+            .extract_tx()
+            .expect("failed to extract tx"),
+    );
     wallet1.insert_txout(utxo.outpoint, utxo.txout);
     let fee = check_fee!(wallet1, psbt);
 
@@ -283,7 +294,8 @@ fn test_taproot_foreign_utxo() {
     );
 
     assert!(
-        psbt.psbt.unsigned_tx
+        psbt.psbt
+            .unsigned_tx
             .input
             .iter()
             .any(|input| input.previous_output == utxo.outpoint),