ReputationVerifierHelper.sol

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

Typescript/Javascript

reputationVerifierHelper.ts

import { deployVerifierHelper } from '@unirep/contracts/deploy'
import { defaultProver } from '@unirep/circuits/provers/defaultProver'
import { Circuit, ReputationProof } from '@unirep/circuits'

// deploys reputation verifier helper contract
const reputationVerifierHelper = await deployVerifierHelper(accounts[0], Circuit.proveReputation)

const r = await defaultProver.genProofAndPublicSignals(
  Circuit.proveReputation,
  CircuitInputs // see @unirep/circuits to know the whole circuit inputs
)

const { publicSignals, proof } = new ReputationProof(
  r.publicSignals,
  r.proof
)

// fails or returns proof signals
const signals = await reputationVerifierHelper.verifyAndCheck(
  publicSignals,
  proof
) 

Solidity

App.sol

// SPDX-License-Identifier: MIT
pragma solidity ^0.8.0;

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

contract App {
  // use the deployed helper
  ReputationVerifierHelper public helper;
  constructor(
    ReputationVerifierHelper _helper
  ) {
    helper = _helper;
  }

  // decode and verify the proofs
  // fails or returns proof signals
  function decodeAndVerify(
    uint256[] calldata publicSignals,
    uint256[8] calldata proof
  ) public view returns (ReputationVerifierHelper.ReputationSignals memory) {
    return helper.verifyAndCheck(publicSignals, proof);
  }
}

decodeReputationControl

Decode a reputation related control from reputation proof into named variables.

function decodeReputationControl(uint256 control)
    public
    pure
    returns (
      uint256 minRep,
      uint256 maxRep,
      bool proveMinRep,
      bool proveMaxRep,
      bool proveZeroRep,
      bool proveGraffiti
    )

decodeReputationSignals

Decode the public signals from a reputation proof into named variables.

function decodeReputationSignals(uint256[] memory publicSignals)
    public
    pure
    returns (ReputationSignals memory)

struct ReputationSignals {
    bool proveGraffiti;
    bool proveMinRep;
    bool proveMaxRep;
    bool proveZeroRep;
    bool revealNonce;
    uint8 nonce;
    uint48 epoch;
    uint160 attesterId;
    uint256 stateTreeRoot;
    uint256 epochKey;
    uint256 graffiti;
    uint256 minRep;
    uint256 maxRep;
}

verifyAndCheck

Verify a reputation proof and validate the public signals against the onchain state. This function will revert if any inputs are invalid.

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.

danger

This function does not verify that the attesterId is the same as the caller. Thus, we recommend that to either use verifyAndCheckCaller or to manually verify the attesterId

function verifyAndCheck(
    uint256[] calldata publicSignals,
    uint256[8] calldata proof
) public
  view
  returns (ReputationSignals memory) 

verifyAndCheckCaller

Verify a reputation proof and validate the public signals against the onchain state. This function will revert if any inputs are invalid. This is identical to verifyAndCheck but also checks that the caller is the attester.

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 verifyAndCheckCaller(
    uint256[] calldata publicSignals,
    uint256[8] calldata proof
) public
  view
  returns (ReputationSignals memory) 

danger

The helper is not connected to the Unirep.sol contract. Please manually check if the state tree root exists with attesterStateTreeRootExists.

1. Decode public signals

ReputationVerifierHelper.ReputationSignals memory signals = verifier.decodeReputationSignals(publicSignals); 

2. Verify state tree root

require(
  unirep.attesterStateTreeRootExists(
    signals.attesterId, 
    signals.epoch, 
    signals.stateTreeRoot
  )
);