Skip to content

ed: Removed warning in docs for VerifyingKey::from_bytes #653

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

ed: Removed warning in docs for VerifyingKey::from_bytes #653

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
78dfb48
Removed warning in docs for VerifyingKey::from_bytes
rozbb May 10, 2024
cd3ddd8
Tightened wording
rozbb May 10, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 3 additions & 8 deletions ed25519-dalek/src/verifying.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -124,12 +124,6 @@ impl VerifyingKey {

/// Construct a `VerifyingKey` from a slice of bytes.
///
/// # Warning
///
/// The caller is responsible for ensuring that the bytes passed into this
/// method actually represent a `curve25519_dalek::curve::CompressedEdwardsY`
/// and that said compressed point is actually a point on the curve.
///
/// # Example
///
/// ```
Expand All @@ -154,8 +148,9 @@ impl VerifyingKey {
///
/// # Returns
///
/// A `Result` whose okay value is an EdDSA `VerifyingKey` or whose error value
/// is a `SignatureError` describing the error that occurred.
/// On success, returns an EdDSA `VerifyingKey`. Returns a decompression error if the provided
/// bytes are not a valid verifying key, i.e., do not represent the \\(y\\)-coordinate of a
/// curve point.
#[inline]
pub fn from_bytes(bytes: &[u8; PUBLIC_KEY_LENGTH]) -> Result<VerifyingKey, SignatureError> {
let compressed = CompressedEdwardsY(*bytes);
Expand Down