Version: next

Class: UserState

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

Example

import { UserState } from '@unirep/core'
import { defaultProver } from '@unirep/circuits/provers/defaultProver'
import { Identity } from '@semaphore-protocol/identity'

const id = new Identity()
const state = new UserState({
  prover: defaultProver, // a circuit prover
  unirepAddress: '0xaabbccaabbccaabbccaabbccaabbccaabbccaaaa',
  provider, // an ethers.js provider
  id,
})

// or, initialize with an existing synchronizer object
const state = new UserState({
  synchronizer,
  id,
  prover: defaultProver, // a circuit prover
})

// start the synchoronizer deamon
await state.start()
await state.waitForSync()

// stop the synchronizer deamon
state.stop()

Constructors

constructor

• new UserState(config)

Parameters

Name	Type
`config`	`Object`
`config.attesterId?`	`bigint` \| `bigint`[]
`config.db?`	`DB`
`config.id`	`default`
`config.prover`	`Prover`
`config.provider?`	`Provider`
`config.synchronizer?`	`Synchronizer`
`config.unirepAddress?`	`string`

Defined in

packages/core/src/UserState.ts:97

Properties

_chainId

• Private _chainId: number

Defined in

packages/core/src/UserState.ts:60

_id

• Private _id: default

Defined in

packages/core/src/UserState.ts:58

_prover

• Private _prover: Prover

Defined in

packages/core/src/UserState.ts:57

_sync

• Private _sync: Synchronizer

Defined in

packages/core/src/UserState.ts:59

Accessors

chainId

• get chainId(): number

The current chain ID of UniRep contract.

Returns

number

Defined in

packages/core/src/UserState.ts:93

commitment

• get commitment(): bigint

The Semaphore identity commitment of the user.

Returns

bigint

Defined in

packages/core/src/UserState.ts:65

id

• get id(): default

The Semaphore identity of the user.

Returns

default

Defined in

packages/core/src/UserState.ts:72

prover

• get prover(): Prover

The prover object.

Returns

Prover

Defined in

packages/core/src/UserState.ts:86

sync

• get sync(): Synchronizer

The underlying synchronizer object.

Returns

Synchronizer

Defined in

packages/core/src/UserState.ts:79

Methods

_checkBit

▸ Private _checkBit(input, bit): void

Check if the input exceeds the maximum bit

Parameters

Name	Type	Description
`input`	`bigint`	The input value
`bit`	`number`	The bit number

Returns

void

Defined in

packages/core/src/UserState.ts:567

_checkChainId

▸ Private _checkChainId(): Promise<void>

Check if a chain ID is set. If a chain ID is not set, it queries the provider and sets chain ID.

Returns

Promise<void>

Defined in

packages/core/src/UserState.ts:554

_checkEpkNonce

▸ Private _checkEpkNonce(epochKeyNonce): void

Check if epoch key nonce is valid. Throws an error if the epoch key nonce is invalid.

Parameters

Name	Type	Description
`epochKeyNonce`	`number`	The input epoch key nonce to be checked.

Returns

void

Defined in

packages/core/src/UserState.ts:531

_checkSync

▸ Private _checkSync(): void

Check if a synchronizer is set. Throws an error if a synchronizer is not set.

Returns

void

Defined in

packages/core/src/UserState.ts:545

genEpochKeyLiteProof

▸ genEpochKeyLiteProof(options?): Promise<EpochKeyLiteProof>

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

This proof will not include a merkle tree proof which makes the proof size smaller than an EpochKeyProof. It can be used to prove a seen and valid epoch key.

Parameters

Name	Type	Description
`options`	`Object`	-
`options.attesterId?`	`string` \| `bigint`	Indicates for which attester the proof will be used. Default: `this.attesterId`
`options.data?`	`bigint`	Indicates if user wants to endorse a 253-bits data. Default: `0`.
`options.epoch?`	`number`	The specified epoch. Default: current epoch.
`options.nonce?`	`number`	The specified epoch key nonce. Default: `0`.
`options.revealNonce?`	`boolean`	Indicates if user wants to reveal epoch key nonce. Default: `false`.

Returns

Promise<EpochKeyLiteProof>

The epoch key lite proof of type EpochKeyLiteProof.

Example

const { publicSignals, proof } = await userState.genEpochKeyLiteProof({
  nonce: 1
})

Defined in

packages/core/src/UserState.ts:933

genEpochKeyProof

▸ genEpochKeyProof(options?): Promise<EpochKeyProof>

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

Parameters

Name	Type	Description
`options`	`Object`	-
`options.attesterId?`	`string` \| `bigint`	Indicates for which attester the proof will be used. Default: `this.attesterId`
`options.data?`	`bigint`	Indicates if user wants to endorse a 253-bits data. Default: `0`
`options.epoch?`	`number`	The specified epoch. Default: current epoch.
`options.nonce?`	`number`	The specified epoch key nonce. Default: `0`.
`options.revealNonce?`	`boolean`	Indicates if user wants to reveal epoch key nonce. Default: `false`.

Returns

Promise<EpochKeyProof>

The epoch key proof of type EpochKeyProof.

Example

const { publicSignals, proof } = await userState.genEpochKeyProof({
  nonce: 1
})

Defined in

packages/core/src/UserState.ts:870

genProveReputationProof

▸ genProveReputationProof(options): Promise<ReputationProof>

Generate a proof of reputation. Returns a ReputationProof.

danger

Please avoid assigning the minRep = data[0] - data[1] or maxRep = data[1] - data[0].
The proof could allow a user to accidentally publish their overall reputation (i.e. data[0]-data[1]). Depending on the circumstances (such as the length of the attestation history) this could reveal a user’s epoch key(s) as well.

Parameters

Name	Type	Description
`options`	`Object`	-
`options.attesterId?`	`string` \| `bigint`	`attesterId` is used to generate proof for certain attester. Default: `this.attesterId`
`options.data?`	`string` \| `bigint`	Indicates if user wants to endorse a 253-bits data. Default: `0`.
`options.epkNonce?`	`number`	The nonce determines the output of the epoch key. Default: `0`.
`options.graffiti?`	`string` \| `bigint`	The graffiti that user wants to prove. It should satisfy: `graffiti == (data[SUM_FIELD_COUNT] / (2 ** REPL_NONCE_BITS))`. Default: `0`.
`options.maxRep?`	`string` \| `number` \| `bigint`	The amount of reputation that user wants to prove. It should satisfy: `negRep - posRep >= maxRep`. Default: `0`
`options.minRep?`	`string` \| `number` \| `bigint`	The amount of reputation that user wants to prove. It should satisfy: `posRep - negRep >= minRep`. Default: `0`
`options.proveZeroRep?`	`boolean`	Indicates if user wants to prove `posRep - negRep == 0`. Default: `0`.
`options.revealNonce?`	`boolean`	Indicates if user wants to reveal epoch key nonce. Default: `false`.

Returns

Promise<ReputationProof>

The reputation proof of type ReputationProof.

Example

const {publicSignals, proof} = await userState.genProveReputationProof({
  minRep: 3,
  graffiti: '1234',
})

Defined in

packages/core/src/UserState.ts:761

genUserSignUpProof

▸ genUserSignUpProof(options?): Promise<SignupProof>

Generate a proof that can be used to signup. Returns a SignupProof

Parameters

Name	Type	Description
`options`	`Object`	-
`options.attesterId?`	`string` \| `bigint`	Indicates for which attester the proof will be used. Default: `this.attesterId`
`options.epoch?`	`number`	Indicates in which epoch the proof will be used. Default: current epoch.

Returns

Promise<SignupProof>

The sign up proof of type SignUpProof.

Example

const { publicSignals, proof } = await userState.genUserSignUpProof()

Defined in

packages/core/src/UserState.ts:828

genUserStateTransitionProof

▸ genUserStateTransitionProof(options?): Promise<UserStateTransitionProof>

Generate a user state transition proof. Returns a UserStateTransitionProof.

Parameters

Name	Type	Description
`options`	`Object`	-
`options.attesterId?`	`string` \| `bigint`	`attesterId` is used to generate proof for certain attester. Default: `this.attesterId`.
`options.toEpoch?`	`number`	`toEpoch` is used to indicate in which epoch the proof will be used. Default: current epoch.

Returns

Promise<UserStateTransitionProof>

The UserStateTransitionProof object.

Example

const { publicSignals, proof } = await userState.genUserStateTransitionProof()

Defined in

packages/core/src/UserState.ts:621

getData

▸ getData(toEpoch?, attesterId?): Promise<bigint[]>

Get the data for a user up to and including the provided epoch. By default data up to and including the current epoch is returned.

tip

If you want to make a proof of data make sure to use getProvableData. Data can only be proven once it has been included in a state tree leaf. Learn more about reputation proofs here.

Parameters

Name	Type	Description
`toEpoch?`	`number`	The latest epoch that the reputation is accumulated. Default: current epoch.
`attesterId`	`string` \| `bigint`	The attester to be queried. Default: `this.attesterId`

Returns

Promise<bigint[]>

The data object

Defined in

packages/core/src/UserState.ts:353

getDataByEpochKey

▸ getDataByEpochKey(epochKey, epoch, attesterId?): Promise<any[]>

Get the pending changes to the data owned by an epoch key.

Parameters

Name	Type	Description
`epochKey`	`string` \| `bigint`	The epoch key to be queried.
`epoch`	`number`	The epoch of the epoch key to be queried.
`attesterId`	`string` \| `bigint`	The attester to be queried. Default: `this.attesterId`

Returns

Promise<any[]>

The data object.

Defined in

packages/core/src/UserState.ts:490

getEpochKeyIndex

▸ getEpochKeyIndex(epoch, epochKey, attesterId): Promise<number>

Get the index of epoch key among all attestations.

Parameters

Name	Type	Description
`epoch`	`number`	The epoch of the epoch key to be queried.
`epochKey`	`string` \| `bigint`	The epoch key to be queried.
`attesterId`	`string` \| `bigint`	The attester to be queried.

Returns

Promise<number>

The index of the epoch key.

Defined in

packages/core/src/UserState.ts:582

getEpochKeys

▸ getEpochKeys(epoch?, nonce?, attesterId?): bigint | bigint[]

Get epoch keys for the current user, for an epoch. If a nonce value is supplied the return value will be a single epoch key. Otherwise an array of all epoch keys will be returned.

If no epoch is supplied the current epoch will be used (as determined by synchronizer.calcCurrentEpoch).

Parameters

Name	Type	Description
`epoch?`	`number` \| `bigint`	The epoch to be queried. Default: current epoch.
`nonce?`	`number`	The specified epoch key nonce. Default: `0`.
`attesterId`	`string` \| `bigint`	The attester to be queried. Default: `this.attesterId`

Returns

bigint | bigint[]

An epoch key or an array of epoch keys.

Defined in

packages/core/src/UserState.ts:293

getProvableData

▸ getProvableData(attesterId?): Promise<bigint[]>

Get the data that can be proven by the user using a state tree leaf. This is the data up to, but not including, the epoch the user has transitioned into.

Parameters

Name	Type	Description
`attesterId`	`string` \| `bigint`	The attester to be queried. Default: `this.attesterId`

Returns

Promise<bigint[]>

The data object

Defined in

packages/core/src/UserState.ts:476

hasSignedUp

▸ hasSignedUp(attesterId?): Promise<boolean>

Query the current database if the Semaphore identity commitment is stored.

Parameters

Name	Type	Description
`attesterId`	`string` \| `bigint`	The attester to be queried. Default: `this.attesterId`.

Returns

Promise<boolean>

True if user has signed up in unirep contract, false otherwise.

Defined in

packages/core/src/UserState.ts:175

latestStateTreeLeafIndex

▸ latestStateTreeLeafIndex(epoch?, attesterId?): Promise<number>

Get the latest global state tree leaf index for an epoch.

Parameters

Name	Type	Description
`epoch?`	`number`	Get the global state tree leaf index of the given epoch. Default: current epoch.
`attesterId`	`string` \| `bigint`	The attester to be queried. Default: `this.attesterId`

Returns

Promise<number>

The the latest state tree leaf index for an epoch.

Defined in

packages/core/src/UserState.ts:245

latestTransitionedEpoch

▸ latestTransitionedEpoch(attesterId?): Promise<number>

Query the current database for a user's signup event or latest user state transition nullifier.

Parameters

Name	Type	Description
`attesterId`	`string` \| `bigint`	The attester to be queried. Default: `this.attesterId`

Returns

Promise<number>

The latest epoch where a user performed a user state transition.

Defined in

packages/core/src/UserState.ts:194

parseReplData

▸ parseReplData(replData): Object

This function is used to parse replacement data field to be index and data. See replacement data field.

Parameters

Name	Type	Description
`replData`	`bigint`	The raw data which is processed on-chain.

Returns

Object

The parsed data and the data index (nonce).

Name	Type
`data`	`bigint`
`nonce`	`bigint`

Defined in

packages/core/src/UserState.ts:329

start

▸ start(): Promise<void>

Start the synchronizer daemon. Start polling the blockchain for new events. If we're behind the HEAD block we'll poll many times quickly

Returns

Promise<void>

Defined in

packages/core/src/UserState.ts:149

stop

▸ stop(): void

Stop synchronizing with Unirep contract.

Returns

void

Defined in

packages/core/src/UserState.ts:166

waitForSync

▸ waitForSync(blockNumber?): Promise<void>

Wait for the synchronizer to sync up to a certain block. By default this will wait until the current latest known block (according to the provider).

Parameters

Name	Type	Description
`blockNumber?`	`number`	The block number to be synced to.

Returns

Promise<void>

Defined in

packages/core/src/UserState.ts:159

Constructors​

constructor​

Parameters​

Defined in​

Properties​

_chainId​

Defined in​

_id​

Defined in​

_prover​

Defined in​

_sync​

Defined in​

Accessors​

chainId​

Returns​

Defined in​

commitment​

Returns​

Defined in​

id​

Returns​

Defined in​

prover​

Returns​

Defined in​

sync​

Returns​

Defined in​

Methods​

_checkBit​

Parameters​

Returns​

Defined in​

_checkChainId​

Returns​

Defined in​

_checkEpkNonce​

Parameters​

Returns​

Defined in​

_checkSync​

Returns​

Defined in​

genEpochKeyLiteProof​

Parameters​

Returns​

Defined in​

genEpochKeyProof​

Parameters​

Returns​

Defined in​

genProveReputationProof​

Parameters​

Returns​

Defined in​

genUserSignUpProof​

Parameters​

Returns​

Defined in​

genUserStateTransitionProof​

Parameters​

Returns​

Defined in​

getData​

Parameters​

Returns​

Defined in​

getDataByEpochKey​

Parameters​

Returns​

Defined in​

getEpochKeyIndex​

Parameters​

Returns​

Defined in​

getEpochKeys​

Parameters​

Returns​

Defined in​

Constructors

constructor

Parameters

Defined in

Properties

_chainId

Defined in

_id

Defined in

_prover

Defined in

_sync

Defined in

Accessors

chainId

Returns

Defined in

commitment

Returns

Defined in

id

Returns

Defined in

prover

Returns

Defined in

sync

Returns

Defined in

Methods

_checkBit

Parameters

Returns

Defined in

_checkChainId

Returns

Defined in

_checkEpkNonce

Parameters

Returns

Defined in

_checkSync

Returns

Defined in

genEpochKeyLiteProof

Parameters

Returns

Defined in

genEpochKeyProof

Parameters

Returns

Defined in

genProveReputationProof

Parameters

Returns

Defined in

genUserSignUpProof

Parameters

Returns

Defined in

genUserStateTransitionProof

Parameters

Returns

Defined in

getData

Parameters

Returns

Defined in

getDataByEpochKey

Parameters

Returns

Defined in

getEpochKeyIndex

Parameters

Returns

Defined in

getEpochKeys

Parameters

Returns

Defined in