Skip to content

Commit

Permalink
Updated a few comments
Browse files Browse the repository at this point in the history
  • Loading branch information
Olshansk committed Aug 3, 2023
1 parent 46cd8e5 commit 819f990
Show file tree
Hide file tree
Showing 5 changed files with 8 additions and 2 deletions.
3 changes: 2 additions & 1 deletion consensus/doc/PROTOCOL_STATE_SYNC.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,8 @@
# State Sync Protocol Design <!-- omit in toc -->

⚠️ IMPORTANT NOTES TO THE (last updated on 06/08/2023):
⚠️ IMPORTANT NOTES TO THE (last updated on 08/03/2023):

- TECHDEBT(#821): Once the FSM is remove, state sync will look completely different
- State Sync implementation is a WIP and has taken several different shapes.
- This document is out of date and needs to be updated to reflect the latest implementation. This will be done once a functional implementation is in place.
- This document makes some assumption of P2P implementation details, so please see [p2p](../../p2p/README.md) for the latest source of truth.
Expand Down
1 change: 1 addition & 0 deletions consensus/e2e_tests/utils_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -77,6 +77,7 @@ func generateNodeRuntimeMgrs(t *testing.T, validatorCount int, clockMgr clock.Cl
return runtimeMgrs
}

// TECHDEBT: Try to avoid exposing `modules.EventsChannel` outside the `shared` package and adding the appropriate mocks to the bus.
func createTestConsensusPocketNodes(
t *testing.T,
buses []modules.Bus,
Expand Down
2 changes: 1 addition & 1 deletion consensus/module_consensus_debugging.go
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
package consensus

// All the code below is used for debugging & testing purposes only and should not be used in prod.
// TODO: Add debug/test tags to avoid accidental production usage.
// TECHDEBT: Add debug/test tags to avoid accidental production usage.

import (
typesCons "github.com/pokt-network/pocket/consensus/types"
Expand Down
2 changes: 2 additions & 0 deletions state_machine/fsm.go
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
package state_machine

// TECHDEBT(#821): Remove the dependency of state sync on FSM, as well as the FSM in general.

import (
"github.com/looplab/fsm"
coreTypes "github.com/pokt-network/pocket/shared/core/types"
Expand Down
2 changes: 2 additions & 0 deletions state_machine/module.go
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
package state_machine

// TECHDEBT(#821): Remove the dependency of state sync on FSM, as well as the FSM in general.

import (
"context"

Expand Down

0 comments on commit 819f990

Please sign in to comment.