Add basic watcher command

Author: jannikluhn

rolling-shutter/cmd/gnosiskeyper/gnosiskeyper.go

@@ -9,6 +9,7 @@ import (
 	"github.com/spf13/cobra"
 
 	"github.com/shutter-network/rolling-shutter/rolling-shutter/cmd/shversion"
+	"github.com/shutter-network/rolling-shutter/rolling-shutter/gnosiskeyperwatcher"
 	keyper "github.com/shutter-network/rolling-shutter/rolling-shutter/keyperimpl/gnosis"
 	"github.com/shutter-network/rolling-shutter/rolling-shutter/keyperimpl/gnosis/database"
 	"github.com/shutter-network/rolling-shutter/rolling-shutter/medley/configuration/command"
@@ -28,6 +29,12 @@ Shuttermint node which have to be started separately in advance.`,
 		command.WithDumpConfigSubcommand(),
 	)
 	builder.AddInitDBCommand(initDB)
+	builder.AddFunctionSubcommand(
+		watch,
+		"watch",
+		"Watch the keypers doing their work and log the generated decryption keys.",
+		cobra.NoArgs,
+	)
 	return builder.Command()
 }
 
@@ -36,7 +43,7 @@ func main(config *keyper.Config) error {
 		Str("version", shversion.Version()).
 		Str("address", config.GetAddress().Hex()).
 		Str("shuttermint", config.Shuttermint.ShuttermintURL).
-		Msg("starting gnosiskeyper")
+		Msg("starting gnosis keyper")
 
 	kpr := keyper.New(config)
 	return service.RunWithSighandler(context.Background(), kpr)
@@ -51,3 +58,8 @@ func initDB(cfg *keyper.Config) error {
 	defer dbpool.Close()
 	return db.InitDB(ctx, dbpool, database.Definition.Name(), database.Definition)
 }
+
+func watch(cfg *keyper.Config) error {
+	log.Info().Msg("starting monitor")
+	return service.RunWithSighandler(context.Background(), gnosiskeyperwatcher.New(cfg))
+}

rolling-shutter/docs/rolling-shutter_gnosiskeyper.md

@@ -32,4 +32,5 @@ rolling-shutter gnosiskeyper [flags]
 * [rolling-shutter gnosiskeyper dump-config](rolling-shutter_gnosiskeyper_dump-config.md)	 - Dump a 'gnosiskeyper' configuration file, based on given config and env vars
 * [rolling-shutter gnosiskeyper generate-config](rolling-shutter_gnosiskeyper_generate-config.md)	 - Generate a 'gnosiskeyper' configuration file
 * [rolling-shutter gnosiskeyper initdb](rolling-shutter_gnosiskeyper_initdb.md)	 - Initialize the database of the 'gnosiskeyper'
+* [rolling-shutter gnosiskeyper watch](rolling-shutter_gnosiskeyper_watch.md)	 - Watch the keypers doing their work and log the generated decryption keys.
 

rolling-shutter/docs/rolling-shutter_gnosiskeyper_watch.md

@@ -0,0 +1,27 @@
+## rolling-shutter gnosiskeyper watch
+
+Watch the keypers doing their work and log the generated decryption keys.
+
+```
+rolling-shutter gnosiskeyper watch [flags]
+```
+
+### Options
+
+```
+  -h, --help   help for watch
+```
+
+### 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 gnosiskeyper](rolling-shutter_gnosiskeyper.md)	 - Run a Shutter keyper for Gnosis Chain
+

rolling-shutter/gnosiskeyperwatcher/blocks.go

@@ -0,0 +1,57 @@
+package gnosiskeyperwatcher
+
+import (
+	"context"
+
+	"github.com/ethereum/go-ethereum/core/types"
+	"github.com/ethereum/go-ethereum/ethclient"
+	"github.com/rs/zerolog/log"
+
+	keyper "github.com/shutter-network/rolling-shutter/rolling-shutter/keyperimpl/gnosis"
+	"github.com/shutter-network/rolling-shutter/rolling-shutter/medley/service"
+)
+
+type BlocksWatcher struct {
+	config *keyper.Config
+}
+
+func NewBlocksWatcher(config *keyper.Config) *BlocksWatcher {
+	return &BlocksWatcher{
+		config: config,
+	}
+}
+
+func (w *BlocksWatcher) Start(ctx context.Context, runner service.Runner) error {
+	runner.Go(func() error {
+		ethClient, err := ethclient.Dial(w.config.Gnosis.EthereumURL)
+		if err != nil {
+			return err
+		}
+
+		newHeads := make(chan *types.Header)
+		sub, err := ethClient.SubscribeNewHead(ctx, newHeads)
+		if err != nil {
+			return err
+		}
+		defer sub.Unsubscribe()
+
+		for {
+			select {
+			case <-ctx.Done():
+				return ctx.Err()
+			case head := <-newHeads:
+				w.logNewHead(head)
+			case err := <-sub.Err():
+				return err
+			}
+		}
+	})
+	return nil
+}
+
+func (w *BlocksWatcher) logNewHead(head *types.Header) {
+	log.Info().
+		Int64("number", head.Number.Int64()).
+		Hex("hash", head.Hash().Bytes()).
+		Msg("new head")
+}

rolling-shutter/gnosiskeyperwatcher/keys.go

@@ -0,0 +1,53 @@
+package gnosiskeyperwatcher
+
+import (
+	"context"
+
+	pubsub "github.com/libp2p/go-libp2p-pubsub"
+	"github.com/rs/zerolog/log"
+
+	keyper "github.com/shutter-network/rolling-shutter/rolling-shutter/keyperimpl/gnosis"
+	"github.com/shutter-network/rolling-shutter/rolling-shutter/medley/service"
+	"github.com/shutter-network/rolling-shutter/rolling-shutter/p2p"
+	"github.com/shutter-network/rolling-shutter/rolling-shutter/p2pmsg"
+)
+
+type KeysWatcher struct {
+	config *keyper.Config
+}
+
+func NewKeysWatcher(config *keyper.Config) *KeysWatcher {
+	return &KeysWatcher{
+		config: config,
+	}
+}
+
+func (w *KeysWatcher) Start(_ context.Context, runner service.Runner) error {
+	p2pService, err := p2p.New(w.config.P2P)
+	if err != nil {
+		return err
+	}
+	p2pService.AddMessageHandler(w)
+
+	return runner.StartService(p2pService)
+}
+
+func (w *KeysWatcher) MessagePrototypes() []p2pmsg.Message {
+	return []p2pmsg.Message{
+		&p2pmsg.DecryptionKeys{},
+	}
+}
+
+func (w *KeysWatcher) ValidateMessage(_ context.Context, _ p2pmsg.Message) (pubsub.ValidationResult, error) {
+	return pubsub.ValidationAccept, nil
+}
+
+func (w *KeysWatcher) HandleMessage(_ context.Context, msgUntyped p2pmsg.Message) ([]p2pmsg.Message, error) {
+	msg := msgUntyped.(*p2pmsg.DecryptionKeys)
+	extra := msg.Extra.(*p2pmsg.DecryptionKeys_Gnosis).Gnosis
+	log.Info().
+		Uint64("block", extra.Slot).
+		Int("num-keys", len(msg.Keys)).
+		Msg("new keys")
+	return []p2pmsg.Message{}, nil
+}

rolling-shutter/gnosiskeyperwatcher/watcher.go

@@ -0,0 +1,24 @@
+package gnosiskeyperwatcher
+
+import (
+	"context"
+
+	keyper "github.com/shutter-network/rolling-shutter/rolling-shutter/keyperimpl/gnosis"
+	"github.com/shutter-network/rolling-shutter/rolling-shutter/medley/service"
+)
+
+type Watcher struct {
+	config *keyper.Config
+}
+
+func New(config *keyper.Config) *Watcher {
+	return &Watcher{
+		config: config,
+	}
+}
+
+func (w *Watcher) Start(_ context.Context, runner service.Runner) error {
+	blocksWatcher := NewBlocksWatcher(w.config)
+	keysWatcher := NewKeysWatcher(w.config)
+	return runner.StartService(blocksWatcher, keysWatcher)
+}

rolling-shutter/medley/configuration/command/command.go

@@ -159,10 +159,8 @@ func Build[T configuration.Config](
 
 type CobraRunE func(cmd *cobra.Command, args []string) error
 
-// AddInitDBCommand attaches an additional subcommand
-// 'initdb' to the command initially built by the Build method.
-// The initDB function argument is structured in the same way than the "main"
-// function passed in to the Build method.
+// AddFunctionSubcommand attaches an additional subcommand to the command initially built by the
+// Build method. The command executes the given function and takes the given arguments.
 func (cb *CommandBuilder[T]) AddFunctionSubcommand(
 	fnc ConfigurableFunc[T],
 	use, short string,