Skip to content

Commit b77595f

Browse files
authored
Merge pull request 0xPolygon#677 from 0xPolygon/pos-review-fixes
PoS review fixes
2 parents 4ca3a5b + 92f7c13 commit b77595f

File tree

13 files changed

+59
-264
lines changed

13 files changed

+59
-264
lines changed

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

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

5-
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 Foundry, Remix or Web3.js, Polygon offers the same UX as Ethereum.
5+
## Overview
6+
7+
All your favorite Ethereum tools (Foundry, Remix, Web3.js) work seamlessly on Polygon, with the same familiar UX. Just switch to the [Polygon RPC](https://polygon-rpc.com/) and keep building.
68

79
Connect your wallet and deploy any decentralized application to either PoS mainnet or Amoy testnet (Sepolia-anchored).
810

9-
## Overview
11+
Use the links below to find the right tooling and guides that suit your needs the best.
1012

11-
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:
13+
- [Faucets](../../tools/gas/matic-faucet.md) - Fetch test tokens
14+
- [Polygon gas station](../../tools/gas/polygon-gas-station.md) - Gas estimation API
15+
- [Polygon dApp Launchpad](../../tools/dApp-development/launchpad/intro.md) - dApp development CLI tool
16+
- [Popular third-party tooling](../../tools/dApp-development/third-party-tutorials.md)
17+
- [Matic.js library](../../tools/matic-js/installation.md)
1218

13-
- 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 PoS 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).
19+
If you have no prior experience in dApp development, the following resources will help you get started with some essential tools for building, testing, and deploying applications on Polygon PoS.
1520

16-
In order to be a validator on the Polygon PoS network, you need to:
21+
- [Full Stack dApp: Tutorial Series](https://kauri.io/full-stack-dapp-tutorial-series/5b8e401ee727370001c942e3/c)
22+
- [Web3.js](https://www.dappuniversity.com/articles/web3-js-intro)
23+
- [Ethers.js](https://docs.ethers.io/v5/)
24+
- [thirdweb](https://portal.thirdweb.com)
25+
- [Remix](https://remix.ethereum.org/)
26+
- [Hardhat](https://hardhat.org/hardhat-runner/docs/getting-started)
27+
- [Foundry](https://github.com/foundry-rs/foundry/blob/master/README.md)
28+
- [Metamask](https://support.metamask.io/getting-started/)
29+
- [Venly (previously Arkane)](https://docs.venly.io/docs/getting-started-with-venly)
30+
- [Develop a dApp using Fauna, Polygon, and React](https://github.com/hello-ashleyintech/polygon-fauna-app)
1731

18-
- Run a sentry node, which is a separate machine running a Heimdall node and a Bor node. A sentry node is open to all nodes on the Polygon PoS network.
19-
- Run a validator node, which is 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.
20-
- Stake the MATIC tokens in the staking contracts deployed on the Ethereum mainnet.
2132

2233
## Network details
2334

@@ -70,35 +81,14 @@ async function main() {
7081
main();
7182
```
7283

73-
!!! note "Take it easy!"
74-
75-
If this is overwhelming, that’s alright! You can jump right into the action and start hacking. Here are some notes before you start diving into resources, repositories, and docs:
76-
77-
1. **Beware the cost of being on the bleeding edge**: Like typical niche programming, dApps and blockchain development moves very quickly. While researching, you may find complex code repositories, 404s on a documentation site, or even no documentation. Use that opportunity to [open an issue on the Polygon Knowledge Layer's GitHub repository](https://github.com/0xPolygon/polygon-docs/issues).
78-
2. **The learning curve may be daunting, but the barrier to entry is low**: The community is very open and welcoming! Projects welcome pull requests from outsiders and resolve any blockers actively. We’re working on creating a better world and contribution in any form is appreciated. We’ll be grateful to onboard you into this amazing Web3 ecosystem.
79-
80-
## Building a new dApp on Polygon?
81-
82-
Decentralized applications (dApps) act as the bridge between users and their data privacy on the blockchain. The increasing number of dApps validates their usefulness within the blockchain ecosystem, solving challenges like executing transactions between two participants without the need for central authority via smart contracts.
83-
84-
Suppose you have no prior experience building dApps. In that case, the below-mentioned resources will give you a head start on the tools required to build, debug, and deploy dApps on the Polygon PoS network.
85-
86-
- [Full Stack dApp: Tutorial Series](https://kauri.io/full-stack-dapp-tutorial-series/5b8e401ee727370001c942e3/c)
87-
- [Web3.js](https://www.dappuniversity.com/articles/web3-js-intro)
88-
- [Ethers.js](https://docs.ethers.io/v5/)
89-
- [thirdweb](https://portal.thirdweb.com)
90-
- [Remix](https://remix.ethereum.org/)
91-
- [Hardhat](https://hardhat.org/hardhat-runner/docs/getting-started)
92-
- [Foundry](https://github.com/foundry-rs/foundry/blob/master/README.md)
93-
- [Metamask](https://support.metamask.io/getting-started/)
94-
- [Venly (previously Arkane)](https://docs.venly.io/docs/getting-started-with-venly)
95-
- [Develop a dApp using Fauna, Polygon, and React](https://github.com/hello-ashleyintech/polygon-fauna-app)
96-
97-
## Polygon DID
84+
!!! tip "Reach out to us!"
9885

99-
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.
86+
If you're encountering problems while hacking or have questions about something, please use the following methods to contact us:
10087

101-
* [Polygon DID integration guide](../how-to/polygon-did.md)
88+
1. If you come across a complex code repository, 404s on the docs site, or if you feel there's something missing - feel free to [open an issue on the Polygon Knowledge Layer's GitHub repository](https://github.com/0xPolygon/polygon-docs/issues). You can also open a PR if you're looking to [contribute](https://github.com/0xPolygon/polygon-docs?tab=readme-ov-file#contributing)!
89+
2. Get in touch with us via Discord:
90+
- [Community Discord](https://discord.com/invite/0xPolygonCommunity)
91+
- [Research and Development Discord](https://discord.com/invite/0xpolygonrnd)
10292

10393
## Already have a dApp?
10494

docs/pos/get-started/index.md

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

docs/pos/how-to/bridging/ethereum-polygon/ethereum-to-matic.md

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

5+
!!! warning "Work in progress!"
6+
7+
This doc is currently undergoing revision, and the instructions provided may not be up to date. Stay tuned for updates!
8+
59
The mechanism to natively read Ethereum data from Polygon EVM chain is that of ‘State Sync’. In other words, this mechanism enables transfer of arbitrary data from Ethereum chain to Polygon chain. The procedure that makes it possible is: Validators on the Heimdall layer are listening for a particular event — `StateSynced` from a *sender* contract, as soon as the event is picked, the `data` that was passed in the event is written on the *receiver* contract. Read more [here](../../../architecture/bor/state-sync.md).
610

711
The sender and receiver contracts are required to be mapped on Ethereum — [StateSender.sol](https://github.com/maticnetwork/contracts/blob/release-betaV2/contracts/root/stateSyncer/StateSender.sol) needs to be aware of each sender and receiver.

docs/pos/how-to/bridging/ethereum-polygon/matic-to-ethereum.md

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

5+
!!! warning "Work in progress!"
6+
7+
This doc is currently undergoing revision, and the instructions provided may not be up to date. Stay tuned for updates!
8+
59
The mechanism for transferring data from Polygon PoS to Ethereum differs from the process of transferring data from Ethereum to Polygon PoS. Validators create *checkpoint transactions* on the Ethereum chain to facilitate this transfer. These checkpoints serve as periodic summaries of the PoS chain’s state, ensuring data integrity and consistency when moving data back to Ethereum. The flow of this process is briefly described below.
610

711
1. A transaction is created on Polygon PoS. It is crucial to emit an event and ensure that the event logs include the data intended for transfer to Ethereum. This process is essential for tracking and verifying the data transfer, as the event logs serve as a reliable record that can be referenced on the Ethereum network.

docs/pos/how-to/bridging/ethereum-polygon/index.md renamed to docs/pos/how-to/bridging/ethereum-polygon/portal-ui.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ The official bridge is available on both the PoS Amoy testnet as well as mainnet
44

55
!!! tip "Polygon Portal"
66

7-
To learn more about the features that Polygon Portal offers, and a series of step-by-step reference guides that help you with using the platform, check out [the doc available here](../../../../tools/wallets/portal.md).
7+
To learn more about the features that Polygon Portal offers, and a series of step-by-step instructions that help you with using the platform, check out [the Portal guide](../../../../tools/wallets/portal.md).
88

99
There is no change to the circulating supply of your token when it crosses the bridge. This is what goes on in the background when you bridge your tokens over to Polygon PoS from Ethereum:
1010

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

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,8 +6,7 @@ Token mapping is important in order to enable the transfer mechanism for the sai
66

77
!!! info
88

9-
- For more information on how bridging works in the background, see [the doc available here](../index.md).
10-
- Thinking about bridging another popular token? Refer to the [reference guide on Polygon Portal](../../../../tools/wallets/portal.md).
9+
Thinking about bridging a popular token? Refer to the [reference guide on Polygon Portal](../../../../tools/wallets/portal.md).
1110

1211
## Steps to submit a mapping request
1312

docs/pos/how-to/bridging/index.md

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

docs/pos/how-to/bridging/l1-l2-communication/index.md

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

docs/pos/how-to/bridging/l1-l2-communication/state-transfer.md

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

5+
!!! warning "Work in progress!"
6+
7+
This doc is currently undergoing revision, and the instructions provided may not be up to date. Stay tuned for updates!
8+
59
Polygon validators continuously monitor a contract on Ethereum chain called `StateSender`. Each time a registered contract on Ethereum chain calls this contract, it emits an event. Using this event Polygon validators relay the data to another contract on Polygon chain. This *state sync* mechanism is used to send data from Ethereum to Polygon.
610

711
Additionally, Polygon validators send the transaction hash, namely *checkpoint*, of each transaction on the PoS chain to Ethereum on a regular basis. You can use this to validate any transaction that took place on Polygon. Once a transaction has been verified to have occurred on the PoS chain, the corresponding action can then be executed on Ethereum.
Lines changed: 1 addition & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,6 @@
1-
Welcome to the Polygon PoS node how-tos section!
2-
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.
4-
51
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:
62

7-
!!! tip
3+
!!! tip "Different minimum and recommended system requirements"
84

95
It's always a good idea to first read and understand the *minimum* and *recommended* system requirements for any node that you choose to deploy to the PoS network.
106

0 commit comments

Comments
 (0)