@izi-noir/sdk 0.1.0

package/dist/providers/sunspot.d.cts

@@ -0,0 +1,210 @@
+import { d as IProvingSystem, e as CircuitPaths } from '../IProvingSystem-TKNofoo8.cjs';
+export { I as IziNoirConfig, P as Provider } from '../IProvingSystem-TKNofoo8.cjs';
+import { P as ProofData } from '../types-CaaigonG.cjs';
+import { CompiledCircuit, InputMap } from '@noir-lang/types';
+export { CompiledCircuit, InputMap } from '@noir-lang/types';
+
+/**
+ * Configuration for Sunspot CLI execution
+ */
+interface SunspotConfig {
+    /** Path to nargo binary (default: 'nargo') */
+    nargoBinaryPath: string;
+    /** Path to sunspot binary (default: 'sunspot') */
+    sunspotBinaryPath: string;
+    /** Keep temp artifacts for debugging (default: false) */
+    keepArtifacts: boolean;
+    /** Timeout for CLI commands in ms (default: 120000) */
+    timeoutMs: number;
+}
+/**
+ * Paths to all Sunspot artifacts in the temp directory
+ */
+interface SunspotCircuitPaths {
+    /** Base temp directory */
+    workDir: string;
+    /** Noir project directory with Nargo.toml */
+    noirProjectDir: string;
+    /** Path to compiled circuit.json (ACIR) */
+    circuitJsonPath: string;
+    /** Path to witness.gz */
+    witnessPath: string;
+    /** Path to circuit.ccs */
+    ccsPath: string;
+    /** Path to proving key */
+    pkPath: string;
+    /** Path to verification key */
+    vkPath: string;
+    /** Path to proof file */
+    proofPath: string;
+    /** Path to public witness file */
+    publicWitnessPath: string;
+    /** Path to Prover.toml */
+    proverTomlPath: string;
+}
+/**
+ * Extended CompiledCircuit for Sunspot backend
+ */
+interface SunspotCompiledCircuit extends CompiledCircuit {
+    /** Marker to identify Sunspot circuits */
+    __sunspot: true;
+    /** Paths to all artifacts */
+    paths: SunspotCircuitPaths;
+}
+/**
+ * Type guard to check if a circuit is a Sunspot circuit
+ */
+declare function isSunspotCircuit(circuit: CompiledCircuit): circuit is SunspotCompiledCircuit;
+/**
+ * Error thrown when CLI command fails
+ */
+declare class SunspotCliError extends Error {
+    readonly command: string;
+    readonly exitCode: number;
+    readonly stderr: string;
+    constructor(message: string, command: string, exitCode: number, stderr: string);
+}
+
+/**
+ * Configuration for Sunspot constructor
+ */
+interface SunspotInitConfig extends Partial<SunspotConfig> {
+    /** Pre-compiled circuit paths (if provided, compile() is disabled) */
+    precompiledPaths?: CircuitPaths;
+}
+/**
+ * Sunspot proving system using CLI tools.
+ * Node.js only (requires nargo and sunspot binaries).
+ * Produces Groth16 proofs (~324 bytes) for Solana on-chain verification.
+ *
+ * Can be used in two modes:
+ * 1. Full compilation: Call compile() with Noir code (requires nargo + sunspot CLI)
+ * 2. Pre-compiled: Provide circuitPaths in constructor, then only prove/verify
+ *
+ * @example Full compilation
+ * ```typescript
+ * const sunspot = new Sunspot();
+ * const circuit = await sunspot.compile(noirCode);
+ * const proof = await sunspot.generateProof(circuit, inputs);
+ * ```
+ *
+ * @example Pre-compiled (via IziNoir)
+ * ```typescript
+ * const izi = await IziNoir.init({
+ *   provider: Provider.Sunspot,
+ *   circuitPaths: { pkPath: '...', vkPath: '...', circuitPath: '...' }
+ * });
+ * ```
+ */
+declare class Sunspot implements IProvingSystem {
+    private readonly config;
+    private readonly executor;
+    private readonly precompiledPaths?;
+    private precompiledCircuit?;
+    /**
+     * Create a new Sunspot proving system
+     * @param config - Configuration options or pre-compiled circuit paths
+     */
+    constructor(config?: SunspotInitConfig | CircuitPaths);
+    /**
+     * Create a SunspotCompiledCircuit from pre-compiled paths
+     */
+    private createPrecompiledCircuit;
+    /**
+     * Create a temporary Noir project for compilation
+     */
+    private createNoirProject;
+    compile(noirCode: string): Promise<CompiledCircuit>;
+    generateProof(circuit: CompiledCircuit, inputs: InputMap): Promise<ProofData>;
+    verifyProof(circuit: CompiledCircuit, proof: Uint8Array, publicInputs: string[]): Promise<boolean>;
+    /**
+     * Resolve which circuit to use - precompiled or provided
+     */
+    private resolveCircuit;
+    private generateProverToml;
+    private formatTomlValue;
+    private parsePublicWitness;
+    private bytesEqual;
+}
+
+/**
+ * Sunspot entry point for Node.js.
+ *
+ * This module provides Sunspot support which is NOT available in the main
+ * `@izi-noir/sdk` entry point due to Node.js-only dependencies.
+ *
+ * Note: Sunspot requires nargo and sunspot CLI tools to be installed.
+ *
+ * @example Using Sunspot directly
+ * ```typescript
+ * import { Sunspot } from '@izi-noir/sdk/sunspot';
+ *
+ * // Full compilation mode
+ * const sunspot = new Sunspot();
+ * const circuit = await sunspot.compile(noirCode);
+ * const proof = await sunspot.generateProof(circuit, inputs);
+ * const verified = await sunspot.verifyProof(circuit, proof.proof, proof.publicInputs);
+ *
+ * // Pre-compiled mode
+ * const sunspot = new Sunspot({
+ *   pkPath: './circuit/circuit.pk',
+ *   vkPath: './circuit/circuit.vk',
+ *   circuitPath: './circuit/circuit.json',
+ * });
+ * ```
+ *
+ * @example Using initSunspotIziNoir helper
+ * ```typescript
+ * import { initSunspotIziNoir } from '@izi-noir/sdk/sunspot';
+ *
+ * const izi = await initSunspotIziNoir({
+ *   pkPath: './circuit/circuit.pk',
+ *   vkPath: './circuit/circuit.vk',
+ *   circuitPath: './circuit/circuit.json',
+ * });
+ *
+ * // Use like regular IziNoir (but only prove/verify, not compile)
+ * const proof = await izi.prove(inputs);
+ * const verified = await izi.verify(proof.proof, proof.publicInputs);
+ * ```
+ *
+ * @module @izi-noir/sdk/sunspot
+ */
+
+/**
+ * IziNoir-like wrapper for Sunspot.
+ * Provides a similar API to IziNoir but backed by the Sunspot proving system.
+ */
+declare class IziNoirSunspot {
+    private provingSystem;
+    private compiledCircuit;
+    private constructor();
+    /**
+     * Initialize IziNoirSunspot with pre-compiled circuit paths.
+     * Note: Sunspot requires pre-compiled circuits for prove/verify operations.
+     *
+     * @param circuitPaths - Paths to the pre-compiled circuit files
+     */
+    static init(circuitPaths: CircuitPaths): Promise<IziNoirSunspot>;
+    /**
+     * Initialize IziNoirSunspot for full compilation mode.
+     * Requires nargo and sunspot CLI tools to be installed.
+     */
+    static initForCompilation(): Promise<IziNoirSunspot>;
+    getProvingSystem(): IProvingSystem;
+    getCompiledCircuit(): CompiledCircuit | null;
+    compile(noirCode: string): Promise<CompiledCircuit>;
+    prove(inputs: InputMap, circuit?: CompiledCircuit): Promise<ProofData>;
+    verify(proof: Uint8Array, publicInputs: string[], circuit?: CompiledCircuit): Promise<boolean>;
+    createProof(noirCode: string, inputs: InputMap): Promise<{
+        proof: ProofData;
+        verified: boolean;
+    }>;
+}
+/**
+ * Helper function to create an IziNoirSunspot instance with pre-compiled circuit paths.
+ * @deprecated Use `IziNoirSunspot.init(circuitPaths)` instead.
+ */
+declare function initSunspotIziNoir(circuitPaths: CircuitPaths): Promise<IziNoirSunspot>;
+
+export { CircuitPaths, IProvingSystem, IziNoirSunspot, ProofData, Sunspot, type SunspotCircuitPaths, SunspotCliError, type SunspotCompiledCircuit, type SunspotConfig, type SunspotInitConfig, initSunspotIziNoir, isSunspotCircuit };

package/dist/providers/sunspot.d.ts

@@ -0,0 +1,210 @@
+import { d as IProvingSystem, e as CircuitPaths } from '../IProvingSystem-D9TnEig0.js';
+export { I as IziNoirConfig, P as Provider } from '../IProvingSystem-D9TnEig0.js';
+import { P as ProofData } from '../types-CaaigonG.js';
+import { CompiledCircuit, InputMap } from '@noir-lang/types';
+export { CompiledCircuit, InputMap } from '@noir-lang/types';
+
+/**
+ * Configuration for Sunspot CLI execution
+ */
+interface SunspotConfig {
+    /** Path to nargo binary (default: 'nargo') */
+    nargoBinaryPath: string;
+    /** Path to sunspot binary (default: 'sunspot') */
+    sunspotBinaryPath: string;
+    /** Keep temp artifacts for debugging (default: false) */
+    keepArtifacts: boolean;
+    /** Timeout for CLI commands in ms (default: 120000) */
+    timeoutMs: number;
+}
+/**
+ * Paths to all Sunspot artifacts in the temp directory
+ */
+interface SunspotCircuitPaths {
+    /** Base temp directory */
+    workDir: string;
+    /** Noir project directory with Nargo.toml */
+    noirProjectDir: string;
+    /** Path to compiled circuit.json (ACIR) */
+    circuitJsonPath: string;
+    /** Path to witness.gz */
+    witnessPath: string;
+    /** Path to circuit.ccs */
+    ccsPath: string;
+    /** Path to proving key */
+    pkPath: string;
+    /** Path to verification key */
+    vkPath: string;
+    /** Path to proof file */
+    proofPath: string;
+    /** Path to public witness file */
+    publicWitnessPath: string;
+    /** Path to Prover.toml */
+    proverTomlPath: string;
+}
+/**
+ * Extended CompiledCircuit for Sunspot backend
+ */
+interface SunspotCompiledCircuit extends CompiledCircuit {
+    /** Marker to identify Sunspot circuits */
+    __sunspot: true;
+    /** Paths to all artifacts */
+    paths: SunspotCircuitPaths;
+}
+/**
+ * Type guard to check if a circuit is a Sunspot circuit
+ */
+declare function isSunspotCircuit(circuit: CompiledCircuit): circuit is SunspotCompiledCircuit;
+/**
+ * Error thrown when CLI command fails
+ */
+declare class SunspotCliError extends Error {
+    readonly command: string;
+    readonly exitCode: number;
+    readonly stderr: string;
+    constructor(message: string, command: string, exitCode: number, stderr: string);
+}
+
+/**
+ * Configuration for Sunspot constructor
+ */
+interface SunspotInitConfig extends Partial<SunspotConfig> {
+    /** Pre-compiled circuit paths (if provided, compile() is disabled) */
+    precompiledPaths?: CircuitPaths;
+}
+/**
+ * Sunspot proving system using CLI tools.
+ * Node.js only (requires nargo and sunspot binaries).
+ * Produces Groth16 proofs (~324 bytes) for Solana on-chain verification.
+ *
+ * Can be used in two modes:
+ * 1. Full compilation: Call compile() with Noir code (requires nargo + sunspot CLI)
+ * 2. Pre-compiled: Provide circuitPaths in constructor, then only prove/verify
+ *
+ * @example Full compilation
+ * ```typescript
+ * const sunspot = new Sunspot();
+ * const circuit = await sunspot.compile(noirCode);
+ * const proof = await sunspot.generateProof(circuit, inputs);
+ * ```
+ *
+ * @example Pre-compiled (via IziNoir)
+ * ```typescript
+ * const izi = await IziNoir.init({
+ *   provider: Provider.Sunspot,
+ *   circuitPaths: { pkPath: '...', vkPath: '...', circuitPath: '...' }
+ * });
+ * ```
+ */
+declare class Sunspot implements IProvingSystem {
+    private readonly config;
+    private readonly executor;
+    private readonly precompiledPaths?;
+    private precompiledCircuit?;
+    /**
+     * Create a new Sunspot proving system
+     * @param config - Configuration options or pre-compiled circuit paths
+     */
+    constructor(config?: SunspotInitConfig | CircuitPaths);
+    /**
+     * Create a SunspotCompiledCircuit from pre-compiled paths
+     */
+    private createPrecompiledCircuit;
+    /**
+     * Create a temporary Noir project for compilation
+     */
+    private createNoirProject;
+    compile(noirCode: string): Promise<CompiledCircuit>;
+    generateProof(circuit: CompiledCircuit, inputs: InputMap): Promise<ProofData>;
+    verifyProof(circuit: CompiledCircuit, proof: Uint8Array, publicInputs: string[]): Promise<boolean>;
+    /**
+     * Resolve which circuit to use - precompiled or provided
+     */
+    private resolveCircuit;
+    private generateProverToml;
+    private formatTomlValue;
+    private parsePublicWitness;
+    private bytesEqual;
+}
+
+/**
+ * Sunspot entry point for Node.js.
+ *
+ * This module provides Sunspot support which is NOT available in the main
+ * `@izi-noir/sdk` entry point due to Node.js-only dependencies.
+ *
+ * Note: Sunspot requires nargo and sunspot CLI tools to be installed.
+ *
+ * @example Using Sunspot directly
+ * ```typescript
+ * import { Sunspot } from '@izi-noir/sdk/sunspot';
+ *
+ * // Full compilation mode
+ * const sunspot = new Sunspot();
+ * const circuit = await sunspot.compile(noirCode);
+ * const proof = await sunspot.generateProof(circuit, inputs);
+ * const verified = await sunspot.verifyProof(circuit, proof.proof, proof.publicInputs);
+ *
+ * // Pre-compiled mode
+ * const sunspot = new Sunspot({
+ *   pkPath: './circuit/circuit.pk',
+ *   vkPath: './circuit/circuit.vk',
+ *   circuitPath: './circuit/circuit.json',
+ * });
+ * ```
+ *
+ * @example Using initSunspotIziNoir helper
+ * ```typescript
+ * import { initSunspotIziNoir } from '@izi-noir/sdk/sunspot';
+ *
+ * const izi = await initSunspotIziNoir({
+ *   pkPath: './circuit/circuit.pk',
+ *   vkPath: './circuit/circuit.vk',
+ *   circuitPath: './circuit/circuit.json',
+ * });
+ *
+ * // Use like regular IziNoir (but only prove/verify, not compile)
+ * const proof = await izi.prove(inputs);
+ * const verified = await izi.verify(proof.proof, proof.publicInputs);
+ * ```
+ *
+ * @module @izi-noir/sdk/sunspot
+ */
+
+/**
+ * IziNoir-like wrapper for Sunspot.
+ * Provides a similar API to IziNoir but backed by the Sunspot proving system.
+ */
+declare class IziNoirSunspot {
+    private provingSystem;
+    private compiledCircuit;
+    private constructor();
+    /**
+     * Initialize IziNoirSunspot with pre-compiled circuit paths.
+     * Note: Sunspot requires pre-compiled circuits for prove/verify operations.
+     *
+     * @param circuitPaths - Paths to the pre-compiled circuit files
+     */
+    static init(circuitPaths: CircuitPaths): Promise<IziNoirSunspot>;
+    /**
+     * Initialize IziNoirSunspot for full compilation mode.
+     * Requires nargo and sunspot CLI tools to be installed.
+     */
+    static initForCompilation(): Promise<IziNoirSunspot>;
+    getProvingSystem(): IProvingSystem;
+    getCompiledCircuit(): CompiledCircuit | null;
+    compile(noirCode: string): Promise<CompiledCircuit>;
+    prove(inputs: InputMap, circuit?: CompiledCircuit): Promise<ProofData>;
+    verify(proof: Uint8Array, publicInputs: string[], circuit?: CompiledCircuit): Promise<boolean>;
+    createProof(noirCode: string, inputs: InputMap): Promise<{
+        proof: ProofData;
+        verified: boolean;
+    }>;
+}
+/**
+ * Helper function to create an IziNoirSunspot instance with pre-compiled circuit paths.
+ * @deprecated Use `IziNoirSunspot.init(circuitPaths)` instead.
+ */
+declare function initSunspotIziNoir(circuitPaths: CircuitPaths): Promise<IziNoirSunspot>;
+
+export { CircuitPaths, IProvingSystem, IziNoirSunspot, ProofData, Sunspot, type SunspotCircuitPaths, SunspotCliError, type SunspotCompiledCircuit, type SunspotConfig, type SunspotInitConfig, initSunspotIziNoir, isSunspotCircuit };