What the developer wrote
Authored by Mitchell Bagot
Fix to_secret_key docs on Keypair
The to_secret_key function docs state that it returns a PrivateKey
type, but the function actually returns a secp256k1::SecretKey.
Fix to_secret_key docs on Keypair to correctly reference
secp256k1::SecretKey return type.
What changed, and why it matters
This commit fixes a documentation comment for a Rust function. The comment previously said the function returned one type of private key object, but it actually returns a different, lower-level secret key type. There is no code behavior change and no security risk.
No action needed; this is a non-security documentation correction.
Security signals we found
No strong security signals were identified.
Evidence from the diff
The patch updates a doc comment on Keypair::to_secret_key in bitcoin/src/crypto/key.rs. The old comment claimed the return type was PrivateKey, but the function returns secp256k1::SecretKey. The implementation is unchanged.
Changed components
bitcoin/src/crypto/key.rs documentationInspect captured patch +1 / −1
diff --git a/bitcoin/src/crypto/key.rs b/bitcoin/src/crypto/key.rs
index b0f09d23..e43b993b 100644
--- a/bitcoin/src/crypto/key.rs
+++ b/bitcoin/src/crypto/key.rs
@@ -424,7 +424,7 @@ impl Keypair {
Self::from(secp256k1::Keypair::from_secret_key(sk))
}
- /// Returns the [`PrivateKey`] for this [`Keypair`].
+ /// Returns the [`secp256k1::SecretKey`] for this [`Keypair`].
///
/// This is equivalent to using [`secp256k1::SecretKey::from_keypair`] on the inner value.
#[inline]
Why this scored 15/100
Community notes
Notes can correct, qualify, or add evidence to the AI analysis. Every note shown here has been validated by a human moderator.
The AI analysis stands alone for now. Submit a note if you can add evidence or important context.