feat(merkleroot-gatekeeper): adds a gatekeeper that uses merkle tree #1821
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
crisgarner
requested review from
ctrlc03,
kittybest and
0xmad
as code owners
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
![github-advanced-security[bot]](https://avatars.githubusercontent.com/in/57789?s=60&v=4){kind=small}
Comment on lines
12
to
71
| contract MerkleProofGatekeeper is SignUpGatekeeper, Ownable(msg.sender) { | ||
| // the merkle tree root | ||
| bytes32 public root; | ||
|
|
||
| /// @notice the reference to the MACI contract | ||
| address public maci; | ||
|
|
||
| // a mapping of addresses that have already registered | ||
| mapping(address => bool) public registeredProofs; | ||
|
|
||
| /// @notice custom errors | ||
| error InvalidProof(); | ||
| error AlreadyRegistered(); | ||
| error OnlyMACI(); | ||
| error ZeroAddress(); | ||
| error InvalidRoot(); | ||
|
|
||
| /// @notice Deploy an instance of MerkleProofGatekeeper | ||
| /// @param _root The tree root | ||
| constructor(bytes32 _root) payable { | ||
| if (_root == bytes32(0)) revert InvalidRoot(); | ||
| root = _root; | ||
| } | ||
|
|
||
| /// @notice Adds an uninitialised MACI instance to allow for token signups | ||
| /// @param _maci The MACI contract interface to be stored | ||
| function setMaciInstance(address _maci) public override onlyOwner { | ||
| if (_maci == address(0)) revert ZeroAddress(); | ||
| maci = _maci; | ||
| } | ||
|
|
||
| /// @notice Register an user based on being part of the tree | ||
| /// @dev Throw if the proof is not valid or the user has already been registered | ||
| /// @param _user The user's Ethereum address. | ||
| /// @param _data The proof athat the user is part of the tree. | ||
| function register(address _user, bytes memory _data) public override { | ||
| // ensure that the caller is the MACI contract | ||
| if (maci != msg.sender) revert OnlyMACI(); | ||
|
|
||
| bytes32[] memory proof = abi.decode(_data, (bytes32[])); | ||
|
|
||
| // ensure that the user has not been registered yet | ||
| if (registeredProofs[_user]) revert AlreadyRegistered(); | ||
|
|
||
| // register the user so it cannot be called again with the same one | ||
| registeredProofs[_user] = true; | ||
|
|
||
| // get the leaf | ||
| bytes32 leaf = keccak256(bytes.concat(keccak256(abi.encode(_user)))); | ||
|
|
||
| // check the proof | ||
| if (!MerkleProof.verify(proof, root, leaf)) revert InvalidProof(); | ||
| } | ||
|
|
||
| /// @notice Get the trait of the gatekeeper | ||
| /// @return The type of the gatekeeper | ||
| function getTrait() public pure override returns (string memory) { | ||
| return "MerkleProof"; | ||
| } | ||
| } |
Check warning
Code scanning / Slither
Contracts that lock Ether Medium
packages/contracts/contracts/gatekeepers/MerkleProofGatekeeper.sol
Fixed
Show resolved
Hide resolved
|
|
||
| /// @notice Adds an uninitialised MACI instance to allow for token signups | ||
| /// @param _maci The MACI contract interface to be stored | ||
| function setMaciInstance(address _maci) public override onlyOwner { |
Check warning
Code scanning / Slither
Conformance to Solidity naming conventions Warning
| /// @dev Throw if the proof is not valid or the user has already been registered | ||
| /// @param _user The user's Ethereum address. | ||
| /// @param _data The proof athat the user is part of the tree. | ||
| function register(address _user, bytes memory _data) public override { |
Check warning
Code scanning / Slither
Conformance to Solidity naming conventions Warning
| /// @dev Throw if the proof is not valid or the user has already been registered | ||
| /// @param _user The user's Ethereum address. | ||
| /// @param _data The proof athat the user is part of the tree. | ||
| function register(address _user, bytes memory _data) public override { |
Check warning
Code scanning / Slither
Conformance to Solidity naming conventions Warning
ctrlc03
requested changes
Sep 11, 2024
packages/contracts/contracts/gatekeepers/MerkleProofGatekeeper.sol
Fixed
Show resolved
Hide resolved
packages/contracts/contracts/gatekeepers/MerkleProofGatekeeper.sol
Outdated
Show resolved
Hide resolved
packages/contracts/contracts/gatekeepers/MerkleProofGatekeeper.sol
Outdated
Show resolved
Hide resolved
crisgarner
force-pushed
the
feat/merkle-gatekeeper
branch
from
d78d663
to
5190955
Compare
crisgarner
force-pushed
the
feat/merkle-gatekeeper
branch
from
5190955
to
f7fdba7
Compare
Thanks! added the fixes. |
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
A gatekeeper contract which allows users to sign up to MACI only if they are part of the tree
Confirmation