Add gnosis-access-node subcommand boilerplate

Author: jannikluhn

rolling-shutter/cmd/command.go

@@ -7,6 +7,7 @@ import (
 	"github.com/shutter-network/rolling-shutter/rolling-shutter/cmd/chain"
 	"github.com/shutter-network/rolling-shutter/rolling-shutter/cmd/collator"
 	"github.com/shutter-network/rolling-shutter/rolling-shutter/cmd/cryptocmd"
+	"github.com/shutter-network/rolling-shutter/rolling-shutter/cmd/gnosisaccessnode"
 	"github.com/shutter-network/rolling-shutter/rolling-shutter/cmd/gnosiskeyper"
 	"github.com/shutter-network/rolling-shutter/rolling-shutter/cmd/mocknode"
 	"github.com/shutter-network/rolling-shutter/rolling-shutter/cmd/mocksequencer"
@@ -31,6 +32,7 @@ func Subcommands() []*cobra.Command {
 		snapshot.Cmd(),
 		snapshotkeyper.Cmd(),
 		gnosiskeyper.Cmd(),
+		gnosisaccessnode.Cmd(),
 		cryptocmd.Cmd(),
 		proxy.Cmd(),
 		mocksequencer.Cmd(),

rolling-shutter/cmd/gnosisaccessnode/gnosisaccessnode.go

@@ -0,0 +1,36 @@
+package gnosisaccessnode
+
+import (
+	"context"
+
+	"github.com/rs/zerolog/log"
+	"github.com/spf13/cobra"
+
+	"github.com/shutter-network/rolling-shutter/rolling-shutter/cmd/shversion"
+	"github.com/shutter-network/rolling-shutter/rolling-shutter/gnosisaccessnode"
+	"github.com/shutter-network/rolling-shutter/rolling-shutter/medley/configuration/command"
+	"github.com/shutter-network/rolling-shutter/rolling-shutter/medley/service"
+)
+
+func Cmd() *cobra.Command {
+	builder := command.Build(
+		main,
+		command.Usage(
+			"Run an access node for the keyper network of Shutterized Gnosis Chain",
+			`This command runs a node that only relays messages, but doesn't create any on
+its own. It is intended to be a stable node to connect to to receive messages.`,
+		),
+		command.WithGenerateConfigSubcommand(),
+		command.WithDumpConfigSubcommand(),
+	)
+	return builder.Command()
+}
+
+func main(config *gnosisaccessnode.Config) error {
+	log.Info().
+		Str("version", shversion.Version()).
+		Msg("starting access node")
+
+	accessNode := gnosisaccessnode.New(config)
+	return service.RunWithSighandler(context.Background(), accessNode)
+}

rolling-shutter/docs/rolling-shutter.md

@@ -17,6 +17,7 @@ A collection of commands to run and interact with Rolling Shutter nodes
 * [rolling-shutter chain](rolling-shutter_chain.md)	 - Run a node for Shutter's Tendermint chain
 * [rolling-shutter collator](rolling-shutter_collator.md)	 - Run a collator node
 * [rolling-shutter crypto](rolling-shutter_crypto.md)	 - CLI tool to access crypto functions
+* [rolling-shutter gnosis-access-node](rolling-shutter_gnosis-access-node.md)	 - Run an access node for the keyper network of Shutterized Gnosis Chain
 * [rolling-shutter gnosiskeyper](rolling-shutter_gnosiskeyper.md)	 - Run a Shutter keyper for Gnosis Chain
 * [rolling-shutter keyper](rolling-shutter_keyper.md)	 - Run a Shutter keyper node
 * [rolling-shutter mocknode](rolling-shutter_mocknode.md)	 - Run a Shutter mock node

rolling-shutter/docs/rolling-shutter_gnosis-access-node.md

@@ -0,0 +1,34 @@
+## rolling-shutter gnosis-access-node
+
+Run an access node for the keyper network of Shutterized Gnosis Chain
+
+### Synopsis
+
+This command runs a node that only relays messages, but doesn't create any on
+its own. It is intended to be a stable node to connect to to receive messages.
+
+```
+rolling-shutter gnosis-access-node [flags]
+```
+
+### Options
+
+```
+      --config string   config file
+  -h, --help            help for gnosis-access-node
+```
+
+### Options inherited from parent commands
+
+```
+      --logformat string   set log format, possible values:  min, short, long, max (default "long")
+      --loglevel string    set log level, possible values:  warn, info, debug (default "info")
+      --no-color           do not write colored logs
+```
+
+### SEE ALSO
+
+* [rolling-shutter](rolling-shutter.md)	 - A collection of commands to run and interact with Rolling Shutter nodes
+* [rolling-shutter gnosis-access-node dump-config](rolling-shutter_gnosis-access-node_dump-config.md)	 - Dump a 'gnosis-access-node' configuration file, based on given config and env vars
+* [rolling-shutter gnosis-access-node generate-config](rolling-shutter_gnosis-access-node_generate-config.md)	 - Generate a 'gnosis-access-node' configuration file
+

rolling-shutter/docs/rolling-shutter_gnosis-access-node_dump-config.md

@@ -0,0 +1,28 @@
+## rolling-shutter gnosis-access-node dump-config
+
+Dump a 'gnosis-access-node' configuration file, based on given config and env vars
+
+```
+rolling-shutter gnosis-access-node dump-config [flags]
+```
+
+### Options
+
+```
+      --config string   config file
+  -h, --help            help for dump-config
+      --output string   output file
+```
+
+### Options inherited from parent commands
+
+```
+      --logformat string   set log format, possible values:  min, short, long, max (default "long")
+      --loglevel string    set log level, possible values:  warn, info, debug (default "info")
+      --no-color           do not write colored logs
+```
+
+### SEE ALSO
+
+* [rolling-shutter gnosis-access-node](rolling-shutter_gnosis-access-node.md)	 - Run an access node for the keyper network of Shutterized Gnosis Chain
+

rolling-shutter/docs/rolling-shutter_gnosis-access-node_generate-config.md

@@ -0,0 +1,28 @@
+## rolling-shutter gnosis-access-node generate-config
+
+Generate a 'gnosis-access-node' configuration file
+
+```
+rolling-shutter gnosis-access-node generate-config [flags]
+```
+
+### Options
+
+```
+  -h, --help            help for generate-config
+      --output string   output file
+```
+
+### Options inherited from parent commands
+
+```
+      --config string      config file
+      --logformat string   set log format, possible values:  min, short, long, max (default "long")
+      --loglevel string    set log level, possible values:  warn, info, debug (default "info")
+      --no-color           do not write colored logs
+```
+
+### SEE ALSO
+
+* [rolling-shutter gnosis-access-node](rolling-shutter_gnosis-access-node.md)	 - Run an access node for the keyper network of Shutterized Gnosis Chain
+

rolling-shutter/gnosisaccessnode/config.go

@@ -0,0 +1,50 @@
+package gnosisaccessnode
+
+import (
+	"io"
+
+	"github.com/shutter-network/rolling-shutter/rolling-shutter/medley/metricsserver"
+	"github.com/shutter-network/rolling-shutter/rolling-shutter/p2p"
+)
+
+type Config struct {
+	InstanceID uint64
+
+	P2P     *p2p.Config
+	Metrics *metricsserver.MetricsConfig
+
+	MaxNumKeysPerMessage uint64
+}
+
+func (c *Config) Init() {
+	c.P2P = p2p.NewConfig()
+	c.Metrics = metricsserver.NewConfig()
+}
+
+func (c *Config) Name() string {
+	return "gnosis-access-node"
+}
+
+func (c *Config) Validate() error {
+	if err := c.P2P.Validate(); err != nil {
+		return err
+	}
+	if err := c.Metrics.Validate(); err != nil {
+		return err
+	}
+	return nil
+}
+
+func (c *Config) SetDefaultValues() error {
+	return nil
+}
+
+func (c *Config) SetExampleValues() error { //nolint:unparam
+	c.InstanceID = 1000
+	c.MaxNumKeysPerMessage = 500
+	return nil
+}
+
+func (c *Config) TOMLWriteHeader(_ io.Writer) (int, error) {
+	return 0, nil
+}

rolling-shutter/gnosisaccessnode/node.go

@@ -0,0 +1,21 @@
+package gnosisaccessnode
+
+import (
+	"context"
+
+	"github.com/shutter-network/rolling-shutter/rolling-shutter/medley/service"
+)
+
+type GnosisAccessNode struct {
+	config *Config
+}
+
+func New(config *Config) *GnosisAccessNode {
+	return &GnosisAccessNode{
+		config: config,
+	}
+}
+
+func (node *GnosisAccessNode) Start(ctx context.Context, runner service.Runner) error {
+	return nil
+}