| Semaphore is a generic privacy layer. Leveraging zero-knowledge technology, users can prove their membership in groups and send messages (extending from votes to endorsements) off-chain or across EVM-compatible blockchains, all without revealing their personal 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/offchain verification easier. To learn more about Semaphore visit semaphore.pse.dev.
Important
Help Semaphore prosper by sharing your ideas with the PSE acceleration program.
Packages
Install
Clone this repository:
Install the dependencies:
And build the repository:
Usage
Copy the .env.example file as .env:
And add your environment variables.
Code quality and formatting
Run ESLint to analyze the code and catch bugs:
Run Prettier to check formatting rules:
Or to automatically format the code:
Conventional commits
Semaphore uses conventional commits. A command line utility to commit using the correct syntax can be used by running:
It will also automatically check that the modified files comply with ESLint and Prettier rules.
Testing
Run Jest to test the JS libraries:
Run Mocha to test the contracts:
Or test everything with:
Build libraries & compile contracts
Run Rollup and TheGraph to build all the packages and the subgraph:
Compile the smart contracts with Hardhat:
Documentation (JS libraries)
Run TypeDoc to generate a documentation website for each package:
The output will be placed on the docs folder.
Releases
Steps:
- Bump a new version with:
# e.g. yarn version:bump 2.0.0
This step creates a commit and a git tag.
- Push the changes to main:
- Push the new git tag:
# e.g. git push origin v2.0.0
After pushing the new git tag, a workflow will be triggered to publish the Semaphore packages on npm and release a new version on GitHub with its changelogs automatically.