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:

git clone https://github.com/semaphore-protocol/semaphore.git

Install the dependencies:

cd semaphore && yarn

And build the repository:

yarn build

📜 Usage

Copy the .env.example file as .env:

cp .env.example .env

And add your environment variables.

Code quality and formatting

Run ESLint to analyze the code and catch bugs:

yarn lint

Run Prettier to check formatting rules:

yarn format

Or to automatically format the code:

yarn format:write

Conventional commits

Semaphore uses conventional commits. A command line utility to commit using the correct syntax can be used by running:

git commit

It will also automatically check that the modified files comply with ESLint and Prettier rules.

Testing

Run Jest to test the JS libraries:

yarn test:libraries

Run Mocha to test the contracts:

yarn test:contracts

Or test everything with:

yarn test

Build libraries & compile contracts

Run Rollup and TheGraph to build all the packages and the subgraph:

yarn build

Compile the smart contracts with Hardhat:

yarn compile:contracts

Documentation (JS libraries)

Run TypeDoc to generate a documentation website for each package:

yarn docs

The output will be placed on the docs folder.

Releases

Steps:

1. Bump a new version with:

yarn version:bump <version>
# e.g. yarn version:bump 2.0.0

This step creates a commit and a git tag.

2. Push the changes to main:

git push origin main

3. Push the new git tag:

git push origin <version>
# 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.