Skip to content

Commit

Permalink
docs: update welcome page and scribes
Browse files Browse the repository at this point in the history
  • Loading branch information
yuxizama committed Feb 21, 2025
1 parent e0f1422 commit e2c2ce3
Show file tree
Hide file tree
Showing 7 changed files with 143 additions and 255 deletions.
35 changes: 22 additions & 13 deletions docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,44 +21,53 @@ layout:

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

<table 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>Overview</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">key_concepts.md</a></td></tr><tr><td><strong>Quick start</strong></td><td>Deploy your first fhEVM smart contract.</td><td><a href=".gitbook/assets/start4.png">start4.png</a></td><td><a href="./getting-started/overview-1/overview.md">quick_start.md</a></td></tr><tr><td><strong>Get started with Hardhat</strong></td><td>Learn how to deploy and write confidential smart contracts with Hardhat</td><td><a href=".gitbook/assets/start5.png">start5.png</a></td><td><a href="tutorials/hardhat.md">hardhat.md</a></td></tr></tbody></table>
<table 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>Overview</strong></td><td>Explore the suite of fhEVM protocol.</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>Quick start with Remix</strong></td><td>Learn and prototype in the in-browser IDE.</td><td><a href=".gitbook/assets/start4.png">start4.png</a></td><td><a href="getting-started/overview-1/overview.md">overview.md</a></td></tr><tr><td><strong>Get started with Hardhat</strong></td><td>Develop in production-ready envrionment.</td><td><a href=".gitbook/assets/start5.png">start5.png</a></td><td><a href="broken-reference">Broken link</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="tutorials/hardhat.md">Write contract with Hardhat</a></li><li><a href="smart_contracts/types.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>Learn more about fhEVM implementation.</td><td><ul><li><a href="./frontend/webapp.md">Frontend</a></li></ul></td><td><a href=".gitbook/assets/build2.png">build2.png</a></td></tr><tr><td><strong>Tutorials</strong></td><td>Build quickly with tutorials.</td><td><ul><li><a href="tutorials/see-all-tutorials.md">See all tutorials</a></li></ul></td><td><a href=".gitbook/assets/build3.png">build3.png</a></td></tr></tbody></table>
<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>Smart contract</strong></td><td>Learn core Solidity library.</td><td><ul><li><a href="smart_contracts/key_concepts.md">Key features</a></li><li><a href="smart_contracts/types.md">Use encrypted types</a></li></ul></td><td><a href=".gitbook/assets/build1.png">build1.png</a></td></tr><tr><td><strong>Frontend</strong></td><td>Write a dAPP frontend.</td><td><ul><li><a href="frontend/setup.md">Set up</a></li><li><a href="frontend/webapp.md">Build a web application</a></li></ul></td><td><a href=".gitbook/assets/build2.png">build2.png</a></td></tr><tr><td><strong>Tutorials</strong></td><td>Build quickly with tutorials.</td><td><ul><li><a href="tutorials/see-all-tutorials.md">See all tutorials</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.

### Explanations

Explore the technical architecture of the fheEVM protocol and the underlying cryptographic principles that power it.

* [Architecture overview](smart_contracts/architecture_overview.md)
* [FHE on blockchain](smart_contracts/architecture_overview/fhe-on-blockchain.md)
* [fhEVM components](smart_contracts/architecture_overview/fhevm-components.md)
* [Encryption, decryption re-encryption and computaiton](smart_contracts/d_re_ecrypt_compute.md)

### 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)
* [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)
* [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?assignees=&labels=enhancement&projects=&template=feature-request.md&title=)
- [Report a bug](https://github.com/zama-ai/fhevm/issues/new?assignees=&labels=bug&projects=&template=bug_report_fhevm.md&title=)
* [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?assignees=\&labels=enhancement\&projects=\&template=feature-request.md\&title=)
* [Report a bug](https://github.com/zama-ai/fhevm/issues/new?assignees=\&labels=bug\&projects=\&template=bug_report_fhevm.md\&title=)

---
***

{% hint style="success" %}
**Zama 5-Question Developer Survey**
Expand Down
117 changes: 58 additions & 59 deletions docs/SUMMARY.md
Original file line number Diff line number Diff line change
@@ -1,82 +1,81 @@
# Table of contents

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

## Getting Started

- [Overview](getting-started/overview.md)
- [Quick Start](getting-started/overview-1/overview.md)
- [Remix](getting-started/overview-1/remix/README.md)
- [1. Setting up Remix](getting-started/overview-1/remix/remix.md)
- [2. Connect your wallet to Remix](getting-started/overview-1/remix/connect_wallet.md)
- [3. Deploying ConfidentialERC20](getting-started/overview-1/remix/deploying_cerc20.md)
- [4. Interacting with the contract](getting-started/overview-1/remix/interact.md)
- [Hardhat](getting-started/overview-1/hardhat/README.md)
- [Prerequisites](getting-started/overview-1/hardhat/prerequisites.md)
- [1. Setting up Hardhat](getting-started/overview-1/hardhat/1.-setting-up-hardhat.md)
- [2. Writing contracts](getting-started/overview-1/hardhat/2.-writing-contracts.md)
- [3. Testing in mocked mode](getting-started/overview-1/hardhat/3.-testing-in-mocked-mode.md)
- [4. Deploying the contract](getting-started/overview-1/hardhat/4.-deploying-the-contract.md)
- [5. Interacting with the contract](getting-started/overview-1/hardhat/5.-interacting-with-the-contract.md)
* [Overview](getting-started/overview.md)
* [Quick Start](getting-started/overview-1/overview.md)
* [Remix](getting-started/overview-1/remix/README.md)
* [1. Setting up Remix](getting-started/overview-1/remix/remix.md)
* [2. Connect your wallet to Remix](getting-started/overview-1/remix/connect_wallet.md)
* [3. Deploying ConfidentialERC20](getting-started/overview-1/remix/deploying_cerc20.md)
* [4. Interacting with the contract](getting-started/overview-1/remix/interact.md)
* [Hardhat](getting-started/overview-1/hardhat/README.md)
* [Prerequisites](getting-started/overview-1/hardhat/prerequisites.md)
* [1. Setting up Hardhat](getting-started/overview-1/hardhat/1.-setting-up-hardhat.md)
* [2. Writing contracts](getting-started/overview-1/hardhat/2.-writing-contracts.md)
* [3. Testing in mocked mode](getting-started/overview-1/hardhat/3.-testing-in-mocked-mode.md)
* [4. Deploying the contract](getting-started/overview-1/hardhat/4.-deploying-the-contract.md)
* [5. Interacting with the contract](getting-started/overview-1/hardhat/5.-interacting-with-the-contract.md)

## Tutorials

- [Tutorial: Setting up Hardhat](tutorials/hardhat.md)
- [See all tutorials](tutorials/see-all-tutorials.md)
* [See all tutorials](tutorials/see-all-tutorials.md)

## Smart contract

- [Key features](smart_contracts/key_concepts.md)
- [Configuration](smart_contracts/configure.md)
- [FhEVM contracts](smart_contracts/contracts.md)
- [Supported types](smart_contracts/types.md)
- [Operations on encrypted types](smart_contracts/operations.md)
- [Access Control List](smart_contracts/acl/README.md)
- [ACL examples](smart_contracts/acl/acl_examples.md)
- [Encrypted Inputs](smart_contracts/inputs.md)
- [Decryption](smart_contracts/decryption/README.md)
- [Decryption](smart_contracts/decryption/decrypt.md)
- [Decryption in depth](smart_contracts/decryption/decrypt_details.md)
- [Re-encryption](smart_contracts/decryption/reencryption.md)
- [If sentences](smart_contracts/loop.md)
- [Branching in FHE](smart_contracts/conditions.md)
- [AsEbool, asEuintXX, asEaddress and asEbytesXX operations](smart_contracts/asEXXoperators.md)
- [Generate random numbers](smart_contracts/random.md)
- [Error handling](smart_contracts/error_handling.md)
- [Gas estimation](smart_contracts/gas.md)
- [Debug decrypt](smart_contracts/debug_decrypt.md)
- [Using Foundry](smart_contracts/write_contract/foundry.md)
* [Key features](smart_contracts/key_concepts.md)
* [Configuration](smart_contracts/configure.md)
* [FhEVM contracts](smart_contracts/contracts.md)
* [Supported types](smart_contracts/types.md)
* [Operations on encrypted types](smart_contracts/operations.md)
* [Access Control List](smart_contracts/acl/README.md)
* [ACL examples](smart_contracts/acl/acl_examples.md)
* [Encrypted Inputs](smart_contracts/inputs.md)
* [Decryption](smart_contracts/decryption/README.md)
* [Decryption](smart_contracts/decryption/decrypt.md)
* [Decryption in depth](smart_contracts/decryption/decrypt_details.md)
* [Re-encryption](smart_contracts/decryption/reencryption.md)
* [If sentences](smart_contracts/loop.md)
* [Branching in FHE](smart_contracts/conditions.md)
* [AsEbool, asEuintXX, asEaddress and asEbytesXX operations](smart_contracts/asEXXoperators.md)
* [Generate random numbers](smart_contracts/random.md)
* [Error handling](smart_contracts/error_handling.md)
* [Gas estimation](smart_contracts/gas.md)
* [Debug decrypt](smart_contracts/debug_decrypt.md)
* [Using Foundry](smart_contracts/write_contract/foundry.md)

## Frontend

- [Setup](frontend/setup.md)
- [Build a web application](frontend/webapp.md)
- [Using React.js](https://github.com/zama-ai/fhevm-react-template)
- [Using Next.js](https://github.com/zama-ai/fhevm-next-template)
- [Using Vue.js](https://github.com/zama-ai/fhevm-vue-template)
- [Using Node or Typescript](frontend/node.md)
- [Using the CLI](frontend/cli.md)
- [Common webpack errors](frontend/webpack.md)
* [Setup](frontend/setup.md)
* [Build a web application](frontend/webapp.md)
* [Using React.js](https://github.com/zama-ai/fhevm-react-template)
* [Using Next.js](https://github.com/zama-ai/fhevm-next-template)
* [Using Vue.js](https://github.com/zama-ai/fhevm-vue-template)
* [Using Node or Typescript](frontend/node.md)
* [Using the CLI](frontend/cli.md)
* [Common webpack errors](frontend/webpack.md)

## Explanations

- [Architectural overview](smart_contracts/architecture_overview.md)
- [FHE on blockchain](smart_contracts/architecture_overview/fhe-on-blockchain.md)
- [fhEVM components](smart_contracts/architecture_overview/fhevm-components.md)
- [Encryption, decryption, re-encryption, and computation](smart_contracts/d_re_ecrypt_compute.md)
* [Architectural overview](smart_contracts/architecture_overview.md)
* [FHE on blockchain](smart_contracts/architecture_overview/fhe-on-blockchain.md)
* [fhEVM components](smart_contracts/architecture_overview/fhevm-components.md)
* [Encryption, decryption, re-encryption, and computation](smart_contracts/d_re_ecrypt_compute.md)

## References

- [Table of all addresses](references/table_of_addresses.md)
- [Smart contracts - fhEVM API](references/functions.md)
- [Frontend - fhevmjs lib](references/fhevmjs.md)
- [Repositories](references/repositories.md)
* [Table of all addresses](references/table_of_addresses.md)
* [Smart contracts - fhEVM API](references/functions.md)
* [Frontend - fhevmjs lib](references/fhevmjs.md)
* [Repositories](references/repositories.md)

## Developer

- [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?assignees=&labels=enhancement&projects=&template=feature-request.md&title=)
- [Bug report](https://github.com/zama-ai/fhevm/issues/new?assignees=&labels=bug&projects=&template=bug_report_fhevm.md&title=)
* [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?assignees=\&labels=enhancement\&projects=\&template=feature-request.md\&title=)
* [Bug report](https://github.com/zama-ai/fhevm/issues/new?assignees=\&labels=bug\&projects=\&template=bug_report_fhevm.md\&title=)
27 changes: 13 additions & 14 deletions docs/getting-started/overview-1/hardhat/1.-setting-up-hardhat.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,19 +4,18 @@ This guide walks you through setting up your Hardhat environment using Zama's fh

## Step 1: Clone the Hardhat template

1. Go to the fhEVM Hardhat Template Repository:
- Open the repository: [Zama fhEVM Hardhat Template](https://github.com/zama-ai/fhevm-hardhat-template)
- Click "Use this template" to create a new repository under your GitHub account.
2. Clone the repository you have created to your local environment:
- Copy the repository URL of your newly created repository.
- Open a terminal and run:
1. Open the repository: [Zama fhEVM Hardhat Template](https://github.com/zama-ai/fhevm-hardhat-template)
2. Click "Use this template" to create a new repository under your GitHub account.
3. Clone the repository you have created to your local environment
4. Copy the repository URL of your newly created repository.
5. Open a terminal and run:

```sh
git clone <your-new-repo-url>
cd <your-new-repo-name>
```

{% embed url="https://scribehow.com/embed/Step_1__M1Gjr6SAQuOsPyT7luekmw?skipIntro=true&removeLogo=true" %}
{% embed url="https://scribehow.com/embed/Step_1__M1Gjr6SAQuOsPyT7luekmw?removeLogo=true&skipIntro=true" %}

## Step 2: Configure the environment

Expand All @@ -25,7 +24,6 @@ cd <your-new-repo-name>
```sh
cp .env.example .env
```

2. Install project dependencies: Depending on your package manager, run one of the following:

```sh
Expand All @@ -39,17 +37,18 @@ cd <your-new-repo-name>
pnpm install
```

{% embed url="https://scribehow.com/embed/Step_2__X1NmSAwhRiSiToABTDD31Q?skipIntro=true&removeLogo=true" %}
{% embed url="https://scribehow.com/embed/Step_2_Copy__dIIvxIkrTPWTMD-A9s3Twg?removeLogo=true&skipIntro=true" %}

## Project structure overview

- **`contracts/`**: Write your Solidity smart contracts here.
- **`test/`**: Place your test scripts for smart contract testing.
- **`deploy/`**: Deployment scripts for deploying your contracts.
- **`hardhat.config.js`**: Pre-configured Hardhat setup for deploying on Sepolia.
* **`contracts/`**: Write your Solidity smart contracts here.
* **`test/`**: Place your test scripts for smart contract testing.
* **`deploy/`**: Deployment scripts for deploying your contracts.
* **`hardhat.config.js`**: The pre-configured Hardhat setup file for deploying on Sepolia.
* **`.env`:** The envrionment file that stores sensitive or environment-specific variables such as private keys and API keys.

To learn more about Hardhat, refer to the [official Hardhat documentation](https://hardhat.org/hardhat-runner/docs/getting-started#overview).

---
***

You are now ready to start building your confidential smart contracts with fhEVM!
Loading

0 comments on commit e2c2ce3

Please sign in to comment.