milksad
/
rust-secp256k1-unsafe-fast
14
0
Fork 0
Code Issues Pull Requests Activity

Use lowercase for schnorr 

In docs "schnorr signature" does not need, or deserve, a capital letter.
This commit is contained in:
Tobin C. Harding 2022-11-24 11:16:17 +11:00
parent 27b3e92889
commit 47f19a78ef
3 changed files with 9 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
src/constants.rs
View File

@ -34,10 +34,10 @@ pub const MAX_SIGNATURE_SIZE: usize = 72;
/// The maximum size of a compact signature. /// The maximum size of a compact signature.
pub const COMPACT_SIGNATURE_SIZE: usize = 64; pub const COMPACT_SIGNATURE_SIZE: usize = 64;
/// The size of a Schnorr signature. /// The size of a schnorr signature.
pub const SCHNORR_SIGNATURE_SIZE: usize = 64; pub const SCHNORR_SIGNATURE_SIZE: usize = 64;
/// The size of a Schnorr public key. /// The size of a schnorr public key.
pub const SCHNORR_PUBLIC_KEY_SIZE: usize = 32; pub const SCHNORR_PUBLIC_KEY_SIZE: usize = 32;
/// The size of a key pair. /// The size of a key pair.

6
src/key.rs
View File

@ -1078,7 +1078,7 @@ impl CPtr for KeyPair {
fn as_mut_c_ptr(&mut self) -> *mut Self::Target { &mut self.0 } fn as_mut_c_ptr(&mut self) -> *mut Self::Target { &mut self.0 }
} }
/// An x-only public key, used for verification of Schnorr signatures and serialized according to BIP-340. /// An x-only public key, used for verification of schnorr signatures and serialized according to BIP-340.
/// ///
/// # Serde support /// # Serde support
/// ///
@ -1165,7 +1165,7 @@ impl XOnlyPublicKey {
} }
} }
/// Creates a Schnorr public key directly from a slice. /// Creates a schnorr public key directly from a slice.
/// ///
/// # Errors /// # Errors
/// ///
@ -1472,7 +1472,7 @@ impl CPtr for XOnlyPublicKey {
fn as_mut_c_ptr(&mut self) -> *mut Self::Target { &mut self.0 } fn as_mut_c_ptr(&mut self) -> *mut Self::Target { &mut self.0 }
} }
/// Creates a new Schnorr public key from a FFI x-only public key. /// Creates a new schnorr public key from a FFI x-only public key.
impl From<ffi::XOnlyPublicKey> for XOnlyPublicKey { impl From<ffi::XOnlyPublicKey> for XOnlyPublicKey {
#[inline] #[inline]
fn from(pk: ffi::XOnlyPublicKey) -> XOnlyPublicKey { XOnlyPublicKey(pk) } fn from(pk: ffi::XOnlyPublicKey) -> XOnlyPublicKey { XOnlyPublicKey(pk) }

8
src/schnorr.rs
View File

@ -1,4 +1,4 @@
//! Support for Schnorr signatures. //! Support for schnorr signatures.
//! //!
use core::{fmt, ptr, str}; use core::{fmt, ptr, str};
@ -14,7 +14,7 @@ use crate::{
constants, from_hex, impl_array_newtype, Error, Message, Secp256k1, Signing, Verification, constants, from_hex, impl_array_newtype, Error, Message, Secp256k1, Signing, Verification,
}; };
/// Represents a Schnorr signature. /// Represents a schnorr signature.
#[derive(Copy, Clone)] #[derive(Copy, Clone)]
pub struct Signature([u8; constants::SCHNORR_SIGNATURE_SIZE]); pub struct Signature([u8; constants::SCHNORR_SIGNATURE_SIZE]);
impl_array_newtype!(Signature, u8, constants::SCHNORR_SIGNATURE_SIZE); impl_array_newtype!(Signature, u8, constants::SCHNORR_SIGNATURE_SIZE);
@ -132,7 +132,7 @@ impl<C: Signing> Secp256k1<C> {
self.sign_schnorr_helper(msg, keypair, ptr::null()) self.sign_schnorr_helper(msg, keypair, ptr::null())
} }
/// Create a Schnorr signature using the given auxiliary random data. /// Create a schnorr signature using the given auxiliary random data.
pub fn sign_schnorr_with_aux_rand( pub fn sign_schnorr_with_aux_rand(
&self, &self,
msg: &Message, msg: &Message,
@ -159,7 +159,7 @@ impl<C: Signing> Secp256k1<C> {
} }
impl<C: Verification> Secp256k1<C> { impl<C: Verification> Secp256k1<C> {
/// Verify a Schnorr signature. /// Verify a schnorr signature.
pub fn verify_schnorr( pub fn verify_schnorr(
&self, &self,
sig: &Signature, sig: &Signature,