refactor(cli): Remove babe-lead flag (#3193)

chain/westend-local/config-alice.toml

@@ -25,7 +25,6 @@ unlock = ""
 roles = 4
 babe-authority = true
 grandpa-authority = true
-babe-lead = true
 
 [network]
 port = 7001

cmd/gossamer/config.go

@@ -605,11 +605,6 @@ func setDotCoreConfig(ctx *cli.Context, tomlCfg ctoml.CoreConfig, cfg *dot.CoreC
 	cfg.GrandpaAuthority = common.Roles(tomlCfg.Roles) == common.AuthorityRole
 	cfg.GrandpaInterval = time.Second * time.Duration(tomlCfg.GrandpaInterval)
 
-	cfg.BABELead = tomlCfg.BABELead
-	if ctx.IsSet(BABELeadFlag.Name) {
-		cfg.BABELead = ctx.Bool(BABELeadFlag.Name)
-	}
-
 	// check --roles flag and update node configuration
 	if roles := ctx.String(RolesFlag.Name); roles != "" {
 		// convert string to byte

cmd/gossamer/flags.go

@@ -385,10 +385,6 @@ var (
 
 // BABE flags
 var (
-	BABELeadFlag = cli.BoolFlag{
-		Name:  "babe-lead",
-		Usage: `specify whether node should build block 1 of the network. only used when starting a new network`,
-	}
 	ValidatorFlag = cli.BoolFlag{
 		Name: "validator", // TODO(ed) implement
 	}
@@ -461,7 +457,6 @@ var (
 		&TelemetryURLFlag,
 
 		// BABE flags
-		&BABELeadFlag,
 		&ValidatorFlag,
 	}
 )

devnet/README.md

@@ -43,7 +43,7 @@ export $DD_API_KEY=YourKey
 
 There are four Docker files used in the devnet.  
 
-- `alice.Dockerfile` is the lead node and is initiated with the `babe-lead` flag to build the first block.  
+- `alice.Dockerfile` is the lead node.  
 - `bob.Dockerfile` is used for both `bob` and `charlie` and shares the same genesis as alice docker file.
 - `substrate_alice.Dockerfile` is the alice node initiated with explicit node key to keep a deterministic peer id (the same used by gossamer alice node)
 - `substrate_bob.Dockerfile` is used for `bob` and `charlie` and shares the same genesis as alice docker file.

devnet/alice.Dockerfile

@@ -35,6 +35,6 @@ RUN go run cmd/update-dd-agent-confd/main.go -n=${METRICS_NAMESPACE} -t=key:alic
 
 WORKDIR /gossamer
 
-ENTRYPOINT service datadog-agent start && gossamer --key=alice --babe-lead --publish-metrics  --metrics-address=":9876" --rpc --rpc-external=true --pubdns=alice --port 7001
+ENTRYPOINT service datadog-agent start && gossamer --key=alice --publish-metrics  --metrics-address=":9876" --rpc --rpc-external=true --pubdns=alice --port 7001
 
 EXPOSE 7001/tcp 8545/tcp 8546/tcp 8540/tcp 9876/tcp 6060/tcp

dot/config.go

@@ -111,7 +111,6 @@ type NetworkConfig struct {
 type CoreConfig struct {
 	Roles            common.Roles
 	BabeAuthority    bool
-	BABELead         bool
 	GrandpaAuthority bool
 	WasmInterpreter  string
 	GrandpaInterval  time.Duration

dot/config/toml/config.go

@@ -77,7 +77,6 @@ type CoreConfig struct {
 	EpochLength      uint64 `toml:"epoch-length,omitempty"`
 	WasmInterpreter  string `toml:"wasm-interpreter,omitempty"`
 	GrandpaInterval  uint32 `toml:"grandpa-interval,omitempty"`
-	BABELead         bool   `toml:"babe-lead,omitempty"`
 }
 
 // StateConfig contains the configuration for the state.

dot/services.go

@@ -214,7 +214,6 @@ func (nodeBuilder) createBABEServiceWithBuilder(cfg *Config, st *state.Service,
 		BlockImportHandler: cs,
 		Authority:          cfg.Core.BabeAuthority,
 		IsDev:              cfg.Global.ID == "dev",
-		Lead:               cfg.Core.BABELead,
 		Telemetry:          telemetryMailer,
 	}
 

dot/utils_test.go

@@ -120,7 +120,6 @@ func TestNewTestConfig(t *testing.T) {
 				Core: CoreConfig{
 					Roles:            4,
 					BabeAuthority:    true,
-					BABELead:         false,
 					GrandpaAuthority: true,
 					WasmInterpreter:  "wasmer",
 					GrandpaInterval:  1000000000,

lib/babe/babe.go

@@ -23,14 +23,10 @@ var logger = log.NewFromGlobal(log.AddContext("pkg", "babe"))
 
 // Service contains the VRF keys for the validator, as well as BABE configuation data
 type Service struct {
-	ctx       context.Context
-	cancel    context.CancelFunc
-	authority bool
-	dev       bool
-	// lead is used when setting up a new network from genesis.
-	// the "lead" node is the node that is designated to build block 1, after which the rest of the nodes
-	// will sync block 1 and determine the first slot of the network based on it
-	lead         bool
+	ctx          context.Context
+	cancel       context.CancelFunc
+	authority    bool
+	dev          bool
 	constants    constants
 	epochHandler *epochHandler
 
@@ -64,7 +60,6 @@ type ServiceConfig struct {
 	AuthData           []types.Authority
 	IsDev              bool
 	Authority          bool
-	Lead               bool
 	Telemetry          Telemetry
 }
 
@@ -112,7 +107,6 @@ func (Builder) NewServiceIFace(cfg *ServiceConfig) (service *Service, err error)
 		authority:          cfg.Authority,
 		dev:                cfg.IsDev,
 		blockImportHandler: cfg.BlockImportHandler,
-		lead:               cfg.Lead,
 		constants: constants{
 			slotDuration: slotDuration,
 			epochLength:  epochLength,
@@ -125,10 +119,6 @@ func (Builder) NewServiceIFace(cfg *ServiceConfig) (service *Service, err error)
 		cfg.Authority, babeService.constants.slotDuration, babeService.constants.epochLength,
 	)
 
-	if cfg.Lead {
-		logger.Debug("node designated to build block 1")
-	}
-
 	return babeService, nil
 }
 
@@ -164,7 +154,6 @@ func NewService(cfg *ServiceConfig) (*Service, error) {
 		authority:          cfg.Authority,
 		dev:                cfg.IsDev,
 		blockImportHandler: cfg.BlockImportHandler,
-		lead:               cfg.Lead,
 		constants: constants{
 			slotDuration: slotDuration,
 			epochLength:  epochLength,
@@ -177,10 +166,6 @@ func NewService(cfg *ServiceConfig) (*Service, error) {
 		cfg.Authority, babeService.constants.slotDuration, babeService.constants.epochLength,
 	)
 
-	if cfg.Lead {
-		logger.Debug("node designated to build block 1")
-	}
-
 	return babeService, nil
 }
 
@@ -190,55 +175,10 @@ func (b *Service) Start() error {
 		return nil
 	}
 
-	// if we aren't leading node, wait for first block
-	if !b.lead {
-		if err := b.waitForFirstBlock(); err != nil {
-			return err
-		}
-	}
-
 	go b.initiate()
 	return nil
 }
 
-func (b *Service) waitForFirstBlock() error {
-	head, err := b.blockState.BestBlockHeader()
-	if err != nil {
-		return fmt.Errorf("cannot get best block header: %w", err)
-	}
-
-	if head.Number > 0 {
-		return nil
-	}
-
-	ch := b.blockState.GetImportedBlockNotifierChannel()
-	defer b.blockState.FreeImportedBlockNotifierChannel(ch)
-
-	const firstBlockTimeout = time.Minute * 5
-	timer := time.NewTimer(firstBlockTimeout)
-
-	// loop until block 1
-	for {
-		select {
-		case block, ok := <-ch:
-			if !ok {
-				timer.Stop()
-				return errChannelClosed
-			}
-
-			if ok && block.Header.Number > 0 {
-				timer.Stop()
-				return nil
-			}
-		case <-timer.C:
-			return errFirstBlockTimeout
-		case <-b.ctx.Done():
-			timer.Stop()
-			return b.ctx.Err()
-		}
-	}
-}
-
 // SlotDuration returns the current service slot duration in milliseconds
 func (b *Service) SlotDuration() uint64 {
 	return uint64(b.constants.slotDuration.Milliseconds())

lib/babe/babe_integration_test.go

@@ -41,7 +41,6 @@ func TestService_ProducesBlocks(t *testing.T) {
 		Return(nil).MinTimes(2)
 	cfg := ServiceConfig{
 		Authority:          true,
-		Lead:               true,
 		BlockImportHandler: blockImportHandler,
 	}
 
@@ -90,9 +89,7 @@ func TestService_GetAuthorityIndex(t *testing.T) {
 }
 
 func TestStartAndStop(t *testing.T) {
-	cfg := ServiceConfig{
-		Lead: true,
-	}
+	cfg := ServiceConfig{}
 	gen, genTrie, genHeader := newWestendLocalGenesisWithTrieAndHeader(t)
 	bs := createTestService(t, cfg, gen, genTrie, genHeader, nil)
 	err := bs.Start()
@@ -102,9 +99,7 @@ func TestStartAndStop(t *testing.T) {
 }
 
 func TestService_PauseAndResume(t *testing.T) {
-	cfg := ServiceConfig{
-		Lead: true,
-	}
+	cfg := ServiceConfig{}
 	genesis, genesisTrie, genesisHeader := newWestendLocalGenesisWithTrieAndHeader(t)
 	babeService := createTestService(t, cfg, genesis, genesisTrie, genesisHeader, nil)
 	err := babeService.Start()
@@ -136,7 +131,6 @@ func TestService_PauseAndResume(t *testing.T) {
 func TestService_HandleSlotWithLaggingSlot(t *testing.T) {
 	cfg := ServiceConfig{
 		Authority: true,
-		Lead:      true,
 	}
 
 	genesis, genesisTrie, genesisHeader := newWestendDevGenesisWithTrieAndHeader(t)

lib/babe/errors.go

@@ -65,8 +65,6 @@ var (
 
 	errNilParentHeader            = errors.New("parent header is nil")
 	errInvalidResult              = errors.New("invalid error value")
-	errFirstBlockTimeout          = errors.New("timed out waiting for first block")
-	errChannelClosed              = errors.New("block notifier channel was closed")
 	errOverPrimarySlotThreshold   = errors.New("cannot claim slot, over primary threshold")
 	errNotOurTurnToPropose        = errors.New("cannot claim slot, not our turn to propose a block")
 	errMissingDigestItems         = errors.New("block header is missing digest items")

tests/polkadotjs_test/start_polkadotjs_test.go

@@ -47,7 +47,6 @@ func TestStartGossamerAndPolkadotAPI(t *testing.T) {
 
 	tomlConfig := config.Default()
 	tomlConfig.Init.Genesis = libutils.GetWestendLocalRawGenesisPath(t)
-	tomlConfig.Core.BABELead = true
 	tomlConfig.RPC.WS = true
 	tomlConfig.RPC.Unsafe = true
 	tomlConfig.RPC.WSUnsafe = true

tests/rpc/rpc_02-author_test.go

@@ -29,7 +29,6 @@ func TestAuthorSubmitExtrinsic(t *testing.T) {
 	tomlConfig := config.Default()
 	tomlConfig.Account.Key = "alice"
 	tomlConfig.Init.Genesis = genesisPath
-	tomlConfig.Core.BABELead = true
 
 	node := node.New(t, tomlConfig)
 	ctx, cancel := context.WithCancel(context.Background())
@@ -100,7 +99,6 @@ func TestAuthorRPC(t *testing.T) { //nolint:tparallel
 	genesisPath := libutils.GetWestendDevRawGenesisPath(t)
 	tomlConfig := config.Default()
 	tomlConfig.Init.Genesis = genesisPath
-	tomlConfig.Core.BABELead = true
 	node := node.New(t, tomlConfig)
 	ctx, cancel := context.WithCancel(context.Background())
 	node.InitAndStartTest(ctx, t, cancel)

tests/rpc/rpc_03-chain_test.go

@@ -33,7 +33,6 @@ func TestChainRPC(t *testing.T) {
 	genesisPath := libutils.GetWestendDevRawGenesisPath(t)
 	tomlConfig := config.Default()
 	tomlConfig.Init.Genesis = genesisPath
-	tomlConfig.Core.BABELead = true
 
 	node := node.New(t, tomlConfig)
 	ctx, cancel := context.WithCancel(context.Background())
@@ -138,7 +137,6 @@ func TestChainSubscriptionRPC(t *testing.T) { //nolint:tparallel
 	genesisPath := libutils.GetWestendDevRawGenesisPath(t)
 	tomlConfig := config.Default()
 	tomlConfig.Init.Genesis = genesisPath
-	tomlConfig.Core.BABELead = true
 	tomlConfig.RPC.WS = true // WS port is set in the node.New constructor
 	node := node.New(t, tomlConfig)
 	ctx, cancel := context.WithCancel(context.Background())

tests/rpc/rpc_04-offchain_test.go

@@ -17,7 +17,6 @@ func TestOffchainRPC(t *testing.T) { //nolint:tparallel
 
 	genesisPath := libutils.GetWestendDevRawGenesisPath(t)
 	tomlConfig := config.Default()
-	tomlConfig.Core.BABELead = true
 	tomlConfig.Init.Genesis = genesisPath
 	node := node.New(t, tomlConfig)
 	ctx, cancel := context.WithCancel(context.Background())

tests/rpc/rpc_05-state_test.go

@@ -22,7 +22,6 @@ func TestStateRPCResponseValidation(t *testing.T) { //nolint:tparallel
 	genesisPath := libutils.GetWestendDevRawGenesisPath(t)
 	tomlConfig := config.Default()
 	tomlConfig.Init.Genesis = genesisPath
-	tomlConfig.Core.BABELead = true
 	node := node.New(t, tomlConfig)
 	ctx, cancel := context.WithCancel(context.Background())
 	node.InitAndStartTest(ctx, t, cancel)
@@ -165,7 +164,6 @@ func TestStateRPCAPI(t *testing.T) {
 	genesisPath := libutils.GetWestendLocalRawGenesisPath(t)
 	tomlConfig := config.Default()
 	tomlConfig.Init.Genesis = genesisPath
-	tomlConfig.Core.BABELead = true
 	node := node.New(t, tomlConfig)
 	ctx, cancel := context.WithCancel(context.Background())
 	node.InitAndStartTest(ctx, t, cancel)
@@ -367,7 +365,6 @@ func TestStateRPCAPI(t *testing.T) {
 func TestRPCStructParamUnmarshal(t *testing.T) {
 	genesisPath := libutils.GetWestendDevRawGenesisPath(t)
 	tomlConfig := config.Default()
-	tomlConfig.Core.BABELead = true
 	tomlConfig.Init.Genesis = genesisPath
 	node := node.New(t, tomlConfig)
 	ctx, cancel := context.WithCancel(context.Background())

tests/rpc/rpc_06-engine_test.go

@@ -18,7 +18,6 @@ func TestEngineRPC(t *testing.T) { //nolint:tparallel
 	genesisPath := libutils.GetWestendDevRawGenesisPath(t)
 	tomlConfig := config.Default()
 	tomlConfig.Init.Genesis = genesisPath
-	tomlConfig.Core.BABELead = true
 	node := node.New(t, tomlConfig)
 	ctx, cancel := context.WithCancel(context.Background())
 	node.InitAndStartTest(ctx, t, cancel)

tests/rpc/rpc_07-payment_test.go

@@ -18,7 +18,6 @@ func TestPaymentRPC(t *testing.T) { //nolint:tparallel
 	genesisPath := libutils.GetWestendDevRawGenesisPath(t)
 	tomlConfig := config.Default()
 	tomlConfig.Init.Genesis = genesisPath
-	tomlConfig.Core.BABELead = true
 	node := node.New(t, tomlConfig)
 	ctx, cancel := context.WithCancel(context.Background())
 	node.InitAndStartTest(ctx, t, cancel)

tests/rpc/rpc_08-contracts_test.go

@@ -18,7 +18,6 @@ func TestContractsRPC(t *testing.T) { //nolint:tparallel
 	genesisPath := libutils.GetWestendDevRawGenesisPath(t)
 	tomlConfig := config.Default()
 	tomlConfig.Init.Genesis = genesisPath
-	tomlConfig.Core.BABELead = true
 	node := node.New(t, tomlConfig)
 	ctx, cancel := context.WithCancel(context.Background())
 	node.InitAndStartTest(ctx, t, cancel)

tests/rpc/rpc_09-babe_test.go

@@ -18,7 +18,6 @@ func TestBabeRPC(t *testing.T) { //nolint:tparallel
 	genesisPath := libutils.GetWestendDevRawGenesisPath(t)
 	tomlConfig := config.Default()
 	tomlConfig.Init.Genesis = genesisPath
-	tomlConfig.Core.BABELead = true
 	node := node.New(t, tomlConfig)
 	ctx, cancel := context.WithCancel(context.Background())
 	node.InitAndStartTest(ctx, t, cancel)

tests/stress/grandpa_test.go

@@ -20,7 +20,6 @@ import (
 func TestStress_Grandpa_OneAuthority(t *testing.T) {
 	genesisPath := libutils.GetWestendDevRawGenesisPath(t)
 	tomlConfig := config.Default()
-	tomlConfig.Core.BABELead = true
 	tomlConfig.Init.Genesis = genesisPath
 	n := node.New(t, tomlConfig)