Skip to content

Commit 694ac09

Browse files
committed
PoS: node how-tos reoerg and revision
- Page restructuring - Content revision
1 parent e2df3b6 commit 694ac09

28 files changed

+936
-2180
lines changed

docs/img/pos/change-owner-1.png

15.1 KB
Loading

docs/img/pos/change-owner-2.png

131 KB
Loading

docs/img/pos/polygon-instance.png

240 KB
Loading

docs/img/pos/support-portal-1.png

254 KB
Loading

docs/pos/get-started/becoming-a-validator.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -191,12 +191,12 @@ The following step-by-step guides will take you through the process of running a
191191

192192
* [Start and run the nodes with Ansible](../how-to/validator/validator-ansible.md).
193193
* [Start and run the nodes with binaries](../how-to/validator/validator-binaries.md).
194-
* [Stake as a validator](../how-to/operate-validator-node/validator-staking-operations.md).
194+
* [Stake as a validator](../how-to/operate-validator-node/next-steps.md#stake-tokens).
195195

196196
### Maintain your validator nodes
197197

198198
* [Change the signer address](../how-to/operate-validator-node/change-signer-address.md).
199-
* [Change the commission](../how-to/operate-validator-node/validator-commission-operations.md).
199+
* [Change the commission](../how-to/operate-validator-node/next-steps.md#changing-your-commission-rate).
200200

201201
### Community assistance
202202

docs/pos/how-to/choose-node-type.md

Lines changed: 0 additions & 14 deletions
This file was deleted.

docs/pos/how-to/erigon-archive-node.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -8,9 +8,9 @@ comments: true
88
- RAM: 64GB
99
- Storage
1010
- Basically `io1` or above with at least 20k+ iops and RAID-0 based disk structure
11-
- Mainnet archive node: 10TB
11+
- Mainnet archive node: 15TB
1212
- Amoy testnet archive node: 1TB
13-
- SSD or NVMe. Bear in mind that SSD performance deteriorates when close to capacity
13+
- SSD or NVMe. Bear in mind that SSD performance deteriorates when close to capacity.
1414
- Golang: >= v1.20
1515
- GCC: >= v10
1616

@@ -34,16 +34,16 @@ This should create the binary at `./build/bin/erigon`
3434

3535
## Start Erigon client
3636

37-
When connecting to Amoy testnet, use the following command to start your Erigon client:
37+
If you're deploying to mainnet, run the following command:
3838

3939
```bash
40-
erigon --chain=amoy
40+
erigon --chain=bor-mainnet --db.size.limit=12TB --db.pagesize=16KB # remaining flags follow
4141
```
4242

43-
If you're deploying to mainnet, run the following command:
43+
When connecting to Amoy testnet, use the following command to start your Erigon client:
4444

4545
```bash
46-
erigon --chain=bor-mainnet --db.size.limit=12TB --db.pagesize=16KB # remaining flags follow
46+
erigon --chain=amoy
4747
```
4848

4949
## Configure Erigon client
@@ -60,11 +60,11 @@ If you are not using local **heimdall**, use `-bor.heimdall=<your heimdall url>`
6060
erigon --chain=amoy --bor.heimdall=<your heimdall url> --datadir=<your_data_dir>
6161
```
6262

63-
!!! note "Node RPC"
63+
## Node RPC
6464

65-
- If you want to connect to Polygon Amoy Testnet, use: [https://heimdall-api-amoy.polygon.technology](https://heimdall-api-amoy.polygon.technology)
65+
- If you want to connect to PoS Amoy Testnet, use: [https://heimdall-api-amoy.polygon.technology](https://heimdall-api-amoy.polygon.technology)
6666

67-
- For Polygon mainnet, use: [https://heimdall-api.polygon.technology](https://heimdall-api.polygon.technology)
67+
- For PoS mainnet, use: [https://heimdall-api.polygon.technology](https://heimdall-api.polygon.technology)
6868

6969
!!! tip
7070

docs/pos/how-to/full-node/full-node-ansible.md

Lines changed: 6 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -2,36 +2,18 @@
22
comments: true
33
---
44

5-
An [Ansible playbook](https://docs.ansible.com/ansible/latest/user_guide/playbooks_intro.html) is used to configure and manage a full node.
5+
An [Ansible playbook](https://docs.ansible.com/ansible/latest/user_guide/playbooks_intro.html) can be used to configure and manage a full node.
66

77
## Prerequisites
88

99
- Install Ansible on your local machine with Python3.x. The setup doesn't run on Python 2.x.
1010
- To install Ansible with Python 3.x, you can use pip. If you do not have pip on your machine,
1111
follow the steps outlined [here](https://pip.pypa.io/en/stable/). Run `pip3 install ansible` to install
1212
Ansible.
13-
- Check the [Polygon PoS Ansible repository](https://github.com/maticnetwork/node-ansible#requirements) for
14-
requirements.
13+
- Check the [Polygon PoS Ansible repository](https://github.com/maticnetwork/node-ansible#requirements) for requirements.
1514
- You also need to ensure that Go is *not installed* in your environment. You will run into issues if you attempt to set up your full node through Ansible with Go installed as Ansible requires specific packages of Go.
1615
- You will also need to make sure that your VM / Machine does not have any previous setups for Polygon Validator or Heimdall or Bor. You will need to delete them as your setup will run into issues.
1716

18-
!!! info "Heimdall source enhancements"
19-
20-
The latest Heimdall version, **[v1.0.3](https://github.com/maticnetwork/heimdall/releases/tag/v1.0.3)**, contains a few enhancements.
21-
The delay time between the contract events of different validators **has been increased** to ensure that the mempool doesn't get filled quickly in case of a burst of events that could hamper the chain's progress.
22-
23-
Additionally, the data size **has been restricted in state sync txs to 30Kb (when represented in bytes) and 60Kb (when defined as string)**.
24-
25-
For example:
26-
27-
```bash
28-
Data - "abcd1234"
29-
Length in string format - 8
30-
Hex Byte representation - [171 205 18 52]
31-
Length in byte format - 4
32-
```
33-
34-
3517
## Full node setup
3618

3719
- Ensure you have access to the remote machine or VM on which the full node is being set up.
@@ -97,10 +79,10 @@ An [Ansible playbook](https://docs.ansible.com/ansible/latest/user_guide/playboo
9779
- On the remote machine/VM, run `curl localhost:26657/status`
9880
- In the output, `catching_up` value should be `false`
9981

100-
- Once Heimdall is synced, run
82+
- Once Heimdall is synced, run:
10183
- `sudo service bor start`
10284

103-
You have successfully set up a full node with Ansible.
85+
If you've reached this point, you have successfully set up a full node with Ansible.
10486
10587
!!! note
10688
@@ -120,14 +102,8 @@ Logs can be managed by the `journalctl` linux tool. Here is a tutorial for advan
120102
journalctl -u heimdalld.service -f
121103
```
122104
123-
### Check Bor REST-server logs
105+
### Check Bor node logs
124106
125107
```bash
126108
journalctl -u bor.service -f
127-
```
128-
129-
## Ports and firewall setup
130-
131-
Open ports `22`, `26656` and `30303` to world (0.0.0.0/0) on sentry node firewall.
132-
133-
You can use VPN to restrict access for port 22 as per your requirement and security guidelines.
109+
```

docs/pos/how-to/full-node/full-node-binaries.md

Lines changed: 10 additions & 37 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
comments: true
33
---
44

5-
This deployment guide walks you through starting and running a full node through various methods. For the system requirements, see the [minimum technical requirements](../validator/validator-system-requirements.md) guide.
5+
This deployment guide walks you through starting and running a full node through various methods. For the system requirements, see the [minimum technical requirements](../prerequisites.md) guide.
66

77
!!! tip "Snapshots"
88

@@ -17,7 +17,7 @@ This deployment guide walks you through starting and running a full node through
1717

1818
!!! warning
1919

20-
It's crucial to follow the outlined sequence of actions precisely; deviating from it may result in encountering issues.
20+
It is essential to follow the outlined sequence of actions precisely, as any deviation may lead to potential issues.
2121

2222
- Prepare the machine.
2323
- Install Heimdall and Bor binaries on the full node machine.
@@ -29,7 +29,7 @@ This deployment guide walks you through starting and running a full node through
2929

3030
### Install `build-essential`
3131

32-
This is **required** for your full node. In order to install, run the below command:
32+
This is *required* for your full node. In order to install, run the below command:
3333

3434
```bash
3535
sudo apt-get update
@@ -44,22 +44,7 @@ Both binaries must be installed and run in the correct order to function properl
4444

4545
### Heimdall
4646

47-
Install the latest version of Heimdall and related services. Make sure you checkout to the correct [release version](https://github.com/maticnetwork/heimdall/releases). Note that the latest version, [Heimdall v1.0.5](https://github.com/maticnetwork/heimdall/releases/tag/v1.0.5), contains enhancements such as:
48-
49-
1. Restricting data size in state sync txs to:
50-
* *30Kb* when represented in `bytes`
51-
* *60Kb* when represented as `string`
52-
53-
2. Increasing the `delay time` between the contract events of different validators to ensure that the mempool doesn't get filled very quickly in case of a burst of events which can hamper the progress of the chain.
54-
55-
The following example shows how the data size is restricted:
56-
57-
```
58-
Data - "abcd1234"
59-
Length in string format - 8
60-
Hex Byte representation - [171 205 18 52]
61-
Length in byte format - 4
62-
```
47+
Install the latest version of Heimdall and related services. Make sure you checkout to the correct [release version](https://github.com/maticnetwork/heimdall/releases).
6348

6449
To install *Heimdall*, run the following commands:
6550

@@ -73,7 +58,7 @@ You can run the above command with following options:
7358
- `network_type`: `mainnet` and `amoy`
7459
- `node_type`: `sentry`
7560

76-
That will install the `heimdalld` and `heimdallcli` binaries. Verify the installation by checking the Heimdall version on your machine:
61+
This will install the `heimdalld` and `heimdallcli` binaries. Verify the installation by checking the Heimdall version on your machine:
7762

7863
```bash
7964
heimdalld version --long
@@ -88,9 +73,9 @@ chown heimdall /var/lib/heimdall
8873

8974
### Configure Heimdall seeds (Amoy)
9075

91-
The Heimdall seeds don't need to be configured manually for Amoy testnet since they've already been included at genesis.
76+
The Heimdall and Bor seeds don't need to be configured manually for Amoy testnet since they've already been included at genesis.
9277

93-
### Bor install
78+
### Bor
9479

9580
Install the latest version of Bor, based on valid v1.0+ [released version](https://github.com/maticnetwork/bor/releases).
9681

@@ -119,7 +104,7 @@ chown bor /var/lib/bor
119104

120105
### Configure Bor seeds (Amoy)
121106

122-
The Bor seeds don't need to be configured manually for Amoy testnet since they've already been included at genesis.
107+
The Heimdall and Bor seeds don't need to be configured manually for Amoy testnet since they've already been included at genesis.
123108

124109
### Update service config user permission
125110

@@ -160,20 +145,8 @@ Logs can be managed by the `journalctl` linux tool. Here is a tutorial for advan
160145
journalctl -u heimdalld.service -f
161146
```
162147

163-
### Check Heimdall REST-server logs
164-
165-
```bash
166-
journalctl -u heimdalld-rest-server.service -f
167-
```
168-
169-
### Check Bor REST-server logs
148+
### Check Bor node logs
170149

171150
```bash
172151
journalctl -u bor.service -f
173-
```
174-
175-
## Ports and firewall setup
176-
177-
Open ports `22`, `26656` and `30303` to world (0.0.0.0/0) on sentry node firewall.
178-
179-
You can use VPN to restrict access for port `22` as per your requirement and security guidelines.
152+
```

0 commit comments

Comments
 (0)