create-fhevm-example 1.2.2 → 1.3.0

package/dist/scripts/builders.js

@@ -0,0 +1,160 @@
+"use strict";
+/**
+ * Project Builders
+ *
+ * Creates single example and category projects from templates.
+ */
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.createSingleExample = createSingleExample;
+exports.createCategoryProject = createCategoryProject;
+const fs = __importStar(require("fs"));
+const path = __importStar(require("path"));
+const config_1 = require("./config");
+const utils_1 = require("./utils");
+// =============================================================================
+// Helper Functions
+// =============================================================================
+/**
+ * Downloads contract dependencies to the output directory
+ */
+async function downloadDependencies(dependencies, outputDir) {
+    for (const depPath of dependencies) {
+        const relativePath = depPath.replace(/^contracts\//, "");
+        const depDestPath = path.join(outputDir, "contracts", relativePath);
+        const depDestDir = path.dirname(depDestPath);
+        if (!fs.existsSync(depDestDir)) {
+            fs.mkdirSync(depDestDir, { recursive: true });
+        }
+        await (0, utils_1.downloadFileFromGitHub)(depPath, depDestPath);
+    }
+}
+/**
+ * Initializes git repository (optional, fails silently)
+ */
+async function initGitRepo(outputDir) {
+    try {
+        await (0, utils_1.runCommand)("git", ["init"], outputDir);
+    }
+    catch (error) {
+        // Git init is optional
+    }
+}
+// =============================================================================
+// Single Example Builder
+// =============================================================================
+/**
+ * Creates a single example project from the template
+ * @param exampleName - Name of the example to create
+ * @param outputDir - Target directory for the project
+ * @param tempRepoPath - Path to cloned template repository
+ */
+async function createSingleExample(exampleName, outputDir, tempRepoPath) {
+    const example = config_1.EXAMPLES[exampleName];
+    if (!example) {
+        throw new Error(`Unknown example: ${exampleName}`);
+    }
+    const templateDir = path.join(tempRepoPath, utils_1.TEMPLATE_DIR_NAME);
+    const contractName = (0, utils_1.getContractName)(example.contract);
+    if (!contractName) {
+        throw new Error("Could not extract contract name");
+    }
+    // Step 1: Copy template and clean up
+    (0, utils_1.copyDirectoryRecursive)(templateDir, outputDir);
+    (0, utils_1.cleanupTemplate)(outputDir);
+    // Step 2: Download example contract
+    await (0, utils_1.downloadFileFromGitHub)(example.contract, path.join(outputDir, "contracts", `${contractName}.sol`));
+    // Download contract dependencies if specified
+    if (example.dependencies) {
+        await downloadDependencies(example.dependencies, outputDir);
+    }
+    // Step 3: Download test file
+    await (0, utils_1.downloadFileFromGitHub)(example.test, path.join(outputDir, "test", path.basename(example.test)));
+    // Step 4: Update deploy script and package.json
+    fs.writeFileSync(path.join(outputDir, "deploy", "deploy.ts"), (0, utils_1.generateDeployScript)(contractName));
+    (0, utils_1.updateProjectPackageJson)(outputDir, `fhevm-example-${exampleName}`, example.description, example.npmDependencies);
+    // Initialize git repository
+    await initGitRepo(outputDir);
+}
+// =============================================================================
+// Category Project Builder
+// =============================================================================
+/**
+ * Creates a category project with multiple examples
+ * @param categoryName - Name of the category to create
+ * @param outputDir - Target directory for the project
+ * @param tempRepoPath - Path to cloned template repository
+ */
+async function createCategoryProject(categoryName, outputDir, tempRepoPath) {
+    const category = config_1.CATEGORIES[categoryName];
+    if (!category) {
+        throw new Error(`Unknown category: ${categoryName}`);
+    }
+    const templateDir = path.join(tempRepoPath, utils_1.TEMPLATE_DIR_NAME);
+    // Step 1: Copy template and clean up
+    (0, utils_1.copyDirectoryRecursive)(templateDir, outputDir);
+    (0, utils_1.cleanupTemplate)(outputDir);
+    // Step 2: Download all contracts and tests
+    for (const item of category.contracts) {
+        const contractName = (0, utils_1.getContractName)(item.sol);
+        if (contractName) {
+            await (0, utils_1.downloadFileFromGitHub)(item.sol, path.join(outputDir, "contracts", `${contractName}.sol`));
+        }
+        if (item.test) {
+            await (0, utils_1.downloadFileFromGitHub)(item.test, path.join(outputDir, "test", path.basename(item.test)));
+        }
+    }
+    // Collect dependencies from all examples in this category
+    const allDependencies = new Set();
+    const allNpmDependencies = {};
+    for (const [exampleName, exampleConfig] of Object.entries(config_1.EXAMPLES)) {
+        if (exampleConfig.category === category.name.replace(" Examples", "")) {
+            if (exampleConfig.dependencies) {
+                exampleConfig.dependencies.forEach((dep) => allDependencies.add(dep));
+            }
+            if (exampleConfig.npmDependencies) {
+                Object.assign(allNpmDependencies, exampleConfig.npmDependencies);
+            }
+        }
+    }
+    // Download all collected dependencies
+    if (allDependencies.size > 0) {
+        await downloadDependencies(Array.from(allDependencies), outputDir);
+    }
+    // Step 3: Update package.json
+    (0, utils_1.updateProjectPackageJson)(outputDir, `fhevm-examples-${categoryName}`, undefined, allNpmDependencies);
+    // Initialize git repository
+    await initGitRepo(outputDir);
+}

package/dist/{config.d.ts → scripts/config.d.ts}

@@ -1,8 +1,8 @@
 /**
  * ⚠️ AUTO-GENERATED FILE - DO NOT EDIT MANUALLY ⚠️
  *
- * This file is auto-generated by scripts/update-config.ts
- * Run 'npm run update:config' to regenerate
+ * This file is auto-generated by cli/generate-config.ts
+ * Run 'npm run generate:config' to regenerate
  */
 export interface ExampleConfig {
     /** Path to the Solidity contract file */
@@ -17,6 +17,8 @@ export interface ExampleConfig {
     description: string;
     /** Category for grouping */
     category: string;
+    /** Output path for generated documentation */
+    docsOutput: string;
     /** Title for documentation */
     title: string;
 }
@@ -31,7 +33,26 @@ export interface CategoryConfig {
 }
 export declare const REPO_URL = "https://github.com/NecipAkgz/fhevm-example-factory";
 export declare const REPO_BRANCH = "main";
-export declare const TEMPLATE_SUBMODULE_PATH = "fhevm-hardhat-template";
 export declare const EXAMPLES: Record<string, ExampleConfig>;
 export declare const CATEGORIES: Record<string, CategoryConfig>;
+/**
+ * Get list of example names
+ */
+export declare function getExampleNames(): string[];
+/**
+ * Get list of category names
+ */
+export declare function getCategoryNames(): string[];
+/**
+ * Get example by name
+ */
+export declare function getExample(name: string): ExampleConfig | undefined;
+/**
+ * Get category by name
+ */
+export declare function getCategory(name: string): CategoryConfig | undefined;
+/**
+ * Generate consistent docs filename with fhe- prefix
+ */
+export declare function getDocsFileName(exampleName: string): string;
 //# sourceMappingURL=config.d.ts.map

package/dist/scripts/config.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"config.d.ts","sourceRoot":"","sources":["../../scripts/config.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAMH,MAAM,WAAW,aAAa;IAC5B,yCAAyC;IACzC,QAAQ,EAAE,MAAM,CAAC;IACjB,uCAAuC;IACvC,IAAI,EAAE,MAAM,CAAC;IACb,gDAAgD;IAChD,YAAY,CAAC,EAAE,MAAM,EAAE,CAAC;IACxB,uCAAuC;IACvC,eAAe,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IACzC,yCAAyC;IACzC,WAAW,EAAE,MAAM,CAAC;IACpB,4BAA4B;IAC5B,QAAQ,EAAE,MAAM,CAAC;IACjB,8CAA8C;IAC9C,UAAU,EAAE,MAAM,CAAC;IACnB,8BAA8B;IAC9B,KAAK,EAAE,MAAM,CAAC;CACf;AAED,MAAM,WAAW,cAAc;IAC7B,mBAAmB;IACnB,IAAI,EAAE,MAAM,CAAC;IACb,yCAAyC;IACzC,SAAS,EAAE,KAAK,CAAC;QAAE,GAAG,EAAE,MAAM,CAAC;QAAC,IAAI,CAAC,EAAE,MAAM,CAAA;KAAE,CAAC,CAAC;CAClD;AAMD,eAAO,MAAM,QAAQ,uDAAuD,CAAC;AAC7E,eAAO,MAAM,WAAW,SAAS,CAAC;AAMlC,eAAO,MAAM,QAAQ,EAAE,MAAM,CAAC,MAAM,EAAE,aAAa,CA6RlD,CAAC;AAMF,eAAO,MAAM,UAAU,EAAE,MAAM,CAAC,MAAM,EAAE,cAAc,CAoJrD,CAAC;AAMF;;GAEG;AACH,wBAAgB,eAAe,IAAI,MAAM,EAAE,CAE1C;AAED;;GAEG;AACH,wBAAgB,gBAAgB,IAAI,MAAM,EAAE,CAE3C;AAED;;GAEG;AACH,wBAAgB,UAAU,CAAC,IAAI,EAAE,MAAM,GAAG,aAAa,GAAG,SAAS,CAElE;AAED;;GAEG;AACH,wBAAgB,WAAW,CAAC,IAAI,EAAE,MAAM,GAAG,cAAc,GAAG,SAAS,CAEpE;AAED;;GAEG;AACH,wBAAgB,eAAe,CAAC,WAAW,EAAE,MAAM,GAAG,MAAM,CAE3D"}

package/dist/scripts/config.js

@@ -0,0 +1,465 @@
+"use strict";
+/**
+ * ⚠️ AUTO-GENERATED FILE - DO NOT EDIT MANUALLY ⚠️
+ *
+ * This file is auto-generated by cli/generate-config.ts
+ * 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.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 = {
+    "blind-auction": {
+        contract: "contracts/advanced/BlindAuction.sol",
+        test: "test/advanced/BlindAuction.ts",
+        description: "Blind Auction with encrypted bids - only the winning price is revealed",
+        category: "Advanced",
+        docsOutput: "docs/advanced/blind-auction.md",
+        title: "Blind Auction"
+    },
+    "encrypted-escrow": {
+        contract: "contracts/advanced/EncryptedEscrow.sol",
+        test: "test/advanced/EncryptedEscrow.ts",
+        description: "Encrypted Escrow service - amounts hidden until release!",
+        category: "Advanced",
+        docsOutput: "docs/advanced/encrypted-escrow.md",
+        title: "Encrypted Escrow"
+    },
+    "hidden-voting": {
+        contract: "contracts/advanced/HiddenVoting.sol",
+        test: "test/advanced/HiddenVoting.ts",
+        description: "Hidden Voting with encrypted ballots and homomorphic tallying",
+        category: "Advanced",
+        docsOutput: "docs/advanced/hidden-voting.md",
+        title: "Hidden Voting"
+    },
+    "private-kyc": {
+        contract: "contracts/advanced/PrivateKYC.sol",
+        test: "test/advanced/PrivateKYC.ts",
+        description: "Private KYC - verify identity without revealing personal data!",
+        category: "Advanced",
+        docsOutput: "docs/advanced/private-kyc.md",
+        title: "Private KYC"
+    },
+    "private-payroll": {
+        contract: "contracts/advanced/PrivatePayroll.sol",
+        test: "test/advanced/PrivatePayroll.ts",
+        description: "Private Payroll system - salaries stay encrypted, only employees see their own!",
+        category: "Advanced",
+        docsOutput: "docs/advanced/private-payroll.md",
+        title: "Private Payroll"
+    },
+    "public-decrypt-multiple-values": {
+        contract: "contracts/basic/decryption/PublicDecryptMultipleValues.sol",
+        test: "test/basic/decryption/PublicDecryptMultipleValues.ts",
+        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"
+    },
+    "public-decrypt-single-value": {
+        contract: "contracts/basic/decryption/PublicDecryptSingleValue.sol",
+        test: "test/basic/decryption/PublicDecryptSingleValue.ts",
+        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"
+    },
+    "user-decrypt-multiple-values": {
+        contract: "contracts/basic/decryption/UserDecryptMultipleValues.sol",
+        test: "test/basic/decryption/UserDecryptMultipleValues.ts",
+        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"
+    },
+    "user-decrypt-single-value": {
+        contract: "contracts/basic/decryption/UserDecryptSingleValue.sol",
+        test: "test/basic/decryption/UserDecryptSingleValue.ts",
+        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"
+    },
+    "encrypt-multiple-values": {
+        contract: "contracts/basic/encryption/EncryptMultipleValues.sol",
+        test: "test/basic/encryption/EncryptMultipleValues.ts",
+        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"
+    },
+    "encrypt-single-value": {
+        contract: "contracts/basic/encryption/EncryptSingleValue.sol",
+        test: "test/basic/encryption/EncryptSingleValue.ts",
+        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"
+    },
+    "fhe-counter": {
+        contract: "contracts/basic/encryption/FHECounter.sol",
+        test: "test/basic/encryption/FHECounter.ts",
+        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"
+    },
+    "fhe-add": {
+        contract: "contracts/basic/fhe-operations/FHEAdd.sol",
+        test: "test/basic/fhe-operations/FHEAdd.ts",
+        description: "Simple example: adding two encrypted values (a + b)",
+        category: "Basic - FHE Operations",
+        docsOutput: "docs/basic/fhe-operations/fhe-add.md",
+        title: "FHE Add"
+    },
+    "fhe-arithmetic": {
+        contract: "contracts/basic/fhe-operations/FHEArithmetic.sol",
+        test: "test/basic/fhe-operations/FHEArithmetic.ts",
+        description: "Demonstrates all FHE arithmetic operations on encrypted integers",
+        category: "Basic - FHE Operations",
+        docsOutput: "docs/basic/fhe-operations/fhe-arithmetic.md",
+        title: "FHE Arithmetic"
+    },
+    "fhe-comparison": {
+        contract: "contracts/basic/fhe-operations/FHEComparison.sol",
+        test: "test/basic/fhe-operations/FHEComparison.ts",
+        description: "Demonstrates all FHE comparison operations on encrypted integers",
+        category: "Basic - FHE Operations",
+        docsOutput: "docs/basic/fhe-operations/fhe-comparison.md",
+        title: "FHE Comparison"
+    },
+    "fhe-if-then-else": {
+        contract: "contracts/basic/fhe-operations/FHEIfThenElse.sol",
+        test: "test/basic/fhe-operations/FHEIfThenElse.ts",
+        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"
+    },
+    "fhe-access-control": {
+        contract: "contracts/concepts/FHEAccessControl.sol",
+        test: "test/concepts/FHEAccessControl.ts",
+        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"
+    },
+    "fhe-anti-patterns": {
+        contract: "contracts/concepts/FHEAntiPatterns.sol",
+        test: "test/concepts/FHEAntiPatterns.ts",
+        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"
+    },
+    "fhe-handles": {
+        contract: "contracts/concepts/FHEHandles.sol",
+        test: "test/concepts/FHEHandles.ts",
+        description: "Understanding FHE handles: creation, computation, immutability, and symbolic execution in mock mode.",
+        category: "Concepts",
+        docsOutput: "docs/concepts/fhe-handles.md",
+        title: "FHE Handles"
+    },
+    "fhe-input-proof": {
+        contract: "contracts/concepts/FHEInputProof.sol",
+        test: "test/concepts/FHEInputProof.ts",
+        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"
+    },
+    "encrypted-lottery": {
+        contract: "contracts/gaming/EncryptedLottery.sol",
+        test: "test/gaming/EncryptedLottery.ts",
+        description: "Encrypted Lottery with private ticket numbers - fair and verifiable!",
+        category: "Gaming",
+        docsOutput: "docs/gaming/encrypted-lottery.md",
+        title: "Encrypted Lottery"
+    },
+    "encrypted-poker": {
+        contract: "contracts/gaming/EncryptedPoker.sol",
+        test: "test/gaming/EncryptedPoker.ts",
+        description: "Encrypted Poker - Texas Hold'em with hidden hole cards!",
+        category: "Gaming",
+        docsOutput: "docs/gaming/encrypted-poker.md",
+        title: "Encrypted Poker"
+    },
+    "rock-paper-scissors": {
+        contract: "contracts/gaming/RockPaperScissors.sol",
+        test: "test/gaming/RockPaperScissors.ts",
+        description: "Rock-Paper-Scissors game with encrypted moves - fair play guaranteed!",
+        category: "Gaming",
+        docsOutput: "docs/gaming/rock-paper-scissors.md",
+        title: "Rock Paper Scissors"
+    },
+    "erc7984": {
+        contract: "contracts/openzeppelin/ERC7984.sol",
+        test: "test/openzeppelin/ERC7984.ts",
+        npmDependencies: {
+            "@openzeppelin/contracts": "^5.4.0",
+            "@openzeppelin/confidential-contracts": "^0.3.0"
+        },
+        description: "Confidential token using OpenZeppelin's ERC7984 standard",
+        category: "Openzeppelin",
+        docsOutput: "docs/openzeppelin/erc7984.md",
+        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"
+        },
+        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"
+    },
+    "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"
+        },
+        dependencies: [
+            "contracts/openzeppelin/mocks/ERC20Mock.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"
+    },
+    "swap-erc7984-to-erc7984": {
+        contract: "contracts/openzeppelin/SwapERC7984ToERC7984.sol",
+        test: "test/openzeppelin/SwapERC7984ToERC7984.ts",
+        npmDependencies: {
+            "@openzeppelin/confidential-contracts": "^0.3.0"
+        },
+        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"
+    },
+    "vesting-wallet": {
+        contract: "contracts/openzeppelin/VestingWallet.sol",
+        test: "test/openzeppelin/VestingWallet.ts",
+        npmDependencies: {
+            "@openzeppelin/contracts": "^5.4.0",
+            "@openzeppelin/confidential-contracts": "^0.3.0"
+        },
+        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"
+    }
+};
+// =============================================================================
+// Category Configurations
+// =============================================================================
+exports.CATEGORIES = {
+    advanced: {
+        name: "Advanced Examples",
+        contracts: [
+            {
+                sol: "contracts/advanced/BlindAuction.sol",
+                test: "test/advanced/BlindAuction.ts",
+            },
+            {
+                sol: "contracts/advanced/EncryptedEscrow.sol",
+                test: "test/advanced/EncryptedEscrow.ts",
+            },
+            {
+                sol: "contracts/advanced/HiddenVoting.sol",
+                test: "test/advanced/HiddenVoting.ts",
+            },
+            {
+                sol: "contracts/advanced/PrivateKYC.sol",
+                test: "test/advanced/PrivateKYC.ts",
+            },
+            {
+                sol: "contracts/advanced/PrivatePayroll.sol",
+                test: "test/advanced/PrivatePayroll.ts",
+            }
+        ],
+    },
+    basicdecryption: {
+        name: "Basic - Decryption Examples",
+        contracts: [
+            {
+                sol: "contracts/basic/decryption/PublicDecryptMultipleValues.sol",
+                test: "test/basic/decryption/PublicDecryptMultipleValues.ts",
+            },
+            {
+                sol: "contracts/basic/decryption/PublicDecryptSingleValue.sol",
+                test: "test/basic/decryption/PublicDecryptSingleValue.ts",
+            },
+            {
+                sol: "contracts/basic/decryption/UserDecryptMultipleValues.sol",
+                test: "test/basic/decryption/UserDecryptMultipleValues.ts",
+            },
+            {
+                sol: "contracts/basic/decryption/UserDecryptSingleValue.sol",
+                test: "test/basic/decryption/UserDecryptSingleValue.ts",
+            }
+        ],
+    },
+    basicencryption: {
+        name: "Basic - Encryption Examples",
+        contracts: [
+            {
+                sol: "contracts/basic/encryption/EncryptMultipleValues.sol",
+                test: "test/basic/encryption/EncryptMultipleValues.ts",
+            },
+            {
+                sol: "contracts/basic/encryption/EncryptSingleValue.sol",
+                test: "test/basic/encryption/EncryptSingleValue.ts",
+            },
+            {
+                sol: "contracts/basic/encryption/FHECounter.sol",
+                test: "test/basic/encryption/FHECounter.ts",
+            }
+        ],
+    },
+    basicfheoperations: {
+        name: "Basic - FHE Operations Examples",
+        contracts: [
+            {
+                sol: "contracts/basic/fhe-operations/FHEAdd.sol",
+                test: "test/basic/fhe-operations/FHEAdd.ts",
+            },
+            {
+                sol: "contracts/basic/fhe-operations/FHEArithmetic.sol",
+                test: "test/basic/fhe-operations/FHEArithmetic.ts",
+            },
+            {
+                sol: "contracts/basic/fhe-operations/FHEComparison.sol",
+                test: "test/basic/fhe-operations/FHEComparison.ts",
+            },
+            {
+                sol: "contracts/basic/fhe-operations/FHEIfThenElse.sol",
+                test: "test/basic/fhe-operations/FHEIfThenElse.ts",
+            }
+        ],
+    },
+    concepts: {
+        name: "Concepts Examples",
+        contracts: [
+            {
+                sol: "contracts/concepts/FHEAccessControl.sol",
+                test: "test/concepts/FHEAccessControl.ts",
+            },
+            {
+                sol: "contracts/concepts/FHEAntiPatterns.sol",
+                test: "test/concepts/FHEAntiPatterns.ts",
+            },
+            {
+                sol: "contracts/concepts/FHEHandles.sol",
+                test: "test/concepts/FHEHandles.ts",
+            },
+            {
+                sol: "contracts/concepts/FHEInputProof.sol",
+                test: "test/concepts/FHEInputProof.ts",
+            }
+        ],
+    },
+    gaming: {
+        name: "Gaming Examples",
+        contracts: [
+            {
+                sol: "contracts/gaming/EncryptedLottery.sol",
+                test: "test/gaming/EncryptedLottery.ts",
+            },
+            {
+                sol: "contracts/gaming/EncryptedPoker.sol",
+                test: "test/gaming/EncryptedPoker.ts",
+            },
+            {
+                sol: "contracts/gaming/RockPaperScissors.sol",
+                test: "test/gaming/RockPaperScissors.ts",
+            }
+        ],
+    },
+    openzeppelin: {
+        name: "Openzeppelin Examples",
+        contracts: [
+            {
+                sol: "contracts/openzeppelin/ERC7984.sol",
+                test: "test/openzeppelin/ERC7984.ts",
+            },
+            {
+                sol: "contracts/openzeppelin/ERC7984ERC20Wrapper.sol",
+                test: "test/openzeppelin/ERC7984ERC20Wrapper.ts",
+            },
+            {
+                sol: "contracts/openzeppelin/SwapERC7984ToERC20.sol",
+                test: "test/openzeppelin/SwapERC7984ToERC20.ts",
+            },
+            {
+                sol: "contracts/openzeppelin/SwapERC7984ToERC7984.sol",
+                test: "test/openzeppelin/SwapERC7984ToERC7984.ts",
+            },
+            {
+                sol: "contracts/openzeppelin/VestingWallet.sol",
+                test: "test/openzeppelin/VestingWallet.ts",
+            }
+        ],
+    }
+};
+// =============================================================================
+// Helper Functions
+// =============================================================================
+/**
+ * Get list of example names
+ */
+function getExampleNames() {
+    return Object.keys(exports.EXAMPLES);
+}
+/**
+ * Get list of category names
+ */
+function getCategoryNames() {
+    return Object.keys(exports.CATEGORIES);
+}
+/**
+ * Get example by name
+ */
+function getExample(name) {
+    return exports.EXAMPLES[name];
+}
+/**
+ * Get category by name
+ */
+function getCategory(name) {
+    return exports.CATEGORIES[name];
+}
+/**
+ * Generate consistent docs filename with fhe- prefix
+ */
+function getDocsFileName(exampleName) {
+    return exampleName.startsWith("fhe-") ? exampleName : `fhe-${exampleName}`;
+}

package/dist/scripts/doctor.d.ts

@@ -0,0 +1,3 @@
+#!/usr/bin/env node
+export {};
+//# sourceMappingURL=doctor.d.ts.map