Skip to content

Commit 5a3def1

Browse files
committed
Merge branch 'main' of github.com:0xPolygon/polygon-docs into empieichO-docs-review
2 parents 95f4790 + fa77b91 commit 5a3def1

File tree

16 files changed

+196
-276
lines changed

16 files changed

+196
-276
lines changed

.github/workflows/prod_deployment.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -31,6 +31,7 @@ jobs:
3131
uses: actions/checkout@v3
3232
with:
3333
submodules: true
34+
fetch-depth: 0
3435

3536
- name: Configure AWS credentials
3637
uses: aws-actions/configure-aws-credentials@v1-node16

.github/workflows/staging_deployment.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,7 @@ jobs:
2424
uses: actions/checkout@v3
2525
with:
2626
submodules: true
27+
fetch-depth: 0
2728

2829
- name: Configure AWS credentials
2930
uses: aws-actions/configure-aws-credentials@v1-node16

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

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

2-
# How to Delegate
2+
# How to delegate
33

44
This is a step-by-step guide to help you become a delegator on the Polygon Network.
55

@@ -24,7 +24,7 @@ The only prerequisite is to have your MATIC tokens and ETH on the Ethereum mainn
2424
If you are a validator, use a different non-validating address to log in as delegator.
2525

2626

27-
## Delegate to a Validator
27+
## Delegate to a validator
2828

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

@@ -80,7 +80,7 @@ This will withdraw the MATIC token rewards to your Ethereum address.
8080

8181
This will restake the MATIC token rewards to the validator and increase your delegation stake.
8282

83-
## Unbond from a Validator
83+
## Unbond from a validator
8484

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

Lines changed: 19 additions & 78 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,12 @@
11

2-
### What is the Staking Dashboard URL?
2+
### What is the staking dashboard URL?
33

44
The staking dashboard URL is https://staking.polygon.technology/.
55

66
### What is the minimum stake amount?
77

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

10-
### How many rewards will I get if I delegate?
11-
12-
Please use the [Staking Rewards Calculator](https://staking.polygon.technology/rewards-calculator) to determine your estimates.
13-
1410
### Why does my transaction take so long?
1511

1612
All staking transactions of Polygon happen on Ethereum for security reasons.
@@ -47,15 +43,15 @@ On the Dashboard, you can click on the **My Account** option on the left-hand si
4743
![Figure: My account](../../../img/pos/my-account.png)
4844

4945

50-
### Do I need ETH to pay for Gas fees?
46+
### Do I need ETH to pay for gas fees?
5147

5248
Yes. You should provision for ~0.05-0.1 ETH to be safe.
5349

54-
### Do I need to deposit MATIC tokens to the Polygon Mainnet network for staking?
50+
### Do I need to deposit MATIC tokens to the Polygon mainnet network for staking?
5551

56-
No. All your funds need to be on the Main Ethereum Network.
52+
No. All your funds need to be on the main Ethereum network.
5753

58-
### When I try to do the transaction my Confirm button is disabled, why so?
54+
### When I try to do the transaction my **Confirm** button is disabled.
5955

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

@@ -84,7 +80,7 @@ You can claim your rewards instantly by clicking on the **Withdraw Reward** butt
8480
![Figure: Withdraw-reward](../../../img/pos/withdraw-reward.png)
8581

8682

87-
### What is the Unbonding period?
83+
### What is the unbonding period?
8884

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

@@ -98,16 +94,14 @@ Delegation requires 2 transactions, one after the other. One to **Approve** the
9894

9995
![Figure: Delegate ](../../../img/pos/delegate.png)
10096

101-
102-
103-
### What does Redelegate Rewards mean?
97+
### What does redelegate rewards mean?
10498

10599
Redelegating your rewards simply means that you want to increase your stake by restaking the rewards you have accumulated.
106100

107101
### Can I stake to any validator?
108102
Yes, you can delegate to any validator except the ones which are offline.
109103

110-
### Which browser is compatible with Staking Dashboard?
104+
### Which browser is compatible with the Polygon earnings calculator?
111105

112106
Chrome, Firefox, and Brave
113107

@@ -122,7 +116,7 @@ Check for the following:
122116

123117
### How do I send funds from Binance or other exchanges to Polygon wallet?
124118

125-
Technically, the Polygon Wallet Suite/Staking interface is just a web application. Currently it supports the following wallets - Metamask, WalletConnect, and WalletLink.
119+
The Polygon Wallet Suite is a web application.
126120

127121
First, you must withdraw your funds from Binance or any other exchange to your Ethereum address on Metamask. If you don't know how to use Metamask, google it a bit. There are plenty of videos and blogs to get started with it.
128122

@@ -140,87 +134,34 @@ If you have not re-delegated your rewards before delegating additional funds to
140134

141135
In case you dont want that to happen, re-delegate your rewards before delegating additional funds.
142136

143-
### I have delegated my tokens via MetaMask on the Staking dashboard. Do I need to keep my system or device on?
137+
### I have delegated my tokens via MetaMask on the dashboard. Do I need to keep my system or device on?
144138

145-
No. Once your Delegation transactions are confirmed, and you can see your tokens reflected in the **Total Stake** and **New Reward** sections, then you are done. There is no need to keep your system or device on.
139+
No. Once your delegation transactions are confirmed, and you can see your tokens reflected in the **Total Stake** and **New Reward** sections, then you are done. There is no need to keep your system or device on.
146140

147-
### I have unbonded, how long will it take to Unbond?
141+
### I have unbonded, how long will it take to unbond?
148142

149143
The unbonding period is currently set to 80 checkpoints. Every checkpoint takes approximately 30 minutes. However, some checkpoints could be delayed upto ~1 hour due to congestion on Ethereum.
150144

151-
### I have unbonded, and I now see the Claim Stake button, but it is disabled, why is that?
145+
### I have unbonded, and I now see the **Claim Stake** button, but it is disabled.
152146

153147
The Claim Stake button will only be enabled when your unbonding period is complete. The unbonding period is currently set at 80 checkpoints.
154148

155-
### Do I know when will the Claim Stake button be enabled?
149+
### When will the **Claim Stake** button be enabled?
156150

157-
Yes, under the Claim Stake button you would see a note on how many checkpoints are pending before the Claim Stake button would be enabled. Every checkpoint takes approximately 30 minutes. However, some checkpoints could be delayed upto ~1 hour due to congestion on Ethereum.
151+
Under the **Claim Stake** button you should see a note on how many checkpoints are pending before the **Claim Stake** button is enabled. Every checkpoint takes approximately 30 minutes. However, some checkpoints could be delayed upto ~1 hour due to congestion on Ethereum.
158152

159153
![Figure: Unbound ](../../../img/pos/unbond.png)
160154

161155

162-
<!-->Hiding questions pertaining to foundation nodes, since there are no foundation nodes anymore<!-->
163-
<!--
164-
### How do I switch my delegation from Foundation Nodes to External nodes?
165-
166-
You can switch your Delegation using the **Move Stake** option on the Staking UI. This will switch your Delegation from the Foundation node to any other external node of your choice.
167-
168-
<div align="center">
169-
<img src={useBaseUrl("/img/delegator-faq/move-stake.png")} width="500" />
170-
</div>
171-
172-
You will see a list of other validators:
173-
174-
<div>
175-
<img src={useBaseUrl("/img/delegator-faq/validators.png")} />
176-
</div>
177-
178-
179-
### Will there be any ubonding period when I switch Delegation from Foundation nodes to external nodes?
180-
181-
There will be no Unbonding period when you switch Delegation from foundation nodes to external nodes. It will be a direct switch without any delays. However, if you are unbonding from a Foundation Node or an External node there will be an Unbonding period for that.
182-
183-
### Are they any specifics to choose an external node during switch delegation?
184-
185-
No. You can choose any node of your choice.
186-
187-
### What happens to my rewards that are accumalated if I switch delegation from Foundation to External node?
188-
189-
If you haven't already claimed your rewards before switching delegation, then upon successful switch of your delegation from Foundation to External the Rewards that were accumalated till then will be transferred back to your account.
190-
191-
### Will delegation on the External Nodes work the same as Foundation Nodes?
192-
193-
Yes, it will work the same as Foundation nodes.
194-
195-
### Will I still get rewards after delegating to an External Node?
196-
197-
Yes, rewards will be distributed the same as earlier with the Foundation nodes. Every successful submission of a checkpoint will yield in rewards. Rewards will be distributed and calculated at every checkpoint relative to the stake ratio, as currently implemented.
198-
199-
### Will there be any unbonding period if I unbond from an External Node?
200-
201-
Yes, the unbonding period will stay the same as currently implemented. 82 Checkpoints.
202-
203-
### Will there be any locking period after I switch my Delegation from Foundation to External node?
204-
205-
No. There won't be any locking period after you switch your delegation.
206-
207-
### Can I partially switch my delegation from Foundation to External nodes?
208-
209-
Yes, you will have the option to partially move your stake from Foundation node to an external node. The remaining partial stake will remain on the Foundation node. You can then move that to another node of your choice or the same node.
210-
211-
### Can I switch delegation from an external node to another external node?
212-
213-
No, the **Move Stake** option is only available on the Foundation Nodes. If you want to switch your delegation from an external node to another external node, you will have to unbond first and then delegate to another external node.
214-
<!-->
215156

216-
### Have the Foundations nodes been turned off?
157+
### Have the foundations nodes been turned off?
217158

218159
Yes, the foundation nodes had been turned off.
219160

220-
### Will there be any Foundation nodes in the future?
161+
### Will there be any foundation nodes in the future?
221162

222163
No, there won't be any Foundation nodes in the future.
223164

224-
### How many transactions do I need to pay for Gas when I do a Move Stake?
165+
### How many transactions do I need to pay for gas when I do a "move stake"?
225166

226-
The Move Stake is a single transaction only. All transactions would be on the Ethereum Blockchain so you would need to spend some ETH while doing the Move Stake transaction.
167+
The move stake is a single transaction only. All transactions are on the Ethereum blockchain so you will spend some ETH to make the transaction.

docs/pos/operate-node/validator/run-validator/binaries.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -11,11 +11,11 @@ follow the [Validator Node System Requirements](/pos/validator/validator-node-sy
1111
For snapshot download links, see [<ins>Polygon Chains Snapshots</ins>](https://snapshot.polygon.technology/).
1212

1313

14-
## Port Configuration Details
14+
## Port configuration details
1515

16-
Here are a few instructions on how to configure ports for Sentry and Validator nodes.
16+
Here are a few instructions on how to configure ports for sentry and validator nodes.
1717

18-
### For Sentry nodes
18+
### For sentry nodes
1919

2020
- **Port 22**: Opening this to the public is not a good idea as the default SSH port 22 is prone to attacks. It is better to secure it by allowing it only in a closed network (VPN).
2121

@@ -30,7 +30,7 @@ Here are a few instructions on how to configure ports for Sentry and Validator n
3030
- **Ports 8545, 8546, 1317**: Can be opened for Bor HTTP RPC, Bor WS RPC, and Heimdall API respectively; but only if really necessary.
3131

3232

33-
### For Validator nodes
33+
### For validator nodes
3434

3535
- **Port 22**: Opening this to the public is not a good idea as the default SSH port 22 is prone to attacks. It is better to secure it by allowing it only in a closed network (VPN).
3636

docs/pos/operate-node/validator/staking-faq.md

Lines changed: 16 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -32,21 +32,21 @@ Please watch this video for a graphical illustration of how this works:
3232

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

35-
### I am unable to view the Staking tab. How do I access Staking?
35+
### I am unable to view the staking tab. How do I access staking?
3636

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

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

4141

42-
### How do I know which Validator to select for better rewards?
42+
### How do I know which validator to select for better rewards?
4343

4444
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
4545

4646
### How to unbond?
4747

48-
To Unbond from a Validator, navigate to MyAccount, where you find "Your Delegations".
49-
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.
48+
To unbond from a validator, navigate to MyAccount, where you find **Your Delegations**.
49+
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.
5050

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

@@ -66,8 +66,8 @@ This period applies to the originally delegated amount and re-delegated amounts.
6666

6767
### How to restake rewards?
6868

69-
Go to My Account to check "Your Delegations".
70-
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.
69+
Go to **My Account** to check **Your Delegations**.
70+
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.
7171

7272
`Step 1`
7373
<center>
@@ -86,13 +86,13 @@ Please watch the video for a graphical illustration of how this works:
8686
<p>Your browser does not support the video element.</p>
8787
</video>
8888

89-
### I want to Restake Rewards but I am unable to.
89+
### I want to restake rewards but I am unable to.
9090

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

9393
### How to withdraw rewards?
9494

95-
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.
95+
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.
9696

9797
`Step 1` <br/>
9898
<center>
@@ -111,13 +111,13 @@ Please watch the video for a graphical illustration of how this works:
111111
<p>Your browser does not support the video element.</p>
112112
</video>
113113

114-
### I want to Withdraw Rewards but I am unable to.
114+
### I want to withdraw rewards but I am unable to.
115115

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

118118
### How to claim stake?
119119

120-
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.
120+
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.
121121

122122
`Step 1` <br/>
123123
<center>
@@ -143,15 +143,15 @@ Please watch the video for a graphical illustration of how this works:
143143

144144
### Are hardware wallets supported?
145145

146-
Yes, hardware wallets are supported. You can use the "Connect Hardware Wallet" option on MetaMask and connect your Hardware wallet and then continue the delegation process.
146+
Yes, hardware wallets are supported. You can use the **Connect Hardware Wallet** option on MetaMask and connect your Hardware wallet and then continue the delegation process.
147147

148148
### Why can’t I stake directly from Binance?
149149

150150
Staking through Binance is not yet supported. There will be an announcement if and when Binance starts supporting it.
151151

152152

153-
### Do I need to deposit Matic to the Polygon Mainnet network for staking?
154-
No. All your funds need to be on the Main Ethereum Network.
153+
### Do I need to deposit Matic to the Polygon mainnet network for staking?
154+
No. All your funds need to be on the Ethereum mainnet.
155155

156156

157157
### When do rewards get distributed?
@@ -176,7 +176,7 @@ Rewards will be higher, to begin with, and will keep decreasing as the locked su
176176
No. Once you unbond you stop receiving rewards.
177177

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

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

@@ -185,14 +185,14 @@ Please watch the video for a graphical illustration of how this works:
185185
<p>Your browser does not support the video element.</p>
186186
</video>
187187

188-
### Which browsers are compatible with the Staking Dashboard?
188+
### Which browsers are compatible with the staking dashboard?
189189

190190
Chrome, Firefox, and Brave.
191191

192192
### Nothing happens when I try to log in or my MetaMask is stuck at confirming after logging in. What do I do?
193193

194194
Check for the following:
195-
- If you’re using Brave, please turn off the option for Use Crypto Wallets in the settings panel.
195+
- If you’re using Brave, please turn off the option for **Use Crypto Wallets** in the settings panel.
196196
- Check if you are logged into Metamask.
197197
- Check if you are logged into MetaMask with Trezor/Ledger. You need to additionally turn on permission to call contracts on your Ledger device, if not enabled already.
198198
- Check your system timestamp. If the system time is not correct, you will need to correct it.

docs/pos/operate-node/validator/technical-faqs.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -265,12 +265,12 @@ You can run the following command to check it:
265265
Check the value of catching_up. If it is false then the node is all synced up.
266266

267267

268-
### 15. Deprecated FAQ: What if someone become a Top 10 staker, how he will receive his MATIC reward at the end?
268+
### 15. If someone becomes a top 10 staker, how do they receive their MATIC reward?
269269

270270
Stage 1 rewards are not based on stake. Participants with high stake don't automatically qualify for a reward in this stage.
271271

272272

273-
### 16. What should be my heimdall version?
273+
### 16. What should the Heimdall version be?
274274

275275
To check your Heimdall version you can simply run:
276276

0 commit comments

Comments
 (0)