Skip to content

Commit b28d312

Browse files
authoredNov 12, 2024··
fix: typos in documentation files (#1525)
**Description** This pull request contains changes to improve clarity, correctness and structure. Please review the changes and let me know if any additional changes are needed. 1. Corrected "compatability" → "compatibility" 2. Corrected "transacton" → "transaction" 3. Corrected "double-sigining" → "double-signing" 4. Corrected "entires" → "entries" 5. Corrected "empthHash" → "emptyHash" 6. Corrected "reponse" → "response" **PR checklist** - [x] Tests written/updated - [ ] Changelog entry added in `.changelog` (we use [unclog](https://github.com/informalsystems/unclog) to manage our changelog) - [x] Updated relevant documentation (`docs/` or `spec/`) and code comments
1 parent 746a1e1 commit b28d312

File tree

4 files changed

+6
-6
lines changed

4 files changed

+6
-6
lines changed
 

‎mempool/cat/spec.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ message WantTx {
3838

3939
Both `SeenTx` and `WantTx` contain the sha256 hash of the raw transaction bytes. `SeenTx` also contains an optional `p2p.ID` that corresponds to the peer that the node recieved the tx from. The only validation for both is that the byte slice of the `tx_key` MUST have a length of 32.
4040

41-
Both messages are sent across a new channel with the ID: `byte(0x31)`. This enables cross compatability as discussed in greater detail below.
41+
Both messages are sent across a new channel with the ID: `byte(0x31)`. This enables cross compatibility as discussed in greater detail below.
4242

4343
> **Note:**
4444
> The term `SeenTx` is used over the more common `HasTx` because the transaction pool contains sophisticated eviction logic. TTL's, higher priority transactions and reCheckTx may mean that a transaction pool *had* a transaction but does not have it any more. Semantically it's more appropriate to use `SeenTx` to imply not the presence of a transaction but that the node has seen it and dealt with it accordingly.
@@ -53,7 +53,7 @@ A node in the protocol has two distinct modes: "broadcast" and "request/response
5353
A `SeenTx` is broadcasted to ALL nodes upon receiving a "new" transaction from a peer. The transaction pool does not need to track every unique inbound transaction, therefore "new" is identified as:
5454

5555
- The node does not currently have the transaction
56-
- The node did not recently reject the transacton or has recently seen the same transaction committed (subject to the size of the cache)
56+
- The node did not recently reject the transaction or has recently seen the same transaction committed (subject to the size of the cache)
5757
- The node did not recently evict the transaction (subject to the size of the cache)
5858

5959
Given this criteria, it is feasible, yet unlikely that a node receives two `SeenTx` messages from the same peer for the same transaction.

‎spec/consensus/signing.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55

66
Here we specify the rules for validating a proposal and vote before signing.
77
First we include some general notes on validating data structures common to both types.
8-
We then provide specific validation rules for each. Finally, we include validation rules to prevent double-sigining.
8+
We then provide specific validation rules for each. Finally, we include validation rules to prevent double-signing.
99

1010
## SignedMsgType
1111

‎spec/core/encoding.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ For details on varints, see the [protobuf
1919
spec](https://developers.google.com/protocol-buffers/docs/encoding#varints).
2020

2121
For example, the byte-array `[0xA, 0xB]` would be encoded as `0x020A0B`,
22-
while a byte-array containing 300 entires beginning with `[0xA, 0xB, ...]` would
22+
while a byte-array containing 300 entries beginning with `[0xA, 0xB, ...]` would
2323
be encoded as `0xAC020A0B...` where `0xAC02` is the UVarint encoding of 300.
2424

2525
## Hashing
@@ -171,7 +171,7 @@ func getSplitPoint(k int) { ... }
171171
func MerkleRoot(items [][]byte) []byte{
172172
switch len(items) {
173173
case 0:
174-
return empthHash()
174+
return emptyHash()
175175
case 1:
176176
return leafHash(items[0])
177177
default:

‎spec/p2p/v0.34/pex.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -106,6 +106,6 @@ A node receives two type of messages as part of the PEX protocol:
106106

107107
- `PexRequest`: a request for addresses received from a peer, handled as
108108
described [here](./pex-protocol.md#providing-addresses)
109-
- `PexAddrs`: a list of addresses received from a peer, as a reponse to a PEX
109+
- `PexAddrs`: a list of addresses received from a peer, as a response to a PEX
110110
request sent by the node, as described [here](./pex-protocol.md#responses)
111111

0 commit comments

Comments
 (0)
Please sign in to comment.