Skip to content

Commit 2ee8c21

Browse files
committed
zkEVM - Adding new doc
2 parents 5651231 + 8a1c7a1 commit 2ee8c21

File tree

15 files changed

+135
-95
lines changed

15 files changed

+135
-95
lines changed
686 KB
Loading
652 KB
Loading
-750 KB
Loading

docs/tools/gas/matic-faucet.md

Lines changed: 54 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -2,78 +2,99 @@
22
comments: true
33
---
44

5-
Polygon Faucet is a tool provided by Polygon and ecosystem partners, such as Alchemy and Quicknode, that allows you to obtain free MATIC tokens on the testnets and get started with the Polygon network. These test tokens enable you to work with Polygon features without having to spend actual MATIC tokens on the mainnet.
5+
The Polygon Faucet is a tool provided by Polygon and ecosystem partners like Alchemy, QuickNode, and GetBlock. It enables developers to acquire free MATIC/ETH test tokens on the PoS Amoy and zkEVM Cardona testnets. Start deploying and testing your dApps on the Polygon network with test tokens that allow you to explore Polygon features without spending actual MATIC tokens on the mainnet.
66

7-
Additionally, you can also receive Polygon zkEVM testnet ETH on Polygon Faucet.
7+
Polygon Faucet drips:
88

9-
!!! info
10-
Tokens on testnet networks like Amoy, Sepolia, and Cardona have no value as they are only used for testing purposes.
9+
- MATIC on PoS Amoy and Ethereum Sepolia.
10+
- Test ETH on zkEVM Cardona.
1111

12-
We have listed several faucet tools you can use to receive MATIC testnet tokens in the sections below:
12+
!!! info "Testnet tokens hold no real-world value"
13+
Tokens on testnets such as PoS Amoy, Ethereum Sepolia, and zkEVM Cardona hold no real value and are solely used for testing purposes.
1314

14-
- [Polygon faucet](https://faucet.polygon.technology/)
15-
- [Alchemy Polygon Amoy MATIC faucet](https://www.alchemy.com/faucets/polygon-amoy)
16-
- [QuickNode Polygon faucet](https://faucet.quicknode.com/polygon)
15+
Several faucet tools are available to receive test MATIC and ETH on Sepolia-anchored Polygon networks:
1716

18-
In addition, the faucet also has Polygon zkEVM testnet ETH tokens.
17+
| Faucet | Supported networks |
18+
| :----------------------: | --------------------------------------------------------------------------------------------------------------------- |
19+
| Polygon Faucet | [zkEVM Cardona, PoS Amoy, Ethereum Sepolia](https://faucet.polygon.technology) |
20+
| Alchemy Faucet | [PoS Amoy](https://www.alchemy.com/faucets/polygon-amoy) \| [Ethereum Sepolia](https://www.alchemy.com/faucets/ethereum-sepolia) |
21+
| QuickNode Polygon Faucet | [PoS Amoy](https://faucet.quicknode.com/polygon/amoy) |
22+
| GetBlock Faucet | [PoS Amoy](https://getblock.io/faucet/matic-amoy/) \| [Ethereum Sepolia](https://getblock.io/faucet/eth-sepolia) |
1923

20-
## Polygon faucet
24+
## Polygon Faucet
2125

22-
- Navigate to [faucet.polygon.technology](https://faucet.polygon.technology/).
26+
- Start by navigating to [faucet.polygon.technology](https://faucet.polygon.technology/) and connecting/verifying your Discord by selecting **Connect Discord** in the top-right corner of the page.
2327

24-
![img](../../img/tools/gas/faucet.png)
28+
<center>
29+
![img](../../img/tools/gas/faucet.png){width=70%}
30+
</center>
2531

26-
- Select one of the blockchain testnet networks:
32+
- Select one of the blockchain testnet networks from the drop-down list:
2733

28-
- Polygon zkEVM (Cardona) testnet
29-
- Sepolia Ethereum testnet
30-
- Amoy Polygon PoS testnet
34+
- **Polygon zkEVM (Cardona)**
35+
- **Polygon PoS Amoy (Amoy)**
36+
- **Sepolia**
3137

3238
- Select the type of token you want to receive:
3339

34-
- **zkEVM ETH**: Testnet ETH on the Cardona testnet.
35-
- **MATIC token**: Testnet MATIC on the Amoy and Sepolia testnets.
40+
- **zkEVM ETH**: Testnet ETH on zkEVM Cardona.
41+
- **MATIC**: Testnet MATIC on the PoS Amoy and Ethereum Sepolia.
3642

37-
- Once done, copy your wallet address and click on **Paste** to paste it in the text box. Typing is disabled to prevent entering a wrong address.
43+
- Once done, copy your wallet address and select **Paste** to paste it in the text box. Typing is disabled to prevent entering a wrong address.
3844

39-
- Click on the **Submit** button.
45+
- Select **Submit**.
4046

41-
- Click **Confirm** to finalize the transaction. Recheck the details.
47+
- Verify the details and select **Confirm** to finalize the transaction.
4248

43-
![img](../../img/tools/gas/confirm-transaction.png)
49+
<center>
50+
![img](../../img/tools/gas/confirm-transaction.png){width=50%}
51+
</center>
4452

4553
!!! danger
4654

4755
If you don't have enough MATIC testnet tokens in your account to pay for the gas fees, the transaction may fail. If you require testnet tokens in bulk, please fill out [this form](https://docs.google.com/forms/d/e/1FAIpQLSe4npoGldJknEs9EBtPaV3AS-0HTso2IuMWDCiMmLEMCx8euQ/viewform).
4856

4957
- Testnet tokens usually arrive within 1 to 2 minutes.
5058

51-
![img](../../img/tools/gas/success.png)
59+
<center>
60+
![img](../../img/tools/gas/success.png){width=50%}
61+
</center>
5262

53-
## Alchemy MATIC faucet
63+
## Alchemy Faucet
5464

55-
!!! tip "GET 0.5 Amoy MATIC"
65+
!!! tip "Get 0.5 Amoy MATIC"
5666
If you sign up or log in with an Alchemy account, you get 0.5 MATIC per day. Without an account, you get 0.2.
5767

5868
- You can request MATIC tokens from Alchemy's Amoy Faucet. In order to receive testnet tokens, head over to the [Alchemy Polygon Amoy MATIC faucet](https://www.alchemy.com/faucets/polygon-amoy), enter your wallet address and hit the **Send Me MATIC** button.
5969

6070
![img](../../img/tools/gas/alchemy-faucet1.png)
6171

62-
- Check the transaction hash as soon as you finish requesting your MATIC, and view the transaction details on [Polygonscan](https://mumbai.polygonscan.com/).
72+
- Check the transaction hash as soon as you finish requesting your MATIC, and view the transaction details on [Polygonscan](https://amoy.polygonscan.com/).
6373

6474
## QuickNode Polygon Faucet
6575

6676
In order to receive Amoy MATIC tokens using QuickNode faucet,
6777

68-
- Head over to the [QuickNode Polygon Faucet](https://faucet.quicknode.com/polygon). Connect your Coinbase, MetaMask or Phantom wallet by clicking on **Connect Wallet**. Select **Amoy** and click **Continue**.
78+
- Head over to the [QuickNode Polygon Faucet](https://faucet.quicknode.com/polygon). Connect your Coinbase, MetaMask, or Phantom wallet by clicking on **Connect Wallet**. Then, choose **Amoy**, and finally select **Continue**.
6979

70-
![img](../../img/tools/gas/quicknode-faucet2.png)
80+
<center>
81+
![img](../../img/tools/gas/quicknode-faucet2.png){width=80%}
82+
</center>
7183

72-
!!! tip "Get 2x MATIC"
73-
If you tweet the [drip faucet URL](https://faucet.quicknode.com/drip) along with your wallet address, you get 2X more MATIC testnet tokens.
84+
!!! tip "Get 2x MATIC"
85+
Tweet the [drip faucet URL](https://faucet.quicknode.com/drip) with your wallet address to get *twice* as many MATIC testnet tokens.
7486

75-
- You can also view your transaction details on [Polygonscan](https://mumbai.polygonscan.com/) by clicking on the TxHash.
87+
- Click on the transaction hash to view transaction details on [Polygonscan](https://amoy.polygonscan.com/).
7688

77-
!!! tip "Join the Polygon Discord community"
89+
## GetBlock Polygon Faucet
7890

79-
Make sure to connect with the [Polygon Discord community](https://discord.gg/0xPolygon) for news, tips, and help.
91+
Head over to the [GetBlock Polygon Faucet](https://getblock.io/faucet/matic-amoy/) to acquire Amoy MATIC tokens using the GetBlock faucet.
92+
93+
Please register or login to request free testnet tokens.
94+
95+
!!! tip "Get additional tokens"
96+
If you tweet about the [GetBlock Faucet](https://getblock.io/faucet/matic-amoy/), you can claim additional PoS Amoy testnet tokens.
97+
98+
## Discord community
99+
100+
Make sure to connect with the [Polygon Discord community](https://discord.gg/0xPolygon) for news, tips, and help.

docs/zkEVM/architecture/high-level/smart-contracts/bridging.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
![Polygon Solidity smart contract bridging architecture](../../../../img/cdk/high-level-architecture/bridging-class-diagram.png)
2+
13
The unified bridge transfers assets and messages between networks (L1, L2) by calling bridge and claim functions on the [PolygonZkEVMBridgeV2.sol](https://github.com/0xPolygonHermez/zkevm-contracts/blob/main/contracts/v2/PolygonZkEVMBridgeV2.sol) contract whose deployment address is an [upgradeable proxy](https://etherscan.io/address/0x2a3DD3EB832aF982ec71669E178424b10Dca2EDe#code). Interaction with the actual contract happens via the proxy.
24

35
This contract is deployed on L1 and there is also one deployed on every L2 network. It communicates closely with an exit root manager contract specific to L1 or L2.

docs/zkEVM/architecture/high-level/smart-contracts/exit-roots.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,7 @@
1+
The class diagram below describes how the exit root contracts communicate with the bridge and the rollup manager.
2+
3+
![Polygon Solidity smart contract bridging architecture](../../../../img/cdk/high-level-architecture/exit-root-class-diagram.png)
4+
15
An exit tree is a binary, append-only, sparse Merkle tree (SMT) whose leaf nodes store bridging data. The exit trees have a depth of 32.
26

37
The Merkle root of an exit tree is known as the exit tree root, and it is the fingerprint of all the information recorded in the exit tree's leaf nodes.

docs/zkEVM/architecture/high-level/smart-contracts/overview.md

Lines changed: 9 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,13 +2,11 @@
22
comments: true
33
---
44

5-
<!-- https://excalidraw.com/#json=JKZp9QEihifF_B7Z41Dfv,FVNhqQKi9PA1jM0kzUoCsQ" -->
6-
75
## Polygon smart contract architecture
86

97
Chain stacks at the node level direct transaction data to the L2 and L1 networks via smart contract calls. The system stores state in binary tree structures containing verifiable local and global exit roots.
108

11-
The diagram below details the Polygon Solidity smart contract architecture.
9+
The diagram below details the Polygon Solidity smart contract architecture minus the bridging contracts.
1210

1311
![Polygon Solidity smart contract architecture](../../../../img/cdk/high-level-architecture/smart-contracts-full-view.png)
1412

@@ -39,6 +37,10 @@ The [PolygonRollupManager.sol](https://github.com/0xPolygonHermez/zkevm-contract
3937

4038
## Bridge
4139

40+
The class diagram below describes the unified bridge interactions.
41+
42+
![Polygon Solidity smart contract bridging architecture](../../../../img/cdk/high-level-architecture/bridging-class-diagram.png)
43+
4244
The unified bridge contract [PolygonZkEVMBridgeV2.sol](https://github.com/0xPolygonHermez/zkevm-contracts/blob/main/contracts/v2/PolygonZkEVMBridgeV2.sol) is responsible for bridging and claiming activity across L1 and L2 chains.
4345

4446
<center>
@@ -49,6 +51,10 @@ In the L1 network, the bridge also manages the complex exit root mechanism gover
4951

5052
## Global exit roots
5153

54+
The class diagram below describes the exit root interactions.
55+
56+
![Polygon Solidity smart contract bridging architecture](../../../../img/cdk/high-level-architecture/exit-root-class-diagram.png)
57+
5258
System state as a whole is stored on binary trees with data and/or exit roots written into their leaves.
5359

5460
Local updates at the leaf-level trigger exit root updates at the top of the trees which are then available to the global exit root trees and the consensus contracts via the L1 bridge contract.

0 commit comments

Comments
 (0)