You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/pos/architecture/heimdall_v2/balance-transfers.md
+4-4Lines changed: 4 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -15,9 +15,9 @@ interaction with other modules which must alter user balances.
15
15
In addition, the bank module tracks and provides query support for the total
16
16
supply of all assets used in the application.
17
17
18
-
This module is used in the Cosmos Hub and [Heimdall-v2](https://github.com/0xPolygon/heimdall-v2).
18
+
This module is used in the Cosmos Hub and [Heimdall](https://github.com/0xPolygon/heimdall-v2).
19
19
20
-
**NOTE**: For heimdall-v2, minimal changes have been done in the fork listed [here](#conceptschanges-specific-to-heimdall-v2)
20
+
**NOTE**: For heimdall, minimal changes have been done in the fork listed [here](#conceptschanges-specific-to-heimdall)
21
21
22
22
## Supply
23
23
@@ -1016,12 +1016,12 @@ Example Output:
1016
1016
}
1017
1017
```
1018
1018
1019
-
## concepts/changes specific to heimdall-v2
1019
+
## concepts/changes specific to heimdall
1020
1020
1021
1021
Since heimdall is a unique component of the PoS architecture and not a traditional Cosmos SDK app, some changes had to be made in order to ensure correct functionality, some of which are :
1022
1022
1023
1023
* MsgSetSendEnabled is not supported since POL is the only denom used.
1024
1024
1025
1025
* (Un)delegation is not supported since staking related logic is handled by PoS [core contracts](https://github.com/0xPolygon/core-contracts/tree/main/contracts) deployed on Ethereum.
1026
1026
1027
-
* A default fee of 10^15 POL (`DefaultFeeInPol`) is deducted from the tx sender.
1027
+
* A default fee of 10^15 POL (`DefaultFeeInPol`) is deducted from the tx sender.
In Heimdallv2, validator signing keys must be imported into the keyring for transaction signing. For details of keyring, refer to the Cosmos SDK documentation [here](https://docs.cosmos.network/v0.46/run-node/keyring.html)
16
+
In Heimdall-v2, validator signing keys must be imported into the keyring for transaction signing. For details of keyring, refer to the Cosmos SDK documentation [here](https://docs.cosmos.network/v0.46/run-node/keyring.html)
17
17
18
18
From the Cosmos documentation:
19
19
@@ -42,4 +42,4 @@ When running a `tx` command, just specify the `--from` argument, by using the na
42
42
43
43
## Vote extension in each block
44
44
45
-
In Heimdallv2, the first transaction of each block will contain the encoded vote extensions. To decode these, use the additional command in `heimdallld`
45
+
In Heimdall-v2, the first transaction of each block will contain the encoded vote extensions. To decode these, use the additional command in `heimdallld`
Copy file name to clipboardExpand all lines: docs/pos/architecture/heimdall_v2/checkpoints.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -56,7 +56,7 @@ Additionally, the selection of the next checkpoint proposer is adjusted based on
56
56
The `MsgCpNoAck` message is broadcast by the bridge processor to indicate that a checkpoint was potentially transferred to the Ethereum chain but has not received an acknowledgment.
57
57
A background routine periodically checks for time elapsed and publishes the No-ACK signal. No-ACK is sent if a sufficient amount of time has passed since:
58
58
59
-
- the last checkpoint was created on the Heimdallv2 chain and
59
+
- the last checkpoint was created on the Heimdall-v2 chain and
60
60
- the last No-ACK was issued.
61
61
To conclude, the No-ACKs are triggered only when a checkpoint acknowledgment is overdue, ensuring they are not sent too frequently.
62
62
This message is broadcasted only by the proposer. This entire flow ensures that checkpoints are securely proposed, verified, and finalized across the Heimdall and Ethereum chains in a decentralized manner.
Copy file name to clipboardExpand all lines: docs/pos/architecture/heimdall_v2/introduction.md
+3-3Lines changed: 3 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,6 +1,6 @@
1
-
# Heimdallv2
1
+
# Heimdall-v2
2
2
3
-
Heimdallv2 is a modernized and revamped consensus client that is at the heart of the Polygon PoS network. Similar to the previous version of Heimdall it performs the following functions:
3
+
Heimdall-v2 is a modernized and revamped consensus client that is at the heart of the Polygon PoS network. Similar to the previous version of Heimdall it performs the following functions:
4
4
5
5
- Manages validators.
6
6
- Handles block producer selection.
@@ -12,4 +12,4 @@ It uses a fork of [*Cosmos SDK*](https://github.com/0xPolygon/cosmos-sdk) based
12
12
13
13
Heimdall leverages some modified versions of `cosmos-sdk` modules (`auth`, `bank` and `gov`) plus some fully customized modules (`bor`, `chainmanager`, `checkpoint`, `clerk`, `milestone`, `stake` and `topup`).
14
14
15
-
For detailed instructions on running Heimdall v2, refer to the [Readme](https://github.com/0xPolygon/heimdall-v2/blob/develop/README.md) in the Github repository
15
+
For detailed instructions on running Heimdall, refer to the [Readme](https://github.com/0xPolygon/heimdall-v2/blob/develop/README.md) in the Github repository
Copy file name to clipboardExpand all lines: docs/pos/architecture/heimdall_v2/staking.md
+4-4Lines changed: 4 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -12,7 +12,7 @@ this module saves the validator information on Heimdall state.
12
12
13
13
## Flow
14
14
15
-
The x/stake module manages validator-related transactions and validator set management for Heimdall v2.
15
+
The x/stake module manages validator-related transactions and validator set management for Heimdall.
16
16
17
17
Validators stake their tokens on the Ethereum chain to participate in consensus. To synchronize these changes with Heimdall, the bridge processor broadcasts the corresponding transaction for an Ethereum-emitted event, choosing from one of the following messages each with the necessary parameters:
18
18
@@ -21,14 +21,14 @@ Validators stake their tokens on the Ethereum chain to participate in consensus.
21
21
-`MsgValidatorExit`: When a validator decides to exit, they initiate the process on Ethereum, leading to the emission of a `UnstakeInit` event. This message ensures that Heimdall records the validator’s departure accordingly.
22
22
-`MsgSignerUpdate`: This message is responsible for processing changes to a validator’s signer key. When a validator updates their signer key on Ethereum, it emits a `SignerUpdate` event, prompting Heimdall to reflect the new signer key in its records.
23
23
24
-
Each of these transactions in Heimdall v2 follows the same processing mechanisms, leveraging ABCI++ phases.
24
+
Each of these transactions in Heimdall follows the same processing mechanisms, leveraging ABCI++ phases.
25
25
26
26
During the `PreCommit` phase, side transaction handlers are triggered, and a vote is injected after validating the Ethereum-emitted event and ensuring its alignment with the data in the processed message.
27
27
28
28
Once a majority of validators confirm that the action described in the message has occurred on Ethereum, the x/stake module updates the validator’s state in Heimdall during the `FinalizeBlock`’s `PreBlocker` execution.
29
29
30
30
### Replay Prevention Mechanism
31
-
Heimdall v2 employs a replay prevention mechanism in the post-tx handler functions to ensure that validator update messages derived from Ethereum events are not processed multiple times.
31
+
Heimdall employs a replay prevention mechanism in the post-tx handler functions to ensure that validator update messages derived from Ethereum events are not processed multiple times.
32
32
33
33
This mechanism prevents replay attacks by assigning a unique sequence number to each transaction and verifying whether it has already been processed.
34
34
The sequence number is constructed using the Ethereum block number and log index, following the formula:
Copy file name to clipboardExpand all lines: docs/pos/architecture/heimdall_v2/topup.md
+3-3Lines changed: 3 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -13,7 +13,7 @@ There are two ways to top up your account:
13
13
14
14
## Flow
15
15
16
-
The Heimdall Top-up Mechanism facilitates the management of validator fees on the Heimdall v2 chain by allowing deposits from the Ethereum (L1) root chain.
16
+
The Heimdall Top-up Mechanism facilitates the management of validator fees on the Heimdall chain by allowing deposits from the Ethereum (L1) root chain.
17
17
This mechanism ensures validators have enough balances on Heimdall to cover operational fees.
18
18
The system integrates staking smart contract on Ethereum with Heimdall custom x/topup and x/checkpoint modules and a bridge component to enable seamless cross-chain fee management.
19
19
@@ -47,7 +47,7 @@ Each top-up is uniquely identified by a sequence number built from `TxHash` and
47
47
`MsgTopupTx` is a side-transaction, ensuring state changes only after the successful pre-commit majority of the votes are collected and final validation and post-tx handler execution in the following block height.
48
48
When broadcasting the `MsgTopupTx` - sender (proposer of the topup) must sign it, and additional user address must be sent.
49
49
50
-
For the top-up to be accepted, the `MsgTopupTx.Fee` must be at least equal to the `DefaultFeeWantedPerTx` amount. The top-up processing on Heimdall v2 involves:
50
+
For the top-up to be accepted, the `MsgTopupTx.Fee` must be at least equal to the `DefaultFeeWantedPerTx` amount. The top-up processing on Heimdall involves:
51
51
52
52
- Minting the top-up number of pol tokens to the top-up module account.
53
53
- Transferring the entire amount from the top-up module account to the user account.
Copy file name to clipboardExpand all lines: docs/pos/architecture/overview.md
+2-2Lines changed: 2 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -54,13 +54,13 @@ An overview of the process:
54
54
* A selected proposer from the validator set is responsible for collecting all signatures for a particular checkpoint and committing the checkpoint on the Ethereum mainnet.
55
55
* The responsibility of creating blocks and proposing checkpoints is variably dependent on a validator’s stake ratio in the overall pool.
56
56
57
-
Heimdall (v1) was deprecated and replaced by Heimdall-v2.
57
+
The original Heimdall implementation (v1) was deprecated and replaced by Heimdall-v2.
58
58
In these docs, referring to Heimdall means Heimdall-v2, unless otherwise specified.
59
59
The new version is a complete rewrite of the original Heimdall, based on Cosmos SDK and CometBFT.
60
60
More information can be found in the following PIPs:
61
61
-[PIP-43: Replacing Tendermint with CometBFT](https://github.com/maticnetwork/Polygon-Improvement-Proposals/blob/cb371136414b5e198c44750cd4c30f7aad16043a/PIPs/PIP-43.md)
Copy file name to clipboardExpand all lines: docs/pos/governance/governance-fundamentals.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -39,7 +39,7 @@ The framework is composed of three key components:
39
39
40
40
The PoS network currently uses two clients simultaneously:
41
41
42
-
- Heimdall-v2: The [consensus layer](https://docs.polygon.technology/pos/architecture/heimdall_v2/introduction/) - [See GitHub](https://github.com/0xPolygon/heimdall-v2)
42
+
- Heimdall: The [consensus layer](https://docs.polygon.technology/pos/architecture/heimdall_v2/introduction/) - [See GitHub](https://github.com/0xPolygon/heimdall-v2)
43
43
- Bor: The [execution layer](https://docs.polygon.technology/pos/architecture/bor/introduction/) client - [See GitHub](https://github.com/0xPolygon/bor)
44
44
45
45
Currently, Bor and Heimdall are the majority clients for the PoS network. These clients serve as ecosystem focal points rather than control switches operated by core developers that can dictate decisions.
Copy file name to clipboardExpand all lines: docs/pos/how-to/full-node/full-node-binaries.md
+7-7Lines changed: 7 additions & 7 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -44,12 +44,12 @@ Both binaries must be installed and run in the correct order to function properl
44
44
45
45
### Heimdall
46
46
47
-
Install the latest version of Heimdall-v2 and related services. Make sure you checkout to the correct [release version](https://github.com/0xPolygon/heimdall-v2/releases).
47
+
Install the latest version of Heimdall and related services. Make sure you checkout to the correct [release version](https://github.com/0xPolygon/heimdall-v2/releases).
48
48
49
-
To install *Heimdall-v2*, run the following commands:
49
+
To install *Heimdall*, run the following commands:
You can run the above command with the following options:
@@ -74,13 +74,13 @@ Where `BUCKET_URL` is
74
74
-https://storage.googleapis.com/amoy-heimdallv2-genesis/migrated_dump-genesis.json for amoy
75
75
-https://storage.googleapis.com/mainnet-heimdallv2-genesis/migrated_dump-genesis.json for mainnet
76
76
77
-
Verify the installation by checking the Heimdall-v2 version on your machine:
77
+
Verify the installation by checking the Heimdall version on your machine:
78
78
79
79
```bash
80
80
heimdalld version
81
81
```
82
82
83
-
It should return the version of Heimdall-v2 you installed.
83
+
It should return the version of Heimdall you installed.
84
84
85
85
### Bor
86
86
@@ -101,7 +101,7 @@ That will install the `bor` binary. Verify the installation by checking the Bor
101
101
bor version
102
102
```
103
103
104
-
### Configure Heimdall-v2 and Bor seeds
104
+
### Configure Heimdall and Bor seeds
105
105
106
106
The latest bor and heimdall seeds can be found [here](https://docs.polygon.technology/pos/reference/seed-and-bootnodes/). To configure them, update the following lines:
107
107
@@ -130,7 +130,7 @@ sed -i 's/User=bor/User=root/g' /lib/systemd/system/bor.service
130
130
131
131
## Start services
132
132
133
-
Run the full Heimdall-v2 node with these commands on your Sentry Node:
133
+
Run the full Heimdall node with these commands on your Sentry Node:
where `BUCKET_URL` is https://storage.googleapis.com/amoy-heimdallv2-genesis/migrated_dump-genesis.json for amoyand https://storage.googleapis.com/mainnet-heimdallv2-genesis/migrated_dump-genesis.json for mainnet
138
138
139
-
Replace `HEIMDALL_HOME` with the actual path to your Heimdall-v2 home directory.
139
+
Replace `HEIMDALL_HOME` with the actual path to your Heimdall home directory.
140
140
141
141
Please note that the genesis file size is around 50MB for amoy and 3GB for mainnet.
142
142
Hence, the download might take a while, and it’s recommended to use a stable and fast connection.
0 commit comments