Merge remote-tracking branch 'origin/main' into develop/patch-3

Author: SlayeR6889

docs/api-reference/index.md

@@ -9,6 +9,6 @@ sidebar_position: 1
 
 # API Reference
 
-import UnderProgress from '@site/src/components/Docs/under-progress.js';
+import UnderProgress from '@site/src/components/docs/under-progress.js';
 
 <UnderProgress />

docs/develop/contribute.md

@@ -9,6 +9,6 @@ sidebar_position: 5
 
 # Contribute
 
-import UnderProgress from '@site/src/components/Docs/under-progress.js';
+import UnderProgress from '@site/src/components/docs/under-progress.js';
 
 <UnderProgress />

docs/develop/exercise/hands-on-fhevm.md

@@ -0,0 +1,53 @@
+---
+id: compiling-and-deploying
+title: Compiling and Deploying
+description: compile and deploy FHE-enabled Solidity contracts
+slug: /develop/exercise/hands-on-fhevm/compiling-and-deploying
+hide_table_of_contents: false
+sidebar_position: 4
+---
+
+# Compiling and Deploying fhEVM Smart Contracts
+
+This guide provides instructions on compiling and deploying Fully Homomorphic Encryption Virtual Machine (fhEVM) smart contracts. These contracts operate in an environment where data remains encrypted, offering enhanced privacy.
+
+If you are new to blockchain development, **learn the basics of compiling, deploying, and interacting with standard Ethereum smart contracts first**. There are many tutorials online that explain these foundational concepts, which will make it easier to understand fhEVM development.
+
+The template repository contains pre-written codes for compilation and deployment, along with sample contracts. Follow the steps below to get started.
+
+---
+
+## fhEVM Smart Contracts
+
+The compilation code uses the Solidity compiler (`solc`) to compile smart contracts and extract their ABI and bytecode. It also handles special import resolutions required for fhEVM contracts.
+
+### Steps to Compile and Deploy
+
+1. Ensure your contract file is placed in the `contracts/` directory.
+2. Navigate to `contract-deploy.js` and search for the `contractName` variable, then replace its value with the name of your desired contract.
+
+### Output
+
+The compiled ABI is stored in the `build/` directory. For example:
+
+- ABI: `build/<ContractName>.json`
+- Bytecode: Generated and used internally by the deployment script.
+
+**Note**: The script automatically resolves imports from `node_modules/`.
+
+### Deployment of fhEVM Smart Contracts
+
+The deployment process requires:
+
+- A JSON-RPC endpoint of the fhEVM-compatible network.
+- A private key for deploying the contract.
+- The compiled contract file (from the `build/` directory).
+- Constructor arguments (if any).
+
+The `contract-deploy.js` script includes a function call that deploys your contract using a **_test private key_** derived from the mnemonic provided in the `.env` file.
+
+---
+
+## What's Next?
+
+Let's continue to writing fhEVM smart contracts. Move on to the **[Writing Smart Contracts](./writing-smart-contract.md)** section to learn more.

docs/develop/exercise/hands-on-fhevm/compiling-and-deploying.md

@@ -0,0 +1,190 @@
+---
+id: index
+title: Hands-on fhEVM
+description: --
+slug: /develop/exercise/hands-on-fhevm
+hide_table_of_contents: false
+sidebar_position: 1
+---
+
+# Hands-on fhEVM
+
+This hands-on guide will walk you through **understanding, setting up, and working with fhEVM** to develop encrypted smart contracts and test them on fhEVM network.
+
+### What You’ll Learn
+
+- Basics of fhEVM and its architecture.
+- Setting up a local fhEVM development environment.
+- Writing, compiling, and deploying FHE-enabled Solidity contracts.
+- Testing encrypted contract interactions.
+
+---
+
+## **1. Understanding fhEVM**
+
+fhEVM is a **privacy-first smart contract platform** that allows computations on encrypted data **without decryption**. This ensures **on-chain privacy** while maintaining **verifiability and interoperability**.
+
+### **Core Principles**
+
+1. **Security**: No compromise on blockchain security.
+2. **Public Verifiability**: Confidential yet verifiable computations.
+3. **Developer-Friendly**: Familiar Solidity tools.
+4. **Composability**: Interoperable confidential and public contracts.
+
+### **Key Features**
+
+- **Encrypted Data Types**: `ebool`, `euintX`, `eaddress`, `ebytesX`, etc.
+- **Homomorphic Computation**: Arithmetic on encrypted numbers.
+- **Confidential Transactions**: Data remains encrypted even on-chain.
+- **EVM-Compatible**: Supports Solidity with added FHE functionalities.
+
+### **Encrypted Data Types**
+
+fhEVM introduces special encrypted types for secure computations:
+
+- **Booleans**: `ebool`
+- **Integers**: `euint4`, `euint8`, ... `euint256`
+- **Addresses**: `eaddress`
+- **Bytes**: `ebytes64`, `ebytes128`, `ebytes256`
+- **Inputs**: `einput`
+
+### **Type Casting**
+
+fhEVM provides utility functions to convert between encrypted types:
+
+- `TFHE.asEbool(value)`: Converts a boolean to an encrypted boolean.
+- `TFHE.asEuintX(value)`: Converts an integer to an encrypted integer.
+- `TFHE.asEaddress(value)`: Converts an address to an encrypted address.
+
+fhEVM empowers secure and efficient computation on encrypted data while preserving blockchain functionality.
+
+---
+
+## 2. **fhEVM Architecture**
+
+### **Core Components**
+
+fhEVM consists of several **interdependent components**:
+
+- **Smart Contracts**: Interact with encrypted data to execute logic securely on the blockchain.
+- **fhEVM-native**: On-chain processing that handles homomorphic computations on ciphertexts using evaluation keys.
+- **Key Management System (KMS)**: Safeguards private keys for decryption and re-encryption processes.
+- **Gateway**: Acts as a bridge between the blockchain and the KMS, enabling secure operations like decryption and re-encryption.
+- **Connector**: A service that connects the gateway to the KMS.
+- **Gateway Store**: A service that stores ciphertexts.
+- **fhEVM.js Library**: Facilitates client-side interactions such as encryption, decryption, and re-encryption.
+
+---
+
+### **End-to-End Confidentiality**
+
+fhEVM ensures that:
+
+- **Plaintext data is never exposed** during processing or transmission.
+- **Homomorphic computations** enable complex operations on encrypted data.
+- **Secure re-encryption** allows sharing and interoperability without compromising privacy.
+
+This **tightly integrated architecture** supports **decentralized applications (dApps)** requiring privacy-preserving operations, paving the way for **more secure and trustless systems**.
+
+For more detailed insights, you can refer to the **[official documentation by Zama](https://docs.zama.ai/fhevm)**.
+
+---
+
+### **What's Next?**
+
+Now that you understand the **fhEVM architecture**, let's set up an **fhEVM network**.
+➡ Move on to **[Network Setup](./setting-up-network.md)** to learn how to proceed.
+
+
+<!--
+## **3. Setting Up Your Development Environment**
+
+Before writing encrypted contracts, install the necessary tools.
+
+### **Prerequisites**
+
+✔ **Go** (`v1.23.x` or later)
+✔ **Docker** (`v26.x.x` or later)
+✔ **Node.js** (`v20.x` or later)
+
+📖 **[Full Setup Guide](./preparation.md)**
+
+---
+
+## **4. Deploying fhEVM Network**
+
+We will **set up a local fhEVM test network** using Docker.
+
+### **Start the Network**
+
+```bash
+make run-full
+```
+
+### **Fund Accounts**
+
+```bash
+npm run fund
+```
+
+### **Deploy Core Contracts**
+
+```bash
+npm run core
+```
+
+📖 **[Full Network Setup Guide](./setting-up-network.md)**
+
+---
+
+## **5. Writing and Deploying Encrypted Smart Contracts**
+
+fhEVM supports **Fully Homomorphic Encryption (FHE)** within Solidity contracts.
+
+### **Key Contract Operations**
+
+✔ **EncryptedERC20**: Secure token minting, transfer, and approvals.
+✔ **Homomorphic Computation**: Arithmetic on encrypted balances.
+✔ **Decryption via Gateway**: Interact with KMS securely.
+
+📖 **[Writing Smart Contracts](./writing-smart-contract.md)**
+📖 **[Deploying Smart Contracts](./compiling-and-deploying.md)**
+
+---
+
+## **6. Testing Encrypted Contracts**
+
+To validate your contracts, write **JavaScript-based tests** using `ethers.js`.
+
+### **Example Test Cases**
+
+✔ **Minting Tokens**
+✔ **Encrypted Transfers**
+✔ **Encrypted Approvals**
+✔ **Balance Decryption**
+
+📖 **[Writing Test Files](./writing-contract-test-files.md)**
+
+---
+
+## **7. Conclusion**
+
+By completing this hands-on guide, you now understand:
+
+- **How fhEVM works** and how it enables privacy in smart contracts.
+- **How to set up and deploy an encrypted EVM-compatible network**.
+- **How to write and test FHE-enabled Solidity contracts**.
+
+### **Next Steps**
+
+🔹 Explore **advanced encrypted contract interactions**.
+🔹 Contribute to **fhEVM projects and research**.
+🔹 Learn more from **[Zama’s Official Documentation](https://docs.zama.ai/fhevm)**.
+
+📖 **[Final Thoughts & Summary](./08-conclusion.md)**
+
+---
+
+## **🚀 Ready to Build?**
+
+You’re now equipped with the **fundamentals of fhEVM**. Start experimenting with your own encrypted smart contracts and push the boundaries of **on-chain privacy**! -->

docs/develop/exercise/hands-on-fhevm/index.md

@@ -0,0 +1,94 @@
+---
+id: prerequisites
+title: Prerequisites
+description: This guide walks you through configuring your development setup, ensuring seamless interaction with the fhEVM network for encrypted smart contract execution
+slug: /develop/exercise/hands-on-fhevm/prerequisites
+hide_table_of_contents: false
+sidebar_position: 2
+---
+
+# Prerequisites
+
+Here are the prerequisites to set up your development environment for working with **fhEVM**.
+
+Before proceeding, ensure your system meets the following requirements:
+
+- **Operating System**: Linux, macOS, or Windows with WSL2
+- **Go**: Version `v1.23.x` or higher
+- **Docker**: Version `v26.x.x` or higher
+- **Node.js**: Node.js `v20.x` or higher
+
+---
+
+## Step 1: Install Go
+
+1. Visit the [Go Downloads Page](https://go.dev/dl/) and download the installer for your operating system.
+2. Follow the installation instructions specific for your OS.
+3. Verify the installation by running the following command:
+
+   ```bash
+   go version
+   ```
+
+   You should see the installed Go version in the output.
+
+---
+
+## Step 2: Install Docker
+
+1. Follow the official Docker installation guide for your operating system:
+   - [Install Docker on Linux](https://docs.docker.com/engine/install/)
+   - [Install Docker on macOS](https://docs.docker.com/docker-for-mac/install/)
+2. After installation, verify Docker is installed correctly:
+
+   ```bash
+   docker --version
+   ```
+
+   You should see the installed Docker version in the output.
+
+3. Ensure Docker can run without `sudo` (Linux users only):
+
+   ```bash
+   sudo groupadd docker
+   sudo usermod -aG docker $USER
+   newgrp docker
+   ```
+
+   Verify it works:
+
+   ```bash
+   docker run hello-world
+   ```
+
+---
+
+## Step 3: Install Docker Compose Plugin
+
+1. Follow the official Docker Compose plugin installation guide for your operating system:
+   - [Install Docker Compose Plugin on Linux](https://docs.docker.com/compose/install/linux/)
+   - [Install Docker Compose Plugin on macOS](https://docs.docker.com/compose/install/mac/)
+2. After installation, verify Docker Compose plugin is installed correctly:
+
+   ```bash
+   docker compose version
+   ```
+
+   You should see the installed Docker Compose plugin version in the output.
+
+---
+
+## Step 4: Install Node.js
+
+1. Install Node.js and npm using the official guide for your operating system: [Node.js Downloads](https://nodejs.org/en/download/)
+
+   - Select the **LTS** version for better stability.
+
+2. Verify the installation by running the following commands:
+
+   ```bash
+   node -v
+   npm -v
+   ```
+
+   These should output the installed Node.js and npm versions.