From f6b97b9c13ba5d4f20ba3fbb4721909b3fc49d7c Mon Sep 17 00:00:00 2001 From: rene <41963722+renaynay@users.noreply.github.com> Date: Tue, 12 Apr 2022 15:30:14 +0200 Subject: [PATCH] (cmd | node/rpc): Make RPC port configurable and ensure port 0 used for swamp (#617) --- cmd/celestia/bridge.go | 7 +++++++ cmd/celestia/full.go | 7 +++++++ cmd/celestia/light.go | 7 +++++++ cmd/flags_rpc.go | 44 +++++++++++++++++++++++++++++++++++++++ node/components.go | 16 ++------------ node/config.go | 2 ++ node/config_opts.go | 16 ++++++++++++++ node/node.go | 2 +- node/node_full_test.go | 1 - node/rpc/component.go | 19 +++++++++++++++++ node/rpc/config.go | 6 ++++-- node/rpc/server.go | 4 +++- node/rpc/server_test.go | 5 ++++- node/tests/swamp/swamp.go | 1 + 14 files changed, 117 insertions(+), 20 deletions(-) create mode 100644 cmd/flags_rpc.go create mode 100644 node/rpc/component.go diff --git a/cmd/celestia/bridge.go b/cmd/celestia/bridge.go index 02734045b4..99493e7255 100644 --- a/cmd/celestia/bridge.go +++ b/cmd/celestia/bridge.go @@ -27,6 +27,7 @@ func init() { cmdnode.CoreFlags(), cmdnode.TrustedHashFlags(), cmdnode.MiscFlags(), + cmdnode.RPCFlags(), ), cmdnode.Start( cmdnode.NodeFlags(node.Bridge), @@ -34,6 +35,7 @@ func init() { cmdnode.CoreFlags(), cmdnode.TrustedHashFlags(), cmdnode.MiscFlags(), + cmdnode.RPCFlags(), ), bridgeKeyCmd, ) @@ -76,6 +78,11 @@ var bridgeCmd = &cobra.Command{ return err } + err = cmdnode.ParseRPCFlags(cmd, env) + if err != nil { + return err + } + return nil }, } diff --git a/cmd/celestia/full.go b/cmd/celestia/full.go index d67660b7b2..4f39d85951 100644 --- a/cmd/celestia/full.go +++ b/cmd/celestia/full.go @@ -29,6 +29,7 @@ func init() { // NOTE: for now, state-related queries can only be accessed // over an RPC connection with a celestia-core node. cmdnode.CoreFlags(), + cmdnode.RPCFlags(), ), cmdnode.Start( cmdnode.NodeFlags(node.Full), @@ -38,6 +39,7 @@ func init() { // NOTE: for now, state-related queries can only be accessed // over an RPC connection with a celestia-core node. cmdnode.CoreFlags(), + cmdnode.RPCFlags(), ), fullKeyCmd, ) @@ -80,6 +82,11 @@ var fullCmd = &cobra.Command{ return err } + err = cmdnode.ParseRPCFlags(cmd, env) + if err != nil { + return err + } + return nil }, } diff --git a/cmd/celestia/light.go b/cmd/celestia/light.go index 90571c2f66..e28507b200 100644 --- a/cmd/celestia/light.go +++ b/cmd/celestia/light.go @@ -29,6 +29,7 @@ func init() { // NOTE: for now, state-related queries can only be accessed // over an RPC connection with a celestia-core node. cmdnode.CoreFlags(), + cmdnode.RPCFlags(), ), cmdnode.Start( cmdnode.NodeFlags(node.Light), @@ -38,6 +39,7 @@ func init() { // NOTE: for now, state-related queries can only be accessed // over an RPC connection with a celestia-core node. cmdnode.CoreFlags(), + cmdnode.RPCFlags(), ), lightKeyCmd, ) @@ -79,6 +81,11 @@ var lightCmd = &cobra.Command{ return err } + err = cmdnode.ParseRPCFlags(cmd, env) + if err != nil { + return err + } + return nil }, } diff --git a/cmd/flags_rpc.go b/cmd/flags_rpc.go new file mode 100644 index 0000000000..d52a0cfc8d --- /dev/null +++ b/cmd/flags_rpc.go @@ -0,0 +1,44 @@ +package cmd + +import ( + "github.com/spf13/cobra" + flag "github.com/spf13/pflag" + + "github.com/celestiaorg/celestia-node/node" +) + +var ( + addrFlag = "rpc.addr" + portFlag = "rpc.port" +) + +// RPCFlags gives a set of hardcoded node/rpc package flags. +func RPCFlags() *flag.FlagSet { + flags := &flag.FlagSet{} + + flags.String( + addrFlag, + "", + "Set a custom RPC listen address (default: localhost)", + ) + flags.String( + portFlag, + "", + "Set a custom RPC port (default: 26658)", + ) + + return flags +} + +// ParseRPCFlags parses RPC flags from the given cmd and applies values to Env. +func ParseRPCFlags(cmd *cobra.Command, env *Env) error { + addr := cmd.Flag(addrFlag).Value.String() + if addr != "" { + env.AddOptions(node.WithRPCAddress(addr)) + } + port := cmd.Flag(portFlag).Value.String() + if port != "" { + env.AddOptions(node.WithRPCPort(port)) + } + return nil +} diff --git a/node/components.go b/node/components.go index c026f70b47..04db9d86b7 100644 --- a/node/components.go +++ b/node/components.go @@ -10,9 +10,7 @@ import ( "go.uber.org/fx" "github.com/celestiaorg/celestia-node/libs/fxutil" - nodecore "github.com/celestiaorg/celestia-node/node/core" - "github.com/celestiaorg/celestia-node/node/p2p" "github.com/celestiaorg/celestia-node/node/rpc" "github.com/celestiaorg/celestia-node/node/services" @@ -74,18 +72,8 @@ func baseComponents(cfg *Config, store Store) fx.Option { // state components fx.Provide(statecomponents.NewService), fx.Provide(statecomponents.CoreAccessor(cfg.Core.GRPCAddr)), - // RPC component - fx.Provide(func(lc fx.Lifecycle) *rpc.Server { - // TODO @renaynay @Wondertan: not providing any custom config - // functionality here as this component is meant to be removed on - // implementation of https://github.com/celestiaorg/celestia-node/pull/506. - serv := rpc.NewServer(rpc.DefaultConfig()) - lc.Append(fx.Hook{ - OnStart: serv.Start, - OnStop: serv.Stop, - }) - return serv - }), + // RPCServer component + fx.Provide(rpc.ServerComponent(cfg.RPC)), ) } diff --git a/node/config.go b/node/config.go index 359c24d310..309b80ca0b 100644 --- a/node/config.go +++ b/node/config.go @@ -37,11 +37,13 @@ func DefaultConfig(tp Type) *Config { } case Light: return &Config{ + RPC: rpc.DefaultConfig(), P2P: p2p.DefaultConfig(), Services: services.DefaultConfig(), } case Full: return &Config{ + RPC: rpc.DefaultConfig(), P2P: p2p.DefaultConfig(), Services: services.DefaultConfig(), } diff --git a/node/config_opts.go b/node/config_opts.go index 78490ef282..c1df4e6215 100644 --- a/node/config_opts.go +++ b/node/config_opts.go @@ -16,6 +16,22 @@ func WithGRPCEndpoint(address string) Option { } } +// WithRPCPort configures Node to expose the given port for RPC +// queries. +func WithRPCPort(port string) Option { + return func(sets *settings) { + sets.cfg.RPC.Port = port + } +} + +// WithRPCAddress configures Node to listen on the given address for RPC +// queries. +func WithRPCAddress(addr string) Option { + return func(sets *settings) { + sets.cfg.RPC.Address = addr + } +} + // WithTrustedHash sets TrustedHash to the Config. func WithTrustedHash(hash string) Option { return func(sets *settings) { diff --git a/node/node.go b/node/node.go index 951543b97b..96fa8b967e 100644 --- a/node/node.go +++ b/node/node.go @@ -99,7 +99,7 @@ func (n *Node) Start(ctx context.Context) error { } // TODO(@Wondertan): Print useful information about the node: - // * API/RPC address + // * API/RPCServer address log.Infof("started %s Node", n.Type) addrs, err := peer.AddrInfoToP2pAddrs(host.InfoFromHost(n.Host)) diff --git a/node/node_full_test.go b/node/node_full_test.go index 435a652abe..5baad12ea3 100644 --- a/node/node_full_test.go +++ b/node/node_full_test.go @@ -16,7 +16,6 @@ func TestNewFullAndLifecycle(t *testing.T) { assert.NotZero(t, node.Type) startCtx, cancel := context.WithCancel(context.Background()) - defer cancel() err := node.Start(startCtx) require.NoError(t, err) diff --git a/node/rpc/component.go b/node/rpc/component.go new file mode 100644 index 0000000000..be3dfdf709 --- /dev/null +++ b/node/rpc/component.go @@ -0,0 +1,19 @@ +package rpc + +import ( + "go.uber.org/fx" +) + +// ServerComponent constructs a new RPC Server from the given Config. +// TODO @renaynay @Wondertan: this component is meant to be removed on implementation +// of https://github.com/celestiaorg/celestia-node/pull/506. +func ServerComponent(cfg Config) func(lc fx.Lifecycle) *Server { + return func(lc fx.Lifecycle) *Server { + serv := NewServer(cfg) + lc.Append(fx.Hook{ + OnStart: serv.Start, + OnStop: serv.Stop, + }) + return serv + } +} diff --git a/node/rpc/config.go b/node/rpc/config.go index a6ea107ee9..1b8e120e95 100644 --- a/node/rpc/config.go +++ b/node/rpc/config.go @@ -1,12 +1,14 @@ package rpc type Config struct { - ListenAddr string + Address string + Port string } func DefaultConfig() Config { return Config{ + Address: "0.0.0.0", // do NOT expose the same port as celestia-core by default so that both can run on the same machine - ListenAddr: "0.0.0.0:26658", + Port: "26658", } } diff --git a/node/rpc/server.go b/node/rpc/server.go index b50ceaa52f..96a44c5ce6 100644 --- a/node/rpc/server.go +++ b/node/rpc/server.go @@ -2,6 +2,7 @@ package rpc import ( "context" + "fmt" "net" "net/http" @@ -36,7 +37,8 @@ func NewServer(cfg Config) *Server { // Start starts the RPC Server, listening on the given address. func (s *Server) Start(context.Context) error { - listener, err := net.Listen("tcp", s.cfg.ListenAddr) + listenAddr := fmt.Sprintf("%s:%s", s.cfg.Address, s.cfg.Port) + listener, err := net.Listen("tcp", listenAddr) if err != nil { return err } diff --git a/node/rpc/server_test.go b/node/rpc/server_test.go index 21b83a7a38..943d779c2c 100644 --- a/node/rpc/server_test.go +++ b/node/rpc/server_test.go @@ -12,7 +12,10 @@ import ( ) func TestServer(t *testing.T) { - server := NewServer(DefaultConfig()) + server := NewServer(Config{ + Address: "0.0.0.0", + Port: "0", + }) ctx, cancel := context.WithCancel(context.Background()) t.Cleanup(cancel) diff --git a/node/tests/swamp/swamp.go b/node/tests/swamp/swamp.go index a99533abf7..10e2f7bf36 100644 --- a/node/tests/swamp/swamp.go +++ b/node/tests/swamp/swamp.go @@ -249,6 +249,7 @@ func (s *Swamp) newNode(t node.Type, store node.Store, options ...node.Option) * node.WithHost(s.createPeer(ks)), node.WithTrustedHash(s.trustedHash), node.WithNetwork(params.Private), + node.WithRPCPort("0"), ) node, err := node.New(t, store, options...)