ProofConverter<TNative>

SIP Protocol API Reference / ProofConverter

Interface: ProofConverter<TNative>

Defined in: @sip-protocol/sdk/dist/index-DXh2IGkz.d.ts:2360

Interface for proof format converters

Converters transform proofs between native formats and the unified SIP format. All converters should:

Be pure functions (no side effects)
Preserve proof validity
Handle version differences gracefully
Provide detailed error information

Example

const converter = new NoirProofConverter()

// Convert Noir proof to SIP format
const result = converter.toSIP(noirProof, {
  preserveNativeMetadata: true,
})

if (result.success) {
  const sipProof = result.result!
  console.log('Converted proof:', sipProof.id)
}

Type Parameters

TNative

TNative extends NativeProofFormat

Properties

system

readonly system: ProofSystem

Defined in: @sip-protocol/sdk/dist/index-DXh2IGkz.d.ts:2362

The proof system this converter handles

version

readonly version: string

Defined in: @sip-protocol/sdk/dist/index-DXh2IGkz.d.ts:2364

Converter version for tracking

Methods

toSIP()

toSIP(nativeProof, options?): ConversionResult<SingleProof>

Defined in: @sip-protocol/sdk/dist/index-DXh2IGkz.d.ts:2372

Convert from native format to SIP unified format

Parameters

nativeProof

TNative

The native proof to convert

options?

ConversionOptions

Conversion options

Returns

ConversionResult<SingleProof>

Conversion result with SIP proof

fromSIP()

fromSIP(sipProof, options?): ConversionResult<TNative>

Defined in: @sip-protocol/sdk/dist/index-DXh2IGkz.d.ts:2380

Convert from SIP unified format to native format

Parameters

sipProof

SingleProof

The SIP proof to convert

options?

ConversionOptions

Conversion options

Returns

ConversionResult<TNative>

Conversion result with native proof

validateNative()

validateNative(nativeProof): ConverterValidationResult

Defined in: @sip-protocol/sdk/dist/index-DXh2IGkz.d.ts:2387

Validate a native proof structure without converting

Parameters

nativeProof

TNative

The native proof to validate

Returns

ConverterValidationResult

Validation result

canConvertFromSIP()

canConvertFromSIP(sipProof): boolean

Defined in: @sip-protocol/sdk/dist/index-DXh2IGkz.d.ts:2394

Check if a SIP proof can be converted to this native format

Parameters

sipProof

SingleProof

The SIP proof to check

Returns

boolean

Whether conversion is possible

getSupportedVersions()

getSupportedVersions(): string[]

Defined in: @sip-protocol/sdk/dist/index-DXh2IGkz.d.ts:2400

Get supported versions for this converter

Returns

string[]

List of supported system versions