Skip to content

Commit 79e9c3a

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

File tree

101 files changed

+542
-537
lines changed

Some content is hidden

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

101 files changed

+542
-537
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/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-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: 1 addition & 1 deletion
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

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 {

docs/build/architecture/adr-018-extendable-voting-period.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ There is a new `Msg` type called `MsgExtendVotingPeriod`, which can be sent by a
2727

2828
So for example, if the `MaxVotingPeriodExtension` is set to 100 Days, then anyone with 1% of voting power can extend the voting power by 1 day. If 33% of voting power has sent the message, the voting period will be extended by 33 days. Thus, if absolutely everyone chooses to extend the voting period, the absolute maximum voting period will be `MinVotingPeriod + MaxVotingPeriodExtension`.
2929

30-
This system acts as a sort of distributed coordination, where individual stakers choosing to extend or not, allows the system the guage the conentiousness/complexity of the proposal. It is extremely unlikely that many stakers will choose to extend at the exact same time, it allows stakers to view how long others have already extended thus far, to decide whether or not to extend further.
30+
This system acts as a sort of distributed coordination, where individual stakers choosing to extend or not, allows the system the gauge the contentiousness/complexity of the proposal. It is extremely unlikely that many stakers will choose to extend at the exact same time, it allows stakers to view how long others have already extended thus far, to decide whether or not to extend further.
3131

3232
### Dealing with Unbonding/Redelegation
3333

docs/build/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/build/architecture/adr-021-protobuf-query-encoding.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ This ADR is a continuation of the motivation, design, and context established in
1515
[ADR 020](./adr-020-protobuf-transaction-encoding.md), namely, we aim to design the
1616
Protocol Buffer migration path for the client-side of the Cosmos SDK.
1717

18-
This ADR continues from [ADD 020](./adr-020-protobuf-transaction-encoding.md)
18+
This ADR continues from [ADR 020](./adr-020-protobuf-transaction-encoding.md)
1919
to specify the encoding of queries.
2020

2121
## Decision
@@ -176,7 +176,7 @@ service Query {
176176
}
177177
```
178178

179-
grpc-gateway will work direcly against the GRPC proxy described above which will
179+
grpc-gateway will work directly against the GRPC proxy described above which will
180180
translate requests to ABCI queries under the hood. grpc-gateway can also
181181
generate Swagger definitions automatically.
182182

docs/build/architecture/adr-022-custom-panic-handling.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ We propose middleware-solution, which could help developers implement the follow
2323
* call panic for specific error cases;
2424

2525
It will also make `OutOfGas` case and `default` case one of the middlewares.
26-
`Default` case wraps recovery object to an error and logs it ([example middleware implementation](#Recovery-middleware)).
26+
`Default` case wraps recovery object to an error and logs it ([example middleware implementation](#recovery-middleware)).
2727

2828
Our project has a sidecar service running alongside the blockchain node (smart contracts virtual machine). It is
2929
essential that node <-> sidecar connectivity stays stable for TXs processing. So when the communication breaks we need

0 commit comments

Comments
 (0)