npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

@vivianjeng/circuits

v2.0.0-beta-5

Published

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

Downloads

2

Readme

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 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

Build a prover for UniRep protocol

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<boolean> => {
        const vkey = require(buildPath +  `${name}.vkey.json`)
        return snarkjs.groth16.verify(vkey, publicSignals, proof)
    },
}

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;   

    (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/.