keypair / signature / ed25519: Deprecate dalek types from public API #107
Conversation
This file contains hidden or 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
febo
reviewed
Apr 1, 2025
febo
reviewed
Apr 1, 2025
febo
reviewed
Apr 1, 2025
| pub fn new_ed25519_instruction_with_signature( | ||
| message: &[u8], | ||
| signature: &[u8; SIGNATURE_SERIALIZED_SIZE], | ||
| pubkey: &[u8; PUBKEY_SERIALIZED_SIZE], |
There was a problem hiding this comment.
These changes make a lot of sense.
There was a problem hiding this comment.
ok great! I tried to follow other verification method signatures like https://docs.rs/ed25519-dalek/latest/ed25519_dalek/fn.verify_batch.html, which go message, then signature, then verifying key
febo
reviewed
Apr 1, 2025
febo
approved these changes
Apr 1, 2025
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.
Problem
The keypair, signature, and ed25519-program crates all expose
ed25519_dalektypes in their public APIs, either as inputs or outputs.This makes it difficult to land PRs like #26, since we'll just end up causing breaking changes.
Summary of changes
Rather than constantly break APIs whenever the ed25519_dalek crates publishes a new major version, deprecate all functions that use ed25519_dalek types and add non-dalek versions.
As part of this work, I copied over the Signature error from RustCrypto to use as a generic error. That way, we can choose when to make breaking changes, independent of dependency bumps. I wasn't able to do the same thing since we're not ready to start using
core::error::Erroreverywhere.cc @kevinheavey