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

Separate simple_example into "simple circuit" and "simple gadget" #727

Open
str4d opened this issue Jan 25, 2023 · 1 comment
Open

Separate simple_example into "simple circuit" and "simple gadget" #727

str4d opened this issue Jan 25, 2023 · 1 comment
Labels
A-book Area: The Halo 2 book A-documentation Area: Improvements or additions to documentation E-good-first-issue Effort: Suitable for someone new to the codebase. E-help-wanted Call for participation: Help is requested to fix this issue.

Comments

@str4d
Copy link
Contributor

str4d commented Jan 25, 2023

https://zcash.github.io/halo2/user/simple-example.html renders https://github.com/zcash/halo2/blob/main/halo2_proofs/examples/simple-example.rs in the book to guide people in how to use halo2_proofs. However, it is really two examples in one:

  • How to build a simple gadget and chip.
  • How to construct a simple circuit.

We should split these into two separate examples in the book, and use existing gadgets for the latter. Note that this will require a separate example under halo2_gadgets, as we don't have access to that library of gadgets inside halo2_proofs.

@str4d str4d added A-documentation Area: Improvements or additions to documentation A-book Area: The Halo 2 book labels Jan 25, 2023
@str4d
Copy link
Contributor Author

str4d commented Feb 3, 2023

Hmm, it might actually be better to write a separate "simple example", because halo2_gadgets does not (currently) have gadgets for arbitrary integer addition (only ECC math). So it would probably be better to write a separate example using one of the existing gadgets (e.g. Poseidon, or some of the ECC gadget).

@str4d str4d added E-good-first-issue Effort: Suitable for someone new to the codebase. E-help-wanted Call for participation: Help is requested to fix this issue. labels Feb 3, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
A-book Area: The Halo 2 book A-documentation Area: Improvements or additions to documentation E-good-first-issue Effort: Suitable for someone new to the codebase. E-help-wanted Call for participation: Help is requested to fix this issue.
Projects
None yet
Development

No branches or pull requests

2 participants
@str4d and others