ComplianceProofProvider

SIP Protocol API Reference / ComplianceProofProvider

Class: ComplianceProofProvider

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

Compliance Proof Provider

Generates ZK proofs for regulatory compliance without revealing sensitive data.

Example

const provider = new ComplianceProofProvider()
await provider.initialize()

// Prove viewing key access to auditor
const result = await provider.generateViewingKeyAccessProof({
  viewingKey: myViewingKey,
  transactionHash: '0x...',
  encryptedData: encryptedTxData,
  auditorPublicKey: '0x...',
  timestamp: Date.now(),
})

// Share proof with auditor (they can verify without seeing data)
await sendToAuditor(result.proof)

Constructors

Constructor

new ComplianceProofProvider(config?): ComplianceProofProvider

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

Parameters

config?

ComplianceProofConfig

Returns

ComplianceProofProvider

Accessors

isReady

Get Signature

get isReady(): boolean

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

Check if provider is initialized

Returns

boolean

Methods

initialize()

initialize(): Promise<void>

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

Initialize the compliance proof provider

Returns

Promise<void>

generateViewingKeyAccessProof()

generateViewingKeyAccessProof(params): Promise<ComplianceProofResult>

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

Generate a viewing key access proof

Proves to an auditor that the holder of a viewing key can decrypt a specific transaction without revealing the decrypted contents.

Parameters

params

ViewingKeyAccessParams

Viewing key access parameters

Returns

Promise<ComplianceProofResult>

Compliance proof result

generateSanctionsClearProof()

generateSanctionsClearProof(params): Promise<ComplianceProofResult>

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

Generate a sanctions clearance proof

Proves that sender and recipient are not on any sanctions lists without revealing their actual addresses.

Parameters

params

SanctionsClearParams

Sanctions clearance parameters

Returns

Promise<ComplianceProofResult>

Compliance proof result

generateBalanceAttestationProof()

generateBalanceAttestationProof(params): Promise<ComplianceProofResult>

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

Generate a balance attestation proof

Proves that an account has at least a certain balance without revealing the exact balance.

Parameters

params

BalanceAttestationParams

Balance attestation parameters

Returns

Promise<ComplianceProofResult>

Compliance proof result

generateHistoryCompletenessProof()

generateHistoryCompletenessProof(params): Promise<ComplianceProofResult>

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

Generate a history completeness proof

Proves that all transactions in a time range have been disclosed without revealing individual transaction amounts.

Parameters

params

HistoryCompletenessParams

History completeness parameters

Returns

Promise<ComplianceProofResult>

Compliance proof result

verifyComplianceProof()

verifyComplianceProof(result): Promise<boolean>

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

Verify a compliance proof

Parameters

result

ComplianceProofResult

Compliance proof result to verify

Returns

Promise<boolean>

true if valid, false otherwise

Remarks

IMPORTANT: Mock Implementation

This verification performs structural validation only:

Checks proof expiry
Validates proof format and size
Verifies public inputs exist
Checks proof type matches compliance type

It does NOT perform cryptographic verification of the ZK proof. For production use, integrate with SolanaNoirVerifier.verifyOffChain() or deploy a dedicated compliance circuit verifier.

Example

// For production cryptographic verification:
const solanaVerifier = new SolanaNoirVerifier()
await solanaVerifier.initialize()
const cryptoValid = await solanaVerifier.verifyOffChain(result.proof)
const formatValid = await complianceProvider.verifyComplianceProof(result)
const isValid = cryptoValid && formatValid

destroy()

destroy(): Promise<void>

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

Destroy the provider and free resources

Returns

Promise<void>