create-izi-noir 0.1.1

package/README.md

@@ -0,0 +1,71 @@
+# create-izi-noir
+
+CLI to scaffold IZI-NOIR ZK projects.
+
+## Usage
+
+```bash
+# Create a new project interactively
+npx create-izi-noir my-project
+
+# Create with options
+npx create-izi-noir my-project --template balance-proof --provider arkworks
+
+# Skip prompts
+npx create-izi-noir my-project --skip-install --skip-git
+```
+
+## Options
+
+| Option | Description | Default |
+|--------|-------------|---------|
+| `-t, --template <template>` | Template to use (default, minimal, balance-proof) | default |
+| `-p, --provider <provider>` | Proving provider (arkworks, barretenberg) | arkworks |
+| `-y, --yes` | Skip prompts and use defaults | false |
+| `--skip-install` | Skip npm install | false |
+| `--skip-git` | Skip git initialization | false |
+
+## Templates
+
+### Default
+Includes balance proof and age proof circuit examples.
+
+### Minimal
+Empty circuit for starting from scratch.
+
+### Balance Proof
+Single balance proof circuit example.
+
+## Generated Project Structure
+
+```
+my-project/
+├── circuits/
+│   ├── balance-proof.ts    # ZK circuit as JS function
+│   ├── age-proof.ts
+│   └── index.ts
+├── generated/              # Compiled circuits (npm run build)
+├── scripts/
+│   └── test-proof.ts       # Test script
+├── package.json
+├── tsconfig.json
+├── izi-noir.config.ts
+└── README.md
+```
+
+## Development
+
+```bash
+# Install dependencies
+npm install
+
+# Build the CLI
+npm run build
+
+# Test locally
+node dist/index.js test-project
+```
+
+## License
+
+MIT

package/dist/index.d.ts

@@ -0,0 +1 @@
+#!/usr/bin/env node

package/dist/index.js

@@ -0,0 +1,648 @@
+#!/usr/bin/env node
+
+// src/cli.ts
+import { Command } from "commander";
+
+// src/commands/init.ts
+import path2 from "path";
+import { execSync } from "child_process";
+import pc3 from "picocolors";
+
+// src/prompts/project.ts
+import prompts from "prompts";
+import pc from "picocolors";
+var TEMPLATES = [
+  { title: "Default (balance + age proofs)", value: "default" },
+  { title: "Minimal (empty circuit)", value: "minimal" },
+  { title: "Balance Proof only", value: "balance-proof" }
+];
+var PROVIDERS = [
+  { title: "Arkworks (recommended)", value: "arkworks" },
+  { title: "Barretenberg", value: "barretenberg" }
+];
+async function promptProjectOptions(defaults) {
+  console.log();
+  console.log(pc.bold(pc.cyan("  IZI-NOIR")) + " - Privacy-preserving toolkit for Solana");
+  console.log();
+  const questions = [];
+  if (!defaults.projectName) {
+    questions.push({
+      type: "text",
+      name: "projectName",
+      message: "Project name:",
+      initial: "my-zk-project",
+      validate: (value) => {
+        if (!value) return "Project name is required";
+        if (!/^[a-z0-9-_]+$/i.test(value)) {
+          return "Project name can only contain letters, numbers, hyphens, and underscores";
+        }
+        return true;
+      }
+    });
+  }
+  questions.push(
+    {
+      type: "select",
+      name: "template",
+      message: "Select a template:",
+      choices: TEMPLATES,
+      initial: TEMPLATES.findIndex((t) => t.value === defaults.template) || 0
+    },
+    {
+      type: "select",
+      name: "provider",
+      message: "Select proving provider:",
+      choices: PROVIDERS,
+      initial: PROVIDERS.findIndex((p) => p.value === defaults.provider) || 0
+    },
+    {
+      type: "confirm",
+      name: "installDeps",
+      message: "Install dependencies?",
+      initial: !defaults.skipInstall
+    },
+    {
+      type: "confirm",
+      name: "initGit",
+      message: "Initialize git repository?",
+      initial: !defaults.skipGit
+    }
+  );
+  try {
+    const response = await prompts(questions, {
+      onCancel: () => {
+        throw new Error("Operation cancelled");
+      }
+    });
+    return {
+      projectName: defaults.projectName || response.projectName,
+      template: response.template || defaults.template || "default",
+      provider: response.provider || defaults.provider || "arkworks",
+      skipInstall: response.installDeps === false,
+      skipGit: response.initGit === false
+    };
+  } catch {
+    return null;
+  }
+}
+
+// src/utils/fs.ts
+import fs from "fs-extra";
+import path from "path";
+async function ensureDir(dir) {
+  await fs.ensureDir(dir);
+}
+async function writeFile(filePath, content) {
+  await fs.ensureDir(path.dirname(filePath));
+  await fs.writeFile(filePath, content, "utf-8");
+}
+async function directoryExists(dir) {
+  try {
+    const stat = await fs.stat(dir);
+    return stat.isDirectory();
+  } catch {
+    return false;
+  }
+}
+async function isDirectoryEmpty(dir) {
+  try {
+    const files = await fs.readdir(dir);
+    return files.length === 0;
+  } catch {
+    return true;
+  }
+}
+
+// src/utils/spinner.ts
+import pc2 from "picocolors";
+var frames = ["\u280B", "\u2819", "\u2839", "\u2838", "\u283C", "\u2834", "\u2826", "\u2827", "\u2807", "\u280F"];
+var Spinner = class {
+  message;
+  interval = null;
+  frameIndex = 0;
+  constructor(message) {
+    this.message = message;
+  }
+  start() {
+    process.stdout.write("\x1B[?25l");
+    this.interval = setInterval(() => {
+      const frame = pc2.cyan(frames[this.frameIndex]);
+      process.stdout.write(`\r${frame} ${this.message}`);
+      this.frameIndex = (this.frameIndex + 1) % frames.length;
+    }, 80);
+  }
+  stop(success = true) {
+    if (this.interval) {
+      clearInterval(this.interval);
+      this.interval = null;
+    }
+    process.stdout.write("\x1B[?25h");
+    const icon = success ? pc2.green("\u2713") : pc2.red("\u2717");
+    process.stdout.write(`\r${icon} ${this.message}
+`);
+  }
+  update(message) {
+    this.message = message;
+  }
+};
+function createSpinner(message) {
+  return new Spinner(message);
+}
+
+// src/generators/package-json.ts
+function generatePackageJson(options) {
+  const pkg = {
+    name: options.projectName,
+    version: "0.1.0",
+    description: "ZK circuits built with IZI-NOIR",
+    type: "module",
+    main: "./dist/index.js",
+    types: "./dist/index.d.ts",
+    exports: {
+      ".": {
+        types: "./dist/index.d.ts",
+        import: "./dist/index.js"
+      },
+      "./circuits": {
+        types: "./circuits/index.d.ts",
+        import: "./circuits/index.js"
+      }
+    },
+    files: ["dist", "circuits", "generated"],
+    scripts: {
+      build: "izi-noir build && tsc",
+      "build:circuits": "izi-noir build",
+      dev: "izi-noir build --watch",
+      test: "tsx scripts/test-proof.ts",
+      prepublishOnly: "npm run build"
+    },
+    dependencies: {
+      "@izi-noir/sdk": "^0.1.0"
+    },
+    devDependencies: {
+      "@types/node": "^22.0.0",
+      tsx: "^4.0.0",
+      typescript: "^5.4.0"
+    },
+    keywords: ["zk", "noir", "zero-knowledge", "privacy", "solana"],
+    license: "MIT"
+  };
+  return JSON.stringify(pkg, null, 2);
+}
+
+// src/generators/tsconfig.ts
+function generateTsconfig() {
+  const config = {
+    compilerOptions: {
+      target: "ES2022",
+      module: "ESNext",
+      moduleResolution: "bundler",
+      lib: ["ES2022"],
+      outDir: "./dist",
+      rootDir: ".",
+      strict: true,
+      esModuleInterop: true,
+      skipLibCheck: true,
+      forceConsistentCasingInFileNames: true,
+      declaration: true,
+      declarationMap: true,
+      sourceMap: true,
+      resolveJsonModule: true
+    },
+    include: ["circuits/**/*", "generated/**/*", "scripts/**/*"],
+    exclude: ["node_modules", "dist"]
+  };
+  return JSON.stringify(config, null, 2);
+}
+
+// src/generators/config.ts
+function generateConfig(options) {
+  return `import { defineConfig } from '@izi-noir/sdk';
+
+export default defineConfig({
+  // Directory containing your circuit files
+  circuitsDir: './circuits',
+
+  // Output directory for compiled circuits
+  outDir: './generated',
+
+  // Proving provider to use
+  provider: '${options.provider}',
+
+  // Enable watch mode optimizations
+  watch: {
+    // Debounce file changes (ms)
+    debounce: 100,
+  },
+});
+`;
+}
+
+// src/generators/circuits.ts
+function generateBalanceProof() {
+  return `/**
+ * Balance Proof Circuit
+ *
+ * Proves that a private balance is greater than or equal to a public threshold
+ * without revealing the actual balance.
+ *
+ * @param threshold - The minimum required balance (public)
+ * @param balance - The actual balance to prove (private, not revealed)
+ */
+export function balanceProof(
+  [threshold]: [number],
+  [balance]: [number]
+): void {
+  assert(balance >= threshold);
+}
+`;
+}
+function generateAgeProof() {
+  return `/**
+ * Age Proof Circuit
+ *
+ * Proves that a private birth year results in an age >= minimum age
+ * without revealing the actual birth year.
+ *
+ * @param currentYear - The current year (public)
+ * @param minAge - The minimum required age (public)
+ * @param birthYear - The actual birth year (private, not revealed)
+ */
+export function ageProof(
+  [currentYear, minAge]: [number, number],
+  [birthYear]: [number]
+): void {
+  const age = currentYear - birthYear;
+  assert(age >= minAge);
+}
+`;
+}
+function generateMinimalCircuit() {
+  return `/**
+ * My Custom Circuit
+ *
+ * Replace this with your own circuit logic.
+ * Use assert() statements to define constraints.
+ *
+ * @param publicInput - A public input value
+ * @param privateInput - A private input value (not revealed)
+ */
+export function myCircuit(
+  [publicInput]: [number],
+  [privateInput]: [number]
+): void {
+  // Example: prove that private input equals public input
+  assert(privateInput === publicInput);
+}
+`;
+}
+function generateCircuitsIndex(template) {
+  switch (template) {
+    case "minimal":
+      return `export { myCircuit } from './my-circuit.js';
+`;
+    case "balance-proof":
+      return `export { balanceProof } from './balance-proof.js';
+`;
+    default:
+      return `export { balanceProof } from './balance-proof.js';
+export { ageProof } from './age-proof.js';
+`;
+  }
+}
+
+// src/generators/scripts.ts
+function generateTestScript(options) {
+  const imports = getImports(options.template);
+  const tests = getTests(options.template);
+  return `/**
+ * Test script for ZK proofs
+ *
+ * Run with: npm test
+ */
+import { IziNoir, Provider } from '@izi-noir/sdk';
+${imports}
+
+async function main() {
+  console.log('Initializing IZI-NOIR...');
+  const izi = await IziNoir.init({
+    provider: Provider.${capitalizeFirst(options.provider)},
+  });
+
+${tests}
+
+  console.log('\\n\u2713 All proofs verified successfully!');
+}
+
+main().catch((error) => {
+  console.error('Error:', error);
+  process.exit(1);
+});
+`;
+}
+function getImports(template) {
+  switch (template) {
+    case "minimal":
+      return `import { myCircuit } from '../circuits/index.js';`;
+    case "balance-proof":
+      return `import { balanceProof } from '../circuits/index.js';`;
+    default:
+      return `import { balanceProof, ageProof } from '../circuits/index.js';`;
+  }
+}
+function getTests(template) {
+  switch (template) {
+    case "minimal":
+      return `  // Test: myCircuit
+  console.log('\\nTesting myCircuit...');
+  const result1 = await izi.createProof(
+    myCircuit,
+    [42],     // public: expected value
+    [42]      // private: actual value
+  );
+  console.log('  Proof verified:', result1.verified);`;
+    case "balance-proof":
+      return `  // Test: Balance Proof
+  console.log('\\nTesting balanceProof...');
+  const result1 = await izi.createProof(
+    balanceProof,
+    [100],    // public: threshold
+    [1500]    // private: actual balance
+  );
+  console.log('  Proof verified:', result1.verified);
+  console.log('  The prover has >= 100 balance (actual: hidden)');`;
+    default:
+      return `  // Test 1: Balance Proof
+  console.log('\\nTesting balanceProof...');
+  const result1 = await izi.createProof(
+    balanceProof,
+    [100],    // public: threshold
+    [1500]    // private: actual balance
+  );
+  console.log('  Proof verified:', result1.verified);
+  console.log('  The prover has >= 100 balance (actual: hidden)');
+
+  // Test 2: Age Proof
+  console.log('\\nTesting ageProof...');
+  const result2 = await izi.createProof(
+    ageProof,
+    [2024, 18],   // public: current year, minimum age
+    [1990]        // private: birth year
+  );
+  console.log('  Proof verified:', result2.verified);
+  console.log('  The prover is >= 18 years old (birth year: hidden)');`;
+  }
+}
+function capitalizeFirst(str) {
+  return str.charAt(0).toUpperCase() + str.slice(1);
+}
+
+// src/generators/readme.ts
+function generateReadme(options) {
+  return `# ${options.projectName}
+
+ZK circuits built with [IZI-NOIR](https://github.com/izi-noir/izi-noir).
+
+## Getting Started
+
+\`\`\`bash
+# Build circuits
+npm run build
+
+# Run tests
+npm test
+
+# Watch mode (rebuild on changes)
+npm run dev
+\`\`\`
+
+## Project Structure
+
+\`\`\`
+${options.projectName}/
+\u251C\u2500\u2500 circuits/           # Your ZK circuit definitions
+\u2502   \u251C\u2500\u2500 *.ts           # Circuits as JS functions with assert()
+\u2502   \u2514\u2500\u2500 index.ts       # Re-exports
+\u251C\u2500\u2500 generated/          # Compiled circuits (auto-generated)
+\u2502   \u251C\u2500\u2500 *.json         # Compiled circuit artifacts
+\u2502   \u2514\u2500\u2500 index.ts       # Typed re-exports
+\u251C\u2500\u2500 scripts/
+\u2502   \u2514\u2500\u2500 test-proof.ts  # Local test script
+\u251C\u2500\u2500 izi-noir.config.ts # Build configuration
+\u2514\u2500\u2500 package.json
+\`\`\`
+
+## Writing Circuits
+
+Circuits are JavaScript functions with \`assert()\` statements:
+
+\`\`\`typescript
+// circuits/my-circuit.ts
+export function myCircuit(
+  [publicInput]: [number],
+  [privateInput]: [number]
+): void {
+  assert(privateInput >= publicInput);
+}
+\`\`\`
+
+## Usage in Frontend
+
+\`\`\`typescript
+import { IziNoir, Provider } from '@izi-noir/sdk';
+import { myCircuit } from '${options.projectName}/circuits';
+
+const izi = await IziNoir.init({ provider: Provider.Arkworks });
+
+const proof = await izi.createProof(
+  myCircuit,
+  [100],    // public inputs
+  [1500]    // private inputs (hidden)
+);
+
+console.log(proof.verified); // true
+\`\`\`
+
+## Publishing
+
+\`\`\`bash
+npm publish
+\`\`\`
+
+Your circuits can then be installed as a dependency in other projects.
+
+## Learn More
+
+- [IZI-NOIR Documentation](https://github.com/izi-noir/izi-noir)
+- [Noir Language](https://noir-lang.org)
+`;
+}
+
+// src/generators/gitignore.ts
+function generateGitignore() {
+  return `# Dependencies
+node_modules/
+
+# Build output
+dist/
+generated/
+
+# IDE
+.idea/
+.vscode/
+*.swp
+*.swo
+
+# OS
+.DS_Store
+Thumbs.db
+
+# Logs
+*.log
+npm-debug.log*
+
+# Environment
+.env
+.env.local
+.env.*.local
+
+# Test coverage
+coverage/
+`;
+}
+
+// src/commands/init.ts
+async function initCommand(projectName, options) {
+  let projectOptions;
+  if (options.yes && projectName) {
+    projectOptions = {
+      projectName,
+      template: options.template,
+      provider: options.provider,
+      skipInstall: options.skipInstall,
+      skipGit: options.skipGit
+    };
+  } else {
+    projectOptions = await promptProjectOptions({
+      projectName,
+      template: options.template,
+      provider: options.provider,
+      skipInstall: options.skipInstall,
+      skipGit: options.skipGit
+    });
+  }
+  if (!projectOptions) {
+    console.log(pc3.yellow("\nOperation cancelled."));
+    process.exit(0);
+  }
+  const projectDir = path2.resolve(process.cwd(), projectOptions.projectName);
+  if (await directoryExists(projectDir)) {
+    if (!await isDirectoryEmpty(projectDir)) {
+      console.log(
+        pc3.red(`
+Error: Directory "${projectOptions.projectName}" already exists and is not empty.`)
+      );
+      process.exit(1);
+    }
+  }
+  console.log();
+  const spinner = createSpinner("Creating project structure...");
+  spinner.start();
+  try {
+    await createProjectStructure(projectDir, projectOptions);
+    spinner.stop(true);
+  } catch (error) {
+    spinner.stop(false);
+    console.error(pc3.red("\nFailed to create project structure:"), error);
+    process.exit(1);
+  }
+  if (!projectOptions.skipGit) {
+    const gitSpinner = createSpinner("Initializing git repository...");
+    gitSpinner.start();
+    try {
+      execSync("git init", { cwd: projectDir, stdio: "ignore" });
+      gitSpinner.stop(true);
+    } catch {
+      gitSpinner.stop(false);
+      console.log(pc3.yellow("  Warning: Failed to initialize git repository"));
+    }
+  }
+  if (!projectOptions.skipInstall) {
+    const installSpinner = createSpinner("Installing dependencies...");
+    installSpinner.start();
+    try {
+      execSync("npm install", { cwd: projectDir, stdio: "ignore" });
+      installSpinner.stop(true);
+    } catch {
+      installSpinner.stop(false);
+      console.log(pc3.yellow('  Warning: Failed to install dependencies. Run "npm install" manually.'));
+    }
+  }
+  printSuccessMessage(projectOptions);
+}
+async function createProjectStructure(projectDir, options) {
+  await ensureDir(path2.join(projectDir, "circuits"));
+  await ensureDir(path2.join(projectDir, "generated"));
+  await ensureDir(path2.join(projectDir, "scripts"));
+  const files = [
+    ["package.json", generatePackageJson(options)],
+    ["tsconfig.json", generateTsconfig()],
+    ["izi-noir.config.ts", generateConfig(options)],
+    ["README.md", generateReadme(options)],
+    [".gitignore", generateGitignore()],
+    ["scripts/test-proof.ts", generateTestScript(options)]
+  ];
+  switch (options.template) {
+    case "minimal":
+      files.push(["circuits/my-circuit.ts", generateMinimalCircuit()]);
+      break;
+    case "balance-proof":
+      files.push(["circuits/balance-proof.ts", generateBalanceProof()]);
+      break;
+    default:
+      files.push(["circuits/balance-proof.ts", generateBalanceProof()]);
+      files.push(["circuits/age-proof.ts", generateAgeProof()]);
+      break;
+  }
+  files.push(["circuits/index.ts", generateCircuitsIndex(options.template)]);
+  files.push([
+    "generated/.gitkeep",
+    "# This directory contains compiled circuit artifacts\n# Generated by: npm run build\n"
+  ]);
+  await Promise.all(
+    files.map(
+      ([relativePath, content]) => writeFile(path2.join(projectDir, relativePath), content)
+    )
+  );
+}
+function printSuccessMessage(options) {
+  console.log();
+  console.log(pc3.green("\u2713") + " Project created successfully!");
+  console.log();
+  console.log("Next steps:");
+  console.log();
+  console.log(pc3.cyan(`  cd ${options.projectName}`));
+  if (options.skipInstall) {
+    console.log(pc3.cyan("  npm install"));
+  }
+  console.log(pc3.cyan("  npm run build"));
+  console.log(pc3.cyan("  npm test"));
+  console.log();
+  console.log("To start developing:");
+  console.log();
+  console.log(pc3.dim("  1. Edit circuits in circuits/*.ts"));
+  console.log(pc3.dim('  2. Run "npm run dev" for watch mode'));
+  console.log(pc3.dim('  3. Test with "npm test"'));
+  console.log();
+  console.log(
+    pc3.dim("Learn more: ") + pc3.blue("https://github.com/izi-noir/izi-noir")
+  );
+  console.log();
+}
+
+// src/cli.ts
+var VERSION = "0.1.0";
+var cli = new Command().name("create-izi-noir").description("Create a new IZI-NOIR ZK project").version(VERSION).argument("[project-name]", "Name of the project to create").option("-t, --template <template>", "Template to use", "default").option("-p, --provider <provider>", "Proving provider", "arkworks").option("-y, --yes", "Skip prompts and use defaults", false).option("--skip-install", "Skip npm install", false).option("--skip-git", "Skip git initialization", false).action(initCommand);
+
+// src/index.ts
+cli.parse(process.argv);

package/package.json

@@ -0,0 +1,47 @@
+{
+  "name": "create-izi-noir",
+  "version": "0.1.1",
+  "description": "CLI to scaffold IZI-NOIR ZK projects",
+  "type": "module",
+  "bin": {
+    "create-izi-noir": "./dist/index.js"
+  },
+  "main": "./dist/index.js",
+  "files": [
+    "dist",
+    "templates"
+  ],
+  "scripts": {
+    "build": "tsup src/index.ts --format esm --dts --clean",
+    "dev": "tsup src/index.ts --format esm --watch",
+    "prepublishOnly": "npm run build"
+  },
+  "dependencies": {
+    "commander": "^12.0.0",
+    "prompts": "^2.4.2",
+    "picocolors": "^1.0.0",
+    "fs-extra": "^11.0.0"
+  },
+  "devDependencies": {
+    "@types/fs-extra": "^11.0.4",
+    "@types/node": "^22.0.0",
+    "@types/prompts": "^2.4.9",
+    "tsup": "^8.0.0",
+    "typescript": "^5.4.0"
+  },
+  "keywords": [
+    "zk",
+    "noir",
+    "solana",
+    "privacy",
+    "zero-knowledge",
+    "scaffold",
+    "cli"
+  ],
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/izi-noir/izi-noir.git",
+    "directory": "packages/create-izi-noir"
+  }
+}