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

EN-01 About Documentation #81

Open
xoloki opened this issue May 15, 2024 · 0 comments
Open

EN-01 About Documentation #81

xoloki opened this issue May 15, 2024 · 0 comments
Assignees
Labels

Comments

@xoloki
Copy link
Collaborator

xoloki commented May 15, 2024

In auditing this project we also went through some alternative FROST implementations. We found the ZF Frost Book that accompanies the Z-Cash implementation to be helpful and suggest writing an analogous text. References to the FROST and WSTS papers, or the IETF standard are also welcome.
Documentation for relevant use cases is missing. In particular, there is no clear indication into what the interfaces that the library exposes to users since all functions are public. The most relevant files and functions should include more detailed documentation.
We also find that examples would complement very well with the code and provide a concise guide to library users (developers).

@xoloki xoloki added the audit label May 15, 2024
@xoloki xoloki self-assigned this May 15, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

1 participant