Skip to content

Commit

Permalink
Merge pull request #105 from 0xPolygon/empieichO-docs-review
Browse files Browse the repository at this point in the history
Update zkEVM and PoS docs
  • Loading branch information
0xgraciegrace authored Dec 21, 2023
2 parents af2f524 + 39131a5 commit 343ff46
Show file tree
Hide file tree
Showing 10 changed files with 537 additions and 82 deletions.
Binary file added docs/img/pos/bad_block.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/img/pos/block_number.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
28 changes: 14 additions & 14 deletions docs/pos/operate-node/delegate/delegate.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ The only prerequisite is to have your MATIC tokens and ETH on the Ethereum mainn

## Delegate to a validator

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

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

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


3. Approve the delegation transaction and click **Delegate**.
3. Approve the delegation transaction and click "Delegate".

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


After the delegation transaction completes, you will see the **Delegation Completed** message.
After the delegation transaction completes, you will see the `Delegation Completed` message.

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


## View your delegations

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

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

## Withdraw rewards

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

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


2. Under your delegated validator, click **Withdraw Reward**.
2. Under your delegated validator, click "Withdraw Rewards".

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

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

## Restake rewards

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

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


2. Under your delegated validator, click **Restake Reward**.
2. Under your delegated validator, click "Restake Reward".

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

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

## Unbond from a validator

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

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


2. Under your delegated validator, click **Unbond**.
2. Under your delegated validator, click "Unbond".

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

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

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

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

2. Click **Move Stake** under your delegated validator.
2. Click "Move Stake" under your delegated validator.

3. Select an external validator and click **Stake here**.
3. Select an external validator and click "Stake here".

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


4. Provide the stake amount and click **Move Stake**.
4. Provide the stake amount and click "Move Stake".

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

Expand Down
171 changes: 167 additions & 4 deletions docs/pos/operate-node/delegate/delegator-faq.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,12 +7,162 @@ The staking dashboard URL is https://staking.polygon.technology/.

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



### How to stake tokens on Polygon?

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/

Please watch this video for a graphical illustration of how this works:

<video loop width="100%" height="100%" controls="true" >
<source type="video/mp4" src="../../../../img/pos/staking.mp4"></source>
<p>Your browser does not support the video element.</p>
</video>


### Why does my transaction take so long?

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

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.


### I've staked my Matic tokens. How can I stake more?

Navigate to "Your Delegations", choose one of the stakes and click on "Stake More".

Please watch this video for a graphical illustration of how this works:

<video loop width="100%" height="100%" controls="true" >
<source type="video/mp4" src="../../../../img/pos/staking-more.mov"></source>
<p>Your browser does not support the video element.</p>
</video>

<!--
<video width="70%" height="70%" controls="true" >
<source type="video/mp4" src="../../../../img/pos/staking-more.mov"></source>
<p>Your browser does not support the video element.</p>
</video> -->


### Why am I not able to stake?

Check if you have funds on the Main Ethereum Network, to delegate your tokens. All staking happens on the Ethereum Network only.


### I am unable to view the staking tab. How do I access staking?

You just need to access **https://staking.polygon.technology/**, where you will see the following landing page:

![img](../../../img/pos/staking-lp.png)



### How do I know which validator to select for better rewards?

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

### How to unbond?

To unbond from a validator, navigate to MyAccount, where you find **Your Delegations**.
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.

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


Please watch the video for a graphical illustration of how this works:

<video loop width="100%" height="100%" controls="true" >
<source type="video/mp4" src="../../../../img/pos/unbond.mp4"></source>
<p>Your browser does not support the video element.</p>
</video>


### What is the unbonding period?

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.
This period applies to the originally delegated amount and re-delegated amounts. It does not apply to any rewards that were not re-delegated.


### How to restake rewards?

Go to **My Account** to check **Your Delegations**.
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.

`Step 1`
<center>
![img](../../../img/pos/restake-rewards1.png)
</center>

`Step 2` <br/>
<center>
![img](../../../img/pos/restake-rewards2.png)
</center>

Please watch the video for a graphical illustration of how this works:

<video width="100%" height="100%" controls="true" >
<source type="video/mp4" src="../../../../img/pos/restake.mp4"></source>
<p>Your browser does not support the video element.</p>
</video>

### I want to restake rewards but I am unable to.

You would need to have a minimum of **2 Matic** to restake rewards.

### How to withdraw rewards?

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.

`Step 1` <br/>
<center>
![img](../../../img/pos/withdraw1.png)
</center>

`Step 2` <br/>
<center>
![img](../../../img/pos/withdraw2.png)
</center>

Please watch the video for a graphical illustration of how this works:

<video width="100%" height="100%" controls="true" >
<source type="video/mp4" src="../../../../img/pos/claim-rewards.mp4"></source>
<p>Your browser does not support the video element.</p>
</video>

### I want to withdraw rewards but I am unable to.

You would need to have a minimum of **2 Matic** to withdraw rewards.

### How to claim stake?

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.

`Step 1` <br/>
<center>
![img](../../../img/pos/claim-stake1.png)
</center>

`Step 2` <br/>
<center>
![img](../../../img/pos/claim-stake2.png)
</center>

`Step 3` <br/>
<center>
![img](../../../img/pos/claim-stake3.png)
</center>

Please watch the video for a graphical illustration of how this works:

<video width="100%" height="100%" controls="true" >
<source type="video/mp4" src="../../../../img/pos/claiming-stake.mov"></source>
<p>Your browser does not support the video element.</p>
</video>


### Which wallets are currently supported?

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.
Expand Down Expand Up @@ -55,7 +205,7 @@ No. All your funds need to be on the main Ethereum network.

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

### When does reward get distributed?
### When do rewards get distributed?

The rewards are distributed whenever a checkpoint is submitted.

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

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

### Why does reward keep getting decreased every checkpoint?
### Why do rewards keep getting decreased at every checkpoint?

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.

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

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


<!--
### What is the unbonding period?
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.
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. -->

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

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


### Can I move the stake to another validator?
Yes, you just have to access **Your Delegations**, click on **Move Stake**, and then choose your new validator.

Please watch the video for a graphical illustration of how this works:

<video width="100%" height="100%" controls="true" >
<source type="video/mp4" src="../../../../img/pos/moving.mp4"></source>
<p>Your browser does not support the video element.</p>
</video>



### Which browser is compatible with the Polygon earnings calculator?

Chrome, Firefox, and Brave
Expand Down
12 changes: 7 additions & 5 deletions docs/pos/operate-node/validator/issues/reporting-issues.md
Original file line number Diff line number Diff line change
@@ -1,21 +1,23 @@

## Where to report a bug

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.**
For any bugs or attacks that are discovered, you need to report them to the [Immunefi bug bounty program](https://immunefi.com/bounty/polygon/).

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.
!!!info
Performing an attack and not providing submission of your proof will result in disqualification of your attempt.

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.

## What happens after submitting a report

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.
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.

## Contact us for further questions

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

### Via E-mail

* Anurag — [email protected]
* Parvez — [email protected]

### Via Discord
Expand Down
Loading

0 comments on commit 343ff46

Please sign in to comment.