Skip to content

Commit 343ff46

Browse files
Merge pull request 0xPolygon#105 from 0xPolygon/empieichO-docs-review
Update zkEVM and PoS docs
2 parents af2f524 + 39131a5 commit 343ff46

File tree

10 files changed

+537
-82
lines changed

10 files changed

+537
-82
lines changed

docs/img/pos/bad_block.png

52.1 KB
Loading

docs/img/pos/block_number.png

587 KB
Loading

docs/pos/operate-node/delegate/delegate.md

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ The only prerequisite is to have your MATIC tokens and ETH on the Ethereum mainn
2626

2727
## Delegate to a validator
2828

29-
1. Click **Become a Delegator** or scroll down to a specific validator and click **Delegate**.
29+
1. Click "Become a Delegator" or scroll down to a specific validator and click "Delegate".
3030

3131
![img](../../../img/pos/home.png)
3232

@@ -35,30 +35,30 @@ The only prerequisite is to have your MATIC tokens and ETH on the Ethereum mainn
3535
![img](../../../img/pos/delegateB.png)
3636

3737

38-
3. Approve the delegation transaction and click **Delegate**.
38+
3. Approve the delegation transaction and click "Delegate".
3939

4040
![img](../../../img/pos/delegate2.png)
4141

4242

43-
After the delegation transaction completes, you will see the **Delegation Completed** message.
43+
After the delegation transaction completes, you will see the `Delegation Completed` message.
4444

4545
![img](../../../img/pos/delegate3.png)
4646

4747

4848
## View your delegations
4949

50-
To view your delegations, click [My Account](https://staking.polygon.technology/account).
50+
To view your delegations, click "My Account".
5151

5252
![img](../../../img/pos/myAccount.png)
5353

5454
## Withdraw rewards
5555

56-
1. Click [My Account](https://staking.polygon.technology/account).
56+
1. Click "My Account".
5757

5858
![img](../../../img/pos/click-my-account.png)
5959

6060

61-
2. Under your delegated validator, click **Withdraw Reward**.
61+
2. Under your delegated validator, click "Withdraw Rewards".
6262

6363
![img](../../../img/pos/withdraw-reward.png)
6464

@@ -67,12 +67,12 @@ This will withdraw the MATIC token rewards to your Ethereum address.
6767

6868
## Restake rewards
6969

70-
1. Click [My Account](https://staking.polygon.technology/account).
70+
1. Click "My Account".
7171

7272
![img](../../../img/pos/click-my-account.png)
7373

7474

75-
2. Under your delegated validator, click **Restake Reward**.
75+
2. Under your delegated validator, click "Restake Reward".
7676

7777
![img](../../../img/pos/restake-rewards.png)
7878

@@ -82,12 +82,12 @@ This will restake the MATIC token rewards to the validator and increase your del
8282

8383
## Unbond from a validator
8484

85-
1. Click [My Account](https://staking.polygon.technology/account).
85+
1. Click "My Account".
8686

8787
![img](../../../img/pos/click-my-account.png)
8888

8989

90-
2. Under your delegated validator, click **Unbond**.
90+
2. Under your delegated validator, click "Unbond".
9191

9292
![img](../../../img/pos/unbond-from-validator.png)
9393

@@ -110,16 +110,16 @@ This will restake the MATIC token rewards to the validator and increase your del
110110

111111
Moving stake from one node to another node is a single transaction. There are no delays or unbonding periods during this event.
112112

113-
1. Log in to the [My Account](https://staking.polygon.technology/account) on the Staking dashboard.
113+
1. Log in to the "My Account" on the Staking dashboard.
114114

115-
2. Click **Move Stake** under your delegated validator.
115+
2. Click "Move Stake" under your delegated validator.
116116

117-
3. Select an external validator and click **Stake here**.
117+
3. Select an external validator and click "Stake here".
118118

119119
![img](../../../img/pos/move.png)
120120

121121

122-
4. Provide the stake amount and click **Move Stake**.
122+
4. Provide the stake amount and click "Move Stake".
123123

124124
![img](../../../img/pos/move2.png)
125125

docs/pos/operate-node/delegate/delegator-faq.md

Lines changed: 167 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -7,12 +7,162 @@ The staking dashboard URL is https://staking.polygon.technology/.
77

88
There is no minimum stake amount to delegate. However, you can always start with 1 MATIC token.
99

10+
11+
12+
### How to stake tokens on Polygon?
13+
14+
For Staking you would need to have funds on the Ethereum Mainnet (more information [here](https://etherscan.io/gastracker)). Log into your wallet on the Ethereum network using the Staking Dashboard. https://staking.polygon.technology/
15+
16+
Please watch this video for a graphical illustration of how this works:
17+
18+
<video loop width="100%" height="100%" controls="true" >
19+
<source type="video/mp4" src="../../../../img/pos/staking.mp4"></source>
20+
<p>Your browser does not support the video element.</p>
21+
</video>
22+
23+
1024
### Why does my transaction take so long?
1125

1226
All staking transactions of Polygon happen on Ethereum for security reasons.
1327

1428
The time taken to complete a transaction depends on the gas fees that you have allowed and also the network congestion of Ethereum mainnet at that point in time. You can always use the “Speed Up” option to increase the gas fees so that your transaction can be completed soon.
1529

30+
31+
### I've staked my Matic tokens. How can I stake more?
32+
33+
Navigate to "Your Delegations", choose one of the stakes and click on "Stake More".
34+
35+
Please watch this video for a graphical illustration of how this works:
36+
37+
<video loop width="100%" height="100%" controls="true" >
38+
<source type="video/mp4" src="../../../../img/pos/staking-more.mov"></source>
39+
<p>Your browser does not support the video element.</p>
40+
</video>
41+
42+
<!--
43+
<video width="70%" height="70%" controls="true" >
44+
<source type="video/mp4" src="../../../../img/pos/staking-more.mov"></source>
45+
<p>Your browser does not support the video element.</p>
46+
</video> -->
47+
48+
49+
### Why am I not able to stake?
50+
51+
Check if you have funds on the Main Ethereum Network, to delegate your tokens. All staking happens on the Ethereum Network only.
52+
53+
54+
### I am unable to view the staking tab. How do I access staking?
55+
56+
You just need to access **https://staking.polygon.technology/**, where you will see the following landing page:
57+
58+
![img](../../../img/pos/staking-lp.png)
59+
60+
61+
62+
### How do I know which validator to select for better rewards?
63+
64+
It depends on your understanding and research on which validator you would want to stake on. You can find the list of validators here : https://staking.polygon.technology/validators
65+
66+
### How to unbond?
67+
68+
To unbond from a validator, navigate to MyAccount, where you find **Your Delegations**.
69+
There you will see an **Unbond** button for each of the validators. Click on the **Unbond** button for whichever validator that you want to unbond from.
70+
71+
![img](../../../img/pos/unbond-from-validator.png)
72+
73+
74+
Please watch the video for a graphical illustration of how this works:
75+
76+
<video loop width="100%" height="100%" controls="true" >
77+
<source type="video/mp4" src="../../../../img/pos/unbond.mp4"></source>
78+
<p>Your browser does not support the video element.</p>
79+
</video>
80+
81+
82+
### What is the unbonding period?
83+
84+
The unbonding period on Polygon is 80 checkpoints. Every checkpoint takes approximately 30 minutes. However, some checkpoints could be delayed due to congestion on Ethereum.
85+
This period applies to the originally delegated amount and re-delegated amounts. It does not apply to any rewards that were not re-delegated.
86+
87+
88+
### How to restake rewards?
89+
90+
Go to **My Account** to check **Your Delegations**.
91+
Clicking on **Restake Reward** will ask you for confirmation from your wallet account. Once you confirm the transaction, only then the restake transaction would be complete.
92+
93+
`Step 1`
94+
<center>
95+
![img](../../../img/pos/restake-rewards1.png)
96+
</center>
97+
98+
`Step 2` <br/>
99+
<center>
100+
![img](../../../img/pos/restake-rewards2.png)
101+
</center>
102+
103+
Please watch the video for a graphical illustration of how this works:
104+
105+
<video width="100%" height="100%" controls="true" >
106+
<source type="video/mp4" src="../../../../img/pos/restake.mp4"></source>
107+
<p>Your browser does not support the video element.</p>
108+
</video>
109+
110+
### I want to restake rewards but I am unable to.
111+
112+
You would need to have a minimum of **2 Matic** to restake rewards.
113+
114+
### How to withdraw rewards?
115+
116+
You can claim your rewards by clicking on the **My Account**, all the delegators for a validator are displayed. Click on the **Withdraw Reward** button and the rewards will be transferred to your delegated account in wallet.
117+
118+
`Step 1` <br/>
119+
<center>
120+
![img](../../../img/pos/withdraw1.png)
121+
</center>
122+
123+
`Step 2` <br/>
124+
<center>
125+
![img](../../../img/pos/withdraw2.png)
126+
</center>
127+
128+
Please watch the video for a graphical illustration of how this works:
129+
130+
<video width="100%" height="100%" controls="true" >
131+
<source type="video/mp4" src="../../../../img/pos/claim-rewards.mp4"></source>
132+
<p>Your browser does not support the video element.</p>
133+
</video>
134+
135+
### I want to withdraw rewards but I am unable to.
136+
137+
You would need to have a minimum of **2 Matic** to withdraw rewards.
138+
139+
### How to claim stake?
140+
141+
Once the unbonding period is complete, the **Claim Stake** button will be enabled and you can then claim your staked tokens. The tokens will be transferred to your account.
142+
143+
`Step 1` <br/>
144+
<center>
145+
![img](../../../img/pos/claim-stake1.png)
146+
</center>
147+
148+
`Step 2` <br/>
149+
<center>
150+
![img](../../../img/pos/claim-stake2.png)
151+
</center>
152+
153+
`Step 3` <br/>
154+
<center>
155+
![img](../../../img/pos/claim-stake3.png)
156+
</center>
157+
158+
Please watch the video for a graphical illustration of how this works:
159+
160+
<video width="100%" height="100%" controls="true" >
161+
<source type="video/mp4" src="../../../../img/pos/claiming-stake.mov"></source>
162+
<p>Your browser does not support the video element.</p>
163+
</video>
164+
165+
16166
### Which wallets are currently supported?
17167

18168
We have recently upgraded the wallet support to WalletConnect v2.0. Now you can choose from a plethora of wallets, including Metamask, Coinbase, and others, on both desktop and mobile devices to log in.
@@ -55,7 +205,7 @@ No. All your funds need to be on the main Ethereum network.
55205

56206
Please check if you have enough ETH for the gas fees.
57207

58-
### When does reward get distributed?
208+
### When do rewards get distributed?
59209

60210
The rewards are distributed whenever a checkpoint is submitted.
61211

@@ -67,7 +217,7 @@ The checkpoint submission is done by one of the validators approximately every 3
67217

68218
You can track checkpoints on the staking contract [here](https://etherscan.io/address/0x86e4dc95c7fbdbf52e33d563bbdb00823894c287)
69219

70-
### Why does reward keep getting decreased every checkpoint?
220+
### Why do rewards keep getting decreased at every checkpoint?
71221

72222
Actual rewards earned will depend on the actual total locked supply in the network at each checkpoint. This is expected to vary significantly as more MATIC tokens get locked in the staking contracts.
73223

@@ -79,10 +229,10 @@ You can claim your rewards instantly by clicking on the **Withdraw Reward** butt
79229

80230
![Figure: Withdraw-reward](../../../img/pos/withdraw-reward.png)
81231

82-
232+
<!--
83233
### What is the unbonding period?
84234
85-
The unbonding period on Polygon is 80 checkpoints. This period applies to the originally delegated amount and re-delegated amounts - it does not apply to any rewards that were not re-delegated.
235+
The unbonding period on Polygon is 80 checkpoints. This period applies to the originally delegated amount and re-delegated amounts - it does not apply to any rewards that were not re-delegated. -->
86236

87237
### Will I keep receiving rewards after I unbond?
88238

@@ -101,6 +251,19 @@ Redelegating your rewards simply means that you want to increase your stake by r
101251
### Can I stake to any validator?
102252
Yes, you can delegate to any validator except the ones which are offline.
103253

254+
255+
### Can I move the stake to another validator?
256+
Yes, you just have to access **Your Delegations**, click on **Move Stake**, and then choose your new validator.
257+
258+
Please watch the video for a graphical illustration of how this works:
259+
260+
<video width="100%" height="100%" controls="true" >
261+
<source type="video/mp4" src="../../../../img/pos/moving.mp4"></source>
262+
<p>Your browser does not support the video element.</p>
263+
</video>
264+
265+
266+
104267
### Which browser is compatible with the Polygon earnings calculator?
105268

106269
Chrome, Firefox, and Brave

docs/pos/operate-node/validator/issues/reporting-issues.md

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,23 @@
11

22
## Where to report a bug
33

4-
For any bugs or attacks that are discovered, you need to report them to the [Immunefi bug bounty program](https://immunefi.com/bounty/polygon/). **Performing an attack and not providing submission of your proof will result in disqualification of your attempt.**
4+
For any bugs or attacks that are discovered, you need to report them to the [Immunefi bug bounty program](https://immunefi.com/bounty/polygon/).
55

6-
You need to make sure that you add all relevant details, such as an email address and Discord ID in order to maintain a rapport of communication in case it is required. You also need to provide as many details as possible so that the Polygon team can appropriately evaluate your submission.
6+
!!!info
7+
Performing an attack and not providing submission of your proof will result in disqualification of your attempt.
8+
9+
Make sure you add all relevant details such as your email address and Discord ID. Providing ample details creates a rapport of communication, and helps the Polygon team evaluate your submission appropriately.
710

811
## What happens after submitting a report
912

10-
Upon reporting an issue, the Polygon team will review and update / comment on the status of the issue. Upon evaluation, the Polygon team will report the outcome of the submission. The Severity will also be tagged as per the evaluation.
13+
Once an issue is reported, the Polygon team reviews it, comments, and updates on the status of the issue. After evaluation, the Polygon team reports the outcome of the submission. The severity of the issue also gets tagged as per the evaluation.
1114

1215
## Contact us for further questions
1316

14-
You can always connect with the community leaders, Anurag & Parvez, via email or tag the validator-support-team on Discord:
17+
Submitters of issues can connect with the community leaders via email or tag the validator-support-team on Discord.
1518

1619
### Via E-mail
1720

18-
* Anurag — anurag@polygon.technology
1921
* Parvez — parvez.shaikh@polygon.technology
2022

2123
### Via Discord

0 commit comments

Comments
 (0)