| Semaphore is a protocol, designed to be a simple and generic privacy layer for Ethereum DApps. Using zero knowledge, Ethereum users can prove their membership of a group and send signals such as votes or endorsements without revealing their original identity. |
|---|
The core of the Semaphore protocol is in the circuit logic. However Semaphore also provides Solidity contracts and JavaScript libraries to make the steps for offchain proof creation and onchain verification easier. To learn more about Semaphore visit semaphore.pse.dev.
The following are some of the internal and external projects that use Semaphore. If you want to include your project, open an issue or create a PR by adding the project information to the projects.json file.
| Project | Description | Links |
|---|---|---|
| Bandada | An open-source system for managing privacy-preserving groups of anonymous individuals. Create and manage onchain and offchain Semaphore groups using UI or API. | Github | Discord |
| Semaphore Explorer | Semaphore explorer for on-chain groups. | Github | Discord |
| Semaphore Discord Bot | A Discord bot for Semaphore. | Github | Discord |
| Unirep | Private and nonrepudiable reputation system based on ZKP. | Github | Discord |
| ZK Proof of Humanity | A project to allows humans, registered in Proof of Humanity, to prove their humanity without doxing. | Github |
| Plurality |
An Identity Lego Building Block for dapp creators that lets them identify their users without using any third-party KYC provider or other middlemen, whilst preserving the privacy of users. |
Github |
| ZeroTherapy | AMA privacy application built with Semaphore. | Github |
| Block Qualified | On-chain and privacy preserving education platform built on Semaphore. | Github |
| StealthComms | A project that allows users to prove their membership in a group and send messages/signals without revealing their original identity. | Github |
Clone this repository:
git clone https://github.com/semaphore-protocol/semaphore.gitAnd install the dependencies:
cd semaphore && yarnCopy the .env.example file as .env:
cp .env.example .envAnd add your environment variables.
Run ESLint to analyze the code and catch bugs:
yarn lintRun Prettier to check formatting rules:
yarn prettierOr to automatically format the code:
yarn prettier:writeSemaphore uses conventional commits. A command line utility to commit using the correct syntax can be used by running:
yarn commitIt will also automatically check that the modified files comply with ESLint and Prettier rules.
Download the Semaphore snark artifacts needed to generate and verify proofs:
yarn download:snark-artifactsRun Jest to test the JS libraries:
yarn test:librariesRun Mocha to test the contracts:
yarn test:contractsOr test everything with:
yarn testRun Rollup to build all the packages:
yarn build:librariesCompile the smart contracts with Hardhat:
yarn compile:contractsRun TypeDoc to generate a documentation website for each package:
yarn docsThe output will be placed on the docs folder.