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

gnark-EdDSA-Verify example #1193

Open
hellojackhelloma opened this issue Jul 10, 2024 · 1 comment
Open

gnark-EdDSA-Verify example #1193

hellojackhelloma opened this issue Jul 10, 2024 · 1 comment

Comments

@hellojackhelloma
Copy link

I found some issues with the circuit code for EdDSA signature verification in the gnark official documentation. Additionally, there are no EdDSA signature verification examples in the gnark source code. I wrote one myself, and it is in the GitHub repository below. I hope it can be merged into the official codebase.

https://github.com/hellojackhelloma/gnark-EdDSA-Verify

@ivokub
Copy link
Collaborator

ivokub commented Jul 17, 2024

Thank you! It would be a great addition.

Would it be possible to create a PR implementing the example? For documentation purposes, it would be best to add a full-file example as described in https://pkg.go.dev/testing#hdr-Examples:

The entire test file is presented as the example when it contains a single example function, at least one other function, type, variable, or constant declaration, and no test or benchmark functions.

The example test could be created as a file std/signature/eddsa/doc_test.go. See for example https://github.com/Consensys/gnark/blob/master/std/algebra/emulated/sw_bn254/doc_test.go. This would be rendered as https://pkg.go.dev/github.com/consensys/[email protected]/std/algebra/emulated/sw_bn254#example-Pairing at the documentation site. The benefit of this approach is that these kinds of examples are testable in CI, so we can ensure that they are always up-to-date.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants