Skip to content
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

Jump to bottom

Improving Message struct description #620

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Improving Message struct description #620

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
8 changes: 7 additions & 1 deletion src/lib.rs
View file
Open in desktop
Expand Up @@ -211,7 +211,13 @@ impl<T: hashes::sha256t::Tag> ThirtyTwoByteHash for hashes::sha256t::Hash<T> {
fn into_32(self) -> [u8; 32] { self.to_byte_array() }
}

/// A (hashed) message input to an ECDSA signature.
/// A (hashed) message input to an EC signature algorithm (such as ECDSA or Schnorr).
///
/// Message is invalid if
/// - Message has no content or has a length of zero.
/// - Message length doesn't match the expected size.
/// - Non hased message is passed as input.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think this comment is confusing. It's impossible for the length to differ from 32 bytes (which I guess is the "expected size"?) so it's impossible for a message to be invalid in this way.

"Non-hashed message" is also not very precisely defined. It's fine to tell people that this should always be the output of a hash function, and to point them to the [ThirtyTwoByteHash] trait (or whatever it's called) to help them with this, but it's not "invalid" otherwise because it's not well-defined what is the output of a hash function and what is not.

Invalid values are ones that will cause signature signing and verification to fail every time.

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ah I see. So can I write it like below instead of invalid ?

/// A valid Message is always of 32 Bytes.

///
#[derive(Copy, Clone, PartialEq, Eq, PartialOrd, Ord, Hash)]
pub struct Message([u8; constants::MESSAGE_SIZE]);
impl_array_newtype!(Message, u8, constants::MESSAGE_SIZE);
Expand Down