-
Notifications
You must be signed in to change notification settings - Fork 5
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 #99 from worldcoin/kit/contract-tests
Update `PBHExternalNullifier` tests
- Loading branch information
Showing
13 changed files
with
291 additions
and
130 deletions.
There are no files selected for viewing
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
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
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
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,38 @@ | ||
| //SPDX-License-Identifier: MIT | ||
| pragma solidity ^0.8.21; | ||
|
|
||
| interface IWorldID { | ||
| /////////////////////////////////////////////////////////////////////////////// | ||
| /// ERRORS /// | ||
| /////////////////////////////////////////////////////////////////////////////// | ||
|
|
||
| /// @notice Thrown when attempting to validate a root that has expired. | ||
| error ExpiredRoot(); | ||
|
|
||
| /// @notice Thrown when attempting to validate a root that has yet to be added to the root | ||
| /// history. | ||
| error NonExistentRoot(); | ||
|
|
||
| /// @notice Verifies a WorldID zero knowledge proof. | ||
| /// @dev Note that a double-signaling check is not included here, and should be carried by the | ||
| /// caller. | ||
| /// @dev It is highly recommended that the implementation is restricted to `view` if possible. | ||
| /// | ||
| /// @param groupId The group identifier for the group to verify a proof for. | ||
| /// @param root The of the Merkle tree | ||
| /// @param signalHash A keccak256 hash of the Semaphore signal | ||
| /// @param nullifierHash The nullifier hash | ||
| /// @param externalNullifierHash A keccak256 hash of the external nullifier | ||
| /// @param proof The zero-knowledge proof | ||
| /// | ||
| /// @custom:reverts string If the `proof` is invalid. | ||
| /// @custom:reverts NoSuchGroup If the provided `groupId` references a group that does not exist. | ||
| function verifyProof( | ||
| uint256 root, | ||
| uint256 groupId, | ||
| uint256 signalHash, | ||
| uint256 nullifierHash, | ||
| uint256 externalNullifierHash, | ||
| uint256[8] calldata proof | ||
| ) external view; | ||
| } |
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
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,111 @@ | ||
| // SPDX-License-Identifier: MIT | ||
| pragma solidity ^0.8.21; | ||
|
|
||
| import {IWorldIDGroups} from "@world-id-contracts/interfaces/IWorldIDGroups.sol"; | ||
| import {MockWorldIDGroups} from "./mocks/MockWorldIDGroups.sol"; | ||
| import {CheckInitialized} from "@world-id-contracts/utils/CheckInitialized.sol"; | ||
| import {WorldIDImpl} from "@world-id-contracts/abstract/WorldIDImpl.sol"; | ||
| import {ByteHasher} from "@helpers/ByteHasher.sol"; | ||
| import {IPBHEntryPoint} from "../src/interfaces/IPBHEntryPoint.sol"; | ||
| import {PBHEntryPointImplV1} from "../src/PBHEntryPointImplV1.sol"; | ||
|
|
||
| import "@BokkyPooBahsDateTimeLibrary/BokkyPooBahsDateTimeLibrary.sol"; | ||
| import "@helpers/PBHExternalNullifier.sol"; | ||
| import {TestSetup} from "./TestSetup.sol"; | ||
|
|
||
| /// @title PBHVerifer Verify Tests | ||
| /// @notice Contains tests for the pbhVerifier | ||
| /// @author Worldcoin | ||
| contract PBHEntryPointImplV1Test is TestSetup { | ||
| using ByteHasher for bytes; | ||
|
|
||
| event PBH(address indexed sender, IPBHEntryPoint.PBHPayload payload); | ||
| event NumPbhPerMonthSet(uint8 indexed numPbhPerMonth); | ||
| event WorldIdSet(address indexed worldId); | ||
|
|
||
| /// @notice Test payload for the PBHVerifier | ||
| IPBHEntryPoint.PBHPayload public testPayload = IPBHEntryPoint.PBHPayload({ | ||
| root: 1, | ||
| pbhExternalNullifier: getValidPBHExternalNullifier(), | ||
| nullifierHash: 1, | ||
| proof: [uint256(0), 0, 0, 0, 0, 0, 0, 0] | ||
| }); | ||
|
|
||
| uint256 internal nonce = 1; | ||
| address internal sender = address(0x123); | ||
| bytes internal testCallData = hex"deadbeef"; | ||
|
|
||
| // TODO: move this to test utils | ||
| function getValidPBHExternalNullifier() public view returns (uint256) { | ||
| uint8 month = uint8(BokkyPooBahsDateTimeLibrary.getMonth(block.timestamp)); | ||
| uint16 year = uint16(BokkyPooBahsDateTimeLibrary.getYear(block.timestamp)); | ||
| return PBHExternalNullifier.encode(PBHExternalNullifier.V1, 0, month, year); | ||
| } | ||
|
|
||
| // TODO: | ||
| function test_verifyPbh() public { | ||
| uint256 signalHash = abi.encodePacked(sender, nonce, testCallData).hashToField(); | ||
|
|
||
| pbhEntryPoint.verifyPbh(signalHash, testPayload); | ||
|
|
||
| // TODO: update to use mock work id | ||
| // Expect revert when proof verification fails | ||
| MockWorldIDGroups(address(worldIDGroups)).setVerifyProofSuccess(false); | ||
| vm.expectRevert("Proof verification failed"); | ||
| pbhEntryPoint.verifyPbh(signalHash, testPayload); | ||
|
|
||
| // Now expect success | ||
| MockWorldIDGroups(address(worldIDGroups)).setVerifyProofSuccess(true); | ||
| pbhEntryPoint.verifyPbh(signalHash, testPayload); | ||
| } | ||
|
|
||
| // TODO: | ||
| function test_verifyPbh_RevertIfInvalidNullifier() public {} | ||
|
|
||
| /// @notice Test that setNumPBHPerMonth works as expected | ||
| function testSetNumPBHPerMonth() public { | ||
| uint256 signalHash = abi.encodePacked(sender, nonce, testCallData).hashToField(); | ||
|
|
||
| MockWorldIDGroups(address(worldIDGroups)).setVerifyProofSuccess(true); | ||
| uint8 month = uint8(BokkyPooBahsDateTimeLibrary.getMonth(block.timestamp)); | ||
| uint16 year = uint16(BokkyPooBahsDateTimeLibrary.getYear(block.timestamp)); | ||
|
|
||
| // Value starts at 30, make sure 30 reverts. | ||
| testPayload.pbhExternalNullifier = PBHExternalNullifier.encode(PBHExternalNullifier.V1, 30, month, year); | ||
|
|
||
| testPayload.nullifierHash = 0; | ||
| vm.expectRevert(PBHExternalNullifier.InvalidPbhNonce.selector); | ||
| pbhEntryPoint.verifyPbh(signalHash, testPayload); | ||
|
|
||
| // Increase numPbhPerMonth from non owner, expect revert | ||
| vm.prank(address(123)); | ||
| vm.expectRevert("Ownable: caller is not the owner"); | ||
| pbhEntryPoint.setNumPbhPerMonth(40); | ||
|
|
||
| // Increase numPbhPerMonth from owner | ||
| vm.prank(thisAddress); | ||
| vm.expectEmit(true, false, false, false); | ||
| emit NumPbhPerMonthSet(40); | ||
| pbhEntryPoint.setNumPbhPerMonth(40); | ||
|
|
||
| // Try again, it should work | ||
| testPayload.pbhExternalNullifier = PBHExternalNullifier.encode(PBHExternalNullifier.V1, 30, month, year); | ||
| testPayload.nullifierHash = 1; | ||
| pbhEntryPoint.verifyPbh(signalHash, testPayload); | ||
| } | ||
|
|
||
| function testSetWorldId() public { | ||
| vm.expectEmit(true, false, false, false); | ||
| emit WorldIdSet(address(0x123)); | ||
| pbhEntryPoint.setWorldId(address(0x123)); | ||
| } | ||
|
|
||
| function test_FailSetWorldId_NotOwner(address naughty) public { | ||
| if (naughty == thisAddress) { | ||
| return; | ||
| } | ||
| vm.prank(naughty); | ||
| vm.expectRevert("Ownable: caller is not the owner"); | ||
| pbhEntryPoint.setWorldId(address(0x123)); | ||
| } | ||
| } |
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
Oops, something went wrong.