Skip to content

Latest commit

 

History

History
 
 

contracts

Semaphore contracts

Semaphore contracts to manage groups and broadcast anonymous signals.

Github license NPM version Downloads

To learn more about contracts visit semaphore.appliedzkp.org.


🛠 Install

npm or yarn

Install the @semaphore-protocol/contracts package with npm:

npm i @semaphore-protocol/contracts

or yarn:

yarn add @semaphore-protocol/contracts

📜 Usage

Compile contracts

Compile the smart contracts with Hardhat:

yarn compile

Testing

Run Mocha to test the contracts:

yarn test

You can also generate a test coverage report:

yarn test:coverage

Or a test gas report:

yarn test:report-gas

Deploy contracts

Deploy the Semaphore.sol contract without any parameter:

yarn deploy:semaphore

or deploy it by providing the addresses of the contracts/libraries on which it depends:

yarn deploy:semaphore --semaphoreVerifier <address>

Note
Run yarn deploy:semaphore --help to see the complete list.

If you want to deploy your contract in a specific network you can set up the DEFAULT_NETWORK variable in your .env file with the name of one of our supported networks (hardhat, localhost, goerli, arbitrum). Or you can specify it as an option:

yarn deploy:semaphore --network goerli
yarn deploy:semaphore --network sepolia
yarn deploy:semaphore --network mumbai
yarn deploy:semaphore --network optimism-goerli
yarn deploy:semaphore --network arbitrum

If you want to deploy contracts on Goerli or Arbitrum, remember to provide a valid private key and an Infura API in your .env file.