cometbft · calciumbe · Dec 23, 2024
@@ -315,7 +315,7 @@ $(BUILDDIR):
 
 #? help: Get more info on make commands.
 help: Makefile
-	@echo " Choose a command run in comebft:"
+	@echo " Choose a command run in cometbft:"
 	@sed -n 's/^#?//p' $< | column -t -s ':' |  sort | sed -e 's/^/ /'
 .PHONY: help
 

@@ -36,7 +36,7 @@ The minimum Go version has been bumped to [v1.23][go123].
 ### Upgrading Guide (`v0.38` -> `v1.0`)
 
 Starting with the `v1.0` release, instead of providing detailed information
-about new features, changes, and other relevant details for upgrading to ComeBFT `v1.0` in this document,
+about new features, changes, and other relevant details for upgrading to CometBFT `v1.0` in this document,
 we have created a comprehensive upgrading guide from the previous `v0.38.x` release line to this new `v1.0` release.
 This guide can be utilized as a valuable resource when upgrading to the CometBFT `v1.0` release.
 

@@ -112,7 +112,7 @@ transferBalance100FinalizeBlock11          1
 transferNodeNothingFinalizeBlock11         1
 ---- event2 ------
 transferSenderTomFinalizeBlock12           1
-transferRecepientAliceFinalizeBlock12      1
+transferRecipientAliceFinalizeBlock12      1
 transferBalance200FinalizeBlock12          1
 transferNodeNothingFinalizeBlock12         1
 

@@ -303,7 +303,7 @@ func (sc *schedule) popSchedule(maxRequest int) []scBlockRequestMessage {
 
 type scPeer struct {
 	peerID               p2p.ID
-	numOustandingRequest int
+	numOutstandingRequest int
 	lastTouched          time.Time
 	monitor              flow.Monitor
 }

@@ -140,7 +140,7 @@ type ProofOfLockChange struct {
 
 This can be either evidence of +2/3 PREVOTES or PRECOMMITS (either warrants the honest node the right to vote) and is valid, among other checks, so long as the PRECOMMIT vote of the node in V2 came after all the votes in the `ProofOfLockChange` i.e. it received +2/3 votes for a block and then voted for that block thereafter (F is unable to prove this).
 
-In the event that an honest node receives `PotentialAmnesiaEvidence` it will first `ValidateBasic()` and `Verify()` it and then will check if it is among the suspected nodes in the evidence. If so, it will retrieve the `ProofOfLockChange` and combine it with `PotentialAmensiaEvidence` to form `AmensiaEvidence`. All honest nodes that are part of the indicted group will have a time, measured in blocks, equal to `ProofTrialPeriod`, the aforementioned evidence parameter, to gossip their `AmnesiaEvidence` with their `ProofOfLockChange`
+In the event that an honest node receives `PotentialAmnesiaEvidence` it will first `ValidateBasic()` and `Verify()` it and then will check if it is among the suspected nodes in the evidence. If so, it will retrieve the `ProofOfLockChange` and combine it with `PotentialAmnesiaEvidence` to form `AmnesiaEvidence`. All honest nodes that are part of the indicted group will have a time, measured in blocks, equal to `ProofTrialPeriod`, the aforementioned evidence parameter, to gossip their `AmnesiaEvidence` with their `ProofOfLockChange`
 
 ```golang
 type AmnesiaEvidence struct {
@@ -153,7 +153,7 @@ If the node is not required to submit any proof than it will simply broadcast th
 
 If a node receives `AmnesiaEvidence` that contains a valid `ProofOfClockChange` it will add it to the evidence store and replace any PotentialAmnesiaEvidence of the same height and round. At this stage, an amnesia evidence with polc, it is ready to be submitted to the chin. If a node receives `AmnesiaEvidence` with an empty polc it will ignore it as each honest node will conduct their own trial period to be sure that time was given for any other honest nodes to respond.
 
-There can only be one `AmnesiaEvidence` and one `PotentialAmneisaEvidence` stored for each attack (i.e. for each height).
+There can only be one `AmnesiaEvidence` and one `PotentialAmnesiaEvidence` stored for each attack (i.e. for each height).
 
 When, `state.LastBlockHeight > PotentialAmnesiaEvidence.timestamp + ProofTrialPeriod`, nodes will upgrade the corresponding `PotentialAmnesiaEvidence` and attach an empty `ProofOfLockChange`. Then honest validators of the current validator set can begin proposing the block that contains the `AmnesiaEvidence`.
 

@@ -92,7 +92,7 @@ When a hard fork happens, a new chain can start from a higher initial height by
 
 > Notes:
 
->> If a Height `"0"` is specified in `initial_heigth`, then CometBFT during the genesis file validation, will change the
+>> If a Height `"0"` is specified in `initial_height`, then CometBFT during the genesis file validation, will change the
 > initial height parameter to `"1"`.
 
 >> Note: A height in CometBFT is an `int64` integer therefore its maximum value is `9223372036854775807`

@@ -269,7 +269,7 @@ Thus, the final decision should be left to the application after testing and und
 
 As the feature is experimental, we do not provide a way to convert the database back into the current format if it is initialized with the new layout. 
 
-The two layouts are not interchange-able, once one is used, a node cannot switch to the other. The version to be used is set in the `config.toml` and defaults to `v1` - the current layout. Once the layout is set, it is written back to the database with `version` as the key. When a node boots up and loads the database initially, if this flag is set, it takes precedense over any configuration file. 
+The two layouts are not interchange-able, once one is used, a node cannot switch to the other. The version to be used is set in the `config.toml` and defaults to `v1` - the current layout. Once the layout is set, it is written back to the database with `version` as the key. When a node boots up and loads the database initially, if this flag is set, it takes precedence over any configuration file. 
 
 The support for both layouts will allow users to benchmark their applications. If at any point we get clear indications that one layout is better than the other, we will gladly drop support for one of them and provide users with a way to migrate their databases gracefully. 
 

@@ -244,7 +244,7 @@ Finally, if there are no banned users found in the transactions, it accepts the
 
 *Tip: The function `ProcessProposal` is used by state replication to indicate to the application to process the tx.
 The application can process a tx in accordance to the logic defined by the application. Although the application can
-perform 'optimisitic execution', the application is not mandated to do so.*
+perform 'optimistic execution', the application is not mandated to do so.*
 
 Note: You will learn about different packages and functions like `isBanTx` in the upcoming sections. In this section
 you will learn about `app.go` file only.

@@ -130,7 +130,7 @@ func (bA *BitArray) copyBits(bits int) *BitArray {
 }
 
 // Or returns a bit array resulting from a bitwise OR of the two bit arrays.
-// If the two bit-arrys have different lengths, Or right-pads the smaller of the two bit-arrays with zeroes.
+// If the two bit-arrays have different lengths, Or right-pads the smaller of the two bit-arrays with zeroes.
 // Thus the size of the return value is the maximum of the two provided bit arrays.
 func (bA *BitArray) Or(o *BitArray) *BitArray {
 	if bA == nil && o == nil {
@@ -155,7 +155,7 @@ func (bA *BitArray) Or(o *BitArray) *BitArray {
 }
 
 // And returns a bit array resulting from a bitwise AND of the two bit arrays.
-// If the two bit-arrys have different lengths, this truncates the larger of the two bit-arrays from the right.
+// If the two bit-arrays have different lengths, this truncates the larger of the two bit-arrays from the right.
 // Thus the size of the return value is the minimum of the two provided bit arrays.
 func (bA *BitArray) And(o *BitArray) *BitArray {
 	if bA == nil || o == nil {

@@ -1408,7 +1408,7 @@ func (cs *State) defaultDoPrevote(height int64, round int32) {
 		25: else
 		26:   broadcast <PREVOTE, h_p, round_p, nil>
 
-		Here, cs.Proposal.POLRound corresponds to the -1 in the rule of the pseude-code (line 22).
+		Here, cs.Proposal.POLRound corresponds to the -1 in the rule of the pseudo-code (line 22).
 		This means that the proposer is producing a new proposal that has not previously
 		seen a 2/3 majority by the network.
 

@@ -552,7 +552,7 @@ func TestSwitchReconnectsToOutboundPersistentPeer(t *testing.T) {
 	conf.TestDialFail = true // will trigger a reconnect
 	err = sw.addOutboundPeerWithConfig(rp.Addr(), conf)
 	require.Error(t, err)
-	// DialPeerWithAddres - sw.peerConfig resets the dialer
+	// DialPeerWithAddress - sw.peerConfig resets the dialer
 	waitUntilSwitchHasAtLeastNPeers(sw, 2)
 	assert.Equal(t, 2, sw.Peers().Size())
 }

@@ -9,7 +9,7 @@
 - this specification focuses on safety, so timeouts are modelled with
    with non-determinism
 
-- the proposer function is non-determinstic, no fairness is assumed
+- the proposer function is non-deterministic, no fairness is assumed
 
 - the messages by the faulty processes are injected right in the initial states
 

@@ -8,7 +8,7 @@
  - this specification focuses on safety, so timeouts are modelled
    with non-determinism
 
- - the proposer function is non-determinstic, no fairness is assumed
+ - the proposer function is non-deterministic, no fairness is assumed
 
  - the messages by the faulty processes are injected right in the initial states
 

@@ -1105,7 +1105,7 @@ func Main (primary PeerID, lightStore LightStore, targetHeight Height)
             // maintain state
    // we do that whether VerifyToTarget was successful or not
             for i, s range auxLS {
-                lighStore.Update(s,s.State)
+                lightStore.Update(s,s.State)
             }
             return (lightStore, res2)
         }

@@ -30,7 +30,7 @@ const (
 	tagKeySeparator          = "/"
 	tagKeySeparatorRune      = '/'
 	eventSeqSeparator        = "$es$"
-	eventSeqSeperatorRuneAt0 = '$'
+	eventSeqSeparatorRuneAt0 = '$'
 )
 
 var (
@@ -1043,7 +1043,7 @@ func extractEventSeqFromKey(key []byte) string {
 	}
 
 	for ; endPos < len(key); endPos++ {
-		if key[endPos] == eventSeqSeperatorRuneAt0 {
+		if key[endPos] == eventSeqSeparatorRuneAt0 {
 			eventSeq := string(key[endPos:])
 			if eventSeq, ok := strings.CutPrefix(eventSeq, eventSeqSeparator); ok {
 				return eventSeq

@@ -47,7 +47,7 @@ func newParser(l *lexer.Lexer) *parser {
 }
 
 // Parse returns the BSR set containing the parse forest.
-// If the parse was successfull []*Error is nil
+// If the parse was successful []*Error is nil
 func Parse(l *lexer.Lexer) (*bsr.Set, []*Error) {
 	return newParser(l).parse()
 }
@@ -2066,7 +2066,7 @@ type Error struct {
 	// Index of token that caused the error.
 	cI int
 
-	// Grammar slot at which the error occured.
+	// Grammar slot at which the error occurred.
 	Slot slot.Label
 
 	// The token at which the error occurred.