cmd: rename simnet flag (#301)

Renames `--simnet` to `--simnet-beacon-mock` to align it with `--simnet-validator-mock` and to differentiate it from general network selection which it isn't. Charon doesn't require network selection, it uses whatever beacon node it is connected to. Similar to teku `--network=auto`. category: refactor ticket: none
ObolNetwork · Mar 29, 2022 · 1de96c5 · 1de96c5
1 parent 6d9ae0a
commit 1de96c5
Show file tree

Hide file tree

Showing 6 changed files with 10 additions and 10 deletions.
diff --git a/app/app.go b/app/app.go
@@ -67,7 +67,7 @@ type Config struct {
 	ValidatorAPIAddr string
 	BeaconNodeAddr   string
 	JaegerAddr       string
-	Simnet           bool
+	SimnetBMock      bool
 	SimnetVMock      bool
 
 	TestConfig TestConfig
@@ -245,7 +245,7 @@ func wireCoreWorkflow(ctx context.Context, life *lifecycle.Manager, conf Config,
 
 	// Configure the beacon node api.
 	var eth2Cl eth2client.Service
-	if conf.Simnet {
+	if conf.SimnetBMock {
 		// Configure the beacon mock.
 		opts := []beaconmock.Option{
 			beaconmock.WithSlotDuration(time.Second),
@@ -433,7 +433,7 @@ func (h httpServeHook) Call(context.Context) error {
 // wireValidatorMock wires the validator mock if enabled. The validator mock attestions
 // will be triggered by scheduler's DutyAttester. It connects via http validatorapi.Router.
 func wireValidatorMock(conf Config, pubshares []eth2p0.BLSPubKey, sched core.Scheduler) error {
-	if !conf.Simnet || !conf.SimnetVMock {
+	if !conf.SimnetBMock || !conf.SimnetVMock {
 		return nil
 	}
 

diff --git a/app/app_test.go b/app/app_test.go
@@ -119,7 +119,7 @@ func pingCluster(t *testing.T, test pingTest) {
 	for i := 0; i < n; i++ {
 		conf := app.Config{
 			Log:              log.DefaultConfig(),
-			Simnet:           true,
+			SimnetBMock:      true,
 			MonitoringAddr:   testutil.AvailableAddr(t).String(), // Random monitoring address
 			ValidatorAPIAddr: testutil.AvailableAddr(t).String(), // Random validatorapi address
 			TestConfig: app.TestConfig{

diff --git a/app/simnet_test.go b/app/simnet_test.go
@@ -127,7 +127,7 @@ func testSimnet(t *testing.T, args simnetArgs) {
 	for i := 0; i < args.N; i++ {
 		conf := app.Config{
 			Log:              log.DefaultConfig(),
-			Simnet:           true,
+			SimnetBMock:      true,
 			SimnetVMock:      args.VMocks[i],
 			MonitoringAddr:   testutil.AvailableAddr(t).String(), // Random monitoring address
 			ValidatorAPIAddr: args.VAPIAddrs[i],

diff --git a/cmd/gen_simnet.go b/cmd/gen_simnet.go
@@ -284,7 +284,7 @@ func writeRunScript(clusterDir string, nodeDir string, charonBin string, monitor
 	flags = append(flags, fmt.Sprintf("--validator-api-address=\"127.0.0.1:%d\"", validatorAPIPort))
 	flags = append(flags, fmt.Sprintf("--p2p-tcp-address=%s", tcpAddr))
 	flags = append(flags, fmt.Sprintf("--p2p-udp-address=%s", udpAddr))
-	flags = append(flags, "--simnet")
+	flags = append(flags, "--simnet-beacon-mock")
 	flags = append(flags, "--simnet-validator-mock")
 
 	tmpl, err := template.New("").Parse(scriptTmpl)

diff --git a/cmd/run.go b/cmd/run.go
@@ -56,8 +56,8 @@ func bindRunFlags(flags *pflag.FlagSet, config *app.Config) {
 	flags.StringVar(&config.ValidatorAPIAddr, "validator-api-address", "127.0.0.1:3500", "Listening address (ip and port) for validator-facing traffic proxying the beacon-node API")
 	flags.StringVar(&config.MonitoringAddr, "monitoring-address", "127.0.0.1:8088", "Listening address (ip and port) for the monitoring API (prometheus, pprof)")
 	flags.StringVar(&config.JaegerAddr, "jaeger-address", "", "Listening address for jaeger tracing")
-	flags.BoolVar(&config.Simnet, "simnet", false, "Enables simnet, starts and connects to an internal mock beacon node.")
-	flags.BoolVar(&config.SimnetVMock, "simnet-validator-mock", false, "Enables an internal mock validator client when running simnet.")
+	flags.BoolVar(&config.SimnetBMock, "simnet-beacon-mock", false, "Enables an internal mock beacon node for running a simnet.")
+	flags.BoolVar(&config.SimnetVMock, "simnet-validator-mock", false, "Enables an internal mock validator client when running a simnet. Requires simnet-beacon-mock.")
 }
 
 func bindLogFlags(flags *pflag.FlagSet, config *log.Config) {

diff --git a/docs/configuration.md b/docs/configuration.md
@@ -38,8 +38,8 @@ Flags:
       --p2p-peerdb string              Path to store a discv5 peer database. Empty default results in in-memory database.
       --p2p-tcp-address strings        Comma-separated list of listening TCP addresses (ip and port) for LibP2P traffic (default [127.0.0.1:13900])
       --p2p-udp-address string         Listening UDP address (ip and port) for Discv5 discovery (default "127.0.0.1:30309")
-      --simnet                         Enables simnet, starts and connects to an internal mock beacon node.
-      --simnet-validator-mock          Enables an internal mock validator client when running simnet.
+      --simnet-beacon-mock             Enables an internal mock beacon node for running a simnet.
+      --simnet-validator-mock          Enables an internal mock validator client when running a simnet. Requires simnet-beacon-mock.
       --validator-api-address string   Listening address (ip and port) for validator-facing traffic proxying the beacon-node API (default "127.0.0.1:3500")
 
 ````