docs(ed25519): fix type names and method calls in README#61
Merged
arihantbansal merged 1 commit intoarcium-hq:mainfrom Mar 8, 2026
Merged
Conversation
The README showed CompressedVerifyingKey and VerifyingKey::from_compressed() but the actual code uses Pack<VerifyingKey> and .to_arcis().unpack().
giwaov
force-pushed
the
fix/ed25519-readme-type-names
branch
from
471b551 to
1306b9d
Compare
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Summary
CompressedVerifyingKey→Pack<VerifyingKey>in README code snippetVerifyingKey::from_compressed(...to_arcis())→.to_arcis().unpack()verifying_key_compressed_enc→verifying_key_encIssue
The README's
verify_signaturesnippet showed types and methods that don't exist in the actual implementation, which would mislead developers trying to follow the example.Verification
Confirmed against actual code in
ed25519/encrypted-ixs/src/lib.rs.Test plan