PoS: MATIC to POL update

hsutaiyu · hsutaiyu · commit 6bab14b21a86 · 2024-09-17T16:13:04.000+04:00
- Update MATIC token to POL across different PoS docs
diff --git a/docs/img/pos/delegateB.png b/docs/img/pos/delegateB.png
diff --git a/docs/pos/architecture/heimdall/authentication.md b/docs/pos/architecture/heimdall/authentication.md
@@ -113,7 +113,7 @@ Expected result:
 ```json
 address: 0x68243159a498cf20d945cf3e4250918278ba538e
 coins:
-- denom: matic
+- denom: pol
     amount:
     i: "1000000000000000000000"
 pubkey: ""
diff --git a/docs/pos/architecture/heimdall/balance-transfers.md b/docs/pos/architecture/heimdall/balance-transfers.md
@@ -39,8 +39,8 @@ The bank module contains the following parameters:
 
 ### Send balance
 
-The following command sends 1000 matic tokens to the specified `address`:
+The following command sends 1000 POL tokens to the specified `address`:
 
 ```bash
-heimdallcli tx bank send <address> 1000matic --chain-id <chain-id>
+heimdallcli tx bank send <address> 1000pol --chain-id <chain-id>
 ```
diff --git a/docs/pos/architecture/heimdall/chain-management.md b/docs/pos/architecture/heimdall/chain-management.md
@@ -13,8 +13,8 @@ type ChainParams struct {
  // BorChainID is valid bor chainId
  BorChainID            string                  `json:"bor_chain_id" yaml:"bor_chain_id"`
 
- // MaticTokenAddress is valid matic token address
- MaticTokenAddress     hmTypes.HeimdallAddress `json:"matic_token_address" yaml:"matic_token_address"`
+ // PolTokenAddress is valid POL token address
+ PolTokenAddress     hmTypes.HeimdallAddress `json:"pol_token_address" yaml:"pol_token_address"`
 
  // StakingManagerAddress is valid contract address
  StakingManagerAddress hmTypes.HeimdallAddress `json:"staking_manager_address" yaml:"staking_manager_address"`
@@ -53,7 +53,7 @@ Expected result:
 tx_confirmation_time: 12s
 chain_params:
   bor_chain_id: "15001"
-  matic_token_address: "0x0000000000000000000000000000000000000000"
+  pol_token_address: "0x0000000000000000000000000000000000000000"
   staking_manager_address: "0x0000000000000000000000000000000000000000"
   root_chain_address: "0x0000000000000000000000000000000000000000"
   staking_info_address: "0x0000000000000000000000000000000000000000"
diff --git a/docs/pos/architecture/heimdall/key-management.md b/docs/pos/architecture/heimdall/key-management.md
@@ -8,7 +8,7 @@ The signer key is an address that is used for signing Heimdall blocks, checkpoin
 
 The validator must keep two types of balances on this address:
 
-- MATIC tokens on Heimdall (through top-up transactions) to perform validator responsibilities on Heimdall.
+- POL tokens on Heimdall (through top-up transactions) to perform validator responsibilities on Heimdall.
 - ETH on Ethereum chain to send checkpoints on Ethereum.
 
 ## Owner key
diff --git a/docs/pos/get-started/becoming-a-validator.md b/docs/pos/get-started/becoming-a-validator.md
@@ -2,9 +2,16 @@
 comments: true
 ---
 
-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.
+!!! info "Transitioning to POL"
 
-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.
+    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:
+
+    - [Migrate from MATIC to POL](../get-started/matic-to-pol.md)
+    - [POL token specs](../concepts/tokens/pol.md)
+
+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.
+
+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.
 
 In return for their efforts, validators are rewarded with incentives, encouraging active participation and commitment to the network's stability and growth.
 
@@ -29,7 +36,7 @@ To be a validator on the Polygon PoS network, you must do the following:
 
 * 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.
 * 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.
-* Stake the MATIC tokens in the staking contracts deployed on the Ethereum mainnet.
+* Stake the POL tokens in the staking contracts deployed on the Ethereum mainnet.
 
 ## Components
 
@@ -68,11 +75,11 @@ Bor is the block producing node and layer for the Polygon PoS network. It is bas
 
     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).
 
-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.
+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.
 
-!!! info "PIP4 raises the minimum staking amount"
+!!! info "PIP4 raised the minimum staking amount"
 
-    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*.
+    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*.
 
 Any validator on the Polygon PoS network has the following responsibilities:
 
diff --git a/docs/pos/get-started/building-on-polygon.md b/docs/pos/get-started/building-on-polygon.md
@@ -2,6 +2,13 @@
 comments: true
 ---
 
+!!! info "Transitioning to POL"
+
+    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:
+
+    - [Migrate from MATIC to POL](../get-started/matic-to-pol.md)
+    - [POL token specs](../concepts/tokens/pol.md)
+
 ## Overview
 
 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.
diff --git a/docs/pos/governance/governance-fundamentals.md b/docs/pos/governance/governance-fundamentals.md
@@ -8,7 +8,7 @@ Changes to the network require a high level of coordination and ecosystem consen
 
     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.
 
-    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.
+    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.
 
     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. 
 
@@ -69,7 +69,7 @@ The Heimdall client also has an [in-built governance module](https://github.com/
 2. Each validator then tallies votes cast by validators.
 3. When the defined voting parameters are met, each validator makes the upgrade with the proposal data.
 
-The current voting parameters (denominated in staked MATIC):
+The current voting parameters (denominated in staked POL):
 
 - Quorum: 33.4%		
 - Threshold: 50% 
diff --git a/docs/pos/how-to/delegate.md b/docs/pos/how-to/delegate.md
@@ -2,12 +2,20 @@
 comments: true
 ---
 
-
 # How to delegate
 
-This is a step-by-step guide to help you become a delegator on the Polygon Network.
+This is a step-by-step guide to help you become a delegator in the Polygon network.
+
+The only prerequisite is to have your POL tokens and ETH on the Ethereum mainnet address.
+
+!!! info "Staking MATIC"
 
-The only prerequisite is to have your MATIC tokens and ETH on the Ethereum mainnet address.
+    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:
+
+    - [Migrate from MATIC to POL](../get-started/matic-to-pol.md)
+    - [POL token specs](../concepts/tokens/pol.md)
+    
+    It is advisable to [migrate your MATIC tokens to POL](../get-started/matic-to-pol.md), but if you continue to delegate MATIC tokens, you'll receive the staking rewards in the form of POL tokens.
 
 ## Access the dashboard
 
@@ -34,7 +42,7 @@ The only prerequisite is to have your MATIC tokens and ETH on the Ethereum mainn
     ![img](../../img/pos/home.png)
     </center>
 
-  2. Enter the amount of MATIC to delegate.
+  2. Select POL or MATIC from the drop-down list and enter the token amount to delegate. It is recommended to migrate your MATIC tokens to POL and delegate POL tokens. If you choose MATIC, you'll still receive your staking rewards in POL. Then, select **Continue**.
     <center>
     ![img](../../img/pos/delegateB.png){width=50%}
     </center>
@@ -70,7 +78,7 @@ To view your delegations, select **My Account**.
     ![img](../../img/pos/withdraw-reward.png)
     </center>
 
-This will withdraw the MATIC token rewards to your Ethereum address.
+This will withdraw the POL token rewards to your Ethereum address.
 
 ## Restake rewards
 
@@ -85,7 +93,7 @@ This will withdraw the MATIC token rewards to your Ethereum address.
     ![img](../../img/pos/restake-rewards.png)
 
 
-This will restake the MATIC token rewards to the validator and increase your delegation stake.
+This will restake the POL token rewards to the validator and increase your delegation stake.
 
 ## Unbond from a validator
 
@@ -135,15 +143,15 @@ Moving stake from one node to another node is a single transaction. There are no
 
 This will move the stake. The dashboard will update *after 12 block confirmations*.
 
-# Common queries and solutions
+## Common queries and solutions
 
 ### What is the staking dashboard URL?
 
 The staking dashboard URL is https://staking.polygon.technology/.
 
 ### What is the minimum stake amount?
 
-There is no minimum stake amount to delegate. However, you can always start with 1 MATIC token.
+There is no minimum stake amount to delegate. However, you can always start with 1 POL token.
 
 
 ### How to stake tokens on Polygon?
@@ -165,7 +173,7 @@ All staking transactions of Polygon PoS take place on Ethereum for security reas
 The time taken to complete a transaction depends on the gas fees that you have allowed and also the network congestion of Ethereum mainnet at that point in time. You can always use the **Speed Up** option to increase the gas fees so that your transaction can be completed soon.
 
 
-### I've staked my MATIC tokens. How can I stake more?
+### I've staked my POL tokens. How can I stake more?
 
 Navigate to the **Your Delegations** page and choose one of the stakes. Then click on **Stake More**.
 
@@ -243,7 +251,7 @@ Please watch the video for a graphical illustration of how this works:
 
 ### I want to restake rewards but I am unable to.
 
-You would need to have a minimum of **2 MATIC** to restake rewards.
+You'll need to have a minimum of **2 POL** to restake rewards.
 
 ### How to withdraw rewards?
 
@@ -268,7 +276,7 @@ Please watch the video for a graphical illustration of how this works:
 
 ### I want to withdraw rewards but I am unable to.
 
-You would need to have a minimum of **2 MATIC** available to withdraw rewards.
+You'll need to have a minimum of **2 POL** available to withdraw rewards.
 
 ### How to claim stake?
 
@@ -329,7 +337,7 @@ On the dashboard, you can click on the **My Account** option on the left-hand si
 
 Yes. You should maintain at least ~0.05-0.1 ETH balance for gas fees to be safe.
 
-### Do I need to deposit MATIC tokens to the Polygon mainnet network for staking?
+### Do I need to deposit POL tokens to the Polygon mainnet network for staking?
 
 No. All your funds need to be on the main Ethereum network.
 
@@ -341,7 +349,7 @@ Please check if you have enough ETH for the gas fees.
 
 The rewards are distributed whenever a checkpoint is submitted.
 
-Currently, 71795 MATIC tokens are distributed proportionately on each successful checkpoint submission to each delegator based on their stake relative to the overall staking pool of all validators and delegators. Also, the percentage for the reward distributed to each delegator will vary with each checkpoint depending on the relative stake of the delegator, validator and the overall stake.
+Currently, 71795 POL tokens are distributed proportionately on each successful checkpoint submission to each delegator based on their stake relative to the overall staking pool of all validators and delegators. Also, the percentage for the reward distributed to each delegator will vary with each checkpoint depending on the relative stake of the delegator, validator and the overall stake.
 
 Note that there is a 10% proposer bonus that accrues to the validator who submits the checkpoint, but over time, the effect of the extra bonus is nullified over multiple checkpoints by different validators.
 
@@ -351,7 +359,7 @@ You can track checkpoints on the staking contract [here](https://etherscan.io/ad
 
 ### Why do rewards keep getting decreased at every checkpoint?
 
-Actual rewards earned will depend on the actual total locked supply in the network at each checkpoint. This is expected to vary significantly as more MATIC tokens get locked in the staking contracts.
+Actual rewards earned will depend on the actual total locked supply in the network at each checkpoint. This is expected to vary significantly as more POL tokens get locked in the staking contracts.
 
 Rewards will be higher, to begin with, and will keep decreasing as the locked supply % goes up. This change in locked supply is captured at every checkpoint, and rewards are calculated based on this.
 
diff --git a/docs/pos/how-to/full-node/full-node-gcp.md b/docs/pos/how-to/full-node/full-node-gcp.md
@@ -3,10 +3,10 @@ comments: true
 ---
 
 !!! warning "Mumbai testnet deprecated"
+      
+      Mumbai testnet is deprecated and will not receive any future updates. GCP support for deploying Amoy testnet nodes will be ready soon. Stay tuned!
 
-   Mumbai testnet is deprecated and will not receive any future updates. GCP support for deploying Amoy testnet nodes will be ready soon. Stay tuned!
-
-In this document, we will describe how to deploy Polygon nodes into a Virtual Machine instance on the Google Cloud Platform (GCP).
+This document describes how to deploy Polygon PoS nodes into a Virtual Machine instance on the Google Cloud Platform (GCP).
 
 It is recommended to use any modern Debian or Linux Ubuntu OS with long-term support, i.e. Debian 11, Ubuntu 20.04. We'll focus on Ubuntu 20.04 in this guide.
 
diff --git a/docs/pos/how-to/operate-validator-node/topup-heimdall-fee.md b/docs/pos/how-to/operate-validator-node/topup-heimdall-fee.md
@@ -23,7 +23,7 @@ You can also do it manually by following the steps below. This requires basic Et
 5. Fill in the details:
 
     - `user`: Validator's Signer Address
-    - `heimdallFee`: Top-up fee (**minimum 1 MATIC**)
+    - `heimdallFee`: Top-up fee (**minimum 1 POL**)
 
 6. After filling in the details, select **Write** to sign the transaction.
 
diff --git a/docs/pos/how-to/operate-validator-node/validator-best-practices.md b/docs/pos/how-to/operate-validator-node/validator-best-practices.md
@@ -10,7 +10,7 @@ The *signer wallet* is an address that is used for signing Heimdall blocks, chec
 
 The validator must keep two types of balances in this wallet:
 
-- MATIC tokens on Heimdall (through top-up transactions) to perform validator responsibilities on Heimdall.
+- POL tokens on Heimdall (through top-up transactions) to perform validator responsibilities on Heimdall.
 - ETH on Ethereum to send checkpoints on Ethereum.
 
 The *owner wallet* is an address that is used for staking, re-staking, changing the signer key, withdrawing rewards, and managing delegation related parameters on the Ethereum chain. 
diff --git a/docs/pos/how-to/operate-validator-node/validator-staking-operations.md b/docs/pos/how-to/operate-validator-node/validator-staking-operations.md
@@ -52,7 +52,7 @@ You can stake on Polygon using the [validator dashboard](https://staking.polygon
 ### Stake using the staking dashboard
 
 1. Access the [validator dashboard](https://staking.polygon.technology/validators/).
-2. Log in with your wallet. MetaMask is the recommended wallet. You have to make sure that you login using the same address where your MATIC tokens are present.
+2. Log in with your wallet. MetaMask is the recommended wallet. You have to make sure that you login using the same address where your POL tokens are present.
 3. Select **Become a Validator**. You will be asked to set up your node. If you haven't already set up your node by now, you will need to do so, else if you proceed ahead you will receive an error when you attempt to stake.
 4. On the next screen, add your validator details, the commission rate, and the staking amount.
 5. Select **Stake Now**.
@@ -86,7 +86,7 @@ The following output should appear:
 ```json
 address: 0x6c468cf8c9879006e22ec4029696e005c2319c9d
 coins:
-- denom: matic
+- denom: pol
 amount:
     i: "1000000000000000000000"
 accountnumber: 0
diff --git a/docs/pos/how-to/troubleshoot/technical-faqs.md b/docs/pos/how-to/troubleshoot/technical-faqs.md
@@ -221,7 +221,7 @@ Under the current limit, a maximum of 105 validators can be active at any given
 
 Set the `stake-amount` and `heimdall-fee-amount` values according to the logic described below.
 
-A minimum of 10 Matic tokens is required for the stake amount whereas heimdall fee should be greater than 10. For example, your stake amount is 400 then the heimdall fee should be 20. We suggest to keep the Heimdall fee as 20.
+A minimum of 10 POL tokens is required for the stake amount whereas heimdall fee should be greater than 10. For example, your stake amount is 400 then the heimdall fee should be 20. We suggest to keep the Heimdall fee as 20.
 
 However, please note that the values entered in stake amount and `heimdal-fee-amount` should be entered in 18 decimals.
 
@@ -271,7 +271,7 @@ $ curl [http://localhost:26657/status](http://localhost:26657/status)
 Check the value of the `catching_up` flag. If it is `false` then the node is all synced up.
 
 
-### 15. If someone becomes a top 10 staker, how do they receive their MATIC reward?
+### 15. If someone becomes a top 10 staker, how do they receive their POL reward?
 
 Stage 1 rewards are not based on stake. Participants with high stake don't automatically qualify for a reward in this stage.
 
@@ -289,7 +289,7 @@ The correct version of Heimdall for stage 1 should be `heimdalld version is beta
 
 ### 17. What values should I add in the stake amount and fee amount?
 
-A minimum of 10 Matic tokens is required for the stake amount whereas heimdall fee should be greater than 10. For example, your stake amount is 400 then the heimdall fee should be 20. We suggest to keep the Heimdall fee as 20.
+A minimum of 10 POL tokens is required for the stake amount whereas heimdall fee should be greater than 10. For example, your stake amount is 400 then the heimdall fee should be 20. We suggest to keep the Heimdall fee as 20.
 
 However, please note that the values entered in stake amount and `heimdal-fee-amount` should be entered in 18 decimals.
 
diff --git a/docs/pos/how-to/validator/prerequisites.md b/docs/pos/how-to/validator/prerequisites.md
@@ -199,7 +199,7 @@ Run: `heimdalld version`
 
 ### 6. Which private key should be added when generating the validator key?
 
-The private key to be used is your wallet's ETH address where your MATIC testnet tokens are stored. You can complete the setup with one public-private key pair tied to the address submitted on the form.
+The private key to be used is your wallet's ETH address where your POL testnet tokens are stored. You can complete the setup with one public-private key pair tied to the address submitted on the form.
 
 ### 7. Where can I find Heimdall account info location?
 
diff --git a/docs/pos/how-to/validator/validator-ansible.md b/docs/pos/how-to/validator/validator-ansible.md
diff --git a/docs/pos/how-to/validator/validator-binaries.md b/docs/pos/how-to/validator/validator-binaries.md
diff --git a/docs/pos/how-to/validator/validator-packages.md b/docs/pos/how-to/validator/validator-packages.md
