ProofComposer

SIP Protocol API Reference v0.7.4

---

SIP Protocol API Reference / ProofComposer

Interface: ProofComposer

Defined in: @sip-protocol/sdk/dist/interface-Bf7w1PLW.d.ts:447

Main interface for the proof composition system.

ProofComposer orchestrates the composition of proofs from multiple proof systems, handling:

• Provider registration and management
• Proof generation across systems
• Proof composition and aggregation
• Verification of composed proofs
• Caching and optimization

Example

const composer = new ProofComposer(config)

// Register providers
await composer.registerProvider(noirProvider)
await composer.registerProvider(halo2Provider)

// Generate proofs
const proof1 = await composer.generateProof({
  circuitId: 'funding_proof',
  privateInputs: { balance: 1000n },
  publicInputs: { minRequired: 100n },
})

const proof2 = await composer.generateProof({
  circuitId: 'validity_proof',
  privateInputs: { sender: '0x...' },
  publicInputs: { intentHash: '0x...' },
})

// Compose proofs
const result = await composer.compose({
  proofs: [proof1.proof!, proof2.proof!],
  strategy: ProofAggregationStrategy.PARALLEL,
})

// Verify composed proof
const verification = await composer.verify({
  composedProof: result.composedProof!,
})

Properties

config

readonly config: ProofCompositionConfig

Defined in: @sip-protocol/sdk/dist/interface-Bf7w1PLW.d.ts:451

Current configuration

Methods

updateConfig()

updateConfig(config): void

Defined in: @sip-protocol/sdk/dist/interface-Bf7w1PLW.d.ts:457

Update configuration.

Parameters

config

Partial<ProofCompositionConfig>

Partial configuration to merge

Returns

void

---

registerProvider()

registerProvider(provider, options?): Promise<ProofProviderRegistration>

Defined in: @sip-protocol/sdk/dist/interface-Bf7w1PLW.d.ts:465

Register a proof provider.

Parameters

provider

ComposableProofProvider

The provider to register

options?

RegisterProviderOptions

Registration options

Returns

Promise<ProofProviderRegistration>

Registration entry

---

unregisterProvider()

unregisterProvider(providerId): boolean

Defined in: @sip-protocol/sdk/dist/interface-Bf7w1PLW.d.ts:472

Unregister a provider.

Parameters

providerId

string

Provider ID to unregister

Returns

boolean

true if provider was removed

---

getProvider()

getProvider(providerId): ComposableProofProvider | undefined

Defined in: @sip-protocol/sdk/dist/interface-Bf7w1PLW.d.ts:479

Get a registered provider by ID.

Parameters

providerId

string

Provider ID

Returns

ComposableProofProvider | undefined

Provider or undefined

---

getProviderForSystem()

getProviderForSystem(system): ComposableProofProvider | undefined

Defined in: @sip-protocol/sdk/dist/interface-Bf7w1PLW.d.ts:486

Get provider for a specific proof system.

Parameters

system

ProofSystem

Proof system

Returns

ComposableProofProvider | undefined

Provider or undefined

---

getProviders()

getProviders(): ProofProviderRegistration[]

Defined in: @sip-protocol/sdk/dist/interface-Bf7w1PLW.d.ts:492

Get all registered providers.

Returns

ProofProviderRegistration[]

Array of provider registrations

---

getAvailableSystems()

getAvailableSystems(): ProofSystem[]

Defined in: @sip-protocol/sdk/dist/interface-Bf7w1PLW.d.ts:498

Get available proof systems.

Returns

ProofSystem[]

Array of available systems

---

generateProof()

generateProof(request): Promise<ProofGenerationResult>

Defined in: @sip-protocol/sdk/dist/interface-Bf7w1PLW.d.ts:505

Generate a proof using the appropriate provider.

Parameters

request

ProofGenerationRequest

Proof generation request

Returns

Promise<ProofGenerationResult>

Generation result

---

generateProofs()

generateProofs(requests): Promise<ProofGenerationResult[]>

Defined in: @sip-protocol/sdk/dist/interface-Bf7w1PLW.d.ts:512

Generate multiple proofs in parallel.

Parameters

requests

ProofGenerationRequest[]

Array of proof requests

Returns

Promise<ProofGenerationResult[]>

Array of generation results

---

compose()

compose(options): Promise<CompositionResult>

Defined in: @sip-protocol/sdk/dist/interface-Bf7w1PLW.d.ts:519

Compose multiple proofs into a single composed proof.

Parameters

options

ComposeProofsOptions

Composition options

Returns

Promise<CompositionResult>

Composition result

---

aggregate()

aggregate(options): Promise<AggregationResult>

Defined in: @sip-protocol/sdk/dist/interface-Bf7w1PLW.d.ts:526

Aggregate proofs into a single proof (if supported).

Parameters

options

AggregateProofsOptions

Aggregation options

Returns

Promise<AggregationResult>

Aggregation result

---

verify()

verify(options): Promise<ProofVerificationResult>

Defined in: @sip-protocol/sdk/dist/interface-Bf7w1PLW.d.ts:533

Verify a composed proof.

Parameters

options

VerifyComposedProofOptions

Verification options

Returns

Promise<ProofVerificationResult>

Verification result

---

verifySingle()

verifySingle(proof): Promise<boolean>

Defined in: @sip-protocol/sdk/dist/interface-Bf7w1PLW.d.ts:540

Verify a single proof.

Parameters

proof

SingleProof

Proof to verify

Returns

Promise<boolean>

true if valid

---

convert()

convert(options): Promise<ConversionResult>

Defined in: @sip-protocol/sdk/dist/interface-Bf7w1PLW.d.ts:547

Convert a proof to a different format.

Parameters

options

ConvertProofOptions

Conversion options

Returns

Promise<ConversionResult>

Conversion result

---

getCompatibilityMatrix()

getCompatibilityMatrix(): CompatibilityMatrix

Defined in: @sip-protocol/sdk/dist/interface-Bf7w1PLW.d.ts:553

Get the compatibility matrix for proof systems.

Returns

CompatibilityMatrix

Compatibility matrix

---

areSystemsCompatible()

areSystemsCompatible(source, target): boolean

Defined in: @sip-protocol/sdk/dist/interface-Bf7w1PLW.d.ts:561

Check if two systems are compatible for composition.

Parameters

source

ProofSystem

Source system

target

ProofSystem

Target system

Returns

boolean

true if compatible

---

getCacheStats()

getCacheStats(): CacheStats

Defined in: @sip-protocol/sdk/dist/interface-Bf7w1PLW.d.ts:567

Get cache statistics.

Returns

CacheStats

Cache stats

---

clearCache()

clearCache(olderThan?): void

Defined in: @sip-protocol/sdk/dist/interface-Bf7w1PLW.d.ts:573

Clear the proof cache.

Parameters

olderThan?

number

Optional: only clear entries older than this timestamp

Returns

void

---

getWorkerPoolStatus()

getWorkerPoolStatus(): WorkerPoolStatus

Defined in: @sip-protocol/sdk/dist/interface-Bf7w1PLW.d.ts:579

Get worker pool status.

Returns

WorkerPoolStatus

Worker pool status

---

scaleWorkerPool()

scaleWorkerPool(targetWorkers): Promise<void>

Defined in: @sip-protocol/sdk/dist/interface-Bf7w1PLW.d.ts:585

Scale worker pool.

Parameters

targetWorkers

number

Target number of workers

Returns

Promise<void>

---

setFallbackConfig()

setFallbackConfig(config): void

Defined in: @sip-protocol/sdk/dist/interface-Bf7w1PLW.d.ts:591

Set fallback configuration.

Parameters

config

FallbackConfig

Fallback configuration

Returns

void

---

getFallbackConfig()

getFallbackConfig(): FallbackConfig | undefined

Defined in: @sip-protocol/sdk/dist/interface-Bf7w1PLW.d.ts:597

Get current fallback configuration.

Returns

FallbackConfig | undefined

Fallback config or undefined

---

addEventListener()

addEventListener(listener): () => void

Defined in: @sip-protocol/sdk/dist/interface-Bf7w1PLW.d.ts:604

Add an event listener.

Parameters

listener

CompositionEventListener

Event listener

Returns

Unsubscribe function

(): void

Returns

void

---

removeEventListener()

removeEventListener(listener): void

Defined in: @sip-protocol/sdk/dist/interface-Bf7w1PLW.d.ts:610

Remove an event listener.

Parameters

listener

CompositionEventListener

Listener to remove

Returns

void

---

setTelemetryCollector()

setTelemetryCollector(collector): void

Defined in: @sip-protocol/sdk/dist/interface-Bf7w1PLW.d.ts:616

Set telemetry collector.

Parameters

collector

TelemetryCollector

Telemetry collector

Returns

void

---

initialize()

initialize(): Promise<void>

Defined in: @sip-protocol/sdk/dist/interface-Bf7w1PLW.d.ts:620

Initialize the composer and all providers.

Returns

Promise<void>

---

dispose()

dispose(): Promise<void>

Defined in: @sip-protocol/sdk/dist/interface-Bf7w1PLW.d.ts:624

Dispose of resources.

Returns

Promise<void>