Skip to content

Commit aca3389

Browse files
leopardracerAlex | Interchain Labs
andauthored
docs: fix typos and clarify wording (#24925)
Co-authored-by: Alex | Interchain Labs <[email protected]>
1 parent 1572b8e commit aca3389

File tree

2 files changed

+5
-5
lines changed

2 files changed

+5
-5
lines changed

x/gov/README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -284,7 +284,7 @@ There are three parameters that define if the deposit of a proposal should be bu
284284

285285
### Constitution
286286

287-
`Constitution` is found in the genesis state. It is a string field intended to be used to descibe the purpose of a particular blockchain, and its expected norms. A few examples of how the constitution field can be used:
287+
`Constitution` is found in the genesis state. It is a string field intended to be used to describe the purpose of a particular blockchain, and its expected norms. A few examples of how the constitution field can be used:
288288

289289
* define the purpose of the chain, laying a foundation for its future development
290290
* set expectations for delegators
@@ -299,9 +299,9 @@ Since this is more of a social feature than a technical feature, we'll now get i
299299
* In the event of an economic emergency, what should validators do?
300300
* Terra crash of May, 2022, saw validators choose to run a new binary with code that had not been approved by governance, because the governance token had been inflated to nothing.
301301
* What is the purpose of the chain, specifically?
302-
* best example of this is the Cosmos hub, where different founding groups, have different interpertations of the purpose of the network.
302+
* best example of this is the Cosmos hub, where different founding groups, have different interpretations of the purpose of the network.
303303

304-
This genesis entry, "constitution" hasn't been designed for existing chains, who should likely just ratify a constitution using their governance system. Instead, this is for new chains. It will allow for validators to have a much clearer idea of purpose and the expecations placed on them while operating thier nodes. Likewise, for community members, the constitution will give them some idea of what to expect from both the "chain team" and the validators, respectively.
304+
This genesis entry, "constitution" hasn't been designed for existing chains, who should likely just ratify a constitution using their governance system. Instead, this is for new chains. It will allow for validators to have a much clearer idea of purpose and the expectations placed on them while operating their nodes. Likewise, for community members, the constitution will give them some idea of what to expect from both the "chain team" and the validators, respectively.
305305

306306
This constitution is designed to be immutable, and placed only in genesis, though that could change over time by a pull request to the cosmos-sdk that allows for the constitution to be changed by governance. Communities whishing to make amendments to their original constitution should use the governance mechanism and a "signaling proposal" to do exactly that.
307307

@@ -2528,7 +2528,7 @@ Example Output:
25282528

25292529
## Metadata
25302530

2531-
The gov module has two locations for metadata where users can provide further context about the on-chain actions they are taking. By default all metadata fields have a 255 character length field where metadata can be stored in json format, either on-chain or off-chain depending on the amount of data required. Here we provide a recommendation for the json structure and where the data should be stored. There are two important factors in making these recommendations. First, that the gov and group modules are consistent with one another, note the number of proposals made by all groups may be quite large. Second, that client applications such as block explorers and governance interfaces have confidence in the consistency of metadata structure accross chains.
2531+
The gov module has two locations for metadata where users can provide further context about the on-chain actions they are taking. By default all metadata fields have a 255 character length field where metadata can be stored in json format, either on-chain or off-chain depending on the amount of data required. Here we provide a recommendation for the json structure and where the data should be stored. There are two important factors in making these recommendations. First, that the gov and group modules are consistent with one another, note the number of proposals made by all groups may be quite large. Second, that client applications such as block explorers and governance interfaces have confidence in the consistency of metadata structure across chains.
25322532

25332533
### Proposal
25342534

x/slashing/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -53,7 +53,7 @@ blocks. Validators who are _bonded_ are _at stake_, meaning that part or all of
5353
their stake and their delegators' stake is at risk if they commit a protocol fault.
5454

5555
For each of these validators we keep a `ValidatorSigningInfo` record that contains
56-
information partaining to validator's liveness and other infraction related
56+
information pertaining to validator's liveness and other infraction related
5757
attributes.
5858

5959
### Tombstone Caps

0 commit comments

Comments
 (0)