Merge 06fbcbf848 into 5e1a39d67f

This change fixes a bug on the `DirectoryFlag` and the `BigFlag`, which would trigger a `panic` with the message "flag redefined" in case an alias was added to such a flag.

cmd/clef/main.go

@@ -748,7 +748,7 @@ func signer(c *cli.Context) error {
 
 		// start http server
 		httpEndpoint := net.JoinHostPort(c.String(utils.HTTPListenAddrFlag.Name), fmt.Sprintf("%d", port))
-		httpServer, addr, err := node.StartHTTPEndpoint(httpEndpoint, rpc.DefaultHTTPTimeouts, handler)
+		httpServer, addr, err := node.StartHTTPEndpoint(httpEndpoint, c.String(utils.HTTPListenProtocolFlag.Name), rpc.DefaultHTTPTimeouts, handler)
 		if err != nil {
 			utils.Fatalf("Could not start RPC api: %v", err)
 		}

cmd/geth/main.go

@@ -160,6 +160,7 @@ var (
 	rpcFlags = []cli.Flag{
 		utils.HTTPEnabledFlag,
 		utils.HTTPListenAddrFlag,
+		utils.HTTPListenProtocolFlag,
 		utils.HTTPPortFlag,
 		utils.HTTPCORSDomainFlag,
 		utils.AuthListenFlag,

cmd/utils/flags.go

@@ -29,6 +29,7 @@ import (
 	"net"
 	"net/http"
 	"os"
+	"path"
 	"path/filepath"
 	godebug "runtime/debug"
 	"strconv"
@@ -614,6 +615,12 @@ var (
 		Value:    node.DefaultHTTPHost,
 		Category: flags.APICategory,
 	}
+	HTTPListenProtocolFlag = &cli.StringFlag{
+		Name:     "http.proto",
+		Usage:    "HTTP-RPC server listening protocol (tcp,unix)",
+		Value:    node.DefaultHTTPProtocol,
+		Category: flags.APICategory,
+	}
 	HTTPPortFlag = &cli.IntFlag{
 		Name:     "http.port",
 		Usage:    "HTTP-RPC server listening port",
@@ -1105,13 +1112,23 @@ func SplitAndTrim(input string) (ret []string) {
 func setHTTP(ctx *cli.Context, cfg *node.Config) {
 	if ctx.Bool(HTTPEnabledFlag.Name) {
 		if cfg.HTTPHost == "" {
-			cfg.HTTPHost = "127.0.0.1"
+			if HTTPListenProtocolFlag.Name == "unix" {
+				cfg.HTTPHost = path.Join(os.TempDir(), "geth.http.sock")
+			} else {
+				cfg.HTTPHost = "127.0.0.1"
+			}
 		}
 		if ctx.IsSet(HTTPListenAddrFlag.Name) {
 			cfg.HTTPHost = ctx.String(HTTPListenAddrFlag.Name)
 		}
 	}
 
+	if ctx.IsSet(HTTPListenProtocolFlag.Name) {
+		cfg.HTTPProto = ctx.String(HTTPListenProtocolFlag.Name)
+	} else {
+		cfg.HTTPProto = "tcp"
+	}
+
 	if ctx.IsSet(HTTPPortFlag.Name) {
 		cfg.HTTPPort = ctx.Int(HTTPPortFlag.Name)
 	}

internal/flags/flags.go

@@ -90,7 +90,7 @@ func (f *DirectoryFlag) Apply(set *flag.FlagSet) error {
 		}
 	}
 	eachName(f, func(name string) {
-		set.Var(&f.Value, f.Name, f.Usage)
+		set.Var(&f.Value, name, f.Usage)
 	})
 	return nil
 }
@@ -172,7 +172,7 @@ func (f *BigFlag) Apply(set *flag.FlagSet) error {
 	}
 	eachName(f, func(name string) {
 		f.Value = new(big.Int)
-		set.Var((*bigValue)(f.Value), f.Name, f.Usage)
+		set.Var((*bigValue)(f.Value), name, f.Usage)
 	})
 	return nil
 }

node/api.go

@@ -157,7 +157,7 @@ func (api *adminAPI) PeerEvents(ctx context.Context) (*rpc.Subscription, error)
 }
 
 // StartHTTP starts the HTTP RPC API server.
-func (api *adminAPI) StartHTTP(host *string, port *int, cors *string, apis *string, vhosts *string) (bool, error) {
+func (api *adminAPI) StartHTTP(proto *string, host *string, port *int, cors *string, apis *string, vhosts *string) (bool, error) {
 	api.node.lock.Lock()
 	defer api.node.lock.Unlock()
 
@@ -202,7 +202,7 @@ func (api *adminAPI) StartHTTP(host *string, port *int, cors *string, apis *stri
 		}
 	}
 
-	if err := api.node.http.setListenAddr(*host, *port); err != nil {
+	if err := api.node.http.setListenAddr(*proto, *host, *port); err != nil {
 		return false, err
 	}
 	if err := api.node.http.enableRPC(api.node.rpcAPIs, config); err != nil {
@@ -216,9 +216,9 @@ func (api *adminAPI) StartHTTP(host *string, port *int, cors *string, apis *stri
 
 // StartRPC starts the HTTP RPC API server.
 // Deprecated: use StartHTTP instead.
-func (api *adminAPI) StartRPC(host *string, port *int, cors *string, apis *string, vhosts *string) (bool, error) {
+func (api *adminAPI) StartRPC(proto *string, host *string, port *int, cors *string, apis *string, vhosts *string) (bool, error) {
 	log.Warn("Deprecation warning", "method", "admin.StartRPC", "use-instead", "admin.StartHTTP")
-	return api.StartHTTP(host, port, cors, apis, vhosts)
+	return api.StartHTTP(proto, host, port, cors, apis, vhosts)
 }
 
 // StopHTTP shuts down the HTTP server.
@@ -235,7 +235,7 @@ func (api *adminAPI) StopRPC() (bool, error) {
 }
 
 // StartWS starts the websocket RPC API server.
-func (api *adminAPI) StartWS(host *string, port *int, allowedOrigins *string, apis *string) (bool, error) {
+func (api *adminAPI) StartWS(proto *string, host *string, port *int, allowedOrigins *string, apis *string) (bool, error) {
 	api.node.lock.Lock()
 	defer api.node.lock.Unlock()
 
@@ -276,7 +276,7 @@ func (api *adminAPI) StartWS(host *string, port *int, allowedOrigins *string, ap
 
 	// Enable WebSocket on the server.
 	server := api.node.wsServerForPort(*port, false)
-	if err := server.setListenAddr(*host, *port); err != nil {
+	if err := server.setListenAddr(*proto, *host, *port); err != nil {
 		return false, err
 	}
 	openApis, _ := api.node.getAPIs()

node/api_test.go

@@ -69,7 +69,7 @@ func TestStartRPC(t *testing.T) {
 			name: "rpc enabled through API",
 			cfg:  Config{},
 			fn: func(t *testing.T, n *Node, api *adminAPI) {
-				_, err := api.StartHTTP(sp("127.0.0.1"), ip(0), nil, nil, nil)
+				_, err := api.StartHTTP(sp("tcp"), sp("127.0.0.1"), ip(0), nil, nil, nil)
 				assert.NoError(t, err)
 			},
 			wantReachable: true,
@@ -90,14 +90,14 @@ func TestStartRPC(t *testing.T) {
 				port := listener.Addr().(*net.TCPAddr).Port
 
 				// Now try to start RPC on that port. This should fail.
-				_, err = api.StartHTTP(sp("127.0.0.1"), ip(port), nil, nil, nil)
+				_, err = api.StartHTTP(sp("tcp"), sp("127.0.0.1"), ip(port), nil, nil, nil)
 				if err == nil {
 					t.Fatal("StartHTTP should have failed on port", port)
 				}
 
 				// Try again after unblocking the port. It should work this time.
 				listener.Close()
-				_, err = api.StartHTTP(sp("127.0.0.1"), ip(port), nil, nil, nil)
+				_, err = api.StartHTTP(sp("tcp"), sp("127.0.0.1"), ip(port), nil, nil, nil)
 				assert.NoError(t, err)
 			},
 			wantReachable: true,
@@ -144,7 +144,7 @@ func TestStartRPC(t *testing.T) {
 			name: "ws enabled through API",
 			cfg:  Config{},
 			fn: func(t *testing.T, n *Node, api *adminAPI) {
-				_, err := api.StartWS(sp("127.0.0.1"), ip(0), nil, nil)
+				_, err := api.StartWS(sp("tcp"), sp("127.0.0.1"), ip(0), nil, nil)
 				assert.NoError(t, err)
 			},
 			wantReachable: true,
@@ -184,7 +184,7 @@ func TestStartRPC(t *testing.T) {
 			cfg:  Config{HTTPHost: "127.0.0.1"},
 			fn: func(t *testing.T, n *Node, api *adminAPI) {
 				wsport := n.http.port
-				_, err := api.StartWS(sp("127.0.0.1"), ip(wsport), nil, nil)
+				_, err := api.StartWS(sp("tcp"), sp("127.0.0.1"), ip(wsport), nil, nil)
 				assert.NoError(t, err)
 			},
 			wantReachable: true,
@@ -197,7 +197,7 @@ func TestStartRPC(t *testing.T) {
 			cfg:  Config{HTTPHost: "127.0.0.1"},
 			fn: func(t *testing.T, n *Node, api *adminAPI) {
 				wsport := n.http.port
-				_, err := api.StartWS(sp("127.0.0.1"), ip(wsport), nil, nil)
+				_, err := api.StartWS(sp("tcp"), sp("127.0.0.1"), ip(wsport), nil, nil)
 				assert.NoError(t, err)
 
 				_, err = api.StopWS()
@@ -211,11 +211,11 @@ func TestStartRPC(t *testing.T) {
 		{
 			name: "rpc stopped with ws enabled",
 			fn: func(t *testing.T, n *Node, api *adminAPI) {
-				_, err := api.StartHTTP(sp("127.0.0.1"), ip(0), nil, nil, nil)
+				_, err := api.StartHTTP(sp("tcp"), sp("127.0.0.1"), ip(0), nil, nil, nil)
 				assert.NoError(t, err)
 
 				wsport := n.http.port
-				_, err = api.StartWS(sp("127.0.0.1"), ip(wsport), nil, nil)
+				_, err = api.StartWS(sp("tcp"), sp("127.0.0.1"), ip(wsport), nil, nil)
 				assert.NoError(t, err)
 
 				_, err = api.StopHTTP()
@@ -229,11 +229,11 @@ func TestStartRPC(t *testing.T) {
 		{
 			name: "rpc enabled after ws",
 			fn: func(t *testing.T, n *Node, api *adminAPI) {
-				_, err := api.StartWS(sp("127.0.0.1"), ip(0), nil, nil)
+				_, err := api.StartWS(sp("tcp"), sp("127.0.0.1"), ip(0), nil, nil)
 				assert.NoError(t, err)
 
 				wsport := n.http.port
-				_, err = api.StartHTTP(sp("127.0.0.1"), ip(wsport), nil, nil, nil)
+				_, err = api.StartHTTP(sp("tcp"), sp("127.0.0.1"), ip(wsport), nil, nil, nil)
 				assert.NoError(t, err)
 			},
 			wantReachable: true,

node/config.go

@@ -106,6 +106,10 @@ type Config struct {
 	// field is empty, no HTTP API endpoint will be started.
 	HTTPHost string
 
+	// HTTPProto is the protocol on which the HTTP RPC server will bind.
+	// Supported values are tcp, unix. HTTPPort is ignored if HTTPProto == unix
+	HTTPProto string
+
 	// HTTPPort is the TCP port number on which to start the HTTP RPC server. The
 	// default zero value is/ valid and will pick a port number randomly (useful
 	// for ephemeral nodes).

node/defaults.go

@@ -28,12 +28,13 @@ import (
 )
 
 const (
-	DefaultHTTPHost = "localhost" // Default host interface for the HTTP RPC server
-	DefaultHTTPPort = 8545        // Default TCP port for the HTTP RPC server
-	DefaultWSHost   = "localhost" // Default host interface for the websocket RPC server
-	DefaultWSPort   = 8546        // Default TCP port for the websocket RPC server
-	DefaultAuthHost = "localhost" // Default host interface for the authenticated apis
-	DefaultAuthPort = 8551        // Default port for the authenticated apis
+	DefaultHTTPProtocol = "tcp"       // Default protocol for the HTTP RPC SERVER
+	DefaultHTTPHost     = "localhost" // Default host interface for the HTTP RPC server
+	DefaultHTTPPort     = 8545        // Default TCP port for the HTTP RPC server
+	DefaultWSHost       = "localhost" // Default host interface for the websocket RPC server
+	DefaultWSPort       = 8546        // Default TCP port for the websocket RPC server
+	DefaultAuthHost     = "localhost" // Default host interface for the authenticated apis
+	DefaultAuthPort     = 8551        // Default port for the authenticated apis
 )
 
 const (

node/endpoints.go

@@ -26,13 +26,13 @@ import (
 )
 
 // StartHTTPEndpoint starts the HTTP RPC endpoint.
-func StartHTTPEndpoint(endpoint string, timeouts rpc.HTTPTimeouts, handler http.Handler) (*http.Server, net.Addr, error) {
+func StartHTTPEndpoint(endpoint string, protocol string, timeouts rpc.HTTPTimeouts, handler http.Handler) (*http.Server, net.Addr, error) {
 	// start the HTTP listener
 	var (
 		listener net.Listener
 		err      error
 	)
-	if listener, err = net.Listen("tcp", endpoint); err != nil {
+	if listener, err = net.Listen(protocol, endpoint); err != nil {
 		return nil, nil, err
 	}
 	// make sure timeout values are meaningful

node/node.go

@@ -92,6 +92,10 @@ func New(conf *Config) (*Node, error) {
 		conf.Logger = log.New()
 	}
 
+	if conf.HTTPProto == "" {
+		conf.HTTPProto = "tcp"
+	}
+
 	// Ensure that the instance name doesn't cause weird conflicts with
 	// other files in the data directory.
 	if strings.ContainsAny(conf.Name, `/\`) {
@@ -396,7 +400,7 @@ func (n *Node) startRPC() error {
 	}
 
 	initHttp := func(server *httpServer, port int) error {
-		if err := server.setListenAddr(n.config.HTTPHost, port); err != nil {
+		if err := server.setListenAddr(n.config.HTTPProto, n.config.HTTPHost, port); err != nil {
 			return err
 		}
 		if err := server.enableRPC(openAPIs, httpConfig{
@@ -414,7 +418,7 @@ func (n *Node) startRPC() error {
 
 	initWS := func(port int) error {
 		server := n.wsServerForPort(port, false)
-		if err := server.setListenAddr(n.config.WSHost, port); err != nil {
+		if err := server.setListenAddr(n.config.HTTPProto, n.config.WSHost, port); err != nil {
 			return err
 		}
 		if err := server.enableWS(openAPIs, wsConfig{
@@ -432,7 +436,7 @@ func (n *Node) startRPC() error {
 	initAuth := func(port int, secret []byte) error {
 		// Enable auth via HTTP
 		server := n.httpAuth
-		if err := server.setListenAddr(n.config.AuthAddr, port); err != nil {
+		if err := server.setListenAddr(n.config.HTTPProto, n.config.AuthAddr, port); err != nil {
 			return err
 		}
 		sharedConfig := rpcEndpointConfig{
@@ -455,7 +459,7 @@ func (n *Node) startRPC() error {
 
 		// Enable auth via WS
 		server = n.wsServerForPort(port, true)
-		if err := server.setListenAddr(n.config.AuthAddr, port); err != nil {
+		if err := server.setListenAddr(n.config.HTTPProto, n.config.AuthAddr, port); err != nil {
 			return err
 		}
 		if err := server.enableWS(allAPIs, wsConfig{

node/node_test.go

@@ -516,6 +516,7 @@ func TestNodeRPCPrefix(t *testing.T) {
 		name := fmt.Sprintf("http=%s ws=%s", test.httpPrefix, test.wsPrefix)
 		t.Run(name, func(t *testing.T) {
 			cfg := &Config{
+				HTTPProto:      "tcp",
 				HTTPHost:       "127.0.0.1",
 				HTTPPathPrefix: test.httpPrefix,
 				WSHost:         "127.0.0.1",

node/rpcstack.go

@@ -85,6 +85,7 @@ type httpServer struct {
 
 	// These are set by setListenAddr.
 	endpoint string
+	proto    string
 	host     string
 	port     int
 
@@ -105,16 +106,21 @@ func newHTTPServer(log log.Logger, timeouts rpc.HTTPTimeouts) *httpServer {
 
 // setListenAddr configures the listening address of the server.
 // The address can only be set while the server isn't running.
-func (h *httpServer) setListenAddr(host string, port int) error {
+func (h *httpServer) setListenAddr(proto string, host string, port int) error {
 	h.mu.Lock()
 	defer h.mu.Unlock()
 
-	if h.listener != nil && (host != h.host || port != h.port) {
+	if h.listener != nil && (host != h.host || port != h.port || proto != h.proto) {
 		return fmt.Errorf("HTTP server already running on %s", h.endpoint)
 	}
 
+	h.proto, h.host, h.port = proto, host, port
 	h.host, h.port = host, port
-	h.endpoint = net.JoinHostPort(host, fmt.Sprintf("%d", port))
+	if h.proto != "unix" {
+		h.endpoint = net.JoinHostPort(host, fmt.Sprintf("%d", port))
+	} else {
+		h.endpoint = host
+	}
 	return nil
 }
 
@@ -149,7 +155,7 @@ func (h *httpServer) start() error {
 	}
 
 	// Start the server.
-	listener, err := net.Listen("tcp", h.endpoint)
+	listener, err := net.Listen(h.proto, h.endpoint)
 	if err != nil {
 		// If the server fails to start, we need to clear out the RPC and WS
 		// configuration so they can be configured another time.
@@ -290,7 +296,7 @@ func (h *httpServer) doStop() {
 	h.log.Info("HTTP server stopped", "endpoint", h.listener.Addr())
 
 	// Clear out everything to allow re-configuring it later.
-	h.host, h.port, h.endpoint = "", 0, ""
+	h.proto, h.host, h.port, h.endpoint = "", "", 0, ""
 	h.server, h.listener = nil, nil
 }
 

node/rpcstack_test.go

@@ -246,7 +246,7 @@ func createAndStartServer(t *testing.T, conf *httpConfig, ws bool, wsConf *wsCon
 	if ws {
 		assert.NoError(t, srv.enableWS(nil, *wsConf))
 	}
-	assert.NoError(t, srv.setListenAddr("localhost", 0))
+	assert.NoError(t, srv.setListenAddr("tcp", "localhost", 0))
 	assert.NoError(t, srv.start())
 	return srv
 }