Official documentation for Fhenix - the privacy-preserving blockchain platform that enables developers to build confidential smart contracts using Fully Homomorphic Encryption (FHE).
This repository contains the complete developer documentation for Fhenix, including:
- Get Started - Introduction to Fhenix and CoFHE, compatibility, support, and builder programs
- Client SDK -
@cofhe/sdkfor encrypting inputs, managing Access Control Permissions, and decrypting outputs, plus the Hardhat and Foundry plugins - FHE library -
FHE.sol, the Solidity library for working with encrypted data in smart contracts - Tutorials - Step-by-step guides for building FHE-enabled applications
- Deep Dive - Technical architecture details, CoFHE components, and data flows
This documentation is built using Mintlify. To preview the documentation locally:
Install the Mintlify CLI:
npm i -g mintRun the following command at the root of the documentation directory:
mint devThe documentation will be available at http://localhost:3000.
fhenix-developer-docs/
├── get-started/ # Introduction and getting started guides
├── client-sdk/ # @cofhe/sdk, Hardhat plugin, and Foundry plugin docs
├── fhe-library/ # Solidity FHE library documentation
├── tutorials/ # Step-by-step tutorials
├── deep-dive/ # Architecture and technical deep dives
├── images/ # Images referenced from pages
├── scripts/ # Structure linter (lint-docs.py)
├── styles/ # Vale prose rules
├── STYLE.md # Writing style guide, binding for all pages
└── docs.json # Mintlify configuration
Changes pushed to the default branch are automatically deployed to production through the Mintlify GitHub app integration.
We welcome contributions to improve the documentation. When making changes:
- Read
STYLE.mdbefore writing; it is binding for all pages - Test locally using
mint dev - Run the linters on the pages you changed:
python3 scripts/lint-docs.py <files>andvale <files> - Ensure all links and navigation work correctly
- Submit a pull request with a clear description of your changes
- If your dev environment isn't running: Run
mint updateto ensure you have the most recent version of the CLI - If a page loads as a 404: Make sure you are running in the folder with
docs.json
For questions and support:
- Join our Telegram Support Channel
- Visit our Discord
- Check the Support and Feedback documentation