Skip to content

Latest commit

 

History

History
73 lines (55 loc) · 2.22 KB

README.md

File metadata and controls

73 lines (55 loc) · 2.22 KB

Hands-on fhEVM

Welcome to the Hands-on fhEVM guide! 🚀

This repository provides a step-by-step guide to setting up your own fhEVM network and deploying fhEVM smart contracts. Follow the instructions below to get started.

📖 Overview

fhEVM (Fully Homomorphic Encryption Virtual Machine) enables encrypted computation on blockchain smart contracts. This guide walks you through the setup process, from network initialization to contract deployment and testing.

📂 Table of Contents

  1. Basics
  2. Architecture Overview
  3. Preparation
  4. Setting Up Network
  5. Compiling and Deploying
  6. Writing Smart Contracts
  7. Writing Contract Test Files
  8. Conclusion

🛠️ Installation

Prerequisites

Ensure you have the following installed:

  • Node.js (>=20)
  • Docker (>=24) with docker compose plugin

Setup

Clone the repository and install dependencies:

git clone https://github.com/airchains-network/hands-on-fhevm.git
cd hands-on-fhevm
npm install

Environment Configuration

Create an .env file and configure the necessary environment variables:

cp .env.example .env

Running the Network

Follow the instructions in Setting Up Network to start the network, then proceed through the remaining documentation to learn how to deploy and interact with smart contracts.

🤝 Contributing

We welcome contributions! To contribute:

  1. Fork the repository.
  2. Create a feature branch: 
    git checkout -b feature/feature-name/patch-${version}
  3. Commit your changes: 
    git commit -m "Description of changes"
  4. Push to your branch: 
    git push origin feature/feature-name/patch-${version}
  5. Open a Pull Request.

📬 Feedback and Support

If you have any feedback or encounter any issues, feel free to:

📜 License

This project is licensed under the MIT License.