Add a port for node webserver/api

Author: jshufro

rocketpool/node/node.go

@@ -52,7 +52,7 @@ func RegisterCommands(app *cli.App, name string, aliases []string) {
 	app.Commands = append(app.Commands, cli.Command{
 		Name:    name,
 		Aliases: aliases,
-		Usage:   "Run Rocket Pool node activity daemon",
+		Usage:   "Run Rocket Pool node activity daemon/webserver",
 		Action: func(c *cli.Context) error {
 			return run(c)
 		},

shared/services/config/rocket-pool-config.go

@@ -1383,6 +1383,16 @@ func (cfg *RocketPoolConfig) GetMevBoostOpenPorts() string {
 	return fmt.Sprintf("\"%s\"", portMode.DockerPortMapping(port))
 }
 
+// Used by text/template to format node.yml
+func (cfg *RocketPoolConfig) GetNodeOpenPorts() string {
+	portMode := cfg.Smartnode.OpenAPIPort.Value.(config.RPCMode)
+	if !portMode.Open() {
+		return ""
+	}
+	port := cfg.Smartnode.APIPort.Value.(uint16)
+	return fmt.Sprintf("\"%s\"", portMode.DockerPortMapping(port))
+}
+
 // Used by text/template to select an entrypoint based on which consensus client is used.
 func (cfg *RocketPoolConfig) GetEth2Entrypoint() string {
 	if client, _ := cfg.GetSelectedConsensusClient(); client == config.ConsensusClient_Prysm {

shared/services/config/smartnode-config.go

@@ -112,6 +112,12 @@ type SmartnodeConfig struct {
 	// Threshold for automatic vote power initialization transactions
 	AutoInitVPThreshold config.Parameter `yaml:"autoInitVPThreshold,omitempty"`
 
+	// Port for the node's webserver
+	APIPort config.Parameter `yaml:"apiPort,omitempty"`
+
+	// Whether to expose the node's API port to the local network
+	OpenAPIPort config.Parameter `yaml:"openAPIPort,omitempty"`
+
 	///////////////////////////
 	// Non-editable settings //
 	///////////////////////////
@@ -413,6 +419,29 @@ func NewSmartnodeConfig(cfg *RocketPoolConfig) *SmartnodeConfig {
 			OverwriteOnUpgrade: true,
 		},
 
+		APIPort: config.Parameter{
+			ID:                 "apiPort",
+			Name:               "API Port",
+			Description:        "The port your Smartnode's API should listen on.",
+			Type:               config.ParameterType_Uint16,
+			Default:            map[config.Network]interface{}{config.Network_All: uint16(8280)},
+			AffectsContainers:  []config.ContainerID{config.ContainerID_Node},
+			CanBeBlank:         false,
+			OverwriteOnUpgrade: false,
+		},
+
+		OpenAPIPort: config.Parameter{
+			ID:                 "openAPIPort",
+			Name:               "Expose API Port",
+			Description:        "Expose the API port to other processes on your machine. For security reasons, you cannot expose the API port except to localhost. It is recommended to keep this CLOSED.",
+			Type:               config.ParameterType_Choice,
+			Default:            map[config.Network]interface{}{config.Network_All: config.RPC_Closed},
+			AffectsContainers:  []config.ContainerID{config.ContainerID_Node},
+			CanBeBlank:         false,
+			OverwriteOnUpgrade: false,
+			Options:            config.RestrictedPortModes(),
+		},
+
 		txWatchUrl: map[config.Network]string{
 			config.Network_Mainnet: "https://etherscan.io/tx",
 			config.Network_Devnet:  "https://hoodi.etherscan.io/tx",
@@ -635,6 +664,8 @@ func (cfg *SmartnodeConfig) GetParameters() []*config.Parameter {
 		&cfg.ArchiveECUrl,
 		&cfg.WatchtowerMaxFeeOverride,
 		&cfg.WatchtowerPrioFeeOverride,
+		&cfg.APIPort,
+		&cfg.OpenAPIPort,
 	}
 }
 

shared/services/rocketpool/assets/install/templates/node.tmpl

@@ -10,6 +10,7 @@ services:
     image: {{.Smartnode.GetSmartnodeContainerTag}}
     container_name: {{.Smartnode.ProjectName}}_node
     restart: unless-stopped
+    ports: [{{.GetNodeOpenPorts}}]
     volumes:
       - /var/run/docker.sock:/var/run/docker.sock
       - {{.RocketPoolDirectory}}:/.rocketpool

shared/types/config/port-modes.go

@@ -55,3 +55,16 @@ func PortModes(warningOverride string) []ParameterOption {
 		Value:       RPC_OpenExternal,
 	}}
 }
+
+func RestrictedPortModes() []ParameterOption {
+
+	return []ParameterOption{{
+		Name:        "Closed",
+		Description: "Do not allow connections to the port",
+		Value:       RPC_Closed,
+	}, {
+		Name:        "Open to Localhost",
+		Description: "Allow connections from this host only",
+		Value:       RPC_OpenLocalhost,
+	}}
+}