[Consensus] State sync server to advertise blocks

.gitignore

@@ -31,9 +31,14 @@ prototype/vendor/
 # Generated Mocks (for testing)
 shared/modules/mocks/*
 !shared/modules/mocks/mocks.go
+
 p2p/types/mocks/*
 !p2p/types/mocks/mocks.go
 
+persistence/types/mocks/*
+!persistence/types/mocks/mocks.go
+
+
 # TODO(team): Does the `types` directory contain generated or raw type files?
 # types/
 

Makefile

@@ -222,13 +222,15 @@ mockgen: clean_mocks ## Use `mockgen` to generate mocks used for testing purpose
 	$(eval modules_dir = "shared/modules")
 	go generate ./${modules_dir}
 	echo "Mocks generated in ${modules_dir}/mocks"
-
-	$(eval p2p_dir = "p2p")
-	$(eval p2p_type_mocks_dir = "p2p/types/mocks")
-	find ${p2p_type_mocks_dir} -type f ! -name "mocks.go" -exec rm {} \;
-	go generate ./${p2p_dir}/...
-	echo "P2P mocks generated in ${p2p_type_mocks_dir}"
-
+
+	$(eval DIRS = p2p persistence)
+	for dir in $(DIRS); do \
+		echo "Processing $$dir mocks..."; \
+        find $$dir/types/mocks -type f ! -name "mocks.go" -exec rm {} \;; \
+        go generate ./${dir_name}/...; \
+        echo "$$dir mocks generated in $$dir/types/mocks"; \
+    done
+
 # TODO(team): Tested locally with `protoc` version `libprotoc 3.19.4`. In the near future, only the Dockerfiles will be used to compile protos.
 
 .PHONY: protogen_show

app/client/cli/debug.go

@@ -19,11 +19,15 @@ import (
 
 // TECHDEBT: Lowercase variables / constants that do not need to be exported.
 const (
-	PromptResetToGenesis         string = "ResetToGenesis"
-	PromptPrintNodeState         string = "PrintNodeState"
-	PromptTriggerNextView        string = "TriggerNextView"
-	PromptTogglePacemakerMode    string = "TogglePacemakerMode"
+	PromptResetToGenesis      string = "ResetToGenesis"
+	PromptPrintNodeState      string = "PrintNodeState"
+	PromptTriggerNextView     string = "TriggerNextView"
+	PromptTogglePacemakerMode string = "TogglePacemakerMode"
+
 	PromptShowLatestBlockInStore string = "ShowLatestBlockInStore"
+
+	PromptSendMetadataRequest string = "MetadataRequest"
+	PromptSendBlockRequest    string = "BlockRequest"
 )
 
 var (
@@ -36,6 +40,8 @@ var (
 		PromptTriggerNextView,
 		PromptTogglePacemakerMode,
 		PromptShowLatestBlockInStore,
+		PromptSendMetadataRequest,
+		PromptSendBlockRequest,
 	}
 
 	// validators holds the list of the validators at genesis time so that we can use it to create a debug address book provider.
@@ -159,6 +165,18 @@ func handleSelect(selection string) {
 			Message: nil,
 		}
 		sendDebugMessage(m)
+	case PromptSendMetadataRequest:
+		m := &messaging.DebugMessage{
+			Action:  messaging.DebugMessageAction_DEBUG_CONSENSUS_SEND_METADATA_REQ,
+			Message: nil,
+		}
+		broadcastDebugMessage(m)
+	case PromptSendBlockRequest:
+		m := &messaging.DebugMessage{
+			Action:  messaging.DebugMessageAction_DEBUG_CONSENSUS_SEND_BLOCK_REQ,
+			Message: nil,
+		}
+		broadcastDebugMessage(m)
 	default:
 		logger.Global.Error().Msg("Selection not yet implemented...")
 	}

app/client/doc/CHANGELOG.md

@@ -7,6 +7,12 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [0.0.0.11] - 2023-02-07
+
+- Added debugging init for state sync
+- SendMetadataRequest to send metadata request by all nodes to all nodes
+- SendBlockRequest to send get block request by all nodes to all nodes
+
 ## [0.0.0.10] - 2023-02-07
 
 - Added GITHUB_WIKI tags where it was missing

app/pocket/main.go

@@ -31,6 +31,7 @@ func main() {
 	if err != nil {
 		logger.Global.Fatal().Err(err).Msg("Failed to create pocket node")
 	}
+	pocketNode.GetBus().GetConsensusModule().EnableServerMode()
 
 	if err = pocketNode.Start(); err != nil {
 		logger.Global.Fatal().Err(err).Msg("Failed to start pocket node")

build/config/config1.json

@@ -8,7 +8,8 @@
       "manual": true,
       "debug_time_between_steps_msec": 1000
     },
-    "private_key": "0ca1a40ddecdab4f5b04fa0bfed1d235beaa2b8082e7554425607516f0862075dfe357de55649e6d2ce889acf15eb77e94ab3c5756fe46d3c7538d37f27f115e"
+    "private_key": "0ca1a40ddecdab4f5b04fa0bfed1d235beaa2b8082e7554425607516f0862075dfe357de55649e6d2ce889acf15eb77e94ab3c5756fe46d3c7538d37f27f115e",
+    "server_mode_enabled": true
   },
   "utility": {
     "max_mempool_transaction_bytes": 1073741824,

build/config/config2.json

@@ -8,7 +8,8 @@
       "manual": true,
       "debug_time_between_steps_msec": 1000
     },
-    "private_key": "ba81e6e56d293895b299bc495ae75d490644429a5e0028fabeb5e1871c1098e7eb2c78364525a210d994a83e02d18b4287ab81f6670cf4510ab6c9f51e296d91"
+    "private_key": "ba81e6e56d293895b299bc495ae75d490644429a5e0028fabeb5e1871c1098e7eb2c78364525a210d994a83e02d18b4287ab81f6670cf4510ab6c9f51e296d91",
+    "server_mode_enabled": true
   },
   "utility": {
     "max_mempool_transaction_bytes": 1073741824,

build/config/config3.json

@@ -8,7 +8,8 @@
       "manual": true,
       "debug_time_between_steps_msec": 1000
     },
-    "private_key": "25b385b367a827eaafcdb1003bd17a25f2ecc0d10d41f138846f52ae1015aa941041a9c76539791fef9bee5b4fcd5bf4a1a489e0790c44cbdfa776b901e13b50"
+    "private_key": "25b385b367a827eaafcdb1003bd17a25f2ecc0d10d41f138846f52ae1015aa941041a9c76539791fef9bee5b4fcd5bf4a1a489e0790c44cbdfa776b901e13b50",
+    "server_mode_enabled": true
   },
   "utility": {
     "max_mempool_transaction_bytes": 1073741824,

build/config/config4.json

@@ -8,7 +8,8 @@
       "manual": true,
       "debug_time_between_steps_msec": 1000
     },
-    "private_key": "4ff3292ff14213149446f8208942b35439cb4b2c5e819f41fb612e880b5614bdd6cea8706f6ee6672c1e013e667ec8c46231e0e7abcf97ba35d89fceb8edae45"
+    "private_key": "4ff3292ff14213149446f8208942b35439cb4b2c5e819f41fb612e880b5614bdd6cea8706f6ee6672c1e013e667ec8c46231e0e7abcf97ba35d89fceb8edae45",
+    "server_mode_enabled": true
   },
   "utility": {
     "max_mempool_transaction_bytes": 1073741824,

build/docs/CHANGELOG.md

@@ -7,6 +7,10 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [0.0.0.12] - 2023-02-07
+
+- Updated all `config*.json` files with new `server_mode_enabled` value
+
 ## [0.0.0.11] - 2023-02-07
 
 - Added GITHUB_WIKI tags where it was missing

consensus/debugging.go

@@ -2,6 +2,7 @@ package consensus
 
 import (
 	typesCons "github.com/pokt-network/pocket/consensus/types"
+	cryptoPocket "github.com/pokt-network/pocket/shared/crypto"
 	"github.com/pokt-network/pocket/shared/messaging"
 )
 
@@ -20,6 +21,10 @@ func (m *consensusModule) HandleDebugMessage(debugMessage *messaging.DebugMessag
 		m.triggerNextView(debugMessage)
 	case messaging.DebugMessageAction_DEBUG_CONSENSUS_TOGGLE_PACE_MAKER_MODE:
 		m.togglePacemakerManualMode(debugMessage)
+	case messaging.DebugMessageAction_DEBUG_CONSENSUS_SEND_BLOCK_REQ:
+		m.sendGetBlockStateSyncMessage(debugMessage)
+	case messaging.DebugMessageAction_DEBUG_CONSENSUS_SEND_METADATA_REQ:
+		m.sendGetMetadataStateSyncMessage(debugMessage)
 	default:
 		m.logger.Debug().Msgf("Debug message: %s", debugMessage.Message)
 	}
@@ -95,3 +100,59 @@ func (m *consensusModule) togglePacemakerManualMode(_ *messaging.DebugMessage) {
 	}
 	m.paceMaker.SetManualMode(newMode)
 }
+
+// requests current block from all validators
+func (m *consensusModule) sendGetBlockStateSyncMessage(_ *messaging.DebugMessage) {
+	currentHeight := m.CurrentHeight()
+	requestHeight := currentHeight - 1
+	peerAddress := m.GetNodeAddress()
+
+	stateSyncGetBlockMessage := &typesCons.StateSyncMessage{
+		Message: &typesCons.StateSyncMessage_GetBlockReq{
+			GetBlockReq: &typesCons.GetBlockRequest{
+				PeerAddress: peerAddress,
+				Height:      requestHeight,
+			},
+		},
+	}
+
+	validators, err := m.getValidatorsAtHeight(currentHeight)
+	if err != nil {
+		m.logger.Debug().Msgf(typesCons.ErrPersistenceGetAllValidators.Error(), err)
+	}
+
+	for _, val := range validators {
+		valAddress := cryptoPocket.AddressFromString(val.GetAddress())
+		if err := m.stateSync.SendStateSyncMessage(stateSyncGetBlockMessage, valAddress, requestHeight); err != nil {
+			m.logger.Debug().Msgf(typesCons.SendingStateSyncMessage(valAddress, requestHeight), err)
+		}
+	}
+}
+
+// requests metadata from all validators
+func (m *consensusModule) sendGetMetadataStateSyncMessage(_ *messaging.DebugMessage) {
+	currentHeight := m.CurrentHeight()
+	requestHeight := currentHeight - 1
+	peerAddress := m.GetNodeAddress()
+
+	stateSyncMetaDataReqMessage := &typesCons.StateSyncMessage{
+		Message: &typesCons.StateSyncMessage_MetadataReq{
+			MetadataReq: &typesCons.StateSyncMetadataRequest{
+				PeerAddress: peerAddress,
+			},
+		},
+	}
+
+	validators, err := m.getValidatorsAtHeight(currentHeight)
+	if err != nil {
+		m.logger.Debug().Msgf(typesCons.ErrPersistenceGetAllValidators.Error(), err)
+	}
+
+	for _, val := range validators {
+		valAddress := cryptoPocket.AddressFromString(val.GetAddress())
+		if err := m.stateSync.SendStateSyncMessage(stateSyncMetaDataReqMessage, valAddress, requestHeight); err != nil {
+			m.logger.Debug().Msgf(typesCons.SendingStateSyncMessage(valAddress, requestHeight), err)
+		}
+	}
+
+}

consensus/doc/CHANGELOG.md

@@ -7,8 +7,14 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
-## [0.0.0.26] - 2023-02-06
+## [0.0.0.27] - 2023-02-07
+- Add `state_sync` submodule, with `state_sync` struct
+- Implement state sync server to advertise blocks and metadata
+- Create new `state_sync_handler.go` source file that handles `StateSyncMessage`s sent to the `Consensus` module
+- Add two new tests in `state_sync_test.go`:`TestStateSyncServerGetMetaDataReq` and `TestStateSyncServerGetBlock`
+- Update `TestHotstuff4Nodes1BlockHappyPath` test to also retrieve the committed block
 
+## [0.0.0.26] - 2023-02-06
 - Address legacy linter errors from `golangci-lint`
 
 ## [0.0.0.25] - 2023-02-04

consensus/e2e_tests/hotstuff_test.go

@@ -8,8 +8,10 @@ import (
 	"github.com/benbjohnson/clock"
 	"github.com/pokt-network/pocket/consensus"
 	typesCons "github.com/pokt-network/pocket/consensus/types"
+	"github.com/pokt-network/pocket/shared/codec"
 	"github.com/pokt-network/pocket/shared/modules"
 	"github.com/stretchr/testify/require"
+	"google.golang.org/protobuf/types/known/anypb"
 )
 
 func TestHotstuff4Nodes1BlockHappyPath(t *testing.T) {
@@ -188,6 +190,48 @@ func TestHotstuff4Nodes1BlockHappyPath(t *testing.T) {
 			nodeState)
 		require.Equal(t, typesCons.NodeId(0), nodeState.LeaderId, "Leader should be empty")
 	}
+
+	// Test state synchronisation's get block functionality
+	// At this stage, first round is finished, get block request for block height 1 must return non-nill block
+	serverNode := pocketNodes[1]
+
+	// We choose node 2 as the requester node.
+	requesterNode := pocketNodes[2]
+	requesterNodePeerAddress := requesterNode.GetBus().GetConsensusModule().GetNodeAddress()
+
+	stateSyncGetBlockReq := typesCons.GetBlockRequest{
+		PeerAddress: requesterNodePeerAddress,
+		Height:      1,
+	}
+
+	stateSyncGetBlockMessage := &typesCons.StateSyncMessage{
+		Message: &typesCons.StateSyncMessage_GetBlockReq{
+			GetBlockReq: &stateSyncGetBlockReq,
+		},
+	}
+
+	anyProto, err := anypb.New(stateSyncGetBlockMessage)
+	require.NoError(t, err)
+
+	// Send get block request to the server node
+	P2PSend(t, serverNode, anyProto)
+
+	// Start waiting for the get block request on server node,
+	numExpectedMsgs := 1
+	errMsg := "StateSync Get Block Request Message"
+	receivedMsg, err := WaitForNetworkStateSyncEvents(t, clockMock, eventsChannel, errMsg, numExpectedMsgs, 250, false)
+	require.NoError(t, err)
+
+	msg, err := codec.GetCodec().FromAny(receivedMsg[0])
+	require.NoError(t, err)
+
+	stateSyncGetBlockResMessage, ok := msg.(*typesCons.StateSyncMessage)
+	require.True(t, ok)
+
+	getBlockRes := stateSyncGetBlockResMessage.GetGetBlockRes()
+	require.NotEmpty(t, getBlockRes)
+
+	require.Equal(t, uint64(1), getBlockRes.Block.GetBlockHeader().Height)
 }
 
 // TODO: Implement these tests and use them as a starting point for new ones. Consider using ChatGPT to help you out :)