3.11 Better document API expectations

This commit is contained in:
Luke Parker
2023-07-19 23:51:21 -04:00
parent df67b7d94c
commit 6f9d02fdf8
3 changed files with 11 additions and 3 deletions

View File

@@ -245,7 +245,7 @@ impl SignableTransaction {
/// A FROST signing machine to produce a Bitcoin transaction.
///
/// This does not support caching its preprocess. When sign is called, the message must be empty.
/// This will panic if it isn't.
/// This will panic if either `cache` is called or the message isn't empty.
pub struct TransactionMachine {
tx: SignableTransaction,
sigs: Vec<AlgorithmMachine<Secp256k1, Schnorr<RecommendedTranscript>>>,