Skip to content

Commit

Permalink
typos
Browse files Browse the repository at this point in the history
  • Loading branch information
imabdulbasit committed Jul 11, 2024
1 parent 41c113f commit d98d2a4
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 6 deletions.
8 changes: 4 additions & 4 deletions doc/upgrades.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ Voting for the `UpgradeProposal` begins before its proposal. Sufficient votes ar

To enable an upgrade in Hotshot protocol:

When preparing for an upgrade, it's essential to define the base version, the upgrade version, and a unique upgrade hash:
When preparing for an upgrade, it is essential to define the base version, the upgrade version, and a upgrade hash:

- **Base Version:** Represents the current version of the protocol (`0.1` in this example).
- **Upgrade Version:** Specifies the version to which the protocol will upgrade once the process is successful (`0.2` in this example).
Expand All @@ -29,7 +29,7 @@ impl NodeType for SeqTypes {

These parameters are fetched from the genesis TOML file and set in Hotshot config:

- **start_voting_view:** view at which voting for the upgrade proposal starts. In our implementation, this is set to 1 so that voting begins as soon as the node is bootup.
- **start_voting_view:** view at which voting for the upgrade proposal starts. In our implementation, this is set to 1 so that voting begins as soon as the node is started.
- **stop_voting_view:** view at which voting for the upgrade proposal stops. To disable an upgrade, set this parameter to 0 or ensure `stop_voting_view` is less than `start_voting_view`.
- **start_proposing_view:** view at which the node proposes an upgrade. This should be set to when an upgrade is intended. If the current view > `start_proposing_view`, the node proposes as soon as `UpgradeCertificate` is formed.
- **stop_proposing_view:** The view after which the upgrade proposal is no longer valid. If the upgrade proposal fails and the current view > stop_proposing_view then the upgrade is never proposed again.
Expand All @@ -55,8 +55,8 @@ fee_contract = '0xa15bb66138824a1c7167f5e85b957d04dd34e468'
```
In the TOML configuration example above, the `upgrade` section defines an array of tables, each specifying upgrade parameters such as version, view, and propose window.

- **Version:** Indicates the current version targeted for the upgrade.
- **View:** Represents the `start_proposing_view` value, marking when the upgrade proposal initiates.
- **Version:** the current version targeted for the upgrade.
- **View:** Represents the `start_proposing_view` value at which the upgrade is proposed.
- **Propose Window:** Refers to the view window between `start_proposing_view` and `stop_proposing_view`.

We currently support only chain config upgrades. The `upgrade.chain_config` table contains the complete set of chain config parameters, which can be used, for example, to enable protocol fees or modify other parameters during an upgrade.
5 changes: 3 additions & 2 deletions types/src/v0/v0_1/instance_state.rs
Original file line number Diff line number Diff line change
Expand Up @@ -69,7 +69,8 @@ pub struct NodeState {
/// Current version of the sequencer.
///
/// This version is checked to determine if an upgrade is planned,
/// and which version variant for versioned types (e.g., build V2 header is version is 0,2) to use
/// in functions such as genesis.
/// and which version variant for versioned types
/// to use in functions such as genesis.
/// (example: genesis returns V2 Header if version is 0.2)
pub current_version: Version,
}

0 comments on commit d98d2a4

Please sign in to comment.