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.

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

No documentation on byte layout or formatting #171

Open
ShadowJonathan opened this issue May 20, 2021 · 0 comments
Open

No documentation on byte layout or formatting #171

ShadowJonathan opened this issue May 20, 2021 · 0 comments
Labels
do-for-2.0 This should be resolved before a 2.0 release

Comments

@ShadowJonathan
Copy link

Partially re: #17 (comment), I'm currently coming across the problem of seeing all {to,from,as}_bytes functions documented with nothing more but stubs.

I do, for example, not know if the formatting of those bytes are specific to ed25519-dalek, if they're generic DER formats, or if it is any other kind of format, I do not know what I can feed it to give me a valid result, and figuring this out requires me to annotate my own code as to what the functions from this library are actually doing.


Also, the documentation here comes over as unnecessarily hostile to the user of this library;

Absolutely no validation is done on the key. If you give this function bytes which do not represent a valid point, or which do not represent corresponding parts of the key, then your Keypair will be broken and it will be your fault.

@rozbb rozbb added the do-for-2.0 This should be resolved before a 2.0 release label Jan 20, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
do-for-2.0 This should be resolved before a 2.0 release
Projects
None yet
Development

No branches or pull requests

2 participants