Security News
Introducing the Socket Python SDK
The initial version of the Socket Python SDK is now on PyPI, enabling developers to more easily interact with the Socket REST API in Python projects.
@vivianjeng/circuits
Advanced tools
Client library for circuit related functions which are used in UniRep protocol.
Client library for circuit related functions which are used in UniRep protocol.
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.
Read the medium article to know more about the concept of UniRep protocol. For more information, refer to the documentation
Install the @unirep/circuits
package with npm:
npm i @unirep/circuits
or yarn:
yarn add @unirep/circuits
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
)
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 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
This project is supported by Privacy & Scaling Explorations and the Ethereum Foundation. See more projects on: https://pse.dev/.
FAQs
Client library for circuit related functions which are used in UniRep protocol.
We found that @vivianjeng/circuits demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
The initial version of the Socket Python SDK is now on PyPI, enabling developers to more easily interact with the Socket REST API in Python projects.
Security News
Floating dependency ranges in npm can introduce instability and security risks into your project by allowing unverified or incompatible versions to be installed automatically, leading to unpredictable behavior and potential conflicts.
Security News
A new Rust RFC proposes "Trusted Publishing" for Crates.io, introducing short-lived access tokens via OIDC to improve security and reduce risks associated with long-lived API tokens.