Skip to content

Commit 29967e6

Browse files
authored
Merge pull request 0xPolygon#187 from 0xPolygon/pos-node-deploy-guides-update
PoS reorg
2 parents b6ab630 + 60273bf commit 29967e6

40 files changed

+1518
-338
lines changed

docs/pos/operate-node/validator/responsibilities.md renamed to docs/pos/get-started/becoming-a-validator.md

Lines changed: 94 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,70 @@
1+
Validators are the key actor in maintaining the Polygon network. Validators run a full node, secure the network by staking MATIC to produce blocks, validate and participate in PoS consensus.
12

2-
!!!tip
3-
Stay in the know
3+
!!!info
4+
5+
There is limited space for accepting new validators. New validators can only join the active set when a currently active validator unbonds/is removed due to low performance.
6+
If you are interested in becoming a validator on the PoS network, you can submit an application here: https://polygoncommunity.typeform.com/validatorshub
47

5-
Keep up with the latest node and validator updates from the Polygon team and the community by subscribing to the [Polygon notification groups](https://polygon.technology/notifications/).
8+
* Submitting an application does not guarantee you a validator slot.
69

710

8-
A blockchain validator is someone who is responsible for validating transactions within a blockchain. On the Polygon Network, any participant can be qualified to become a Polygon's validator by running a **Validator Node (Sentry + Validator)** to earn rewards and collect transaction fees. To ensure the good participation by validators, they lock up at least 1 MATIC token as a stake in the ecosystem.
11+
## Overview
12+
13+
Polygon consists of the three following layers:
14+
15+
* Ethereum layer — a set of contracts on the Ethereum mainnet.
16+
* Heimdall layer — a set of proof-of-stake Heimdall nodes running in parallel to the Ethereum mainnet, monitoring the set of staking contracts deployed on the Ethereum mainnet, and committing the Polygon Network checkpoints to the Ethereum mainnet. Heimdall is based on Tendermint.
17+
* Bor layer — a set of block-producing Bor nodes shuffled by Heimdall nodes. Bor is based on Go Ethereum.
18+
19+
To be a validator on the Polygon Network, you must run:
20+
21+
* Sentry node — a separate machine running a Heimdall node and a Bor node. A sentry node is open to all nodes on the Polygon Network.
22+
* Validator node — a separate machine running a Heimdall node and a Bor node. A validator node is only open to its sentry node and closed to the rest of the network.
23+
* Stake the MATIC tokens in the staking contracts deployed on the Ethereum mainnet.
24+
25+
## Components
26+
27+
### Heimdall
28+
29+
Heimdall does the following:
30+
31+
* Monitors the staking contracts on the Ethereum mainnet.
32+
* Verifies all state transitions on the Bor chain.
33+
* Commits the Bor chain state checkpoints to the Ethereum mainnet.
34+
35+
Heimdall is based on Tendermint.
36+
37+
!!!info
38+
See Also
39+
40+
* GitHub repository: [Heimdall](https://github.com/maticnetwork/heimdall)
41+
* GitHub repository: [Staking contracts](https://github.com/maticnetwork/contracts/tree/master/contracts/staking)
42+
* Blog post: [Heimdall](https://polygon.technology/blog/heimdall-vaibhav-chellani-the-all-seeing-all-hearing-protector-of-matic)
43+
### Bor
44+
45+
Bor does the following:
46+
47+
* Produces blocks on the Polygon Network.
48+
49+
Bor is the Block producer node and layer for the Polygon Network. It is based on Go Ethereum. Blocks produced on Bor are validated by Heimdall nodes.
950

1051
!!!info
52+
See Also
53+
54+
* GitHub repository: [Bor](https://github.com/maticnetwork/bor)
55+
* Blog post: [Heimdall and Bor](https://blog.polygon.technology/heimdall-and-bor/)
56+
57+
## Validator responsibilities
58+
59+
!!!tip "Stay in the know"
60+
61+
Keep up with the latest node and validator updates from the Polygon team and the community by keeping an eye on the [announcements posed to Polygon forums](https://forum.polygon.technology/c/announcement/6).
62+
63+
A blockchain validator is someone who is responsible for validating transactions within a blockchain. On the Polygon Network, any participant can be qualified to become a Polygon's validator by running a **Validator Node (Sentry + Validator)** to earn rewards and collect transaction fees. To ensure the good participation by validators, they lock up at least 1 MATIC token as a stake in the ecosystem.
64+
65+
!!!info "Active validator limit"
1166

12-
Currently, there is a limit of 100 active validators at a time. For a detailed description on what a validator is, see [<ins>Validator</ins>](./getting-started.md).
67+
Currently, there is a limit of 100 active validators at a time.
1368

1469
Also, after the [<ins>PIP4 governance proposal</ins>](https://forum.polygon.technology/t/pip-4-validator-performance-management/9956) is implemented on the contract-level, the minimum staking amount will increase to 10,000 MATIC.
1570

@@ -29,7 +84,7 @@ Any validator on the Polygon Network has the following responsibilities:
2984
* Provide feedback and suggestions
3085
* Earn staking rewards for validate blocks on the blockchain
3186

32-
## Technical node operations
87+
### Technical node operations
3388

3489
The following technical node operations are **done automatically by the nodes:**
3590

@@ -43,37 +98,37 @@ The following technical node operations are **done automatically by the nodes:**
4398
* If more than 2/3 of the active validators reach consensus on the checkpoint, the checkpoint is submitted to the Ethereum mainnet.
4499
* Sync changes to Polygon staking contracts on Ethereum:
45100
* Continuing from the checkpoint submission step, since this is an external network call, the checkpoint transaction on Ethereum may or may not be confirmed, or may be pending due to Ethereum congestion issues.
46-
* In this case, there is an `ack/no-ack` process that is followed to ensure that the next checkpoint contains a snapshot of the previous Bor blocks as well. For example, if checkpoint 1 is for Bor blocks 1-256, and it failed for some reason, the next checkpoint 2 will be for Bor blocks 1-512. See also [Heimdall architecture: Checkpoint](/pos/design/heimdall/checkpoint.md).
101+
* In this case, there is an `ack/no-ack` process that is followed to ensure that the next checkpoint contains a snapshot of the previous Bor blocks as well. For example, if checkpoint 1 is for Bor blocks 1-256, and it failed for some reason, the next checkpoint 2 will be for Bor blocks 1-512. See also [Heimdall architecture: Checkpoint](/pos/architecture/heimdall/checkpoints).
47102
* State sync from the Ethereum mainnet to Bor:
48103
* Contract state can be moved between Ethereum and Polygon, specifically through Bor:
49104
* A DApp contract on Ethereum calls a function on a special Polygon contract on Ethereum.
50105
* The corresponding event is relayed to Heimdall and then Bor.
51106
* A state-sync transaction gets called on a Polygon smart contract and the DApp can get the value on Bor via a function call on Bor itself.
52-
* A similar mechanism is in place for sending state from Polygon to Ethereum. See also [State Sync Mechanism](/docs/pos/state-sync/state-sync).
107+
* A similar mechanism is in place for sending state from Polygon to Ethereum. See also [State Sync Mechanism](/pos/how-to/bridging/l1-l2-communication/state-transfer).
53108

54-
## Operations
109+
### Operations
55110

56-
### Maintain high uptime
111+
#### Maintain high uptime
57112

58113
The node uptime on the Polygon Network is based on the number of checkpoint transactions that the validator node has signed.
59114

60115
Approximately every 34 minutes a proposer submits a checkpoint transaction to the Ethereum mainnet. The checkpoint transaction must be signed by every validator on the Polygon Network. **Failure to sign a checkpoint transaction results in the decrease of your validator node performance**.
61116

62117
The process of signing the checkpoint transactions is automated. To ensure your validator node is signing all valid checkpoint transactions, you must maintain and monitor your node health.
63118

64-
### Check node services and processes daily
119+
#### Check node services and processes daily
65120

66121
You must check daily the services and processes associated with Heimdall and Bor. Also, pruning of the nodes should be done regularly to reduce disk usage.
67122

68-
### Run node monitoring
123+
#### Run node monitoring
69124

70125
You must run either:
71126

72127
* Grafana Dashboards provided by Polygon. See GitHub repository: [Matic-Jagar setup](https://github.com/vitwit/matic-jagar)
73128
* Or, use your own monitoring tools for the validator and sentry nodes
74129
* Ethereum endpoint used on nodes should be monitored to ensure the node is within the request limits
75130

76-
### Keep an ETH balance
131+
#### Maintain ETH balance
77132

78133
You must maintain an adequate amount of ETH (should be always around the threshold value i.e., 0.5 to 1) on your validator signer address on the Ethereum Mainnet.
79134

@@ -88,29 +143,49 @@ Not maintaining an adequate amount of ETH on the signer address will result in:
88143
* Delays in the finality of transactions included in the checkpoints.
89144
* Delays in subsequent checkpoint transactions.
90145

91-
## Delegation
146+
### Delegation
92147

93-
### Be open for delegation
148+
#### Be open for delegation
94149

95150
All validators must be open for delegation from the community. Each validator has the choice of setting their own commission rate. There is no upper limit to the commission rate.
96151

97-
### Communicate commission rates
152+
#### Communicate commission rates
98153

99154
It is the moral duty of the validators to communicate the commission rates and the commission rate changes to the community. The preferred platforms to communicate the commission rates are:
100155

101156
* [Discord](https://discord.com/invite/0xPolygon)
102157
* [Forum](https://forum.polygon.technology/)
103158

104-
## Communication
159+
### Communication
105160

106-
### Communicate issues
161+
#### Communicate issues
107162

108163
Communicating issues as early as possible ensures that the community and the Polygon team can rectify the problems as soon as possible. The preferred platforms to communicate the commission rates are:
109164

110165
* [Discord](https://discord.com/invite/0xPolygon)
111166
* [Forum](https://forum.polygon.technology/)
112167
* [GitHub](https://github.com/maticnetwork)
113168

114-
### Provide feedback and suggestions
169+
#### Provide feedback and suggestions
115170

116171
At Polygon, we value your feedback and suggestions on any aspect of the validator ecosystem. [Forum](https://forum.polygon.technology/) is the preferred platform to provide feedback and suggestions.
172+
173+
## Run and maintain a node
174+
175+
The following step-by-step guides will take you through the process of running a new validator node, or performing necessary maintenance actions for an existing node you've deployed.
176+
177+
### Join the network as a validator
178+
179+
* [Start and run the nodes with Ansible](/pos/how-to/validator/validator-ansible).
180+
* [Start and run the nodes with binaries](/pos/how-to/validator/validator-binaries).
181+
* [Stake as a validator](/pos/how-to/operate-maintain-node/validator-staking-operations).
182+
183+
### Maintain your validator nodes
184+
185+
* [Change the signer address](/pos/how-to/operate-maintain-node/change-signer-address).
186+
* [Change the commission](/pos/how-to/operate-maintain-node/validator-commission-operations).
187+
188+
### Community assistance
189+
190+
* [Discord](https://discord.com/invite/0xPolygon)
191+
* [Forum](https://forum.polygon.technology/)

docs/pos/get-started/building-on-polygon.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
Ethereum developers are by default Polygon developers. Welcome. Simply switch to the [Polygon RPC](https://polygon-rpc.com/) and get started. All familiar tools used on Ethereum are supported on Polygon. Whether it is Truffle, Remix or Web3js, Polygon offers the same UX as Ethereum.
1+
Ethereum developers are by default Polygon developers. Welcome. Simply switch to the [Polygon RPC](https://polygon-rpc.com/) and get started. All familiar tools used on Ethereum are supported on Polygon. Whether it is Truffle, Remix or Web3.js, Polygon offers the same UX as Ethereum.
22

33
Connect your wallet and deploy any decentralized application to either Polygon Mainnet or Polygon Mumbai Testnet.
44

@@ -11,7 +11,7 @@ Find all the network-related details in the [network documentation](../referenc
1111
Polygon is a layer 2 (L2) network to Ethereum, employing a proof-of-stake (PoS) consensus mechanism, and thus composed of the following two layers:
1212

1313
- Heimdall layer, a consensus layer consisting of a set of proof-of-stake Heimdall nodes for monitoring staking contracts deployed on the Ethereum mainnet, and committing the Polygon Network checkpoints to the Ethereum mainnet. Heimdall is based on Tendermint.
14-
- Bor layer, an execution layer which is made up of a set of block-producing Bor nodes shuffled by Heimdall nodes. Bor is based on Go Ethereum (Geth).
14+
- Bor layer, an execution layer which is made up of a set of block-producing Bor nodes shuffled by Heimdall nodes. Bor is based on Go Ethereum (Geth).
1515

1616
In order to be a validator on the Polygon Network, you need to:
1717

File renamed without changes.

0 commit comments

Comments
 (0)