@semaphore-protocol/proof

Index

Type Aliases

Functions

Type Aliases

BigNumberish

BigNumberish: string | bigint

FullProof

FullProof: { proof: Proof; publicSignals: PublicSignals }

Type declaration

proof: Proof
publicSignals: PublicSignals

Proof

Proof: { curve: string; pi_a: BigNumberish[]; pi_b: BigNumberish[][]; pi_c: BigNumberish[]; protocol: string }

Type declaration

curve: string
pi_a: BigNumberish[]
pi_b: BigNumberish[][]
pi_c: BigNumberish[]
protocol: string

PublicSignals

PublicSignals: { externalNullifier: BigNumberish; merkleRoot: BigNumberish; nullifierHash: BigNumberish; signalHash: BigNumberish }

Type declaration

externalNullifier: BigNumberish
merkleRoot: BigNumberish
nullifierHash: BigNumberish
signalHash: BigNumberish

SnarkArtifacts

SnarkArtifacts: { wasmFilePath: string; zkeyFilePath: string }

Type declaration

wasmFilePath: string
zkeyFilePath: string

SolidityProof

SolidityProof: [BigNumberish, BigNumberish, BigNumberish, BigNumberish, BigNumberish, BigNumberish, BigNumberish, BigNumberish]

Functions

generateNullifierHash

generateNullifierHash(externalNullifier: BigNumberish, identityNullifier: BigNumberish): bigint

- Defined in generateNullifierHash.ts:10
Generates a nullifier by hashing the external and the identity nullifiers.

Parameters
- externalNullifier: BigNumberish
  
  The external nullifier.
- identityNullifier: BigNumberish
  
  The identity nullifier.
Returns bigint
The nullifier hash.

generateProof

generateProof(identity: default, groupOrMerkleProof: default | MerkleProof, externalNullifier: BigNumberish, signal: string, snarkArtifacts?: SnarkArtifacts): Promise<FullProof>

- Defined in generateProof.ts:8
Parameters
- identity: default
- groupOrMerkleProof: default | MerkleProof
- externalNullifier: BigNumberish
- signal: string
- Optional snarkArtifacts: SnarkArtifacts
Returns Promise<FullProof>

generateSignalHash

generateSignalHash(signal: string): bigint

- Defined in generateSignalHash.ts:10
Hashes a signal string with Keccak256.

Parameters
- signal: string
  
  The Semaphore signal.
Returns bigint
The signal hash.

packToSolidityProof

packToSolidityProof(proof: Proof): SolidityProof

- Defined in packToSolidityProof.ts:8
Makes a proof compatible with the Verifier.sol method inputs.

Parameters
- proof: Proof
  
  The proof generated with SnarkJS.
Returns SolidityProof
The Solidity compatible proof.

verifyProof

verifyProof(verificationKey: any, fullProof: FullProof): Promise<boolean>

- Defined in verifyProof.ts:10
Verifies a SnarkJS proof.

Parameters
- verificationKey: any
  
  The zero-knowledge verification key.
- fullProof: FullProof
  
  The SnarkJS full proof.
Returns Promise<boolean>
True if the proof is valid, false otherwise.

Generated using TypeDoc