Change chain init roles

This changes the `validator` role to create a configuration for a
network exposed validator. The previous setting, where
`--role validator` set the parameters for an isolated validator behind a
`sentry` mode can now be configured by using
`--role isolated-validator`.

This is now more in line with the setup used in
https://github.com/shutter-network/snapshot-keyper which means less
configuration changes are needed during the setup.

It also allows for a simpler local docker compose test setup.

Author: konradkonrad

rolling-shutter/cmd/chain/init.go

@@ -23,11 +23,17 @@ import (
 	"github.com/tendermint/tendermint/p2p"
 	"github.com/tendermint/tendermint/privval"
 	"github.com/tendermint/tendermint/types"
+	"golang.org/x/exp/slices"
 
 	"github.com/shutter-network/rolling-shutter/rolling-shutter/app"
 )
 
-const VALIDATOR = "validator"
+const (
+	VALIDATOR         = "validator"
+	ISOLATEDVALIDATOR = "isolated-validator"
+	SENTRY            = "sentry"
+	SEED              = "seed"
+)
 
 type Config struct {
 	RootDir       string   `mapstructure:"root"`
@@ -65,7 +71,7 @@ func initCmd() *cobra.Command {
 	cmd.PersistentFlags().Float64("blocktime", 1.0, "block time in seconds")
 	cmd.PersistentFlags().StringSlice("genesis-keyper", nil, "genesis keyper address")
 	cmd.PersistentFlags().String("listen-address", "tcp://127.0.0.1:26657", "tendermint RPC listen address")
-	cmd.PersistentFlags().String("role", "validator", "tendermint node role (validator, sentry, seed)")
+	cmd.PersistentFlags().String("role", "validator", "tendermint node role (validator, isolated-validator, sentry, seed)")
 	cmd.PersistentFlags().Uint64("initial-eon", 0, "initial eon")
 	return cmd
 }
@@ -95,7 +101,7 @@ func getArgFromViper[T interface{}](getter func(string) T, name string, required
 func initFiles(_ *cobra.Command, config *Config, _ []string) error {
 	keypers := []common.Address{}
 
-	if config.Role == VALIDATOR {
+	if slices.Contains([]string{VALIDATOR, ISOLATEDVALIDATOR}, config.Role) {
 		for _, a := range config.GenesisKeyper {
 			if !common.IsHexAddress(a) {
 				return errors.Errorf("--genesis-keyper argument '%s' is not an address", a)
@@ -133,13 +139,17 @@ func initFiles(_ *cobra.Command, config *Config, _ []string) error {
 
 	// set up according to the network role: https://docs.tendermint.com/v0.34/tendermint-core/validators.html
 	switch config.Role {
-	case VALIDATOR:
+	case VALIDATOR: // standard validator mode, network exposed
+		tendermintCfg.P2P.PexReactor = true
+		tendermintCfg.Mode = cfg.ModeValidator
+		tendermintCfg.P2P.AddrBookStrict = true
+	case ISOLATEDVALIDATOR: // validator mode behind a sentry node
 		tendermintCfg.P2P.PexReactor = false
 		tendermintCfg.P2P.AddrBookStrict = false
-	case "sentry":
+	case SENTRY: // even though "sentry" nodes are documented, there is no special mode
 		tendermintCfg.P2P.PexReactor = true
 		tendermintCfg.P2P.AddrBookStrict = false
-	case "seed":
+	case SEED:
 		tendermintCfg.P2P.PexReactor = true
 		tendermintCfg.P2P.AddrBookStrict = false
 	default:
@@ -170,24 +180,25 @@ func adjustPort(address string, keyperIndex int) (string, error) {
 
 func initFilesWithConfig(tendermintConfig *cfg.Config, config *Config, appState app.GenesisAppState) error {
 	var err error
-	// private validator
-	privValKeyFile := tendermintConfig.PrivValidatorKeyFile()
-	privValStateFile := tendermintConfig.PrivValidatorStateFile()
-	var pv *privval.FilePV
-	if tmos.FileExists(privValKeyFile) {
-		pv = privval.LoadFilePV(privValKeyFile, privValStateFile)
-		log.Info().
-			Str("privValKeyFile", privValKeyFile).
-			Str("stateFile", privValStateFile).
-			Msg("Found private validator")
-	} else {
-		pv = privval.GenFilePV(privValKeyFile, privValStateFile)
-		pv.Save()
-		log.Info().
-			Str("privValKeyFile", privValKeyFile).
-			Str("stateFile", privValStateFile).
-			Msg("Generated private validator")
-	}
+	if slices.Contains([]string{VALIDATOR, ISOLATEDVALIDATOR}, config.Role) {
+		// private validator
+		privValKeyFile := tendermintConfig.PrivValidatorKeyFile()
+		privValStateFile := tendermintConfig.PrivValidatorStateFile()
+		var pv *privval.FilePV
+		if tmos.FileExists(privValKeyFile) {
+			pv = privval.LoadFilePV(privValKeyFile, privValStateFile)
+			log.Info().
+				Str("privValKeyFile", privValKeyFile).
+				Str("stateFile", privValStateFile).
+				Msg("Found private validator")
+		} else {
+			pv = privval.GenFilePV(privValKeyFile, privValStateFile)
+			pv.Save()
+			log.Info().
+				Str("privValKeyFile", privValKeyFile).
+				Str("stateFile", privValStateFile).
+				Msg("Generated private validator")
+		}
 
 	validatorPubKeyPath := filepath.Join(tendermintConfig.RootDir, "config", "priv_validator_pubkey.hex")
 	validatorPublicKeyHex := hex.EncodeToString(pv.Key.PubKey.Bytes())
@@ -227,7 +238,7 @@ func initFilesWithConfig(tendermintConfig *cfg.Config, config *Config, appState
 		}
 		log.Info().Str("path", genFile).Msg("Generated genesis file")
 	}
-
+	
 	nodeKeyFile := tendermintConfig.NodeKeyFile()
 	if tmos.FileExists(nodeKeyFile) {
 		log.Info().Str("path", nodeKeyFile).Msg("Found node key")

rolling-shutter/docs/rolling-shutter_chain_init.md

@@ -16,7 +16,7 @@ rolling-shutter chain init [flags]
       --index int                keyper index
       --initial-eon uint         initial eon
       --listen-address string    tendermint RPC listen address (default "tcp://127.0.0.1:26657")
-      --role string              tendermint node role (validator, sentry, seed) (default "validator")
+      --role string              tendermint node role (validator, isolated-validator, sentry, seed) (default "validator")
       --root string              root directory
 ```
 

rolling-shutter/go.mod

@@ -42,6 +42,7 @@ require (
 	go.opentelemetry.io/otel/trace v1.14.0
 	go.opentelemetry.io/proto/otlp v0.19.0
 	golang.org/x/crypto v0.12.0
+	golang.org/x/exp v0.0.0-20230817173708-d852ddb80c63
 	golang.org/x/sync v0.3.0
 	google.golang.org/protobuf v1.30.0
 	gotest.tools v2.2.0+incompatible
@@ -215,7 +216,6 @@ require (
 	go.uber.org/fx v1.20.0 // indirect
 	go.uber.org/multierr v1.11.0 // indirect
 	go.uber.org/zap v1.25.0 // indirect
-	golang.org/x/exp v0.0.0-20230817173708-d852ddb80c63 // indirect
 	golang.org/x/mod v0.12.0 // indirect
 	golang.org/x/net v0.14.0 // indirect
 	golang.org/x/sys v0.11.0 // indirect