From 4e1d33e8579cdfdfdb87d5d58d92b787b967ebb9 Mon Sep 17 00:00:00 2001 From: LLFourn Date: Fri, 26 Jul 2024 17:26:52 +1000 Subject: [PATCH] [frost] Renaming and docs --- ecdsa_fun/src/adaptor/mod.rs | 4 ++-- schnorr_fun/src/adaptor/mod.rs | 4 ++-- schnorr_fun/src/frost/mod.rs | 2 +- schnorr_fun/src/musig.rs | 4 ++-- 4 files changed, 7 insertions(+), 7 deletions(-) diff --git a/ecdsa_fun/src/adaptor/mod.rs b/ecdsa_fun/src/adaptor/mod.rs index c5ecf11c..06727eb2 100644 --- a/ecdsa_fun/src/adaptor/mod.rs +++ b/ecdsa_fun/src/adaptor/mod.rs @@ -234,9 +234,9 @@ impl, NG> 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 /// diff --git a/schnorr_fun/src/adaptor/mod.rs b/schnorr_fun/src/adaptor/mod.rs index 660bc5c2..a188e478 100644 --- a/schnorr_fun/src/adaptor/mod.rs +++ b/schnorr_fun/src/adaptor/mod.rs @@ -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 /// diff --git a/schnorr_fun/src/frost/mod.rs b/schnorr_fun/src/frost/mod.rs index cd1a0d99..2dda37cd 100644 --- a/schnorr_fun/src/frost/mod.rs +++ b/schnorr_fun/src/frost/mod.rs @@ -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 //! diff --git a/schnorr_fun/src/musig.rs b/schnorr_fun/src/musig.rs index c52206f3..78142478 100644 --- a/schnorr_fun/src/musig.rs +++ b/schnorr_fun/src/musig.rs @@ -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