diff --git a/docs/.gitbook/assets/zama_fhevm_summary.png b/docs/.gitbook/assets/zama_fhevm_summary.png new file mode 100644 index 0000000..f8559ab Binary files /dev/null and b/docs/.gitbook/assets/zama_fhevm_summary.png differ diff --git a/docs/README.md b/docs/README.md index b72b443..2ebc8e9 100644 --- a/docs/README.md +++ b/docs/README.md @@ -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)
-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 @@ -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) diff --git a/docs/SUMMARY.md b/docs/SUMMARY.md index a0d2210..4a5fad3 100644 --- a/docs/SUMMARY.md +++ b/docs/SUMMARY.md @@ -1,24 +1,24 @@ # Table of contents -- [What is fhEVM ecosystem?](README.md) +* [What is Zama's fhEVM?](README.md) ## Contract -- [Getting Started](solidity/getting_started.md) -- [TFHE Library](solidity/library.md) -- [Function specifications](solidity/functions.md) -- [Decryption and control structures](solidity/requires.md) +* [Getting Started](solidity/getting\_started.md) +* [TFHE Library](solidity/library.md) +* [Function specifications](solidity/functions.md) +* [Decryption and control structures](solidity/requires.md) ## fhevmjs -- [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) +* [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) ## Resources -- [Tutorials](resources/tutorials.md) -- [Examples](resources/examples.md) +* [Tutorials](resources/tutorials.md) +* [Examples](resources/examples.md)