Skip to content

Commit d3122b1

Browse files
Merge pull request 0xPolygon#3 from 0xPolygon/empieichO/zkevmdocs_edit
Adding initial review
2 parents 51b1049 + 6bb49a1 commit d3122b1

File tree

11 files changed

+33142
-1
lines changed

11 files changed

+33142
-1
lines changed

docs/zkEVM/develop.md

Lines changed: 75 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,75 @@
1+
---
2+
id: develop
3+
title: Get Started with Polygon zkEVM
4+
sidebar_label: Quickstart
5+
description: A guide to how to connect to the Polygon zkEVM network and start building with higher throughput and lower fees.
6+
keywords:
7+
- polygon
8+
- develop
9+
- zkEVM
10+
- deploy smart contracts
11+
- connecting to zkEVM
12+
---
13+
14+
15+
## Connecting to zkEVM
16+
17+
Add the **Polygon zkEVM** network to your wallet in order to interact with either the mainnet or the testnet.
18+
19+
Navigate to `Add network` in your wallet, and enter the respective network details as given in the below table:
20+
21+
| Network | RPC URL | ChainID | Block Explorer URL | Currency |
22+
| ------- | ------------------------------- | ---------------- | ---------------- | ----- |
23+
| Polygon zkEVM | `https://zkevm-rpc.com` | `1101` | `https://zkevm.polygonscan.com/` | **ETH** |
24+
| zkEVM Testnet | `https://rpc.public.zkevm-test.net` | `1442` | `https://testnet-zkevm.polygonscan.com` | **ETH** |
25+
26+
27+
Once the wallet is connected, the next step is to [bridge crypto assets](zkEVM/bridge-to-zkevm.md) from Ethereum to zkEVM.
28+
29+
For testnet purposes, you can use the zkEVM faucet to get testnet tokens.
30+
31+
32+
33+
## Deploying Smart Contracts
34+
35+
The development experience on zkEVM is seamless and identical to Ethereum Virtual Machine. Developers on zkEVM can use their existing code and toolings to deploy on zkEVM with much higher throughput and lower fees.
36+
37+
Here is a video tutorial on **how to add Polygon zkEVM Testnet to MetaMask and deploy smart contracts**:
38+
39+
<video autoplay width="100%" height="100%" controls="true" >
40+
<source type="video/mp4" src="/img/zkevm/tutorial.mp4"></source>
41+
<p>Your browser does not support the video element.</p>
42+
</video>
43+
44+
## Get Started with Web3Modal
45+
46+
:::caution Content disclaimer
47+
48+
Please view the third-party content disclaimer [<ins>here</ins>](https://github.com/0xPolygon/wiki/blob/master/CONTENT_DISCLAIMER.md).
49+
50+
:::
51+
52+
### Overview
53+
54+
[<ins>Web3Modal</ins>](https://web3modal.com/) is a simple and intuitive SDK that provides a drop-in UI to enable users of any wallet to seamlessly log in to applications, offering a unified and smooth experience. It features a streamlined wallet selection interface with automatic detection of various wallet types, including mobile, extension, desktop, and web app wallets.
55+
56+
### Code Sandbox for Polygon
57+
58+
The Web3Modal team has prepared a [<ins>Polygon Code Sandbox</ins>](https://codesandbox.io/p/sandbox/web3modal-v3-polygon-7264l5?file=/src/main.tsx:9,19-9,50). It’s a straightforward way for developers to integrate and get hands-on experience with Polygon.
59+
60+
### How to Integrate
61+
62+
1. **Visit Web3Modal:** Go to [<ins>Web3Modal's official website</ins>](https://web3modal.com/) to explore its features and capabilities.
63+
2. **Explore the Code Sandbox:** Utilize the [<ins>Polygon Code Sandbox</ins>](https://codesandbox.io/p/sandbox/web3modal-v3-polygon-7264l5?file=/src/main.tsx:9,19-9,50) to demo and understand the integration process.
64+
3. **Follow the Documentation:** Refer to the provided documentation and instructions to integrate Web3Modal into your projects and leverage its features effectively.
65+
66+
## zkEVM Support
67+
68+
If you need help with anything related to the Polygon zkEVM, you can raise a ticket on the [Polygon Support](https://support.polygon.technology/support/tickets/new) portal, and check out the [Knowledge base](https://support.polygon.technology/support/solutions/folders/82000694871) to view the most common queries about the zkEVM. Additionally, you can reach out to the support team available on the **#zkevm-support** channel on the [Polygon Discord server](https://discord.com/invite/XvpHAxZ). Instructions for raising a zkEVM support ticket are as follows:
69+
70+
1. Join the **Polygon Discord** server [here](https://discord.gg/0xPolygon).
71+
2. Accept the invite sent via DM.
72+
3. Take the **Member** role under **#roles**.
73+
4. Navigate to the **#zkevm-support** channel.
74+
75+
You can now contact the zkEVM support staff with your questions and concerns. We will actively monitor for issues and work to resolve them as soon as possible.
156 KB
Loading
81.3 KB
Loading
145 KB
Loading
100 KB
Loading
210 KB
Loading

docs/zkEVM/qswelcome.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
This documentation contains guides on how to connect wallets to the Polygon zkEVM network, deploy new or existing Ethereum smart contracts, and bridge assets between Polygon zkEVM and Ethereum.
2+
3+
Developers can find guides to setting up an RPC zkNode, spinning up a production zkNode, or even implementing their own fully-fledged zkEVM.
4+
5+
All the while, there is no need for any special toolings or wallets to build or interact with Polygon zkEVM.
6+
7+
Polygon zkEVM is fully compatible with Ethereum to provide a complete EVM-like UX for both Developers and Users.
8+
9+
Simply switch to the zkEVM RPC and start building on a network with a much higher throughput and lower fees.
10+
11+
:::caution Risks
12+
13+
Check the list of potential risks associated with the use of Polygon zkEVM in the [<ins>Risks FAQ</ins>](/zkevm/risk-disclosure.md) section.
14+
15+
:::

docs/zkEVM/risk-disclosures.md

Lines changed: 54 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,54 @@
1+
---
2+
id: risk-disclosure
3+
title: Polygon zkEVM Risk Disclosures
4+
sidebar_label: Risk Disclosures
5+
description: This article explains the potential risks associated with using Polygon zkEVM Mainnet Beta.
6+
keywords:
7+
- zkEVM
8+
- polygon
9+
- Risk Disclosures
10+
- Network Availability
11+
- Decentralization
12+
---
13+
14+
Polygon zkEVM Mainnet Beta is provided on an **AS-IS** and **AS-AVAILABLE** basis. The documentation contains statements about technical specifications, some of which may relate to future versions of Polygon zkEVM rather than its current implementation.
15+
16+
## Attack Vectors/Security
17+
18+
- This is a **Mainnet Beta** and **not a Mainnet release of Polygon zkEVM**, [<ins>security audits</ins>](https://polygon.technology/blog/polygon-zkevm-results-of-hexens-security-audit) and assessments are ongoing. Your data and crypto-assets may be at risk as a result of bugs or otherwise.
19+
20+
- **Polygon zkEVM technology is novel**. As such, there may be unanticipated issues and risks associated with your use of the technology. For example, there may be errors that result in losing data or crypto-assets.
21+
22+
- **Cross-blockchain bridging may be subject to cyberattacks and exploits** including, without limitation, hacks that exploit a vulnerability in the software, hardware, systems or equipment associated with any bridge component, smart contracts, and related systems.
23+
24+
## Network Availability/Performance
25+
26+
As this is a Mainnet Beta, Polygon zkEVM may be slow or unavailable from time to time without notice, which could result in unexpected loss of use or data or crypto-assets. Before engaging in high value transactions, be mindful that there may be time delays before transactions are finalized.
27+
28+
## Decentralization Progress
29+
30+
Polygon Labs is in the process of further decentralizing Polygon zkEVM. This refers to the process of gradually increasing decentralization of the system over time.
31+
32+
- The Mainnet Beta will have some centralized features, such as the Sequencer and Aggregator (Prover), that Polygon Labs currently maintains in an effort to provide greater security at this time. **The Sequencer has the ability to delay the inclusion of a transaction and otherwise reorder transactions**.
33+
34+
- Security of Polygon zkEVM Mainnet Beta is a continuous process. This process includes responding to security concerns, which depends on the Security Council. **The Security Council consists of 8 individuals who are empowered to upgrade Polygon zkEVM Mainnet Beta** without a timelock to respond to urgent security issues. If members of the Council behave maliciously or collude, then the integrity of the system may be compromised including network upgrades that may result in loss of crypto-assets.
35+
36+
- As the Sequencer and Aggregator are centralized for Mainnet Beta, there are risks for potential network downtime and outages, including those that are outside the control of Polygon Labs.
37+
38+
- During the initial phase of the Mainnet Beta release, users will not be able to force transactions on Layer 1.
39+
40+
## Gas Fees
41+
42+
If the gas fees associated with a proposed transaction are too low, it is possible that such transaction will not be sequenced and that those fees may be lost.
43+
44+
## Security Audits
45+
46+
- Polygon Labs’ implementation of Polygon zkEVM has been carefully constructed, was audited by several internal and external parties, and is continuously being reviewed and tested against engineering best practices. It is, however, unlikely that all potential bugs or vulnerabilities were identified through these audits and thus there may be undiscovered vulnerabilities that may put user funds at risk. Users should consider this risk when deciding how much value to place onto the Polygon zkEVM Mainnet Beta. To see the audit reports, see [<ins>here</ins>](https://github.com/0xPolygonHermez/zkevm-rom/blob/main/audits/Hexens_Polygon_zkEVM_PUBLIC_27.02.23.pdf).
47+
48+
- There is a robust bug bounty program for Polygon zkEVM to help encourage the community to find critical bugs in the codebase. Head over to the [<ins>Polygon zkEVM Bug Bounty page on Immunefi</ins>](https://immunefi.com/bounty/polygonzkevm/).
49+
50+
## Prover Infrastructure
51+
52+
- Currently the Polygon zkEVM zkProver does not run on ARM-powered Macs. For Windows users, using WSL/WSL2 is not recommended. Apple M1 chips are not supported for now, since some optimizations on the zkProver require specific Intel instructions. This means some non-M1 computers won't work regardless of the OS, for example: AMD.
53+
54+
- In the event you are deploying a full node of Polygon zkEVM Mainnet Beta, be mindful that the network data is stored inside of each docker container. This means once you remove the container that network data will be lost and you will be required to resync the network data.

0 commit comments

Comments
 (0)