vplasencia commented 6 months ago

Description

This PR adds tree depth constants to JavaScript libraries and Solidity contracts to follow good practices and make it easier to update these important values.

JavaScript libraries:

There is a new export in the @semaphore-protocol/utils library called constants which has the minimum and maximum Semaphore supported tree depth.

Solidity contracts:

There is a new file called Constants.sol in the packages/contracts/contracts/base folder which has the minimum and maximum Semaphore supported tree depth.

With these updates, when the supported tree depths change, only these two files should be updated with the VK_POINTS variable in the SemaphoreVerifier.sol contract.

Related Issue(s)

Closes #683

Checklist

[x] My code follows the style guidelines of this project
[x] I have performed a self-review of my code
[x] I have commented my code, particularly in hard-to-understand areas
[ ] I have made corresponding changes to the documentation
[x] My changes generate no new warnings
[x] I have run yarn prettier and yarn lint without getting any errors
[ ] I have added tests that prove my fix is effective or that my feature works
[x] New and existing unit tests pass locally with my changes
[x] Any dependent changes have been merged and published in downstream modules

openzeppelin-code[bot] commented 6 months ago

Add tree depth constants to JavaScript libraries and Solidity contracts

Generated at commit: c3b9b98370598b78bc1d6d9d7e91546773f37631

🚨 Report Summary

Severity Level Results

Contracts Critical
High
Medium
Low
Note
Total 0
0
0
4
16
20

Dependencies Critical
High
Medium
Low
Note
Total 0
0
0
0
0
0

For more details view the full report in OpenZeppelin Code Inspector

	Severity Level	Results
Contracts	Critical High Medium Low Note Total	0 0 0 4 16 20
Dependencies	Critical High Medium Low Note Total	0 0 0 0 0 0