chore(lib/grandpa): make interval configurable

chain/gssmr/config.toml

@@ -30,6 +30,7 @@ port = 7001
 nobootstrap = false
 nomdns = false
 discovery-interval = 10
+grandpa-interval = 1
 
 [rpc]
 enabled = false

chain/gssmr/defaults.go

@@ -85,6 +85,9 @@ var (
 	// DefaultDiscoveryInterval is the default interval for searching for DHT peers
 	DefaultDiscoveryInterval = time.Second * 10
 
+	// DefaultGrandpaInterval
+	DefaultGrandpaInterval = time.Second
+
 	// RPCConfig
 
 	// DefaultRPCHTTPHost rpc host

cmd/gossamer/config.go

@@ -631,6 +631,12 @@ func setDotNetworkConfig(ctx *cli.Context, tomlCfg ctoml.NetworkConfig, cfg *dot
 		cfg.DiscoveryInterval = 0
 	}
 
+	if tomlCfg.GrandpaInterval > 0 {
+		cfg.GrandpaInterval = time.Second * time.Duration(tomlCfg.GrandpaInterval)
+	} else {
+		cfg.GrandpaInterval = 0
+	}
+
 	// check --port flag and update node configuration
 	if port := ctx.GlobalUint(PortFlag.Name); port != 0 {
 		cfg.Port = uint32(port)
@@ -676,6 +682,7 @@ func setDotNetworkConfig(ctx *cli.Context, tomlCfg ctoml.NetworkConfig, cfg *dot
 		"maxpeers", cfg.MaxPeers,
 		"persistent-peers", cfg.PersistentPeers,
 		"discovery-interval", cfg.DiscoveryInterval,
+		"grandpa-interval", cfg.GrandpaInterval,
 	)
 }
 

cmd/gossamer/config_test.go

@@ -390,6 +390,7 @@ func TestNetworkConfigFromFlags(t *testing.T) {
 				NoBootstrap:       testCfg.Network.NoBootstrap,
 				NoMDNS:            testCfg.Network.NoMDNS,
 				DiscoveryInterval: time.Second * 10,
+				GrandpaInterval:   time.Second,
 			},
 		},
 		{
@@ -403,6 +404,7 @@ func TestNetworkConfigFromFlags(t *testing.T) {
 				NoBootstrap:       testCfg.Network.NoBootstrap,
 				NoMDNS:            testCfg.Network.NoMDNS,
 				DiscoveryInterval: time.Second * 10,
+				GrandpaInterval:   time.Second,
 			},
 		},
 		{
@@ -416,6 +418,7 @@ func TestNetworkConfigFromFlags(t *testing.T) {
 				NoBootstrap:       testCfg.Network.NoBootstrap,
 				NoMDNS:            testCfg.Network.NoMDNS,
 				DiscoveryInterval: time.Second * 10,
+				GrandpaInterval:   time.Second,
 			},
 		},
 		{
@@ -429,6 +432,7 @@ func TestNetworkConfigFromFlags(t *testing.T) {
 				NoBootstrap:       true,
 				NoMDNS:            testCfg.Network.NoMDNS,
 				DiscoveryInterval: time.Second * 10,
+				GrandpaInterval:   time.Second,
 			},
 		},
 		{
@@ -442,6 +446,7 @@ func TestNetworkConfigFromFlags(t *testing.T) {
 				NoBootstrap:       testCfg.Network.NoBootstrap,
 				NoMDNS:            true,
 				DiscoveryInterval: time.Second * 10,
+				GrandpaInterval:   time.Second,
 			},
 		},
 	}
@@ -816,6 +821,7 @@ func TestUpdateConfigFromGenesisData(t *testing.T) {
 			NoBootstrap:       testCfg.Network.NoBootstrap,
 			NoMDNS:            testCfg.Network.NoMDNS,
 			DiscoveryInterval: testCfg.Network.DiscoveryInterval,
+			GrandpaInterval:   testCfg.Network.GrandpaInterval,
 		},
 		RPC:    testCfg.RPC,
 		System: testCfg.System,

cmd/gossamer/export.go

@@ -124,6 +124,7 @@ func dotConfigToToml(dcfg *dot.Config) *ctoml.Config {
 		NoBootstrap:       dcfg.Network.NoBootstrap,
 		NoMDNS:            dcfg.Network.NoMDNS,
 		DiscoveryInterval: int(dcfg.Network.DiscoveryInterval / time.Second),
+		GrandpaInterval:   int(dcfg.Network.GrandpaInterval / time.Second),
 	}
 
 	cfg.RPC = ctoml.RPCConfig{

cmd/gossamer/export_test.go

@@ -87,6 +87,7 @@ func TestExportCommand(t *testing.T) {
 					NoBootstrap:       testCfg.Network.NoBootstrap,
 					NoMDNS:            testCfg.Network.NoMDNS,
 					DiscoveryInterval: testCfg.Network.DiscoveryInterval,
+					GrandpaInterval:   testCfg.Network.GrandpaInterval,
 				},
 				RPC: testCfg.RPC,
 			},
@@ -119,6 +120,7 @@ func TestExportCommand(t *testing.T) {
 					NoBootstrap:       testCfg.Network.NoBootstrap,
 					NoMDNS:            testCfg.Network.NoMDNS,
 					DiscoveryInterval: testCfg.Network.DiscoveryInterval,
+					GrandpaInterval:   testCfg.Network.GrandpaInterval,
 				},
 				RPC: testCfg.RPC,
 			},
@@ -151,6 +153,7 @@ func TestExportCommand(t *testing.T) {
 					NoBootstrap:       testCfg.Network.NoBootstrap,
 					NoMDNS:            testCfg.Network.NoMDNS,
 					DiscoveryInterval: testCfg.Network.DiscoveryInterval,
+					GrandpaInterval:   testCfg.Network.GrandpaInterval,
 				},
 				RPC: testCfg.RPC,
 			},

dot/config.go

@@ -92,6 +92,7 @@ type NetworkConfig struct {
 	MaxPeers          int
 	PersistentPeers   []string
 	DiscoveryInterval time.Duration
+	GrandpaInterval   time.Duration
 }
 
 // CoreConfig is to marshal/unmarshal toml core config vars
@@ -185,6 +186,7 @@ func GssmrConfig() *Config {
 			NoBootstrap:       gssmr.DefaultNoBootstrap,
 			NoMDNS:            gssmr.DefaultNoMDNS,
 			DiscoveryInterval: gssmr.DefaultDiscoveryInterval,
+			GrandpaInterval:   gssmr.DefaultGrandpaInterval,
 		},
 		RPC: RPCConfig{
 			Port:    gssmr.DefaultRPCHTTPPort,

dot/config/toml/config.go

@@ -72,6 +72,7 @@ type NetworkConfig struct {
 	MaxPeers          int      `toml:"max-peers,omitempty"`
 	PersistentPeers   []string `toml:"persistent-peers,omitempty"`
 	DiscoveryInterval int      `toml:"discovery-interval,omitempty"`
+	GrandpaInterval   int      `toml:"grandpa-interval,omitempty"`
 }
 
 // CoreConfig is to marshal/unmarshal toml core config vars

dot/services.go

@@ -388,6 +388,7 @@ func createGRANDPAService(cfg *Config, st *state.Service, dh *digest.Handler, ks
 		Voters:        voters,
 		Authority:     cfg.Core.GrandpaAuthority,
 		Network:       net,
+		Interval:      cfg.Network.GrandpaInterval,
 	}
 
 	if cfg.Core.GrandpaAuthority {

lib/grandpa/grandpa.go

@@ -41,8 +41,7 @@ const (
 )
 
 var (
-	interval = time.Second // TODO: make this configurable; currently 1s is same as substrate; total round length is interval * 2
-	logger   = log.New("pkg", "grandpa")
+	logger = log.New("pkg", "grandpa")
 )
 
 // Service represents the current state of the grandpa protocol
@@ -62,6 +61,7 @@ type Service struct {
 	resumed        chan struct{} // this channel will be closed when the service resumes
 	messageHandler *MessageHandler
 	network        Network
+	interval       time.Duration
 
 	// current state information
 	state           *State                                   // current state
@@ -92,6 +92,7 @@ type Config struct {
 	Voters        []Voter
 	Keypair       *ed25519.Keypair
 	Authority     bool
+	Interval      time.Duration
 }
 
 // NewService returns a new GRANDPA Service instance.
@@ -166,6 +167,7 @@ func NewService(cfg *Config) (*Service, error) {
 		resumed:            make(chan struct{}),
 		network:            cfg.Network,
 		finalisedCh:        finalisedCh,
+		interval:           cfg.Interval,
 	}
 
 	s.messageHandler = NewMessageHandler(s, s.blockState)
@@ -464,7 +466,7 @@ func (s *Service) playGrandpaRound() error {
 
 	logger.Debug("receiving pre-vote messages...")
 	go s.receiveMessages(ctx)
-	time.Sleep(interval)
+	time.Sleep(s.interval)
 
 	if s.paused.Load().(bool) {
 		return ErrServicePaused
@@ -493,7 +495,7 @@ func (s *Service) playGrandpaRound() error {
 	go s.sendVoteMessage(prevote, vm, roundComplete)
 
 	logger.Debug("receiving pre-commit messages...")
-	time.Sleep(interval)
+	time.Sleep(s.interval)
 
 	if s.paused.Load().(bool) {
 		return ErrServicePaused
@@ -526,7 +528,7 @@ func (s *Service) playGrandpaRound() error {
 }
 
 func (s *Service) sendVoteMessage(stage Subround, msg *VoteMessage, roundComplete <-chan struct{}) {
-	ticker := time.NewTicker(interval * 4)
+	ticker := time.NewTicker(s.interval * 4)
 	defer ticker.Stop()
 
 	for {
@@ -550,7 +552,7 @@ func (s *Service) sendVoteMessage(stage Subround, msg *VoteMessage, roundComplet
 
 // attemptToFinalize loops until the round is finalisable
 func (s *Service) attemptToFinalize() error {
-	ticker := time.NewTicker(interval / 100)
+	ticker := time.NewTicker(s.interval / 100)
 
 	for {
 		select {

lib/grandpa/grandpa_test.go

@@ -117,6 +117,7 @@ func newTestService(t *testing.T) (*Service, *state.Service) {
 		Keypair:       kr.Alice().(*ed25519.Keypair),
 		Authority:     true,
 		Network:       net,
+		Interval:      time.Second,
 	}
 
 	gs, err := NewService(cfg)

lib/grandpa/round_test.go

@@ -126,6 +126,7 @@ func setupGrandpa(t *testing.T, kp *ed25519.Keypair) (*Service, chan *networkVot
 		LogLvl:        log.LvlInfo,
 		Authority:     true,
 		Network:       net,
+		Interval:      time.Second,
 	}
 
 	gs, err := NewService(cfg)