README - Fhevm — ContextQMD

This section contains comprehensive guides and examples for using OpenZeppelin's confidential smart contracts library with FHEVM. The library provides contracts and utilities that utilize the FHE (Fully Homomorphic Encryption) capabilities of the Zama Protocol to perform confidential transactions.

The library includes the ERC7984 confidential fungible token standard, an ERC20-to-ERC7984 wrapper, confidential vesting wallets, and encrypted voting utilities. See the official OpenZeppelin documentation for more details.

Getting Started

This guide will help you set up a development environment for working with OpenZeppelin's confidential contracts and FHEVM.

Prerequisites

Before you begin, ensure you have the following installed:

Node.js >= 20
Hardhat ^2.24
Access to an FHEVM-enabled network and the Zama gateway/relayer

Project Setup

Clone the FHEVM Hardhat template repository:

bash

git clone https://github.com/zama-ai/fhevm-hardhat-template conf-token
cd conf-token

Install project dependencies:
bash
```
npm ci
```
Install OpenZeppelin's confidential contracts library:
bash
```
npm i @openzeppelin/confidential-contracts
```
Compile the contracts:
bash
```
npm run compile
```
Run the test suite:
bash
```
npm test
```

Available Guides

Explore the following guides to learn how to implement confidential contracts using OpenZeppelin's library:

ERC7984 Standard - Learn about the ERC7984 standard for confidential tokens
ERC-20 to Wrapped ERC-7984 - Wrap ERC-20 tokens into confidential ERC-7984 tokens
Swap ERC7984 to ERC20 - Unwrap confidential tokens back to ERC-20
Vesting Wallet - Implement confidential token vesting mechanisms