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

Merge rust-bitcoin/rust-secp256k1#643: Update docs to mention ECDSA 

aa4489c71b key: Improve docs (Tobin C. Harding)

Pull request description:

  `PublicKey` types are for verifying ECDSA signatures, when these docs where written there were no other types of signatures. With the addition of taproot these docs have become stale.

ACKs for top commit:
  apoelstra:
    ACK aa4489c71b

Tree-SHA512: bb24d82f2bf316f8907b1bf02132d454d21f0b13d57f06f09f9985bc7fbf7b36e6972a0fdaf3a68967577dbe1995f2a14fd06fddd38eb46718f04bca1c50a445
This commit is contained in:
Andrew Poelstra 2023-08-20 14:03:37 +00:00
parent d9aadc6eaa aa4489c71b
commit 83a2245582
No known key found for this signature in database
GPG Key ID: C588D63CE41B97C1
1 changed files with 6 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
src/key.rs
View File

@ -21,7 +21,9 @@ use crate::{
#[cfg(feature = "hashes")] #[cfg(feature = "hashes")]
use crate::{hashes, ThirtyTwoByteHash}; use crate::{hashes, ThirtyTwoByteHash};
/// Secret 256-bit key used as `x` in an ECDSA signature. /// Secret key - a 256-bit key used to create ECDSA and Taproot signatures.
///
/// This value should be generated using a [cryptographically secure pseudorandom number generator].
/// ///
/// # Side channel attacks /// # Side channel attacks
/// ///
@ -50,6 +52,7 @@ use crate::{hashes, ThirtyTwoByteHash};
/// ``` /// ```
/// [`bincode`]: https://docs.rs/bincode /// [`bincode`]: https://docs.rs/bincode
/// [`cbor`]: https://docs.rs/cbor /// [`cbor`]: https://docs.rs/cbor
/// [cryptographically secure pseudorandom number generator]: https://en.wikipedia.org/wiki/Cryptographically_secure_pseudorandom_number_generator
#[derive(Copy, Clone)] #[derive(Copy, Clone)]
pub struct SecretKey([u8; constants::SECRET_KEY_SIZE]); pub struct SecretKey([u8; constants::SECRET_KEY_SIZE]);
impl_display_secret!(SecretKey); impl_display_secret!(SecretKey);
@ -117,7 +120,7 @@ impl str::FromStr for SecretKey {
} }
} }
/// A Secp256k1 public key, used for verification of signatures. /// Public key - used to verify ECDSA signatures and to do Taproot tweaks.
/// ///
/// # Serde support /// # Serde support
/// ///
@ -1082,7 +1085,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 Taproot signatures and serialized according to BIP-340.
/// ///
/// # Serde support /// # Serde support
/// ///