\r\n \r\n
\r\n Composable Template System for Privacy-Preserving Smart Contracts\r\n
\r\n\r\n Stop writing FHE boilerplate from scratch.
\r\n Generate production ready encrypted smart contracts in seconds with a single CLI command.
\r\n Choose from 44 standalone templates or compose custom contracts with 16 bases + 13 modules.\r\n
\r\n ![\"npm\"](\"https://img.shields.io/npm/v/@0xflydev/labz?color=CB3837&logo=npm\")
![\"Built](\"https://img.shields.io/badge/Built%20with-Zama%20FHEVM-yellow\"){kind=icon}
![\"Next.js\"](\"https://img.shields.io/badge/Next.js-15-000000?logo=next.js\"){kind=icon}
![\"TypeScript\"](\"https://img.shields.io/badge/TypeScript-5.x-3178C6?logo=typescript\"){kind=icon}
![\"Solidity\"](\"https://img.shields.io/badge/Solidity-0.8.24-363636?logo=solidity\"){kind=icon}
![\"License:](\"https://img.shields.io/badge/License-MIT-blue.svg\"){kind=icon}
\r\n
![](\"https://img.shields.io/badge/◆_Overview-FFD966?style=flat-square\"){kind=icon}
\r\n\r\n\r\n▸ Lab-Z provides two ways to generate FHE smart contracts:\r\n\r\n| Command | Use Case | Templates |\r\n|---------|----------|-----------|\r\n| `labz create` | Quick start with ready-made examples | 44 standalone templates |\r\n| `labz build` | Custom contracts with composable modules | 16 bases + 13 modules |\r\n\r\n### ▎Key Features\r\n\r\n- **44 standalone templates** across 9 categories (basics, encryption, decryption, acl, input-proofs, anti-patterns, handles, openzeppelin, advanced)\r\n- **16 composable base templates** for DeFi, gaming, voting, and identity\r\n- **13 feature modules** for ACL, admin, security, and FHE operations\r\n- **9 OpenZeppelin ERC7984 + FHEVM** production-ready confidential contracts\r\n- **9-phase validation pipeline** preventing incompatible module combinations\r\n- **CLI with 9 commands**, interactive mode, and visual composer\r\n\r\n### ▎CLI Commands\r\n\r\n| Command | Options |\r\n|---------|---------|\r\n| `create` | `-i, --interactive` `--git` `--install` `--open` `-o, --output` `-l, --list` `-y, --yes` |\r\n| `build` | `-i, --interactive` `-w, --with` `-t, --type` `--list-bases` `--list-modules` `--check` `--preview` `--dry-run` `-o, --output` `-y, --yes` |\r\n| `list` | `-c, --category` `-d, --difficulty` `-t, --tag` |\r\n| `search` | `-c, --category` `-d, --difficulty` `-b, --blocks` `-l, --limit` |\r\n| `info` | `-c, --code` `-t, --test` `-b, --blocks` |\r\n| `compose` | - |\r\n| `doctor` | `-p, --path` |\r\n| `deploy` | `-n, --network` `--verify` `--no-compile` `-y, --yes` |\r\n| `test` | `--keep` `-y, --yes` |\r\n\r\n![](\"https://img.shields.io/badge/◆_Quick_Start-FFD966?style=flat-square\"){kind=icon}
\r\n\r\n### ▎Installation\r\n\r\n**▸ Option A: Install via npm (recommended)**\r\n\r\n```bash\r\nnpm install -g @0xflydev/labz\r\n# ↑ ↑ ↑\r\n# │ │ └── Package name on npm registry\r\n# │ │\r\n# │ └── Install globally (available everywhere)\r\n# │\r\n# └── Node package manager\r\n```\r\n\r\n**▸ Option B: Build from source**\r\n\r\n```bash\r\ngit clone https://github.com/Farukest/Lab-Z.git\r\ncd Lab-Z\r\n\r\npnpm install\r\n# ↑ ↑\r\n# │ └── Download dependencies (TypeScript, FHEVM libs, Hardhat, etc.)\r\n# │\r\n# └── Package manager (npm alternative, faster)\r\n\r\npnpm build\r\n# ↑\r\n# └── Compile CLI tool and core packages (enables labz commands)\r\n```\r\n\r\n### ▎Option 1: Quick Start with `create`\r\n\r\n▸ Use `create` for ready-made, tested examples - no configuration needed:\r\n\r\n```bash\r\nlabz create --list\r\n# ↑ ↑\r\n# │ └── Show all 44 available templates grouped by category\r\n# │\r\n# └── Standalone project generator (labz = Lab-Z CLI)\r\n\r\nlabz create prediction-market my-market\r\n# ↑ ↑ ↑\r\n# │ │ └── Your project folder name\r\n# │ │\r\n# │ └── Template name (from --list)\r\n# │\r\n# └── Standalone project generator (labz = Lab-Z CLI)\r\n\r\ncd my-market && npm install && npx hardhat test\r\n# ↑ ↑ ↑\r\n# │ │ └── Run the included tests\r\n# │ │\r\n# │ └── Install dependencies\r\n# │\r\n# └── Enter your new project\r\n```\r\n\r\n↳ **What you get:** A complete standalone Hardhat project with contract, tests, and configuration.\r\n\r\n### ▎Option 2: Quick Start for Custom Build with `build`\r\n\r\n▸ Use `build` for composable contracts with modules:\r\n\r\n```bash\r\nlabz build --list-bases\r\n# ↑ ↑ ↑\r\n# │ │ └── Show 16 available base templates\r\n# │ │\r\n# │ └── Composable contract generator\r\n# │\r\n# └────── Lab-Z CLI tool\r\n\r\nlabz build --list-modules\r\n# ↑\r\n# └── Show 13 available feature modules\r\n\r\nlabz build auction my-auction --with acl/auction-sharing\r\n# ↑ ↑ ↑ ↑ ↑\r\n# │ │ │ │ └── Module name (category/name format)\r\n# │ │ │ │\r\n# │ │ │ └── Flag to add feature modules\r\n# │ │ │\r\n# │ │ └── Your project folder name\r\n# │ │\r\n# │ └── Base template name (from --list-bases)\r\n# │\r\n# └────── Lab-Z CLI tool\r\n\r\nlabz build token my-token --with acl/transient --with functions/encrypted-add\r\n# ↑ ↑\r\n# │ └── Each --with adds another module\r\n# │\r\n# └── Multiple modules can be combined\r\n```\r\n\r\n↳ **What you get:** A custom contract with selected modules injected into appropriate slots.\r\n\r\n### ▎create vs build\r\n\r\n| | `labz create` | `labz build` |\r\n|---|---|---|\r\n| **Source** | `templates/creatable/{category}/` | `templates/buildable/projects/` + `templates/buildable/modules/` |\r\n| **Format** | Ready `.sol` + `.test.ts` | `.tmpl` templates with slots |\r\n| **Modules** | No | Yes (`--with acl/transient`, `--with functions/encrypted-add`) |\r\n| **Parameters** | No | Yes (`--type euint64`, `--type euint32`) |\r\n| **Best for** | Learning, quick prototypes | Production, customization |\r\n\r\n![](\"https://img.shields.io/badge/◆_CLI_Reference-FFD966?style=flat-square\"){kind=icon}
\r\n\r\n### ▎labz create\r\n\r\n▸ Create project from standalone templates (quick start).\r\n\r\n```bash\r\nlabz create [template] [project-name] [options]\r\n\r\n -o, --output ![](\"https://img.shields.io/badge/◆_Standalone_Templates-FFD966?style=flat-square\"){kind=icon}
\r\n\r\n### ▎Categories\r\n\r\n| Category | Templates | Description |\r\n|----------|:---------:|-------------|\r\n| basics | 5 | counter, add, multiply, boolean, bitwise |\r\n| encryption | 2 | encrypt single/multiple values |\r\n| decryption | 4 | user/public decryption (single & multiple) |\r\n| acl | 1 | FHE.allow, allowThis, allowTransient |\r\n| input-proofs | 1 | input proof security |\r\n| anti-patterns | 2 | common mistakes to avoid |\r\n| handles | 4 | FHE handle lifecycle, debugging, symbolic execution |\r\n| openzeppelin | 9 | ERC7984 confidential tokens |\r\n| advanced | 16 | DeFi, gaming, voting, identity |\r\n\r\n### ▎Advanced Templates\r\n\r\n| Template | Description |\r\n|----------|-------------|\r\n| prediction-market | Polymarket-style with encrypted positions |\r\n| dark-pool | Private DEX order matching |\r\n| sealed-tender | Sealed-bid procurement |\r\n| auction | Blind auction with hidden bids |\r\n| voting | Private voting with homomorphic tallying |\r\n| quadratic-vote | Quadratic voting with encrypted credits |\r\n| lottery | Encrypted lottery with fair randomness |\r\n| dice-game | Provably fair dice |\r\n| poker | Encrypted poker hands |\r\n| mystery-box | NFT mystery box with hidden rarity |\r\n| escrow | Private escrow with dispute resolution |\r\n| token | Confidential ERC20-like token |\r\n| age-gate | Age verification without revealing |\r\n| salary-proof | Salary range proofs |\r\n| blind-match | Private preference matching |\r\n| batch-reveal | Multi-party batch reveal with single proof |\r\n\r\n![](\"https://img.shields.io/badge/◆_Composable_Templates-FFD966?style=flat-square\"){kind=icon}
\r\n\r\n### ▎Base Templates\r\n\r\n▸ 16 base templates in `templates/buildable/projects/`:\r\n\r\n| Category | Bases |\r\n|----------|-------|\r\n| Basic | counter, token, voting |\r\n| DeFi | auction, escrow, dark-pool, prediction-market |\r\n| Gaming | lottery, dice-game, mystery-box, poker |\r\n| Governance | quadratic-vote, sealed-tender |\r\n| Identity | age-gate, salary-proof, blind-match |\r\n\r\n### ▎Feature Modules\r\n\r\n▸ 13 modules in `templates/buildable/modules/`:\r\n\r\n| Category | Modules |\r\n|----------|---------|\r\n| ACL | transient, sharing, token-sharing, auction-sharing, voting-results |\r\n| Admin | ownable, roles |\r\n| Security | pausable, reentrancy |\r\n| Functions | encrypted-add, encrypted-mul, encrypted-compare |\r\n| Events | basic |\r\n\r\n### ▎Example Combinations\r\n\r\n```bash\r\nlabz build auction sealed-auction --with acl/auction-sharing --with admin/ownable\r\n# ↑ ↑ ↑ ↑\r\n# │ │ │ └── Only owner can end auction\r\n# │ │ │\r\n# │ │ └── FHE.allow() for encrypted bid sharing\r\n# │ │\r\n# │ └── Project folder name\r\n# │\r\n# └── Sealed-bid auction base template\r\n\r\nlabz build token private-erc20 --with acl/transient --with functions/encrypted-add --with admin/roles\r\n# ↑ ↑ ↑ ↑ ↑\r\n# │ │ │ │ └── Admin can mint, operator can pause\r\n# │ │ │ │\r\n# │ │ │ └── FHE.add() for balance operations\r\n# │ │ │\r\n# │ │ └── FHE.allowTransient() temporary decrypt\r\n# │ │\r\n# │ └── Project folder name\r\n# │\r\n# └── Confidential ERC20-like token\r\n\r\nlabz build voting dao-voting --with acl/voting-results --with functions/encrypted-compare\r\n# ↑ ↑ ↑ ↑\r\n# │ │ │ └── FHE.lt(), FHE.gt() for vote counting\r\n# │ │ │\r\n# │ │ └── Share encrypted results with auditors\r\n# │ │\r\n# │ └── Project folder name\r\n# │\r\n# └── Encrypted voting system\r\n\r\nlabz build counter my-counter --with functions/encrypted-mul --with security/pausable\r\n# ↑ ↑ ↑ ↑\r\n# │ │ │ └── Emergency pause for security\r\n# │ │ │\r\n# │ │ └── FHE.mul() encrypted multiplication\r\n# │ │\r\n# │ └── Project folder name\r\n# │\r\n# └── Simple encrypted counter\r\n\r\nlabz build token erc7984-defi --with acl/token-sharing --with functions/encrypted-add --with admin/roles\r\n# ↑ ↑ ↑ ↑ ↑\r\n# │ │ │ │ └── Role-based mint/burn permissions\r\n# │ │ │ │\r\n# │ │ │ └── FHE.add() for confidential transfers\r\n# │ │ │\r\n# │ │ └── OpenZeppelin ERC7984 compatible ACL sharing\r\n# │ │\r\n# │ └── Project folder name\r\n# │\r\n# └── OpenZeppelin-style confidential token base\r\n```\r\n\r\n![](\"https://img.shields.io/badge/◆_OpenZeppelin_ERC7984-FFD966?style=flat-square\"){kind=icon}
\r\n\r\n▸ Production-ready confidential contracts combining OpenZeppelin's battle-tested patterns with Zama FHEVM encryption.\r\n\r\n| Template | OpenZeppelin | FHEVM Operations |\r\n|----------|--------------|------------------|\r\n| erc7984-token | ERC7984, Ownable2Step | FHE.add, FHE.allow, FHE.isInitialized |\r\n| erc7984-wrapper | ERC7984ERC20Wrapper | FHE.asEuint64, FHE.allowTransient |\r\n| swap-erc7984-to-erc20 | Ownable, ReentrancyGuard | FHE.sub, public decryption |\r\n| swap-erc7984-to-erc7984 | ReentrancyGuard | FHE.add, FHE.sub, FHE.allowTransient |\r\n| lottery-erc7984 | Ownable, ReentrancyGuard | FHE.randEuint64, encrypted tickets |\r\n| amm-erc7984 | Ownable, ReentrancyGuard | FHE.mul, FHE.div, encrypted liquidity |\r\n| escrow-erc7984 | ReentrancyGuard | FHE.select, encrypted disputes |\r\n| prediction-market-erc7984 | Ownable, ReentrancyGuard | FHE.add, encrypted positions |\r\n| vesting-wallet | Ownable, ReentrancyGuard | euint128, encrypted schedules |\r\n\r\n### ▎Usage Examples\r\n\r\n```bash\r\nlabz create erc7984-token my-confidential-token\r\n# ↑ ↑ ↑\r\n# │ │ └── Your project folder name\r\n# │ │\r\n# │ └── OpenZeppelin ERC7984 reference implementation\r\n# │\r\n# └── Create standalone project (templates/creatable/openzeppelin/)\r\n\r\nlabz create erc7984-wrapper my-wrapper\r\n# ↑ ↑\r\n# │ └── Project name\r\n# │\r\n# └── Wrap existing ERC20 into confidential ERC7984\r\n\r\nlabz create amm-erc7984 private-amm\r\n# ↑ ↑\r\n# │ └── Project name\r\n# │\r\n# └── AMM with FHE-encrypted liquidity pools\r\n\r\ncd my-confidential-token && npm install && npx hardhat test\r\n# ↑ ↑ ↑\r\n# │ │ └── Run included tests\r\n# │ │\r\n# │ └── Install dependencies\r\n# │\r\n# └── Enter project folder\r\n```\r\n\r\n![](\"https://img.shields.io/badge/◆_Validation_Pipeline-FFD966?style=flat-square\"){kind=icon}
\r\n\r\n▸ The `build` command runs 9 validation phases before generating code:\r\n\r\n| Phase | Check |\r\n|-------|-------|\r\n| 1 | Base Compatibility |\r\n| 2 | Module Compatibility |\r\n| 3 | Dependency Resolution |\r\n| 4 | Slot Validation |\r\n| 5 | Type Validation |\r\n| 6 | Name Collision |\r\n| 7 | Exclusivity |\r\n| 8 | Size Estimation |\r\n| 9 | Semantic Conflicts |\r\n\r\n```bash\r\n# Check before building\r\nlabz build token my-token --with admin/roles --with security/reentrancy --check\r\n```\r\n\r\n![](\"https://img.shields.io/badge/◆_Playground-FFD966?style=flat-square\"){kind=icon}
\r\n\r\n▸ Copy-paste examples for quick testing after cloning the repo.\r\n\r\n\r\n\r\n### ▎Quick Create Examples\r\n\r\n**Encrypted Counter**\r\n```bash\r\nlabz create counter my-counter\r\n```\r\n\r\n**Blind Auction**\r\n```bash\r\nlabz create auction my-auction\r\n```\r\n\r\n**Private Voting**\r\n```bash\r\nlabz create voting my-voting\r\n```\r\n\r\n\r\n\r\n
\r\n\r\n### ▎OpenZeppelin + FHE Examples\r\n\r\n**ERC7984 Confidential Token**\r\n```bash\r\nlabz create erc7984-token my-token\r\n```\r\n\r\n**ERC20 to ERC7984 Wrapper**\r\n```bash\r\nlabz create erc7984-wrapper my-wrapper\r\n```\r\n\r\n**Confidential AMM**\r\n```bash\r\nlabz create amm-erc7984 my-amm\r\n```\r\n\r\n\r\n\r\n
\r\n\r\n### ▎Custom Build Examples\r\n\r\n**Auction + FHE Sharing + Owner**\r\n```bash\r\nlabz build auction my-sealed-auction --with acl/auction-sharing --with admin/ownable\r\n```\r\n\r\n**Token + Encrypted Transfers + Roles**\r\n```bash\r\nlabz build token my-private-token --with acl/transient --with functions/encrypted-add --with admin/roles\r\n```\r\n\r\n**Voting + FHE Compare + Results**\r\n```bash\r\nlabz build voting my-dao-vote --with functions/encrypted-compare --with acl/voting-results\r\n```\r\n\r\n\r\n\r\n### ▎Run & Test\r\n\r\n```bash\r\ncd my-counter && npm install && npx hardhat test\r\n```\r\n\r\n### ▎Output Structure\r\n\r\n▸ Each command creates a folder with:\r\n\r\n| File | Description |\r\n|------|-------------|\r\n| `contracts/*.sol` | Solidity contract with FHE |\r\n| `test/*.test.ts` | Hardhat test file |\r\n| `hardhat.config.ts` | Pre-configured for FHEVM |\r\n| `package.json` | Dependencies ready |\r\n\r\n
![](\"https://img.shields.io/badge/◆_Project_Structure-FFD966?style=flat-square\"){kind=icon}
\r\n\r\n```\r\nLab-Z/\r\n├── packages/\r\n│ ├── core/ # Template engine, registry, search\r\n│ ├── cli/ # Command-line interface\r\n│ └── web/ # Web UI (Next.js)\r\n│\r\n├── base-template/ # Hardhat project skeleton\r\n│\r\n├── templates/\r\n│ ├── creatable/ # For `labz create` (44 standalone)\r\n│ │ ├── basics/ # counter, add, multiply, boolean, bitwise\r\n│ │ ├── encryption/ # single, multiple\r\n│ │ ├── decryption/ # user-single, user-multiple, public-single, public-multiple\r\n│ │ ├── acl/ # allow demo\r\n│ │ ├── input-proofs/ # input proof security\r\n│ │ ├── anti-patterns/ # common mistakes\r\n│ │ ├── handles/ # handle lifecycle, debugging\r\n│ │ ├── openzeppelin/ # ERC7984 examples\r\n│ │ └── advanced/ # DeFi, gaming, voting, identity\r\n│ │\r\n│ ├── buildable/ # For `labz build` (16 + 13)\r\n│ │ ├── projects/ # 16 base templates (.tmpl)\r\n│ │ └── modules/ # 13 feature modules\r\n│ │ ├── acl/\r\n│ │ ├── admin/\r\n│ │ ├── security/\r\n│ │ ├── functions/\r\n│ │ └── events/\r\n│ │\r\n│ └── _test/ # Development test environment\r\n│\r\n├── scripts/\r\n│ └── generate-docs.ts # GitBook documentation generator\r\n│\r\n└── docs/ # Generated documentation\r\n```\r\n\r\n![](\"https://img.shields.io/badge/◆_Test_Coverage-FFD966?style=flat-square\"){kind=icon}
\r\n\r\n```bash\r\ncd templates/_test\r\nnpm install\r\nnpx hardhat test\r\n```\r\n\r\n![](\"https://img.shields.io/badge/◆_Documentation-FFD966?style=flat-square\"){kind=icon}
\r\n\r\n```bash\r\n# Generate GitBook-compatible docs\r\nnpm run docs:generate\r\n```\r\n\r\n↳ Output in `docs/examples/` with `SUMMARY.md` for navigation.\r\n\r\n![](\"https://img.shields.io/badge/◆_Development-FFD966?style=flat-square\"){kind=icon}
\r\n\r\n### ▎Prerequisites\r\n\r\n- Node.js 18+\r\n- pnpm 8+\r\n\r\n### ▎Setup\r\n\r\n```bash\r\npnpm install\r\npnpm build\r\n```\r\n\r\n### ▎Adding Templates\r\n\r\n**Standalone template (for create):**\r\n```\r\ntemplates/creatable/{category}/{name}/\r\n├── {Name}.sol\r\n├── {Name}.test.ts\r\n└── meta.json\r\n```\r\n\r\n**Composable template (for build):**\r\n```\r\ntemplates/buildable/projects/{name}/\r\n├── contracts/{Name}.sol.tmpl\r\n├── test/{Name}.test.ts.tmpl\r\n└── meta.json\r\n\r\ntemplates/buildable/modules/{category}/{name}/\r\n├── meta.json\r\n└── inject/\r\n```\r\n\r\n![](\"https://img.shields.io/badge/◆_References-FFD966?style=flat-square\"){kind=icon}
\r\n\r\n- [Zama FHEVM Documentation](https://docs.zama.ai/fhevm)\r\n- [FHEVM Hardhat Template](https://github.com/zama-ai/fhevm-hardhat-template)\r\n- [OpenZeppelin Confidential Contracts](https://github.com/OpenZeppelin/openzeppelin-confidential-contracts)\r\n\r\n![](\"https://img.shields.io/badge/◆_Implementation_Status-FFD966?style=flat-square\"){kind=icon}
\r\n\r\n### Project Structure and Simplicity\r\n\r\n| Requirement | Implementation | Status |\r\n|-------------|----------------|--------|\r\n| Use only Hardhat | All templates use Hardhat | Complete |\r\n| One repo per example | CLI generates standalone projects | Complete |\r\n| Keep each repo minimal | contracts/, test/, hardhat.config.ts | Complete |\r\n| Shared base-template | base-template/ directory | Complete |\r\n| Generate documentation | scripts/generate-docs.ts | Complete |\r\n\r\n### Scaffolding and Automation\r\n\r\n| Requirement | Implementation | Status |\r\n|-------------|----------------|--------|\r\n| CLI tool (create-fhevm-example) | labz create, labz build | Complete |\r\n| Clone and customize template | packages/cli/src/commands/create.ts | Complete |\r\n| Insert contract into contracts/ | Automatic during generation | Complete |\r\n| Generate matching tests | Every template includes tests | Complete |\r\n| Auto-generate docs from annotations | scripts/generate-docs.ts with meta.json | Complete |\r\n\r\n### Required Example Templates\r\n\r\n| Category | Requirement | Template | Status |\r\n|----------|-------------|----------|--------|\r\n| Basic | Simple FHE counter | basics/counter | Complete |\r\n| Basic | Arithmetic (FHE.add, FHE.sub) | basics/add | Complete |\r\n| Basic | Equality comparison (FHE.eq) | basics/boolean | Complete |\r\n| Encryption | Encrypt single value | encryption/single | Complete |\r\n| Encryption | Encrypt multiple values | encryption/multiple | Complete |\r\n| Decryption | User decrypt single | decryption/user-single | Complete |\r\n| Decryption | User decrypt multiple | decryption/user-multiple | Complete |\r\n| Decryption | Public decrypt single | decryption/public-single | Complete |\r\n| Decryption | Public decrypt multiple | decryption/public-multiple | Complete |\r\n| Access Control | FHE.allow | acl/allow | Complete |\r\n| Access Control | FHE.allowTransient | Included in acl templates | Complete |\r\n| Input Proofs | Explanation and usage | input-proofs/ | Complete |\r\n| Anti-patterns | View functions with encrypted | anti-patterns/view-encrypted | Complete |\r\n| Anti-patterns | Missing FHE.allowThis | anti-patterns/missing-allow | Complete |\r\n| Handles | Handle lifecycle | handles/journey | Complete |\r\n| Handles | Symbolic execution | handles/symbolic-execution | Complete |\r\n| OpenZeppelin | ERC7984 example | openzeppelin/erc7984-token | Complete |\r\n| OpenZeppelin | ERC7984 to ERC20 Wrapper | openzeppelin/erc7984-wrapper | Complete |\r\n| OpenZeppelin | Swap ERC7984 to ERC20 | openzeppelin/swap-erc7984-to-erc20 | Complete |\r\n| OpenZeppelin | Swap ERC7984 to ERC7984 | openzeppelin/swap-erc7984-to-erc7984 | Complete |\r\n| OpenZeppelin | Vesting Wallet | openzeppelin/vesting-wallet | Complete |\r\n| Advanced | Blind auction | advanced/auction | Complete |\r\n\r\n### Additional Implementations\r\n\r\n| Category | Template | Description |\r\n|----------|----------|-------------|\r\n| Advanced | batch-reveal | Multi-party batch reveal with single proof verification |\r\n| Advanced | prediction-market | Polymarket-style encrypted positions |\r\n| Advanced | dark-pool | Private DEX order matching |\r\n| Advanced | sealed-tender | Sealed-bid procurement system |\r\n| Advanced | quadratic-vote | Quadratic voting with encrypted credits |\r\n| Advanced | lottery | Encrypted lottery with fair randomness |\r\n| Advanced | dice-game | Provably fair dice game |\r\n| Advanced | poker | Encrypted poker hands |\r\n| Advanced | mystery-box | NFT mystery box with hidden rarity |\r\n| Advanced | escrow | Private escrow with dispute resolution |\r\n| OpenZeppelin | amm-erc7984 | AMM with confidential liquidity |\r\n| OpenZeppelin | escrow-erc7984 | Confidential escrow with ERC7984 |\r\n| OpenZeppelin | prediction-market-erc7984 | Prediction market with private bets |\r\n| OpenZeppelin | lottery-erc7984 | Lottery using ERC7984 tokens |\r\n\r\n### FHE Operations Coverage\r\n\r\n| Operation | Templates Using It |\r\n|-----------|-------------------|\r\n| FHE.asEuint64 | All encryption templates |\r\n| FHE.add | basics/add, token, escrow |\r\n| FHE.sub | basics/add, token |\r\n| FHE.mul | basics/multiply |\r\n| FHE.lt, FHE.gt, FHE.eq | basics/boolean, voting, auction |\r\n| FHE.select | auction, voting, quadratic-vote |\r\n| FHE.allow | acl/allow, all decryption templates |\r\n| FHE.allowThis | All templates with storage |\r\n| FHE.allowTransient | acl/allow, token templates |\r\n| FHE.makePubliclyDecryptable | All public decryption templates |\r\n| FHE.checkSignatures | All public decryption templates |\r\n| FHE.fromExternal | All templates with input proofs |\r\n| FHE.randEuint64 | lottery, dice-game, mystery-box |\r\n\r\n### Documentation Strategy\r\n\r\n| Requirement | Implementation |\r\n|-------------|----------------|\r\n| JSDoc/TSDoc comments in tests | All test files include detailed comments |\r\n| Auto-generate markdown per repo | scripts/generate-docs.ts creates 44 markdown files |\r\n| Tag examples into docs | meta.json with tags, categories, blocks |\r\n| GitBook-compatible | docs/SUMMARY.md, docs/examples/*.md |\r\n\r\n![](\"https://img.shields.io/badge/◆_License-FFD966?style=flat-square\"){kind=icon}
\r\n\r\nMIT License\r\n\r\n\r\n