Semaphore includes two types of contracts:
And Semaphore.sol, the main contract deployed on the networks supported by Semaphore.
To use Semaphore contracts and interfaces in your project,
@semaphore-protocol/contracts NPM package.
Semaphore provides the following base contracts:
SemaphoreVerifier.sol: contains a function to verify Semaphore proofs;
SemaphoreGroups.sol: contains the functions to create groups and add/remove/update members.
These contracts are closely related to the protocol. You can use them in your contract or you can use Semaphore.sol, which integrates them for you.
While some DApps may use on-chain groups, others may prefer to use off-chain groups, saving only their tree roots in the contract.
SemaphoreVoting.sol: voting contract that contains the essential functions to create polls, add voters, and anonymously cast votes;
SemaphoreWhistleblowing.sol: whistleblowing contract that contains the essential functions to create entities (for example: non-profit organizations), add whistleblowers, and anonymously publish leaks.
These contracts extend the protocol to provide application logic for specific use-cases. More extensions will be added in the future.
Semaphore.sol is based on the base contracts. It integrates them and additionally provides:
- a system to allow only admins (i.e. Ethereum accounts or smart contracts) to manage groups;
- a mechanism to save the nullifier hashes of each group and prevent double-signaling;
- a mechanism to allow Semaphore proofs generated with old Merkle roots to be verified for a certain period of time defined by the group admin.
See our deployed contracts to find the addresses for your network.