ProofOrchestrator
SIP Protocol API Reference v0.7.4
SIP Protocol API Reference / ProofOrchestrator
Class: ProofOrchestrator
Section titled “Class: ProofOrchestrator”Defined in: @sip-protocol/sdk/dist/index-DXh2IGkz.d.ts:2064
ProofOrchestrator
High-level orchestrator for proof composition workflows.
Example
Section titled “Example”const orchestrator = new ProofOrchestrator()
// Register providersorchestrator.registerProvider(noirProvider)orchestrator.registerProvider(halo2Provider)
// Plan compositionconst plan = await orchestrator.plan({ proofs: [ { circuitId: 'funding_proof', ... }, { circuitId: 'validity_proof', ... }, ], strategy: ProofAggregationStrategy.SEQUENTIAL,})
// Execute compositionconst result = await orchestrator.execute({ proofs: [...], onProgress: (event) => console.log(event),})Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new ProofOrchestrator(
config?):ProofOrchestrator
Defined in: @sip-protocol/sdk/dist/index-DXh2IGkz.d.ts:2072
Parameters
Section titled “Parameters”config?
Section titled “config?”Partial<OrchestratorConfig>
Returns
Section titled “Returns”ProofOrchestrator
Accessors
Section titled “Accessors”config
Section titled “config”Get Signature
Section titled “Get Signature”get config():
OrchestratorConfig
Defined in: @sip-protocol/sdk/dist/index-DXh2IGkz.d.ts:2073
Returns
Section titled “Returns”Get Signature
Section titled “Get Signature”get state():
CompositionState
Defined in: @sip-protocol/sdk/dist/index-DXh2IGkz.d.ts:2074
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:2075
Parameters
Section titled “Parameters”config
Section titled “config”Partial<OrchestratorConfig>
Returns
Section titled “Returns”void
registerProvider()
Section titled “registerProvider()”registerProvider(
provider):void
Defined in: @sip-protocol/sdk/dist/index-DXh2IGkz.d.ts:2076
Parameters
Section titled “Parameters”provider
Section titled “provider”Returns
Section titled “Returns”void
unregisterProvider()
Section titled “unregisterProvider()”unregisterProvider(
system):boolean
Defined in: @sip-protocol/sdk/dist/index-DXh2IGkz.d.ts:2077
Parameters
Section titled “Parameters”system
Section titled “system”Returns
Section titled “Returns”boolean
getProvider()
Section titled “getProvider()”getProvider(
system):ComposableProofProvider|undefined
Defined in: @sip-protocol/sdk/dist/index-DXh2IGkz.d.ts:2078
Parameters
Section titled “Parameters”system
Section titled “system”Returns
Section titled “Returns”ComposableProofProvider | undefined
getAvailableSystems()
Section titled “getAvailableSystems()”getAvailableSystems():
ProofSystem[]
Defined in: @sip-protocol/sdk/dist/index-DXh2IGkz.d.ts:2079
Returns
Section titled “Returns”registerTemplate()
Section titled “registerTemplate()”registerTemplate(
template):void
Defined in: @sip-protocol/sdk/dist/index-DXh2IGkz.d.ts:2080
Parameters
Section titled “Parameters”template
Section titled “template”Returns
Section titled “Returns”void
getTemplate()
Section titled “getTemplate()”getTemplate(
id):CompositionTemplate|undefined
Defined in: @sip-protocol/sdk/dist/index-DXh2IGkz.d.ts:2081
Parameters
Section titled “Parameters”string
Returns
Section titled “Returns”CompositionTemplate | undefined
getTemplates()
Section titled “getTemplates()”getTemplates():
CompositionTemplate[]
Defined in: @sip-protocol/sdk/dist/index-DXh2IGkz.d.ts:2082
Returns
Section titled “Returns”plan()
Section titled “plan()”plan(
request):Promise<CompositionPlan>
Defined in: @sip-protocol/sdk/dist/index-DXh2IGkz.d.ts:2086
Create a composition plan without executing
Parameters
Section titled “Parameters”request
Section titled “request”Returns
Section titled “Returns”Promise<CompositionPlan>
execute()
Section titled “execute()”execute(
request,onProgress?):Promise<OrchestratorResult>
Defined in: @sip-protocol/sdk/dist/index-DXh2IGkz.d.ts:2090
Execute a composition request
Parameters
Section titled “Parameters”request
Section titled “request”onProgress?
Section titled “onProgress?”Returns
Section titled “Returns”Promise<OrchestratorResult>
cancel()
Section titled “cancel()”cancel():
void
Defined in: @sip-protocol/sdk/dist/index-DXh2IGkz.d.ts:2094
Cancel current composition
Returns
Section titled “Returns”void
getAuditLog()
Section titled “getAuditLog()”getAuditLog():
ProofAuditLogEntry[]
Defined in: @sip-protocol/sdk/dist/index-DXh2IGkz.d.ts:2110
Get full audit log
Returns
Section titled “Returns”clearAuditLog()
Section titled “clearAuditLog()”clearAuditLog():
void
Defined in: @sip-protocol/sdk/dist/index-DXh2IGkz.d.ts:2114
Clear audit log
Returns
Section titled “Returns”void