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

@@ -25,11 +25,17 @@ import (
 	tmtime "github.com/tendermint/tendermint/libs/time"
 	"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"`
@@ -67,7 +73,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
 }
@@ -97,7 +103,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)
@@ -126,7 +132,6 @@ func initFiles(_ *cobra.Command, config *Config, _ []string) error {
 	tendermintCfg.P2P.ListenAddress = p2pAddress
 
 	tendermintCfg.P2P.AllowDuplicateIP = true
-	tendermintCfg.Mode = cfg.ModeValidator
 
 	tendermintCfg.SetRoot(config.RootDir)
 	if err := tendermintCfg.ValidateBasic(); err != nil {
@@ -136,15 +141,19 @@ 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.Mode = cfg.ModeValidator
 		tendermintCfg.P2P.AddrBookStrict = false
-	case "sentry": // even though "sentry" nodes are documented, there is no special mode
+	case SENTRY: // even though "sentry" nodes are documented, there is no special mode
 		tendermintCfg.P2P.PexReactor = true
 		tendermintCfg.Mode = cfg.ModeFull
 		tendermintCfg.P2P.AddrBookStrict = false
-	case "seed":
+	case SEED:
 		tendermintCfg.P2P.PexReactor = true
 		tendermintCfg.Mode = cfg.ModeSeed
 		tendermintCfg.P2P.AddrBookStrict = false
@@ -179,7 +188,7 @@ func adjustPort(address string, keyperIndex int) (string, error) {
 
 func initFilesWithConfig(tendermintConfig *cfg.Config, config *Config, appState app.GenesisAppState) error {
 	var err error
-	if config.Role == VALIDATOR {
+	if slices.Contains([]string{VALIDATOR, ISOLATEDVALIDATOR}, config.Role) {
 		// private validator
 		privValKeyFile := tendermintConfig.PrivValidator.KeyFile()
 		privValStateFile := tendermintConfig.PrivValidator.StateFile()

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.7.0
+	golang.org/x/exp v0.0.0-20230811145659-89c5cff77bcb
 	golang.org/x/sync v0.1.0
 	google.golang.org/protobuf v1.30.0
 	gotest.tools v2.2.0+incompatible
@@ -215,7 +216,6 @@ require (
 	go.uber.org/fx v1.19.3 // indirect
 	go.uber.org/multierr v1.11.0 // indirect
 	go.uber.org/zap v1.24.0 // indirect
-	golang.org/x/exp v0.0.0-20230811145659-89c5cff77bcb // indirect
 	golang.org/x/mod v0.11.0 // indirect
 	golang.org/x/net v0.8.0 // indirect
 	golang.org/x/sys v0.11.0 // indirect