relayer-config: add yaml and based struct configuration for forward

Author: eddyzags

pkg/relayer/cmd/cmd_start.go

@@ -197,6 +197,15 @@ Totals:
 		}
 	}
 
+	// --- Serve forward endpoint if enabled ---
+	// enable the forward authenticated server to send request to a supplier for a given service name. It can be useful for operational purposes.
+	// More information available here:  https://dev.poktroll.com/operate/configs/relayminer_config#forward
+	if relayMinerConfig.Forward.Enabled {
+		if err = relayMiner.ServeForward(ctx, "tcp", relayMinerConfig.Forward.Addr, relayMinerConfig.Forward.AuthToken); err != nil {
+			return fmt.Errorf("serve forward: %w", err)
+		}
+	}
+
 	// --- Start the relay miner ---
 	logger.Info().Msg("Starting relay miner...")
 

pkg/relayer/config/errors.go

@@ -13,4 +13,5 @@ var (
 	ErrRelayMinerConfigInvalidServer         = sdkerrors.Register(codespace, 2106, "invalid server in RelayMiner config")
 	ErrRelayMinerConfigInvalidRequestTimeout = sdkerrors.Register(codespace, 2107, "invalid request timeout specified in RelayMiner config")
 	ErrRelayMinerConfigInvalidMaxBodySize    = sdkerrors.Register(codespace, 2108, "invalid max body size specified in RelayMiner config")
+	ErrRelayerMinerWrongForwardToken         = sdkerrors.Register(codespace, 2109, "wrong or empty forward.token in configuration file. Expect a 32 bytes hexadecimal string (you can use 'make relayminer_forward_token_gen' command to generate a token)")
 )

pkg/relayer/config/relayminer_configs_reader.go

@@ -1,6 +1,8 @@
 package config
 
 import (
+	"regexp"
+
 	"github.com/docker/go-units"
 	yaml "gopkg.in/yaml.v2"
 
@@ -87,6 +89,19 @@ func ParseRelayMinerConfigs(logger polylog.Logger, configContent []byte) (*Relay
 		Addr:    yamlRelayMinerConfig.Ping.Addr,
 	}
 
+	if yamlRelayMinerConfig.Forward.Enabled {
+		// accepts 32 bytes hexadecimal
+		if matched, _ := regexp.MatchString(`^[a-fA-F0-9]{64}$`, yamlRelayMinerConfig.Forward.AuthToken); !matched {
+			return nil, ErrRelayerMinerWrongForwardToken
+		}
+	}
+
+	relayMinerConfig.Forward = &RelayMinerForwardConfig{
+		Enabled:   yamlRelayMinerConfig.Forward.Enabled,
+		Addr:      yamlRelayMinerConfig.Forward.Addr,
+		AuthToken: yamlRelayMinerConfig.Forward.AuthToken,
+	}
+
 	// Hydrate the pocket node urls
 	if err := relayMinerConfig.HydratePocketNodeUrls(&yamlRelayMinerConfig.PocketNode); err != nil {
 		return nil, err

pkg/relayer/config/types.go

@@ -1,6 +1,7 @@
 package config
 
 import (
+	"net/http"
 	"net/url"
 
 	sharedtypes "github.com/pokt-network/poktroll/x/shared/types"
@@ -32,6 +33,7 @@ type YAMLRelayMinerConfig struct {
 	Suppliers                    []YAMLRelayMinerSupplierConfig `yaml:"suppliers"`
 	Ping                         YAMLRelayMinerPingConfig       `yaml:"ping"`
 	EnableOverServicing          bool                           `yaml:"enable_over_servicing"`
+	Forward                      YAMLRelayMinerForwardConfig    `yaml:"forward"`
 
 	// TODO_IMPROVE: Add a EnableErrorPropagation flag to control whether errors (i.e. non-2XX HTTP status codes)
 	// are propagated back to the client or masked as internal errors.
@@ -52,6 +54,19 @@ type YAMLRelayMinerPingConfig struct {
 	Addr string `yaml:"addr"`
 }
 
+// YAMLRelayMinerForwardConfig represents the configuration to expose a forward
+// request server.
+type YAMLRelayMinerForwardConfig struct {
+	Enabled bool `yaml:"enabled"`
+
+	// Addr is the address to bind to (format: 'hostname:port') where 'hostname' can be a DNS name or an IP.
+	Addr string `yaml:"addr"`
+
+	// AuthToken is a 32 bytes hexadecimal string to authenticate request to the forward server. (mandatory flag when enabling forwarding capabilities).
+	// You can use 'make relayminer_forward_token_gen' command to print a well-formatted token.
+	AuthToken string `yaml:"auth_token"`
+}
+
 // YAMLRelayMinerPocketNodeConfig is the structure used to unmarshal the pocket
 // node URLs section of the RelayMiner config file.
 type YAMLRelayMinerPocketNodeConfig struct {
@@ -116,6 +131,7 @@ type RelayMinerConfig struct {
 	SmtStorePath                 string
 	Ping                         *RelayMinerPingConfig
 	EnableOverServicing          bool
+	Forward                      *RelayMinerForwardConfig
 }
 
 // TODO_TECHDEBT(@red-0ne): Remove this structure altogether. See the discussion here for ref:
@@ -128,6 +144,17 @@ type RelayMinerPingConfig struct {
 	Addr string
 }
 
+// RelayMinerForwardConfig is the structure resulting from parsing the
+// forward server configuration.
+type RelayMinerForwardConfig struct {
+	Enabled bool
+	// Addr is the address to bind to (format: 'hostname:port') where 'hostname' can be a DNS name or an IP.
+	Addr string
+	// AuthToken is a 32 bytes hexadecimal string to authenticate request to the forward server. (mandatory flag when enabling forwarding capabilities)
+	// You can use 'make relayminer_forward_token_gen' command to print a well-formatted token.
+	AuthToken string
+}
+
 // RelayMinerPocketNodeConfig is the structure resulting from parsing the pocket
 // node URLs section of the RelayMiner config file
 type RelayMinerPocketNodeConfig struct {
@@ -227,6 +254,17 @@ type RelayMinerSupplierServiceConfig struct {
 	ForwardPocketHeaders bool
 }
 
+// GetHeadersHTTP returns the supplier's service config http header.
+func (c RelayMinerSupplierServiceConfig) GetHeadersHTTP() http.Header {
+	header := make(http.Header)
+
+	for k, v := range c.Headers {
+		header.Add(k, v)
+	}
+
+	return header
+}
+
 // RelayMinerSupplierServiceAuthentication is the structure resulting from parsing
 // the supplier service basic auth of the RelayMiner config file when the
 // supplier is of type "http".