crypto: Adjust SerializedLegacyPublicKey docs
What the developer wrote
Authored by Mitchell Bagot
crypto: Adjust SerializedLegacyPublicKey docs
The SerializedLegacyPublicKey docs don't mention the maximum size or
the lack of allocations like the ecdsa::SerializedSignature docs do.
Adjust wording of docs to mention lack of allocation and max size of
65 bytes.
What changed, and why it matters
This commit only changes documentation wording for a Rust Bitcoin data type. It adds a note that the serialized legacy public key type avoids heap allocation and has a maximum size of 65 bytes. No code behavior was altered.
No action needed; this is a non-functional documentation-only change.
Security signals we found
No strong security signals were identified.
Evidence from the diff
The diff modifies a doc comment in crypto/src/key.rs for SerializedLegacyPublicKey. It rephrases the description and adds two factual claims already implied by the underlying ArrayVec
Changed components
crypto/src/key.rs documentationInspect captured patch +3 / −2
diff --git a/crypto/src/key.rs b/crypto/src/key.rs
index 46d4ca94..07b4be52 100644
--- a/crypto/src/key.rs
+++ b/crypto/src/key.rs
@@ -288,8 +288,9 @@ mod serialized_legacy_public_key {
/// A serialized form of `LegacyPublicKey`.
///
- /// This type contains the legacy public key in serialized as either compressed or
- /// uncompressed. The type implements the standard conversion traits so it behaves a lot like
+ /// This type contains the legacy public key serialized in either compressed or
+ /// uncompressed form, without allocating and guaranteeing a maximum size of 65 bytes.
+ /// The type implements the standard conversion traits so it behaves a lot like
/// an array.
#[derive(Debug, Copy, Clone, Eq, PartialEq, Ord, PartialOrd, Hash)]
pub struct SerializedLegacyPublicKey(ArrayVec<u8, 65>);
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.