Semaphore Protocol is composed of several specialized packages for identity, group management, proof generation, and smart contract interaction. Depending on your use case, you may need one or more of the following:

• @semaphore-protocol/core: Core logic.
• @semaphore-protocol/contracts: Smart contract implementations.
• @semaphore-protocol/identity: Identity management.
• @semaphore-protocol/group: Group management functionality.
• @semaphore-protocol/proof: Proof generation and verification.
• @semaphore-protocol/data: Data handling utilities.
• @semaphore-protocol/hardhat: Hardhat integration for testing and deployment.
• @semaphore-protocol/cli: Command line interface.
• @semaphore-protocol/utils: General utility functions.

Semaphore is a generic privacy layer that leverages zero-knowledge technology. It allows users to prove membership in groups and send messages (such as votes or endorsements) off-chain or across EVM-compatible blockchains without revealing their personal identity.

The protocol consists of three main components:

1. Circuit Logic: The core zero-knowledge circuit logic.
2. Solidity Contracts: On-chain components for verification.
3. JavaScript Libraries: Tools to facilitate off-chain proof creation and verification.

The Semaphore repository is a monorepo containing several specialized packages:

• @semaphore-protocol/circuits: Core circuit logic.
• @semaphore-protocol/contracts: Solidity smart contracts.
• @semaphore-protocol/core: Core protocol logic.
• @semaphore-protocol/cli: Command Line Interface tools.
• CLI Templates (for scaffolding projects):
  • @semaphore-protocol/cli-template-contracts-foundry: Semaphore Foundry Template.
  • @semaphore-protocol/cli-template-contracts-hardhat: Semaphore Hardhat template.
  • @semaphore-protocol/cli-template-monorepo-ethers: Semaphore Hardhat + Next.js + SemaphoreEthers template.
  • @semaphore-protocol/cli-template-monorepo-subgraph: Semaphore Hardhat + Next.js + SemaphoreSubgraph template.

You can install the Semaphore CLI globally using npm or run it on-demand using npx. The CLI is used to scaffold Semaphore projects and retrieve on-chain group data.

# Install globally
npm i -g @semaphore-protocol/cli

# Run without global installation
npx @semaphore-protocol/cli create my-app

Install the @semaphore-protocol/hardhat plugin using npm or yarn to simplify the deployment of Semaphore contracts.

npm i @semaphore-protocol/hardhat

or

yarn add @semaphore-protocol/hardhat

You can generate a documentation website for each package using TypeDoc by running:

yarn docs

The generated documentation will be located in the docs folder.

You can install the @semaphore-protocol/identity package using npm or yarn to manage Semaphore-compatible identities.

npm i @semaphore-protocol/identity
# or
yarn add @semaphore-protocol/identity

To enable the plugin, import @semaphore-protocol/hardhat in your hardhat.config.ts file.

import "@semaphore-protocol/hardhat"
import "./tasks/deploy"

const hardhatConfig: HardhatUserConfig = {
    solidity: "0.8.4"
}

export default hardhatConfig