Remove cautionary usage warning from PublicKey::from_bytes
#150
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This warning implies that users of `PublicKey::from_bytes` must do separate validation before calling it. This used to be the case, but the eager decompression added in dalek-cryptography@8dbaf9a means that `PublicKey::from_bytes(bytes).is_ok()` implies that `bytes` represents a valid `CompressedEdwardsY`.
|
I'm running into the same documentation issue. Will this be merged? |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This warning implies that users of
PublicKey::from_bytesmust doseparate validation before calling it. This used to be the case, but the
eager decompression added in
8dbaf9a
means that
PublicKey::from_bytes(bytes).is_ok()implies thatbytesrepresents a valid
CompressedEdwardsY.