Skip to main content
Version: next

UniRep contracts package

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

Github licenseNPM versionDownloadsLinter eslintCode style prettierCoverage report

💡 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/contracts package with npm:

npm i @unirep/contracts

or yarn:

yarn add @unirep/contracts

👩🏻‍⚕️ Deploy UniRep contract​

Deploy Unirep smart contract with default config:

import { ethers } from 'ethers'
import { Unirep } from '@unirep/contracts'
import { deployUnirep } from '@unirep/contracts/deploy'

const privateKey = 'YOUR/PRIVATE/KEY'
const provider = 'YOUR/ETH/PROVIDER'
const deployer = new ethers.Wallet(privateKey, provider);

const unirepContract: Unirep = await deployUnirep(deployer)

🙆🏻‍♀️ Get UniRep contract with address​

Check current deployment: 🤝 Testnet Deployment

import { getUnirepContract, Unirep } from '@unirep/contracts'

const address = '0x....'
const provider = 'YOUR/ETH/PROVIDER'

const unirepContract: Unirep = getUnirepContract(address, provider)

🧑🏻‍💻 Call UniRep contract with ethers​

import { ethers } from 'ethers'
import { getUnirepContract, Unirep } from '@unirep/contracts'

const address = '0x....'
const privateKey = 'YOUR/PRIVATE/KEY'
const provider = 'YOUR/ETH/PROVIDER'

// connect a signer
const signer = new ethers.Wallet(privateKey, provider)
const unirepContract: Unirep = getUnirepContract(address, signer)

// attester sign up
const epochLength = 300 // 300 seconds
const tx = await unirepContract.attesterSignUp(epochLength)
await tx.wait()

🙋🏻‍♂️ Call UniRep contract in DApps​

// SPDX-License-Identifier: UNLICENSED
pragma solidity ^0.8.0;
import { Unirep } from "@unirep/contracts/Unirep.sol";
import { IVerifier } from "@unirep/contracts/interfaces/IVerifier.sol";

contract UnirepApp {
    Unirep public unirep;
    IVerifier public dataVerifier;

    constructor(
        Unirep _unirep,
        IVerifier _dataVerifier,
        uint48 _epochLength
    ) {
        // set unirep address
        unirep = _unirep;

        // set verifier address
        dataVerifier = _dataVerifier;

        // sign up as an attester
        unirep.attesterSignUp(_epochLength);
    }

    // sign up users in this app
    function userSignUp(
        uint256[] memory publicSignals,
        uint256[8] memory proof
    ) public {
        unirep.userSignUp(publicSignals, proof);
    }

    // submit attestations
    function submitAttestation(
        uint256 epochKey,
        uint48 targetEpoch,
        uint256 fieldIndex,
        uint256 val
    ) public {
        unirep.attest(
            epochKey,
            targetEpoch,
            fieldIndex,
            val
        );
    }
}

🙌🏻 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/.