Improve docs w.r.t. PSBT finalization
This commit is contained in:
parent
562cb81cad
commit
8963e8c9f4
@ -1196,7 +1196,12 @@ where
|
||||
}
|
||||
}
|
||||
|
||||
/// Try to finalize a PSBT
|
||||
/// Finalize a PSBT, i.e., for each input determine if sufficient data is available to pass
|
||||
/// validation and construct the respective `scriptSig` or `scriptWitness`. Please refer to
|
||||
/// [BIP174](https://github.com/bitcoin/bips/blob/master/bip-0174.mediawiki#Input_Finalizer)
|
||||
/// for further information.
|
||||
///
|
||||
/// Returns `true` if the PSBT could be finalized, and `false` otherwise.
|
||||
///
|
||||
/// The [`SignOptions`] can be used to tweak the behavior of the finalizer.
|
||||
pub fn finalize_psbt(
|
||||
|
@ -696,14 +696,14 @@ pub struct SignOptions {
|
||||
/// Defaults to `false` which will only allow signing using `SIGHASH_ALL`.
|
||||
pub allow_all_sighashes: bool,
|
||||
|
||||
/// Whether to remove partial_sigs from psbt inputs while finalizing psbt.
|
||||
/// Whether to remove partial signatures from the PSBT inputs while finalizing PSBT.
|
||||
///
|
||||
/// Defaults to `true` which will remove partial_sigs after finalizing.
|
||||
/// Defaults to `true` which will remove partial signatures during finalization.
|
||||
pub remove_partial_sigs: bool,
|
||||
|
||||
/// Whether to try finalizing psbt input after the inputs are signed.
|
||||
/// Whether to try finalizing the PSBT after the inputs are signed.
|
||||
///
|
||||
/// Defaults to `true` which will try fianlizing psbt after inputs are signed.
|
||||
/// Defaults to `true` which will try finalizing PSBT after inputs are signed.
|
||||
pub try_finalize: bool,
|
||||
|
||||
/// Specifies which Taproot script-spend leaves we should sign for. This option is
|
||||
|
Loading…
x
Reference in New Issue
Block a user