create-fhevm-example 1.3.2 → 1.4.0

package/dist/scripts/{config.js → shared/config.js}

@@ -6,18 +6,13 @@
  * Run 'npm run generate:config' to regenerate
  */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.CATEGORIES = exports.EXAMPLES = exports.REPO_BRANCH = exports.REPO_URL = void 0;
+exports.CATEGORIES = exports.EXAMPLES = void 0;
 exports.getExampleNames = getExampleNames;
 exports.getCategoryNames = getCategoryNames;
 exports.getExample = getExample;
 exports.getCategory = getCategory;
 exports.getDocsFileName = getDocsFileName;
 // =============================================================================
-// GitHub Repository Configuration
-// =============================================================================
-exports.REPO_URL = "https://github.com/NecipAkgz/fhevm-example-factory";
-exports.REPO_BRANCH = "main";
-// =============================================================================
 // Example Configurations
 // =============================================================================
 exports.EXAMPLES = {
@@ -27,7 +22,7 @@ exports.EXAMPLES = {
         description: "Blind Auction with encrypted bids - only the winning price is revealed",
         category: "Advanced",
         docsOutput: "docs/advanced/blind-auction.md",
-        title: "Blind Auction"
+        title: "Blind Auction",
     },
     "encrypted-escrow": {
         contract: "contracts/advanced/EncryptedEscrow.sol",
@@ -35,7 +30,7 @@ exports.EXAMPLES = {
         description: "Encrypted Escrow service - amounts hidden until release!",
         category: "Advanced",
         docsOutput: "docs/advanced/encrypted-escrow.md",
-        title: "Encrypted Escrow"
+        title: "Encrypted Escrow",
     },
     "hidden-voting": {
         contract: "contracts/advanced/HiddenVoting.sol",
@@ -43,7 +38,7 @@ exports.EXAMPLES = {
         description: "Hidden Voting with encrypted ballots and homomorphic tallying",
         category: "Advanced",
         docsOutput: "docs/advanced/hidden-voting.md",
-        title: "Hidden Voting"
+        title: "Hidden Voting",
     },
     "private-kyc": {
         contract: "contracts/advanced/PrivateKYC.sol",
@@ -51,7 +46,7 @@ exports.EXAMPLES = {
         description: "Private KYC - verify identity without revealing personal data!",
         category: "Advanced",
         docsOutput: "docs/advanced/private-kyc.md",
-        title: "Private KYC"
+        title: "Private KYC",
     },
     "private-payroll": {
         contract: "contracts/advanced/PrivatePayroll.sol",
@@ -59,7 +54,7 @@ exports.EXAMPLES = {
         description: "Private Payroll system - salaries stay encrypted, only employees see their own!",
         category: "Advanced",
         docsOutput: "docs/advanced/private-payroll.md",
-        title: "Private Payroll"
+        title: "Private Payroll",
     },
     "public-decrypt-multiple-values": {
         contract: "contracts/basic/decryption/PublicDecryptMultipleValues.sol",
@@ -67,7 +62,7 @@ exports.EXAMPLES = {
         description: "Implements a simple 8-sided Die Roll game demonstrating public, permissionless decryption",
         category: "Basic - Decryption",
         docsOutput: "docs/basic/decryption/public-decrypt-multiple-values.md",
-        title: "Public Decrypt Multiple Values"
+        title: "Public Decrypt Multiple Values",
     },
     "public-decrypt-single-value": {
         contract: "contracts/basic/decryption/PublicDecryptSingleValue.sol",
@@ -75,7 +70,7 @@ exports.EXAMPLES = {
         description: "Implements a simple Heads or Tails game demonstrating public, permissionless decryption",
         category: "Basic - Decryption",
         docsOutput: "docs/basic/decryption/public-decrypt-single-value.md",
-        title: "Public Decrypt Single Value"
+        title: "Public Decrypt Single Value",
     },
     "user-decrypt-multiple-values": {
         contract: "contracts/basic/decryption/UserDecryptMultipleValues.sol",
@@ -83,7 +78,7 @@ exports.EXAMPLES = {
         description: "Demonstrates user decryption of multiple encrypted values",
         category: "Basic - Decryption",
         docsOutput: "docs/basic/decryption/user-decrypt-multiple-values.md",
-        title: "User Decrypt Multiple Values"
+        title: "User Decrypt Multiple Values",
     },
     "user-decrypt-single-value": {
         contract: "contracts/basic/decryption/UserDecryptSingleValue.sol",
@@ -91,7 +86,7 @@ exports.EXAMPLES = {
         description: "Demonstrates the FHE decryption mechanism and highlights common pitfalls",
         category: "Basic - Decryption",
         docsOutput: "docs/basic/decryption/user-decrypt-single-value.md",
-        title: "User Decrypt Single Value"
+        title: "User Decrypt Single Value",
     },
     "encrypt-multiple-values": {
         contract: "contracts/basic/encryption/EncryptMultipleValues.sol",
@@ -99,7 +94,7 @@ exports.EXAMPLES = {
         description: "Encrypting and handling multiple values in a single transaction efficiently.",
         category: "Basic - Encryption",
         docsOutput: "docs/basic/encryption/encrypt-multiple-values.md",
-        title: "Encrypt Multiple Values"
+        title: "Encrypt Multiple Values",
     },
     "encrypt-single-value": {
         contract: "contracts/basic/encryption/EncryptSingleValue.sol",
@@ -107,7 +102,7 @@ exports.EXAMPLES = {
         description: "FHE encryption mechanism with single values, including common pitfalls and best practices for developers.",
         category: "Basic - Encryption",
         docsOutput: "docs/basic/encryption/encrypt-single-value.md",
-        title: "Encrypt Single Value"
+        title: "Encrypt Single Value",
     },
     "fhe-counter": {
         contract: "contracts/basic/encryption/FHECounter.sol",
@@ -115,7 +110,7 @@ exports.EXAMPLES = {
         description: "Confidential counter implementation using FHEVM, compared with a standard counter to highlight encryption benefits.",
         category: "Basic - Encryption",
         docsOutput: "docs/basic/encryption/fhe-counter.md",
-        title: "FHE Counter"
+        title: "FHE Counter",
     },
     "fhe-add": {
         contract: "contracts/basic/fhe-operations/FHEAdd.sol",
@@ -123,7 +118,7 @@ exports.EXAMPLES = {
         description: "Simple example: adding two encrypted values (a + b)",
         category: "Basic - FHE Operations",
         docsOutput: "docs/basic/fhe-operations/fhe-add.md",
-        title: "FHE Add"
+        title: "FHE Add",
     },
     "fhe-arithmetic": {
         contract: "contracts/basic/fhe-operations/FHEArithmetic.sol",
@@ -131,7 +126,7 @@ exports.EXAMPLES = {
         description: "Demonstrates all FHE arithmetic operations on encrypted integers",
         category: "Basic - FHE Operations",
         docsOutput: "docs/basic/fhe-operations/fhe-arithmetic.md",
-        title: "FHE Arithmetic"
+        title: "FHE Arithmetic",
     },
     "fhe-comparison": {
         contract: "contracts/basic/fhe-operations/FHEComparison.sol",
@@ -139,7 +134,7 @@ exports.EXAMPLES = {
         description: "Demonstrates all FHE comparison operations on encrypted integers",
         category: "Basic - FHE Operations",
         docsOutput: "docs/basic/fhe-operations/fhe-comparison.md",
-        title: "FHE Comparison"
+        title: "FHE Comparison",
     },
     "fhe-if-then-else": {
         contract: "contracts/basic/fhe-operations/FHEIfThenElse.sol",
@@ -147,7 +142,7 @@ exports.EXAMPLES = {
         description: "Demonstrates conditional logic: max(a, b) using encrypted comparison",
         category: "Basic - FHE Operations",
         docsOutput: "docs/basic/fhe-operations/fhe-if-then-else.md",
-        title: "FHE If Then Else"
+        title: "FHE If Then Else",
     },
     "fhe-access-control": {
         contract: "contracts/concepts/FHEAccessControl.sol",
@@ -155,7 +150,7 @@ exports.EXAMPLES = {
         description: "Critical access control patterns in FHEVM: FHE.allow, FHE.allowThis, FHE.allowTransient. Includes common mistakes and correct implementations.",
         category: "Concepts",
         docsOutput: "docs/concepts/fhe-access-control.md",
-        title: "FHE Access Control"
+        title: "FHE Access Control",
     },
     "fhe-anti-patterns": {
         contract: "contracts/concepts/FHEAntiPatterns.sol",
@@ -163,7 +158,7 @@ exports.EXAMPLES = {
         description: "Common FHE mistakes and their correct alternatives. Covers: branching, permissions, require/revert, re-encryption, loops, noise, and deprecated APIs.",
         category: "Concepts",
         docsOutput: "docs/concepts/fhe-anti-patterns.md",
-        title: "FHE Anti Patterns"
+        title: "FHE Anti Patterns",
     },
     "fhe-handles": {
         contract: "contracts/concepts/FHEHandles.sol",
@@ -171,7 +166,7 @@ exports.EXAMPLES = {
         description: "Understanding FHE handles: creation, computation, immutability, and symbolic execution in mock mode.",
         category: "Concepts",
         docsOutput: "docs/concepts/fhe-handles.md",
-        title: "FHE Handles"
+        title: "FHE Handles",
     },
     "fhe-input-proof": {
         contract: "contracts/concepts/FHEInputProof.sol",
@@ -179,7 +174,7 @@ exports.EXAMPLES = {
         description: "Explains input proof validation in FHEVM: what proofs are, why they are needed, and how to use them correctly with single and batched inputs.",
         category: "Concepts",
         docsOutput: "docs/concepts/fhe-input-proof.md",
-        title: "FHE Input Proof"
+        title: "FHE Input Proof",
     },
     "encrypted-lottery": {
         contract: "contracts/gaming/EncryptedLottery.sol",
@@ -187,7 +182,7 @@ exports.EXAMPLES = {
         description: "Encrypted Lottery with private ticket numbers - fair and verifiable!",
         category: "Gaming",
         docsOutput: "docs/gaming/encrypted-lottery.md",
-        title: "Encrypted Lottery"
+        title: "Encrypted Lottery",
     },
     "encrypted-poker": {
         contract: "contracts/gaming/EncryptedPoker.sol",
@@ -195,7 +190,7 @@ exports.EXAMPLES = {
         description: "Encrypted Poker - Texas Hold'em with hidden hole cards!",
         category: "Gaming",
         docsOutput: "docs/gaming/encrypted-poker.md",
-        title: "Encrypted Poker"
+        title: "Encrypted Poker",
     },
     "rock-paper-scissors": {
         contract: "contracts/gaming/RockPaperScissors.sol",
@@ -203,80 +198,74 @@ exports.EXAMPLES = {
         description: "Rock-Paper-Scissors game with encrypted moves - fair play guaranteed!",
         category: "Gaming",
         docsOutput: "docs/gaming/rock-paper-scissors.md",
-        title: "Rock Paper Scissors"
+        title: "Rock Paper Scissors",
     },
-    "erc7984": {
+    erc7984: {
         contract: "contracts/openzeppelin/ERC7984.sol",
         test: "test/openzeppelin/ERC7984.ts",
         npmDependencies: {
             "@openzeppelin/contracts": "^5.4.0",
-            "@openzeppelin/confidential-contracts": "^0.3.0"
+            "@openzeppelin/confidential-contracts": "^0.3.0",
         },
         description: "Confidential token using OpenZeppelin's ERC7984 standard",
         category: "Openzeppelin",
         docsOutput: "docs/openzeppelin/erc7984.md",
-        title: "ERC7984"
+        title: "ERC7984",
     },
     "erc7984-erc20-wrapper": {
         contract: "contracts/openzeppelin/ERC7984ERC20Wrapper.sol",
         test: "test/openzeppelin/ERC7984ERC20Wrapper.ts",
         npmDependencies: {
             "@openzeppelin/contracts": "^5.4.0",
-            "@openzeppelin/confidential-contracts": "^0.3.0"
+            "@openzeppelin/confidential-contracts": "^0.3.0",
         },
-        dependencies: [
-            "contracts/openzeppelin/mocks/ERC20Mock.sol"
-        ],
+        dependencies: ["contracts/openzeppelin/mocks/ERC20Mock.sol"],
         description: "Wraps ERC20 tokens into confidential ERC7984 tokens",
         category: "Openzeppelin",
         docsOutput: "docs/openzeppelin/erc7984-erc20-wrapper.md",
-        title: "ERC7984 ERC20 Wrapper"
+        title: "ERC7984 ERC20 Wrapper",
     },
     "swap-erc7984-to-erc20": {
         contract: "contracts/openzeppelin/SwapERC7984ToERC20.sol",
         test: "test/openzeppelin/SwapERC7984ToERC20.ts",
         npmDependencies: {
             "@openzeppelin/contracts": "^5.4.0",
-            "@openzeppelin/confidential-contracts": "^0.3.0"
+            "@openzeppelin/confidential-contracts": "^0.3.0",
         },
         dependencies: [
             "contracts/openzeppelin/mocks/ERC20Mock.sol",
-            "contracts/openzeppelin/ERC7984.sol"
+            "contracts/openzeppelin/ERC7984.sol",
         ],
         description: "Swap confidential ERC7984 tokens to regular ERC20 tokens",
         category: "Openzeppelin",
         docsOutput: "docs/openzeppelin/swap-erc7984-to-erc20.md",
-        title: "Swap ERC7984 To ERC20"
+        title: "Swap ERC7984 To ERC20",
     },
     "swap-erc7984-to-erc7984": {
         contract: "contracts/openzeppelin/SwapERC7984ToERC7984.sol",
         test: "test/openzeppelin/SwapERC7984ToERC7984.ts",
         npmDependencies: {
-            "@openzeppelin/confidential-contracts": "^0.3.0"
+            "@openzeppelin/confidential-contracts": "^0.3.0",
         },
-        dependencies: [
-            "contracts/openzeppelin/ERC7984.sol"
-        ],
+        dependencies: ["contracts/openzeppelin/ERC7984.sol"],
         description: "Fully confidential swap between two ERC7984 tokens",
         category: "Openzeppelin",
         docsOutput: "docs/openzeppelin/swap-erc7984-to-erc7984.md",
-        title: "Swap ERC7984 To ERC7984"
+        title: "Swap ERC7984 To ERC7984",
     },
     "vesting-wallet": {
         contract: "contracts/openzeppelin/VestingWallet.sol",
         test: "test/openzeppelin/VestingWallet.ts",
         npmDependencies: {
             "@openzeppelin/contracts": "^5.4.0",
-            "@openzeppelin/confidential-contracts": "^0.3.0"
+            "@openzeppelin/confidential-contracts": "^0.3.0",
         },
-        dependencies: [
-            "contracts/openzeppelin/ERC7984.sol"
-        ],
+        dependencies: ["contracts/openzeppelin/ERC7984.sol"],
         description: "Linear vesting wallet for ERC7984 tokens - amounts stay encrypted!",
         category: "Openzeppelin",
         docsOutput: "docs/openzeppelin/vesting-wallet.md",
-        title: "Vesting Wallet"
-    }
+        title: "Vesting Wallet",
+    },
 };
 // =============================================================================
 // Category Configurations
@@ -304,7 +293,7 @@ exports.CATEGORIES = {
             {
                 sol: "contracts/advanced/PrivatePayroll.sol",
                 test: "test/advanced/PrivatePayroll.ts",
-            }
+            },
         ],
     },
     basicdecryption: {
@@ -325,7 +314,7 @@ exports.CATEGORIES = {
             {
                 sol: "contracts/basic/decryption/UserDecryptSingleValue.sol",
                 test: "test/basic/decryption/UserDecryptSingleValue.ts",
-            }
+            },
         ],
     },
     basicencryption: {
@@ -342,7 +331,7 @@ exports.CATEGORIES = {
             {
                 sol: "contracts/basic/encryption/FHECounter.sol",
                 test: "test/basic/encryption/FHECounter.ts",
-            }
+            },
         ],
     },
     basicfheoperations: {
@@ -363,7 +352,7 @@ exports.CATEGORIES = {
             {
                 sol: "contracts/basic/fhe-operations/FHEIfThenElse.sol",
                 test: "test/basic/fhe-operations/FHEIfThenElse.ts",
-            }
+            },
         ],
     },
     concepts: {
@@ -384,7 +373,7 @@ exports.CATEGORIES = {
             {
                 sol: "contracts/concepts/FHEInputProof.sol",
                 test: "test/concepts/FHEInputProof.ts",
-            }
+            },
         ],
     },
     gaming: {
@@ -401,7 +390,7 @@ exports.CATEGORIES = {
             {
                 sol: "contracts/gaming/RockPaperScissors.sol",
                 test: "test/gaming/RockPaperScissors.ts",
-            }
+            },
         ],
     },
     openzeppelin: {
@@ -426,9 +415,9 @@ exports.CATEGORIES = {
             {
                 sol: "contracts/openzeppelin/VestingWallet.sol",
                 test: "test/openzeppelin/VestingWallet.ts",
-            }
+            },
         ],
-    }
+    },
 };
 // =============================================================================
 // Helper Functions

package/dist/scripts/shared/generators.d.ts

@@ -0,0 +1,42 @@
+/**
+ * Generators - Template processing and code generation utilities.
+ *
+ * Contains functions for scaffolding templates, generating deploy scripts,
+ * and creating documentation.
+ */
+/**
+ * Cleans up the template directory after copying
+ */
+export declare function cleanupTemplate(outputDir: string): void;
+/**
+ * Generates a deploy script for a contract
+ */
+export declare function generateDeployScript(contractName: string): string;
+/**
+ * Generates GitBook-compatible markdown documentation
+ */
+export declare function generateGitBookMarkdown(description: string, contractContent: string, testContent: string, contractName: string, testFileName: string): string;
+/**
+ * Updates package.json with project name and dependencies
+ */
+export declare function updateProjectPackageJson(outputDir: string, projectName: string, description?: string, npmDependencies?: Record<string, string>): void;
+/**
+ * Runs a command and returns the output
+ */
+export declare function runCommand(cmd: string, args: string[], cwd: string): Promise<string>;
+/**
+ * Runs a command and returns success status with output
+ */
+export declare function runCommandWithStatus(cmd: string, args: string[], cwd: string): Promise<{
+    success: boolean;
+    output: string;
+}>;
+/**
+ * Extracts test results from command output
+ */
+export declare function extractTestResults(output: string): string | null;
+/**
+ * Extracts error messages from command output
+ */
+export declare function extractErrorMessage(output: string): string;
+//# sourceMappingURL=generators.d.ts.map

package/dist/scripts/shared/generators.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"generators.d.ts","sourceRoot":"","sources":["../../../scripts/shared/generators.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAWH;;GAEG;AACH,wBAAgB,eAAe,CAAC,SAAS,EAAE,MAAM,GAAG,IAAI,CAiDvD;AAMD;;GAEG;AACH,wBAAgB,oBAAoB,CAAC,YAAY,EAAE,MAAM,GAAG,MAAM,CAkCjE;AAED;;GAEG;AACH,wBAAgB,uBAAuB,CACrC,WAAW,EAAE,MAAM,EACnB,eAAe,EAAE,MAAM,EACvB,WAAW,EAAE,MAAM,EACnB,YAAY,EAAE,MAAM,EACpB,YAAY,EAAE,MAAM,GACnB,MAAM,CA2BR;AAMD;;GAEG;AACH,wBAAgB,wBAAwB,CACtC,SAAS,EAAE,MAAM,EACjB,WAAW,EAAE,MAAM,EACnB,WAAW,CAAC,EAAE,MAAM,EACpB,eAAe,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GACvC,IAAI,CAiBN;AAMD;;GAEG;AACH,wBAAgB,UAAU,CACxB,GAAG,EAAE,MAAM,EACX,IAAI,EAAE,MAAM,EAAE,EACd,GAAG,EAAE,MAAM,GACV,OAAO,CAAC,MAAM,CAAC,CA+BjB;AAED;;GAEG;AACH,wBAAgB,oBAAoB,CAClC,GAAG,EAAE,MAAM,EACX,IAAI,EAAE,MAAM,EAAE,EACd,GAAG,EAAE,MAAM,GACV,OAAO,CAAC;IAAE,OAAO,EAAE,OAAO,CAAC;IAAC,MAAM,EAAE,MAAM,CAAA;CAAE,CAAC,CA2B/C;AAED;;GAEG;AACH,wBAAgB,kBAAkB,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,GAAG,IAAI,CAchE;AAED;;GAEG;AACH,wBAAgB,mBAAmB,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,CA4B1D"}