Skip to content

Commit

Permalink
Merge branch 'main' into louis/update-sol-docs
Browse files Browse the repository at this point in the history
  • Loading branch information
tremblaythibaultl authored Sep 19, 2023
2 parents 4014a82 + 80cc9a3 commit 7afb2d3
Show file tree
Hide file tree
Showing 12 changed files with 67 additions and 326 deletions.
Binary file added docs/.gitbook/assets/zama_fhevm_summary.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
18 changes: 16 additions & 2 deletions docs/README.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,12 @@
# What is fhEVM ecosystem?
# What is Zama's fhEVM?

📁 [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 (3).png" alt=""><figcaption></figcaption></figure>

Zama's fhEVM allows developer to create private smart contracts using homomorphic encryption on the EVM.
## Bring confidential smart contracts to your blockchain with Zama's fhEVM

There used to be a dilemma in blockchain: keep your application and user data on-chain, allowing everyone to see it, or keep it privately off-chain and lose contract composability. Thanks to a breakthrough in homomorphic encryption, Zama’s fhEVM makes it possible to run confidential smart contracts on encrypted data, guaranteeing both confidentiality and composability.

## fhevmjs

Expand All @@ -13,3 +15,15 @@ fhevmjs is a javascript library that enables developers to interact with blockch
## Solidity library

The Solidity library we introduce is a powerful tool that empowers developers to manipulate encrypted data using TFHE within smart contracts. With this library, developers can perform computations over encrypted data, such as addition, multiplication, comparison and more, while maintaining the confidentiality of the underlying information.

## Tutorials and Examples

* [Workshop during ETHcc](https://www.youtube.com/watch?v=eivfVykPP8U) by Morten Dahl (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-solidity/blob/main/examples/EncryptedERC20.sol)
* [Blind Auction](https://github.com/zama-ai/fhevm-solidity/blob/main/examples/BlindAuction.sol)
* [Governor DAO](https://github.com/zama-ai/fhevm-solidity/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)
34 changes: 16 additions & 18 deletions docs/SUMMARY.md
Original file line number Diff line number Diff line change
@@ -1,26 +1,24 @@
# Table of contents

- [What is fhEVM ecosystem?](README.md)
* [What is Zama's fhEVM?](README.md)

## fhevmjs
## Contract

- [Getting Started](sdk/getting_started.md)
- [Using the CLI](sdk/cli.md)
- [Instance](sdk/instance.md)
- [Parameters](sdk/parameters.md)
- [Reencryption](sdk/reencryption.md)
- ## [Examples](sdk/examples.md)
-
* [Getting Started](solidity/getting\_started.md)
* [TFHE Library](solidity/library.md)
* [Function specifications](solidity/functions.md)
* [Decryption and control structures](solidity/requires.md)

## Solidity
## fhevmjs

- [Getting Started](solidity/getting_started.md)
- [TFHE Library](solidity/library.md)
- [Function specifications](solidity/functions.md)
- [Decryption and control structures](solidity/decryption.md)
* [Getting Started](sdk/getting\_started.md)
* [Using the CLI](sdk/cli.md)
* [Setup an instance](sdk/instance.md)
* [Inputs](sdk/inputs.md)
* [Reencryption](sdk/reencryption.md)
* [Examples](sdk/examples.md)

## Examples
## Resources

- [ERC-20](examples/erc20.md)
- [Blind auction](examples/blindauction.md)
- [Other examples](examples/other.md)
* [Tutorials](resources/tutorials.md)
* [Examples](resources/examples.md)
164 changes: 0 additions & 164 deletions docs/examples/blindauction.md

This file was deleted.

129 changes: 0 additions & 129 deletions docs/examples/erc20.md

This file was deleted.

7 changes: 5 additions & 2 deletions docs/examples/other.md → docs/resources/examples.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,10 @@
# Other examples
# Examples

## Solidity
## Contracts

- [ERC-20](https://github.com/zama-ai/fhevm-solidity/blob/main/examples/EncryptedERC20.sol)
- [Blind Auction](https://github.com/zama-ai/fhevm-solidity/blob/main/examples/BlindAuction.sol)
- [Governor DAO](https://github.com/zama-ai/fhevm-solidity/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)
5 changes: 5 additions & 0 deletions docs/resources/tutorials.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
# Tutorials

- [Workshop during ETHcc](https://www.youtube.com/watch?v=eivfVykPP8U) by Morten Dahl (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)
Loading

0 comments on commit 7afb2d3

Please sign in to comment.