PR#518 and PR#529 -> qa (ethereum#532)

* Added script to generate config.toml fromstart.sh (ethereum#518)

* added go and bash script to get config out of start.sh and updated flagset.go

* changed 'requiredblocks' flag back to 'eth.requiredblocks'

* updated script

* changed 'requiredblocks' flag back to 'eth.requiredblocks'

* updated tests, and removed requiredblocks from json and hcl

* addressed comments

* internal/cli/server: fix flag behaviour (ethereum#529)

* remove setting maxpeers to 0 for nodiscover flag

* set default prometheus and open-collector endpoint

* skip building grpc address from pprof address and port

* fix: linters

* fix and improve tests

* use loopback address for prometheus and open-collector endpoint

* add logs for prometheus and open-collector setup

* updated the script to handle prometheus-addr

* updated builder/files/config.toml

Co-authored-by: Pratik Patil <pratikspatil024@gmail.com>

Co-authored-by: Manav Darji <manavdarji.india@gmail.com>

builder/files/config.toml

@@ -96,8 +96,8 @@ syncmode = "full"
 [telemetry]
   metrics = true
   # expensive = false
-  prometheus-addr = "127.0.0.1:7071"
-  # opencollector-endpoint = ""
+  # prometheus-addr = "127.0.0.1:7071"
+  # opencollector-endpoint = "127.0.0.1:4317"
   # [telemetry.influx]
     # influxdb = false
     # endpoint = ""

go.mod

@@ -119,6 +119,7 @@ require (
 	github.com/mitchellh/pointerstructure v1.2.0 // indirect
 	github.com/mitchellh/reflectwalk v1.0.0 // indirect
 	github.com/opentracing/opentracing-go v1.1.0 // indirect
+	github.com/pelletier/go-toml v1.9.5 // indirect
 	github.com/pkg/errors v0.9.1 // indirect
 	github.com/pmezard/go-difflib v1.0.0 // indirect
 	github.com/posener/complete v1.1.1 // indirect

go.sum

@@ -391,6 +391,8 @@ github.com/opentracing/opentracing-go v1.0.3-0.20180606204148-bd9c31933947/go.mo
 github.com/opentracing/opentracing-go v1.1.0 h1:pWlfV3Bxv7k65HYwkikxat0+s3pV4bsqf19k25Ur8rU=
 github.com/opentracing/opentracing-go v1.1.0/go.mod h1:UkNAQd3GIcIGf0SeVgPpRdFStlNbqXla1AfSYxPUl2o=
 github.com/paulbellamy/ratecounter v0.2.0/go.mod h1:Hfx1hDpSGoqxkVVpBi/IlYD7kChlfo5C6hzIHwPqfFE=
+github.com/pelletier/go-toml v1.9.5 h1:4yBQzkHv+7BHq2PQUZF3Mx0IYxG7LsP222s7Agd3ve8=
+github.com/pelletier/go-toml v1.9.5/go.mod h1:u1nR/EPcESfeI/szUZKdtJ0xRNbUoANCkoOuaOx1Y+c=
 github.com/peterh/liner v1.0.1-0.20180619022028-8c1271fcf47f/go.mod h1:xIteQHvHuaLYG9IFj6mSxM0fCKrs34IrEQUhOYuGPHc=
 github.com/peterh/liner v1.1.1-0.20190123174540-a2c9a5303de7 h1:oYW+YCJ1pachXTQmzR3rNLYGGz4g/UgFcjb28p/viDM=
 github.com/peterh/liner v1.1.1-0.20190123174540-a2c9a5303de7/go.mod h1:CRroGNssyjTd/qIG2FyxByd2S8JEAZXBl4qUrZf8GS0=

internal/cli/flagset/flagset.go

@@ -44,6 +44,15 @@ func (f *Flagset) Help() string {
 	return str + strings.Join(items, "\n\n")
 }
 
+func (f *Flagset) GetAllFlags() []string {
+	flags := []string{}
+	for _, flag := range f.flags {
+		flags = append(flags, flag.Name)
+	}
+
+	return flags
+}
+
 // MarkDown implements cli.MarkDown interface
 func (f *Flagset) MarkDown() string {
 	if len(f.flags) == 0 {

internal/cli/server/config.go

@@ -475,8 +475,8 @@ func DefaultConfig() *Config {
 		Telemetry: &TelemetryConfig{
 			Enabled:               false,
 			Expensive:             false,
-			PrometheusAddr:        "",
-			OpenCollectorEndpoint: "",
+			PrometheusAddr:        "127.0.0.1:7071",
+			OpenCollectorEndpoint: "127.0.0.1:4317",
 			InfluxDB: &InfluxDBConfig{
 				V1Enabled:    false,
 				Endpoint:     "",
@@ -991,8 +991,7 @@ func (c *Config) buildNode() (*node.Config, error) {
 	}
 
 	if c.P2P.NoDiscover {
-		// Disable networking, for now, we will not even allow incomming connections
-		cfg.P2P.MaxPeers = 0
+		// Disable peer discovery
 		cfg.P2P.NoDiscovery = true
 	}
 

internal/cli/server/config_legacy_test.go

@@ -6,9 +6,6 @@ import (
 	"time"
 
 	"github.com/stretchr/testify/assert"
-
-	"github.com/ethereum/go-ethereum/eth/ethconfig"
-	"github.com/ethereum/go-ethereum/params"
 )
 
 func TestConfigLegacy(t *testing.T) {
@@ -17,139 +14,23 @@ func TestConfigLegacy(t *testing.T) {
 		expectedConfig, err := readLegacyConfig(path)
 		assert.NoError(t, err)
 
-		testConfig := &Config{
-			Chain:    "mainnet",
-			Identity: Hostname(),
-			RequiredBlocks: map[string]string{
-				"a": "b",
-			},
-			LogLevel: "INFO",
-			DataDir:  "./data",
-			P2P: &P2PConfig{
-				MaxPeers:     30,
-				MaxPendPeers: 50,
-				Bind:         "0.0.0.0",
-				Port:         30303,
-				NoDiscover:   false,
-				NAT:          "any",
-				Discovery: &P2PDiscovery{
-					V5Enabled:    false,
-					Bootnodes:    []string{},
-					BootnodesV4:  []string{},
-					BootnodesV5:  []string{},
-					StaticNodes:  []string{},
-					TrustedNodes: []string{},
-					DNS:          []string{},
-				},
-			},
-			Heimdall: &HeimdallConfig{
-				URL:     "http://localhost:1317",
-				Without: false,
-			},
-			SyncMode: "full",
-			GcMode:   "full",
-			Snapshot: true,
-			TxPool: &TxPoolConfig{
-				Locals:       []string{},
-				NoLocals:     false,
-				Journal:      "transactions.rlp",
-				Rejournal:    1 * time.Hour,
-				PriceLimit:   30000000000,
-				PriceBump:    10,
-				AccountSlots: 16,
-				GlobalSlots:  32768,
-				AccountQueue: 16,
-				GlobalQueue:  32768,
-				LifeTime:     1 * time.Second,
-			},
-			Sealer: &SealerConfig{
-				Enabled:   false,
-				Etherbase: "",
-				GasCeil:   30000000,
-				GasPrice:  big.NewInt(1 * params.GWei),
-				ExtraData: "",
-			},
-			Gpo: &GpoConfig{
-				Blocks:      20,
-				Percentile:  60,
-				MaxPrice:    big.NewInt(5000 * params.GWei),
-				IgnorePrice: big.NewInt(4),
-			},
-			JsonRPC: &JsonRPCConfig{
-				IPCDisable: false,
-				IPCPath:    "",
-				GasCap:     ethconfig.Defaults.RPCGasCap,
-				TxFeeCap:   ethconfig.Defaults.RPCTxFeeCap,
-				Http: &APIConfig{
-					Enabled: false,
-					Port:    8545,
-					Prefix:  "",
-					Host:    "localhost",
-					API:     []string{"eth", "net", "web3", "txpool", "bor"},
-					Cors:    []string{"localhost"},
-					VHost:   []string{"localhost"},
-				},
-				Ws: &APIConfig{
-					Enabled: false,
-					Port:    8546,
-					Prefix:  "",
-					Host:    "localhost",
-					API:     []string{"net", "web3"},
-					Cors:    []string{"localhost"},
-					VHost:   []string{"localhost"},
-				},
-				Graphql: &APIConfig{
-					Enabled: false,
-					Cors:    []string{"localhost"},
-					VHost:   []string{"localhost"},
-				},
-			},
-			Ethstats: "",
-			Telemetry: &TelemetryConfig{
-				Enabled:               false,
-				Expensive:             false,
-				PrometheusAddr:        "",
-				OpenCollectorEndpoint: "",
-				InfluxDB: &InfluxDBConfig{
-					V1Enabled:    false,
-					Endpoint:     "",
-					Database:     "",
-					Username:     "",
-					Password:     "",
-					Tags:         map[string]string{},
-					V2Enabled:    false,
-					Token:        "",
-					Bucket:       "",
-					Organization: "",
-				},
-			},
-			Cache: &CacheConfig{
-				Cache:         1024,
-				PercDatabase:  50,
-				PercTrie:      15,
-				PercGc:        25,
-				PercSnapshot:  10,
-				Journal:       "triecache",
-				Rejournal:     1 * time.Second,
-				NoPrefetch:    false,
-				Preimages:     false,
-				TxLookupLimit: 2350000,
-			},
-			Accounts: &AccountsConfig{
-				Unlock:              []string{},
-				PasswordFile:        "",
-				AllowInsecureUnlock: false,
-				UseLightweightKDF:   false,
-				DisableBorWallet:    true,
-			},
-			GRPC: &GRPCConfig{
-				Addr: ":3131",
-			},
-			Developer: &DeveloperConfig{
-				Enabled: false,
-				Period:  0,
-			},
+		testConfig := DefaultConfig()
+
+		testConfig.DataDir = "./data"
+		testConfig.Snapshot = false
+		testConfig.RequiredBlocks = map[string]string{
+			"31000000": "0x2087b9e2b353209c2c21e370c82daa12278efd0fe5f0febe6c29035352cf050e",
+			"32000000": "0x875500011e5eecc0c554f95d07b31cf59df4ca2505f4dbbfffa7d4e4da917c68",
 		}
+		testConfig.P2P.MaxPeers = 30
+		testConfig.TxPool.Locals = []string{}
+		testConfig.TxPool.LifeTime = time.Second
+		testConfig.Sealer.Enabled = true
+		testConfig.Sealer.GasCeil = 30000000
+		testConfig.Sealer.GasPrice = big.NewInt(1000000000)
+		testConfig.Gpo.IgnorePrice = big.NewInt(4)
+		testConfig.Cache.Cache = 1024
+		testConfig.Cache.Rejournal = time.Second
 
 		assert.Equal(t, expectedConfig, testConfig)
 	}

internal/cli/server/flags.go

@@ -57,7 +57,7 @@ func (c *Command) Flags() *flagset.Flagset {
 	})
 	f.MapStringFlag(&flagset.MapStringFlag{
 		Name:  "eth.requiredblocks",
-		Usage: "Comma separated block number-to-hash mappings to enforce (<number>=<hash>)",
+		Usage: "Comma separated block number-to-hash mappings to require for peering (<number>=<hash>)",
 		Value: &c.cliConfig.RequiredBlocks,
 	})
 	f.BoolFlag(&flagset.BoolFlag{

internal/cli/server/server.go

@@ -281,6 +281,8 @@ func (s *Server) setupMetrics(config *TelemetryConfig, serviceName string) error
 			}
 		}()
 
+		log.Info("Enabling metrics export to prometheus", "path", fmt.Sprintf("http://%s/debug/metrics/prometheus", config.PrometheusAddr))
+
 	}
 
 	if config.OpenCollectorEndpoint != "" {
@@ -322,6 +324,8 @@ func (s *Server) setupMetrics(config *TelemetryConfig, serviceName string) error
 
 		// set the tracer
 		s.tracer = tracerProvider
+
+		log.Info("Open collector tracing started", "address", config.OpenCollectorEndpoint)
 	}
 
 	return nil

internal/cli/server/testdata/test.toml

@@ -1,7 +1,9 @@
 datadir = "./data"
+snapshot = false
 
 ["eth.requiredblocks"]
-a = "b"
+"31000000" = "0x2087b9e2b353209c2c21e370c82daa12278efd0fe5f0febe6c29035352cf050e"
+"32000000" = "0x875500011e5eecc0c554f95d07b31cf59df4ca2505f4dbbfffa7d4e4da917c68"
 
 [p2p]
 maxpeers = 30
@@ -11,7 +13,7 @@ locals = []
 lifetime = "1s"
 
 [miner]
-mine = false
+mine = true
 gaslimit = 30000000
 gasprice = "1000000000"