@sip-protocol/sdk 0.7.3 → 0.8.0

package/dist/{noir-DKfEzWy9.d.mts → noir-kzbLVTei.d.mts}

@@ -162,6 +162,18 @@ interface ProofProvider {
      * @throws Error if initialization fails
      */
     initialize(): Promise<void>;
+    /**
+     * Wait for the provider to be ready, with optional timeout
+     *
+     * This method blocks until initialization is complete or the timeout is reached.
+     * If initialization is already complete, resolves immediately.
+     * If initialization hasn't started, this method will start it.
+     *
+     * @param timeoutMs - Maximum time to wait in milliseconds (default: 30000)
+     * @throws ProofError if timeout is reached before ready
+     * @throws ProofError if initialization fails
+     */
+    waitUntilReady(timeoutMs?: number): Promise<void>;
     /**
      * Generate a Funding Proof
      *
@@ -277,31 +289,13 @@ interface NoirProviderConfig {
      */
     strictMode?: boolean;
 }
-/**
- * Noir Proof Provider
- *
- * Production ZK proof provider using Noir circuits.
- *
- * @example
- * ```typescript
- * const provider = new NoirProofProvider()
- *
- * await provider.initialize()
- *
- * const result = await provider.generateFundingProof({
- *   balance: 100n,
- *   minimumRequired: 50n,
- *   blindingFactor: new Uint8Array(32),
- *   assetId: '0xABCD',
- *   userAddress: '0x1234...',
- *   ownershipSignature: new Uint8Array(64),
- * })
- * ```
- */
 declare class NoirProofProvider implements ProofProvider {
     readonly framework: ProofFramework;
     private _isReady;
+    private _initPromise;
+    private _initError;
     private config;
+    private barretenberg;
     private fundingNoir;
     private fundingBackend;
     private validityNoir;
@@ -346,6 +340,22 @@ declare class NoirProofProvider implements ProofProvider {
      * Loads circuit artifacts and initializes the proving backend.
      */
     initialize(): Promise<void>;
+    /**
+     * Wait for the provider to be ready, with optional timeout
+     *
+     * This method blocks until initialization is complete or the timeout is reached.
+     * If initialization is already complete, resolves immediately.
+     * If initialization hasn't started, this method will start it.
+     *
+     * @param timeoutMs - Maximum time to wait in milliseconds (default: 30000)
+     * @throws ProofError if timeout is reached before ready
+     * @throws ProofError if initialization fails
+     */
+    waitUntilReady(timeoutMs?: number): Promise<void>;
+    /**
+     * Internal initialization logic
+     */
+    private _doInitialize;
     /**
      * Generate a Funding Proof using Noir circuits
      *

package/dist/{noir-DKfEzWy9.d.ts → noir-kzbLVTei.d.ts}

@@ -162,6 +162,18 @@ interface ProofProvider {
      * @throws Error if initialization fails
      */
     initialize(): Promise<void>;
+    /**
+     * Wait for the provider to be ready, with optional timeout
+     *
+     * This method blocks until initialization is complete or the timeout is reached.
+     * If initialization is already complete, resolves immediately.
+     * If initialization hasn't started, this method will start it.
+     *
+     * @param timeoutMs - Maximum time to wait in milliseconds (default: 30000)
+     * @throws ProofError if timeout is reached before ready
+     * @throws ProofError if initialization fails
+     */
+    waitUntilReady(timeoutMs?: number): Promise<void>;
     /**
      * Generate a Funding Proof
      *
@@ -277,31 +289,13 @@ interface NoirProviderConfig {
      */
     strictMode?: boolean;
 }
-/**
- * Noir Proof Provider
- *
- * Production ZK proof provider using Noir circuits.
- *
- * @example
- * ```typescript
- * const provider = new NoirProofProvider()
- *
- * await provider.initialize()
- *
- * const result = await provider.generateFundingProof({
- *   balance: 100n,
- *   minimumRequired: 50n,
- *   blindingFactor: new Uint8Array(32),
- *   assetId: '0xABCD',
- *   userAddress: '0x1234...',
- *   ownershipSignature: new Uint8Array(64),
- * })
- * ```
- */
 declare class NoirProofProvider implements ProofProvider {
     readonly framework: ProofFramework;
     private _isReady;
+    private _initPromise;
+    private _initError;
     private config;
+    private barretenberg;
     private fundingNoir;
     private fundingBackend;
     private validityNoir;
@@ -346,6 +340,22 @@ declare class NoirProofProvider implements ProofProvider {
      * Loads circuit artifacts and initializes the proving backend.
      */
     initialize(): Promise<void>;
+    /**
+     * Wait for the provider to be ready, with optional timeout
+     *
+     * This method blocks until initialization is complete or the timeout is reached.
+     * If initialization is already complete, resolves immediately.
+     * If initialization hasn't started, this method will start it.
+     *
+     * @param timeoutMs - Maximum time to wait in milliseconds (default: 30000)
+     * @throws ProofError if timeout is reached before ready
+     * @throws ProofError if initialization fails
+     */
+    waitUntilReady(timeoutMs?: number): Promise<void>;
+    /**
+     * Internal initialization logic
+     */
+    private _doInitialize;
     /**
      * Generate a Funding Proof using Noir circuits
      *

package/dist/proofs/halo2.d.mts

@@ -0,0 +1,151 @@
+import { b as ComposableProofProvider, g as ProofGenerationRequest, h as ProofGenerationResult } from '../interface-Bf7w1PLW.mjs';
+import { ProofSystem, ProofProviderCapabilities, ProofProviderStatus, SingleProof } from '@sip-protocol/types';
+export { ProofMetadata, ProofProviderCapabilities, ProofProviderStatus, ProofSystem, SingleProof } from '@sip-protocol/types';
+
+/**
+ * Halo2 Proof Provider
+ *
+ * Implements ComposableProofProvider interface for Halo2 proof system.
+ * Halo2 is used by Zcash for Orchard shielded transactions and provides
+ * recursive proof composition capabilities.
+ *
+ * This provider supports:
+ * - PLONK-based proving system (PLONKish arithmetization)
+ * - Recursive proof composition (IPA-based)
+ * - Batch verification for efficiency
+ *
+ * @see https://zcash.github.io/halo2/ for Halo2 documentation
+ * @packageDocumentation
+ */
+
+/**
+ * Halo2 proving key parameters
+ */
+interface Halo2ProvingKey {
+    /** Circuit identifier */
+    circuitId: string;
+    /** Parameters K (circuit size) */
+    k: number;
+    /** Proving key bytes (lazy-loaded) */
+    pkBytes?: Uint8Array;
+    /** Verifying key bytes */
+    vkBytes?: Uint8Array;
+}
+/**
+ * Halo2 circuit configuration
+ */
+interface Halo2CircuitConfig {
+    /** Circuit identifier */
+    id: string;
+    /** Circuit name */
+    name: string;
+    /** K parameter (determines circuit size: 2^k rows) */
+    k: number;
+    /** Number of columns */
+    numColumns: number;
+    /** Number of public inputs */
+    numPublicInputs: number;
+    /** Whether circuit supports recursion */
+    supportsRecursion: boolean;
+}
+/**
+ * Halo2 provider configuration
+ */
+interface Halo2ProviderConfig {
+    /**
+     * Path to compiled circuit artifacts
+     */
+    artifactsPath?: string;
+    /**
+     * Pre-configured circuits
+     */
+    circuits?: Halo2CircuitConfig[];
+    /**
+     * Enable verbose logging
+     * @default false
+     */
+    verbose?: boolean;
+    /**
+     * Number of threads for parallel proving
+     * @default 4
+     */
+    numThreads?: number;
+    /**
+     * Enable recursive proving capabilities
+     * @default false
+     */
+    enableRecursion?: boolean;
+    /**
+     * Backend implementation
+     * @default 'wasm'
+     */
+    backend?: 'wasm' | 'native';
+}
+/**
+ * Halo2 Proof Provider
+ *
+ * Implements ComposableProofProvider for Halo2 proof system.
+ *
+ * @example
+ * ```typescript
+ * const provider = new Halo2Provider({
+ *   enableRecursion: true,
+ *   numThreads: 8,
+ * })
+ *
+ * await provider.initialize()
+ *
+ * const result = await provider.generateProof({
+ *   circuitId: 'orchard_spend',
+ *   privateInputs: { note: '...', nullifier: '...' },
+ *   publicInputs: { commitment: '...' },
+ * })
+ * ```
+ */
+declare class Halo2Provider implements ComposableProofProvider {
+    readonly system: ProofSystem;
+    private _config;
+    private _status;
+    private _capabilities;
+    private _metrics;
+    private _circuits;
+    private _provingKeys;
+    private _initPromise;
+    private _initError;
+    constructor(config?: Halo2ProviderConfig);
+    get capabilities(): ProofProviderCapabilities;
+    get status(): ProofProviderStatus;
+    initialize(): Promise<void>;
+    private doInitialize;
+    waitUntilReady(timeoutMs?: number): Promise<void>;
+    dispose(): Promise<void>;
+    getAvailableCircuits(): string[];
+    hasCircuit(circuitId: string): boolean;
+    /**
+     * Register a circuit configuration
+     */
+    registerCircuit(config: Halo2CircuitConfig): void;
+    /**
+     * Load proving/verifying keys for a circuit
+     */
+    loadCircuitKeys(circuitId: string): Promise<void>;
+    generateProof(request: ProofGenerationRequest): Promise<ProofGenerationResult>;
+    private generateMockProof;
+    verifyProof(proof: SingleProof): Promise<boolean>;
+    verifyBatch(proofs: SingleProof[]): Promise<boolean[]>;
+    private validateProofFormat;
+    private simulateAsyncLoad;
+    private loadCircuitArtifacts;
+    private delay;
+    private generateProviderId;
+}
+/**
+ * Create a Halo2 provider with standard configuration
+ */
+declare function createHalo2Provider(config?: Halo2ProviderConfig): Halo2Provider;
+/**
+ * Create a Halo2 provider configured for Zcash Orchard circuits
+ */
+declare function createOrchardProvider(): Halo2Provider;
+
+export { ComposableProofProvider, type Halo2CircuitConfig, Halo2Provider, type Halo2ProviderConfig, type Halo2ProvingKey, createHalo2Provider, createOrchardProvider };

package/dist/proofs/halo2.d.ts

@@ -0,0 +1,151 @@
+import { b as ComposableProofProvider, g as ProofGenerationRequest, h as ProofGenerationResult } from '../interface-Bf7w1PLW.js';
+import { ProofSystem, ProofProviderCapabilities, ProofProviderStatus, SingleProof } from '@sip-protocol/types';
+export { ProofMetadata, ProofProviderCapabilities, ProofProviderStatus, ProofSystem, SingleProof } from '@sip-protocol/types';
+
+/**
+ * Halo2 Proof Provider
+ *
+ * Implements ComposableProofProvider interface for Halo2 proof system.
+ * Halo2 is used by Zcash for Orchard shielded transactions and provides
+ * recursive proof composition capabilities.
+ *
+ * This provider supports:
+ * - PLONK-based proving system (PLONKish arithmetization)
+ * - Recursive proof composition (IPA-based)
+ * - Batch verification for efficiency
+ *
+ * @see https://zcash.github.io/halo2/ for Halo2 documentation
+ * @packageDocumentation
+ */
+
+/**
+ * Halo2 proving key parameters
+ */
+interface Halo2ProvingKey {
+    /** Circuit identifier */
+    circuitId: string;
+    /** Parameters K (circuit size) */
+    k: number;
+    /** Proving key bytes (lazy-loaded) */
+    pkBytes?: Uint8Array;
+    /** Verifying key bytes */
+    vkBytes?: Uint8Array;
+}
+/**
+ * Halo2 circuit configuration
+ */
+interface Halo2CircuitConfig {
+    /** Circuit identifier */
+    id: string;
+    /** Circuit name */
+    name: string;
+    /** K parameter (determines circuit size: 2^k rows) */
+    k: number;
+    /** Number of columns */
+    numColumns: number;
+    /** Number of public inputs */
+    numPublicInputs: number;
+    /** Whether circuit supports recursion */
+    supportsRecursion: boolean;
+}
+/**
+ * Halo2 provider configuration
+ */
+interface Halo2ProviderConfig {
+    /**
+     * Path to compiled circuit artifacts
+     */
+    artifactsPath?: string;
+    /**
+     * Pre-configured circuits
+     */
+    circuits?: Halo2CircuitConfig[];
+    /**
+     * Enable verbose logging
+     * @default false
+     */
+    verbose?: boolean;
+    /**
+     * Number of threads for parallel proving
+     * @default 4
+     */
+    numThreads?: number;
+    /**
+     * Enable recursive proving capabilities
+     * @default false
+     */
+    enableRecursion?: boolean;
+    /**
+     * Backend implementation
+     * @default 'wasm'
+     */
+    backend?: 'wasm' | 'native';
+}
+/**
+ * Halo2 Proof Provider
+ *
+ * Implements ComposableProofProvider for Halo2 proof system.
+ *
+ * @example
+ * ```typescript
+ * const provider = new Halo2Provider({
+ *   enableRecursion: true,
+ *   numThreads: 8,
+ * })
+ *
+ * await provider.initialize()
+ *
+ * const result = await provider.generateProof({
+ *   circuitId: 'orchard_spend',
+ *   privateInputs: { note: '...', nullifier: '...' },
+ *   publicInputs: { commitment: '...' },
+ * })
+ * ```
+ */
+declare class Halo2Provider implements ComposableProofProvider {
+    readonly system: ProofSystem;
+    private _config;
+    private _status;
+    private _capabilities;
+    private _metrics;
+    private _circuits;
+    private _provingKeys;
+    private _initPromise;
+    private _initError;
+    constructor(config?: Halo2ProviderConfig);
+    get capabilities(): ProofProviderCapabilities;
+    get status(): ProofProviderStatus;
+    initialize(): Promise<void>;
+    private doInitialize;
+    waitUntilReady(timeoutMs?: number): Promise<void>;
+    dispose(): Promise<void>;
+    getAvailableCircuits(): string[];
+    hasCircuit(circuitId: string): boolean;
+    /**
+     * Register a circuit configuration
+     */
+    registerCircuit(config: Halo2CircuitConfig): void;
+    /**
+     * Load proving/verifying keys for a circuit
+     */
+    loadCircuitKeys(circuitId: string): Promise<void>;
+    generateProof(request: ProofGenerationRequest): Promise<ProofGenerationResult>;
+    private generateMockProof;
+    verifyProof(proof: SingleProof): Promise<boolean>;
+    verifyBatch(proofs: SingleProof[]): Promise<boolean[]>;
+    private validateProofFormat;
+    private simulateAsyncLoad;
+    private loadCircuitArtifacts;
+    private delay;
+    private generateProviderId;
+}
+/**
+ * Create a Halo2 provider with standard configuration
+ */
+declare function createHalo2Provider(config?: Halo2ProviderConfig): Halo2Provider;
+/**
+ * Create a Halo2 provider configured for Zcash Orchard circuits
+ */
+declare function createOrchardProvider(): Halo2Provider;
+
+export { ComposableProofProvider, type Halo2CircuitConfig, Halo2Provider, type Halo2ProviderConfig, type Halo2ProvingKey, createHalo2Provider, createOrchardProvider };