Product
Introducing License Enforcement in Socket
Ensure open-source compliance with Socket’s License Enforcement Beta. Set up your License Policy and secure your software!
@unirep/contracts
Advanced tools
Client library for contracts related functions which are used in UniRep protocol.
Client library for contracts 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/contracts
package with npm:
npm i @unirep/contracts
or yarn:
yarn add @unirep/contracts
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)
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)
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()
// 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
);
}
}
This project is supported by Privacy & Scaling Explorations and the Ethereum Foundation. See more projects on: https://pse.dev/.
FAQs
Client library for contracts related functions which are used in UniRep protocol.
The npm package @unirep/contracts receives a total of 61 weekly downloads. As such, @unirep/contracts popularity was classified as not popular.
We found that @unirep/contracts demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 0 open source maintainers 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.
Product
Ensure open-source compliance with Socket’s License Enforcement Beta. Set up your License Policy and secure your software!
Product
We're launching a new set of license analysis and compliance features for analyzing, managing, and complying with licenses across a range of supported languages and ecosystems.
Product
We're excited to introduce Socket Optimize, a powerful CLI command to secure open source dependencies with tested, optimized package overrides.