Skip to main content
Version: 2.0.0-alpha-2

User State

The user state object is used to manage user state for an attester. The state is backed by an anondb instance.

import { UserState, schema } from '@unirep/core'
import { SQLiteConnector } from 'anondb/node'
import { defaultProver } from '@unirep/circuits/provers/defaultProver'

const db = new SQLiteConnector(schema, ':memory:')
const state = new UserState({
  db,
  prover: defaultProver, // a circuit prover
  unirepAddress: '0xaabbccaabbccaabbccaabbccaabbccaabbccaaaa',
  provider, // an ethers.js provider
  attesterId: ATTESTER_ADDRESS,
  _id: identity, // a user identity that will be used for making proofs
})
info

The UserState class is a superclass of Synchronizer.

constructor​

constructor(config: {
    db: DB
    prover: Prover
    unirepContract: ethers.Contract
    _id: ZkIdentity
    attesterId: bigint
}) {

hasSignedUp​

state.hasSignedUp(): Promise<boolean>

latestTransitionedEpoch​

state.latestTransitionedEpoch(): Promise<number>

latestStateTreeLeafIndex​

Get the latest state tree leaf index for either the latest transitioned epoch, or the epoch specified.

state.latestStateTreeLeafIndex(epoch?: number): Promise<number>

getEpochKeys​

Get epoch keys for the current user, for the current epoch.

state.getEpochKeys(epoch: number): bigint[]

getRepByAttester​

Get the reputation balance for an attester in an epoch. By default we use the currently specified attester and the latest epoch.

state.getRepByAttester(attesterId?: bigint, epoch: number): Promise<Reputation>

getRepByEpochKey​

Get the rep owed to an epoch key in a certain epoch.

state.getRepByEpochKey(epochKey: bigint, epoch: number): Promise<Reputation>

genUserStateTransitionProof​

Generate a user state transition proof.

state.genUserStateTransitionProof(options?: {
  toEpoch?: bigint | number
}): Promise<UserStateTransitionProof>

genProveReputationProof​

Generate a proof of reputation.

state.genProveReputationProof(options: {
  epochKeyNonce: number,
  minRep?: number
}): Promise<ReputationProof>

genUserSignUpProof​

Generate a proof that can be used to signup.

state.genUserSignUpProof(): Promise<SignupProof>

genEpochKeyProof​

Generate a proof that a user controls an epoch key in a certain epoch. Optionally provide a data value to sign.

state.genEpochKeyProof(options: {
  nonce?: number,
  epoch?: number,
  data?: bigint,
}): Promise<EpochKeyProof>

genAggregateEpochKeysProof​

Generate a proof that can be used to update the epoch tree root on chain.

info

TODO: See the epoch tree section for more info

danger

Users shouldn't be generating this proof.

state.genAggregateEpochKeysProof(options: {
    epochKeys: bigint[],
    newBalances: Reputation[],
    hashchainIndex: bigint,
    epoch?: number
}): Promise<AggregateEpochKeysProof>