@izi-noir/sdk 0.1.0

package/dist/IProvingSystem-TKNofoo8.d.cts

@@ -0,0 +1,140 @@
+import { CompiledCircuit, InputMap } from '@noir-lang/types';
+import { P as ProofData } from './types-CaaigonG.cjs';
+
+/**
+ * Chain types for multi-chain proof formatting
+ */
+/**
+ * Supported blockchain targets for proof verification
+ */
+type ChainId = 'solana' | 'ethereum';
+/**
+ * Chain enum for IziNoir initialization.
+ * Use undefined (don't pass chain) for offchain mode.
+ */
+declare enum Chain {
+    /** Solana blockchain - uses Groth16 proofs with gnark format VK */
+    Solana = "solana",
+    /** Ethereum blockchain - uses Groth16 proofs (future support) */
+    Ethereum = "ethereum"
+}
+/**
+ * Metadata about the compiled circuit
+ */
+interface CircuitMetadata {
+    /** Number of public inputs in the circuit */
+    numPublicInputs: number;
+    /** Optional circuit name for identification */
+    circuitName?: string;
+}
+/**
+ * Base interface for chain-specific metadata
+ */
+interface ChainMetadata {
+    chainId: ChainId;
+}
+/**
+ * Solana-specific metadata for VK account sizing and rent
+ */
+interface SolanaChainMetadata extends ChainMetadata {
+    chainId: 'solana';
+    /** Size of the VK account in bytes */
+    accountSize: number;
+    /** Estimated rent-exempt balance in lamports */
+    estimatedRent: number;
+}
+/**
+ * Ethereum-specific metadata (future)
+ */
+interface EthereumChainMetadata extends ChainMetadata {
+    chainId: 'ethereum';
+    /** Estimated gas for verification */
+    estimatedGas: bigint;
+}
+/**
+ * Type helper to get chain-specific metadata
+ */
+type ChainMetadataFor<T extends ChainId> = T extends 'solana' ? SolanaChainMetadata : T extends 'ethereum' ? EthereumChainMetadata : ChainMetadata;
+
+/**
+ * Available proving system providers
+ */
+declare enum Provider {
+    /** Barretenberg backend - browser compatible, UltraHonk proofs (~16KB) */
+    Barretenberg = "barretenberg",
+    /** Arkworks WASM backend - browser compatible, Groth16 proofs (~256 bytes) */
+    Arkworks = "arkworks",
+    /** Sunspot CLI backend - Node.js only, Groth16 proofs (~256 bytes) */
+    Sunspot = "sunspot"
+}
+/**
+ * Configuration for circuit paths (required for Sunspot)
+ */
+interface CircuitPaths {
+    /** Path to the proving key file */
+    pkPath: string;
+    /** Path to the verification key file */
+    vkPath: string;
+    /** Path to the compiled circuit JSON file */
+    circuitPath: string;
+}
+/**
+ * Configuration for IziNoir initialization
+ */
+interface IziNoirConfig {
+    /** The proving system provider to use */
+    provider: Provider;
+    /**
+     * Target blockchain for proof formatting.
+     * If omitted, operates in offchain mode (raw proofs, no chain formatting).
+     */
+    chain?: Chain;
+    /** Circuit paths - required for Sunspot provider */
+    circuitPaths?: CircuitPaths;
+}
+
+interface ICompiler {
+    compile(noirCode: string): Promise<CompiledCircuit>;
+}
+
+/**
+ * Interface for generating zero-knowledge proofs
+ */
+interface IProver {
+    /**
+     * Generate a proof for the given circuit and inputs
+     *
+     * @param circuit - The compiled circuit to prove
+     * @param inputs - The inputs (both public and private) for the circuit
+     * @returns The proof data including proof bytes and public inputs
+     */
+    generateProof(circuit: CompiledCircuit, inputs: InputMap): Promise<ProofData>;
+}
+
+/**
+ * Interface for verifying zero-knowledge proofs
+ */
+interface IVerifier {
+    /**
+     * Verify a proof against a compiled circuit
+     *
+     * @param circuit - The compiled circuit used to generate the proof
+     * @param proof - The proof bytes to verify
+     * @param publicInputs - The public inputs that were used
+     * @returns true if the proof is valid, false otherwise
+     */
+    verifyProof(circuit: CompiledCircuit, proof: Uint8Array, publicInputs: string[]): Promise<boolean>;
+}
+
+/**
+ * Unified interface for a complete proving system.
+ * Combines compilation, proof generation, and verification into a single abstraction.
+ *
+ * Implementations:
+ * - Barretenberg: WASM-based (browser compatible), UltraHonk proofs
+ * - Sunspot: CLI-based (Node.js only), Groth16 proofs for Solana
+ */
+interface IProvingSystem extends ICompiler, IProver, IVerifier {
+}
+
+export { type ChainId as C, type EthereumChainMetadata as E, type IziNoirConfig as I, Provider as P, type SolanaChainMetadata as S, type CircuitMetadata as a, type ChainMetadataFor as b, Chain as c, type IProvingSystem as d, type CircuitPaths as e, type ChainMetadata as f, type ICompiler as g, type IProver as h, type IVerifier as i };