Skip to content

Commit df02b34

Browse files
authored
Merge pull request 0xPolygon#205 from 0xPolygon/howto-reorg
Howto reorg
2 parents 01216fe + 365f65a commit df02b34

19 files changed

+107
-1221
lines changed

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

Lines changed: 40 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -21,15 +21,45 @@ In order to be a validator on the Polygon Network, you need to:
2121

2222
## Wallets
2323

24-
To interact with the Polygon Network, you need to have an Ethereum-based wallet because Polygon runs on Ethereum Virtual Machine (EVM). You can choose to set up a [Metamask](https://github.com/0xPolygon/wiki/blob/master/docs/tools/wallets/metamask/overview.md) or Arkane Wallet.
24+
You'll need an Ethereum-based wallet to interact with Polygon because the network runs on Ethereum Virtual Machine (EVM). You can choose to set up a [Metamask](../../tools/wallets/metamask/create-metamask-wallet.md), or [Venly](../../tools/wallets/venly/create-wallet.md) (Arkane) Wallet.
25+
26+
There are several other third-party wallet options available to choose from, and you'll find them listed out on [this page here](../../tools/wallets/getting-started.md).
27+
28+
!!! tip "Set up web3 provider"
29+
30+
Refer to the following guides and follow along to set up your wallet for making web3 function calls:
31+
32+
- [MetaMask](../../tools/wallets/metamask/index.md#1-set-up-web3)
33+
- [Venly](../../tools/wallets/venly/index.md#initialize-the-web3-provider)
34+
35+
## Common tasks
36+
37+
Token bridging between Polygon PoS and Ethereum and vice-versa, and inter-layer communication are basic and essential actions that most dApps need to perform. Use the links below to navigate to guides that'll help you get started with these tasks.
38+
39+
* [Bridge tokens from Ethereum to PoS](../how-to/bridging/ethereum-polygon/ethereum-to-matic.md)
40+
* [Bridge tokens from PoS to Ethereum](../how-to/bridging/ethereum-polygon/matic-to-ethereum.md)
41+
* [L1 - L2 communication](../how-to/bridging/l1-l2-communication/state-transfer.md)
2542

2643
## Smart contracts
2744

28-
Polygon supports many services you can use to test, compile, debug, and deploy decentralized applications onto the Polygon Network. These include deployment using thirdweb, Alchemy, Chainstack, QuickNode, Remix, Truffle, Hardhat, and Replit.
45+
Polygon supports many popular frameworks and tools that you can choose from to deploy, debug, compile, and test smart contracts on Polygon PoS. This helps ensure your dApp development experience on Polygon is virtually the same as it would be if you were deploying to Ethereum. These frameworks and tools include:
46+
47+
- [Alchemy](../../tools/dApp-development/pos/alchemy.md)
48+
- [thirdweb](../../tools/dApp-development/pos/thirdweb.md)
49+
- [ChainIDE](../../tools/dApp-development/pos/chainide.md)
50+
- [Chainstack](../../tools/dApp-development/pos/chainstack.md)
51+
- [QuickNode](../../tools/dApp-development/pos/quicknode.md)
52+
- [GetBlock](../../tools/dApp-development/pos/quicknode.md)
53+
- [Crossmint](../../tools/dApp-development/pos/crossmint.md)
54+
- [SmartPress](../../tools/dApp-development/pos/crossmint.md)
55+
- [Remix](../../tools/dApp-development/common-tools/remix.md)
56+
- [Hardhat](../../tools/dApp-development/common-tools/hardhat.md)
57+
- [Truffle](../../tools/dApp-development/common-tools/hardhat.md)
58+
- [Replit](../../tools/dApp-development/common-tools/replit.md)
2959

3060
## Connecting to Polygon
3161

32-
You can add Polygon to MetaMask or directly use Arkane, which allows you to connect to Polygon using RPC.
62+
You can add Polygon to MetaMask, or directly use Venly (Arkane), which allows you to connect to Polygon using RPC.
3363

3464
In order to connect with the Polygon network to read blockchain information, we recommend using the Alchemy SDK.
3565

@@ -76,9 +106,15 @@ Suppose you have no prior experience building decentralized applications (dApps)
76106
- Arkane
77107
- Develop a dApp using Fauna, Polygon and React
78108

109+
## Polygon DID
110+
111+
You can refer to the elaborate startup guide for users who wish to implement the Polygon DID, which is a three-part package consisting of an identity-registrar, identity-resolver, and identity-registry-contract.
112+
113+
* [Polygon DID integration guide](../how-to/polygon-did.md)
114+
79115
## Already have a dApp?
80116

81117
If you already have a decentralized application (dApp) and are looking for a platform to help you scale efficiently, then you are at the right place because Polygon allows you to:
82118

83119
1. **Easily migrate from Ethereum Virtual Machine (EVM) based chain**: Polygon prides itself in being the ultimate Layer-2 scaling solution for Ethereum. You don't have to worry about the underlying architecture while moving or deploying your dApps to the Polygon Network as long as it is EVM-compatible.
84-
2. **Use Polygon as a faster transaction layer**: Deploying your dApp to the Polygon Mainnet allows you to leverage Polygon as a faster transaction layer for your dApp. Additionally, you can get your tokens mapped by us. You can join our [technical discussions group](http://bit.ly/matic-technical-group) on Telegram to learn more.
120+
2. **Use Polygon as a faster transaction layer**: Deploying your dApp to the Polygon Mainnet allows you to leverage Polygon as a faster transaction layer for your dApp. Additionally, you can get your tokens mapped by us. You can join our [technical discussions group](http://bit.ly/matic-technical-group) on Telegram to learn more.
Lines changed: 46 additions & 40 deletions
Original file line numberDiff line numberDiff line change
@@ -1,71 +1,77 @@
11

2-
## System Requirements
2+
## System requirements
33

4-
- 16-core CPU
5-
- 64 GB RAM
6-
- Basically io1 or above with at least 20k+ iops and RAID-0 based disk structure
4+
- **CPU:** 16-core, 64-bit architecture
5+
- **RAM:** 64GB
6+
- **Storage**
7+
- Basically **io1** or above with at least 20k+ iops and RAID-0 based disk structure
8+
- Mainnet archive node: 10TB
9+
- Mumbai testnet archive node: 2TB
10+
- SSD or NVMe. Bear in mind that SSD performance deteriorates when close to capacity
11+
- **Golang:** >= v1.20
12+
- **GCC:** >= v10
713

8-
## System Requirements
14+
!!! note "HDD not recommended"
915

10-
- For an Archive node of Polygon Mainnet: 8TB
11-
- For an Archive node of Mumbai Testnet: 1TB
12-
- SSD or NVMe. Bear in mind that SSD performance deteriorates when close to capacity
13-
- RAM: >= 32GB, 64-bit architecture
14-
- Golang version >= 1.18, GCC 10+
16+
On HDDs, Erigon will always stay *N* blocks behind the chain tip, but will not fall behind.
1517

16-
!!!note
17-
HDD not recommended
1818

19-
On HDDs, Erigon will always stay N blocks behind the chain tip, but will not fall behind.
20-
21-
22-
## Install Erigon Client
19+
## Install Erigon client
2320

2421
Run the following commands to install Erigon:
2522

2623
```bash
27-
git clone --recurse-submodules -j8 https://github.com/maticnetwork/erigon.git
24+
git clone --recurse-submodules -j8 https://github.com/ledgerwatch/erigon
2825
cd erigon
29-
git checkout v0.0.8
26+
git checkout v2.57.3
3027
make erigon
3128
```
3229

3330
This should create the binary at `./build/bin/erigon`
3431

35-
Use the tag `v0.0.8` on our forked repo to have a stable version.
36-
37-
## Start Erigon Client
32+
## Start Erigon client
3833

39-
To start Erigon, run:
34+
When connecting to Mumbai testnet, use the following command to start your Erigon client:
4035

4136
```bash
4237
erigon --chain=mumbai
4338
```
4439

45-
- Use `chain=mumbai` for Mumbai testnet
46-
- Use `chain=bor-mainnet` for Polygon Mainnet
40+
If you're deploying to mainnet, run the following command:
4741

48-
## Configure Erigon Client
42+
```bash
43+
erigon --chain=bor-mainnet --db.size.limit=12TB --db.pagesize=16KB # remaining flags follow
44+
```
4945

50-
- If you want to store Erigon files in a non-default location, use `-datadir`
51-
52-
```
53-
erigon --chain=mumbai --datadir=<your_data_dir>
54-
```
55-
56-
- If you are not using local **heimdall**, use `-bor.heimdall=<your heimdall url>`. By default, it will try to connect to `localhost:1317`.
46+
## Configure Erigon client
47+
48+
If you want to store Erigon files in a non-default location, use `-datadir` to specify a new location:
5749

58-
```makefile
59-
erigon --chain=mumbai --bor.heimdall=<your heimdall url> --datadir=<your_data_dir>
60-
```
50+
```bash
51+
erigon --chain=mumbai --datadir=<your_data_dir>
52+
```
6153

62-
- If you want to connect to Polygon Mumbai Testnet use: [https://heimdall-api-testnet.polygon.technology](https://heimdall-api-testnet.polygon.technology)
54+
If you are not using local **heimdall**, use `-bor.heimdall=<your heimdall url>`. By default, it will try to connect to `localhost:1317`.
6355

64-
- For Polygon Mainnet: [https://heimdall-api.polygon.technology](https://heimdall-api.polygon.technology)
56+
```makefile
57+
erigon --chain=mumbai --bor.heimdall=<your heimdall url> --datadir=<your_data_dir>
58+
```
59+
60+
!!! note
61+
62+
- If you want to connect to Polygon Mumbai Testnet, use: [https://heimdall-api-testnet.polygon.technology](https://heimdall-api-testnet.polygon.technology)
6563

66-
**Note:** Remote heimdall is not recommended for production use, Only use it for testing purposes.
64+
- For Polygon mainnet, use: [https://heimdall-api.polygon.technology](https://heimdall-api.polygon.technology)
6765

68-
## Tips for Faster Sync
66+
!!! tip
67+
68+
Remote heimdall is better suited for testing, and is not recommended for production use.
69+
70+
## Tips for faster sync
6971

7072
- Use the machine with high IOPS and RAM for the faster initial sync
71-
- Memory optimized nodes are recommended for faster sync, For example, AWS EC2 `r5` or `r6` series instances.
73+
- Memory optimized nodes are recommended for faster sync. For example, AWS EC2 `r5` or `r6` series instances.
74+
75+
## Reporting issues
76+
77+
In case you encounter any issues and are looking for support, please get in touch with the Erigon team. More details available in [this GitHub README](https://github.com/ledgerwatch/erigon?tab=readme-ov-file#getting-in-touch).

docs/pos/how-to/index.md

Lines changed: 2 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,6 @@
1+
Welcome to the Polygon PoS node how-tos section!
12

2-
Welcome to the Polygon PoS how-to section!
3-
4-
## Common tasks
5-
6-
There are a number of guides here to help you get started with technical tasks like bridging assets from Ethereum to the Polygon PoS chain and vice-versa, smart contract development basics covering deployment and verification, messaging between Layer-1 (L1) and Layer-2 (L2) networks, etc. Check out the links listed below:
7-
8-
* [Bridge tokens from Ethereum to PoS](bridging/ethereum-polygon/ethereum-to-matic.md)
9-
* [Bridge tokens from PoS to Ethereum](bridging/ethereum-polygon/matic-to-ethereum.md)
10-
* [L1 - L2 communication](bridging/l1-l2-communication/state-transfer.md)
11-
* [Work with smart contracts on PoS](smart-contracts/index.md)
12-
13-
## Deploy, operate, and maintain nodes
14-
15-
This section also contains guides that describe the system requirements and configurations necessary to spin up different kinds of Polygon nodes, and then take you step by step through the process of setting them up on the PoS network.
3+
This section contains guides that describe the system requirements and configurations necessary to spin up different kinds of Polygon nodes, and then take you step by step through the process of setting them up on the PoS network.
164

175
Depending on the extent to which you're looking to participate in different network processes, and the kind of computational and network capabilities you can offer, you can choose to deploy any of the following nodes:
186

@@ -28,9 +16,3 @@ Depending on the extent to which you're looking to participate in different netw
2816
| [Packages](validator/validator-packages.md) | [Packages](full-node/full-node-packages.md) | - | - |
2917
| - | [Docker](full-node/full-node-docker.md) | - | - |
3018
| - | [GCP](full-node/full-node-gcp.md) | - | - |
31-
32-
## Polygon DID
33-
34-
Included in the section is an elaborate startup guide for users who wish to implement the Polygon DID, which is a three-part package consisting of an identity-registrar, identity-resolver, and identity-registry-contract.
35-
36-
* [Polygon DID integration guide](./polygon-did.md)

docs/pos/how-to/operate-maintain-node/change-signer-address.md renamed to docs/pos/how-to/operate-validator-node/change-signer-address.md

File renamed without changes.
File renamed without changes.

docs/pos/how-to/operate-maintain-node/topup-heimdall-fee.md renamed to docs/pos/how-to/operate-validator-node/topup-heimdall-fee.md

File renamed without changes.

docs/pos/how-to/operate-maintain-node/validator-commission-operations.md renamed to docs/pos/how-to/operate-validator-node/validator-commission-operations.md

File renamed without changes.

docs/pos/how-to/operate-maintain-node/validator-performance.md renamed to docs/pos/how-to/operate-validator-node/validator-performance.md

File renamed without changes.

docs/pos/how-to/operate-maintain-node/validator-staking-operations.md renamed to docs/pos/how-to/operate-validator-node/validator-staking-operations.md

File renamed without changes.

0 commit comments

Comments
 (0)