Class ZkProofPlugin

Plugin for Zero-Knowledge Proof authentication using Semaphore protocol

Features:

  • Anonymous authentication with ZK proofs
  • Multi-device support via trapdoor backup
  • Privacy-preserving identity management
  • Compatible with Gun decentralized storage

Hierarchy (View Summary)

Implements

Constructors

constructor

Properties

_category config connector core description name version

Methods

addToGroup assertConnector assertInitialized destroy emit generateCredentials generateIdentity generateProof initialize isAvailable login off on once removeAllListeners restoreIdentity signUp verifyProof

Constructors

constructor

Properties

_category

_category: PluginCategory = PluginCategory.Authentication

Categoria del plugin

Privateconfig

config: ZkProofConfig

Privateconnector

connector: null | ZkProofConnector = null

Protectedcore

core: null | ShogunCore = null

Riferimento all'istanza di ShogunCore

description

description: string = "Zero-Knowledge Proof authentication using Semaphore protocol for ShogunCore"

Descrizione opzionale del plugin

name

name: string = "zkproof"

Nome univoco del plugin - deve essere implementato dalle sottoclassi

version

version: string = "1.0.0"

Versione del plugin - deve essere implementata dalle sottoclassi

Methods

addToGroup

  • addToGroup(commitment: string, groupId?: string): void

    Add identity to a group

    Parameters

    • commitment: string
    • OptionalgroupId: string

    Returns void

PrivateassertConnector

ProtectedassertInitialized

  • assertInitialized(): ShogunCore

    Verifica che il plugin sia stato inizializzato prima di usare il core

    Returns ShogunCore

    L'istanza di ShogunCore non null

    Throws

    Error se il plugin non è stato inizializzato

destroy

emit

  • emit(event: EventType, data?: unknown): boolean

    Emits an event with arguments

    Parameters

    • event: EventType
    • Optionaldata: unknown

    Returns boolean

generateCredentials

generateIdentity

generateProof

initialize

isAvailable

  • isAvailable(): boolean

    Check if ZK-Proof is available

    Returns boolean

login

off

  • off(event: EventType, listener: (data: unknown) => void): void

    Removes an event listener

    Parameters

    • event: EventType
    • listener: (data: unknown) => void

    Returns void

on

  • on(event: EventType, listener: (data: unknown) => void): void

    Registers an event listener

    Parameters

    • event: EventType
    • listener: (data: unknown) => void

    Returns void

once

  • once(event: EventType, listener: (data: unknown) => void): void

    Registers a one-time event listener

    Parameters

    • event: EventType
    • listener: (data: unknown) => void

    Returns void

removeAllListeners

  • removeAllListeners(event?: EventType): void

    Removes all listeners for an event or all events

    Parameters

    • Optionalevent: EventType

    Returns void

restoreIdentity

signUp

  • signUp(seed?: string): Promise<SignUpResult>

    Sign up with new ZK identity

    Parameters

    • Optionalseed: string

      Optional seed for deterministic generation

    Returns Promise<SignUpResult>

    Authentication result with trapdoor for backup

verifyProof

Settings

Member Visibility

On This Page

Constructors
Properties
Methods