Skip to content

Commit 83a2245

Browse files
committed
Merge rust-bitcoin#643: Update docs to mention ECDSA
aa4489c 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 aa4489c Tree-SHA512: bb24d82f2bf316f8907b1bf02132d454d21f0b13d57f06f09f9985bc7fbf7b36e6972a0fdaf3a68967577dbe1995f2a14fd06fddd38eb46718f04bca1c50a445
2 parents d9aadc6 + aa4489c commit 83a2245

File tree

1 file changed

+6
-3
lines changed

1 file changed

+6
-3
lines changed

src/key.rs

+6-3
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,9 @@ use crate::{
2121
#[cfg(feature = "hashes")]
2222
use crate::{hashes, ThirtyTwoByteHash};
2323

24-
/// Secret 256-bit key used as `x` in an ECDSA signature.
24+
/// Secret key - a 256-bit key used to create ECDSA and Taproot signatures.
25+
///
26+
/// This value should be generated using a [cryptographically secure pseudorandom number generator].
2527
///
2628
/// # Side channel attacks
2729
///
@@ -50,6 +52,7 @@ use crate::{hashes, ThirtyTwoByteHash};
5052
/// ```
5153
/// [`bincode`]: https://docs.rs/bincode
5254
/// [`cbor`]: https://docs.rs/cbor
55+
/// [cryptographically secure pseudorandom number generator]: https://en.wikipedia.org/wiki/Cryptographically_secure_pseudorandom_number_generator
5356
#[derive(Copy, Clone)]
5457
pub struct SecretKey([u8; constants::SECRET_KEY_SIZE]);
5558
impl_display_secret!(SecretKey);
@@ -117,7 +120,7 @@ impl str::FromStr for SecretKey {
117120
}
118121
}
119122

120-
/// A Secp256k1 public key, used for verification of signatures.
123+
/// Public key - used to verify ECDSA signatures and to do Taproot tweaks.
121124
///
122125
/// # Serde support
123126
///
@@ -1082,7 +1085,7 @@ impl CPtr for Keypair {
10821085
fn as_mut_c_ptr(&mut self) -> *mut Self::Target { &mut self.0 }
10831086
}
10841087

1085-
/// An x-only public key, used for verification of schnorr signatures and serialized according to BIP-340.
1088+
/// An x-only public key, used for verification of Taproot signatures and serialized according to BIP-340.
10861089
///
10871090
/// # Serde support
10881091
///

0 commit comments

Comments
 (0)