@0xflydev/labz

Composable Template System for Privacy-Preserving Smart Contracts

Stop writing FHE boilerplate from scratch.

Generate production ready encrypted smart contracts in seconds with a single CLI command.

Choose from 44 standalone templates or compose custom contracts with 16 bases + 13 modules.

$3

▸ Lab-Z provides two ways to generate FHE smart contracts:

| Command | Use Case | Templates |
|---------|----------|-----------|
| labz create | Quick start with ready-made examples | 44 standalone templates |
| labz build | Custom contracts with composable modules | 16 bases + 13 modules |

$3

- 44 standalone templates across 9 categories (basics, encryption, decryption, acl, input-proofs, anti-patterns, handles, openzeppelin, advanced)
- 16 composable base templates for DeFi, gaming, voting, and identity
- 13 feature modules for ACL, admin, security, and FHE operations
- 9 OpenZeppelin ERC7984 + FHEVM production-ready confidential contracts
- 9-phase validation pipeline preventing incompatible module combinations
- CLI with 9 commands, interactive mode, and visual composer

$3

| Command | Options |
|---------|---------|
| create | -i, --interactive --git --install --open -o, --output -l, --list -y, --yes |
| build | -i, --interactive -w, --with -t, --type --list-bases --list-modules --check --preview --dry-run -o, --output -y, --yes |
| list | -c, --category -d, --difficulty -t, --tag |
| search | -c, --category -d, --difficulty -b, --blocks -l, --limit |
| info | -c, --code -t, --test -b, --blocks |
| compose | - |
| doctor | -p, --path |
| deploy | -n, --network --verify --no-compile -y, --yes |
| test | --keep -y, --yes |

$3

▸ Option A: Install via npm (recommended)

``

bash

npm install -g @0xflydev/labz

     ↑    ↑        ↑

     │    │        └── Package name on npm registry

     │    │

     │    └── Install globally (available everywhere)

     │

     └── Node package manager





▸ Option B: Build from source

bash

git clone https://github.com/Farukest/Lab-Z.git

cd Lab-Z



pnpm install

 ↑     ↑

 │     └── Download dependencies (TypeScript, FHEVM libs, Hardhat, etc.)

 │

 └── Package manager (npm alternative, faster)



pnpm build

     ↑

     └── Compile CLI tool and core packages (enables labz commands)





$3



▸ Use

create

 for ready-made, tested examples - no configuration needed:

bash

labz create --list

     ↑       ↑

     │       └── Show all 44 available templates grouped by category

     │

     └── Standalone project generator (labz = Lab-Z CLI)



labz create prediction-market my-market

     ↑           ↑              ↑

     │           │              └── Your project folder name

     │           │

     │           └── Template name (from --list)

     │

     └── Standalone project generator (labz = Lab-Z CLI)



cd my-market && npm install && npx hardhat test

    ↑              ↑               ↑

    │              │               └── Run the included tests

    │              │

    │              └── Install dependencies

    │

    └── Enter your new project





↳ What you get: A complete standalone Hardhat project with contract, tests, and configuration.



$3



▸ Use

build

 for composable contracts with modules:

bash

labz build --list-bases

 ↑    ↑        ↑

 │    │        └── Show 16 available base templates

 │    │

 │    └── Composable contract generator

 │

 └────── Lab-Z CLI tool



labz build --list-modules

             ↑

             └── Show 13 available feature modules



labz build auction my-auction --with acl/auction-sharing

   ↑       ↑         ↑        ↑          ↑

   │       │         │        │          └── Module name (category/name format)

   │       │         │        │

   │       │         │        └── Flag to add feature modules

   │       │         │

   │       │         └── Your project folder name

   │       │

   │       └── Base template name (from --list-bases)

   │

   └────── Lab-Z CLI tool



labz build token my-token --with acl/transient --with functions/encrypted-add

                           ↑                          ↑

                           │                          └── Each --with adds another module

                           │

                           └── Multiple modules can be combined





↳ What you get: A custom contract with selected modules injected into appropriate slots.



$3



| |

labz create | labz build

 |

|---|---|---|

| Source |

templates/creatable/{category}/ | templates/buildable/projects/ + templates/buildable/modules/

 |

| Format | Ready

.sol + .test.ts | .tmpl

 templates with slots |

| Modules | No | Yes (

--with acl/transient, --with functions/encrypted-add

) |

| Parameters | No | Yes (

--type euint64, --type euint32

) |

| Best for | Learning, quick prototypes | Production, customization |













$3



$3



▸ Create project from standalone templates (quick start).

bash

labz create [template] [project-name] [options]



  -o, --output

    # Output directory (default: current)

  -l, --list            # List available templates

  -y, --yes             # Skip prompts

  -i, --interactive     # Interactive mode with template selection

  --git                 # Initialize git repository

  --install             # Run npm install after creation

  --open                # Open project in VS Code





Examples:

bash

labz create --list                              # Show all 44 templates

labz create counter my-counter -y               # Quick create, skip prompts

labz create -i                                  # Interactive template selection

labz create auction my-auction --git --install  # Full setup with git + deps





$3



▸ Build custom contracts with composable modules.

bash

labz build [base] [project-name] [options]



  -w, --with     # Feature modules to include

  #    ↑

  #    └── Example: labz build auction my-auction --with acl/transient -w admin/roles

  #    └── Explanation: Add FHE or admin modules to customize your contract



  -t, --type           # Encrypted type (euint8, euint32, euint64)

  #    ↑

  #    └── Example: labz build token my-token --type euint64

  #    └── Explanation: Set the encrypted integer size for FHE operations



  -o, --output

         # Output directory

  #    ↑

  #    └── Example: labz build auction my-auction --output ./my-projects

  #    └── Explanation: Generate project in a custom folder instead of current directory



  --list-bases               # List available base templates

  #    ↑

  #    └── Example: labz build --list-bases

  #    └── Explanation: See all 16 base templates (auction, token, voting, etc.)



  --list-modules             # List available modules

  #    ↑

  #    └── Example: labz build --list-modules

  #    └── Explanation: See all 13 modules grouped by category (acl, admin, functions, etc.)



  --check                    # Validate compatibility without generating

  #    ↑

  #    └── Example: labz build auction my-auction --with acl/transient --check

  #    └── Explanation: Test if your module combination is valid before generating



  --preview                  # Preview generated code

  #    ↑

  #    └── Example: labz build auction my-auction --with acl/transient --preview

  #    └── Explanation: See the generated Solidity code without creating files



  --dry-run                  # Show files without creating

  #    ↑

  #    └── Example: labz build auction my-auction --dry-run

  #    └── Explanation: List files that would be created without actually writing them



  -i, --interactive          # Interactive module selection

  #    ↑

  #    └── Example: labz build auction my-auction -i

  #    └── Explanation: Choose modules from a menu instead of typing --with flags



  -y, --yes                  # Skip prompts

  #    ↑

  #    └── Example: labz build auction my-auction -y

  #    └── Explanation: Auto-confirm all prompts for scripting/automation





$3



▸ List and filter available templates.

bash

labz list [options]

    ↑

    └── List and filter all templates



  -c, --category       # Filter by category (basics, advanced, openzeppelin...)

  #        ↑

  #        └── Example: labz list --category advanced

  #        └── Explanation: Show only templates in the "advanced" category



  -d, --difficulty   # Filter by difficulty (beginner, intermediate, advanced)

  #         ↑

  #         └── Example: labz list --difficulty beginner

  #         └── Explanation: Filter templates by learning curve level



  -t, --tag         # Filter by tags

  #      ↑

  #      └── Example: labz list --tag defi privacy

  #      └── Explanation: Find templates tagged with specific keywords





$3



▸ Search templates by keyword.

bash

labz search  [options]

     ↑       ↑

     │       └── Search term (e.g., "encrypted voting", "auction")

     │

     └── Search templates by keyword



  -c, --category       # Filter by category

  #      ↑

  #      └── Example: labz search "token" -c advanced

  #      └── Explanation: Search only in a specific category



  -d, --difficulty   # Filter by difficulty

  #      ↑

  #      └── Example: labz search "voting" -d beginner

  #      └── Explanation: Search only templates of a specific difficulty



  -b, --blocks              # Include code block matches

  #      ↑

  #      └── Example: labz search "encrypted voting" -b

  #      └── Explanation: Also search inside annotated code blocks



  -l, --limit            # Limit results (default: 10)

  #      ↑

  #      └── Example: labz search "auction" -l 5

  #      └── Explanation: Return only first N matching templates





$3



▸ Show detailed template information.

bash

labz info

$3

$3

$3

$3

$3

↑ ↑ ↑

│ │ └── Package name on npm registry

│ │

│ └── Install globally (available everywhere)

│

└── Node package manager

↑ ↑

│ └── Download dependencies (TypeScript, FHEVM libs, Hardhat, etc.)

│

└── Package manager (npm alternative, faster)

↑

└── Compile CLI tool and core packages (enables labz commands)

$3

↑ ↑

│ └── Show all 44 available templates grouped by category

│

└── Standalone project generator (labz = Lab-Z CLI)

↑ ↑ ↑

│ │ └── Your project folder name

│ │

│ └── Template name (from --list)

│

└── Standalone project generator (labz = Lab-Z CLI)

↑ ↑ ↑

│ │ └── Run the included tests

│ │

│ └── Install dependencies

│

└── Enter your new project

$3

↑ ↑ ↑

│ │ └── Show 16 available base templates

│ │

│ └── Composable contract generator

│

└────── Lab-Z CLI tool

↑

└── Show 13 available feature modules

↑ ↑ ↑ ↑ ↑

│ │ │ │ └── Module name (category/name format)

│ │ │ │

│ │ │ └── Flag to add feature modules

│ │ │

│ │ └── Your project folder name

│ │

│ └── Base template name (from --list-bases)

│

└────── Lab-Z CLI tool

↑ ↑

│ └── Each --with adds another module

│

└── Multiple modules can be combined

$3

$3

$3

$3

$3

↑

└── List and filter all templates

$3

↑ ↑

│ └── Search term (e.g., "encrypted voting", "auction")

│

└── Search templates by keyword

$3

↑ ↑

│ └── Template name (e.g., auction, voting, token)

│

└── Show template details

$3

↑ ↑

│ └── Optional contract name (e.g., MyContract)

│

└── Visual contract builder with terminal UI