Skip to content

Commit 8a7b5de

Browse files
committed
docs: clarify try_finalize_psbt behavior
1 parent 7f8cbca commit 8a7b5de

1 file changed

Lines changed: 10 additions & 4 deletions

File tree

src/wallet/mod.rs

Lines changed: 10 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1937,11 +1937,17 @@ impl Wallet {
19371937
.is_finalized())
19381938
}
19391939

1940-
/// Finalize a PSBT and return per-input finalization results. Use this method when you need to
1941-
/// inspect why a specific input could not be finalized.
1940+
/// Attempt to finalize each input of a PSBT and return per-input finalization results.
19421941
///
1943-
/// The method should only return `Err` when the PSBT is malformed, for example if its inputs
1944-
/// are out of bounds.
1942+
/// Use this method when you need to inspect why a specific input could not be finalized. Call
1943+
/// [`FinalizePsbtOutcome::is_finalized`] on the returned value to check whether all inputs are
1944+
/// finalized after the call.
1945+
///
1946+
/// Per-input finalization failures are reported as [`FinalizeInputOutcome`] values. This method
1947+
/// only returns `Err` when the PSBT is malformed, for example if its inputs are out of bounds.
1948+
///
1949+
/// Timelock satisfaction is evaluated from the PSBT transaction fields. This method does not
1950+
/// redact or clear output metadata.
19451951
pub fn try_finalize_psbt(
19461952
&self,
19471953
psbt: &mut Psbt,

0 commit comments

Comments
 (0)