[config] move config.Consensus to consensus package (#3735)

chainservice/builder.go

@@ -29,6 +29,7 @@ import (
 	"github.com/iotexproject/iotex-core/blocksync"
 	"github.com/iotexproject/iotex-core/config"
 	"github.com/iotexproject/iotex-core/consensus"
+	rp "github.com/iotexproject/iotex-core/consensus/scheme/rolldpos"
 	"github.com/iotexproject/iotex-core/db"
 	"github.com/iotexproject/iotex-core/p2p"
 	"github.com/iotexproject/iotex-core/pkg/log"
@@ -557,7 +558,16 @@ func (builder *Builder) buildConsensusComponent() error {
 	}
 
 	// TODO: explorer dependency deleted at #1085, need to revive by migrating to api
-	component, err := consensus.NewConsensus(builder.cfg, builder.cs.chain, builder.cs.factory, copts...)
+	builderCfg := rp.BuilderConfig{
+		Chain:              builder.cfg.Chain,
+		Consensus:          builder.cfg.Consensus.RollDPoS,
+		Scheme:             builder.cfg.Consensus.Scheme,
+		DardanellesUpgrade: builder.cfg.DardanellesUpgrade,
+		DB:                 builder.cfg.DB,
+		Genesis:            builder.cfg.Genesis,
+		SystemActive:       builder.cfg.System.Active,
+	}
+	component, err := consensus.NewConsensus(builderCfg, builder.cs.chain, builder.cs.factory, copts...)
 	if err != nil {
 		return errors.Wrap(err, "failed to create consensus component")
 	}

config/config.go

@@ -17,6 +17,8 @@ import (
 	"github.com/iotexproject/iotex-core/blockchain"
 	"github.com/iotexproject/iotex-core/blockchain/genesis"
 	"github.com/iotexproject/iotex-core/blockindex"
+	"github.com/iotexproject/iotex-core/consensus"
+	"github.com/iotexproject/iotex-core/consensus/consensusfsm"
 	"github.com/iotexproject/iotex-core/db"
 	"github.com/iotexproject/iotex-core/dispatcher"
 	"github.com/iotexproject/iotex-core/p2p"
@@ -57,38 +59,13 @@ func (ss *strs) Set(str string) error {
 var (
 	// Default is the default config
 	Default = Config{
-		Plugins: make(map[int]interface{}),
-		SubLogs: make(map[string]log.GlobalConfig),
-		Network: p2p.DefaultConfig,
-		Chain:   blockchain.DefaultConfig,
-		ActPool: actpool.DefaultConfig,
-		Consensus: Consensus{
-			Scheme: StandaloneScheme,
-			RollDPoS: RollDPoS{
-				FSM: ConsensusTiming{
-					UnmatchedEventTTL:            3 * time.Second,
-					UnmatchedEventInterval:       100 * time.Millisecond,
-					AcceptBlockTTL:               4 * time.Second,
-					AcceptProposalEndorsementTTL: 2 * time.Second,
-					AcceptLockEndorsementTTL:     2 * time.Second,
-					CommitTTL:                    2 * time.Second,
-					EventChanSize:                10000,
-				},
-				ToleratedOvertime: 2 * time.Second,
-				Delay:             5 * time.Second,
-				ConsensusDBPath:   "/var/data/consensus.db",
-			},
-		},
-		DardanellesUpgrade: DardanellesUpgrade{
-			UnmatchedEventTTL:            2 * time.Second,
-			UnmatchedEventInterval:       100 * time.Millisecond,
-			AcceptBlockTTL:               2 * time.Second,
-			AcceptProposalEndorsementTTL: time.Second,
-			AcceptLockEndorsementTTL:     time.Second,
-			CommitTTL:                    time.Second,
-			BlockInterval:                5 * time.Second,
-			Delay:                        2 * time.Second,
-		},
+		Plugins:            make(map[int]interface{}),
+		SubLogs:            make(map[string]log.GlobalConfig),
+		Network:            p2p.DefaultConfig,
+		Chain:              blockchain.DefaultConfig,
+		ActPool:            actpool.DefaultConfig,
+		Consensus:          consensus.DefaultConfig,
+		DardanellesUpgrade: consensusfsm.DefaultDardanellesUpgradeConfig,
 		BlockSync: BlockSync{
 			Interval:              30 * time.Second,
 			ProcessSyncRequestTTL: 10 * time.Second,
@@ -140,13 +117,6 @@ var (
 
 // Network is the config struct for network package
 type (
-	// Consensus is the config struct for consensus package
-	Consensus struct {
-		// There are three schemes that are supported
-		Scheme   string   `yaml:"scheme"`
-		RollDPoS RollDPoS `yaml:"rollDPoS"`
-	}
-
 	// BlockSync is the config struct for the BlockSync
 	BlockSync struct {
 		Interval              time.Duration `yaml:"interval"` // update duration
@@ -159,37 +129,6 @@ type (
 		RepeatDecayStep int `yaml:"repeatDecayStep"`
 	}
 
-	// DardanellesUpgrade is the config for dardanelles upgrade
-	DardanellesUpgrade struct {
-		UnmatchedEventTTL            time.Duration `yaml:"unmatchedEventTTL"`
-		UnmatchedEventInterval       time.Duration `yaml:"unmatchedEventInterval"`
-		AcceptBlockTTL               time.Duration `yaml:"acceptBlockTTL"`
-		AcceptProposalEndorsementTTL time.Duration `yaml:"acceptProposalEndorsementTTL"`
-		AcceptLockEndorsementTTL     time.Duration `yaml:"acceptLockEndorsementTTL"`
-		CommitTTL                    time.Duration `yaml:"commitTTL"`
-		BlockInterval                time.Duration `yaml:"blockInterval"`
-		Delay                        time.Duration `yaml:"delay"`
-	}
-
-	// RollDPoS is the config struct for RollDPoS consensus package
-	RollDPoS struct {
-		FSM               ConsensusTiming `yaml:"fsm"`
-		ToleratedOvertime time.Duration   `yaml:"toleratedOvertime"`
-		Delay             time.Duration   `yaml:"delay"`
-		ConsensusDBPath   string          `yaml:"consensusDBPath"`
-	}
-
-	// ConsensusTiming defines a set of time durations used in fsm and event queue size
-	ConsensusTiming struct {
-		EventChanSize                uint          `yaml:"eventChanSize"`
-		UnmatchedEventTTL            time.Duration `yaml:"unmatchedEventTTL"`
-		UnmatchedEventInterval       time.Duration `yaml:"unmatchedEventInterval"`
-		AcceptBlockTTL               time.Duration `yaml:"acceptBlockTTL"`
-		AcceptProposalEndorsementTTL time.Duration `yaml:"acceptProposalEndorsementTTL"`
-		AcceptLockEndorsementTTL     time.Duration `yaml:"acceptLockEndorsementTTL"`
-		CommitTTL                    time.Duration `yaml:"commitTTL"`
-	}
-
 	// API is the api service config
 	API struct {
 		UseRDS          bool          `yaml:"useRDS"`
@@ -225,21 +164,21 @@ type (
 
 	// Config is the root config struct, each package's config should be put as its sub struct
 	Config struct {
-		Plugins            map[int]interface{}         `ymal:"plugins"`
-		Network            p2p.Config                  `yaml:"network"`
-		Chain              blockchain.Config           `yaml:"chain"`
-		ActPool            actpool.Config              `yaml:"actPool"`
-		Consensus          Consensus                   `yaml:"consensus"`
-		DardanellesUpgrade DardanellesUpgrade          `yaml:"dardanellesUpgrade"`
-		BlockSync          BlockSync                   `yaml:"blockSync"`
-		Dispatcher         dispatcher.Config           `yaml:"dispatcher"`
-		API                API                         `yaml:"api"`
-		System             System                      `yaml:"system"`
-		DB                 db.Config                   `yaml:"db"`
-		Indexer            blockindex.Config           `yaml:"indexer"`
-		Log                log.GlobalConfig            `yaml:"log"`
-		SubLogs            map[string]log.GlobalConfig `yaml:"subLogs"`
-		Genesis            genesis.Genesis             `yaml:"genesis"`
+		Plugins            map[int]interface{}             `ymal:"plugins"`
+		Network            p2p.Config                      `yaml:"network"`
+		Chain              blockchain.Config               `yaml:"chain"`
+		ActPool            actpool.Config                  `yaml:"actPool"`
+		Consensus          consensus.Config                `yaml:"consensus"`
+		DardanellesUpgrade consensusfsm.DardanellesUpgrade `yaml:"dardanellesUpgrade"`
+		BlockSync          BlockSync                       `yaml:"blockSync"`
+		Dispatcher         dispatcher.Config               `yaml:"dispatcher"`
+		API                API                             `yaml:"api"`
+		System             System                          `yaml:"system"`
+		DB                 db.Config                       `yaml:"db"`
+		Indexer            blockindex.Config               `yaml:"indexer"`
+		Log                log.GlobalConfig                `yaml:"log"`
+		SubLogs            map[string]log.GlobalConfig     `yaml:"subLogs"`
+		Genesis            genesis.Genesis                 `yaml:"genesis"`
 	}
 
 	// Validate is the interface of validating the config

consensus/config.go

@@ -0,0 +1,31 @@
+package consensus
+
+import (
+	"github.com/iotexproject/iotex-core/consensus/scheme/rolldpos"
+)
+
+const (
+	// RollDPoSScheme means randomized delegated proof of stake
+	RollDPoSScheme = "ROLLDPOS"
+	// StandaloneScheme means that the node creates a block periodically regardless of others (if there is any)
+	StandaloneScheme = "STANDALONE"
+	// NOOPScheme means that the node does not create only block
+	NOOPScheme = "NOOP"
+)
+
+var (
+	//DefaultConfig is the default config for blocksync
+	DefaultConfig = Config{
+		Scheme:   StandaloneScheme,
+		RollDPoS: rolldpos.DefaultConfig,
+	}
+)
+
+type (
+	// Config is the config struct for consensus package
+	Config struct {
+		// There are three schemes that are supported
+		Scheme   string          `yaml:"scheme"`
+		RollDPoS rolldpos.Config `yaml:"rollDPoS"`
+	}
+)

consensus/consensus.go

@@ -9,6 +9,7 @@ import (
 	"context"
 
 	"github.com/facebookgo/clock"
+	"github.com/iotexproject/iotex-proto/golang/iotextypes"
 	"github.com/pkg/errors"
 	"go.uber.org/zap"
 
@@ -18,14 +19,12 @@ import (
 	"github.com/iotexproject/iotex-core/blockchain"
 	"github.com/iotexproject/iotex-core/blockchain/block"
 	"github.com/iotexproject/iotex-core/blockchain/genesis"
-	"github.com/iotexproject/iotex-core/config"
 	"github.com/iotexproject/iotex-core/consensus/scheme"
 	"github.com/iotexproject/iotex-core/consensus/scheme/rolldpos"
 	"github.com/iotexproject/iotex-core/pkg/lifecycle"
 	"github.com/iotexproject/iotex-core/pkg/log"
 	"github.com/iotexproject/iotex-core/state"
 	"github.com/iotexproject/iotex-core/state/factory"
-	"github.com/iotexproject/iotex-proto/golang/iotextypes"
 )
 
 // Consensus is the interface for handling IotxConsensus view change.
@@ -42,7 +41,7 @@ type Consensus interface {
 
 // IotxConsensus implements Consensus
 type IotxConsensus struct {
-	cfg    config.Consensus
+	cfg    Config
 	scheme scheme.Scheme
 }
 
@@ -81,7 +80,7 @@ func WithPollProtocol(pp poll.Protocol) Option {
 
 // NewConsensus creates a IotxConsensus struct.
 func NewConsensus(
-	cfg config.Config,
+	cfg rolldpos.BuilderConfig,
 	bc blockchain.Blockchain,
 	sf factory.Factory,
 	opts ...Option,
@@ -94,10 +93,13 @@ func NewConsensus(
 	}
 
 	clock := clock.New()
-	cs := &IotxConsensus{cfg: cfg.Consensus}
+	cs := &IotxConsensus{cfg: Config{
+		Scheme:   cfg.Scheme,
+		RollDPoS: cfg.Consensus,
+	}}
 	var err error
-	switch cfg.Consensus.Scheme {
-	case config.RollDPoSScheme:
+	switch cfg.Scheme {
+	case RollDPoSScheme:
 		bd := rolldpos.NewRollDPoSBuilder().
 			SetAddr(cfg.Chain.ProducerAddress().String()).
 			SetPriKey(cfg.Chain.ProducerPrivateKey()).
@@ -143,9 +145,9 @@ func NewConsensus(
 		if err != nil {
 			log.Logger("consensus").Panic("Error when constructing RollDPoS.", zap.Error(err))
 		}
-	case config.NOOPScheme:
+	case NOOPScheme:
 		cs.scheme = scheme.NewNoop()
-	case config.StandaloneScheme:
+	case StandaloneScheme:
 		mintBlockCB := func() (*block.Block, error) {
 			blk, err := bc.MintNewBlock(clock.Now())
 			if err != nil {
@@ -178,7 +180,7 @@ func NewConsensus(
 			cfg.Genesis.BlockInterval,
 		)
 	default:
-		return nil, errors.Errorf("unexpected IotxConsensus scheme %s", cfg.Consensus.Scheme)
+		return nil, errors.Errorf("unexpected IotxConsensus scheme %s", cfg.Scheme)
 	}
 
 	return cs, nil