[Core] Consolidate all node configurations into a new configs package - (Issue #396)

Makefile

@@ -279,10 +279,7 @@ protogen_local: go_protoc-go-inject-tag
 	protoc --go_opt=paths=source_relative  -I=./utility/types/proto       --go_out=./utility/types      	./utility/types/proto/*.proto       --experimental_allow_proto3_optional
 	protoc --go_opt=paths=source_relative  -I=./consensus/types/proto     --go_out=./consensus/types    	./consensus/types/proto/*.proto     --experimental_allow_proto3_optional
 	protoc --go_opt=paths=source_relative  -I=./p2p/raintree/types/proto  --go_out=./p2p/types          	./p2p/raintree/types/proto/*.proto  --experimental_allow_proto3_optional
-	protoc --go_opt=paths=source_relative  -I=./p2p/types/proto           --go_out=./p2p/types          	./p2p/types/proto/*.proto           --experimental_allow_proto3_optional
-	protoc --go_opt=paths=source_relative  -I=./telemetry/proto           --go_out=./telemetry          	./telemetry/proto/*.proto           --experimental_allow_proto3_optional
-	protoc --go_opt=paths=source_relative  -I=./logger/proto              --go_out=./logger             	./logger/proto/*.proto              --experimental_allow_proto3_optional
-	protoc --go_opt=paths=source_relative  -I=./rpc/types/proto 		  --go_out=./rpc/types          	./rpc/types/proto/*.proto           --experimental_allow_proto3_optional
+	protoc --go_opt=paths=source_relative  -I=./runtime/configs/proto     --go_out=./runtime/configs        ./runtime/configs/proto/*.proto     --experimental_allow_proto3_optional
 	echo "View generated proto files by running: make protogen_show"
 
 .PHONY: protogen_docker_m1

consensus/consensus_tests/pacemaker_test.go

@@ -26,9 +26,8 @@ func TestTinyPacemakerTimeouts(t *testing.T) {
 	paceMakerTimeout := 50 * time.Millisecond
 	runtimeMgrs := GenerateNodeRuntimeMgrs(t, numValidators, clockMock)
 	for _, runtimeConfig := range runtimeMgrs {
-		if consCfg, ok := runtimeConfig.GetConfig().GetConsensusConfig().(consensus.HasPacemakerConfig); ok {
-			consCfg.GetPacemakerConfig().SetTimeoutMsec(paceMakerTimeoutMsec)
-		}
+		consCfg := runtimeConfig.GetConfig().Consensus.PacemakerConfig
+		consCfg.TimeoutMsec = paceMakerTimeoutMsec
 	}
 
 	// Create & start test pocket nodes

consensus/consensus_tests/utils_test.go

@@ -17,6 +17,7 @@ import (
 	"github.com/pokt-network/pocket/consensus"
 	typesCons "github.com/pokt-network/pocket/consensus/types"
 	"github.com/pokt-network/pocket/runtime"
+	"github.com/pokt-network/pocket/runtime/configs"
 	"github.com/pokt-network/pocket/runtime/test_artifacts"
 	"github.com/pokt-network/pocket/shared"
 	"github.com/pokt-network/pocket/shared/codec"
@@ -66,17 +67,17 @@ func GenerateNodeRuntimeMgrs(_ *testing.T, validatorCount int, clockMgr clock.Cl
 	runtimeMgrs := make([]runtime.Manager, validatorCount)
 	var validatorKeys []string
 	genesisState, validatorKeys := test_artifacts.NewGenesisState(validatorCount, 1, 1, 1)
-	configs := test_artifacts.NewDefaultConfigs(validatorKeys)
-	for i, config := range configs {
-		runtime.WithConsensusConfig(&typesCons.ConsensusConfig{
-			PrivateKey:      config.GetBaseConfig().GetPrivateKey(),
+	cfgs := test_artifacts.NewDefaultConfigs(validatorKeys)
+	for i, config := range cfgs {
+		config.Consensus = &configs.ConsensusConfig{
+			PrivateKey:      config.PrivateKey,
 			MaxMempoolBytes: 500000000,
-			PacemakerConfig: &typesCons.PacemakerConfig{
+			PacemakerConfig: &configs.PacemakerConfig{
 				TimeoutMsec:               5000,
 				Manual:                    false,
 				DebugTimeBetweenStepsMsec: 0,
 			},
-		})(config)
+		}
 		runtimeMgrs[i] = *runtime.NewManager(config, genesisState, runtime.WithClock(clockMgr))
 	}
 	return runtimeMgrs
@@ -91,9 +92,9 @@ func CreateTestConsensusPocketNodes(
 	// TODO(design): The order here is important in order for NodeId to be set correctly below.
 	// This logic will need to change once proper leader election is implemented.
 	sort.Slice(runtimeMgrs, func(i, j int) bool {
-		pk, err := cryptoPocket.NewPrivateKey(runtimeMgrs[i].GetConfig().GetBaseConfig().GetPrivateKey())
+		pk, err := cryptoPocket.NewPrivateKey(runtimeMgrs[i].GetConfig().PrivateKey)
 		require.NoError(t, err)
-		pk2, err := cryptoPocket.NewPrivateKey(runtimeMgrs[j].GetConfig().GetBaseConfig().GetPrivateKey())
+		pk2, err := cryptoPocket.NewPrivateKey(runtimeMgrs[j].GetConfig().PrivateKey)
 		require.NoError(t, err)
 		return pk.Address().String() < pk2.Address().String()
 	})
@@ -114,9 +115,9 @@ func CreateTestConsensusPocketNodesNew(
 	// TODO(design): The order here is important in order for NodeId to be set correctly below.
 	// This logic will need to change once proper leader election is implemented.
 	sort.Slice(runtimeMgrs, func(i, j int) bool {
-		pk, err := cryptoPocket.NewPrivateKey(runtimeMgrs[i].GetConfig().GetBaseConfig().GetPrivateKey())
+		pk, err := cryptoPocket.NewPrivateKey(runtimeMgrs[i].GetConfig().PrivateKey)
 		require.NoError(t, err)
-		pk2, err := cryptoPocket.NewPrivateKey(runtimeMgrs[j].GetConfig().GetBaseConfig().GetPrivateKey())
+		pk2, err := cryptoPocket.NewPrivateKey(runtimeMgrs[j].GetConfig().PrivateKey)
 		require.NoError(t, err)
 		return pk.Address().String() < pk2.Address().String()
 	})
@@ -149,7 +150,7 @@ func CreateTestConsensusPocketNode(
 
 	require.NoError(t, err)
 
-	pk, err := cryptoPocket.NewPrivateKey(runtimeMgr.GetConfig().GetBaseConfig().GetPrivateKey())
+	pk, err := cryptoPocket.NewPrivateKey(runtimeMgr.GetConfig().PrivateKey)
 	require.NoError(t, err)
 
 	pocketNode := shared.NewNodeWithP2PAddress(pk.Address())

consensus/hotstuff_leader.go

@@ -321,7 +321,7 @@ func (m *consensusModule) validatePartialSignature(msg *typesCons.HotstuffMessag
 //	and does not recursively determine the size of all the underlying elements
 //	Add proper tests and implementation once the mempool is implemented.
 func (m *consensusModule) tempIndexHotstuffMessage(msg *typesCons.HotstuffMessage) {
-	if m.consCfg.GetMaxMempoolBytes() < uint64(unsafe.Sizeof(m.messagePool)) {
+	if m.consCfg.MaxMempoolBytes < uint64(unsafe.Sizeof(m.messagePool)) {
 		m.nodeLogError(typesCons.DisregardHotstuffMessage, typesCons.ErrConsensusMempoolFull)
 		return
 	}

consensus/module.go

@@ -9,6 +9,7 @@ import (
 	"github.com/pokt-network/pocket/consensus/leader_election"
 	consensusTelemetry "github.com/pokt-network/pocket/consensus/telemetry"
 	typesCons "github.com/pokt-network/pocket/consensus/types"
+	"github.com/pokt-network/pocket/runtime/configs"
 	"github.com/pokt-network/pocket/shared/codec"
 	cryptoPocket "github.com/pokt-network/pocket/shared/crypto"
 	"github.com/pokt-network/pocket/shared/modules"
@@ -21,8 +22,8 @@ const (
 )
 
 var (
-	_ modules.ConsensusModule       = &consensusModule{}
-	_ modules.ConsensusConfig       = &typesCons.ConsensusConfig{}
+	_ modules.ConsensusModule = &consensusModule{}
+	// _ modules.ConsensusConfig       = &typesCons.ConsensusConfig{}
 	_ modules.ConsensusGenesisState = &typesCons.ConsensusGenesisState{}
 	_ ConsensusDebugModule          = &consensusModule{}
 )
@@ -31,7 +32,7 @@ type consensusModule struct {
 	bus        modules.Bus
 	privateKey cryptoPocket.Ed25519PrivateKey
 
-	consCfg     modules.ConsensusConfig
+	consCfg     *configs.ConsensusConfig
 	consGenesis modules.ConsensusGenesisState
 
 	// m is a mutex used to control synchronization when multiple goroutines are accessing the struct and its fields / properties.
@@ -117,11 +118,7 @@ func Create(runtimeMgr modules.RuntimeMgr) (modules.Module, error) {
 func (*consensusModule) Create(runtimeMgr modules.RuntimeMgr) (modules.Module, error) {
 	var m *consensusModule
 
-	cfg := runtimeMgr.GetConfig()
-	if err := m.ValidateConfig(cfg); err != nil {
-		return nil, fmt.Errorf("config validation failed: %w", err)
-	}
-	consensusCfg := cfg.GetConsensusConfig()
+	consensusCfg := runtimeMgr.GetConfig().Consensus
 
 	genesis := runtimeMgr.GetGenesis()
 	if err := m.ValidateGenesis(genesis); err != nil {
@@ -142,7 +139,7 @@ func (*consensusModule) Create(runtimeMgr modules.RuntimeMgr) (modules.Module, e
 
 	valMap := typesCons.ActorListToValidatorMap(consensusGenesis.GetVals())
 
-	privateKey, err := cryptoPocket.NewPrivateKey(consensusCfg.GetPrivateKey())
+	privateKey, err := cryptoPocket.NewPrivateKey(consensusCfg.PrivateKey)
 	if err != nil {
 		return nil, err
 	}
@@ -155,7 +152,7 @@ func (*consensusModule) Create(runtimeMgr modules.RuntimeMgr) (modules.Module, e
 		bus: nil,
 
 		privateKey:  privateKey.(cryptoPocket.Ed25519PrivateKey),
-		consCfg:     cfg.GetConsensusConfig(),
+		consCfg:     consensusCfg,
 		consGenesis: genesis.GetConsensusGenesisState(),
 
 		height: 0,
@@ -233,11 +230,6 @@ func (m *consensusModule) SetBus(pocketBus modules.Bus) {
 	m.leaderElectionMod.SetBus(pocketBus)
 }
 
-func (*consensusModule) ValidateConfig(cfg modules.Config) error {
-	// TODO (#334): implement this
-	return nil
-}
-
 func (*consensusModule) ValidateGenesis(genesis modules.GenesisState) error {
 	// Sort the validators by their generic param (i.e. service URL)
 	vals := genesis.GetConsensusGenesisState().GetVals()
@@ -264,7 +256,7 @@ func (*consensusModule) ValidateGenesis(genesis modules.GenesisState) error {
 }
 
 func (m *consensusModule) GetPrivateKey() (cryptoPocket.PrivateKey, error) {
-	return cryptoPocket.NewPrivateKey(m.consCfg.GetPrivateKey())
+	return cryptoPocket.NewPrivateKey(m.consCfg.PrivateKey)
 }
 
 func (m *consensusModule) HandleMessage(message *anypb.Any) error {
@@ -327,9 +319,3 @@ func (m *consensusModule) loadPersistedState() error {
 
 	return nil
 }
-
-// HasPacemakerConfig is used to determine if a ConsensusConfig includes a PacemakerConfig without having to cast to the struct
-// (which would break mocks and/or pollute the codebase with mock types casts and checks)
-type HasPacemakerConfig interface {
-	GetPacemakerConfig() *typesCons.PacemakerConfig
-}

consensus/pacemaker.go

@@ -2,12 +2,12 @@ package consensus
 
 import (
 	"context"
-	"fmt"
 	"log"
 	timePkg "time"
 
 	consensusTelemetry "github.com/pokt-network/pocket/consensus/telemetry"
 	typesCons "github.com/pokt-network/pocket/consensus/types"
+	"github.com/pokt-network/pocket/runtime/configs"
 	"github.com/pokt-network/pocket/shared/modules"
 )
 
@@ -31,10 +31,8 @@ type Pacemaker interface {
 }
 
 var (
-	_ modules.Module             = &paceMaker{}
-	_ modules.ConfigurableModule = &paceMaker{}
-	_ PacemakerDebug             = &paceMaker{}
-	_ modules.PacemakerConfig    = &typesCons.PacemakerConfig{}
+	_ modules.Module = &paceMaker{}
+	_ PacemakerDebug = &paceMaker{}
 )
 
 type paceMaker struct {
@@ -46,7 +44,7 @@ type paceMaker struct {
 	// a great idea in production code.
 	consensusMod *consensusModule
 
-	pacemakerCfg modules.PacemakerConfig
+	pacemakerCfg *configs.PacemakerConfig
 
 	stepCancelFunc context.CancelFunc
 
@@ -61,11 +59,8 @@ func CreatePacemaker(runtimeMgr modules.RuntimeMgr) (modules.Module, error) {
 
 func (m *paceMaker) Create(runtimeMgr modules.RuntimeMgr) (modules.Module, error) {
 	cfg := runtimeMgr.GetConfig()
-	if err := m.ValidateConfig(cfg); err != nil {
-		log.Fatalf("config validation failed: %v", err)
-	}
 
-	pacemakerCfg := cfg.GetConsensusConfig().(HasPacemakerConfig).GetPacemakerConfig()
+	pacemakerCfg := cfg.Consensus.PacemakerConfig
 
 	return &paceMaker{
 		bus:          nil,
@@ -76,8 +71,8 @@ func (m *paceMaker) Create(runtimeMgr modules.RuntimeMgr) (modules.Module, error
 		stepCancelFunc: nil, // Only set on restarts
 
 		paceMakerDebug: paceMakerDebug{
-			manualMode:                pacemakerCfg.GetManual(),
-			debugTimeBetweenStepsMsec: pacemakerCfg.GetDebugTimeBetweenStepsMsec(),
+			manualMode:                pacemakerCfg.Manual,
+			debugTimeBetweenStepsMsec: pacemakerCfg.DebugTimeBetweenStepsMsec,
 			quorumCertificate:         nil,
 		},
 	}, nil
@@ -106,13 +101,6 @@ func (m *paceMaker) GetBus() modules.Bus {
 	return m.bus
 }
 
-func (*paceMaker) ValidateConfig(cfg modules.Config) error {
-	if _, ok := cfg.GetConsensusConfig().(HasPacemakerConfig); !ok {
-		return fmt.Errorf("cannot cast to PacemakeredConsensus")
-	}
-	return nil
-}
-
 func (m *paceMaker) SetConsensusModule(c *consensusModule) {
 	m.consensusMod = c
 }
@@ -259,6 +247,6 @@ func (p *paceMaker) startNextView(qc *typesCons.QuorumCertificate, forceNextView
 
 // TODO(olshansky): Increase timeout using exponential backoff.
 func (p *paceMaker) getStepTimeout(round uint64) timePkg.Duration {
-	baseTimeout := timePkg.Duration(int64(timePkg.Millisecond) * int64(p.pacemakerCfg.GetTimeoutMsec()))
+	baseTimeout := timePkg.Duration(int64(timePkg.Millisecond) * int64(p.pacemakerCfg.TimeoutMsec))
 	return baseTimeout
 }

consensus/types/types.go

@@ -41,10 +41,6 @@ func GetValAddrToIdMap(validatorMap ValidatorMap) (ValAddrToIdMap, IdToValAddrMa
 	return valToIdMap, idToValMap
 }
 
-func (x *PacemakerConfig) SetTimeoutMsec(u uint64) {
-	x.TimeoutMsec = u
-}
-
 func ValidatorMapToModulesValidatorMap(validatorMap ValidatorMap) (vm modules.ValidatorMap) {
 	vm = make(modules.ValidatorMap)
 	for _, v := range validatorMap {

logger/module.go

@@ -4,14 +4,15 @@ import (
 	"os"
 	"strings"
 
+	"github.com/pokt-network/pocket/runtime/configs"
 	"github.com/pokt-network/pocket/shared/modules"
 	"github.com/rs/zerolog"
 )
 
 type loggerModule struct {
 	bus    modules.Bus
 	logger modules.Logger
-	config modules.LoggerConfig
+	config *configs.LoggerConfig
 }
 
 // All loggers branch out of mainLogger, that way configuration changes to mainLogger propagate to others.
@@ -28,19 +29,19 @@ const (
 	ModuleName = "logger"
 )
 
-var pocketLogLevelToZeroLog = map[LogLevel]zerolog.Level{
-	LogLevel_LOG_LEVEL_UNSPECIFIED: zerolog.NoLevel,
-	LogLevel_LOG_LEVEL_DEBUG:       zerolog.DebugLevel,
-	LogLevel_LOG_LEVEL_INFO:        zerolog.InfoLevel,
-	LogLevel_LOG_LEVEL_WARN:        zerolog.WarnLevel,
-	LogLevel_LOG_LEVEL_ERROR:       zerolog.ErrorLevel,
-	LogLevel_LOG_LEVEL_FATAL:       zerolog.FatalLevel,
-	LogLevel_LOG_LEVEL_PANIC:       zerolog.PanicLevel,
+var pocketLogLevelToZeroLog = map[configs.LogLevel]zerolog.Level{
+	configs.LogLevel_LOG_LEVEL_UNSPECIFIED: zerolog.NoLevel,
+	configs.LogLevel_LOG_LEVEL_DEBUG:       zerolog.DebugLevel,
+	configs.LogLevel_LOG_LEVEL_INFO:        zerolog.InfoLevel,
+	configs.LogLevel_LOG_LEVEL_WARN:        zerolog.WarnLevel,
+	configs.LogLevel_LOG_LEVEL_ERROR:       zerolog.ErrorLevel,
+	configs.LogLevel_LOG_LEVEL_FATAL:       zerolog.FatalLevel,
+	configs.LogLevel_LOG_LEVEL_PANIC:       zerolog.PanicLevel,
 }
 
-var pocketLogFormatToEnum = map[string]LogFormat{
-	"json":   LogFormat_LOG_FORMAT_JSON,
-	"pretty": LogFormat_LOG_FORMAT_PRETTY,
+var pocketLogFormatToEnum = map[string]configs.LogFormat{
+	"json":   configs.LogFormat_LOG_FORMAT_JSON,
+	"pretty": configs.LogFormat_LOG_FORMAT_PRETTY,
 }
 
 func Create(runtimeMgr modules.RuntimeMgr) (modules.Module, error) {
@@ -54,19 +55,19 @@ func (*loggerModule) CreateLoggerForModule(moduleName string) modules.Logger {
 func (*loggerModule) Create(runtimeMgr modules.RuntimeMgr) (modules.Module, error) {
 	cfg := runtimeMgr.GetConfig()
 	m := loggerModule{
-		config: cfg.GetLoggerConfig(),
+		config: cfg.Logger,
 	}
 
 	m.InitLogger()
 
 	// Mapping config string value to the proto enum
-	if pocketLogLevel, ok := LogLevel_value[`LogLevel_LOG_LEVEL_`+strings.ToUpper(m.config.GetLevel())]; ok {
-		zerolog.SetGlobalLevel(pocketLogLevelToZeroLog[LogLevel(pocketLogLevel)])
+	if pocketLogLevel, ok := configs.LogLevel_value[`LogLevel_LOG_LEVEL_`+strings.ToUpper(m.config.Level)]; ok {
+		zerolog.SetGlobalLevel(pocketLogLevelToZeroLog[configs.LogLevel(pocketLogLevel)])
 	} else {
 		zerolog.SetGlobalLevel(zerolog.NoLevel)
 	}
 
-	if pocketLogFormatToEnum[m.config.GetFormat()] == LogFormat_LOG_FORMAT_PRETTY {
+	if pocketLogFormatToEnum[m.config.Format] == configs.LogFormat_LOG_FORMAT_PRETTY {
 		mainLogger = mainLogger.Output(zerolog.ConsoleWriter{Out: os.Stderr})
 		mainLogger.Info().Msg("using pretty log format")
 	}

p2p/addrbook_provider/persistence.go

@@ -6,6 +6,7 @@ import (
 
 	"github.com/pokt-network/pocket/p2p/transport"
 	typesP2P "github.com/pokt-network/pocket/p2p/types"
+	"github.com/pokt-network/pocket/runtime/configs"
 	cryptoPocket "github.com/pokt-network/pocket/shared/crypto"
 	"github.com/pokt-network/pocket/shared/modules"
 )
@@ -15,11 +16,11 @@ var _ typesP2P.AddrBookProvider = &persistenceAddrBookProvider{}
 
 type persistenceAddrBookProvider struct {
 	bus         modules.Bus
-	p2pCfg      modules.P2PConfig
+	p2pCfg      *configs.P2PConfig
 	connFactory typesP2P.ConnectionFactory
 }
 
-func NewPersistenceAddrBookProvider(bus modules.Bus, p2pCfg modules.P2PConfig, options ...func(*persistenceAddrBookProvider)) *persistenceAddrBookProvider {
+func NewPersistenceAddrBookProvider(bus modules.Bus, p2pCfg *configs.P2PConfig, options ...func(*persistenceAddrBookProvider)) *persistenceAddrBookProvider {
 	pabp := &persistenceAddrBookProvider{
 		bus:         bus,
 		p2pCfg:      p2pCfg,