Files
fhevm-solidity/docs/README.md
Clément 'birdy' Danjou 03dfa0b1a9 docs: fix broken links:
2024-06-18 15:01:21 +02:00

64 lines
3.9 KiB
Markdown

---
description: >-
fhEVM is a technology that enables confidential smart contracts on the EVM
using Fully Homomorphic Encryption (FHE).
layout:
title:
visible: true
description:
visible: true
tableOfContents:
visible: true
outline:
visible: true
pagination:
visible: false
---
# Welcome to fhEVM
## Get started
Learn the basics of fhEVM, set it up, and make it run with ease.
<table data-card-size="large" data-view="cards"><thead><tr><th></th><th></th><th data-hidden data-card-cover data-type="files"></th><th data-hidden data-card-target data-type="content-ref"></th></tr></thead><tbody><tr><td><strong>What is fhEVM</strong></td><td>Understand the basic concepts of fhEVM library.</td><td><a href=".gitbook/assets/start1.png">start1.png</a></td><td><a href="getting_started/overview.md">overview.md</a></td></tr><tr><td><strong>Using Zama Faucet</strong></td><td>Follow the step-by-step guide to use Zama Faucet</td><td><a href=".gitbook/assets/start4.png">start4.png</a></td><td><a href="getting_started/devnet/faucet.md">faucet.md</a></td></tr><tr><td><strong>Connecting to Zama devnet</strong></td><td>Get 10 Zama token to start working with fhEVM</td><td><a href=".gitbook/assets/start2.png">start2.png</a></td><td><a href="getting_started/devnet/README.md">connect.md</a></td></tr><tr><td><strong>Local dev node</strong></td><td>Use our docker image to spin up a fhEVM node for local development</td><td><a href=".gitbook/assets/start5.png">start5.png</a></td><td><a href="getting_started/devnet/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, discovering essential guides, and learning more with user-friendly tutorials.
<table data-view="cards"><thead><tr><th></th><th></th><th></th><th data-hidden data-card-cover data-type="files"></th></tr></thead><tbody><tr><td><strong>Fundamentals</strong></td><td>Explore core features.</td><td><ul><li><a href="fundamentals/write_contract/">Write contract</a></li><li><a href="fundamentals/types/README.md">Use encrypted types</a></li></ul></td><td><a href=".gitbook/assets/build1.png">build1.png</a></td></tr><tr><td><strong>Guides</strong></td><td>Deploy your project.</td><td><ul><li><a href="guides/gas.md">Gas estimation</a></li><li><a href="guides/pitfalls.md">Common pitfalls and best practices</a></li></ul></td><td><a href=".gitbook/assets/build2.png">build2.png</a></td></tr><tr><td><strong>Tutorials</strong></td><td>Learn more with 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></ul></td><td><a href=".gitbook/assets/build3.png">build3.png</a></td></tr></tbody></table>
## Explore more
Access to additional resources and join the Zama community.
### References
Refer to the API and access additional resources for in-depth explanations while working with fhEVM.
- [API function specifications](references/functions.md)
- [Repositories](references/repositories.md)
### Supports
Ask technical questions and discuss with the community. Our team of experts usually answers within 24 hours in working days.
- [Community forum](https://community.zama.ai/c/fhevm/15)
- [Discord channel](https://discord.com/invite/fhe-org)
- [Telegram](https://t.me/+Ojt5y-I7oR42MTkx)
### Developers
Collaborate with us to advance the FHE spaces and drive innovation together.
- [Contribute to fhEVM](developer/contribute.md)
- [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)
---
We value your feedback! [Take a 5-question developer survey](http://zama.ai/developer-survey) to improve the fhEVM library and the documentation and help other developers use FHE.