Skip to main content
Version: next

Class: SignupProof

src.SignupProof

A class representing a signup proof. Each of the following properties are public signals for the proof.

Hierarchy

Constructors

constructor

new SignupProof(publicSignals, proof, prover?)

Parameters

NameTypeDescription
publicSignals(string | bigint)[]The public signals of the user sign up proof that can be verified by the prover
proofGroth16ProofThe proof that can be verified by the prover
prover?ProverThe prover that can verify the public signals and the proof

Example

import { SignupProof } from '@unirep/circuits'
const data = new SignupProof(publicSignals, proof)

Overrides

BaseProof.constructor

Defined in

circuits/src/SignupProof.ts:57

Properties

_snarkProof

Readonly _snarkProof: Groth16Proof

The proof data in Groth16Proof format. Use this when manually verifying with snarkjs.

Inherited from

BaseProof._snarkProof

Defined in

circuits/src/BaseProof.ts:24


attesterId

attesterId: bigint

The attester id for the proof.

Defined in

circuits/src/SignupProof.ts:37


chainId

chainId: bigint

The chain id for the proof.

Defined in

circuits/src/SignupProof.ts:45


circuit

Protected Optional circuit: Circuit

The string name of the type of circuit this proof came from. For the BaseProof class this is undefined.

Inherited from

BaseProof.circuit

Defined in

circuits/src/BaseProof.ts:28


control

control: bigint

The control field used for the proof. This field contains many signals binary encoded into a single 253 bit value. This value is automatically decoded into the other properties on this class.

Defined in

circuits/src/SignupProof.ts:32


epoch

epoch: bigint

The epoch the proof was made within.

Defined in

circuits/src/SignupProof.ts:41


identityCommitment

identityCommitment: bigint

The identity commitment for the user signing up.

Defined in

circuits/src/SignupProof.ts:23


idx

Readonly idx: Object

The index of the data in the public signals

Type declaration

NameType
controlnumber
identityCommitmentnumber
stateTreeLeafnumber

Defined in

circuits/src/SignupProof.ts:13


proof

proof: bigint[]

The proof data formatted as string[]. Use this property when interacting with smart contracts.

Inherited from

BaseProof.proof

Defined in

circuits/src/BaseProof.ts:37


prover

Optional prover: Prover

The Prover object.

Inherited from

BaseProof.prover

Defined in

circuits/src/BaseProof.ts:41


publicSignals

Readonly publicSignals: bigint[]

The raw array of public signals for the proof.

Inherited from

BaseProof.publicSignals

Defined in

circuits/src/BaseProof.ts:33


stateTreeLeaf

stateTreeLeaf: bigint

The new state tree leaf for the user. This leaf will contain values for data.

Defined in

circuits/src/SignupProof.ts:27

Methods

verify

verify(): Promise<boolean>

A function to verify the proof with the supplied Prover. The prover property must be set either in the constructor or manually, otherwise this will throw.

Returns

Promise<boolean>

True if the proof is valid, false otherwise

Example

const isValid: boolean = await proof.verify()

Inherited from

BaseProof.verify

Defined in

circuits/src/BaseProof.ts:95


buildControl

Static buildControl(config): bigint

Pack several variables into one bigint variable.

Parameters

NameTypeDescription
configanyThe variables that will be packed.

Returns

bigint

The control

Example

SignupProof.buildControl({
epoch,
attesterId,
chainId
})

Defined in

circuits/src/SignupProof.ts:88