feat: expose detailed try_finalize_psbt outcomes by reez · Pull Request #433 · bitcoindevkit/bdk_wallet

reez · 2026-04-07T16:13:53Z

Description

First step for #73, following ValuedMammal's suggestion.

This PR keeps the scope to PSBT finalization only:

add try_finalize_psbt which returns FinalizePsbtResult
report per input outcomes via FinalizePsbtInputResult

Notes to the reviewers

This is now additive rather than breaking: Wallet::finalize_psbt still returns bool

Intentionally not included here:

changing Wallet::sign to return a richer result type
any broader redesign beyond the PSBT finalization API surface

Changelog notice

Add Wallet::try_finalize_psbt, which returns FinalizePsbtResult and exposes per-input finalization outcomes while preserving the existing Wallet::finalize_psbt API.

Checklists

All Submissions:

I've signed all my commits
I followed the contribution guidelines
I ran just p before pushing

New Features:

I've added tests for the new feature
I've added docs for the new feature

codecov · 2026-04-07T16:17:17Z

Codecov Report

❌ Patch coverage is 96.62921% with 3 lines in your changes missing coverage. Please review.
✅ Project coverage is 81.15%. Comparing base (58fe631) to head (ec3a683).

Files with missing lines	Patch %	Lines
src/types.rs	82.35%	3 Missing ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##           master     #433      +/-   ##
==========================================
+ Coverage   80.96%   81.15%   +0.19%     
==========================================
  Files          24       24              
  Lines        5489     5552      +63     
  Branches      247      247              
==========================================
+ Hits         4444     4506      +62     
- Misses        968      970       +2     
+ Partials       77       76       -1

Flag	Coverage Δ
rust	`81.15% <96.62%> (+0.19%)`	⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Harness.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

reez · 2026-04-07T20:23:00Z

Updated per some good feedback from mammal

ValuedMammal

I don't think After and Older are doing much good, and would prefer to leave them out of the new implementation if we plan to support try_finalize_psbt into the future.

notmandatory · 2026-06-12T16:34:38Z

Concept ACK, glad to see this as a non-breaking change.

reez · 2026-06-16T15:21:54Z

Added four commits as small follow-ups from review feedback from mammal: make finalization cleanup more explicit, preserve opaque PSBT/input metadata, stop the new try_finalize_psbt path from redacting output metadata, and clarify the internal timelock inputs without changing legacy finalize_psbt behavior.

oleonardolima · 2026-06-18T00:10:32Z

+    /// The input was already finalized before this call.
+    AlreadyFinalized,
+    /// The input was successfully finalized during this call.
+    Finalized,


question: are we using this differently ? otherwise, a single Finalized would be enough imho.

I see where you're coming from for sure but I do think the distinctions intentional. Finalized would be this call was able to finalize the input, AlreadyFinalized would be the input already had final script/witness data before this call and we skipped it. is_finalized() treats both as success, but I thought preserving that difference was useful since this API is meant to explain what happened per input.

Good, I think I see where you're going. Agree, it's probably useful to have that distinction if it'll be used for upstream users (e.g UX/UI).

oleonardolima

cACK 09d2cd0

Musab1258 · 2026-06-20T06:24:00Z

tACK 09d2cd0

The concept and approach make sense. I fetched the branch and ran the tests locally, and they all pass. The documentation also clearly specifies when to use the finalize_psbt and try_finalize_psbt methods.

Musab1258 · 2026-06-21T11:06:58Z

+    }
+
+    /// Whether all inputs are finalized after this call.
+    pub fn is_finalized(&self) -> bool {


If outcomes is empty (e.g. a PSBT with no inputs), is_finalized() returns true, since .all() on an empty iterator is true. Is this the intended behavior or worth documenting/guarding against explicitly?

I think this is intended since is_finalized() is only answering whether any input failed finalization, so if there are no inputs there is nothing to fail. This also matches the old finalize_psbt behavior where finished started as true and only changed inside the input loop. But that's my take, open to further thoughts

Musab1258 · 2026-06-21T12:32:22Z

-        let mut finished = true;
+        let mut outcomes = BTreeMap::new();

        for (n, input) in tx.input.iter().enumerate() {


If psbt.inputs.len() < tx.input.len() but not 0, this loop will partially mutate earlier inputs before hitting the IndexOutOfBoundsError on a later one. Is it expected to have a partially-mutated PSBT on Err , or should length be validated up front before any mutation starts?

Agree I think validating up front is cleaner here. 6afd006 adds a guard before the loop so a PSBT with missing input metadata returns IndexOutOfBoundsError before any inputs are mutated, plus a regression test for the partial mutation case.

Musab1258 · 2026-06-21T13:44:02Z


+/// The finalization status for a single PSBT input.
+#[derive(Debug, PartialEq)]
+pub enum FinalizeInputOutcome {


Would it make sense to add a Display impl for FinalizeInputOutcome so callers don't have to match on the variants themselves to produce an outcome that can be logged in user interfaces?

Maybe, but I lean toward leaving this out for now. I was thinking of FinalizeInputOutcome as structured data that callers can match on and render however they want, especially for UI wording, while Debug is still available for basic logging. Happy to add Display if others think that belongs in the initial API though.

github-project-automation Bot added this to BDK Wallet Apr 7, 2026

reez force-pushed the issue-73 branch 2 times, most recently from c65f534 to e046adc Compare April 7, 2026 20:16

reez changed the title ~~(draft) feat: expose detailed finalize_psbt outcomes~~ (draft) feat: expose detailed try_finalize_psbt outcomes Apr 7, 2026

reez marked this pull request as ready for review April 9, 2026 19:21

reez requested review from ValuedMammal and oleonardolima as code owners April 9, 2026 19:21

reez changed the title ~~(draft) feat: expose detailed try_finalize_psbt outcomes~~ feat: expose detailed try_finalize_psbt outcomes Apr 9, 2026

reez force-pushed the issue-73 branch 5 times, most recently from f3fb2a6 to 69966b6 Compare April 14, 2026 19:14

ValuedMammal assigned reez Apr 14, 2026

ValuedMammal added this to the Wallet 3.1.0 milestone Apr 14, 2026

ValuedMammal added the new feature New feature or request label Apr 14, 2026

ValuedMammal moved this to In Progress in BDK Wallet Apr 14, 2026

ValuedMammal requested changes May 8, 2026

View reviewed changes

reez force-pushed the issue-73 branch from 69966b6 to a422a2d Compare May 12, 2026 14:21

ValuedMammal modified the milestones: Wallet 3.1.0, Wallet 3.2.0 Jun 9, 2026

reez force-pushed the issue-73 branch from a422a2d to 06e8c30 Compare June 10, 2026 19:17

reez mentioned this pull request Jun 12, 2026

additional information for finalize_psbt when returning false #73

Open

reez force-pushed the issue-73 branch from 06e8c30 to 653031a Compare June 15, 2026 19:05

oleonardolima reviewed Jun 18, 2026

View reviewed changes

reez force-pushed the issue-73 branch from 653031a to c07dbd9 Compare June 18, 2026 13:14

reez force-pushed the issue-73 branch from c07dbd9 to 09d2cd0 Compare June 18, 2026 13:23

oleonardolima reviewed Jun 18, 2026

View reviewed changes

Comment thread src/wallet/mod.rs

Musab1258 reviewed Jun 21, 2026

View reviewed changes

reez added 5 commits June 22, 2026 11:24

feat: expose detailed try_finalize_psbt outcomes

6afd006

fix: preserve opaque psbt input fields on finalize

50a1a0f

fix: preserve output metadata in try_finalize_psbt

7f8cbca

docs: clarify try_finalize_psbt behavior

8a7b5de

refactor: clarify try_finalize_psbt timelock inputs

ec3a683

reez force-pushed the issue-73 branch from 09d2cd0 to ec3a683 Compare June 22, 2026 16:25

Uh oh!

Conversation

reez commented Apr 7, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Notes to the reviewers

Changelog notice

Checklists

All Submissions:

New Features:

Uh oh!

codecov Bot commented Apr 7, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

reez commented Apr 7, 2026

Uh oh!

ValuedMammal left a comment

Choose a reason for hiding this comment

Uh oh!

notmandatory commented Jun 12, 2026

Uh oh!

reez commented Jun 16, 2026

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

oleonardolima left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Musab1258 commented Jun 20, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

reez commented Apr 7, 2026 •

edited

Loading

codecov Bot commented Apr 7, 2026 •

edited

Loading

Musab1258 commented Jun 20, 2026 •

edited

Loading