# UniRep circuits package
Client library for circuit related functions which are used in 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](https://medium.com/privacy-scaling-explorations/unirep-a-private-and-non-repudiable-reputation-system-7fb5c6478549) to know more about the concept of UniRep protocol.
For more information, refer to the [documentation](https://developer.unirep.io/)
## 🛠 Install
### npm or yarn
Install the `@unirep/circuits` package with npm:
```bash
npm i @unirep/circuits
```
or yarn:
```bash
yarn add @unirep/circuits
```
## 📔 Usage
### Prover
**Build a prover for UniRep protocol**
```typescript
import * as snarkjs from 'snarkjs'
import { Circuit, Prover } from '@unirep/circuits'
import { SnarkProof, SnarkPublicSignals } from '@unirep/utils'
const buildPath = 'PATH/TO/CIRCUIT/FOLDER/'
const prover: Prover = {
genProofAndPublicSignals: async (
proofType: string | Circuit,
inputs: any
): Promise<{
proof: any,
publicSignals: any
}> => {
const circuitWasmPath = buildPath + `${proofType}.wasm`
const zkeyPath = buildPath + `${proofType}.zkey`
const { proof, publicSignals } = await snarkjs.groth16.fullProve(
inputs,
circuitWasmPath,
zkeyPath
)
return { proof, publicSignals }
},
verifyProof: async (
name: string | Circuit,
publicSignals: SnarkPublicSignals,
proof: SnarkProof
): Promise => {
const vkey = require(buildPath + `${name}.vkey.json`)
return snarkjs.groth16.verify(vkey, publicSignals, proof)
},
}
```
**Generate proof and verify it with the above prover**
```typescript
import { Circuit } from '@unirep/circuits'
// See ./test/verifyEpochKey.test.ts for generating circuit inputs
const circuitInputs = {
state_tree_elements: ...,
state_tree_indices: ...,
...
}
const { proof, publicSignals } = await prover.genProofAndPublicSignals(
Circuit.epochKey,
circuitInputs
)
const isValid = await prover.verifyProof(
Circuit.epochKey,
publicSignals,
proof
)
```
### Circom
Use the unirep circom circuits like so:
```circom
pragma circom 2.1.0;
include "PATH/TO/node_modules/@unirep/circuits/circuits/epochKey.circom";
template DataProof(STATE_TREE_DEPTH, EPOCH_KEY_NONCE_PER_EPOCH, FIELD_COUNT) {
signal input state_tree_indices[STATE_TREE_DEPTH];
signal input state_tree_elements[STATE_TREE_DEPTH];
signal input identity_secret;
signal input data[FIELD_COUNT];
signal input sig_data;
signal input reveal_nonce;
signal input attester_id;
signal input epoch;
signal input nonce;
signal input chain_id;
signal output epoch_key;
signal output state_tree_root;
(epoch_key, state_tree_root, control) <== EpochKey(STATE_TREE_DEPTH, EPOCH_KEY_NONCE_PER_EPOCH, FIELD_COUNT)(
state_tree_indices,
state_tree_elements,
identity_secret,
reveal_nonce,
attester_id,
epoch,
nonce,
data,
sig_data,
chain_id
);
// add your customized circuits
...
}
```
### Proof helpers
Proof helpers can help users query the public signals in each proof.
**EpochKeyProof**
```ts
import { EpochKeyProof } from '@unirep/circuits'
const { proof, publicSignals } = await prover.genProofAndPublicSignals(
Circuit.epochKey,
circuitInputs
)
const data = new EpochKeyProof(publicSignals, proof)
const epk = data.epochKey
```
**SignupProof**
```ts
import { SignupProof } from '@unirep/circuits'
const { proof, publicSignals } = await prover.genProofAndPublicSignals(
Circuit.signup,
circuitInputs
)
const data = new SignupProof(publicSignals, proof)
const identityCommitment = data.identityCommitment
```
## 🙌🏻 Join our community
- Discord server: 
- Twitter account: 
- Telegram group: 
## 
Privacy & Scaling Explorations
This project is supported by [Privacy & Scaling Explorations](https://github.com/privacy-scaling-explorations) and the Ethereum Foundation.
See more projects on: https://pse.dev/.