Skip to content

Commit 3d73880

Browse files
Merge branch 'main' of https://github.com/0xPolygon/polygon-docs into platform/404s
2 parents 14c7564 + 11756d2 commit 3d73880

File tree

23 files changed

+104
-104
lines changed

23 files changed

+104
-104
lines changed

docs/cdk/getting-started/local-deployment.md

Lines changed: 0 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -38,33 +38,6 @@ git clone https://github.com/0xPolygon/kurtosis-cdk.git
3838
cd kurtosis-cdk
3939
```
4040

41-
### Check your environment
42-
43-
Run the `tool_check.sh` script to confirm you have all the prerequisite software.
44-
45-
!!! tip
46-
You may need to make the script executable: `chmod +x scripts/tool_check.sh`
47-
48-
```sh
49-
./scripts/tool_check.sh
50-
```
51-
52-
If everything is installed correctly, you should see the following output:
53-
54-
```bash
55-
Checking that you have the necessary tools to deploy the Kurtosis CDK package...
56-
✅ kurtosis is installed, meets the requirement (=0.89).
57-
✅ docker is installed, meets the requirement (>=24.7).
58-
59-
You might as well need the following tools to interact with the environment...
60-
✅ jq is installed.
61-
✅ yq is installed, meets the requirement (>=3.2).
62-
✅ cast is installed.
63-
✅ polycli is installed.
64-
65-
🎉 You are ready to go!
66-
```
67-
6841
### Understanding the deployment steps
6942

7043
There are two configuration files which help you understand what happens during a deployment.

docs/img/pos/delegateB.png

-31.8 KB
Loading

docs/pos/architecture/heimdall/authentication.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -113,7 +113,7 @@ Expected result:
113113
```json
114114
address: 0x68243159a498cf20d945cf3e4250918278ba538e
115115
coins:
116-
- denom: matic
116+
- denom: pol
117117
amount:
118118
i: "1000000000000000000000"
119119
pubkey: ""

docs/pos/architecture/heimdall/balance-transfers.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -39,8 +39,8 @@ The bank module contains the following parameters:
3939

4040
### Send balance
4141

42-
The following command sends 1000 matic tokens to the specified `address`:
42+
The following command sends 1000 POL tokens to the specified `address`:
4343

4444
```bash
45-
heimdallcli tx bank send <address> 1000matic --chain-id <chain-id>
45+
heimdallcli tx bank send <address> 1000pol --chain-id <chain-id>
4646
```

docs/pos/architecture/heimdall/chain-management.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -13,8 +13,8 @@ type ChainParams struct {
1313
// BorChainID is valid bor chainId
1414
BorChainID string `json:"bor_chain_id" yaml:"bor_chain_id"`
1515

16-
// MaticTokenAddress is valid matic token address
17-
MaticTokenAddress hmTypes.HeimdallAddress `json:"matic_token_address" yaml:"matic_token_address"`
16+
// PolTokenAddress is valid POL token address
17+
PolTokenAddress hmTypes.HeimdallAddress `json:"pol_token_address" yaml:"pol_token_address"`
1818

1919
// StakingManagerAddress is valid contract address
2020
StakingManagerAddress hmTypes.HeimdallAddress `json:"staking_manager_address" yaml:"staking_manager_address"`
@@ -53,7 +53,7 @@ Expected result:
5353
tx_confirmation_time: 12s
5454
chain_params:
5555
bor_chain_id: "15001"
56-
matic_token_address: "0x0000000000000000000000000000000000000000"
56+
pol_token_address: "0x0000000000000000000000000000000000000000"
5757
staking_manager_address: "0x0000000000000000000000000000000000000000"
5858
root_chain_address: "0x0000000000000000000000000000000000000000"
5959
staking_info_address: "0x0000000000000000000000000000000000000000"

docs/pos/architecture/heimdall/key-management.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ The signer key is an address that is used for signing Heimdall blocks, checkpoin
88

99
The validator must keep two types of balances on this address:
1010

11-
- MATIC tokens on Heimdall (through top-up transactions) to perform validator responsibilities on Heimdall.
11+
- POL tokens on Heimdall (through top-up transactions) to perform validator responsibilities on Heimdall.
1212
- ETH on Ethereum chain to send checkpoints on Ethereum.
1313

1414
## Owner key

docs/pos/concepts/tokens/matic.md

Lines changed: 9 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,19 @@
1-
!!! danger "Important update"
1+
!!! info "Transitioning to POL"
22

3-
There is a proposal to transition the native token of the Polygon PoS network from MATIC to POL. Please find more information [here](https://polygon.technology/blog/polygon-2-0-implementation-officially-begins-the-first-set-of-pips-polygon-improvement-proposals-released).
3+
Polygon network is transitioning from MATIC to POL, which will serve as the gas and staking token on Polygon PoS. Use the links below to learn more:
44

5-
[MATIC](https://etherscan.io/token/0x7D1AfA7B718fb893dB30A3aBc0Cfc608AaCfeBB0) serves as the native cryptocurrency for the Polygon PoS network, analogous to how ETH functions within the Ethereum ecosystem.
5+
- [Migrate from MATIC to POL](../../get-started/matic-to-pol.md)
6+
- [POL token specs](../tokens/pol.md)
67

7-
To engage with the Polygon PoS network, users must use MATIC tokens, which are necessary to cover gas fees for transactions, smart contract interactions, and part of the network's security model via staking.
8+
[MATIC](https://etherscan.io/token/0x7D1AfA7B718fb893dB30A3aBc0Cfc608AaCfeBB0) is a native cryptocurrency that served as the gas token on Polygon PoS, analogous to how ETH functions within the Ethereum ecosystem.
9+
10+
To engage with the Polygon PoS network, users previously used MATIC tokens to cover gas fees for transactions, smart contract interactions, and as a part of the network's security model via staking.
811

912
This is an [example script](https://gist.github.com/rahuldamodar94/ea3bc4c551e6fc2d318767dcd7e5bffe) to send MATIC tokens from one account to another on the Polygon chain.
1013

11-
!!! info "Acquiring MATIC"
14+
!!! info "MATIC rewards"
1215

13-
MATIC tokens can be acquired through methods such as validator rewards, staking, or by purchasing them on the open market.
16+
Validator and staking rewards will now be distributed in the form of POL tokens.
1417

1518
You can obtain test MATIC for testing purposes on the Amoy testnet. Testnet tokens don't hold any real-world value. This can be done via the Polygon faucet in the following way:
1619

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

Lines changed: 13 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,16 @@
22
comments: true
33
---
44

5-
Validators are the key actor in maintaining the Polygon PoS network. Validators run a full node, secure the network by staking MATIC to produce blocks, validate and participate in PoS consensus.
5+
!!! info "Transitioning to POL"
66

7-
Validators play a crucial role in maintaining the integrity and security of the Polygon PoS network. By running a full node, validators contribute to the network's infrastructure and help facilitate transactions. They secure the network by staking MATIC tokens, which enables them to produce blocks and participate in network consensus (PoS). This contributes to greater network security and enhances network decentralization making it more resilient against potential attacks.
7+
Polygon network is transitioning from MATIC to POL, which will serve as the gas and staking token on Polygon PoS. Use the links below to learn more:
8+
9+
- [Migrate from MATIC to POL](../get-started/matic-to-pol.md)
10+
- [POL token specs](../concepts/tokens/pol.md)
11+
12+
Validators are the key actor in maintaining the Polygon PoS network. Validators run a full node, secure the network by staking POL to produce blocks, validate and participate in PoS consensus.
13+
14+
Validators play a crucial role in maintaining the integrity and security of the Polygon PoS network. By running a full node, validators contribute to the network's infrastructure and help facilitate transactions. They secure the network by staking POL tokens, which enables them to produce blocks and participate in network consensus (PoS). This contributes to greater network security and enhances network decentralization making it more resilient against potential attacks.
815

916
In return for their efforts, validators are rewarded with incentives, encouraging active participation and commitment to the network's stability and growth.
1017

@@ -29,7 +36,7 @@ To be a validator on the Polygon PoS network, you must do the following:
2936

3037
* Run a sentry node: A separate machine running a Heimdall node and a Bor node. A sentry node is open to all nodes on the Polygon PoS network.
3138
* Run a validator node: 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.
32-
* Stake the MATIC tokens in the staking contracts deployed on the Ethereum mainnet.
39+
* Stake the POL tokens in the staking contracts deployed on the Ethereum mainnet.
3340

3441
## Components
3542

@@ -68,11 +75,11 @@ Bor is the block producing node and layer for the Polygon PoS network. It is bas
6875

6976
Keep up with the latest node and validator updates from the Polygon team and the community by keeping an eye on the [announcements posed to Polygon forums](https://forum.polygon.technology/c/announcement/6).
7077

71-
A blockchain validator is someone who is responsible for validating transactions within a blockchain. On the Polygon PoS network, any participant can be qualified to become a Polygon's validator by running a validator node (sentry + validator) to earn rewards and collect transaction fees. To ensure the good participation by validators, they lock up at least 1 MATIC token as a stake in the ecosystem.
78+
A blockchain validator is someone who is responsible for validating transactions within a blockchain. On the Polygon PoS network, any participant can be qualified to become a Polygon's validator by running a validator node (sentry + validator) to earn rewards and collect transaction fees. To ensure the good participation by validators, they lock up at least 1 POL token as a stake in the ecosystem.
7279

73-
!!! info "PIP4 raises the minimum staking amount"
80+
!!! info "PIP4 raised the minimum staking amount"
7481

75-
After the implementation of the [PIP4 governance proposal](https://forum.polygon.technology/t/pip-4-validator-performance-management/9956) at the contract level, the minimum staking amount will increase to *10,000 MATIC*.
82+
After the implementation of the [PIP4 governance proposal](https://forum.polygon.technology/t/pip-4-validator-performance-management/9956) at the contract level, the minimum staking amount was increased to *10,000 POL*.
7683

7784
Any validator on the Polygon PoS network has the following responsibilities:
7885

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

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

5+
!!! info "Transitioning to POL"
6+
7+
Polygon network is transitioning from MATIC to POL, which will serve as the gas and staking token on Polygon PoS. Use the links below to learn more:
8+
9+
- [Migrate from MATIC to POL](../get-started/matic-to-pol.md)
10+
- [POL token specs](../concepts/tokens/pol.md)
11+
512
## Overview
613

714
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.

docs/pos/governance/governance-fundamentals.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ Changes to the network require a high level of coordination and ecosystem consen
88

99
A block number is selected, before which all nodes in the network should have upgraded to the new version; nodes running the old version will be disconnected from the canonical chain after the hard fork block.
1010

11-
Should there be ${1/3}+1$ staked MATIC in disagreement with the fork, two canonical chains will temporarily form until the end of the current span. Afterwards, Bor will stop producing blocks, and the chain will halt until consensus is reached.
11+
Should there be ${1/3}+1$ staked POL in disagreement with the fork, two canonical chains will temporarily form until the end of the current span. Afterwards, Bor will stop producing blocks, and the chain will halt until consensus is reached.
1212

1313
In contrast, a *soft fork* is backward-compatible with the pre-fork blocks. This type of protocol change does not require nodes to upgrade before a deadline, therefore, multiple versions of the node software can be running at once and be able to validate transactions.
1414

@@ -69,7 +69,7 @@ The Heimdall client also has an [in-built governance module](https://github.com/
6969
2. Each validator then tallies votes cast by validators.
7070
3. When the defined voting parameters are met, each validator makes the upgrade with the proposal data.
7171

72-
The current voting parameters (denominated in staked MATIC):
72+
The current voting parameters (denominated in staked POL):
7373

7474
- Quorum: 33.4%
7575
- Threshold: 50%

0 commit comments

Comments
 (0)