Skip to content

Commit 7a78048

Browse files
committed
Merge branch 'main' of https://github.com/0xPolygon/polygon-docs into mardizzone/docs-update
2 parents c888aeb + f7f54fc commit 7a78048

File tree

13 files changed

+51
-150
lines changed

13 files changed

+51
-150
lines changed

README.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -69,3 +69,4 @@ docker compose up
6969
- For docs issues (technical or language) open an issue here.
7070
- For technical issues with the software, either raise an issue here and we will follow up, or check https://support.polygon.technology/support/home.
7171

72+
#

docs/_site_essentials/js/init_kapa_widget.js

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

docs/pos/architecture/heimdall_v2/milestones.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ This module enables deterministic finality by leveraging Polygon PoS’s dual cl
66
This is done using a hybrid system that uses CometBFT layer consensus,
77
along with an additional fork choice rule within the execution layer.
88
With the introduction of milestones, finality is deterministic even before a checkpoint is submitted to L1.
9-
After a certain number of blocks (minimum 12), a milestone is proposed and voted by Heimdall.
9+
After a certain number of blocks (minimum 1), a milestone is proposed and voted by Heimdall.
1010
Once 2/3+ of the network agrees, the milestone is finalized, and all transactions up to that milestone are considered final, with no chance of reorganization.
1111

1212
## Flow

docs/pos/how-to/bridging/ethereum-polygon/submit-mapping-request.md

Lines changed: 5 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -16,25 +16,20 @@ Token mapping is important in order to enable the transfer mechanism for the sai
1616

1717
2. Choose a **Network** option depending upon the chain on which you're looking to map your token. This would be **Sepolia <> Polygon Amoy** for testnet, and **Ethereum <> Polygon PoS** for mainnet.
1818

19-
<center>
20-
2119
![form-1](../../../../img/pos/token-mapping-1.png){width=50%}
2220

23-
</center>
24-
3. Next, input the contract address for the token contract that you've deployed on Sepolia/Ethereum mainnet in the **Root Contract Address (L1)** field.
2521

26-
<center>
22+
3. Next, input the contract address for the token contract that you've deployed on Sepolia/Ethereum mainnet in the **Root Contract Address (L1)** field.
2723

2824
![form-2](../../../../img/pos/token-mapping-2.png){width=50%}
2925

30-
</center>
26+
3127
4. Choose the correct **Token Type** for your token. i.e., [ERC-20](https://eips.ethereum.org/EIPS/eip-20) for a standard token, [ERC-721](https://eips.ethereum.org/EIPS/eip-721) for an NFT, or [ERC-1155](https://eips.ethereum.org/EIPS/eip-1155) for a multi token.
32-
33-
<center>
3428

35-
![form-3](../../../../img/pos/token-mapping-3.png){width=20%}
3629

37-
</center>
30+
![form-3](../../../../img/pos/token-mapping-3.png){width=25%}
31+
32+
3833
5. Finally, select **Submit** to send in your request. The Polygon team will review your mapping request, and get back to you with a response. This generally takes up to 7 days.
3934

4035
!!! info "Token list"

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

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -20,8 +20,8 @@ This deployment guide walks you through starting and running a full node through
2020
It is essential to follow the outlined sequence of actions precisely, as any deviation may lead to potential issues.
2121

2222
- Prepare the machine.
23-
- Install Heimdall-v2 and Bor binaries on the full node machine.
24-
- Set up Heimdall-v2 and Bor services on the full node machine.
23+
- Install Heimdall and Bor binaries on the full node machine.
24+
- Set up Heimdall and Bor services on the full node machine.
2525
- Configure the full node machine.
2626
- Start the full node machine.
2727
- Check node health with the community.
@@ -38,23 +38,23 @@ sudo apt-get install build-essential
3838

3939
## Install binaries
4040

41-
Polygon node consists of 2 layers: Heimdall-v2 and Bor. Heimdall-v2 is a Cosmos-SDK/CometBFT fork that monitors contracts in parallel with the Ethereum network. Bor is basically a Geth fork that generates blocks shuffled by Heimdall-v2 nodes.
41+
Polygon node consists of 2 layers: Heimdall and Bor. Heimdall is a Cosmos-SDK/CometBFT fork that monitors contracts in parallel with the Ethereum network. Bor is basically a Geth fork that generates blocks shuffled by Heimdall nodes.
4242

4343
Both binaries must be installed and run in the correct order to function properly.
4444

45-
### Heimdall-v2
45+
### Heimdall
4646

4747
Install the latest version of Heimdall-v2 and related services. Make sure you checkout to the correct [release version](https://github.com/0xPolygon/heimdall-v2/releases).
4848

4949
To install *Heimdall-v2*, run the following commands:
5050

5151
```bash
52-
curl -L https://raw.githubusercontent.com/0xPolygon/install/main/heimdall-v2.sh | bash -s -- <heimdall_version> <network_type> <node_type>
52+
curl -L https://raw.githubusercontent.com/0xPolygon/install/main/heimdall-v2.sh | bash -s -- <heimdall_version> <network> <node_type>
5353
```
5454

5555
You can run the above command with the following options:
5656

57-
- `heimdall_version`: Valid release tag from https://github.com/0xPolygon/heimdall-v2/releases
57+
- `heimdall_version`: Valid v0.2+ release tag from https://github.com/0xPolygon/heimdall-v2/releases
5858
- `network_type`: `mainnet` and `amoy`
5959
- `node_type`: `sentry`
6060

@@ -84,14 +84,14 @@ It should return the version of Heimdall-v2 you installed.
8484

8585
### Bor
8686

87-
Install the latest version of Bor, based on valid v1.0+ [released version](https://github.com/0xPolygon/bor/releases).
87+
Install the latest version of Bor, based on valid v2.0+ [released version](https://github.com/0xPolygon/bor/releases).
8888

8989
```bash
9090
curl -L https://raw.githubusercontent.com/0xPolygon/install/main/bor.sh | bash -s -- <bor_version> <network_type> <node_type>
9191
```
9292
You can run the above command with following options:
9393

94-
- `bor_version`: valid v1.0+ release tag from https://github.com/0xPolygon/bor/releases
94+
- `bor_version`: valid v2.0+ release tag from https://github.com/0xPolygon/bor/releases
9595
- `network_type`: `mainnet` and `amoy`
9696
- `node_type`: `sentry`
9797

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

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -28,31 +28,31 @@ comments: true
2828
- Install the default latest version of sentry for Mainnet:
2929

3030
```shell
31-
curl -L https://raw.githubusercontent.com/0xPolygon/install/main/heimdall-v2.sh | bash -s -- <version> <network> <node_type>
31+
curl -L https://raw.githubusercontent.com/0xPolygon/install/heimdall-v2/heimdall-v2.sh | bash -s -- <version> <network> <node_type>
3232
```
3333

3434
or install a specific version, node type (`sentry` or `validator`), and network (`mainnet` or `amoy`). All release versions can be found on
3535
[Heimdall GitHub repository](https://github.com/0xPolygon/heimdall-v2/releases).
3636

3737
```shell
3838
# Example:
39-
# curl -L https://raw.githubusercontent.com/0xPolygon/install/main/heimdall-v2.sh | bash -s -- v0.2.16 mainnet sentry
39+
# curl -L https://raw.githubusercontent.com/maticnetwork/install/heimdall-v2/heimdall-v2.sh | bash -s -- v0.2.15 mainnet validator
4040
```
4141

4242
### Bor
4343

4444
- Install the default latest version of sentry for Mainnet:
4545

4646
```shell
47-
curl -L https://raw.githubusercontent.com/0xPolygon/install/main/heimdall-v2.sh | bash -s -- <version> <network> <node_type>
47+
curl -L https://raw.githubusercontent.com/0xPolygon/install/main/bor.sh | bash -s -- <version> <network> <node_type>
4848
```
4949

5050
or install a specific version, node type (`sentry` or `validator`), and network (`mainnet` or `amoy`). All release versions could be found on
5151
[Bor Github repository](https://github.com/0xPolygon/bor/releases).
5252

5353
```shell
5454
# Example:
55-
# curl -L https://raw.githubusercontent.com/0xPolygon/install/main/bor.sh | bash -s -- v1.3.7 mainnet sentry
55+
# curl -L https://raw.githubusercontent.com/0xPolygon/install/main/bor.sh | bash -s -- v2.2.9 mainnet sentry
5656
```
5757

5858
## Configuration

docs/pos/how-to/validator/validator-binaries.md

Lines changed: 6 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -20,18 +20,9 @@ This guide will walk you through running a Polygon validator node using binaries
2020
```bash
2121
sudo apt-get install build-essential
2222
```
23+
* Go 1.24+ installed on both the sentry and the validator machines.
2324

24-
* Go 1.19 installed on both the sentry and the validator machines.
25-
26-
To install:
27-
28-
```bash
29-
wget https://raw.githubusercontent.com/0xPolygon/node-ansible/master/go-install.sh
30-
bash go-install.sh
31-
sudo ln -nfs ~/.go/bin/go /usr/bin/go
32-
```
33-
34-
* RabbitMQ installed on both the sentry and the validator machines.
25+
* RabbitMQ installed on the validator machine.
3526

3627
Here are the commands to install RabbitMQ:
3728

@@ -70,14 +61,14 @@ Both binaries must be installed and run in the correct order to function properl
7061

7162
Install the latest version of Heimdall-v2 and related services. Make sure you checkout to the correct [release version](https://github.com/0xPolygon/heimdall-v2/releases).
7263

73-
To install Heimdall, run the following commands:
64+
To install Heimdall, run the following command:
7465

7566
```bash
76-
curl -L https://raw.githubusercontent.com/0xPolygon/install/main/heimdall-v2.sh | bash -s -- <heimdall_version> <network_type> <node_type>
67+
curl -L https://raw.githubusercontent.com/0xPolygon/install/heimdall-v2/heimdall-v2.sh | bash -s -- <heimdall_version> <network_type> <node_type>
7768
```
7869
You can run the above command with the following options:
7970

80-
- `heimdall_version`: valid release tag from https://github.com/0xPolygon/heimdall-v2/releases
71+
- `heimdall_version`: valid v0.2+ release tag from https://github.com/0xPolygon/heimdall-v2/releases
8172
- `network_type`: `mainnet` and `amoy`
8273
- `node_type`: `sentry`
8374

@@ -119,7 +110,7 @@ curl -L https://raw.githubusercontent.com/0xPolygon/install/main/bor.sh | bash -
119110
```
120111
You can run the above command with the following options:
121112

122-
- `bor_version`: valid v1.0+ release tag from https://github.com/0xPolygon/bor/releases
113+
- `bor_version`: valid v2.0+ release tag from https://github.com/0xPolygon/bor/releases
123114
- `network_type`: `mainnet` and `amoy`
124115
- `node_type`: `sentry`
125116

docs/pos/how-to/validator/validator-packages.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ This guide covers running a validator node through packages.
1010

1111
* Two machines — one sentry and one validator.
1212
* Bash installed on both the sentry and the validator machines.
13-
* RabbitMQ installed on both the sentry and the validator machines.
13+
* RabbitMQ installed on the validator machine.
1414
See [Downloading and Installing RabbitMQ](https://www.rabbitmq.com/download.html).
1515

1616
## Overview
@@ -37,15 +37,15 @@ To spin up a functioning validator node, follow these steps in the *specified se
3737
Install the default latest version of sentry and validator for the PoS mainnet/Amoy testnet:
3838

3939
```shell
40-
curl -L https://raw.githubusercontent.com/0xPolygon/install/main/heimdall-v2.sh | bash -s -- <version> <network> <node_type>
40+
curl -L https://raw.githubusercontent.com/0xPolygon/install/heimdall-v2/heimdall-v2.sh | bash -s -- <version> <network> <node_type>
4141
```
4242

4343
or install a specific version, node type (`sentry` or `validator`), and network (`mainnet` or `amoy`). All release versions can be found on
4444
[Heimdall GitHub repository](https://github.com/0xPolygon/heimdall-v2/releases).
4545

4646
```shell
4747
# Example:
48-
curl -L https://raw.githubusercontent.com/0xPolygon/install/main/heimdall-v2.sh | bash -s -- v0.2.16 mainnet sentry
48+
curl -L https://raw.githubusercontent.com/0xPolygon/install/heimdall-v2/heimdall-v2.sh | bash -s -- v0.2.16 mainnet sentry
4949
```
5050

5151
### Bor

0 commit comments

Comments
 (0)