-
Notifications
You must be signed in to change notification settings - Fork 6
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #22 from vacp2p/test-pluggable-validation-logic
test pluggable validation logic
- Loading branch information
Showing
12 changed files
with
495 additions
and
520 deletions.
There are no files selected for viewing
Large diffs are not rendered by default.
Oops, something went wrong.
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,180 +1,18 @@ | ||
| // SPDX-License-Identifier: MIT | ||
|
|
||
| pragma solidity 0.8.15; | ||
|
|
||
| import {IPoseidonHasher} from "./PoseidonHasher.sol"; | ||
| import {IVerifier} from "./IVerifier.sol"; | ||
|
|
||
| /// The tree is full | ||
| error FullTree(); | ||
|
|
||
| /// Invalid deposit amount | ||
| /// @param required The required deposit amount | ||
| /// @param provided The provided deposit amount | ||
| error InsufficientDeposit(uint256 required, uint256 provided); | ||
|
|
||
| /// Member is already registered | ||
| error DuplicateIdCommitment(); | ||
|
|
||
| /// Invalid receiver address, when the receiver is the contract itself or 0x0 | ||
| error InvalidReceiverAddress(address to); | ||
|
|
||
| /// Member is not registered | ||
| error MemberNotRegistered(uint256 idCommitment); | ||
|
|
||
| /// Member has no stake | ||
| error MemberHasNoStake(uint256 idCommitment); | ||
|
|
||
| /// User has insufficient balance to withdraw | ||
| error InsufficientWithdrawalBalance(); | ||
|
|
||
| /// Contract has insufficient balance to return | ||
| error InsufficientContractBalance(); | ||
|
|
||
| /// Invalid proof | ||
| error InvalidProof(); | ||
|
|
||
| contract RLN { | ||
| /// @notice The deposit amount required to register as a member | ||
| uint256 public immutable MEMBERSHIP_DEPOSIT; | ||
|
|
||
| /// @notice The depth of the merkle tree | ||
| uint256 public immutable DEPTH; | ||
|
|
||
| /// @notice The size of the merkle tree, i.e 2^depth | ||
| uint256 public immutable SET_SIZE; | ||
|
|
||
| /// @notice The index of the next member to be registered | ||
| uint256 public idCommitmentIndex = 1; | ||
|
|
||
| /// @notice The amount of eth staked by each member | ||
| /// maps from idCommitment to the amount staked | ||
| mapping(uint256 => uint256) public stakedAmounts; | ||
|
|
||
| /// @notice The membership status of each member | ||
| /// maps from idCommitment to their index in the set | ||
| mapping(uint256 => uint256) public members; | ||
|
|
||
| /// @notice The balance of each user that can be withdrawn | ||
| mapping(address => uint256) public withdrawalBalance; | ||
|
|
||
| /// @notice The Poseidon hasher contract | ||
| IPoseidonHasher public immutable poseidonHasher; | ||
|
|
||
| /// @notice The groth16 verifier contract | ||
| IVerifier public immutable verifier; | ||
|
|
||
| /// Emitted when a new member is added to the set | ||
| /// @param idCommitment The idCommitment of the member | ||
| /// @param index The index of the member in the set | ||
| event MemberRegistered(uint256 idCommitment, uint256 index); | ||
|
|
||
| /// Emitted when a member is removed from the set | ||
| /// @param idCommitment The idCommitment of the member | ||
| /// @param index The index of the member in the set | ||
| event MemberWithdrawn(uint256 idCommitment, uint256 index); | ||
|
|
||
| constructor(uint256 membershipDeposit, uint256 depth, address _poseidonHasher, address _verifier) { | ||
| MEMBERSHIP_DEPOSIT = membershipDeposit; | ||
| DEPTH = depth; | ||
| SET_SIZE = 1 << depth; | ||
| poseidonHasher = IPoseidonHasher(_poseidonHasher); | ||
| verifier = IVerifier(_verifier); | ||
| } | ||
|
|
||
| /// Allows a user to register as a member | ||
| /// @param idCommitment The idCommitment of the member | ||
| function register(uint256 idCommitment) external payable { | ||
| if (msg.value != MEMBERSHIP_DEPOSIT) { | ||
| revert InsufficientDeposit(MEMBERSHIP_DEPOSIT, msg.value); | ||
| } | ||
| _register(idCommitment, msg.value); | ||
| } | ||
|
|
||
| /// Registers a member | ||
| /// @param idCommitment The idCommitment of the member | ||
| /// @param stake The amount of eth staked by the member | ||
| function _register(uint256 idCommitment, uint256 stake) internal { | ||
| if (members[idCommitment] != 0) revert DuplicateIdCommitment(); | ||
| if (idCommitmentIndex >= SET_SIZE) revert FullTree(); | ||
|
|
||
| members[idCommitment] = idCommitmentIndex; | ||
| stakedAmounts[idCommitment] = stake; | ||
|
|
||
| emit MemberRegistered(idCommitment, idCommitmentIndex); | ||
| idCommitmentIndex += 1; | ||
| } | ||
|
|
||
| /// @dev Allows a user to slash a member | ||
| /// @param idCommitment The idCommitment of the member | ||
| function slash(uint256 idCommitment, address payable receiver, uint256[8] calldata proof) external { | ||
| _slash(idCommitment, receiver, proof); | ||
| } | ||
|
|
||
| /// @dev Slashes a member by removing them from the set, and adding their | ||
| /// stake to the receiver's available withdrawal balance | ||
| /// @param idCommitment The idCommitment of the member | ||
| /// @param receiver The address to receive the funds | ||
| function _slash(uint256 idCommitment, address payable receiver, uint256[8] calldata proof) internal { | ||
| if (receiver == address(this) || receiver == address(0)) { | ||
| revert InvalidReceiverAddress(receiver); | ||
| } | ||
|
|
||
| if (members[idCommitment] == 0) revert MemberNotRegistered(idCommitment); | ||
| // check if member is registered | ||
| if (stakedAmounts[idCommitment] == 0) { | ||
| revert MemberHasNoStake(idCommitment); | ||
| } | ||
|
|
||
| if (!_verifyProof(idCommitment, receiver, proof)) { | ||
| revert InvalidProof(); | ||
| } | ||
|
|
||
| uint256 amountToTransfer = stakedAmounts[idCommitment]; | ||
|
|
||
| // delete member | ||
| uint256 index = members[idCommitment]; | ||
| members[idCommitment] = 0; | ||
| stakedAmounts[idCommitment] = 0; | ||
|
|
||
| // refund deposit | ||
| withdrawalBalance[receiver] += amountToTransfer; | ||
|
|
||
| emit MemberWithdrawn(idCommitment, index); | ||
| } | ||
|
|
||
| /// Allows a user to withdraw funds allocated to them upon slashing a member | ||
| function withdraw() external { | ||
| uint256 amount = withdrawalBalance[msg.sender]; | ||
|
|
||
| if (amount == 0) revert InsufficientWithdrawalBalance(); | ||
| if (amount > address(this).balance) { | ||
| revert InsufficientContractBalance(); | ||
| } | ||
|
|
||
| withdrawalBalance[msg.sender] = 0; | ||
| import "./RlnBase.sol"; | ||
|
|
||
| payable(msg.sender).transfer(amount); | ||
| } | ||
| contract Rln is RlnBase { | ||
| constructor(uint256 membershipDeposit, uint256 depth, address _poseidonHasher, address _verifier) | ||
| RlnBase(membershipDeposit, depth, _poseidonHasher, _verifier) | ||
| {} | ||
|
|
||
| /// Hashes a value using the Poseidon hasher | ||
| /// NOTE: The variant of Poseidon we use accepts only 1 input, assume n=2, and the second input is 0 | ||
| /// @param input The value to hash | ||
| function hash(uint256 input) internal view returns (uint256) { | ||
| return poseidonHasher.hash(input); | ||
| } | ||
| function _validateRegistration(uint256 idCommitment) internal pure override {} | ||
|
|
||
| /// @dev Groth16 proof verification | ||
| function _verifyProof(uint256 idCommitment, address receiver, uint256[8] calldata proof) | ||
| function _validateSlash(uint256 idCommitment, address payable receiver, uint256[8] calldata proof) | ||
| internal | ||
| view | ||
| returns (bool) | ||
| { | ||
| return verifier.verifyProof( | ||
| [proof[0], proof[1]], | ||
| [[proof[2], proof[3]], [proof[4], proof[5]]], | ||
| [proof[6], proof[7]], | ||
| [idCommitment, uint256(uint160(receiver))] | ||
| ); | ||
| } | ||
| pure | ||
| override | ||
| {} | ||
| } |
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,193 @@ | ||
| // SPDX-License-Identifier: MIT | ||
|
|
||
| pragma solidity 0.8.15; | ||
|
|
||
| import {IPoseidonHasher} from "./PoseidonHasher.sol"; | ||
| import {IVerifier} from "./IVerifier.sol"; | ||
|
|
||
| /// The tree is full | ||
| error FullTree(); | ||
|
|
||
| /// Invalid deposit amount | ||
| /// @param required The required deposit amount | ||
| /// @param provided The provided deposit amount | ||
| error InsufficientDeposit(uint256 required, uint256 provided); | ||
|
|
||
| /// Member is already registered | ||
| error DuplicateIdCommitment(); | ||
|
|
||
| /// Failed validation on registration/slashing | ||
| error FailedValidation(); | ||
|
|
||
| /// Invalid receiver address, when the receiver is the contract itself or 0x0 | ||
| error InvalidReceiverAddress(address to); | ||
|
|
||
| /// Member is not registered | ||
| error MemberNotRegistered(uint256 idCommitment); | ||
|
|
||
| /// Member has no stake | ||
| error MemberHasNoStake(uint256 idCommitment); | ||
|
|
||
| /// User has insufficient balance to withdraw | ||
| error InsufficientWithdrawalBalance(); | ||
|
|
||
| /// Contract has insufficient balance to return | ||
| error InsufficientContractBalance(); | ||
|
|
||
| /// Invalid proof | ||
| error InvalidProof(); | ||
|
|
||
| abstract contract RlnBase { | ||
| /// @notice The deposit amount required to register as a member | ||
| uint256 public immutable MEMBERSHIP_DEPOSIT; | ||
|
|
||
| /// @notice The depth of the merkle tree | ||
| uint256 public immutable DEPTH; | ||
|
|
||
| /// @notice The size of the merkle tree, i.e 2^depth | ||
| uint256 public immutable SET_SIZE; | ||
|
|
||
| /// @notice The index of the next member to be registered | ||
| uint256 public idCommitmentIndex = 1; | ||
|
|
||
| /// @notice The amount of eth staked by each member | ||
| /// maps from idCommitment to the amount staked | ||
| mapping(uint256 => uint256) public stakedAmounts; | ||
|
|
||
| /// @notice The membership status of each member | ||
| /// maps from idCommitment to their index in the set | ||
| mapping(uint256 => uint256) public members; | ||
|
|
||
| /// @notice The balance of each user that can be withdrawn | ||
| mapping(address => uint256) public withdrawalBalance; | ||
|
|
||
| /// @notice The Poseidon hasher contract | ||
| IPoseidonHasher public immutable poseidonHasher; | ||
|
|
||
| /// @notice The groth16 verifier contract | ||
| IVerifier public immutable verifier; | ||
|
|
||
| /// Emitted when a new member is added to the set | ||
| /// @param idCommitment The idCommitment of the member | ||
| /// @param index The index of the member in the set | ||
| event MemberRegistered(uint256 idCommitment, uint256 index); | ||
|
|
||
| /// Emitted when a member is removed from the set | ||
| /// @param idCommitment The idCommitment of the member | ||
| /// @param index The index of the member in the set | ||
| event MemberWithdrawn(uint256 idCommitment, uint256 index); | ||
|
|
||
| constructor(uint256 membershipDeposit, uint256 depth, address _poseidonHasher, address _verifier) { | ||
| MEMBERSHIP_DEPOSIT = membershipDeposit; | ||
| DEPTH = depth; | ||
| SET_SIZE = 1 << depth; | ||
| poseidonHasher = IPoseidonHasher(_poseidonHasher); | ||
| verifier = IVerifier(_verifier); | ||
| } | ||
|
|
||
| /// Allows a user to register as a member | ||
| /// @param idCommitment The idCommitment of the member | ||
| function register(uint256 idCommitment) external payable { | ||
| if (msg.value != MEMBERSHIP_DEPOSIT) { | ||
| revert InsufficientDeposit(MEMBERSHIP_DEPOSIT, msg.value); | ||
| } | ||
| _validateRegistration(idCommitment); | ||
| _register(idCommitment, msg.value); | ||
| } | ||
|
|
||
| /// Registers a member | ||
| /// @param idCommitment The idCommitment of the member | ||
| /// @param stake The amount of eth staked by the member | ||
| function _register(uint256 idCommitment, uint256 stake) internal { | ||
| if (members[idCommitment] != 0) revert DuplicateIdCommitment(); | ||
| if (idCommitmentIndex >= SET_SIZE) revert FullTree(); | ||
|
|
||
| members[idCommitment] = idCommitmentIndex; | ||
| stakedAmounts[idCommitment] = stake; | ||
|
|
||
| emit MemberRegistered(idCommitment, idCommitmentIndex); | ||
| idCommitmentIndex += 1; | ||
| } | ||
|
|
||
| /// @dev Inheriting contracts MUST override this function | ||
| function _validateRegistration(uint256 idCommitment) internal view virtual; | ||
|
|
||
| /// @dev Allows a user to slash a member | ||
| /// @param idCommitment The idCommitment of the member | ||
| function slash(uint256 idCommitment, address payable receiver, uint256[8] calldata proof) external { | ||
| _validateSlash(idCommitment, receiver, proof); | ||
| _slash(idCommitment, receiver, proof); | ||
| } | ||
|
|
||
| /// @dev Slashes a member by removing them from the set, and adding their | ||
| /// stake to the receiver's available withdrawal balance | ||
| /// @param idCommitment The idCommitment of the member | ||
| /// @param receiver The address to receive the funds | ||
| function _slash(uint256 idCommitment, address payable receiver, uint256[8] calldata proof) internal { | ||
| if (receiver == address(this) || receiver == address(0)) { | ||
| revert InvalidReceiverAddress(receiver); | ||
| } | ||
|
|
||
| if (members[idCommitment] == 0) revert MemberNotRegistered(idCommitment); | ||
| // check if member is registered | ||
| if (stakedAmounts[idCommitment] == 0) { | ||
| revert MemberHasNoStake(idCommitment); | ||
| } | ||
|
|
||
| if (!_verifyProof(idCommitment, receiver, proof)) { | ||
| revert InvalidProof(); | ||
| } | ||
|
|
||
| uint256 amountToTransfer = stakedAmounts[idCommitment]; | ||
|
|
||
| // delete member | ||
| uint256 index = members[idCommitment]; | ||
| members[idCommitment] = 0; | ||
| stakedAmounts[idCommitment] = 0; | ||
|
|
||
| // refund deposit | ||
| withdrawalBalance[receiver] += amountToTransfer; | ||
|
|
||
| emit MemberWithdrawn(idCommitment, index); | ||
| } | ||
|
|
||
| function _validateSlash(uint256 idCommitment, address payable receiver, uint256[8] calldata proof) | ||
| internal | ||
| view | ||
| virtual; | ||
|
|
||
| /// Allows a user to withdraw funds allocated to them upon slashing a member | ||
| function withdraw() external { | ||
| uint256 amount = withdrawalBalance[msg.sender]; | ||
|
|
||
| if (amount == 0) revert InsufficientWithdrawalBalance(); | ||
| if (amount > address(this).balance) { | ||
| revert InsufficientContractBalance(); | ||
| } | ||
|
|
||
| withdrawalBalance[msg.sender] = 0; | ||
|
|
||
| payable(msg.sender).transfer(amount); | ||
| } | ||
|
|
||
| /// Hashes a value using the Poseidon hasher | ||
| /// NOTE: The variant of Poseidon we use accepts only 1 input, assume n=2, and the second input is 0 | ||
| /// @param input The value to hash | ||
| function hash(uint256 input) internal view returns (uint256) { | ||
| return poseidonHasher.hash(input); | ||
| } | ||
|
|
||
| /// @dev Groth16 proof verification | ||
| function _verifyProof(uint256 idCommitment, address receiver, uint256[8] calldata proof) | ||
| internal | ||
| view | ||
| returns (bool) | ||
| { | ||
| return verifier.verifyProof( | ||
| [proof[0], proof[1]], | ||
| [[proof[2], proof[3]], [proof[4], proof[5]]], | ||
| [proof[6], proof[7]], | ||
| [idCommitment, uint256(uint160(receiver))] | ||
| ); | ||
| } | ||
| } |
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -300,4 +300,4 @@ contract Verifier { | |
| return false; | ||
| } | ||
| } | ||
| } | ||
| } | ||
Oops, something went wrong.