diff --git a/consensus/doc/PROTOCOL_STATE_SYNC.md b/consensus/doc/PROTOCOL_STATE_SYNC.md index 4c28a11b3..af8a76e01 100644 --- a/consensus/doc/PROTOCOL_STATE_SYNC.md +++ b/consensus/doc/PROTOCOL_STATE_SYNC.md @@ -1,7 +1,8 @@ # State Sync Protocol Design -⚠️ 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. diff --git a/consensus/e2e_tests/utils_test.go b/consensus/e2e_tests/utils_test.go index e915c94ee..a812a5fbe 100644 --- a/consensus/e2e_tests/utils_test.go +++ b/consensus/e2e_tests/utils_test.go @@ -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, diff --git a/consensus/module_consensus_debugging.go b/consensus/module_consensus_debugging.go index c1003670e..0af34ad83 100644 --- a/consensus/module_consensus_debugging.go +++ b/consensus/module_consensus_debugging.go @@ -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" diff --git a/state_machine/fsm.go b/state_machine/fsm.go index 08ab7c6a2..7950efaa6 100644 --- a/state_machine/fsm.go +++ b/state_machine/fsm.go @@ -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" diff --git a/state_machine/module.go b/state_machine/module.go index 63c682677..9a8b6b505 100644 --- a/state_machine/module.go +++ b/state_machine/module.go @@ -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"