hyli-noir 0.0.1

package/README.md

@@ -0,0 +1,35 @@
+# Check Secret Noir
+
+This is a demonstration project that shows how to implement a secret checking system using Noir (a Domain Specific Language for SNARK proving systems) with a web frontend.
+
+## Project Structure
+
+- `/contract` - Contains the Noir smart contract code
+  - `src/main.nr` - The main Noir contract implementing the secret checking logic
+- `/frontend` - Web interface implementation
+
+## Features
+
+- Zero-knowledge proof based secret verification
+- Web interface for submitting identity and password
+- Real-time proof verification display
+- Secure password handling through zero-knowledge proofs, settling on Hyle network.
+
+## Setup and Running
+
+1. Install dependencies:
+```bash
+# In the frontend directory
+bun install
+```
+
+2. Run the frontend development server:
+```bash
+# In the frontend directory
+bun run dev
+```
+
+## Security
+
+This example demonstrates zero-knowledge proof concepts for password verification. The password is never directly exposed in the verification process, enhancing security through cryptographic proofs.
+

package/dist/check_secret.d.ts

@@ -0,0 +1,44 @@
+import { CompiledCircuit } from "@noir-lang/types";
+import { Blob, ProofTransaction, NodeApiHttpClient } from "hyli";
+/**
+ * Builds a blob transaction containing a secret derived from an identity and password.
+ * The secret is constructed by:
+ * 1. Hashing the password in order to have a fixed-size secret
+ * 2. Concatenating the padded identity (to 64 chars) with ':' and the hashed password
+ * 3. Hashing this combined value
+ *
+ * @param identity - The user's identity string
+ * @param password - The user's password string
+ * @returns A Promise resolving to a BlobTransaction containing the hashed secret
+ */
+export declare const build_blob: (identity: string, password: string) => Promise<Blob>;
+/**
+ * Builds a proof transaction by generating a zero-knowledge proof for checking a secret.
+ * The proof demonstrates knowledge of a password that, when combined with an identity and hashed,
+ * matches a stored hash value. The process involves:
+ * 1. Hashing the password and combining it with the identity
+ * 2. Generating a witness and proof using the UltraHonk backend
+ * 3. Reconstructing and formatting the proof for the transaction
+ *
+ * @param identity - The user's identity string
+ * @param password - The user's password string
+ * @param tx_hash - The blob transaction hash string
+ * @param circuit - The compiled Noir circuit (defaults to the check_secret circuit)
+ * @returns A Promise resolving to a ProofTransaction containing the generated proof
+ */
+export declare const build_proof_transaction: (identity: string, password: string, tx_hash: string, blob_index: number, tx_blob_count: number, circuit?: CompiledCircuit) => Promise<ProofTransaction>;
+/**
+ * Registers the Noir contract with the node if it is not already registered.
+ * The contract is identified by its name "check_secret".
+ * If the contract is not found, it registers the contract using the provided circuit.
+ *
+ * @param node - The NodeApiHttpClient instance to interact with the NodeApiHttpClient
+ * @param circuit - The compiled Noir circuit (defaults to the check_secret circuit)
+ * @returns A Promise that resolves when the contract is registered
+ */
+export declare const register_contract: (node: NodeApiHttpClient, circuit?: CompiledCircuit) => Promise<void>;
+export declare const assert: (condition: boolean, message: string) => void;
+export declare const sha256: (data: Uint8Array) => Promise<Uint8Array>;
+export declare const stringToBytes: (input: string) => Uint8Array;
+export declare const encodeToHex: (data: Uint8Array) => string;
+export declare function flattenFieldsAsArray(fields: string[]): Uint8Array;