Enhance MACI circuits readability #1337
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
|
Love to see this 🙏😍 |
0xjei
requested review from
ctrlc03,
kittybest,
0xmad,
samajammin and
crisgarner
as code owners
ctrlc03
reviewed
Apr 19, 2024
ctrlc03
reviewed
Apr 19, 2024
ctrlc03
reviewed
Apr 19, 2024
ctrlc03
reviewed
Apr 19, 2024
0xjei
force-pushed
the
ref/circuits
branch
2 times, most recently
from
59d4edd to
797f29b
Compare
kittybest
reviewed
Apr 19, 2024
0xjei
force-pushed
the
ref/circuits
branch
2 times, most recently
from
7f60c95 to
1f23dac
Compare
ctrlc03
approved these changes
May 1, 2024
… MACI non-core circuits
…templates qv and non-qv
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
This PR aims to improve the readability of MACI's circuits by introducing precise documentation and refactoring the code to introduce Circom's Anonymous Components and Tuples feature. Also, lighten the circuits by removing unused ones and importing as much as possible from external libraries such as
circomlibandzk-kit.This PR also introduces a significant change to the structure of the
Circuitspackage. Specifically:corecontains onlyprocessMessagesandtallyVoteswith their supporting templates for qv and non-qv version.treescontains IQT and IMTutilscontains all templates that are not a core part of those in the root. Also, when necessary, they are subdivided between qv and non-qv.Note the respective QV e NonQV versions of the templates are located in the same file.
Related issue(s)
See privacy-scaling-explorations/zk-kit#131 (last rewrite).
Confirmation