Skip to content

Commit 533f8f0

Browse files
tac0turtlegithub-actions[bot]
authored andcommitted
chore: Sync docs from cosmos-sdk/docs
1 parent ee7ad59 commit 533f8f0

File tree

133 files changed

+691
-656
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

133 files changed

+691
-656
lines changed

docs/build/abci/03-vote-extensions.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ ABCI 2.0 (colloquially called ABCI++) allows an application to extend a pre-comm
1111
validator process. The Cosmos SDK defines [`baseapp.ExtendVoteHandler`](https://github.com/cosmos/cosmos-sdk/blob/v0.53.0/types/abci.go#L32):
1212

1313
```go
14-
type ExtendVoteHandler func(Context, *abci.RequestExtendVote) (*abci.ResponseExtendVote, error)
14+
type ExtendVoteHandler func(Context, *abci.ExtendVoteRequest) (*abci.ExtendVoteResponse, error)
1515
```
1616

1717
An application can set this handler in `app.go` via the `baseapp.SetExtendVoteHandler`
@@ -38,7 +38,7 @@ other validators when validating their pre-commits. For a given vote extension,
3838
this process MUST be deterministic. The Cosmos SDK defines [`sdk.VerifyVoteExtensionHandler`](https://github.com/cosmos/cosmos-sdk/blob/v0.50.1/types/abci.go#L29-L31):
3939

4040
```go
41-
type VerifyVoteExtensionHandler func(Context, *abci.RequestVerifyVoteExtension) (*abci.ResponseVerifyVoteExtension, error)
41+
type VerifyVoteExtensionHandler func(Context, *abci.VerifyVoteExtensionRequest) (*abci.VerifyVoteExtensionResponse, error)
4242
```
4343

4444
An application can set this handler in `app.go` via the `baseapp.SetVerifyVoteExtensionHandler`
@@ -78,7 +78,7 @@ will be available to the application during the subsequent `FinalizeBlock` call.
7878
An example of how a pre-FinalizeBlock hook could look like is shown below:
7979

8080
```go
81-
app.SetPreBlocker(func(ctx sdk.Context, req *abci.RequestFinalizeBlock) error {
81+
app.SetPreBlocker(func(ctx sdk.Context, req *abci.FinalizeBlockRequest) error {
8282
allVEs := []VE{} // store all parsed vote extensions here
8383
for _, tx := range req.Txs {
8484
// define a custom function that tries to parse the tx as a vote extension

docs/build/architecture/PROCESS.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ ADR creation is an **iterative** process. Instead of having a high amount of com
2020

2121
3. If a _proposed_ ADR is merged, then it should clearly document outstanding issues either in ADR document notes or in a GitHub Issue.
2222

23-
4. The PR SHOULD always be merged. In the case of a faulty ADR, we still prefer to merge it with a _rejected_ status. The only time the ADR SHOULD NOT be merged is if the author abandons it.
23+
4. The PR SHOULD always be merged. In the case of a faulty ADR, we still prefer to merge it with a _rejected_ status. The only time the ADR SHOULD NOT be merged is if the author abandons it.
2424

2525
5. Merged ADRs SHOULD NOT be pruned.
2626

docs/build/architecture/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ it stands today.
3030

3131
If recorded decisions turned out to be lacking, convene a discussion, record the new decisions here, and then modify the code to match.
3232

33-
## Creating new ADR
33+
## Creating a new ADR
3434

3535
Read about the [PROCESS](./PROCESS.md).
3636

docs/build/architecture/adr-004-split-denomination-keys.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -74,7 +74,7 @@ This will result in the balances being indexed by the byte representation of
7474

7575
`DelegateCoins()` and `UndelegateCoins()` will be altered to only load each individual
7676
account balance by denomination found in the (un)delegation amount. As a result,
77-
any mutations to the account balance by will made by denomination.
77+
any mutations to the account balance will be made by denomination.
7878

7979
`SubtractCoins()` and `AddCoins()` will be altered to read & write the balances
8080
directly instead of calling `GetCoins()` / `SetCoins()` (which no longer exist).

docs/build/architecture/adr-006-secret-store-replacement.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ We are seeking solution that provides a common abstraction layer to the many dif
2121

2222
We recommend replacing the current Keybase backend based on LevelDB with [Keyring](https://github.com/99designs/keyring) by 99 designs. This application is designed to provide a common abstraction and uniform interface between many secret stores and is used by AWS Vault application by 99-designs application.
2323

24-
This appears to fulfill the requirement of protecting both key material and metadata from rouge software on a user’s machine.
24+
This appears to fulfill the requirement of protecting both key material and metadata from rogue software on a user’s machine.
2525

2626
## Status
2727

docs/build/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/build/architecture/adr-008-dCERT-group.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -151,7 +151,7 @@ they should all be severely slashed.
151151

152152
## Status
153153

154-
> Proposed
154+
Proposed
155155

156156
## Consequences
157157

docs/build/architecture/adr-010-modular-antehandler.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -142,7 +142,7 @@ type ModuleManager struct {
142142
}
143143

144144
func (mm ModuleManager) GetAnteHandler() AnteHandler {
145-
retun Chainer(mm.AnteHandlerOrder)
145+
return Chainer(mm.AnteHandlerOrder)
146146
}
147147
```
148148

docs/build/architecture/adr-012-state-accessors.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -67,7 +67,7 @@ func (Value) Set(ctx Context, o interface{}) {}
6767
// Check if a raw value exists
6868
func (Value) Exists(ctx Context) bool {}
6969

70-
// Delete a raw value value
70+
// Delete a raw value
7171
func (Value) Delete(ctx Context) {}
7272
```
7373

@@ -92,7 +92,7 @@ func (Mapping) Set(ctx Context, key []byte, o interface{}) {}
9292
// Check if a raw value exists
9393
func (Mapping) Has(ctx Context, key []byte) bool {}
9494

95-
// Delete a raw value value
95+
// Delete a raw value
9696
func (Mapping) Delete(ctx Context, key []byte) {}
9797
```
9898

docs/build/architecture/adr-014-proportional-slashing.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,7 @@ Griefing, the act of intentionally getting oneself slashed in order to make anot
4949

5050
### Implementation
5151

52-
In the slashing module, we will add two queues that will track all of the recent slash events. For double sign faults, we will define "recent slashes" as ones that have occurred within the last `unbonding period`. For liveness faults, we will define "recent slashes" as ones that have occurred withing the last `jail period`.
52+
In the slashing module, we will add two queues that will track all of the recent slash events. For double sign faults, we will define "recent slashes" as ones that have occurred within the last `unbonding period`. For liveness faults, we will define "recent slashes" as ones that have occurred within the last `jail period`.
5353

5454
```go
5555
type SlashEvent struct {

0 commit comments

Comments
 (0)