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

docs to generate GnarkPlonk proofs #242

Draft
wants to merge 15 commits into
base: staging
Choose a base branch
from

Conversation

jotabulacios
Copy link
Contributor

How to test

After generating the proof, you will have to have three different files:

  • proof file
  • verification key file
  • public input file

Then, you can send the proof to the AlignedLayer network by running the following command
from batcher/client folder inside the AlignedLayer repository directory:

cargo run --release -- \
--proving_system GnarkPlonkBn254 \
--proof <proof_path> \
--public_input <public_input_path> \
--vk <verification_key_path> \

```bash
go get github.com/consensys/gnark@latest
```
- gnark project to generate the proofs, instructions[ here](https://docs.gnark.consensys.io/category/how-to)
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm not sure if this guide is the best for generating a proof. Maybe we could add a HackMD
https://hackmd.io/@xr7wfZ30Q3eKDrtinAJaOQ/B1cp2nV4A

@jotabulacios jotabulacios marked this pull request as ready for review May 29, 2024 20:03
Copy link
Contributor

@MauroToscano MauroToscano left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

change the Docs file to docs/gnark_example.md, then link it in the readme

Copy link
Contributor

@MauroToscano MauroToscano left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

  • Gnark version should be pinned to the one we use in Aligned, not latest
  • We already have a section for sending Gnark Proofs, we can add the new text to that one. The important part is to mention you have to add code to your circuit to export the data Aligned needs. We can link the guide on how to do so. It should be one paragraph more, or a couple of lines

@Oppen Oppen marked this pull request as draft October 31, 2024 18:11
@Oppen
Copy link
Collaborator

Oppen commented Oct 31, 2024

Converted to draft due to not being a priority for mainnet

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

Successfully merging this pull request may close these issues.

3 participants