Skip to content

Commit f9b9b45

Browse files
authored
docs: fix typos in files (#24964)
1 parent f9d6429 commit f9b9b45

File tree

5 files changed

+13
-13
lines changed

5 files changed

+13
-13
lines changed

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

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@ in `x/gov`, `MsgSubmitProposal` returns the proposal ID as a big-endian `uint64
4040
This isn’t really documented anywhere and clients would need to know the internals
4141
of the Cosmos SDK to parse that value and return it to users.
4242

43-
Also, there may be cases where we want to use these return values programatically.
43+
Also, there may be cases where we want to use these return values programmatically.
4444
For instance, https://github.com/cosmos/cosmos-sdk/issues/7093 proposes a method for
4545
doing inter-module Ocaps using the `Msg` router. A well-defined return type would
4646
improve the developer UX for this approach.
@@ -82,7 +82,7 @@ the intent of the [protobuf spec](https://developers.google.com/protocol-buffers
8282
With this approach, we would get an auto-generated `MsgServer` interface:
8383

8484
In addition to clearly specifying return types, this has the benefit of generating client and server code. On the server
85-
side, this is almost like an automatically generated keeper method and could maybe be used intead of keepers eventually
85+
side, this is almost like an automatically generated keeper method and could maybe be used instead of keepers eventually
8686
(see [\#7093](https://github.com/cosmos/cosmos-sdk/issues/7093)):
8787

8888
```go
@@ -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 corresponding 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-032-typed-events.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -16,13 +16,13 @@ Proposed
1616

1717
## Abstract
1818

19-
Currently in the Cosmos SDK, events are defined in the handlers for each message as well as `BeginBlock` and `EndBlock`. Each module doesn't have types defined for each event, they are implemented as `map[string]string`. Above all else this makes these events difficult to consume as it requires a great deal of raw string matching and parsing. This proposal focuses on updating the events to use **typed events** defined in each module such that emiting and subscribing to events will be much easier. This workflow comes from the experience of the Akash Network team.
19+
Currently in the Cosmos SDK, events are defined in the handlers for each message as well as `BeginBlock` and `EndBlock`. Each module doesn't have types defined for each event, they are implemented as `map[string]string`. Above all else this makes these events difficult to consume as it requires a great deal of raw string matching and parsing. This proposal focuses on updating the events to use **typed events** defined in each module such that emitting and subscribing to events will be much easier. This workflow comes from the experience of the Akash Network team.
2020

2121
## Context
2222

23-
Currently in the Cosmos SDK, events are defined in the handlers for each message, meaning each module doesn't have a cannonical set of types for each event. Above all else this makes these events difficult to consume as it requires a great deal of raw string matching and parsing. This proposal focuses on updating the events to use **typed events** defined in each module such that emiting and subscribing to events will be much easier. This workflow comes from the experience of the Akash Network team.
23+
Currently in the Cosmos SDK, events are defined in the handlers for each message, meaning each module doesn't have a canonical set of types for each event. Above all else this makes these events difficult to consume as it requires a great deal of raw string matching and parsing. This proposal focuses on updating the events to use **typed events** defined in each module such that emitting and subscribing to events will be much easier. This workflow comes from the experience of the Akash Network team.
2424

25-
[Our platform](http://github.com/ovrclk/akash) requires a number of programatic on chain interactions both on the provider (datacenter - to bid on new orders and listen for leases created) and user (application developer - to send the app manifest to the provider) side. In addition the Akash team is now maintaining the IBC [`relayer`](https://github.com/ovrclk/relayer), another very event driven process. In working on these core pieces of infrastructure, and integrating lessons learned from Kubernetes development, our team has developed a standard method for defining and consuming typed events in Cosmos SDK modules. We have found that it is extremely useful in building this type of event driven application.
25+
[Our platform](http://github.com/ovrclk/akash) requires a number of programmatic on chain interactions both on the provider (datacenter - to bid on new orders and listen for leases created) and user (application developer - to send the app manifest to the provider) side. In addition the Akash team is now maintaining the IBC [`relayer`](https://github.com/ovrclk/relayer), another very event driven process. In working on these core pieces of infrastructure, and integrating lessons learned from Kubernetes development, our team has developed a standard method for defining and consuming typed events in Cosmos SDK modules. We have found that it is extremely useful in building this type of event driven application.
2626

2727
As the Cosmos SDK gets used more extensively for apps like `peggy`, other peg zones, IBC, DeFi, etc... there will be an exploding demand for event driven applications to support new features desired by users. We propose upstreaming our findings into the Cosmos SDK to enable all Cosmos SDK applications to quickly and easily build event driven apps to aid their core application. Wallets, exchanges, explorers, and defi protocols all stand to benefit from this work.
2828

@@ -308,7 +308,7 @@ func PublishChainTxEvents(ctx context.Context, client cmtclient.EventsClient, bu
308308
return err
309309
})
310310

311-
// Exit on error or context cancelation
311+
// Exit on error or context cancellation
312312
return g.Wait()
313313
}
314314
```

docs/architecture/adr-033-protobuf-inter-module-comm.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -378,7 +378,7 @@ replacing `Keeper` interfaces altogether.
378378

379379
* an alternative to keepers which can more easily lead to stable inter-module interfaces
380380
* proper inter-module OCAPs
381-
* improved module developer DevX, as commented on by several particpants on
381+
* improved module developer DevX, as commented on by several participants on
382382
[Architecture Review Call, Dec 3](https://hackmd.io/E0wxxOvRQ5qVmTf6N_k84Q)
383383
* lays the groundwork for what can be a greatly simplified `app.go`
384384
* router can be setup to enforce atomic transactions for module-to-module calls

docs/architecture/adr-034-account-rekeying.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ Account rekeying is a process hat allows an account to replace its authenticatio
1616

1717
Currently, in the Cosmos SDK, the address of an auth `BaseAccount` is based on the hash of the public key. Once an account is created, the public key for the account is set in stone, and cannot be changed. This can be a problem for users, as key rotation is a useful security practice, but is not possible currently. Furthermore, as multisigs are a type of pubkey, once a multisig for an account is set, it can not be updated. This is problematic, as multisigs are often used by organizations or companies, who may need to change their set of multisig signers for internal reasons.
1818

19-
Transferring all the assets of an account to a new account with the updated pubkey is not sufficient, because some "engagements" of an account are not easily transferable. For example, in staking, to transfer bonded Atoms, an account would have to unbond all delegations and wait the three week unbonding period. Even more significantly, for validator operators, ownership over a validator is not transferrable at all, meaning that the operator key for a validator can never be updated, leading to poor operational security for validators.
19+
Transferring all the assets of an account to a new account with the updated pubkey is not sufficient, because some "engagements" of an account are not easily transferable. For example, in staking, to transfer bonded Atoms, an account would have to unbond all delegations and wait the three week unbonding period. Even more significantly, for validator operators, ownership over a validator is not transferable at all, meaning that the operator key for a validator can never be updated, leading to poor operational security for validators.
2020

2121
## Decision
2222

@@ -50,7 +50,7 @@ An account that has had its pubkey changed cannot be automatically pruned from s
5050
ctx.GasMeter().ConsumeGas(amount, "pubkey change fee")
5151
```
5252

53-
Everytime a key for an address is changed, we will store a log of this change in the state of the chain, thus creating a stack of all previous keys for an address and the time intervals for which they were active. This allows dapps and clients to easily query past keys for an account which may be useful for features such as verifying timestamped off-chain signed messages.
53+
Every time a key for an address is changed, we will store a log of this change in the state of the chain, thus creating a stack of all previous keys for an address and the time intervals for which they were active. This allows dapps and clients to easily query past keys for an account which may be useful for features such as verifying timestamped off-chain signed messages.
5454

5555
## Consequences
5656

@@ -68,7 +68,7 @@ Breaks the current assumed relationship between address and pubkeys as H(pubkey)
6868

6969
### Neutral
7070

71-
* While the purpose of this is intended to allow the owner of an account to update to a new pubkey they own, this could technically also be used to transfer ownership of an account to a new owner. For example, this could be use used to sell a staked position without unbonding or an account that has vesting tokens. However, the friction of this is very high as this would essentially have to be done as a very specific OTC trade. Furthermore, additional constraints could be added to prevent accouns with Vesting tokens to use this feature.
71+
* While the purpose of this is intended to allow the owner of an account to update to a new pubkey they own, this could technically also be used to transfer ownership of an account to a new owner. For example, this could be use used to sell a staked position without unbonding or an account that has vesting tokens. However, the friction of this is very high as this would essentially have to be done as a very specific OTC trade. Furthermore, additional constraints could be added to prevent accounts with Vesting tokens to use this feature.
7272
* Will require that PubKeys for an account are included in the genesis exports.
7373

7474
## References

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -31,13 +31,13 @@ acting as a delimiter between extensions. As the chunk hashes should be able to
3131
a delimiter to mark the end of the snapshot stream.
3232

3333
Besides, we provide `Snapshotter` and `ExtensionSnapshotter` interface for modules to implement snapshotters, which will handle both taking
34-
snapshot and the restoration. Each module could have mutiple snapshotters, and for modules with additional state, they should
34+
snapshot and the restoration. Each module could have multiple snapshotters, and for modules with additional state, they should
3535
implement `ExtensionSnapshotter` as extension snapshotters. When setting up the application, the snapshot `Manager` should call
3636
`RegisterExtensions([]ExtensionSnapshotter…)` to register all the extension snapshotters.
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 {

0 commit comments

Comments
 (0)