create-fhevm-example 1.0.1

package/dist/utils.js

@@ -0,0 +1,320 @@
+/**
+ * Utility functions for creating FHEVM example projects
+ */
+import * as fs from "fs";
+import * as path from "path";
+import { spawn } from "child_process";
+import { REPO_URL, REPO_BRANCH, TEMPLATE_SUBMODULE_PATH } from "./config.js";
+// =============================================================================
+// File System Utilities
+// =============================================================================
+/**
+ * Get contract name from file path
+ */
+export function getContractName(contractPath) {
+    const match = contractPath.match(/([^/]+)\.sol$/);
+    return match ? match[1] : null;
+}
+/**
+ * Recursively copy directory
+ */
+export function copyDirectoryRecursive(src, dest) {
+    if (!fs.existsSync(dest)) {
+        fs.mkdirSync(dest, { recursive: true });
+    }
+    const entries = fs.readdirSync(src, { withFileTypes: true });
+    for (const entry of entries) {
+        const srcPath = path.join(src, entry.name);
+        const destPath = path.join(dest, entry.name);
+        if (entry.isDirectory()) {
+            // Skip node_modules and .git
+            if (entry.name === "node_modules" || entry.name === ".git") {
+                continue;
+            }
+            copyDirectoryRecursive(srcPath, destPath);
+        }
+        else {
+            fs.copyFileSync(srcPath, destPath);
+        }
+    }
+}
+// =============================================================================
+// GitHub Repository Utilities
+// =============================================================================
+/**
+ * Download file from GitHub repository
+ */
+export async function downloadFileFromGitHub(filePath, outputPath) {
+    // Extract owner and repo from REPO_URL
+    const urlParts = REPO_URL.replace("https://github.com/", "").split("/");
+    const owner = urlParts[0];
+    const repo = urlParts[1];
+    const url = `https://raw.githubusercontent.com/${owner}/${repo}/${REPO_BRANCH}/${filePath}`;
+    const response = await fetch(url);
+    if (!response.ok) {
+        throw new Error(`Failed to download ${filePath}: ${response.statusText}`);
+    }
+    const content = await response.text();
+    // Ensure directory exists
+    const dir = path.dirname(outputPath);
+    if (!fs.existsSync(dir)) {
+        fs.mkdirSync(dir, { recursive: true });
+    }
+    fs.writeFileSync(outputPath, content);
+}
+/**
+ * Clone template repository to temporary directory
+ */
+export async function cloneTemplate(tempDir) {
+    const templatePath = path.join(tempDir, "template");
+    return new Promise((resolve, reject) => {
+        const cloneUrl = `${REPO_URL}.git`;
+        const args = [
+            "clone",
+            "--depth=1",
+            "--branch",
+            REPO_BRANCH,
+            "--single-branch",
+            cloneUrl,
+            templatePath,
+        ];
+        const child = spawn("git", args, {
+            stdio: "pipe",
+        });
+        let stderr = "";
+        child.stderr?.on("data", (data) => {
+            stderr += data.toString();
+        });
+        child.on("close", (code) => {
+            if (code === 0) {
+                resolve(templatePath);
+            }
+            else {
+                reject(new Error(`Git clone failed: ${stderr}`));
+            }
+        });
+        child.on("error", reject);
+    });
+}
+/**
+ * Initialize git submodule for template
+ */
+export async function initSubmodule(repoPath) {
+    return new Promise((resolve, reject) => {
+        const child = spawn("git", ["submodule", "update", "--init", "--recursive", TEMPLATE_SUBMODULE_PATH], {
+            cwd: repoPath,
+            stdio: "pipe",
+        });
+        let stderr = "";
+        child.stderr?.on("data", (data) => {
+            stderr += data.toString();
+        });
+        child.on("close", (code) => {
+            if (code === 0) {
+                resolve();
+            }
+            else {
+                reject(new Error(`Submodule init failed: ${stderr}`));
+            }
+        });
+        child.on("error", reject);
+    });
+}
+// =============================================================================
+// Command Execution Utilities
+// =============================================================================
+/**
+ * Run a shell command
+ */
+export function runCommand(cmd, args, cwd) {
+    return new Promise((resolve, reject) => {
+        const child = spawn(cmd, args, {
+            cwd,
+            shell: true,
+            stdio: "pipe",
+        });
+        let stdout = "";
+        let stderr = "";
+        child.stdout?.on("data", (data) => {
+            stdout += data.toString();
+        });
+        child.stderr?.on("data", (data) => {
+            stderr += data.toString();
+        });
+        child.on("close", (code) => {
+            if (code === 0) {
+                resolve(stdout);
+            }
+            else {
+                reject(new Error(stderr || stdout || `Command failed with code ${code}`));
+            }
+        });
+        child.on("error", reject);
+    });
+}
+/**
+ * Extract test results from npm test output
+ */
+export function extractTestResults(output) {
+    const passingMatch = output.match(/(\d+)\s+passing/);
+    const failingMatch = output.match(/(\d+)\s+failing/);
+    if (passingMatch) {
+        const passing = passingMatch[1];
+        const failing = failingMatch ? failingMatch[1] : "0";
+        if (failing === "0") {
+            return `${passing} tests passing ✓`;
+        }
+        else {
+            return `${passing} passing, ${failing} failing`;
+        }
+    }
+    return null;
+}
+// =============================================================================
+// README Generation
+// =============================================================================
+/**
+ * Generate README for single example project
+ */
+export function generateExampleReadme(exampleName, description, contractName) {
+    return `# ${contractName} - FHEVM Example
+
+${description}
+
+## Getting Started
+
+### Prerequisites
+
+- Node.js >= 20
+- npm or yarn
+
+### Installation
+
+\`\`\`bash
+npm install
+\`\`\`
+
+### Compile Contracts
+
+\`\`\`bash
+npm run compile
+\`\`\`
+
+### Run Tests
+
+\`\`\`bash
+npm run test
+\`\`\`
+
+### Deploy
+
+\`\`\`bash
+npm run deploy
+\`\`\`
+
+## Project Structure
+
+- \`contracts/\` - Solidity smart contracts
+- \`test/\` - Test files
+- \`deploy/\` - Deployment scripts
+- \`hardhat.config.ts\` - Hardhat configuration
+
+## Learn More
+
+- [FHEVM Documentation](https://docs.zama.ai/fhevm)
+- [Zama](https://www.zama.ai/)
+- [More Examples](https://github.com/zama-ai/fhevm-examples)
+
+## License
+
+BSD-3-Clause-Clear
+`;
+}
+/**
+ * Generate README for category project
+ */
+export function generateCategoryReadme(categoryName, description, contractNames) {
+    const contractList = contractNames.map((name) => `- ${name}`).join("\n");
+    return `# ${categoryName} - FHEVM Examples
+
+${description}
+
+## Included Contracts
+
+${contractList}
+
+## Getting Started
+
+### Prerequisites
+
+- Node.js >= 20
+- npm or yarn
+
+### Installation
+
+\`\`\`bash
+npm install
+\`\`\`
+
+### Compile Contracts
+
+\`\`\`bash
+npm run compile
+\`\`\`
+
+### Run Tests
+
+\`\`\`bash
+npm run test
+\`\`\`
+
+### Deploy
+
+\`\`\`bash
+npm run deploy
+\`\`\`
+
+## Project Structure
+
+- \`contracts/\` - Solidity smart contracts
+- \`test/\` - Test files
+- \`deploy/\` - Deployment scripts
+- \`hardhat.config.ts\` - Hardhat configuration
+
+## Learn More
+
+- [FHEVM Documentation](https://docs.zama.ai/fhevm)
+- [Zama](https://www.zama.ai/)
+- [More Examples](https://github.com/zama-ai/fhevm-examples)
+
+## License
+
+BSD-3-Clause-Clear
+`;
+}
+/**
+ * Generate deploy script
+ */
+export function generateDeployScript(contractName) {
+    return `import { DeployFunction } from "hardhat-deploy/types";
+import { HardhatRuntimeEnvironment } from "hardhat/types";
+
+const func: DeployFunction = async function (hre: HardhatRuntimeEnvironment) {
+  const { deployer } = await hre.getNamedAccounts();
+  const { deploy } = hre.deployments;
+
+  const deployed = await deploy("${contractName}", {
+    from: deployer,
+    args: [],
+    log: true,
+  });
+
+  console.log(\`${contractName} contract deployed at: \${deployed.address}\`);
+};
+
+export default func;
+func.id = "deploy_${contractName.toLowerCase()}";
+func.tags = ["${contractName}"];
+`;
+}
+//# sourceMappingURL=utils.js.map

package/dist/utils.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"utils.js","sourceRoot":"","sources":["../src/utils.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,OAAO,KAAK,EAAE,MAAM,IAAI,CAAC;AACzB,OAAO,KAAK,IAAI,MAAM,MAAM,CAAC;AAC7B,OAAO,EAAE,KAAK,EAAE,MAAM,eAAe,CAAC;AACtC,OAAO,EAAE,QAAQ,EAAE,WAAW,EAAE,uBAAuB,EAAE,MAAM,aAAa,CAAC;AAE7E,gFAAgF;AAChF,wBAAwB;AACxB,gFAAgF;AAEhF;;GAEG;AACH,MAAM,UAAU,eAAe,CAAC,YAAoB;IAClD,MAAM,KAAK,GAAG,YAAY,CAAC,KAAK,CAAC,eAAe,CAAC,CAAC;IAClD,OAAO,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC;AACjC,CAAC;AAED;;GAEG;AACH,MAAM,UAAU,sBAAsB,CAAC,GAAW,EAAE,IAAY;IAC9D,IAAI,CAAC,EAAE,CAAC,UAAU,CAAC,IAAI,CAAC,EAAE,CAAC;QACzB,EAAE,CAAC,SAAS,CAAC,IAAI,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAC;IAC1C,CAAC;IAED,MAAM,OAAO,GAAG,EAAE,CAAC,WAAW,CAAC,GAAG,EAAE,EAAE,aAAa,EAAE,IAAI,EAAE,CAAC,CAAC;IAE7D,KAAK,MAAM,KAAK,IAAI,OAAO,EAAE,CAAC;QAC5B,MAAM,OAAO,GAAG,IAAI,CAAC,IAAI,CAAC,GAAG,EAAE,KAAK,CAAC,IAAI,CAAC,CAAC;QAC3C,MAAM,QAAQ,GAAG,IAAI,CAAC,IAAI,CAAC,IAAI,EAAE,KAAK,CAAC,IAAI,CAAC,CAAC;QAE7C,IAAI,KAAK,CAAC,WAAW,EAAE,EAAE,CAAC;YACxB,6BAA6B;YAC7B,IAAI,KAAK,CAAC,IAAI,KAAK,cAAc,IAAI,KAAK,CAAC,IAAI,KAAK,MAAM,EAAE,CAAC;gBAC3D,SAAS;YACX,CAAC;YACD,sBAAsB,CAAC,OAAO,EAAE,QAAQ,CAAC,CAAC;QAC5C,CAAC;aAAM,CAAC;YACN,EAAE,CAAC,YAAY,CAAC,OAAO,EAAE,QAAQ,CAAC,CAAC;QACrC,CAAC;IACH,CAAC;AACH,CAAC;AAED,gFAAgF;AAChF,8BAA8B;AAC9B,gFAAgF;AAEhF;;GAEG;AACH,MAAM,CAAC,KAAK,UAAU,sBAAsB,CAC1C,QAAgB,EAChB,UAAkB;IAElB,uCAAuC;IACvC,MAAM,QAAQ,GAAG,QAAQ,CAAC,OAAO,CAAC,qBAAqB,EAAE,EAAE,CAAC,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;IACxE,MAAM,KAAK,GAAG,QAAQ,CAAC,CAAC,CAAC,CAAC;IAC1B,MAAM,IAAI,GAAG,QAAQ,CAAC,CAAC,CAAC,CAAC;IAEzB,MAAM,GAAG,GAAG,qCAAqC,KAAK,IAAI,IAAI,IAAI,WAAW,IAAI,QAAQ,EAAE,CAAC;IAE5F,MAAM,QAAQ,GAAG,MAAM,KAAK,CAAC,GAAG,CAAC,CAAC;IAClC,IAAI,CAAC,QAAQ,CAAC,EAAE,EAAE,CAAC;QACjB,MAAM,IAAI,KAAK,CAAC,sBAAsB,QAAQ,KAAK,QAAQ,CAAC,UAAU,EAAE,CAAC,CAAC;IAC5E,CAAC;IAED,MAAM,OAAO,GAAG,MAAM,QAAQ,CAAC,IAAI,EAAE,CAAC;IAEtC,0BAA0B;IAC1B,MAAM,GAAG,GAAG,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,CAAC;IACrC,IAAI,CAAC,EAAE,CAAC,UAAU,CAAC,GAAG,CAAC,EAAE,CAAC;QACxB,EAAE,CAAC,SAAS,CAAC,GAAG,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAC;IACzC,CAAC;IAED,EAAE,CAAC,aAAa,CAAC,UAAU,EAAE,OAAO,CAAC,CAAC;AACxC,CAAC;AAED;;GAEG;AACH,MAAM,CAAC,KAAK,UAAU,aAAa,CAAC,OAAe;IACjD,MAAM,YAAY,GAAG,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE,UAAU,CAAC,CAAC;IAEpD,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;QACrC,MAAM,QAAQ,GAAG,GAAG,QAAQ,MAAM,CAAC;QACnC,MAAM,IAAI,GAAG;YACX,OAAO;YACP,WAAW;YACX,UAAU;YACV,WAAW;YACX,iBAAiB;YACjB,QAAQ;YACR,YAAY;SACb,CAAC;QAEF,MAAM,KAAK,GAAG,KAAK,CAAC,KAAK,EAAE,IAAI,EAAE;YAC/B,KAAK,EAAE,MAAM;SACd,CAAC,CAAC;QAEH,IAAI,MAAM,GAAG,EAAE,CAAC;QAEhB,KAAK,CAAC,MAAM,EAAE,EAAE,CAAC,MAAM,EAAE,CAAC,IAAI,EAAE,EAAE;YAChC,MAAM,IAAI,IAAI,CAAC,QAAQ,EAAE,CAAC;QAC5B,CAAC,CAAC,CAAC;QAEH,KAAK,CAAC,EAAE,CAAC,OAAO,EAAE,CAAC,IAAI,EAAE,EAAE;YACzB,IAAI,IAAI,KAAK,CAAC,EAAE,CAAC;gBACf,OAAO,CAAC,YAAY,CAAC,CAAC;YACxB,CAAC;iBAAM,CAAC;gBACN,MAAM,CAAC,IAAI,KAAK,CAAC,qBAAqB,MAAM,EAAE,CAAC,CAAC,CAAC;YACnD,CAAC;QACH,CAAC,CAAC,CAAC;QAEH,KAAK,CAAC,EAAE,CAAC,OAAO,EAAE,MAAM,CAAC,CAAC;IAC5B,CAAC,CAAC,CAAC;AACL,CAAC;AAED;;GAEG;AACH,MAAM,CAAC,KAAK,UAAU,aAAa,CAAC,QAAgB;IAClD,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;QACrC,MAAM,KAAK,GAAG,KAAK,CACjB,KAAK,EACL,CAAC,WAAW,EAAE,QAAQ,EAAE,QAAQ,EAAE,aAAa,EAAE,uBAAuB,CAAC,EACzE;YACE,GAAG,EAAE,QAAQ;YACb,KAAK,EAAE,MAAM;SACd,CACF,CAAC;QAEF,IAAI,MAAM,GAAG,EAAE,CAAC;QAEhB,KAAK,CAAC,MAAM,EAAE,EAAE,CAAC,MAAM,EAAE,CAAC,IAAI,EAAE,EAAE;YAChC,MAAM,IAAI,IAAI,CAAC,QAAQ,EAAE,CAAC;QAC5B,CAAC,CAAC,CAAC;QAEH,KAAK,CAAC,EAAE,CAAC,OAAO,EAAE,CAAC,IAAI,EAAE,EAAE;YACzB,IAAI,IAAI,KAAK,CAAC,EAAE,CAAC;gBACf,OAAO,EAAE,CAAC;YACZ,CAAC;iBAAM,CAAC;gBACN,MAAM,CAAC,IAAI,KAAK,CAAC,0BAA0B,MAAM,EAAE,CAAC,CAAC,CAAC;YACxD,CAAC;QACH,CAAC,CAAC,CAAC;QAEH,KAAK,CAAC,EAAE,CAAC,OAAO,EAAE,MAAM,CAAC,CAAC;IAC5B,CAAC,CAAC,CAAC;AACL,CAAC;AAED,gFAAgF;AAChF,8BAA8B;AAC9B,gFAAgF;AAEhF;;GAEG;AACH,MAAM,UAAU,UAAU,CACxB,GAAW,EACX,IAAc,EACd,GAAW;IAEX,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;QACrC,MAAM,KAAK,GAAG,KAAK,CAAC,GAAG,EAAE,IAAI,EAAE;YAC7B,GAAG;YACH,KAAK,EAAE,IAAI;YACX,KAAK,EAAE,MAAM;SACd,CAAC,CAAC;QAEH,IAAI,MAAM,GAAG,EAAE,CAAC;QAChB,IAAI,MAAM,GAAG,EAAE,CAAC;QAEhB,KAAK,CAAC,MAAM,EAAE,EAAE,CAAC,MAAM,EAAE,CAAC,IAAI,EAAE,EAAE;YAChC,MAAM,IAAI,IAAI,CAAC,QAAQ,EAAE,CAAC;QAC5B,CAAC,CAAC,CAAC;QAEH,KAAK,CAAC,MAAM,EAAE,EAAE,CAAC,MAAM,EAAE,CAAC,IAAI,EAAE,EAAE;YAChC,MAAM,IAAI,IAAI,CAAC,QAAQ,EAAE,CAAC;QAC5B,CAAC,CAAC,CAAC;QAEH,KAAK,CAAC,EAAE,CAAC,OAAO,EAAE,CAAC,IAAI,EAAE,EAAE;YACzB,IAAI,IAAI,KAAK,CAAC,EAAE,CAAC;gBACf,OAAO,CAAC,MAAM,CAAC,CAAC;YAClB,CAAC;iBAAM,CAAC;gBACN,MAAM,CACJ,IAAI,KAAK,CAAC,MAAM,IAAI,MAAM,IAAI,4BAA4B,IAAI,EAAE,CAAC,CAClE,CAAC;YACJ,CAAC;QACH,CAAC,CAAC,CAAC;QAEH,KAAK,CAAC,EAAE,CAAC,OAAO,EAAE,MAAM,CAAC,CAAC;IAC5B,CAAC,CAAC,CAAC;AACL,CAAC;AAED;;GAEG;AACH,MAAM,UAAU,kBAAkB,CAAC,MAAc;IAC/C,MAAM,YAAY,GAAG,MAAM,CAAC,KAAK,CAAC,iBAAiB,CAAC,CAAC;IACrD,MAAM,YAAY,GAAG,MAAM,CAAC,KAAK,CAAC,iBAAiB,CAAC,CAAC;IAErD,IAAI,YAAY,EAAE,CAAC;QACjB,MAAM,OAAO,GAAG,YAAY,CAAC,CAAC,CAAC,CAAC;QAChC,MAAM,OAAO,GAAG,YAAY,CAAC,CAAC,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC;QACrD,IAAI,OAAO,KAAK,GAAG,EAAE,CAAC;YACpB,OAAO,GAAG,OAAO,kBAAkB,CAAC;QACtC,CAAC;aAAM,CAAC;YACN,OAAO,GAAG,OAAO,aAAa,OAAO,UAAU,CAAC;QAClD,CAAC;IACH,CAAC;IACD,OAAO,IAAI,CAAC;AACd,CAAC;AAED,gFAAgF;AAChF,oBAAoB;AACpB,gFAAgF;AAEhF;;GAEG;AACH,MAAM,UAAU,qBAAqB,CACnC,WAAmB,EACnB,WAAmB,EACnB,YAAoB;IAEpB,OAAO,KAAK,YAAY;;EAExB,WAAW;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAiDZ,CAAC;AACF,CAAC;AAED;;GAEG;AACH,MAAM,UAAU,sBAAsB,CACpC,YAAoB,EACpB,WAAmB,EACnB,aAAuB;IAEvB,MAAM,YAAY,GAAG,aAAa,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,KAAK,IAAI,EAAE,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IAEzE,OAAO,KAAK,YAAY;;EAExB,WAAW;;;;EAIX,YAAY;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAiDb,CAAC;AACF,CAAC;AAED;;GAEG;AACH,MAAM,UAAU,oBAAoB,CAAC,YAAoB;IACvD,OAAO;;;;;;;mCAO0B,YAAY;;;;;;kBAM7B,YAAY;;;;oBAIV,YAAY,CAAC,WAAW,EAAE;gBAC9B,YAAY;CAC3B,CAAC;AACF,CAAC"}

package/package.json

@@ -0,0 +1,46 @@
+{
+  "name": "create-fhevm-example",
+  "version": "1.0.1",
+  "description": "Create FHEVM example projects with a single command",
+  "type": "module",
+  "bin": {
+    "create-fhevm-example": "./dist/index.js"
+  },
+  "files": [
+    "dist"
+  ],
+  "scripts": {
+    "build": "tsc",
+    "dev": "tsc --watch",
+    "prepublishOnly": "npm run build"
+  },
+  "keywords": [
+    "fhevm",
+    "zama",
+    "encryption",
+    "blockchain",
+    "examples",
+    "cli",
+    "create",
+    "scaffold"
+  ],
+  "author": "Zama",
+  "license": "BSD-3-Clause-Clear",
+  "engines": {
+    "node": ">=20"
+  },
+  "homepage": "https://github.com/NecipAkgz/fhevm-example-factory/tree/main/packages/create-fhevm-example#readme",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/NecipAkgz/fhevm-example-factory",
+    "directory": "packages/create-fhevm-example"
+  },
+  "dependencies": {
+    "@clack/prompts": "^0.11.0",
+    "picocolors": "^1.1.1"
+  },
+  "devDependencies": {
+    "@types/node": "^20.19.8",
+    "typescript": "^5.8.3"
+  }
+}