Module: src

Enumerations

• Circuit

Classes

• BaseProof
• CircuitConfig
• EpochKeyLiteProof
• EpochKeyProof
• ReputationProof
• ScopeNullifierProof
• SignupProof
• UserStateTransitionProof

Interfaces

• Prover

Type Aliases

EpochKeyControl

Ƭ EpochKeyControl: Object

The data is used to build epoch key control.

See

https://developer.unirep.io/docs/circuits-api/circuits#epoch-key-proof

Type declaration

Name	Type
attesterId	bigint
chainId	bigint
epoch	bigint
nonce	bigint
revealNonce	bigint

Defined in

circuits/src/type.ts:9

---

Field

Ƭ Field: bigint | string

Defined in

circuits/src/type.ts:3

---

ReputationControl

Ƭ ReputationControl: Object

The data is used to build reputation control.

See

https://developer.unirep.io/docs/circuits-api/circuits#reputation-proof

Type declaration

Name	Type
maxRep	bigint
minRep	bigint
proveGraffiti	bigint
proveMaxRep	bigint
proveMinRep	bigint
proveZeroRep	bigint

Defined in

circuits/src/type.ts:21

---

SignupControl

Ƭ SignupControl: Object

The data is used to build signup control.

See

https://developer.unirep.io/docs/circuits-api/circuits#signup-proof

Type declaration

Name	Type
attesterId	bigint
chainId	bigint
epoch	bigint

Defined in

circuits/src/type.ts:43

---

UserStateTransitionControl

Ƭ UserStateTransitionControl: Object

The data is used to build user state transition control.

See

https://developer.unirep.io/docs/circuits-api/circuits#user-state-transition-proof

Type declaration

Name	Type
attesterId	bigint
toEpoch	bigint

Defined in

circuits/src/type.ts:34

Variables

SNARK_SCALAR_FIELD

• Const SNARK_SCALAR_FIELD: "21888242871839275222246405745257275088548364400416034343698204186575808495617"

A decimal string representing the field prime.

Defined in

utils/build/crypto.d.ts:4

Functions

buildEpochKeyControl

▸ buildEpochKeyControl(params, config?): bigint

Encode data to a 253 bits variable.

Parameters

Name	Type	Default value	Description
params	EpochKeyControl	undefined	The data is going to be encoded. { nonce, epoch, attesterId, revealNonce, chainId }
config	CircuitConfig	CircuitConfig.default	The circuit config. Default: CircuitConfig.default

Returns

bigint

a 253 bits control.

Defined in

circuits/src/utils.ts:196

---

buildReputationControl

▸ buildReputationControl(params, config?): bigint

Encode data to a 253 bits variable.

Parameters

Name	Type	Default value	Description
params	ReputationControl	undefined	The data is going to be encoded. { minRep, maxRep, proveMinRep, proveMaxRep, proveZeroRep, proveGraffiti }
config	CircuitConfig	CircuitConfig.default	The circuit config. Default: CircuitConfig.default

Returns

bigint

a 253 bits control.

Defined in

circuits/src/utils.ts:229

---

buildSignupControl

▸ buildSignupControl(params, config?): bigint

Encode data to a 253 bits variable.

Parameters

Name	Type	Default value	Description
params	SignupControl	undefined	The data is going to be encoded. { attesterId, epoch, chainId }
config	CircuitConfig	CircuitConfig.default	The circuit config. Default: CircuitConfig.default

Returns

bigint

a 253 bits control.

Defined in

circuits/src/utils.ts:293

---

buildUserStateTransitionControl

▸ buildUserStateTransitionControl(params, config?): bigint

Encode data to a 253 bits variable.

Parameters

Name	Type	Default value	Description
params	UserStateTransitionControl	undefined	The data is going to be encoded. { attesterId, toEpoch }
config	CircuitConfig	CircuitConfig.default	The circuit config. Default: CircuitConfig.default

Returns

bigint

a 253 bits control.

Defined in

circuits/src/utils.ts:270

---

decodeEpochKeyControl

▸ decodeEpochKeyControl(control, config?): EpochKeyControl

Decode the raw control field to desired data.

Parameters

Name	Type	Default value	Description
control	bigint	undefined	The raw control field generated by genProofAndPublicSignals
config	CircuitConfig	CircuitConfig.default	The circuit config. Default: CircuitConfig.default

Returns

EpochKeyControl

{ nonce, epoch, attesterId, revealNonce, chainId }

Defined in

circuits/src/utils.ts:70

---

decodeReputationControl

▸ decodeReputationControl(control, config?): Object

Decode the raw control field to desired data.

Parameters

Name	Type	Default value	Description
control	bigint	undefined	The raw control field generated by genProofAndPublicSignals
config	CircuitConfig	CircuitConfig.default	The circuit config. Default: CircuitConfig.default

Returns

Object

{ minRep, maxRep, proveMinRep, proveMaxRep, proveZeroRep, proveGraffiti }

Name	Type
maxRep	bigint
minRep	bigint
proveGraffiti	bigint
proveMaxRep	bigint
proveMinRep	bigint
proveZeroRep	bigint

Defined in

circuits/src/utils.ts:107

---

decodeSignupControl

▸ decodeSignupControl(control, config?): SignupControl

Decode the raw control field to desired data.

Parameters

Name	Type	Default value	Description
control	bigint	undefined	The raw control field generated by genProofAndPublicSignals
config	CircuitConfig	CircuitConfig.default	The circuit config. Default: CircuitConfig.default

Returns

SignupControl

{ attesterId, epoch, chainId }

Defined in

circuits/src/utils.ts:170

---

decodeUserStateTransitionControl

▸ decodeUserStateTransitionControl(control, config?): UserStateTransitionControl

Decode the raw control field to desired data.

Parameters

Name	Type	Default value	Description
control	bigint	undefined	The raw control field generated by genProofAndPublicSignals
config	CircuitConfig	CircuitConfig.default	The circuit config. Default: CircuitConfig.default

Returns

UserStateTransitionControl

{ attesterId, toEpoch }

Defined in

circuits/src/utils.ts:148

---

formatProofForSnarkjsVerification

▸ formatProofForSnarkjsVerification(proof): SnarkProof

Format an one dimensional array for snarkjs verification

Parameters

Name	Type	Description
proof	Field[]	The string array of the proof

Returns

SnarkProof

The SnarkProof type proof data

Defined in

circuits/src/utils.ts:34

---

formatProofForVerifierContract

▸ formatProofForVerifierContract(proof): string[]

Format snark proof for verifier smart contract

Parameters

Name	Type	Description
proof	SnarkProof	The proof of SnarkProof type

Returns

string[]

An one dimensional array of stringified proof data

Defined in

circuits/src/utils.ts:16

---

shiftBits

▸ shiftBits(data, shiftBits, variableBits): bigint

Shift shiftBits bits and compute the AND operation in variableBits bits data. For example, Get data from LSB 20 to 30 bits. Then use shiftBits(data, 20, 10) to get the 10 bits data.

Parameters

Name	Type	Description
data	bigint	The raw data in bigint type.
shiftBits	bigint	The shifted bits.
variableBits	bigint	The output data bits.

Returns

bigint

Defined in

circuits/src/utils.ts:56