Skip to content

Commit 19da09d

Browse files
committed
Absolute links in PoS
1 parent acf47eb commit 19da09d

File tree

22 files changed

+51
-609
lines changed

22 files changed

+51
-609
lines changed

docs/pos/architecture/bor/state-sync.md

Lines changed: 3 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,6 @@
1-
# State Sync Mechanism
2-
31
`State Sync` is the native mechanism to read Ethereum data from Matic EVM chain.
42

5-
Validators on the Heimdall layer pickup the [StateSynced](https://github.com/maticnetwork/contracts/blob/a4c26d59ca6e842af2b8d2265be1da15189e29a4/contracts/root/stateSyncer/StateSender.sol#L24) event and pass it on to the Bor layer (read more about the architecture [here](/docs/pos/design/bor/overview).
3+
Validators on the Heimdall layer pickup the [StateSynced](https://github.com/maticnetwork/contracts/blob/a4c26d59ca6e842af2b8d2265be1da15189e29a4/contracts/root/stateSyncer/StateSender.sol#L24) event and pass it on to the Bor layer.
64

75
The receiver contract inherits [IStateReceiver](https://github.com/maticnetwork/genesis-contracts/blob/master/contracts/IStateReceiver.sol), and custom logic sits inside [onStateReceive](https://github.com/maticnetwork/genesis-contracts/blob/05556cfd91a6879a8190a6828428f50e4912ee1a/contracts/IStateReceiver.sol#L5) function.
86

@@ -78,13 +76,13 @@ interface IStateReceiver {
7876
7977
Only `0x0000000000000000000000000000000000001001``StateReceiver.sol`, must be allowed to call `onStateReceive` function on target contract.
8078
81-
## System Call
79+
## System call
8280
8381
Only system address, `2^160-2`, allows making a system call. Bor calls it internally with the system address as `msg.sender`. It changes the contract state and updates the state root for a particular block. Inspired from [https://github.com/ethereum/EIPs/blob/master/EIPS/eip-210.md](https://github.com/ethereum/EIPs/blob/master/EIPS/eip-210.md) and [https://wiki.parity.io/Validator-Set#contracts](https://wiki.parity.io/Validator-Set#contracts)
8482
8583
System call is helpful to change state to contract without making any transaction.
8684
87-
## State-sync logs and Bor Block Receipt
85+
## State-sync logs and Bor block receipts
8886
8987
Events emitted by system calls are handled in a different way than normal logs. Here is the code: [https://github.com/maticnetwork/bor/pull/90](https://github.com/maticnetwork/bor/pull/90).
9088

docs/pos/architecture/heimdall/modules/checkpoint.md

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,6 @@
22

33
`checkpoint` module manages checkpoint related functionalities for Heimdall. It needs Bor chain when a new checkpoint is proposed on Heimdall to verify checkpoint root hash.
44

5-
All related to checkpoint data is explained in details [here](/docs/pos/design/heimdall/checkpoint).
6-
75
## Checkpoint life-cycle
86

97
Heimdall uses the same leader selection algorithm as Tendermint to select the next proposer. While submitting checkpoints on the Ethereum chain, it may fail due to multiple reasons like gas limit, traffic on Ethereum, high gas fees. That's why the multi-stage checkpoint process is required.

docs/pos/architecture/heimdall/modules/clerk.md

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

docs/pos/architecture/heimdall/modules/staking.md

Lines changed: 0 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -2,22 +2,6 @@
22

33
Staking module manages validator related transactions and state for Heimdall. Note that a validator stakes their tokens on the Ethereum chain and becomes a validator. Respective validators send the transactions on Heimdall using necessary parameters to acknowledge the Ethereum stake change. Once the majority of the validators agree on the change on the stake, this module saves the validator information on Heimdall state.
44

5-
## Key Management
6-
7-
For key management, please refer to [Validator key management](/docs/pos/design/heimdall/validator-key-management)
8-
9-
## Delegation
10-
11-
This module only manages validator staking on Heimdall. The delegation is only available on smart contracts on the Ethereum chain. To optimize the delegation rewards calculation on smart contracts, we are using validator shares (ERC20 per validator).
12-
13-
More details here: [Delegation (Validator shares)](/pos/reference/contracts/delegation)
14-
15-
## Rewards
16-
17-
All rewards are distributed on the Ethereum chain. The validators and delegators claim their rewards or re-stake by simply sending the transaction on `StakeManager.sol`
18-
19-
More details here: [Rewards](/docs/pos/design/validator/rewards.md#what-is-the-incentive)
20-
215
## Messages
226

237
<img src="img/pos/stake-management-flow.svg" />

docs/pos/concepts/tokens/pol.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,6 @@ Separately, you are encouraged to engage in the governance and decision-making p
1818
Your involvement and input can play a significant role in shaping the future of the Polygon ecosystem.
1919

2020
You can participate in governance proposals to vote on various aspects of the Polygon ecosystem through the PIP program.
21-
Check out how to do so [<ins>here</ins>](/docs/category/proposals/).
2221

2322
### **Do** I Need to Do Anything Today **as a Node Operator or Delegator?**
2423

docs/pos/get-started/index.md

Lines changed: 2 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -137,25 +137,10 @@ Bor does the following:
137137

138138
Bor is the Block producer node and layer for the Polygon Network. It is based on Go Ethereum. Blocks produced on Bor are validated by Heimdall nodes.
139139

140-
:::info See Also
140+
!!! info "Community resources"
141141

142142
* GitHub repository: [Bor](https://github.com/maticnetwork/bor)
143143
* Blog post: [Heimdall and Bor](https://blog.polygon.technology/heimdall-and-bor/)
144-
145-
:::
146-
147-
This section guides you through the following topics:
148-
149-
* [Validator responsibilities](/pos/design/validator/responsibilities.md)
150-
* Joining the network as a validator:
151-
* [Start and run the nodes with Ansible](/pos/validator/run-validator/ansible.md)
152-
* [Start and run the nodes with binaries](/pos/validator/run-validator/binaries.md)
153-
* [Stake as a validator](/pos/validator/validator-staking-operations.md)
154-
* Maintaining your validator nodes:
155-
* [Change the signer address](/pos/validator/change-signer-address.md)
156-
* [Change the commission](/pos/validator/validator-commission-operations.md)
157-
158-
Community assistance:
159-
160144
* [Discord](https://discord.com/invite/0xPolygon)
161145
* [Forum](https://forum.polygon.technology/)
146+

0 commit comments

Comments
 (0)