.github/workflows/ci.yml

@@ -13,3 +13,8 @@ jobs:
         run: make all
       - name: "Run tests"
         run: make test
+      - name: Upload coverage to Codecov
+        uses: codecov/codecov-action@v1
+        with:
+          file: ./cover.out
+

Makefile

@@ -50,7 +50,7 @@ ios:
 
 test:
 	# Skip mobile and cmd tests since they are being deprecated
-	go test -v $$(go list ./... | grep -v go-ethereum/cmd/)
+	go test -v $$(go list ./... | grep -v go-ethereum/cmd/) -cover -coverprofile=cover.out
 
 lint: ## Run linters.
 	$(GORUN) build/ci.go lint

consensus/bor/bor.go

@@ -116,6 +116,9 @@ var (
 	// errOutOfRangeChain is returned if an authorization list is attempted to
 	// be modified via out-of-range or non-contiguous headers.
 	errOutOfRangeChain = errors.New("out of range or non-contiguous chain")
+
+	// errShutdownDetected is returned if a shutdown was detected
+	errShutdownDetected = errors.New("shutdown detected")
 )
 
 // SignerFn is a signer callback function to request a header to be signed by a
@@ -916,6 +919,7 @@ func (c *Bor) APIs(chain consensus.ChainHeaderReader) []rpc.API {
 
 // Close implements consensus.Engine. It's a noop for bor as there are no background threads.
 func (c *Bor) Close() error {
+	c.HeimdallClient.Close()
 	return nil
 }
 

consensus/bor/rest.go

@@ -27,11 +27,13 @@ type IHeimdallClient interface {
 	Fetch(path string, query string) (*ResponseWithHeight, error)
 	FetchWithRetry(path string, query string) (*ResponseWithHeight, error)
 	FetchStateSyncEvents(fromID uint64, to int64) ([]*EventRecordWithTime, error)
+	Close()
 }
 
 type HeimdallClient struct {
 	urlString string
 	client    http.Client
+	closeCh   chan struct{}
 }
 
 func NewHeimdallClient(urlString string) (*HeimdallClient, error) {
@@ -40,6 +42,7 @@ func NewHeimdallClient(urlString string) (*HeimdallClient, error) {
 		client: http.Client{
 			Timeout: time.Duration(5 * time.Second),
 		},
+		closeCh: make(chan struct{}),
 	}
 	return h, nil
 }
@@ -96,13 +99,22 @@ func (h *HeimdallClient) FetchWithRetry(rawPath string, rawQuery string) (*Respo
 	u.Path = rawPath
 	u.RawQuery = rawQuery
 
+	// create a new ticker for retrying the request
+	ticker := time.NewTicker(5 * time.Second)
+	defer ticker.Stop()
+
 	for {
-		res, err := h.internalFetch(u)
-		if err == nil && res != nil {
-			return res, nil
+		select {
+		case <-h.closeCh:
+			log.Debug("Shutdown detected, terminating request")
+			return nil, errShutdownDetected
+		case <-ticker.C:
+			res, err := h.internalFetch(u)
+			if err == nil && res != nil {
+				return res, nil
+			}
+			log.Info("Retrying again in 5 seconds for next Heimdall data", "path", u.Path)
 		}
-		log.Info("Retrying again in 5 seconds for next Heimdall span", "path", u.Path)
-		time.Sleep(5 * time.Second)
 	}
 }
 
@@ -137,3 +149,9 @@ func (h *HeimdallClient) internalFetch(u *url.URL) (*ResponseWithHeight, error)
 
 	return &response, nil
 }
+
+// Close sends a signal to stop the running process
+func (h *HeimdallClient) Close() {
+	close(h.closeCh)
+	h.client.CloseIdleConnections()
+}

docs/README.md

@@ -19,18 +19,4 @@ $ bor server
 $ bor server --config ./legacy.toml
 ```
 
-- Modules, vhost and Cors configuration are common for all jsonrpc endpoints.
-
-Before:
-
-```
-$ bor --http --http.modules "eth,web" --ws --ws.modules "eth,web"
-```
-
-Now: 
-
-```
-$ bor server --http --ws --jsonrpc.modules "eth,web"
-```
-
 - ```Admin```, ```Personal``` and account related endpoints in ```Eth``` are being removed from the JsonRPC interface. Some of this functionality will be moved to the new GRPC server for operational tasks.

docs/cli/server.md

@@ -109,8 +109,6 @@ The ```bor server``` command runs the Bor client.
 
 - ```jsonrpc.vhosts```: Comma separated list of virtual hostnames from which to accept requests (server enforced). Accepts '*' wildcard.
 
-- ```jsonrpc.modules```: API's offered over the HTTP-RPC interface.
-
 - ```http```: Enable the HTTP-RPC server.
 
 - ```http.addr```: HTTP-RPC server listening interface.
@@ -119,6 +117,8 @@ The ```bor server``` command runs the Bor client.
         
 - ```http.rpcprefix```: HTTP path path prefix on which JSON-RPC is served. Use '/' to serve on all paths.
 
+- ```http.modules```: API's offered over the HTTP-RPC interface.
+
 - ```ws```: Enable the WS-RPC server.
 
 - ```ws.addr```: WS-RPC server listening interface.
@@ -127,6 +127,8 @@ The ```bor server``` command runs the Bor client.
 
 - ```ws.rpcprefix```: HTTP path prefix on which JSON-RPC is served. Use '/' to serve on all paths.
 
+- ```ws.modules```: API's offered over the WS-RPC interface.
+
 - ```graphql```: Enable GraphQL on the HTTP-RPC server. Note that GraphQL can only be started if an HTTP server is started as well.
 
 ### P2P Options

eth/backend.go

@@ -581,10 +581,12 @@ func (s *Ethereum) Stop() error {
 	// Then stop everything else.
 	s.bloomIndexer.Close()
 	close(s.closeBloomHandler)
+
+	// closing consensus engine first, as miner has deps on it
+	s.engine.Close()
 	s.txPool.Stop()
-	s.miner.Close()
 	s.blockchain.Stop()
-	s.engine.Close()
+	s.miner.Close()
 	rawdb.PopUncleanShutdownMarker(s.chainDb)
 	s.chainDb.Close()
 	s.eventMux.Stop()

internal/cli/server/config.go

@@ -214,9 +214,6 @@ type JsonRPCConfig struct {
 	// IPCPath is the path of the ipc endpoint
 	IPCPath string `hcl:"ipc-path,optional"`
 
-	// Modules is the list of enabled api modules
-	Modules []string `hcl:"modules,optional"`
-
 	// VHost is the list of valid virtual hosts
 	VHost []string `hcl:"vhost,optional"`
 
@@ -256,6 +253,9 @@ type APIConfig struct {
 
 	// Host is the address to bind the api
 	Host string `hcl:"host,optional"`
+
+	// Modules is the list of enabled api modules
+	Modules []string `hcl:"modules,optional"`
 }
 
 type GpoConfig struct {
@@ -438,7 +438,6 @@ func DefaultConfig() *Config {
 		JsonRPC: &JsonRPCConfig{
 			IPCDisable: false,
 			IPCPath:    "",
-			Modules:    []string{"web3", "net"},
 			Cors:       []string{"*"},
 			VHost:      []string{"*"},
 			GasCap:     ethconfig.Defaults.RPCGasCap,
@@ -448,12 +447,14 @@ func DefaultConfig() *Config {
 				Port:    8545,
 				Prefix:  "",
 				Host:    "localhost",
+				Modules: []string{"web3", "net"},
 			},
 			Ws: &APIConfig{
 				Enabled: false,
 				Port:    8546,
 				Prefix:  "",
 				Host:    "localhost",
+				Modules: []string{"web3", "net"},
 			},
 			Graphql: &APIConfig{
 				Enabled: false,
@@ -851,11 +852,11 @@ func (c *Config) buildNode() (*node.Config, error) {
 			ListenAddr:      c.P2P.Bind + ":" + strconv.Itoa(int(c.P2P.Port)),
 			DiscoveryV5:     c.P2P.Discovery.V5Enabled,
 		},
-		HTTPModules:         c.JsonRPC.Modules,
+		HTTPModules:         c.JsonRPC.Http.Modules,
 		HTTPCors:            c.JsonRPC.Cors,
 		HTTPVirtualHosts:    c.JsonRPC.VHost,
 		HTTPPathPrefix:      c.JsonRPC.Http.Prefix,
-		WSModules:           c.JsonRPC.Modules,
+		WSModules:           c.JsonRPC.Ws.Modules,
 		WSOrigins:           c.JsonRPC.Cors,
 		WSPathPrefix:        c.JsonRPC.Ws.Prefix,
 		GraphQLCors:         c.JsonRPC.Cors,

internal/cli/server/flags.go

@@ -263,11 +263,6 @@ func (c *Command) Flags() *flagset.Flagset {
 		Usage: "Comma separated list of virtual hostnames from which to accept requests (server enforced). Accepts '*' wildcard.",
 		Value: &c.cliConfig.JsonRPC.VHost,
 	})
-	f.SliceStringFlag(&flagset.SliceStringFlag{
-		Name:  "jsonrpc.modules",
-		Usage: "API's offered over the HTTP-RPC interface",
-		Value: &c.cliConfig.JsonRPC.Modules,
-	})
 
 	// http options
 	f.BoolFlag(&flagset.BoolFlag{
@@ -290,6 +285,12 @@ func (c *Command) Flags() *flagset.Flagset {
 		Usage: "HTTP path path prefix on which JSON-RPC is served. Use '/' to serve on all paths.",
 		Value: &c.cliConfig.JsonRPC.Http.Prefix,
 	})
+	f.SliceStringFlag(&flagset.SliceStringFlag{
+		Name:  "http.modules",
+		Usage: "API's offered over the HTTP-RPC interface",
+		Value: &c.cliConfig.JsonRPC.Http.Modules,
+	})
+
 	// ws options
 	f.BoolFlag(&flagset.BoolFlag{
 		Name:  "ws",
@@ -311,6 +312,12 @@ func (c *Command) Flags() *flagset.Flagset {
 		Usage: "HTTP path prefix on which JSON-RPC is served. Use '/' to serve on all paths.",
 		Value: &c.cliConfig.JsonRPC.Ws.Prefix,
 	})
+	f.SliceStringFlag(&flagset.SliceStringFlag{
+		Name:  "ws.modules",
+		Usage: "API's offered over the WS-RPC interface",
+		Value: &c.cliConfig.JsonRPC.Ws.Modules,
+	})
+
 	// graphql options
 	f.BoolFlag(&flagset.BoolFlag{
 		Name:  "graphql",

internal/cli/server/server.go

@@ -96,7 +96,7 @@ func NewServer(config *Config) (*Server, error) {
 
 	// graphql is started from another place
 	if config.JsonRPC.Graphql.Enabled {
-		if err := graphql.New(stack, backend.APIBackend, config.JsonRPC.Cors, config.JsonRPC.Modules); err != nil {
+		if err := graphql.New(stack, backend.APIBackend, config.JsonRPC.Cors, config.JsonRPC.VHost); err != nil {
 			return nil, fmt.Errorf("failed to register the GraphQL service: %v", err)
 		}
 	}

renovate.json

+{
+  "$schema": "https://docs.renovatebot.com/renovate-schema.json",
+  "extends": [
+    "config:recommended"
+  ]
+}

tests/bor/mocks/IHeimdallClient.go

-// Code generated by mockery v1.0.0. DO NOT EDIT.
+// Code generated by mockery v2.10.0. DO NOT EDIT.
 
 package mocks
 
@@ -12,6 +12,11 @@ type IHeimdallClient struct {
 	mock.Mock
 }
 
+// Close provides a mock function with given fields:
+func (_m *IHeimdallClient) Close() {
+	_m.Called()
+}
+
 // Fetch provides a mock function with given fields: path, query
 func (_m *IHeimdallClient) Fetch(path string, query string) (*bor.ResponseWithHeight, error) {
 	ret := _m.Called(path, query)