Skip to main content
Version: 2.0.0-alpha-2

UniRep contract

This is the core UniRep contract.

import { Unirep } from '@unirep/contracts/Unirep.sol';

userSignUp​

Submit a signup zk proof for a user.

caution

msg.sender must be the attester.

function userSignUp(
  uint[] memory publicSignals,
  uint[8] memory proof
) public

attesterSignUp​

Register an attester contract. msg.sender will become an attester.

tip

The attesterId is the address of the attester contract. In this case msg.sender.

function attesterSignUp(uint epochLength) public

submitAttestation​

Create an attestation to an epoch key. If the current epoch is not the same as targetEpoch the transaction will revert.

caution

msg.sender must be the attester.

function submitAttestation(
  uint targetEpoch,
  uint epochKey,
  uint posRep,
  uint negRep,
  uint graffiti
) public

buildHashchain​

Create a hashchain of epoch key balance updates that can be used to update the epoch root.

function buildHashchain(uint160 attesterId) public

processHashchain​

Update the epoch tree root using a ZK proof and a hashchain.

function processHashchain(
  uint[] memory publicSignals,
  uint[8] memory proof
) public

userStateTransition​

Execute a user state transition using a ZK proof. This will insert a new state tree leaf in the current epoch.

function userStateTransition(
  uint[] memory publicSignals,
  uint[8] memory proof
) public

attesterCurrentEpoch​

Get the current epoch number for an attester.

function attesterCurrentEpoch(
  uint160 attesterId
) public view returns (uint)

attesterEpochRemainingTime​

Get the remaining time, in seconds, for the current epoch for an attester.

function attesterEpochRemainingTime(
  uint160 attesterId
) public view returns (uint)

verifyReputationProof​

Verify a reputation proof and validate the public signals against the onchain state. This function will revert if any inputs are out of range, otherwise a boolean value is returned.

caution

This function does not require the epoch for the proof to be the current epoch. The user may generate a valid proof for a past epoch. If you require the proof to be for the current epoch you should add an additional check using attesterCurrentEpoch.

function verifyReputationProof(
    uint256[] memory publicSignals,
    uint256[8] memory proof
) public returns (bool);

verifyEpochKeyProof​

Verify an epoch key proof and validate the public signals against the onchain state. This function will revert if any inputs are out of range, otherwise a boolean value is returned.

caution

This function does not require the epoch for the proof to be the current epoch. The user may generate a valid proof for a past epoch. If you require the proof to be for the current epoch you should add an additional check using attesterCurrentEpoch.

function verifyEpochKeyProof(
    uint256[] memory publicSignals,
    uint256[8] memory proof
) public returns (bool);

epochKeyVerifier​

A contract address for an epoch key proof verifier. See IVerifier for more info.

danger

Using the verifier directly does not validate the output state root, attester id, or epoch. Prefer the verifyEpochKeyProof function unless you know what you are doing.

IVerifier public immutable epochKeyVerifier;

Example use:

bool valid = unirep.epochKeyVerifier.verifyProof(publicSignals, proof);

signupVerifier​

A contract address for a signup proof verifier. See IVerifier for more info.

IVerifier public immutable signupVerifier;

reputationVerifier​

A contract address for a reputation proof verifier. See IVerifier for more info.

danger

Using the verifier directly does not validate the output state root, attester id, or epoch. Prefer the verifyReputationProof function unless you know what you are doing.

IVerifier public immutable reputationVerifier;

userStateTransitionVerifier​

A contract address for a user state transition proof verifier. See IVerifier for more info.

IVerifier public immutable userStateTransitionVerifier;

aggregateEpochKeysVerifier​

A contract address for an aggregate epoch keys proof verifier. See IVerifier for more info.

IVerifier public immutable aggregateEpochKeysVerifier;

Events​

The UniRep contract emits a number of events to help offchain observers track state.

UserSignUp​

Emitted when a user joins an attester.

event UserSignedUp(
    uint256 indexed epoch,
    uint256 indexed identityCommitment,
    uint160 indexed attesterId,
    uint256 leafIndex
);

UserStateTransitioned​

Emitted when a user transitions to a new epoch.

event UserStateTransitioned(
    uint256 indexed epoch,
    uint160 indexed attesterId,
    uint256 indexed leafIndex,
    uint256 hashedLeaf,
    uint256 nullifier
);

AttestationSubmitted​

Emitted when an attester makes an attestation to an epoch key.

event AttestationSubmitted(
    uint256 indexed epoch,
    uint256 indexed epochKey,
    uint160 indexed attesterId,
    uint256 posRep,
    uint256 negRep
);

StateTreeLeaf​

Emitted when a leaf is added to a state tree.

event StateTreeLeaf(
    uint256 indexed epoch,
    uint160 indexed attesterId,
    uint256 indexed index,
    uint256 leaf
);

EpochTreeLeaf​

Emitted when a leaf in an epoch tree is updated.

event EpochTreeLeaf(
    uint256 indexed epoch,
    uint160 indexed attesterId,
    uint256 indexed index,
    uint256 leaf
);

EpochEnded​

Emitted when an attester epoch ends.

event EpochEnded(uint256 indexed epoch, uint160 indexed attesterId);