ProofProvider

SIP Protocol API Reference / ProofProvider

Interface: ProofProvider

Defined in: @sip-protocol/sdk/dist/noir-CwPIyBLj.d.ts:149

Proof Provider Interface

Implementations of this interface provide ZK proof generation and verification. The SDK uses this interface to remain agnostic to the underlying ZK framework.

Example

// Use mock provider for testing
const mockProvider = new MockProofProvider()

// Use Noir provider for production
const noirProvider = new NoirProofProvider()

// Configure SIP client with provider
const sip = new SIP({
  network: 'testnet',
  proofProvider: noirProvider,
})

Properties

framework

readonly framework: ProofFramework

Defined in: @sip-protocol/sdk/dist/noir-CwPIyBLj.d.ts:153

The ZK framework this provider uses

isReady

readonly isReady: boolean

Defined in: @sip-protocol/sdk/dist/noir-CwPIyBLj.d.ts:158

Whether the provider is ready to generate proofs (e.g., circuits compiled, keys loaded)

Methods

initialize()

initialize(): Promise<void>

Defined in: @sip-protocol/sdk/dist/noir-CwPIyBLj.d.ts:164

Initialize the provider (compile circuits, load keys, etc.)

Returns

Promise<void>

Throws

Error if initialization fails

waitUntilReady()

waitUntilReady(timeoutMs?): Promise<void>

Defined in: @sip-protocol/sdk/dist/noir-CwPIyBLj.d.ts:176

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.

Parameters

timeoutMs?

number

Maximum time to wait in milliseconds (default: 30000)

Returns

Promise<void>

Throws

ProofError if timeout is reached before ready

Throws

ProofError if initialization fails

generateFundingProof()

generateFundingProof(params): Promise<ProofResult>

Defined in: @sip-protocol/sdk/dist/noir-CwPIyBLj.d.ts:188

Generate a Funding Proof

Proves that the user has sufficient balance without revealing the exact amount.

Parameters

params

FundingProofParams

Funding proof parameters

Returns

Promise<ProofResult>

The generated proof with public inputs

Throws

ProofGenerationError if proof generation fails

See

docs/specs/FUNDING-PROOF.md (~22,000 constraints)

generateValidityProof()

generateValidityProof(params): Promise<ProofResult>

Defined in: @sip-protocol/sdk/dist/noir-CwPIyBLj.d.ts:200

Generate a Validity Proof

Proves that the intent is authorized without revealing the sender.

Parameters

params

ValidityProofParams

Validity proof parameters

Returns

Promise<ProofResult>

The generated proof with public inputs

Throws

ProofGenerationError if proof generation fails

See

docs/specs/VALIDITY-PROOF.md (~72,000 constraints)

generateFulfillmentProof()

generateFulfillmentProof(params): Promise<ProofResult>

Defined in: @sip-protocol/sdk/dist/noir-CwPIyBLj.d.ts:212

Generate a Fulfillment Proof

Proves that the solver correctly delivered the output.

Parameters

params

FulfillmentProofParams

Fulfillment proof parameters

Returns

Promise<ProofResult>

The generated proof with public inputs

Throws

ProofGenerationError if proof generation fails

See

docs/specs/FULFILLMENT-PROOF.md (~22,000 constraints)

verifyProof()

verifyProof(proof): Promise<boolean>

Defined in: @sip-protocol/sdk/dist/noir-CwPIyBLj.d.ts:219

Verify a proof

Parameters

proof

ZKProof

The proof to verify

Returns

Promise<boolean>

true if the proof is valid, false otherwise