Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

New doc structure V2 #311

Closed
wants to merge 1 commit into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Binary file added docs/.gitbook/assets/doc header (11).png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
34 changes: 10 additions & 24 deletions docs/README.md
Original file line number Diff line number Diff line change
@@ -1,32 +1,22 @@
# Welcome to fhEVM

📙 [White paper](https://github.com/zama-ai/fhevm/blob/main/fhevm-whitepaper.pdf) | ⭐️ [Star the repo on Github](https://github.com/zama-ai/fhevm) | 📚 [FHE resources by Zama](https://github.com/zama-ai/awesome-zama) | 💬 [Community support](https://zama.ai/community) 
📙 [White paper](https://github.com/zama-ai/fhevm/blob/main/fhevm-whitepaper.pdf) | ⭐️ [Star the repo on Github](https://github.com/zama-ai/fhevm) | 📚 [FHE resources by Zama](https://github.com/zama-ai/awesome-zama) | 💬 [Community support](https://zama.ai/community)

<figure><img src=".gitbook/assets/doc header (6).png" alt=""><figcaption></figcaption></figure>
<figure><img src=".gitbook/assets/doc header (11).png" alt=""><figcaption></figcaption></figure>

**fhEVM** is a technology that enables confidential smart contracts on the EVM using Fully Homomorphic Encryption (FHE).

### Start here

Learn the basics of fhEVM, set it up, and make it run with ease.

{% tabs %}
{% tab title="Write a fhEVM smart contract in Solidity" %}

<table data-card-size="large" data-view="cards"><thead><tr><th align="center"></th><th data-hidden data-card-target data-type="content-ref"></th></tr></thead><tbody><tr><td align="center">What is fhEVM</td><td><a href="README (1).md">README (1).md</a></td></tr><tr><td align="center">Connecting to Zama Devnet</td><td><a href="getting_started/connect.md">connect.md</a></td></tr><tr><td align="center">Using Zama faucet</td><td><a href="getting_started/faucet.md">faucet.md</a></td></tr><tr><td align="center">Local dev node</td><td><a href="getting_started/local.md">local.md</a></td></tr></tbody></table>
{% endtab %}

{% tab title="Build blockchain cores with fhEVM" %}

<table data-card-size="large" data-view="cards"><thead><tr><th align="center"></th><th></th><th data-hidden data-card-target data-type="content-ref"></th></tr></thead><tbody><tr><td align="center"><strong>fhevm-go</strong></td><td>An open-source library to easily integrate the <a href="https://docs.zama.ai/fhevm">fhEVM</a> into an EVM-compatible blockchain. <br><br>The library helps EVM maintainers to extend their EVM with the power of FHE. </td><td><a href="https://docs.zama.ai/fhevm-go/what-is-fhevm-go/readme">https://docs.zama.ai/fhevm-go/what-is-fhevm-go/readme</a></td></tr></tbody></table>
{% endtab %}
{% endtabs %}
<table data-card-size="large" data-view="cards"><thead><tr><th align="center"></th><th data-hidden data-card-target data-type="content-ref"></th></tr></thead><tbody><tr><td align="center">What is fhEVM</td><td><a href="broken-reference">Broken link</a></td></tr><tr><td align="center">Connecting to Zama Devnet</td><td><a href="getting_started/connect.md">connect.md</a></td></tr><tr><td align="center">Using Zama faucet</td><td><a href="getting_started/faucet.md">faucet.md</a></td></tr><tr><td align="center">Local dev node</td><td><a href="getting_started/local.md">local.md</a></td></tr></tbody></table>

### Develop a fhEVM smart contract

Start developing fhEVM smart contracts in Solidity by exploring its core features, following deployment guides, and diving into user-friendly tutorials step by step.
Start developing fhEVM smart contracts in Solidity by exploring its core features, discovering essential guides, and learning more with user-friendly tutorials.

<table data-view="cards"><thead><tr><th align="center"></th><th></th><th></th><th data-hidden data-card-cover data-type="files"></th></tr></thead><tbody><tr><td align="center"><strong>Fundamentals</strong></td><td>Explore core features of the fhEVM Solidity library with and code examples.</td><td><ul><li><a href="fundamentals/write_contract/">Write contract</a></li><li><a href="fundamentals/types.md">Use encrypted types</a></li><li><a href="fundamentals/conditions.md">Write conditions</a></li><li><a href="fundamentals/decrypt.md">Decrypt and reencrypt</a></li></ul></td><td><a href=".gitbook/assets/3.png">3.png</a></td></tr><tr><td align="center"><strong>Guides</strong></td><td>Discover essential deployment guides to streamline your fhEVM smart contract.</td><td><ul><li><a href="guides/gas.md">Estimate gas</a></li><li><a href="guides/pitfalls.md">Common pitfalls and best practices </a></li><li><a href="guides/client-sdk/">Client SDK</a></li></ul></td><td><a href=".gitbook/assets/2.png">2.png</a></td></tr><tr><td align="center"><strong>Tutorials</strong></td><td>Follow step-by-step guides to build use case examples with fhEVM</td><td><ul><li><a href="tutorials/see-all-tutorials.md#start-here">Start here</a></li><li><a href="tutorials/see-all-tutorials.md#go-further">Go further</a></li></ul></td><td><a href=".gitbook/assets/1.png">1.png</a></td></tr></tbody></table>
<table data-view="cards"><thead><tr><th align="center"></th><th></th><th></th><th data-hidden data-card-cover data-type="files"></th></tr></thead><tbody><tr><td align="center"><strong>Fundamentals</strong></td><td>Explore core features and basics of fhEVM.</td><td><ul><li><a href="fundamentals/write_contract/">Write contract</a></li><li><a href="fundamentals/types.md">Use encrypted types</a></li><li><a href="fundamentals/conditions.md">Write conditions</a></li><li><a href="fundamentals/decrypt.md">Decrypt and reencrypt</a></li></ul></td><td><a href=".gitbook/assets/3.png">3.png</a></td></tr><tr><td align="center"><strong>Guides</strong></td><td>Discover essential guides to work with fhEVM.</td><td><ul><li><a href="guides/gas.md">Estimate gas</a></li><li><a href="guides/pitfalls.md">Common pitfalls and best practices</a></li><li><a href="guides/client-sdk/">Client SDK</a></li></ul></td><td><a href=".gitbook/assets/2.png">2.png</a></td></tr><tr><td align="center"><strong>Tutorials</strong></td><td>Learn more about fhEVM with our tutorials.</td><td><ul><li><a href="tutorials/see-all-tutorials.md#start-here">Start here</a></li><li><a href="tutorials/see-all-tutorials.md#go-further">Go further</a></li><li><a href="tutorials/see-all-tutorials.md">See all tutorials</a></li></ul></td><td><a href=".gitbook/assets/1.png">1.png</a></td></tr></tbody></table>

### References

Expand All @@ -42,12 +32,8 @@ Our team of experts usually answers within 24 hours in working days.

### Developer

- [Contribute to fhEVM](https://github.com/zama-ai/fhevm?tab=readme-ov-file#developer-guide)
- [Development Roadmap](developer/roadmap.md)
- [Latest release note](https://github.com/zama-ai/fhevm/releases)
- [Feature request](https://github.com/zama-ai/fhevm/issues/new)
- [Bug report](https://github.com/zama-ai/fhevm/issues/new)

---

<figure><picture><source srcset=".gitbook/assets/8.png" media="(prefers-color-scheme: dark)"><img src=".gitbook/assets/5.png" alt=""></picture><figcaption></figcaption></figure>
* [Contribute to fhEVM](https://github.com/zama-ai/fhevm?tab=readme-ov-file#developer-guide)
* [Follow the development roadmap](developer/roadmap.md)
* [See the latest test release note](https://github.com/zama-ai/fhevm/releases)
* [Request a feature](https://github.com/zama-ai/fhevm/issues/new)
* [Report a bug](https://github.com/zama-ai/fhevm/issues/new)
75 changes: 38 additions & 37 deletions docs/SUMMARY.md
Original file line number Diff line number Diff line change
@@ -1,57 +1,58 @@
# Table of contents

- [Welcome to fhEVM](README.md)

## What is Zama's fhEVM

- [Overview](overview.md)
- [Whitepaper](https://github.com/zama-ai/fhevm/blob/main/fhevm-whitepaper.pdf)
* [Welcome to fhEVM](README.md)

## Getting Started

- [Connecting to Zama Devnet](getting_started/connect.md)
- [Using Zama Faucet](getting_started/faucet.md)
- [Local dev node](getting_started/local.md)
* [What is fhEVM](getting-started/overview.md)
* [Connecting to Zama Devnet](getting\_started/connect.md)
* [Using Zama Faucet](getting\_started/faucet.md)
* [Local dev node](getting\_started/local.md)
* [Whitepaper](https://github.com/zama-ai/fhevm/blob/main/fhevm-whitepaper.pdf)

## Fundamentals

- [Write contract](fundamentals/write_contract/README.md)
- [Using Hardhat](fundamentals/write_contract/hardhat.md)
- [Using Remix](fundamentals/write_contract/remix.md)
- [Other development environment](fundamentals/write_contract/others.md)
- [Use encrypted types](fundamentals/types.md)
- [Operations on encrypted types](fundamentals/operations.md)
- [Generate random number](fundamentals/random.md)
- [Write conditions](fundamentals/conditions.md)
- [Decrypt and reencrypt](fundamentals/decrypt.md)
* [Write contract](fundamentals/write\_contract/README.md)
* [Using Hardhat](fundamentals/write\_contract/hardhat.md)
* [Using Remix](fundamentals/write\_contract/remix.md)
* [Other development environment](fundamentals/write\_contract/others.md)
* [Use encrypted types](fundamentals/types.md)
* [Operations on encrypted types](fundamentals/operations.md)
* [Write conditions](fundamentals/conditions.md)
* [Decrypt and reencrypt](fundamentals/decrypt.md)
* [Generate random number](fundamentals/random.md)

## Guides

- [Estimate gas](guides/gas.md)
- [Common pitfalls and best practises](guides/pitfalls.md)
- [Client SDK](guides/client-sdk/README.md)
- [Installation](guides/client-sdk/getting_started/README.md)
- [Using Node](guides/client-sdk/getting_started/node.md)
- [Using a template](guides/client-sdk/getting_started/templates.md)
- [Other frontend tooling](guides/client-sdk/getting_started/browser.md)
- [Using CLI](guides/client-sdk/getting_started/cli.md)
- [Setup an instance](guides/client-sdk/instance.md)
- [Encrypt an input](guides/client-sdk/inputs.md)
- [Get a reencryption](guides/client-sdk/reencryption.md)
- [Examples](guides/client-sdk/examples/README.md)
- [Transfer tokens (node)](guides/client-sdk/examples/transfererc20.md)
- [Get balance (node)](guides/client-sdk/examples/getbalance.md)
* [Estimate gas](guides/gas.md)
* [Common pitfalls and best practises](guides/pitfalls.md)
* [Client SDK](guides/client-sdk/README.md)
* [Installation](guides/client-sdk/getting\_started/README.md)
* [Using Node](guides/client-sdk/getting\_started/node.md)
* [Using a template](guides/client-sdk/getting\_started/templates.md)
* [Other frontend tooling](guides/client-sdk/getting\_started/browser.md)
* [Using CLI](guides/client-sdk/getting\_started/cli.md)
* [Setup an instance](guides/client-sdk/instance.md)
* [Encrypt an input](guides/client-sdk/inputs.md)
* [Get a reencryption](guides/client-sdk/reencryption.md)
* [Examples](guides/client-sdk/examples/README.md)
* [Transfer tokens (node)](guides/client-sdk/examples/transfererc20.md)
* [Get balance (node)](guides/client-sdk/examples/getbalance.md)

## Tutorials

- [See all tutorials](tutorials/see-all-tutorials.md)
* [See all tutorials](tutorials/see-all-tutorials.md)
* [Write confidential smart contract with fhEVM](https://www.zama.ai/post/video-tutorial-how-to-write-confidential-smart-contracts-using-zamas-fhevm)

## References

- [API Function specifications](references/functions.md)
- [Repositories](references/repositories.md)
* [API Function specifications](references/functions.md)
* [Repositories](references/repositories.md)

## Developer

- [Development roadmap](developer/roadmap.md)
- [Contribute](developer/contribute.md)
* [Contributing](developer/contribute.md)
* [Development roadmap](developer/roadmap.md)
* [Release note](https://github.com/zama-ai/fhevm/releases)
* [Feature request](https://github.com/zama-ai/fhevm/issues/new)
* [Bug report](https://github.com/zama-ai/fhevm/issues/new)
9 changes: 8 additions & 1 deletion docs/developer/contribute.md
Original file line number Diff line number Diff line change
@@ -1 +1,8 @@
# Contribute
# Contributing

There are two ways to contribute to the Zama fhEVM:

* [Open issues](https://github.com/zama-ai/fhevm/issues/new/choose) to report bugs and typos, or to suggest new ideas
* Request to become an official contributor by emailing [[email protected]](mailto:[email protected]).

Becoming an approved contributor involves signing our Contributor License Agreement (CLA)). Only approved contributors can send pull requests, so please make sure to get in touch before you do!
38 changes: 19 additions & 19 deletions docs/overview.md → docs/getting-started/overview.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
# Overview
# What is fhEVM

📙 [White paper](https://github.com/zama-ai/fhevm/blob/main/fhevm-whitepaper.pdf) | 📁 [Github](https://github.com/zama-ai/fhevm) | 💛 [Community support](https://zama.ai/community) | 🟨 [Zama Bounty Program](https://github.com/zama-ai/bounty-program)

<figure><img src=".gitbook/assets/zama_doc_header_fhevm.png" alt=""><figcaption></figcaption></figure>
<figure><img src="../.gitbook/assets/zama_doc_header_fhevm.png" alt=""><figcaption></figcaption></figure>

## Bring confidential smart contracts to your blockchain with Zama's fhEVM

Expand All @@ -14,23 +14,23 @@ fhEVM contracts are simple solidity contracts that are built using traditional s

## Use cases

- Tokenization: Swap tokens and RWAs on-chain without others seeing the amounts.
- Blind auctions: Bid on items without revealing the amount or the winner.
- On-chain games: Keep moves, selections, cards, or items hidden until ready to reveal.
- Confidential voting: Prevents bribery and blackmailing by keeping votes private.
- Encrypted DIDs: Store identities on-chain and generate attestations without ZK.
- Private transfers: Keep balances and amounts private, without using mixers.
* Tokenization: Swap tokens and RWAs on-chain without others seeing the amounts.
* Blind auctions: Bid on items without revealing the amount or the winner.
* On-chain games: Keep moves, selections, cards, or items hidden until ready to reveal.
* Confidential voting: Prevents bribery and blackmailing by keeping votes private.
* Encrypted DIDs: Store identities on-chain and generate attestations without ZK.
* Private transfers: Keep balances and amounts private, without using mixers.

## Tutorials and examples

- [🎥 Workshop during ETHcc](https://www.youtube.com/watch?v=eivfVykPP8U) \[by Morten Dahl — Zama]
- [🎥 How to Write Confidential Smart Contracts Using Zama's fhEVM](https://www.youtube.com/watch?v=1FtbyHZwNX4) \[by Clément Danjou (Zama)]
- [📃 Programmable Privacy and Onchain Compliance using Homomorphic Encryption](https://www.zama.ai/post/programmable-privacy-and-onchain-compliance-using-homomorphic-encryption) \[by Rand Hindi and Clément Danjou — Zama]
- [📃 Confidential ERC-20 Tokens Using Homomorphic Encryption](https://www.zama.ai/post/confidential-erc-20-tokens-using-homomorphic-encryption) \[by \[Clément Danjou — Zama]
- [📃 On-chain Blind Auctions Using Homomorphic Encryption](https://www.zama.ai/post/on-chain-blind-auctions-using-homomorphic-encryption) \[by Clément Danjou — Zama]
- [🖥️ ERC-20](https://github.com/zama-ai/fhevm/blob/main/examples/EncryptedERC20.sol)
- [🖥️ Blind Auction](https://github.com/zama-ai/fhevm/blob/main/examples/BlindAuction.sol)
- [🖥️ Governor DAO](https://github.com/zama-ai/fhevm/tree/main/examples/Governor)
- [🖥️ Mixnet](https://github.com/anonymousGifter/mixnet-core) \[by [Remi Gai](https://github.com/remi-gai)]
- [🖥️ Battleship](https://github.com/battleship-fhevm/battleship-hardhat) \[by [Owen Murovec](https://github.com/omurovec)]
- [🖥️ Darkpool](https://github.com/omurovec/fhe-darkpools) \[by [Owen Murovec](https://github.com/omurovec)]
* [🎥 Workshop during ETHcc](https://www.youtube.com/watch?v=eivfVykPP8U) \[by Morten Dahl — Zama]
* [🎥 How to Write Confidential Smart Contracts Using Zama's fhEVM](https://www.youtube.com/watch?v=1FtbyHZwNX4) \[by Clément Danjou (Zama)]
* [📃 Programmable Privacy and Onchain Compliance using Homomorphic Encryption](https://www.zama.ai/post/programmable-privacy-and-onchain-compliance-using-homomorphic-encryption) \[by Rand Hindi and Clément Danjou — Zama]
* [📃 Confidential ERC-20 Tokens Using Homomorphic Encryption](https://www.zama.ai/post/confidential-erc-20-tokens-using-homomorphic-encryption) \[by \[Clément Danjou — Zama]
* [📃 On-chain Blind Auctions Using Homomorphic Encryption](https://www.zama.ai/post/on-chain-blind-auctions-using-homomorphic-encryption) \[by Clément Danjou — Zama]
* [🖥️ ERC-20](https://github.com/zama-ai/fhevm/blob/main/examples/EncryptedERC20.sol)
* [🖥️ Blind Auction](https://github.com/zama-ai/fhevm/blob/main/examples/BlindAuction.sol)
* [🖥️ Governor DAO](https://github.com/zama-ai/fhevm/tree/main/examples/Governor)
* [🖥️ Mixnet](https://github.com/anonymousGifter/mixnet-core) \[by [Remi Gai](https://github.com/remi-gai)]
* [🖥️ Battleship](https://github.com/battleship-fhevm/battleship-hardhat) \[by [Owen Murovec](https://github.com/omurovec)]
* [🖥️ Darkpool](https://github.com/omurovec/fhe-darkpools) \[by [Owen Murovec](https://github.com/omurovec)]
Loading
Loading