frost/bdk
3
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Document return type of sign method.

Browse Source 
Small thing but I had to look up the code to see what the returned boolean was about, thought it might be good to have in the docs.
This commit is contained in:
Thibaut Le Guilly 2023-01-13 20:55:38 +09:00 committed by Tibo-lg
parent 2e7a220e39
commit ff72078095
No known key found for this signature in database
GPG Key ID: 05ACEE231816F246
1 changed files with 1 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
src/wallet/mod.rs
View File

@ -1084,7 +1084,7 @@ where
}
/// Sign a transaction with all the wallet's signers, in the order specified by every signer's
/// [`SignerOrdering`]
/// [`SignerOrdering`]. This function returns the `Result` type with an encapsulated `bool` that has the value true if the PSBT was finalized, or false otherwise.
///
/// The [`SignOptions`] can be used to tweak the behavior of the software signers, and the way
/// the transaction is finalized at the end. Note that it can't be guaranteed that *every*