[Shared] Config and genesis handling refactoring idea

Makefile

@@ -394,3 +394,25 @@ gen_genesis_and_config:
 ## Clear the genesis and config files for LocalNet
 clear_genesis_and_config:
 	rm build/config/gen.*.json
+
+.PHONY: check_cross_module_imports
+## Lists cross-module imports
+check_cross_module_imports:
+	$(eval exclude_common=--exclude=Makefile --exclude-dir=shared --exclude-dir=app --exclude-dir=runtime)
+	echo "persistence:\n"
+	grep ${exclude_common} --exclude-dir=persistence -r "github.com/pokt-network/pocket/persistence" || echo "✅ OK!"
+	echo "-----------------------"
+	echo "utility:\n"
+	grep ${exclude_common} --exclude-dir=utility -r "github.com/pokt-network/pocket/utility" || echo "✅ OK!"
+	echo "-----------------------"
+	echo "consensus:\n"
+	grep ${exclude_common} --exclude-dir=consensus -r "github.com/pokt-network/pocket/consensus" || echo "✅ OK!"
+	echo "-----------------------"
+	echo "telemetry:\n"
+	grep ${exclude_common} --exclude-dir=telemetry -r "github.com/pokt-network/pocket/telemetry" || echo "✅ OK!"
+	echo "-----------------------"
+	echo "p2p:\n"
+	grep ${exclude_common} --exclude-dir=p2p -r "github.com/pokt-network/pocket/p2p" || echo "✅ OK!"
+	echo "-----------------------"
+	echo "runtime:\n"
+	grep ${exclude_common} --exclude-dir=runtime -r "github.com/pokt-network/pocket/runtime" || echo "✅ OK!"

app/client/main.go

@@ -6,6 +6,7 @@ import (
 	"log"
 	"os"
 
+	"github.com/pokt-network/pocket/runtime"
 	"github.com/pokt-network/pocket/shared/debug"
 	"github.com/pokt-network/pocket/telemetry"
 
@@ -47,24 +48,32 @@ var consensusMod modules.ConsensusModule
 
 func main() {
 	var err error
-	consensusMod, err = consensus.Create(defaultConfigPath, defaultGenesisPath, true) // TECHDEBT: extra param required for injecting private key hack for debug client
+
+	runtimeMgr := runtime.NewManagerFromFiles(defaultConfigPath, defaultGenesisPath, runtime.WithRandomPK())
+
+	consM, err := consensus.Create(runtimeMgr)
 	if err != nil {
 		log.Fatalf("[ERROR] Failed to create consensus module: %v", err.Error())
 	}
-	p2pMod, err = p2p.Create(defaultConfigPath, defaultGenesisPath, true) // TECHDEBT: extra param required for injecting private key hack for debug client
+	consensusMod = consM.(modules.ConsensusModule)
+
+	p2pM, err := p2p.Create(runtimeMgr)
 	if err != nil {
 		log.Fatalf("[ERROR] Failed to create p2p module: %v", err.Error())
 	}
+	p2pMod = p2pM.(modules.P2PModule)
+
 	// This telemetry module instance is a NOOP because the 'enable_telemetry' flag in the `cfg` above is set to false.
 	// Since this client mimics partial - networking only - functionality of a full node, some of the telemetry-related
 	// code paths are executed. To avoid those messages interfering with the telemetry data collected, a non-nil telemetry
 	// module that NOOPs (per the configs above) is injected.
-	telemetryMod, err := telemetry.Create(defaultConfigPath, defaultGenesisPath)
+	telemetryM, err := telemetry.Create(runtimeMgr)
 	if err != nil {
 		log.Fatalf("[ERROR] Failed to create NOOP telemetry module: " + err.Error())
 	}
+	telemetryMod := telemetryM.(modules.TelemetryModule)
 
-	_ = shared.CreateBusWithOptionalModules(nil, p2pMod, nil, consensusMod, telemetryMod)
+	_ = shared.CreateBusWithOptionalModules(runtimeMgr, nil, p2pMod, nil, consensusMod, telemetryMod)
 
 	p2pMod.Start()
 

build/config/main.go

@@ -6,7 +6,7 @@ import (
 	"fmt"
 	"io/ioutil"
 
-	"github.com/pokt-network/pocket/shared/test_artifacts"
+	"github.com/pokt-network/pocket/runtime/test_artifacts"
 )
 
 // Utility to generate config and genesis files

consensus/CHANGELOG.md

@@ -7,6 +7,15 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [0.0.0.6] - 2022-10-12
+
+### [#235](https://github.com/pokt-network/pocket/pull/235) Config and genesis handling
+
+- Updated to use `RuntimeMgr`
+- Made `ConsensusModule` struct unexported
+- Updated tests and mocks
+- Removed some cross-module dependencies
+
 ## [0.0.0.5] - 2022-10-06
 
 - Don't ignore the exit code of `m.Run()` in the unit tests

consensus/block.go

@@ -8,7 +8,7 @@ import (
 	"github.com/pokt-network/pocket/shared/codec"
 )
 
-func (m *ConsensusModule) commitBlock(block *typesCons.Block) error {
+func (m *consensusModule) commitBlock(block *typesCons.Block) error {
 	m.nodeLog(typesCons.CommittingBlock(m.Height, len(block.Transactions)))
 
 	// Store the block in the KV store
@@ -41,7 +41,7 @@ func (m *ConsensusModule) commitBlock(block *typesCons.Block) error {
 	return nil
 }
 
-func (m *ConsensusModule) storeBlock(block *typesCons.Block, blockProtoBytes []byte) error {
+func (m *consensusModule) storeBlock(block *typesCons.Block, blockProtoBytes []byte) error {
 	store := m.utilityContext.GetPersistenceContext()
 	// Store in KV Store
 	if err := store.StoreBlock(blockProtoBytes); err != nil {
@@ -57,7 +57,7 @@ func (m *ConsensusModule) storeBlock(block *typesCons.Block, blockProtoBytes []b
 }
 
 // TODO: Add unit tests specific to block validation
-func (m *ConsensusModule) validateBlockBasic(block *typesCons.Block) error {
+func (m *consensusModule) validateBlockBasic(block *typesCons.Block) error {
 	if block == nil && m.Step != NewRound {
 		return typesCons.ErrNilBlock
 	}
@@ -66,8 +66,8 @@ func (m *ConsensusModule) validateBlockBasic(block *typesCons.Block) error {
 		return typesCons.ErrBlockExists
 	}
 
-	if block != nil && unsafe.Sizeof(*block) > uintptr(m.consGenesis.MaxBlockBytes) {
-		return typesCons.ErrInvalidBlockSize(uint64(unsafe.Sizeof(*block)), m.consGenesis.MaxBlockBytes)
+	if block != nil && unsafe.Sizeof(*block) > uintptr(m.consGenesis.GetMaxBlockBytes()) {
+		return typesCons.ErrInvalidBlockSize(uint64(unsafe.Sizeof(*block)), m.consGenesis.GetMaxBlockBytes())
 	}
 
 	// If the current block being processed (i.e. voted on) by consensus is non nil, we need to make
@@ -84,7 +84,7 @@ func (m *ConsensusModule) validateBlockBasic(block *typesCons.Block) error {
 }
 
 // Creates a new Utility context and clears/nullifies any previous contexts if they exist
-func (m *ConsensusModule) refreshUtilityContext() error {
+func (m *consensusModule) refreshUtilityContext() error {
 	// Catch-all structure to release the previous utility context if it wasn't properly cleaned up.
 	// Ideally, this should not be called.
 	if m.utilityContext != nil {

consensus/consensus_tests/hotstuff_test.go

@@ -13,16 +13,16 @@ import (
 )
 
 func TestHotstuff4Nodes1BlockHappyPath(t *testing.T) {
+	clockMock := clock.NewMock()
 	// Test configs
 	numNodes := 4
-	configs, genesisStates := GenerateNodeConfigs(t, numNodes)
+	runtimeMgrs := GenerateNodeRuntimeMgrs(t, numNodes, clockMock)
 
-	clockMock := clock.NewMock()
 	go timeReminder(clockMock, 100*time.Millisecond)
 
 	// Create & start test pocket nodes
 	testChannel := make(modules.EventsChannel, 100)
-	pocketNodes := CreateTestConsensusPocketNodes(t, configs, genesisStates, clockMock, testChannel)
+	pocketNodes := CreateTestConsensusPocketNodes(t, runtimeMgrs, testChannel)
 	StartAllTestPocketNodes(t, pocketNodes)
 
 	// Debug message to start consensus by triggering first view change

consensus/consensus_tests/pacemaker_test.go

@@ -24,15 +24,17 @@ func TestTinyPacemakerTimeouts(t *testing.T) {
 	// Test configs
 	numNodes := 4
 	paceMakerTimeoutMsec := uint64(50) // Set a very small pacemaker timeout
-	paceMakerTimeout := 50 * timePkg.Millisecond
-	configs, genesisStates := GenerateNodeConfigs(t, numNodes)
-	for _, config := range configs {
-		config.Consensus.GetPaceMakerConfig().SetTimeoutMsec(paceMakerTimeoutMsec)
+	paceMakerTimeout := 50 * time.Millisecond
+	runtimeMgrs := GenerateNodeRuntimeMgrs(t, numNodes, clockMock)
+	for _, runtimeConfig := range runtimeMgrs {
+		if consCfg, ok := runtimeConfig.GetConfig().GetConsensusConfig().(consensus.HasPacemakerConfig); ok {
+			consCfg.GetPacemakerConfig().SetTimeoutMsec(paceMakerTimeoutMsec)
+		}
 	}
 
 	// Create & start test pocket nodes
 	testChannel := make(modules.EventsChannel, 100)
-	pocketNodes := CreateTestConsensusPocketNodes(t, configs, genesisStates, clockMock, testChannel)
+	pocketNodes := CreateTestConsensusPocketNodes(t, runtimeMgrs, testChannel)
 	StartAllTestPocketNodes(t, pocketNodes)
 
 	// Debug message to start consensus by triggering next view.
@@ -123,15 +125,15 @@ func TestTinyPacemakerTimeouts(t *testing.T) {
 }
 
 func TestPacemakerCatchupSameStepDifferentRounds(t *testing.T) {
+	clockMock := clock.NewMock()
 	numNodes := 4
-	configs, genesisStates := GenerateNodeConfigs(t, numNodes)
+	runtimeConfigs := GenerateNodeRuntimeMgrs(t, numNodes, clockMock)
 
-	clockMock := clock.NewMock()
 	timeReminder(clockMock, 100*time.Millisecond)
 
 	// Create & start test pocket nodes
 	testChannel := make(modules.EventsChannel, 100)
-	pocketNodes := CreateTestConsensusPocketNodes(t, configs, genesisStates, clockMock, testChannel)
+	pocketNodes := CreateTestConsensusPocketNodes(t, runtimeConfigs, testChannel)
 	StartAllTestPocketNodes(t, pocketNodes)
 
 	// Starting point
@@ -143,13 +145,16 @@ func TestPacemakerCatchupSameStepDifferentRounds(t *testing.T) {
 	leader := pocketNodes[leaderId]
 	leaderRound := uint64(6)
 
+	consensusPK, err := leader.GetBus().GetConsensusModule().GetPrivateKey()
+	require.NoError(t, err)
+
 	// Placeholder block
 	blockHeader := &typesCons.BlockHeader{
 		Height:            int64(testHeight),
 		Hash:              hex.EncodeToString(appHash),
 		NumTxs:            0,
 		LastBlockHash:     "",
-		ProposerAddress:   leader.Address.Bytes(),
+		ProposerAddress:   consensusPK.Address(),
 		QuorumCertificate: nil,
 	}
 	block := &typesCons.Block{