cmd/utils, node: remove unused solc references and improve RPC config (#14324)

bas-vk · fjl · commit 5e29f4be935f · 2017-04-12T23:04:14.000+02:00
Currently http cors and websocket origins are a comma separated string in the
config object. These are replaced with string arrays that are more expressive in
case of a config file.
diff --git a/cmd/geth/main.go b/cmd/geth/main.go
@@ -140,7 +140,6 @@ func init() {
 		utils.MetricsEnabledFlag,
 		utils.FakePoWFlag,
 		utils.NoCompactionFlag,
-		utils.SolcPathFlag,
 		utils.GpoBlocksFlag,
 		utils.GpoPercentileFlag,
 		utils.ExtraDataFlag,
diff --git a/cmd/geth/usage.go b/cmd/geth/usage.go
@@ -174,12 +174,6 @@ var AppHelpFlagGroups = []flagGroup{
 			utils.WhisperEnabledFlag,
 		},
 	},
-	{
-		Name: "MISCELLANEOUS",
-		Flags: []cli.Flag{
-			utils.SolcPathFlag,
-		},
-	},
 }
 
 func init() {
diff --git a/cmd/utils/flags.go b/cmd/utils/flags.go
@@ -392,11 +392,6 @@ var (
 		Usage: "JavaScript root path for `loadScript`",
 		Value: ".",
 	}
-	SolcPathFlag = cli.StringFlag{
-		Name:  "solc",
-		Usage: "Solidity compiler command to be used",
-		Value: "solc",
-	}
 
 	// Gas price oracle settings
 	GpoBlocksFlag = cli.IntFlag{
@@ -528,9 +523,9 @@ func setNAT(ctx *cli.Context, cfg *p2p.Config) {
 	}
 }
 
-// makeRPCModules splits input separated by a comma and trims excessive white
-// space from the substrings.
-func makeRPCModules(input string) []string {
+// splitAndTrim splits input separated by a comma
+// and trims excessive white space from the substrings.
+func splitAndTrim(input string) []string {
 	result := strings.Split(input, ",")
 	for i, r := range result {
 		result[i] = strings.TrimSpace(r)
@@ -552,10 +547,10 @@ func setHTTP(ctx *cli.Context, cfg *node.Config) {
 		cfg.HTTPPort = ctx.GlobalInt(RPCPortFlag.Name)
 	}
 	if ctx.GlobalIsSet(RPCCORSDomainFlag.Name) {
-		cfg.HTTPCors = ctx.GlobalString(RPCCORSDomainFlag.Name)
+		cfg.HTTPCors = splitAndTrim(ctx.GlobalString(RPCCORSDomainFlag.Name))
 	}
 	if ctx.GlobalIsSet(RPCApiFlag.Name) {
-		cfg.HTTPModules = makeRPCModules(ctx.GlobalString(RPCApiFlag.Name))
+		cfg.HTTPModules = splitAndTrim(ctx.GlobalString(RPCApiFlag.Name))
 	}
 }
 
@@ -573,10 +568,10 @@ func setWS(ctx *cli.Context, cfg *node.Config) {
 		cfg.WSPort = ctx.GlobalInt(WSPortFlag.Name)
 	}
 	if ctx.GlobalIsSet(WSAllowedOriginsFlag.Name) {
-		cfg.WSOrigins = ctx.GlobalString(WSAllowedOriginsFlag.Name)
+		cfg.WSOrigins = splitAndTrim(ctx.GlobalString(WSAllowedOriginsFlag.Name))
 	}
 	if ctx.GlobalIsSet(WSApiFlag.Name) {
-		cfg.WSModules = makeRPCModules(ctx.GlobalString(WSApiFlag.Name))
+		cfg.WSModules = splitAndTrim(ctx.GlobalString(WSApiFlag.Name))
 	}
 }
 
@@ -828,10 +823,6 @@ func SetEthConfig(ctx *cli.Context, stack *node.Node, cfg *eth.Config) {
 	if ctx.GlobalIsSet(GasPriceFlag.Name) {
 		cfg.GasPrice = GlobalBig(ctx, GasPriceFlag.Name)
 	}
-
-	if ctx.GlobalIsSet(SolcPathFlag.Name) {
-		cfg.SolcPath = ctx.GlobalString(SolcPathFlag.Name)
-	}
 	if ctx.GlobalIsSet(VMEnableDebugFlag.Name) {
 		// TODO(fjl): force-enable this in --dev mode
 		cfg.EnablePreimageRecording = ctx.GlobalBool(VMEnableDebugFlag.Name)
diff --git a/eth/backend.go b/eth/backend.go
@@ -79,7 +79,6 @@ type Ethereum struct {
 	Mining       bool
 	MinerThreads int
 	etherbase    common.Address
-	solcPath     string
 
 	netVersionId  int
 	netRPCService *ethapi.PublicNetAPI
@@ -122,7 +121,6 @@ func New(ctx *node.ServiceContext, config *Config) (*Ethereum, error) {
 		netVersionId:   config.NetworkId,
 		etherbase:      config.Etherbase,
 		MinerThreads:   config.MinerThreads,
-		solcPath:       config.SolcPath,
 	}
 
 	if err := addMipmapBloomBins(chainDb); err != nil {
@@ -236,7 +234,7 @@ func CreateConsensusEngine(ctx *node.ServiceContext, config *Config, chainConfig
 // APIs returns the collection of RPC services the ethereum package offers.
 // NOTE, some of these services probably need to be moved to somewhere else.
 func (s *Ethereum) APIs() []rpc.API {
-	apis := ethapi.GetAPIs(s.ApiBackend, s.solcPath)
+	apis := ethapi.GetAPIs(s.ApiBackend)
 
 	// Append any APIs exposed explicitly by the consensus engine
 	apis = append(apis, s.engine.APIs(s.BlockChain())...)
diff --git a/eth/config.go b/eth/config.go
@@ -105,7 +105,6 @@ type Config struct {
 	EnablePreimageRecording bool
 
 	// Miscellaneous options
-	SolcPath  string
 	DocRoot   string `toml:"-"`
 	PowFake   bool   `toml:"-"`
 	PowTest   bool   `toml:"-"`
diff --git a/eth/gen_config.go b/eth/gen_config.go
diff --git a/internal/ethapi/backend.go b/internal/ethapi/backend.go
@@ -72,7 +72,7 @@ type State interface {
 	GetNonce(ctx context.Context, addr common.Address) (uint64, error)
 }
 
-func GetAPIs(apiBackend Backend, solcPath string) []rpc.API {
+func GetAPIs(apiBackend Backend) []rpc.API {
 	return []rpc.API{
 		{
 			Namespace: "eth",
diff --git a/internal/web3ext/web3ext.go b/internal/web3ext/web3ext.go
@@ -143,11 +143,6 @@ web3._extend({
 			call: 'admin_sleepBlocks',
 			params: 2
 		}),
-		new web3._extend.Method({
-			name: 'setSolc',
-			call: 'admin_setSolc',
-			params: 1
-		}),
 		new web3._extend.Method({
 			name: 'startRPC',
 			call: 'admin_startRPC',
diff --git a/les/backend.go b/les/backend.go
@@ -23,7 +23,6 @@ import (
 
 	"github.com/ethereum/go-ethereum/accounts"
 	"github.com/ethereum/go-ethereum/common"
-	"github.com/ethereum/go-ethereum/common/compiler"
 	"github.com/ethereum/go-ethereum/common/hexutil"
 	"github.com/ethereum/go-ethereum/consensus"
 	"github.com/ethereum/go-ethereum/core"
@@ -61,8 +60,6 @@ type LightEthereum struct {
 	eventMux       *event.TypeMux
 	engine         consensus.Engine
 	accountManager *accounts.Manager
-	solcPath       string
-	solc           *compiler.Solidity
 
 	netVersionId  int
 	netRPCService *ethapi.PublicNetAPI
@@ -91,7 +88,6 @@ func New(ctx *node.ServiceContext, config *eth.Config) (*LightEthereum, error) {
 		engine:         eth.CreateConsensusEngine(ctx, config, chainConfig, chainDb),
 		shutdownChan:   make(chan bool),
 		netVersionId:   config.NetworkId,
-		solcPath:       config.SolcPath,
 	}
 	if eth.blockchain, err = light.NewLightChain(odr, eth.chainConfig, eth.engine, eth.eventMux); err != nil {
 		return nil, err
@@ -145,7 +141,7 @@ func (s *LightDummyAPI) Mining() bool {
 // APIs returns the collection of RPC services the ethereum package offers.
 // NOTE, some of these services probably need to be moved to somewhere else.
 func (s *LightEthereum) APIs() []rpc.API {
-	return append(ethapi.GetAPIs(s.ApiBackend, s.solcPath), []rpc.API{
+	return append(ethapi.GetAPIs(s.ApiBackend), []rpc.API{
 		{
 			Namespace: "eth",
 			Version:   "1.0",
diff --git a/node/api.go b/node/api.go
@@ -92,8 +92,13 @@ func (api *PrivateAdminAPI) StartRPC(host *string, port *int, cors *string, apis
 	if port == nil {
 		port = &api.node.config.HTTPPort
 	}
-	if cors == nil {
-		cors = &api.node.config.HTTPCors
+
+	allowedOrigins := api.node.config.HTTPCors
+	if cors != nil {
+		allowedOrigins = nil
+		for _, origin := range strings.Split(*cors, ",") {
+			allowedOrigins = append(allowedOrigins, strings.TrimSpace(origin))
+		}
 	}
 
 	modules := api.node.httpWhitelist
@@ -104,7 +109,7 @@ func (api *PrivateAdminAPI) StartRPC(host *string, port *int, cors *string, apis
 		}
 	}
 
-	if err := api.node.startHTTP(fmt.Sprintf("%s:%d", *host, *port), api.node.rpcAPIs, modules, *cors); err != nil {
+	if err := api.node.startHTTP(fmt.Sprintf("%s:%d", *host, *port), api.node.rpcAPIs, modules, allowedOrigins); err != nil {
 		return false, err
 	}
 	return true, nil
@@ -141,8 +146,13 @@ func (api *PrivateAdminAPI) StartWS(host *string, port *int, allowedOrigins *str
 	if port == nil {
 		port = &api.node.config.WSPort
 	}
-	if allowedOrigins == nil {
-		allowedOrigins = &api.node.config.WSOrigins
+
+	origins := api.node.config.WSOrigins
+	if allowedOrigins != nil {
+		origins = nil
+		for _, origin := range strings.Split(*allowedOrigins, ",") {
+			origins = append(origins, strings.TrimSpace(origin))
+		}
 	}
 
 	modules := api.node.config.WSModules
@@ -153,7 +163,7 @@ func (api *PrivateAdminAPI) StartWS(host *string, port *int, allowedOrigins *str
 		}
 	}
 
-	if err := api.node.startWS(fmt.Sprintf("%s:%d", *host, *port), api.node.rpcAPIs, modules, *allowedOrigins); err != nil {
+	if err := api.node.startWS(fmt.Sprintf("%s:%d", *host, *port), api.node.rpcAPIs, modules, origins); err != nil {
 		return false, err
 	}
 	return true, nil
diff --git a/node/config.go b/node/config.go
@@ -100,7 +100,7 @@ type Config struct {
 	// HTTPCors is the Cross-Origin Resource Sharing header to send to requesting
 	// clients. Please be aware that CORS is a browser enforced security, it's fully
 	// useless for custom HTTP clients.
-	HTTPCors string `toml:",omitempty"`
+	HTTPCors []string `toml:",omitempty"`
 
 	// HTTPModules is a list of API modules to expose via the HTTP RPC interface.
 	// If the module list is empty, all RPC API endpoints designated public will be
@@ -119,7 +119,7 @@ type Config struct {
 	// WSOrigins is the list of domain to accept websocket requests from. Please be
 	// aware that the server can only act upon the HTTP request the client sends and
 	// cannot verify the validity of the request header.
-	WSOrigins string `toml:",omitempty"`
+	WSOrigins []string `toml:",omitempty"`
 
 	// WSModules is a list of API modules to expose via the websocket RPC interface.
 	// If the module list is empty, all RPC API endpoints designated public will be
diff --git a/node/node.go b/node/node.go
@@ -372,7 +372,7 @@ func (n *Node) stopIPC() {
 }
 
 // startHTTP initializes and starts the HTTP RPC endpoint.
-func (n *Node) startHTTP(endpoint string, apis []rpc.API, modules []string, cors string) error {
+func (n *Node) startHTTP(endpoint string, apis []rpc.API, modules []string, cors []string) error {
 	// Short circuit if the HTTP endpoint isn't being exposed
 	if endpoint == "" {
 		return nil
@@ -426,7 +426,7 @@ func (n *Node) stopHTTP() {
 }
 
 // startWS initializes and starts the websocket RPC endpoint.
-func (n *Node) startWS(endpoint string, apis []rpc.API, modules []string, wsOrigins string) error {
+func (n *Node) startWS(endpoint string, apis []rpc.API, modules []string, wsOrigins []string) error {
 	// Short circuit if the WS endpoint isn't being exposed
 	if endpoint == "" {
 		return nil
diff --git a/rpc/client_test.go b/rpc/client_test.go
@@ -394,7 +394,7 @@ func TestClientReconnect(t *testing.T) {
 		if err != nil {
 			t.Fatal(err)
 		}
-		go http.Serve(l, srv.WebsocketHandler("*"))
+		go http.Serve(l, srv.WebsocketHandler([]string{"*"}))
 		return srv, l
 	}
 
@@ -466,7 +466,7 @@ func httpTestClient(srv *Server, transport string, fl *flakeyListener) (*Client,
 	var hs *httptest.Server
 	switch transport {
 	case "ws":
-		hs = httptest.NewUnstartedServer(srv.WebsocketHandler("*"))
+		hs = httptest.NewUnstartedServer(srv.WebsocketHandler([]string{"*"}))
 	case "http":
 		hs = httptest.NewUnstartedServer(srv)
 	default:
diff --git a/rpc/http.go b/rpc/http.go
@@ -25,7 +25,6 @@ import (
 	"io/ioutil"
 	"net"
 	"net/http"
-	"strings"
 	"sync"
 	"time"
 
@@ -140,8 +139,8 @@ func (t *httpReadWriteNopCloser) Close() error {
 // NewHTTPServer creates a new HTTP RPC server around an API provider.
 //
 // Deprecated: Server implements http.Handler
-func NewHTTPServer(corsString string, srv *Server) *http.Server {
-	return &http.Server{Handler: newCorsHandler(srv, corsString)}
+func NewHTTPServer(cors []string, srv *Server) *http.Server {
+	return &http.Server{Handler: newCorsHandler(srv, cors)}
 }
 
 // ServeHTTP serves JSON-RPC requests over HTTP.
@@ -162,11 +161,7 @@ func (srv *Server) ServeHTTP(w http.ResponseWriter, r *http.Request) {
 	srv.ServeSingleRequest(codec, OptionMethodInvocation)
 }
 
-func newCorsHandler(srv *Server, corsString string) http.Handler {
-	var allowedOrigins []string
-	for _, domain := range strings.Split(corsString, ",") {
-		allowedOrigins = append(allowedOrigins, strings.TrimSpace(domain))
-	}
+func newCorsHandler(srv *Server, allowedOrigins []string) http.Handler {
 	c := cors.New(cors.Options{
 		AllowedOrigins: allowedOrigins,
 		AllowedMethods: []string{"POST", "GET"},
diff --git a/rpc/websocket.go b/rpc/websocket.go
@@ -36,9 +36,9 @@ import (
 //
 // allowedOrigins should be a comma-separated list of allowed origin URLs.
 // To allow connections with any origin, pass "*".
-func (srv *Server) WebsocketHandler(allowedOrigins string) http.Handler {
+func (srv *Server) WebsocketHandler(allowedOrigins []string) http.Handler {
 	return websocket.Server{
-		Handshake: wsHandshakeValidator(strings.Split(allowedOrigins, ",")),
+		Handshake: wsHandshakeValidator(allowedOrigins),
 		Handler: func(conn *websocket.Conn) {
 			srv.ServeCodec(NewJSONCodec(conn), OptionMethodInvocation|OptionSubscriptions)
 		},
@@ -48,7 +48,7 @@ func (srv *Server) WebsocketHandler(allowedOrigins string) http.Handler {
 // NewWSServer creates a new websocket RPC server around an API provider.
 //
 // Deprecated: use Server.WebsocketHandler
-func NewWSServer(allowedOrigins string, srv *Server) *http.Server {
+func NewWSServer(allowedOrigins []string, srv *Server) *http.Server {
 	return &http.Server{Handler: srv.WebsocketHandler(allowedOrigins)}
 }
 

Original file line number	Diff line number	Diff line change
`@@ -392,11 +392,6 @@ var (`
`392`	`392`	Usage: "JavaScript root path for `loadScript`",
`393`	`393`	`Value: ".",`
`394`	`394`	`}`
`395`		`- SolcPathFlag = cli.StringFlag{`
`396`		`- Name: "solc",`
`397`		`- Usage: "Solidity compiler command to be used",`
`398`		`- Value: "solc",`
`399`		`- }`
`400`	`395`
`401`	`396`	`// Gas price oracle settings`
`402`	`397`	`GpoBlocksFlag = cli.IntFlag{`
`@@ -528,9 +523,9 @@ func setNAT(ctx cli.Context, cfg p2p.Config) {`
`528`	`523`	`}`
`529`	`524`	`}`
`530`	`525`
`531`		`-// makeRPCModules splits input separated by a comma and trims excessive white`
`532`		`-// space from the substrings.`
`533`		`-func makeRPCModules(input string) []string {`
	`526`	`+// splitAndTrim splits input separated by a comma`
	`527`	`+// and trims excessive white space from the substrings.`
	`528`	`+func splitAndTrim(input string) []string {`
`534`	`529`	`result := strings.Split(input, ",")`
`535`	`530`	`for i, r := range result {`
`536`	`531`	`result[i] = strings.TrimSpace(r)`
`@@ -552,10 +547,10 @@ func setHTTP(ctx cli.Context, cfg node.Config) {`
`552`	`547`	`cfg.HTTPPort = ctx.GlobalInt(RPCPortFlag.Name)`
`553`	`548`	`}`
`554`	`549`	`if ctx.GlobalIsSet(RPCCORSDomainFlag.Name) {`
`555`		`- cfg.HTTPCors = ctx.GlobalString(RPCCORSDomainFlag.Name)`
	`550`	`+ cfg.HTTPCors = splitAndTrim(ctx.GlobalString(RPCCORSDomainFlag.Name))`
`556`	`551`	`}`
`557`	`552`	`if ctx.GlobalIsSet(RPCApiFlag.Name) {`
`558`		`- cfg.HTTPModules = makeRPCModules(ctx.GlobalString(RPCApiFlag.Name))`
	`553`	`+ cfg.HTTPModules = splitAndTrim(ctx.GlobalString(RPCApiFlag.Name))`
`559`	`554`	`}`
`560`	`555`	`}`
`561`	`556`
`@@ -573,10 +568,10 @@ func setWS(ctx cli.Context, cfg node.Config) {`
`573`	`568`	`cfg.WSPort = ctx.GlobalInt(WSPortFlag.Name)`
`574`	`569`	`}`
`575`	`570`	`if ctx.GlobalIsSet(WSAllowedOriginsFlag.Name) {`
`576`		`- cfg.WSOrigins = ctx.GlobalString(WSAllowedOriginsFlag.Name)`
	`571`	`+ cfg.WSOrigins = splitAndTrim(ctx.GlobalString(WSAllowedOriginsFlag.Name))`
`577`	`572`	`}`
`578`	`573`	`if ctx.GlobalIsSet(WSApiFlag.Name) {`
`579`		`- cfg.WSModules = makeRPCModules(ctx.GlobalString(WSApiFlag.Name))`
	`574`	`+ cfg.WSModules = splitAndTrim(ctx.GlobalString(WSApiFlag.Name))`
`580`	`575`	`}`
`581`	`576`	`}`
`582`	`577`
`@@ -828,10 +823,6 @@ func SetEthConfig(ctx cli.Context, stack node.Node, cfg *eth.Config) {`
`828`	`823`	`if ctx.GlobalIsSet(GasPriceFlag.Name) {`
`829`	`824`	`cfg.GasPrice = GlobalBig(ctx, GasPriceFlag.Name)`
`830`	`825`	`}`
`831`		`-`
`832`		`- if ctx.GlobalIsSet(SolcPathFlag.Name) {`
`833`		`- cfg.SolcPath = ctx.GlobalString(SolcPathFlag.Name)`
`834`		`- }`
`835`	`826`	`if ctx.GlobalIsSet(VMEnableDebugFlag.Name) {`
`836`	`827`	`// TODO(fjl): force-enable this in --dev mode`
`837`	`828`	`cfg.EnablePreimageRecording = ctx.GlobalBool(VMEnableDebugFlag.Name)`
Original file line number	Diff line number	Diff line change
`@@ -72,7 +72,7 @@ type State interface {`
`72`	`72`	`GetNonce(ctx context.Context, addr common.Address) (uint64, error)`
`73`	`73`	`}`
`74`	`74`
`75`		`-func GetAPIs(apiBackend Backend, solcPath string) []rpc.API {`
	`75`	`+func GetAPIs(apiBackend Backend) []rpc.API {`
`76`	`76`	`return []rpc.API{`
`77`	`77`	`{`
`78`	`78`	`Namespace: "eth",`
Original file line number	Diff line number	Diff line change
`@@ -92,8 +92,13 @@ func (api PrivateAdminAPI) StartRPC(host string, port int, cors string, apis`
`92`	`92`	`if port == nil {`
`93`	`93`	`port = &api.node.config.HTTPPort`
`94`	`94`	`}`
`95`		`- if cors == nil {`
`96`		`- cors = &api.node.config.HTTPCors`
	`95`	`+`
	`96`	`+ allowedOrigins := api.node.config.HTTPCors`
	`97`	`+ if cors != nil {`
	`98`	`+ allowedOrigins = nil`
	`99`	`+ for _, origin := range strings.Split(*cors, ",") {`
	`100`	`+ allowedOrigins = append(allowedOrigins, strings.TrimSpace(origin))`
	`101`	`+ }`
`97`	`102`	`}`
`98`	`103`
`99`	`104`	`modules := api.node.httpWhitelist`
`@@ -104,7 +109,7 @@ func (api PrivateAdminAPI) StartRPC(host string, port int, cors string, apis`
`104`	`109`	`}`
`105`	`110`	`}`
`106`	`111`
`107`		`- if err := api.node.startHTTP(fmt.Sprintf("%s:%d", host, port), api.node.rpcAPIs, modules, *cors); err != nil {`
	`112`	`+ if err := api.node.startHTTP(fmt.Sprintf("%s:%d", host, port), api.node.rpcAPIs, modules, allowedOrigins); err != nil {`
`108`	`113`	`return false, err`
`109`	`114`	`}`
`110`	`115`	`return true, nil`
`@@ -141,8 +146,13 @@ func (api PrivateAdminAPI) StartWS(host string, port int, allowedOrigins str`
`141`	`146`	`if port == nil {`
`142`	`147`	`port = &api.node.config.WSPort`
`143`	`148`	`}`
`144`		`- if allowedOrigins == nil {`
`145`		`- allowedOrigins = &api.node.config.WSOrigins`
	`149`	`+`
	`150`	`+ origins := api.node.config.WSOrigins`
	`151`	`+ if allowedOrigins != nil {`
	`152`	`+ origins = nil`
	`153`	`+ for _, origin := range strings.Split(*allowedOrigins, ",") {`
	`154`	`+ origins = append(origins, strings.TrimSpace(origin))`
	`155`	`+ }`
`146`	`156`	`}`
`147`	`157`
`148`	`158`	`modules := api.node.config.WSModules`
`@@ -153,7 +163,7 @@ func (api PrivateAdminAPI) StartWS(host string, port int, allowedOrigins str`
`153`	`163`	`}`
`154`	`164`	`}`
`155`	`165`
`156`		`- if err := api.node.startWS(fmt.Sprintf("%s:%d", host, port), api.node.rpcAPIs, modules, *allowedOrigins); err != nil {`
	`166`	`+ if err := api.node.startWS(fmt.Sprintf("%s:%d", host, port), api.node.rpcAPIs, modules, origins); err != nil {`
`157`	`167`	`return false, err`
`158`	`168`	`}`
`159`	`169`	`return true, nil`