Skip to content

Commit 3731136

Browse files
donatik27Alex | Interchain Labs
andauthored
Fix typos and minor comment cleanup in ADR documentation (#24974)
Co-authored-by: Alex | Interchain Labs <[email protected]>
1 parent 3881dae commit 3731136

File tree

6 files changed

+8
-8
lines changed

6 files changed

+8
-8
lines changed

docs/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/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/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/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/architecture/adr-023-protobuf-naming.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -70,7 +70,7 @@ Further guidelines to be described below.
7070
Names should be descriptive enough to convey their meaning and distinguish
7171
them from other names.
7272

73-
Given that we are using fully-qualifed names within
73+
Given that we are using fully-qualified names within
7474
`google.protobuf.Any` as well as within gRPC query routes, we should aim to
7575
keep names concise, without going overboard. The general rule of thumb should
7676
be if a shorter name would convey more or else the same thing, pick the shorter

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -322,14 +322,14 @@ Module addresses: Should module addresses have different size to differentiate i
322322
* we will need to set a pre-image prefix for module addresse to keept them in 32-byte space: `hash(hash('module') + module_key)`
323323
* Aaron observation: we already need to deal with variable length (to not break secp256k1 keys).
324324

325-
Discssion about arithmetic hash function for ZKP
325+
Discussion about arithmetic hash function for ZKP
326326

327327
* Posseidon / Rescue
328328
* Problem: much bigger risk because we don’t know much techniques and history of crypto-analysis of arithmetic constructions. It’s still a new ground and area of active research.
329329

330330
Post quantum signature size
331331

332-
* Alan suggestion: Falcon: speed / size ration - very good.
332+
* Alan suggestion: Falcon: speed / size ratio - very good.
333333
* Aaron - should we think about it?
334334
Alan: based on early extrapolation this thing will get able to break EC cryptography in 2050 . But that’s a lot of uncertainty. But there is magic happening with recurions / linking / simulation and that can speedup the progress.
335335

0 commit comments

Comments
 (0)