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.

Package	Version	Downloads
@semaphore-protocol/core
@semaphore-protocol/contracts
@semaphore-protocol/identity (docs)
@semaphore-protocol/group (docs)
@semaphore-protocol/proof (docs)
@semaphore-protocol/data (docs)
@semaphore-protocol/hardhat
@semaphore-protocol/cli
@semaphore-protocol/utils (docs)
@semaphore-protocol/heyauthn (docs)

Clone this repository:

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

And install the dependencies:

cd semaphore && yarn

Copy the .env.example file as .env:

cp .env.example .env

And add your environment variables.

Run ESLint to analyze the code and catch bugs:

yarn lint

Run Prettier to check formatting rules:

yarn prettier

Or to automatically format the code:

yarn prettier:write

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

yarn commit

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

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

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

yarn build

Compile the smart contracts with Hardhat:

yarn compile:contracts

Run TypeDoc to generate a documentation website for each package:

yarn docs

The output will be placed on the docs folder.

Bump a new version with:

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

It will create a commit and a git tag that will need to pushed on the main branch. A workflow will be triggered and will publish the Semaphore packages on npm and release a new version on Github with its changelogs automatically.