Skip to content

Commit 4c7476f

Browse files
authored
docs: fix typos (#18125)
1 parent b2398cf commit 4c7476f

11 files changed

+14
-14
lines changed

docs/architecture/adr-007-specialization-groups.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,7 @@ the members already in a specialization group to internally elect new members,
5151
or maybe the community may assign a permission to a particular specialization
5252
group to appoint members to other 3rd party groups. The sky is really the limit
5353
as to how membership admittance can be structured. We attempt to capture
54-
some of these possiblities in a common interface dubbed the `Electionator`. For
54+
some of these possibilities in a common interface dubbed the `Electionator`. For
5555
its initial implementation as a part of this ADR we recommend that the general
5656
election abstraction (`Electionator`) is provided as well as a basic
5757
implementation of that abstraction which allows for a continuous election of

docs/architecture/adr-020-protobuf-transaction-encoding.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -69,7 +69,7 @@ message Tx {
6969
repeated bytes signatures = 3;
7070
}
7171
72-
// A variant of Tx that pins the signer's exact binary represenation of body and
72+
// A variant of Tx that pins the signer's exact binary representation of body and
7373
// auth_info. This is used for signing, broadcasting and verification. The binary
7474
// `serialize(tx: TxRaw)` is stored in Tendermint and the hash `sha256(serialize(tx: TxRaw))`
7575
// becomes the "txhash", commonly used as the transaction ID.

docs/architecture/adr-028-public-key-addresses.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -179,7 +179,7 @@ We must be able to cryptographically derive one address from another one. The de
179179

180180
```go
181181
func Derive(address, derivationKey []byte) []byte {
182-
return Hash(addres, derivationKey)
182+
return Hash(address, derivationKey)
183183
}
184184
```
185185

docs/architecture/adr-031-msg-service.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -118,7 +118,7 @@ We propose to add a `msg_service_router` in BaseApp. This router is a key/value
118118

119119
When a transaction is processed by BaseApp (in CheckTx or in DeliverTx), its `TxBody.messages` are decoded as `Msg`s. Each `Msg`'s `type_url` is matched against an entry in the `msg_service_router`, and the respective `Msg` service method handler is called.
120120

121-
For backward compatability, the old handlers are not removed yet. If BaseApp receives a legacy `Msg` with no correspoding entry in the `msg_service_router`, it will be routed via its legacy `Route()` method into the legacy handler.
121+
For backward compatibility, the old handlers are not removed yet. If BaseApp receives a legacy `Msg` with no correspoding entry in the `msg_service_router`, it will be routed via its legacy `Route()` method into the legacy handler.
122122

123123
### Module Configuration
124124

docs/architecture/adr-039-epoched-staking.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -39,14 +39,14 @@ Furthermore, it has become clearer over time that immediate execution of staking
3939

4040
### Slashing
4141

42-
There is a design consideration for whether to apply a slash immediately or at the end of an epoch. A slash event should apply to only members who are actually staked during the time of the infraction, namely during the epoch the slash event occured.
42+
There is a design consideration for whether to apply a slash immediately or at the end of an epoch. A slash event should apply to only members who are actually staked during the time of the infraction, namely during the epoch the slash event occurred.
4343

4444
Applying it immediately can be viewed as offering greater consensus layer security, at potential costs to the aforementioned usecases. The benefits of immediate slashing for consensus layer security can be all be obtained by executing the validator jailing immediately (thus removing it from the validator set), and delaying the actual slash change to the validator's weight until the epoch boundary. For the use cases mentioned above, workarounds can be integrated to avoid problems, as follows:
4545

4646
* For threshold based cryptography, this setting will have the threshold cryptography use the original epoch weights, while consensus has an update that lets it more rapidly benefit from additional security. If the threshold based cryptography blocks liveness of the chain, then we have effectively raised the liveness threshold of the remaining validators for the rest of the epoch. (Alternatively, jailed nodes could still contribute shares) This plan will fail in the extreme case that more than 1/3rd of the validators have been jailed within a single epoch. For such an extreme scenario, the chain already have its own custom incident response plan, and defining how to handle the threshold cryptography should be a part of that.
4747
* For light client efficiency, there can be a bit included in the header indicating an intra-epoch slash (ala https://github.com/tendermint/spec/issues/199).
4848
* For fairness of deterministic leader election, applying a slash or jailing within an epoch would break the guarantee we were seeking to provide. This then re-introduces a new (but significantly simpler) problem for trying to provide fairness guarantees. Namely, that validators can adversarially elect to remove themself from the set of proposers. From a security perspective, this could potentially be handled by two different mechanisms (or prove to still be too difficult to achieve). One is making a security statement acknowledging the ability for an adversary to force an ahead-of-time fixed threshold of users to drop out of the proposer set within an epoch. The second method would be to parameterize such that the cost of a slash within the epoch far outweights benefits due to being a proposer. However, this latter criterion is quite dubious, since being a proposer can have many advantageous side-effects in chains with complex state machines. (Namely, DeFi games such as Fomo3D)
49-
* For staking derivative design, there is no issue introduced. This does not increase the state size of staking records, since whether a slash has occured is fully queryable given the validator address.
49+
* For staking derivative design, there is no issue introduced. This does not increase the state size of staking records, since whether a slash has occurred is fully queryable given the validator address.
5050

5151
### Token lockup
5252

@@ -100,7 +100,7 @@ Then we add methods to the end blockers, to ensure that at the epoch boundary th
100100

101101
When querying the staking activity of a given address, the status should return not only the amount of tokens staked, but also if there are any queued stake events for that address. This will require more work to be done in the querying logic, to trace the queued upcoming staking events.
102102

103-
As an initial implementation, this can be implemented as a linear search over all queued staking events. However, for chains that need long epochs, they should eventually build additional support for nodes that support querying to be able to produce results in constant time. (This is do-able by maintaining an auxilliary hashmap for indexing upcoming staking events by address)
103+
As an initial implementation, this can be implemented as a linear search over all queued staking events. However, for chains that need long epochs, they should eventually build additional support for nodes that support querying to be able to produce results in constant time. (This is do-able by maintaining an auxiliary hashmap for indexing upcoming staking events by address)
104104

105105
**Step-3**: Adjust gas
106106

docs/architecture/adr-044-protobuf-updates-guidelines.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,7 @@ The SDK requires the Protobuf comment of the new addition to contain one line wi
4949
// Since: cosmos-sdk <version>{, <version>...}
5050
```
5151

52-
Where each `version` denotes a minor ("0.45") or patch ("0.44.5") version from which the field is available. This will greatly help client libraries, who can optionally use reflection or custom code generation to show/hide these fields depending on the targetted node version.
52+
Where each `version` denotes a minor ("0.45") or patch ("0.44.5") version from which the field is available. This will greatly help client libraries, who can optionally use reflection or custom code generation to show/hide these fields depending on the targeted node version.
5353

5454
As examples, the following comments are valid:
5555

docs/architecture/adr-046-module-params.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -143,7 +143,7 @@ are read on a consistent basis.
143143

144144
However, this methodology will require developers to implement more types and
145145
Msg service metohds which can become burdensome if many parameters exist. In addition,
146-
developers are required to implement persistance logics of module parameters.
146+
developers are required to implement persistence logics of module parameters.
147147
However, this should be trivial.
148148

149149
### Backwards Compatibility

docs/architecture/adr-049-state-sync-hooks.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ implement `ExtensionSnapshotter` as extension snapshotters. When setting up the
3737

3838
```protobuf
3939
// SnapshotItem is an item contained in a rootmulti.Store snapshot.
40-
// On top of the exsiting SnapshotStoreItem and SnapshotIAVLItem, we add two new options for the item.
40+
// On top of the existing SnapshotStoreItem and SnapshotIAVLItem, we add two new options for the item.
4141
message SnapshotItem {
4242
// item is the specific type of snapshot item.
4343
oneof item {

docs/architecture/adr-050-sign-mode-textual.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ Spec version: 0.
2424

2525
## Abstract
2626

27-
This ADR specifies SIGN_MODE_TEXTUAL, a new string-based sign mode that is targetted at signing with hardware devices.
27+
This ADR specifies SIGN_MODE_TEXTUAL, a new string-based sign mode that is targeted at signing with hardware devices.
2828

2929
## Context
3030

docs/architecture/adr-059-test-scopes.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -148,7 +148,7 @@ to a production environment as is practical. Presently these tests are located a
148148
[tests/e2e](https://github.com/cosmos/cosmos-sdk/tree/main/tests/e2e) and rely on [testutil/network](https://github.com/cosmos/cosmos-sdk/tree/main/testutil/network) to start up an in-process Tendermint node.
149149

150150
An application should be built as minimally as possible to exercise the desired functionality.
151-
The SDK uses an application will only the required modules for the tests. The application developer is adviced to use its own application for e2e tests.
151+
The SDK uses an application will only the required modules for the tests. The application developer is advised to use its own application for e2e tests.
152152

153153
#### Limitations
154154

0 commit comments

Comments
 (0)