Skip to content

Commit 46d9dd2

Browse files
committed
Update API docs
1 parent 6cd1fb6 commit 46d9dd2

File tree

1 file changed

+18
-0
lines changed

1 file changed

+18
-0
lines changed

src/psbt/mod.rs

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -435,13 +435,22 @@ pub trait PsbtExt {
435435
/// See [finalizer::finalize_mall] if you want to allow malleable satisfactions
436436
///
437437
/// For finalizing individual inputs, see also [`PsbtExt::finalize_inp`]
438+
///
439+
/// # Errors:
440+
///
441+
/// - A vector of errors, one of each of failed finalized input
438442
fn finalize_mut<C: secp256k1::Verification>(
439443
&mut self,
440444
secp: &secp256k1::Secp256k1<C>,
441445
) -> Result<(), Vec<Error>>;
442446

443447
/// Same as [`PsbtExt::finalize_mut`], but does not mutate the input psbt and
444448
/// returns a new psbt
449+
///
450+
/// # Errors:
451+
///
452+
/// - Returns a mutated psbt with all inputs `finalize_mut` could finalize
453+
/// - A vector of input errors, one of each of failed finalized input
445454
fn finalize<C: secp256k1::Verification>(
446455
self,
447456
secp: &secp256k1::Secp256k1<C>,
@@ -462,13 +471,22 @@ pub trait PsbtExt {
462471
/// Same as [`PsbtExt::finalize_mut`], but only tries to finalize a single input leaving other
463472
/// inputs as is. Use this when not all of inputs that you are trying to
464473
/// satisfy are miniscripts
474+
///
475+
/// # Errors:
476+
///
477+
/// - Input error detailing why the finalization failed. The psbt is not mutated when the finalization fails
465478
fn finalize_inp_mut<C: secp256k1::Verification>(
466479
&mut self,
467480
secp: &secp256k1::Secp256k1<C>,
468481
index: usize,
469482
) -> Result<(), Error>;
470483

471484
/// Same as [`PsbtExt::finalize_inp_mut`], but does not mutate the psbt and returns a new one
485+
///
486+
/// # Errors:
487+
/// Returns a tuple containing
488+
/// - Original psbt
489+
/// - Input Error detailing why the input finalization failed
472490
fn finalize_inp<C: secp256k1::Verification>(
473491
self,
474492
secp: &secp256k1::Secp256k1<C>,

0 commit comments

Comments
 (0)