Skip to main content
Version: 2.1.x

UniRep circuits package

Client library for circuit related functions which are used in UniRep protocol.

Github licenseNPM versionDownloadsLinter eslintCode style prettier

💡 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

🛠 Install​

npm or yarn​

Install the @unirep/circuits package with npm:

npm i @unirep/circuits

or yarn:

yarn add @unirep/circuits

📔 Usage​

Prover​

Use default nodejs prover

import { defaultProver } from '@unirep/circuits/provers/defaultProver'

Use web prover

// default web prover from url: https://keys.unirep.io/${version}/.
import prover from '@unirep/circuits/provers/web'

// construct web prover from other url
import { WebProver } from '@unirep/circuits/provers/web'
const prover = new WebProver('https://YOUR/KEYS/URL')

Generate proof and verify it with the above prover

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:

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;
    signal output control;

    (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

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

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 and the Ethereum Foundation. See more projects on: https://pse.dev/.