Skip to content

Commit

Permalink
Merge pull request #480 from zama-ai/docs/devnet
Browse files Browse the repository at this point in the history
docs: update devnet in doc
  • Loading branch information
immortal-tofu authored Aug 29, 2024
2 parents 4475e4e + aee9352 commit 546d87b
Show file tree
Hide file tree
Showing 9 changed files with 43 additions and 21 deletions.
Binary file added docs/.gitbook/assets/remixide.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
4 changes: 2 additions & 2 deletions docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,13 +21,13 @@ layout:

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>Write contract</strong></td><td>Start writing fhEVM smart contract using Hardhat template</td><td><a href=".gitbook/assets/start4.png">start4.png</a></td><td><a href="fundamentals/write_contract/hardhat.md">hardhat.md</a></td></tr><tr><td><strong>Deploy on fhEVM native</strong></td><td>Get 10 Zama token to start working with fhEVM native</td><td><a href=".gitbook/assets/start2.png">start2.png</a></td><td><a href="getting_started/devnet.md">devnet.md</a></td></tr><tr><td><strong>Deploy on Ethereum</strong></td><td>Coming soon!</td><td><a href=".gitbook/assets/start5.png">start5.png</a></td><td><a href="getting_started/ethereum.md">ethereum.md</a></td></tr></tbody></table>
<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>Write contract</strong></td><td>Start writing fhEVM smart contract using Hardhat template</td><td><a href=".gitbook/assets/start4.png">start4.png</a></td><td><a href="getting_started/write_contract/hardhat.md">hardhat.md</a></td></tr><tr><td><strong>Deploy on fhEVM native</strong></td><td>Get 10 Zama token to start working with fhEVM native</td><td><a href=".gitbook/assets/start2.png">start2.png</a></td><td><a href="getting_started/devnet.md">devnet.md</a></td></tr><tr><td><strong>Deploy on Ethereum</strong></td><td>Coming soon!</td><td><a href=".gitbook/assets/start5.png">start5.png</a></td><td><a href="getting_started/ethereum.md">ethereum.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>
<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="getting_started/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

Expand Down
8 changes: 4 additions & 4 deletions docs/SUMMARY.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,10 +6,10 @@

- [What is fhEVM](getting_started/overview.md)
- Write contract
- [Using Hardhat](fundamentals/write_contract/hardhat.md)
- [Using Remix](fundamentals/write_contract/remix.md)
- [Other development environment](fundamentals/write_contract/others.md)
- [Installing packages](fundamentals/write_contract/installation.md)
- [Using Hardhat](getting_started/write_contract/hardhat.md)
- [Using Remix](getting_started/write_contract/remix.md)
- [Other development environment](getting_started/write_contract/others.md)
- [Installing packages](getting_started/write_contract/installation.md)
- [Deploy on fhEVM native](getting_started/devnet.md)
- [Deploy on Ethereum](getting_started/ethereum.md)
- [Whitepaper](https://github.com/zama-ai/fhevm/blob/main/fhevm-whitepaper.pdf)
Expand Down
5 changes: 0 additions & 5 deletions docs/fundamentals/write_contract/remix.md

This file was deleted.

34 changes: 24 additions & 10 deletions docs/getting_started/devnet.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,22 @@

This document explains how to configure the Zama Devnet for deploying smart contracts on fhEVM native.

{% hint style="warning" %}
**Devnet down** Our devnet is currently offline but will be up soon! In the meantime, develop your contracts using a local instance.
{% endhint %}
## Devnet information

Our devnet is up and running.

<!-- markdown-link-check-disable -->

| Fields | Value |
| ------------------ | --------------------------------------------- |
| New RPC URL | https://devnet.zama.ai |
| Chain ID | 9000 |
| Currency symbol | ZAMA |
| Gateway URL | https://gateway.devnet.zama.ai |
| Faucet URL | https://faucet.zama.ai |
| Block explorer URL | https://explorer.devnet.zama.ai (coming soon) |

<!-- markdown-link-check-enable -->

## Configuring MetaMask

Expand All @@ -25,16 +38,17 @@ To configure the [MetaMask](<(https://support.metamask.io/hc/en-us/articles/3600
<!-- markdown-link-check-disable -->

3. Add these information to access to blockchain

{% tabs %}
{% tab title="Zama devnet" %}

| Fields | Value |
| ----------------------------- | ----------------------------- |
| Network Name | Zama Network |
| New RPC URL | https://devnet.zama.ai |
| Chain ID | 8009 |
| Currency symbol | ZAMA |
| Block explorer URL (Optional) | https://main.explorer.zama.ai |
| Fields | Value |
| ----------------------------- | ------------------------------- |
| Network Name | Zama Network |
| New RPC URL | https://devnet.zama.ai |
| Chain ID | 9000 |
| Currency symbol | ZAMA |
| Block explorer URL (Optional) | https://explorer.devnet.zama.ai |

{% endtab %}
{% tab title="Local devnet" %}
Expand Down
File renamed without changes.
File renamed without changes.
13 changes: 13 additions & 0 deletions docs/getting_started/write_contract/remix.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
# Using Remix

We have decided to deprecate our Remix fork in favor of a new plugin we are currently developing. This plugin will enable you to develop your contracts directly on [the official Remix IDE](https://remix.ethereum.org) by simply loading the fhEVM plugin.

To use it:

1. Go to the "Plugin Manager" page
2. Click on "Connect to a Local Plugin"
3. Fill the name with "Zama" and the "Url" with "https://remix.zama.ai/"
4. Keep "Iframe" and "Side panel" and validate

<figure><img src="../../.gitbook/assets/remixide.png" alt="How to install Remix IDE plugin" width="300"><figcaption>
</figcaption></figure>

0 comments on commit 546d87b

Please sign in to comment.