ComposableProofProvider

SIP Protocol API Reference v0.7.4

---

SIP Protocol API Reference / ComposableProofProvider

Interface: ComposableProofProvider

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

Abstract interface for proof providers that can participate in composition.

Implementations of this interface provide proof generation and verification for a specific proof system (Noir, Halo2, Kimchi, etc.).

Example

class Halo2Provider implements ComposableProofProvider {
  readonly system = 'halo2'

  async initialize() {
    // Load WASM, setup keys, etc.
  }

  async generateProof(request) {
    // Generate Halo2 proof
  }

  async verifyProof(proof) {
    // Verify Halo2 proof
  }
}

Properties

system

readonly system: ProofSystem

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

The proof system this provider implements

---

capabilities

readonly capabilities: ProofProviderCapabilities

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

Provider capabilities

---

status

readonly status: ProofProviderStatus

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

Current provider status

Methods

initialize()

initialize(): Promise<void>

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

Initialize the provider. Must be called before generating or verifying proofs.

Returns

Promise<void>

Throws

Error if initialization fails

---

waitUntilReady()

waitUntilReady(timeoutMs?): Promise<void>

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

Wait for provider to be ready with optional timeout.

Parameters

timeoutMs?

number

Maximum wait time in milliseconds (default: 30000)

Returns

Promise<void>

Throws

Error if timeout reached or initialization fails

---

generateProof()

generateProof(request): Promise<ProofGenerationResult>

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

Generate a proof for the given request.

Parameters

request

ProofGenerationRequest

Proof generation request

Returns

Promise<ProofGenerationResult>

Generation result with proof or error

---

verifyProof()

verifyProof(proof): Promise<boolean>

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

Verify a single proof.

Parameters

proof

SingleProof

The proof to verify

Returns

Promise<boolean>

true if valid, false otherwise

---

verifyBatch()?

optional verifyBatch(proofs): Promise<boolean[]>

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

Verify multiple proofs in a batch (if supported).

Parameters

proofs

SingleProof[]

Proofs to verify

Returns

Promise<boolean[]>

Array of verification results

---

getAvailableCircuits()

getAvailableCircuits(): string[]

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

Get available circuits for this provider.

Returns

string[]

Array of circuit identifiers

---

hasCircuit()

hasCircuit(circuitId): boolean

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

Check if a specific circuit is available.

Parameters

circuitId

string

Circuit identifier

Returns

boolean

true if circuit is available

---

dispose()

dispose(): Promise<void>

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

Dispose of resources used by this provider.

Returns

Promise<void>