Skip to main content
Version: V4-alpha

Getting started

Semaphore provides an official CLI to set up your project with Hardhat. If your NPM version is 5.2 or higher you can use NPX:

npx @semaphore-protocol/cli create my-app --template monorepo-ethers

Otherwise, install @semaphore-protocol/cli globally and run the create command:

npm i -g @semaphore-protocol/cli
semaphore create my-app --template monorepo-ethers
info

The supported templates are: contracts-hardhat, monorepo-ethers, monorepo-subgraph.

info

The semaphore CLI can also be used to get group data from a supported network (e.g. semaphore get-groups --network sepolia).

To start working on your project, install the dependencies:

cd my-app
npm i

Output​

The create command will create a directory called my-app (or whatever name you choose) inside the current folder. That directory will contain the initial project structure, which includes a simple contract, a task to deploy it, some tests and a Next.js application (the web-app folder) to interact with that contract.

my-app
β”œβ”€β”€ .yarn
β”œβ”€β”€ apps
β”‚ └── contracts
β”‚ β”‚ └── contracts
| β”‚ β”‚ └── Feedback.sol
β”‚ β”‚ └── tasks
| β”‚ β”‚ └── deploy.ts
β”‚ β”‚ └── test
| β”‚ β”‚ └── Feedback.ts
β”‚ β”‚ └── hardhat.config.ts
β”‚ β”‚ └── package.json
β”‚ β”‚ └── tsconfig.json
β”‚ └── web-app
β”œβ”€β”€ .editorconfig
β”œβ”€β”€ .env
β”œβ”€β”€ .env.example
β”œβ”€β”€ .eslintignore
β”œβ”€β”€ .eslintrc.json
β”œβ”€β”€ .gitignore
β”œβ”€β”€ .prettierignore
β”œβ”€β”€ .prettierrc.json
β”œβ”€β”€ .yarnrc.yml
β”œβ”€β”€ package.json
β”œβ”€β”€ README.md
└── tsconfig.json

The Feedback.sol contract creates a Semaphore group, allows users to join that group with their Semaphore identity, and finally allows group members to send an anonymous feedback.

Usage​

Compile contracts​

Go to the contracts folder:

cd apps/contracts

And compile your contracts:

npm run compile

Test contracts​

Test your contracts:

npm test

Generate a test coverage report:

npm run test:coverage

Or a test gas report:

npm run test:report-gas

Deploy contracts​

Follow the instructions below to deploy your contracts:

In the project root folder:

  1. Add your environment variables in the .env file.

    note

    You should at least set a valid Infura API Key (you could use Alchemy as well) and a private key with some ethers.

  2. Go to the apps/contracts folder and deploy your contract.

    npm run deploy -- --semaphore <semaphore-address> --group <group-id> --network sepolia
    note

    Check the Semaphore contract addresses here.

    caution

    The group id is a number.

Start app​

Start the application:

npm run dev
info

If you want to see the code of a comprehensive application built on top of Semaphore see the boilerplate. For more info about the core libraries, keep reading the next guides.