Class ZkProofConnector

Connector for ZK-Proof operations using Semaphore protocol

Index

Constructors

Properties

credentialCache groups identityCache

Methods

addToGroup cleanup generateCredentials generateIdentity generateProof getCredential getOrCreateGroup restoreIdentity verifyProof

Constructors

constructor

new ZkProofConnector(): ZkProofConnector
Returns ZkProofConnector

Properties

`Private`credentialCache

credentialCache: Map<string, ZkProofCredential> = ...

`Private`groups

groups: Map<string, Group> = ...

`Private`identityCache

identityCache: Map<string, Identity> = ...

Methods

addToGroup

addToGroup(commitment: string, groupId?: string): void
Add identity to a group
Parameters
- commitment: string
- groupId: string = "default"
Returns void

cleanup

cleanup(): void
Clear all caches

Returns void

generateCredentials

generateCredentials(identityData: ZkIdentityData): Promise<ISEAPair>
Generate Gun credentials from ZK identity
Parameters
- identityData: ZkIdentityData
Returns Promise<ISEAPair>

generateIdentity

generateIdentity(seed?: string): Promise<ZkIdentityData>
Generate a new Semaphore identity
Parameters
- Optionalseed: string
Returns Promise<ZkIdentityData>

generateProof

generateProof(
identityData: ZkIdentityData,
options?: ZkProofGenerationOptions,
): Promise<SemaphoreProof>
Generate a Semaphore proof
Parameters
- identityData: ZkIdentityData
- options: ZkProofGenerationOptions = {}
Returns Promise<SemaphoreProof>

getCredential

getCredential(commitment: string): undefined | ZkProofCredential
Get cached credential by commitment
Parameters
- commitment: string
Returns undefined | ZkProofCredential

`Private`getOrCreateGroup

getOrCreateGroup(groupId?: string): Group
Get or create a Semaphore group
Parameters
- groupId: string = "default"
Returns Group

restoreIdentity

restoreIdentity(trapdoor: string): Promise<ZkIdentityData>
Restore identity from trapdoor
Parameters
- trapdoor: string
Returns Promise<ZkIdentityData>

verifyProof

verifyProof(
proof: SemaphoreProof,
treeDepth?: number,
): Promise<ZkProofVerificationResult>
Verify a Semaphore proof
Parameters
- proof: SemaphoreProof
- treeDepth: number = 20
Returns Promise<ZkProofVerificationResult>