--- id: 1739 card_url: "https://mdrss.com/crypto/smart-contract-security/1739" permalink_url: "https://mdrss.com/m/1739" thread_url: "https://mdrss.com/s/crypto" markdown_url: "https://mdrss.com/crypto/smart-contract-security/1739/1739.md" title: "Packages" annotation: "👥 Contributing | 🤝 Code of conduct | 🔎 Issues | 🗣️ Chat & Support | 💻 API Reference 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." state: published thread: crypto domain: crypto category: smart-contract-security type: guide tags: ["circom", "ethereum", "hacktoberfest", "javascript", "monorepo", "proof-of-membership", "semaphore", "solidity"] ontology_terms: [] relation_terms: [] license: "MIT" version: 1 snapshot_at: "2026-08-04T12:17:57.382Z" source_url: "https://github.com/semaphore-protocol/semaphore" source_kind: "mdrss-final-catalog" platform_scam_risk: null platform_evidence_score: 0 evidence_urls: - "https://github.com/semaphore-protocol/semaphore" ---

Repository top language

👥 Contributing | 🤝 Code of conduct | 🔎 Issues | 🗣️ Chat & Support | 💻 API Reference

| Semaphore is a generic privacy layer. Leveraging zero-knowledge technology, users can prove their membership in groups and send messages (extending from votes to endorsements) off-chain or across EVM-compatible blockchains, all without revealing their personal identity. | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | The core of the Semaphore protocol is in the [circuit logic](https://github.com/semaphore-protocol/semaphore/blob/HEAD/packages/circuits/scheme.png). However, Semaphore also provides [Solidity contracts](https://github.com/semaphore-protocol/semaphore/blob/HEAD/packages/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](https://semaphore.pse.dev). > [!IMPORTANT] > Help Semaphore prosper by sharing your ideas with the PSE [acceleration program](https://github.com/privacy-scaling-explorations/acceleration-program). ## 📦 Packages

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)

## 🛠 Install Clone this repository: ```bash git clone https://github.com/semaphore-protocol/semaphore.git ``` Install the dependencies: ```bash cd semaphore && yarn ``` And build the repository: ```bash yarn build ``` ## 📜 Usage Copy the `.env.example` file as `.env`: ```bash cp .env.example .env ``` And add your environment variables. ### Code quality and formatting Run [ESLint](https://eslint.org/) to analyze the code and catch bugs: ```bash yarn lint ``` Run [Prettier](https://prettier.io/) to check formatting rules: ```bash yarn format ``` Or to automatically format the code: ```bash yarn format:write ``` ### Conventional commits Semaphore uses [conventional commits](https://www.conventionalcommits.org/en/v1.0.0/). A [command line utility](https://github.com/commitizen/cz-cli) to commit using the correct syntax can be used by running: ```bash git commit ``` It will also automatically check that the modified files comply with ESLint and Prettier rules. ### Testing Run [Jest](https://jestjs.io/) to test the JS libraries: ```bash yarn test:libraries ``` Run [Mocha](https://mochajs.org/) to test the contracts: ```bash yarn test:contracts ``` Or test everything with: ```bash yarn test ``` ### Build libraries & compile contracts Run [Rollup](https://www.rollupjs.org) and [TheGraph](https://www.npmjs.com/package/@graphprotocol/graph-cli) to build all the packages and the subgraph: ```bash yarn build ``` Compile the smart contracts with [Hardhat](https://hardhat.org/): ```bash yarn compile:contracts ``` ### Documentation (JS libraries) Run [TypeDoc](https://typedoc.org/) to generate a documentation website for each package: ```bash yarn docs ``` The output will be placed on the `docs` folder. ### Releases Steps: 1. Bump a new version with: ```bash yarn version:bump # e.g. yarn version:bump 2.0.0 ``` This step creates a commit and a git tag. 2. Push the changes to main: ```bash git push origin main ``` 3. Push the new git tag: ```bash git push origin # 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](https://www.npmjs.com/) and release a new version on GitHub with its changelogs automatically.