unirep / docs

UniRep Protocol

​

💡 About UniRep

UniRep is a private and non-repudiable data system. Users can receive attestations from attesters, and voluntarily prove facts about their data without revealing the data itself. Moreover, users cannot refuse to receive attestations from an attester.

📘 Documentation

Read the medium article to know more about the concept of Unirep protocol. For more information, refer to the documentation.

📦 Project Structure

• Package	Version	Description
  core		Unirep protocol related functions.
  contracts		Unirep smart contracts, ZKP verifiers and contract related functions.
  circuits		Unirep circom circuits and circuit related functions.
  utils		Utils which are used in unirep protocol.

​

🔋 Requirements

• Intall rust and circom 2
• Node.js >=16.14

🛠 Install and test

• Install

  yarn install

• Build with trusted setup keys

  yarn circuits keys && yarn build

  Or build with phase 1 trusted setup circuits

  yarn build

  If you want to contribute to the circuits Please run yarn circuits buildOverwrite to update keys

• Run test

  yarn test

🎯 Contributing

Contributions are always welcome! Feel free to open any issue or send a pull request. Go to CONTRIBUTING.md and CODE_OF_CONDUCT.md to learn about how to contribute to Unirep project!

🙌🏻 Join our community

• Discord server:
• Twitter account:
• Telegram group:

Privacy & Scaling Explorations

This project is supported by Privacy & Scaling Explorations and the Ethereum Foundation. See more projects on: https://pse.dev/projects.

docs's Issues

[Doc] Relase note of the contract