create-izi-noir 0.2.14 → 0.2.15

package/dist/index.js

@@ -393,39 +393,41 @@ function generateTsconfig() {
 // src/generators/circuits.ts
 function generateBalanceProof() {
   return `/**
- * Balance Proof Circuit
+ * Square Proof Circuit
  *
- * Proves that a private balance is greater than or equal to a public threshold
- * without revealing the actual balance.
+ * Proves knowledge of a secret number whose square equals a public value.
+ * This is a fundamental ZK proof pattern that demonstrates the SDK capabilities.
  *
- * @param threshold - The minimum required balance (public)
- * @param balance - The actual balance to prove (private, not revealed)
+ * Example: To prove you know the secret 7, set expected = 49 (7\xB2)
+ *
+ * @param expected - The expected result (secret\xB2) (public)
+ * @param secret - The secret number to prove (private, not revealed)
  */
 export function balanceProof(
-  [threshold]: [number],
-  [balance]: [number]
+  [expected]: [number],
+  [secret]: [number]
 ): void {
-  assert(balance >= threshold);
+  assert(secret * secret == expected);
 }
 `;
 }
 function generateAgeProof() {
   return `/**
- * Age Proof Circuit
+ * Another Square Proof Circuit
  *
- * Proves that a private birth year results in an age >= minimum age
- * without revealing the actual birth year.
+ * Another example proving knowledge of a secret whose square equals a public value.
+ * This demonstrates the same ZK pattern with different default values.
  *
- * @param currentYear - The current year (public)
- * @param minAge - The minimum required age (public)
- * @param birthYear - The actual birth year (private, not revealed)
+ * Example: To prove you know the secret 4, set expected = 16 (4\xB2)
+ *
+ * @param expected - The expected result (secret\xB2) (public)
+ * @param secret - The secret square root to prove (private, not revealed)
  */
 export function ageProof(
-  [currentYear, minAge]: [number, number],
-  [birthYear]: [number]
+  [expected]: [number],
+  [secret]: [number]
 ): void {
-  const age = currentYear - birthYear;
-  assert(age >= minAge);
+  assert(secret * secret == expected);
 }
 `;
 }
@@ -433,18 +435,20 @@ function generateMinimalCircuit() {
   return `/**
  * My Custom Circuit
  *
- * Replace this with your own circuit logic.
- * Use assert() statements to define constraints.
+ * A minimal ZK proof that proves knowledge of a secret whose square
+ * equals the public expected value.
  *
- * @param publicInput - A public input value
- * @param privateInput - A private input value (not revealed)
+ * Replace with your own circuit logic using assert() statements.
+ *
+ * @param expected - The expected result (secret\xB2) (public)
+ * @param secret - The secret value to prove (private, not revealed)
  */
 export function myCircuit(
-  [publicInput]: [number],
-  [privateInput]: [number]
+  [expected]: [number],
+  [secret]: [number]
 ): void {
-  // Example: prove that private input equals public input
-  assert(privateInput === publicInput);
+  // Prove that secret\xB2 = expected
+  assert(secret * secret == expected);
 }
 `;
 }
@@ -1177,9 +1181,9 @@ function getCircuitOptions(template) {
   {
     name: 'myCircuit',
     fn: myCircuit,
-    publicInputKeys: ['publicInput'],
-    privateInputKeys: ['privateInput'],
-    defaultInputs: { publicInput: '42', privateInput: '42' },
+    publicInputKeys: ['expected'],
+    privateInputKeys: ['secret'],
+    defaultInputs: { expected: '49', secret: '7' },
   },
 ]`;
     case "balance-proof":
@@ -1187,9 +1191,9 @@ function getCircuitOptions(template) {
   {
     name: 'balanceProof',
     fn: balanceProof,
-    publicInputKeys: ['threshold'],
-    privateInputKeys: ['balance'],
-    defaultInputs: { threshold: '100', balance: '1500' },
+    publicInputKeys: ['expected'],
+    privateInputKeys: ['secret'],
+    defaultInputs: { expected: '49', secret: '7' },
   },
 ]`;
     default:
@@ -1197,16 +1201,16 @@ function getCircuitOptions(template) {
   {
     name: 'balanceProof',
     fn: balanceProof,
-    publicInputKeys: ['threshold'],
-    privateInputKeys: ['balance'],
-    defaultInputs: { threshold: '100', balance: '1500' },
+    publicInputKeys: ['expected'],
+    privateInputKeys: ['secret'],
+    defaultInputs: { expected: '49', secret: '7' },
   },
   {
     name: 'ageProof',
     fn: ageProof,
-    publicInputKeys: ['currentYear', 'minAge'],
-    privateInputKeys: ['birthYear'],
-    defaultInputs: { currentYear: '2024', minAge: '18', birthYear: '1990' },
+    publicInputKeys: ['expected'],
+    privateInputKeys: ['secret'],
+    defaultInputs: { expected: '16', secret: '4' },
   },
 ]`;
   }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "create-izi-noir",
-  "version": "0.2.14",
+  "version": "0.2.15",
   "description": "CLI to scaffold IZI-NOIR ZK projects",
   "type": "module",
   "bin": {