Skip to content

Commit df26652

Browse files
tbroimabdulbasit
andauthored
Small update for upgrades.md (#1876)
Updates for recent switch to `Versions` and small clarifications. --------- Co-authored-by: tbro <[email protected]> Co-authored-by: Abdul Basit <[email protected]>
1 parent 4761a20 commit df26652

File tree

1 file changed

+4
-4
lines changed

1 file changed

+4
-4
lines changed

doc/upgrades.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# Upgrades
22

33
Hotshot protocol supports upgrades through an Upgrade proposal mechanism. The Upgrade proposal is broadcast separately
4-
from the `QuorumProposal`, typically several views in advance of its attachment. The goal is to ensure ample time for
4+
from the `QuorumProposal`, typically several views before the upgrade is attempted. The goal is to ensure ample time for
55
nodes to receive and prepare for the upgrade process.
66

77
After enough votes have been collected on the `UpgradeProposal`, an `UpgradeCertificate` is formed. This is attached to
@@ -33,10 +33,10 @@ hash:
3333
different proposals of the same version upgrade, ensuring nodes vote and execute the correct one. It consists of a
3434
sequence of 32 bytes.
3535

36-
These are defined in [NodeType implementation](../types/src/v0/mod.rs) for the Types (`SeqTypes` in our case).
36+
These are defined in [Versions implementation](../types/src/v0/mod.rs) for the Type (`SequencerVersions` in our case).
3737

3838
```rust
39-
impl NodeType for SeqTypes {
39+
impl Versions for SequencerVersions {
4040
type Base = StaticVersion<0, 1>;
4141
type Upgrade = StaticVersion<0, 2>;
4242
const UPGRADE_HASH: [u8; 32] = [
@@ -53,7 +53,7 @@ parameters use Unix timestamps for the same purpose.
5353

5454
To simplify configuration, these parameters are fetched from the genesis TOML file and set in the Hotshot config. The
5555
TOML file can include either view-based parameters or time-based parameters, but not both. Furthermore, the start and
56-
stop voting parameters for both time-based and view-based upgrades are optional. Start parameter is set 0 so that voting
56+
stop voting parameters for both time-based and view-based upgrades are optional. If omitted, start parameter will be set to 0 so that voting
5757
begins as soon as node is started while the stop parameter is set to a maximum value so that the nodes keep voting until
5858
enough votes are collected.
5959

0 commit comments

Comments
 (0)