ProofAggregator
SIP Protocol API Reference v0.7.4
SIP Protocol API Reference / ProofAggregator
Class: ProofAggregator
Section titled “Class: ProofAggregator”Defined in: @sip-protocol/sdk/dist/index-DXh2IGkz.d.ts:1396
Proof Aggregator
Implements aggregation logic for combining multiple ZK proofs.
Example
Section titled “Example”const aggregator = new ProofAggregator()
// Sequential aggregationconst result = await aggregator.aggregateSequential({ proofs: [proof1, proof2, proof3], getProvider: (system) => composer.getProviderForSystem(system), verifyBefore: true,})
// Parallel aggregationconst parallelResult = await aggregator.aggregateParallel({ proofs: [proofA, proofB, proofC], getProvider: (system) => composer.getProviderForSystem(system), maxConcurrent: 3, verifyBefore: true,})
// Recursive aggregationconst recursiveResult = await aggregator.aggregateRecursive({ proofs: proofs, getProvider: (system) => composer.getProviderForSystem(system), targetSystem: 'kimchi', maxDepth: 5,})Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new ProofAggregator(
config?):ProofAggregator
Defined in: @sip-protocol/sdk/dist/index-DXh2IGkz.d.ts:1399
Parameters
Section titled “Parameters”config?
Section titled “config?”Partial<AggregatorConfig>
Returns
Section titled “Returns”ProofAggregator
Accessors
Section titled “Accessors”config
Section titled “config”Get Signature
Section titled “Get Signature”get config():
AggregatorConfig
Defined in: @sip-protocol/sdk/dist/index-DXh2IGkz.d.ts:1400
Returns
Section titled “Returns”Methods
Section titled “Methods”updateConfig()
Section titled “updateConfig()”updateConfig(
config):void
Defined in: @sip-protocol/sdk/dist/index-DXh2IGkz.d.ts:1401
Parameters
Section titled “Parameters”config
Section titled “config”Partial<AggregatorConfig>
Returns
Section titled “Returns”void
aggregateSequential()
Section titled “aggregateSequential()”aggregateSequential(
options):Promise<DetailedAggregationResult>
Defined in: @sip-protocol/sdk/dist/index-DXh2IGkz.d.ts:1408
Aggregate proofs sequentially.
Each proof is processed in order, with optional linking between consecutive proofs.
Parameters
Section titled “Parameters”options
Section titled “options”Returns
Section titled “Returns”Promise<DetailedAggregationResult>
aggregateParallel()
Section titled “aggregateParallel()”aggregateParallel(
options):Promise<DetailedAggregationResult>
Defined in: @sip-protocol/sdk/dist/index-DXh2IGkz.d.ts:1414
Aggregate proofs in parallel.
All proofs are processed concurrently, limited by maxConcurrent.
Parameters
Section titled “Parameters”options
Section titled “options”Returns
Section titled “Returns”Promise<DetailedAggregationResult>
aggregateRecursive()
Section titled “aggregateRecursive()”aggregateRecursive(
options):Promise<DetailedAggregationResult>
Defined in: @sip-protocol/sdk/dist/index-DXh2IGkz.d.ts:1421
Aggregate proofs recursively.
Combines proofs using recursive SNARKs (proof-of-proofs). This enables constant-size proofs regardless of input count.
Parameters
Section titled “Parameters”options
Section titled “options”Returns
Section titled “Returns”Promise<DetailedAggregationResult>
aggregateBatch()
Section titled “aggregateBatch()”aggregateBatch(
proofs,getProvider,onProgress?):Promise<DetailedAggregationResult>
Defined in: @sip-protocol/sdk/dist/index-DXh2IGkz.d.ts:1428
Aggregate proofs using batch verification.
Groups proofs by system and uses batch verification where supported.
Parameters
Section titled “Parameters”proofs
Section titled “proofs”getProvider
Section titled “getProvider”(system) => ComposableProofProvider | undefined
onProgress?
Section titled “onProgress?”Returns
Section titled “Returns”Promise<DetailedAggregationResult>
createCrossSystemLink()
Section titled “createCrossSystemLink()”createCrossSystemLink(
sourceProof,targetProof):`0x${string}`
Defined in: @sip-protocol/sdk/dist/index-DXh2IGkz.d.ts:1434
Link proofs from different systems.
Creates a cryptographic link between proofs from different ZK systems.
Parameters
Section titled “Parameters”sourceProof
Section titled “sourceProof”targetProof
Section titled “targetProof”Returns
Section titled “Returns”`0x${string}`
verifyCrossSystemLink()
Section titled “verifyCrossSystemLink()”verifyCrossSystemLink(
sourceProof,targetProof,linkHash):boolean
Defined in: @sip-protocol/sdk/dist/index-DXh2IGkz.d.ts:1438
Verify a cross-system link.
Parameters
Section titled “Parameters”sourceProof
Section titled “sourceProof”targetProof
Section titled “targetProof”linkHash
Section titled “linkHash”`0x${string}`
Returns
Section titled “Returns”boolean
addEventListener()
Section titled “addEventListener()”addEventListener(
listener): () =>void
Defined in: @sip-protocol/sdk/dist/index-DXh2IGkz.d.ts:1442
Parameters
Section titled “Parameters”listener
Section titled “listener”Returns
Section titled “Returns”():
void
Returns
Section titled “Returns”void
removeEventListener()
Section titled “removeEventListener()”removeEventListener(
listener):void
Defined in: @sip-protocol/sdk/dist/index-DXh2IGkz.d.ts:1443
Parameters
Section titled “Parameters”listener
Section titled “listener”Returns
Section titled “Returns”void