@sip-protocol/sdk 0.7.2 → 0.7.4

package/src/proofs/halo2.ts

@@ -0,0 +1,42 @@
+/**
+ * Halo2 Proof Provider Entry Point
+ *
+ * @module proofs/halo2
+ * @description Separate entry point for Halo2 provider to enable tree-shaking
+ *
+ * ## Usage
+ *
+ * ```typescript
+ * import { Halo2Provider, createHalo2Provider } from '@sip-protocol/sdk/proofs/halo2'
+ *
+ * const provider = createHalo2Provider({ backend: 'pse' })
+ * await provider.initialize()
+ * ```
+ *
+ * M20-16: Add ProofComposer to SDK exports (#329)
+ */
+
+// Halo2 Provider
+export {
+  Halo2Provider,
+  createHalo2Provider,
+  createOrchardProvider,
+} from './providers'
+
+export type {
+  Halo2ProviderConfig,
+  Halo2CircuitConfig,
+  Halo2ProvingKey,
+} from './providers'
+
+// Re-export composer interface for type compatibility
+export type { ComposableProofProvider } from './composer'
+
+// Re-export proof types for convenience
+export type {
+  ProofSystem,
+  SingleProof,
+  ProofMetadata,
+  ProofProviderCapabilities,
+  ProofProviderStatus,
+} from '@sip-protocol/types'

package/src/proofs/index.ts

@@ -73,3 +73,474 @@ export {
 //
 // Types are safe to export (no runtime WASM dependency)
 export type { BrowserNoirProviderConfig, ProofProgressCallback } from './browser'
+
+// Compliance proofs (non-financial ZK use cases)
+// For Aztec/Noir bounty - "Best Non-Financial ZK Use Case"
+export { ComplianceProofProvider } from './compliance-proof'
+export {
+  DEFAULT_VALIDITY_PERIOD_SECONDS,
+  SUPPORTED_JURISDICTIONS,
+  COMPLIANCE_CIRCUIT_IDS,
+} from './compliance-proof'
+export type {
+  ComplianceProofType,
+  ComplianceProofConfig,
+  ViewingKeyAccessParams,
+  SanctionsClearParams,
+  BalanceAttestationParams,
+  HistoryCompletenessParams,
+  ComplianceProofResult,
+} from './compliance-proof'
+
+// ─── Proof Composition (M20) ────────────────────────────────────────────────
+
+// Proof Aggregator
+export {
+  ProofAggregator,
+  createProofAggregator,
+  DEFAULT_AGGREGATOR_CONFIG,
+} from './aggregator'
+
+export type {
+  AggregatorConfig,
+  AggregationProgressEvent,
+  AggregationProgressCallback,
+  SequentialAggregationOptions,
+  ParallelAggregationOptions,
+  RecursiveAggregationOptions,
+  AggregationStepResult,
+  DetailedAggregationResult,
+} from './aggregator'
+
+// Verification Pipeline
+export {
+  VerificationPipeline,
+  createVerificationPipeline,
+  DEFAULT_PIPELINE_CONFIG,
+} from './verifier'
+
+export type {
+  VerificationPipelineConfig,
+  ProofDependency,
+  VerificationOrder,
+  DetailedVerificationResult,
+  LinkValidationResult,
+  SystemVerificationStats,
+  VerificationProgressEvent,
+  VerificationProgressCallback,
+  VerifyOptions,
+} from './verifier'
+
+// Cross-System Validator
+export {
+  CrossSystemValidator,
+  createCrossSystemValidator,
+  SYSTEM_INFO,
+  BN254_MODULUS,
+  PALLAS_MODULUS,
+  VESTA_MODULUS,
+  BLS12_381_MODULUS,
+} from './validator'
+
+export type {
+  EllipticCurve,
+  FieldCharacteristics,
+  SystemInfo,
+  ValidationCheck,
+  ValidationReport,
+  CompatibilityEntry,
+  ValidationOptions,
+} from './validator'
+
+// Proof Orchestrator
+export {
+  ProofOrchestrator,
+  createProofOrchestrator,
+  DEFAULT_ORCHESTRATOR_CONFIG,
+  BUILTIN_TEMPLATES,
+} from './orchestrator'
+
+export type {
+  OrchestratorConfig,
+  CompositionState,
+  CompositionPlan,
+  CompositionRequest,
+  OrchestratorResult,
+  AuditLogEntry,
+  OrchestratorProgressEvent,
+  OrchestratorProgressCallback,
+  CompositionTemplate,
+} from './orchestrator'
+
+// ─── Fallback Strategies (M20-11) ───────────────────────────────────────────
+
+// Fallback classes and factory functions
+export {
+  SequentialFallbackStrategy,
+  ExponentialBackoffStrategy,
+  PriorityFallbackStrategy,
+  CircuitBreaker,
+  FallbackExecutor,
+  createFallbackExecutor,
+  createCircuitBreaker,
+  createMockFallbackProvider,
+  DEFAULT_CIRCUIT_BREAKER_CONFIG,
+  DEFAULT_FALLBACK_CONFIG,
+} from './fallback'
+
+// Fallback types
+export type {
+  FallbackStrategy,
+  CircuitBreakerState,
+  CircuitBreakerConfig,
+  ProviderHealth,
+  FallbackEventType,
+  FallbackEvent,
+  FallbackEventListener,
+  FallbackExecutorConfig,
+} from './fallback'
+
+// Composer interfaces and errors
+export {
+  type ComposableProofProvider,
+  type ProofComposer,
+  type ProofProviderFactory,
+  type ProofProviderRegistry,
+  ProofCompositionError,
+  ProviderNotFoundError,
+  CompositionTimeoutError,
+  IncompatibleSystemsError,
+  BaseProofComposer,
+} from './composer'
+
+// Composable Proof Providers
+export {
+  Halo2Provider,
+  createHalo2Provider,
+  createOrchardProvider,
+  KimchiProvider,
+  createKimchiProvider,
+  createMinaMainnetProvider,
+  createZkAppProvider,
+} from './providers'
+
+export type {
+  Halo2ProviderConfig,
+  Halo2CircuitConfig,
+  Halo2ProvingKey,
+  KimchiProviderConfig,
+  KimchiCircuitConfig,
+} from './providers'
+
+// ─── Proof Format Converters (M20-08) ────────────────────────────────────────
+
+// Converter classes and factory functions
+export {
+  NoirProofConverter,
+  createNoirConverter,
+  Halo2ProofConverter,
+  createHalo2Converter,
+  KimchiProofConverter,
+  createKimchiConverter,
+  UnifiedProofConverter,
+  createUnifiedConverter,
+  convertToSIP,
+  convertFromSIP,
+  ProofConversionError,
+  InvalidProofError,
+  UnsupportedVersionError,
+  DEFAULT_CONVERSION_OPTIONS,
+} from './converters'
+
+// Converter types
+export type {
+  NativeProofFormat,
+  NoirNativeProof,
+  Halo2NativeProof,
+  KimchiNativeProof,
+  ConversionOptions,
+  ConversionResult as ConverterConversionResult,
+  ConversionMetadata,
+  ConversionErrorCode,
+  ProofConverter,
+  ValidationResult,
+  ValidationError,
+  AnyNativeProof,
+  ProofSystemToNativeMap,
+} from './converters'
+
+// Composer SDK types
+export type {
+  ProofProviderRegistration,
+  RegisterProviderOptions,
+  ProofGenerationRequest,
+  ProofGenerationResult,
+  ComposeProofsOptions,
+  VerifyComposedProofOptions,
+  AggregateProofsOptions,
+  AggregationResult,
+  ConvertProofOptions,
+  ConversionResult,
+  ProofCacheEntry,
+  CacheStats,
+  WorkerPoolConfig,
+  WorkerPoolStatus,
+  SystemCompatibility,
+  CompatibilityMatrix,
+  FallbackConfig,
+  ProofTelemetry,
+  TelemetryCollector,
+  ProofTelemetryMetrics,
+} from './composer'
+
+// ─── Lazy Proof Generation (M20-14) ─────────────────────────────────────────
+
+// Lazy Proof
+export {
+  LazyProof,
+  createLazyProof,
+  DEFAULT_LAZY_CONFIG,
+} from './lazy'
+
+export type {
+  LazyProofStatus,
+  ProofTrigger,
+  ProofPriority,
+  LazyProofConfig,
+  ProofGenerator,
+  LazyProofEventType,
+  LazyProofEvent,
+  LazyProofEventListener,
+  SerializedLazyProof,
+} from './lazy'
+
+// Proof Generation Queue
+export {
+  ProofGenerationQueue,
+  createProofQueue,
+  DEFAULT_QUEUE_CONFIG,
+} from './lazy'
+
+export type {
+  ProofQueueConfig,
+  QueueStats,
+} from './lazy'
+
+// Lazy Verification Keys
+export {
+  LazyVerificationKey,
+  VerificationKeyRegistry,
+  createVKRegistry,
+} from './lazy'
+
+// Speculative Prefetching
+export {
+  SpeculativePrefetcher,
+  createPrefetcher,
+  DEFAULT_PREFETCH_CONFIG,
+} from './lazy'
+
+export type {
+  PrefetchConfig,
+} from './lazy'
+
+// Error handling
+export {
+  LazyProofError,
+} from './lazy'
+
+export type {
+  LazyProofErrorCode,
+} from './lazy'
+
+// Re-export base types from @sip-protocol/types for convenience
+export {
+  ProofAggregationStrategy,
+  ComposedProofStatus,
+  CompositionErrorCode,
+  DEFAULT_COMPOSITION_CONFIG,
+} from '@sip-protocol/types'
+
+export type {
+  ProofSystem,
+  ProofMetadata,
+  SingleProof,
+  ComposedProof,
+  CompositionMetadata,
+  VerificationHints,
+  ProofCompositionConfig,
+  ProofProviderCapabilities,
+  ProofProviderStatus,
+  ProofProviderMetrics,
+  CompositionResult,
+  CompositionError,
+  CompositionMetrics,
+  VerificationResult,
+  IndividualVerificationResult,
+  CompositionEventType,
+  CompositionEvent,
+  CompositionProgressEvent,
+  CompositionEventListener,
+} from '@sip-protocol/types'
+
+// ─── Proof Caching Layer (M20-13) ────────────────────────────────────────────
+
+// Cache implementations
+export {
+  LRUCache,
+  createLRUCache,
+  IndexedDBCache,
+  FileCache,
+  createPersistentCache,
+  createIndexedDBCache,
+  createFileCache,
+  MultiTierCache,
+  createMultiTierCache,
+} from './cache'
+
+// Cache key generator
+export {
+  CacheKeyGenerator,
+  createCacheKeyGenerator,
+  cacheKeyGenerator,
+} from './cache'
+
+// Cache configuration defaults
+export {
+  DEFAULT_LRU_CONFIG,
+  DEFAULT_PERSISTENT_CONFIG,
+  DEFAULT_MULTI_TIER_CONFIG,
+  DEFAULT_WARMING_CONFIG,
+  INITIAL_PROOF_CACHE_STATS,
+} from './cache'
+
+// Cache types
+export type {
+  // Cache Key
+  CacheKeyComponents,
+  CacheKey,
+  // Cache Entry
+  CacheEntryMetadata,
+  CacheEntry,
+  CacheLookupResult,
+  // Configuration
+  LRUCacheConfig,
+  PersistentCacheConfig,
+  MultiTierCacheConfig,
+  // Statistics
+  ProofCacheStats,
+  // Events
+  CacheEventType,
+  CacheEvent,
+  CacheEventListener,
+  // Invalidation
+  InvalidationStrategy,
+  InvalidationRule,
+  // Warming
+  CacheWarmingConfig,
+  WarmingResult,
+  // Interfaces
+  ICacheKeyGenerator,
+  IProofCache,
+  ILRUCache,
+  IPersistentCache,
+  IMultiTierCache,
+  IVerificationKeyCache,
+  ICompiledCircuitCache,
+} from './cache'
+
+// ─── Parallel Proof Generation (M20-12) ──────────────────────────────────────
+
+// Parallel Executor
+export {
+  ParallelExecutor,
+  createParallelExecutor,
+  executeParallel,
+} from './parallel'
+
+// Dependency Graph
+export {
+  DependencyAnalyzer,
+  createDependencyAnalyzer,
+  createDependencyNode,
+} from './parallel'
+
+// Worker Pool
+export {
+  WorkerPool,
+  WorkStealingScheduler,
+  createWorkerPool,
+} from './parallel'
+
+// Concurrency Management
+export {
+  ConcurrencyManager,
+  createConcurrencyManager,
+  getRecommendedConcurrency,
+} from './parallel'
+
+// Parallel configuration defaults
+export {
+  DEFAULT_WORKER_POOL_CONFIG,
+  DEFAULT_CONCURRENCY_CONFIG,
+  DEFAULT_SCHEDULER_CONFIG,
+} from './parallel'
+
+// Parallel types
+export type {
+  // Dependency Graph
+  DependencyNode,
+  DependencyEdge,
+  DependencyGraph,
+  GraphAnalysis,
+  // Worker Pool
+  WorkerStatus,
+  WorkerInfo,
+  WorkerPoolConfig as ParallelWorkerPoolConfig,
+  WorkerPoolStats,
+  // Tasks
+  TaskStatus,
+  TaskPriority,
+  ProofTask,
+  TaskSubmitOptions,
+  // Concurrency
+  SystemResources,
+  ConcurrencyConfig,
+  ConcurrencyDecision,
+  // Work Stealing
+  WorkerStealingStats,
+  WorkStealEvent,
+  // Execution
+  ParallelExecutionOptions,
+  ParallelProgressEvent,
+  ParallelExecutionResult,
+  ParallelExecutionStats,
+  ParallelExecutionError,
+  // Scheduler
+  SchedulingStrategy,
+  SchedulerConfig,
+  // Interfaces
+  IDependencyAnalyzer,
+  IWorkerPool,
+  IConcurrencyManager,
+  IWorkStealingScheduler,
+  IParallelExecutor,
+} from './parallel'
+
+// ─── Browser Proof Composition (M20-19) ──────────────────────────────────────
+
+// Browser-compatible proof composer
+// NOTE: This is designed for browser environments but can be used in Node.js
+// with the forceInitialize option. For server-side only, prefer BaseProofComposer.
+export {
+  BrowserProofComposer,
+  createBrowserComposer,
+  createAutoComposer,
+} from './browser-composer'
+
+export type {
+  BrowserProofComposerConfig,
+  BrowserComposeOptions,
+  CompositionProgress,
+  CompositionProgressCallback,
+} from './browser-composer'

package/src/proofs/interface.ts

@@ -172,6 +172,19 @@ export interface ProofProvider {
    */
   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
    *

package/src/proofs/kimchi.ts

@@ -0,0 +1,42 @@
+/**
+ * Kimchi Proof Provider Entry Point
+ *
+ * @module proofs/kimchi
+ * @description Separate entry point for Kimchi/Mina provider to enable tree-shaking
+ *
+ * ## Usage
+ *
+ * ```typescript
+ * import { KimchiProvider, createKimchiProvider } from '@sip-protocol/sdk/proofs/kimchi'
+ *
+ * const provider = createKimchiProvider({ network: 'mainnet' })
+ * await provider.initialize()
+ * ```
+ *
+ * M20-16: Add ProofComposer to SDK exports (#329)
+ */
+
+// Kimchi Provider
+export {
+  KimchiProvider,
+  createKimchiProvider,
+  createMinaMainnetProvider,
+  createZkAppProvider,
+} from './providers'
+
+export type {
+  KimchiProviderConfig,
+  KimchiCircuitConfig,
+} from './providers'
+
+// Re-export composer interface for type compatibility
+export type { ComposableProofProvider } from './composer'
+
+// Re-export proof types for convenience
+export type {
+  ProofSystem,
+  SingleProof,
+  ProofMetadata,
+  ProofProviderCapabilities,
+  ProofProviderStatus,
+} from '@sip-protocol/types'