Skip to content

Commit

Permalink
[frost] Renaming and docs
Browse files Browse the repository at this point in the history
  • Loading branch information
LLFourn committed Jul 26, 2024
1 parent 40191a9 commit 4e1d33e
Show file tree
Hide file tree
Showing 4 changed files with 7 additions and 7 deletions.
4 changes: 2 additions & 2 deletions ecdsa_fun/src/adaptor/mod.rs
Original file line number Diff line number Diff line change
Expand Up @@ -234,9 +234,9 @@ impl<T: Transcript<DLEQ>, NG> Adaptor<T, NG> {
/// There are two crucial things to understand when calling this:
///
/// 1. You should be certain that the encrypted signature is what you think it is by calling
/// [`verify_encrypted_signature`] on it first.
/// [`verify_encrypted_signature`] on it first.
/// 2. Once you give the decrypted signature to anyone who has seen `encrypted_signature` they will be
/// able to learn `decryption_key` by calling [`recover_decryption_key`].
/// able to learn `decryption_key` by calling [`recover_decryption_key`].
///
/// See [synopsis] for an example
///
Expand Down
4 changes: 2 additions & 2 deletions schnorr_fun/src/adaptor/mod.rs
Original file line number Diff line number Diff line change
Expand Up @@ -153,9 +153,9 @@ pub trait Adaptor {
/// There are two crucial things to understand when calling this:
///
/// 1. You should be certain that the encrypted signature is what you think it is by calling
/// [`verify_encrypted_signature`] on it first.
/// [`verify_encrypted_signature`] on it first.
/// 2. Once you give the decrypted signature to anyone who has seen `encrypted_signature` they will be
/// able to learn `decryption_key` by calling [`recover_decryption_key`].
/// able to learn `decryption_key` by calling [`recover_decryption_key`].
///
/// See [synopsis] for an example
///
Expand Down
2 changes: 1 addition & 1 deletion schnorr_fun/src/frost/mod.rs
Original file line number Diff line number Diff line change
Expand Up @@ -136,7 +136,7 @@
//! Signatures]*.
//!
//! > ⚠️ At this stage this implementation is for API exploration purposes only. The way it is
//! currently implemented is not proven secure.
//! > currently implemented is not proven secure.
//!
//! ## Polynomial Generation
//!
Expand Down
4 changes: 2 additions & 2 deletions schnorr_fun/src/musig.rs
Original file line number Diff line number Diff line change
Expand Up @@ -339,8 +339,8 @@ where
/// - `agg_key`: the joint public key we are signing under. This can be an `XOnly` or `Normal`.
/// It will return the same nonce regardless.
/// - `secret`: you're secret key as part of `agg_key`. This **must be the secret key you are
/// going to sign with**. It cannot be an "untweaked" version of the signing key. It must be
/// exactly equal to the secret key you pass to [`sign`] (the MuSig specification requires this).
/// going to sign with**. It cannot be an "untweaked" version of the signing key. It must be
/// exactly equal to the secret key you pass to [`sign`] (the MuSig specification requires this).
/// - `session_id`: a string of bytes that is **unique for each signing attempt**.
///
/// The application should decide upon a unique `session_id` per call to this function. If the
Expand Down

0 comments on commit 4e1d33e

Please sign in to comment.