Skip to content

Commit 3099a36

Browse files
committed
PoS: style and language review
Fixing: - Styling and format - Obvious inaccuracies and mistakes
1 parent 53b4590 commit 3099a36

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

64 files changed

+791
-824
lines changed
159 KB
Loading

docs/img/pos/stake-management-flow.svg

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

docs/pos/architecture/bor/commands.md

Lines changed: 11 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,8 @@
11
This guide provides a curated list of common commands and Polygon-specific operations essential for node operators. Whether you're setting up a full node, validator node or troubleshooting, these commands will assist you in managing your Polygon PoS environment effectively.
22

3-
## Frequently Used Commands for Bor & Heimdall
3+
## Frequently used commands
44

5-
Use the tabs below to switch between commands for Bor and Heimdall:
6-
7-
<Tabs
8-
defaultValue="bor"
9-
values={[
10-
{ label: 'Bor Commands', value: 'bor', },
11-
{ label: 'Heimdall Commands', value: 'heimdall', },
12-
]
13-
}>
14-
<TabItem value="bor">
5+
### Bor
156

167
To execute Bor IPC commands, use the following syntax:
178

@@ -32,8 +23,7 @@ bor attach .bor/data/bor.ipc <command>
3223
| `eth.getBlock("latest").number` | `curl http://YourIP:8545 -X POST -H "Content-Type: application/json" -d '{"jsonrpc":"2.0", "id":1, "method":"bor_getSigners", "params":["0x98b3ea"]}'` | Queries the height of the latest Bor block. |
3324
| | `curl http://YourIP:8545 -X POST -H "Content-Type: application/json" --data '{"method":"eth_chainId","params":[],"id":1,"jsonrpc":"2.0"}'` | Retrieves the `chainID`. |
3425

35-
</TabItem>
36-
<TabItem value="heimdall">
26+
### Heimdall
3727

3828
| Command | Description |
3929
| ------- | ----------- |
@@ -45,9 +35,6 @@ bor attach .bor/data/bor.ipc <command>
4535
| `heimdalld unsafe-reset-all` | Resets the database in case of issues. |
4636
| `curl localhost:26657/status` | Provides comprehensive information about Heimdall. |
4737

48-
</TabItem>
49-
</Tabs>
50-
5138
## Node Management Commands
5239

5340
| Description | Command |
@@ -95,14 +82,14 @@ curl http://<your ip>:8545 -X POST -H "Content-Type: application/json" -d '{"jso
9582

9683
### Cleanup: Deleting Remnants of Heimdall and Bor
9784

98-
**For Linux package:**
85+
##### For Linux package:
9986

10087
```bash
10188
sudo dpkg -i matic-bor
10289
sudo rm -rf /etc/bor
10390
```
10491

105-
**For Binaries:**
92+
##### For Binaries:
10693

10794
```bash
10895
sudo rm -rf /etc/bor
@@ -111,14 +98,14 @@ sudo rm /etc/heimdall
11198

11299
### Terminate Bor Process
113100

114-
**For Linux:**
101+
##### For Linux:
115102

116103
```bash
117104
ps -aux | grep bor
118105
sudo kill -9 <PID>
119106
```
120107

121-
**For Binaries:**
108+
##### For Binaries:
122109

123110
```bash
124111
cd CS-2003/bor
@@ -139,14 +126,14 @@ exit
139126

140127
### Stop Heimdall and Bor Services
141128

142-
**For Linux packages:**
129+
##### For Linux packages:
143130

144131
```bash
145132
sudo service heimdalld stop
146133
sudo service bor stop
147134
```
148135

149-
**For Binaries:**
136+
##### For Binaries:
150137

151138
```bash
152139
pkill heimdalld
@@ -157,14 +144,14 @@ bash stop.sh
157144

158145
### Remove Heimdall and Bor Directories
159146

160-
**For Linux packages:**
147+
##### For Linux packages:
161148

162149
```bash
163150
sudo rm -rf /etc/heimdall/*
164151
sudo rm -rf /etc/bor/*
165152
```
166153

167-
**For Binaries:**
154+
##### For Binaries:
168155

169156
```bash
170157
sudo rm -rf /var/lib/heimdalld/

docs/pos/architecture/bor/index.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@ Bor is an integral component of the Polygon network that operates based on princ
22

33
## Proposers and Producers Selection
44

5-
Block Producers for the Bor layer are a committee selected from the Validator pool on the basis of their stake, which happens at regular intervals and is shuffled periodically. These intervals are decided by the Validator's governance with regard to dynasty and network.
5+
Block Producers for the Bor layer are a committee selected from the validator pool on the basis of their stake, which happens at regular intervals and is shuffled periodically. These intervals are decided by the Validator's governance with regard to dynasty and network.
66

77
The ratio of Stake/Staking power specifies the probability to be selected as a member of the block producer committee.
88

@@ -17,7 +17,7 @@ The ratio of Stake/Staking power specifies the probability to be selected as a m
1717

1818
### Validators in Polygon's Proof-of-Stake System
1919

20-
In Polygon's Proof-of-Stake (PoS) framework, participants can stake Matic tokens on a designated Ethereum smart contract, known as the "staking contract," to become validators. Active validators on Heimdall are eligible for selection as block producers through the `bor` module.
20+
In Polygon's Proof-of-Stake (PoS) framework, participants can stake MATIC tokens on a designated Ethereum smart contract, known as the "staking contract," to become validators. Active validators on Heimdall are eligible for selection as block producers through the Bor module.
2121

2222
### Span: Defining Validator Sets and Voting Power
2323

@@ -47,7 +47,7 @@ The potential for forks arises when backup producers generate blocks due to dela
4747

4848
### View Change and Span Commitment
4949

50-
At the end of each span, Bor undergoes a view change, fetching new producers for the subsequent span. This involves an HTTP call to the Heimdall node to retrieve new span data and a `commitSpan` call to the BorValidatorSet genesis contract. Block headers in Bor are also structured to include producer bytes, aiding in the fast-syncing process.
50+
At the end of each span, Bor undergoes a view change, fetching new producers for the subsequent span. This involves an HTTP call to the Heimdall node to retrieve new span data and a `commitSpan` call to the `BorValidatorSet` genesis contract. Block headers in Bor are also structured to include producer bytes, aiding in the fast-syncing process.
5151

5252
### State Synchronization with the Ethereum Chain
5353

docs/pos/architecture/bor/network-config.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
This guide provides a detailed list of default ports used across Polygon nodes, including Bor and Heimdall. Understanding these ports is crucial for network configuration and effective communication between nodes.
22

3-
## Bor Node
3+
## Bor node
44

55
| Name | Port | Tags | Description |
66
|-------------------------|-------|---------------------------|----------------------------------------------------------------------------------------------------------------|
@@ -13,7 +13,7 @@ This guide provides a detailed list of default ports used across Polygon nodes,
1313
| Pprof Server | 7071 | Internal, Monitoring | Pprof server for collecting Bor metrics. |
1414
| UDP Discovery | 30301 | Can be Public, Internal | Default port for Bootnode peer discovery. |
1515

16-
## Heimdall Node
16+
## Heimdall node
1717

1818
| Name | Port | Tags | Description |
1919
|-------------------------|-------|---------------------------|----------------------------------------------------------------------------------------------------------------|

0 commit comments

Comments
 (0)