chore(circuits): Restructure Merkle tree templates into separate files #2362
+222
−196
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
knelsondev
requested review from
ctrlc03,
0xmad and
NicoSerranoP
as code owners
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
- Introduced new templates for Merkle tree operations: `BinaryMerkleRoot`, `CheckRoot`, `LeafExists`, `MerkleTreeInclusionProof`, and `MerkleGeneratePathIndices`. - Refactored `incrementalMerkleTree.circom` to include these new templates, improving modularity and maintainability of the codebase.
0xmad
force-pushed
the
chore/circuits-split-merkle-templats
branch
from
e2eb0dc to
79593e5
Compare
0xmad
requested changes
Apr 14, 2025
There was a problem hiding this comment.
@knelsondev thanks, just one suggestion and please add new lines at the end of newly added files.
Comment on lines
+3
to
+9
| // Include the individual Merkle tree utility templates. | ||
| // These files were created by splitting the original content of this file. | ||
| include "./MerkleTreeInclusionProof.circom"; | ||
| include "./LeafExists.circom"; | ||
| include "./CheckRoot.circom"; | ||
| include "./MerkleGeneratePathIndices.circom"; | ||
| include "./BinaryMerkleRoot.circom"; |
There was a problem hiding this comment.
Why do you keep only imports here? Does it make sense to remove this file and use these imports where they are needed?
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
Introduced new templates for Merkle tree operations:
BinaryMerkleRoot,CheckRoot,LeafExists,MerkleTreeInclusionProof, andMerkleGeneratePathIndices.incrementalMerkleTree.circomto include these new templates, improving modularity and maintainability of the codebase.This pull request addresses issue #1419 by restructuring the Circom templates located in
packages/circuits/circom/utils/trees/incrementalMerkleTree.circom.Previously, this single file contained multiple template definitions related to Merkle tree operations (
MerkleTreeInclusionProof,LeafExists,CheckRoot,MerkleGeneratePathIndices,BinaryMerkleRoot).To improve code organization and modularity, each template has been extracted into its own dedicated file within the same directory (
packages/circuits/circom/utils/trees/).The original
incrementalMerkleTree.circomfile has been updated to simply include these new, individual template files. This ensures that existing circuits which depend onincrementalMerkleTree.circomcontinue to function without modification, as they will now implicitly import all the necessary templates via the updated include statements.Additional Notes
No additional notes.
Related issue(s)
Confirmation
Important
We do not accept minor grammatical fixes (e.g., correcting typos, rewording sentences) unless they significantly improve clarity in technical documentation. These contributions, while appreciated, are not a priority for merging. If there is a grammatical error feel free to message the team.
Additional Notes
Related issue(s)
Confirmation
Important
We do not accept minor grammatical fixes (e.g., correcting typos, rewording sentences) unless they significantly improve clarity in technical documentation. These contributions, while appreciated, are not a priority for merging. If there is a grammatical error feel free to message the team.