Merge pull request #560 from shutter-network/shutter-service

Shutter service

Author: blockchainluffy

rolling-shutter/cmd/command.go

@@ -10,6 +10,7 @@ import (
 	"github.com/shutter-network/rolling-shutter/rolling-shutter/cmd/gnosiskeyper"
 	"github.com/shutter-network/rolling-shutter/rolling-shutter/cmd/optimism"
 	"github.com/shutter-network/rolling-shutter/rolling-shutter/cmd/p2pnode"
+	"github.com/shutter-network/rolling-shutter/rolling-shutter/cmd/shutterservicekeyper"
 	"github.com/shutter-network/rolling-shutter/rolling-shutter/cmd/snapshot"
 	"github.com/shutter-network/rolling-shutter/rolling-shutter/cmd/snapshotkeyper"
 	"github.com/shutter-network/rolling-shutter/rolling-shutter/medley/rootcmd"
@@ -27,6 +28,7 @@ func Subcommands() []*cobra.Command {
 		gnosisaccessnode.Cmd(),
 		cryptocmd.Cmd(),
 		p2pnode.Cmd(),
+		shutterservicekeyper.Cmd(),
 	}
 }
 

rolling-shutter/cmd/shutterservicekeyper/shutterservicekeyper.go

@@ -0,0 +1,53 @@
+package shutterservicekeyper
+
+import (
+	"context"
+
+	"github.com/jackc/pgx/v4/pgxpool"
+	"github.com/pkg/errors"
+	"github.com/rs/zerolog/log"
+	"github.com/spf13/cobra"
+
+	"github.com/shutter-network/rolling-shutter/rolling-shutter/cmd/shversion"
+	keyper "github.com/shutter-network/rolling-shutter/rolling-shutter/keyperimpl/shutterservice"
+	"github.com/shutter-network/rolling-shutter/rolling-shutter/keyperimpl/shutterservice/database"
+	"github.com/shutter-network/rolling-shutter/rolling-shutter/medley/configuration/command"
+	"github.com/shutter-network/rolling-shutter/rolling-shutter/medley/db"
+	"github.com/shutter-network/rolling-shutter/rolling-shutter/medley/service"
+)
+
+func Cmd() *cobra.Command {
+	builder := command.Build(
+		main,
+		command.Usage(
+			"Run a Shutter keyper for Shutter Service",
+			`This command runs a keyper node. It will connect to both a Shutter service and a
+Shuttermint node which have to be started separately in advance.`,
+		),
+		command.WithGenerateConfigSubcommand(),
+		command.WithDumpConfigSubcommand(),
+	)
+	builder.AddInitDBCommand(initDB)
+	return builder.Command()
+}
+
+func main(config *keyper.Config) error {
+	log.Info().
+		Str("version", shversion.Version()).
+		Str("address", config.GetAddress().Hex()).
+		Str("shuttermint", config.Shuttermint.ShuttermintURL).
+		Msg("starting shutter service keyper")
+
+	kpr := keyper.New(config)
+	return service.RunWithSighandler(context.Background(), kpr)
+}
+
+func initDB(cfg *keyper.Config) error {
+	ctx := context.Background()
+	dbpool, err := pgxpool.Connect(ctx, cfg.DatabaseURL)
+	if err != nil {
+		return errors.Wrap(err, "failed to connect to database")
+	}
+	defer dbpool.Close()
+	return db.InitDB(ctx, dbpool, database.Definition.Name(), database.Definition)
+}

rolling-shutter/docs/rolling-shutter.md

@@ -21,6 +21,7 @@ A collection of commands to run and interact with Rolling Shutter nodes
 * [rolling-shutter op-bootstrap](rolling-shutter_op-bootstrap.md)	 - Bootstrap validator utility functions for a shuttermint chain
 * [rolling-shutter op-keyper](rolling-shutter_op-keyper.md)	 - Run a Shutter optimism keyper node
 * [rolling-shutter p2pnode](rolling-shutter_p2pnode.md)	 - Run a Shutter p2p bootstrap node
+* [rolling-shutter shutterservicekeyper](rolling-shutter_shutterservicekeyper.md)	 - Run a Shutter keyper for Shutter Service
 * [rolling-shutter snapshot](rolling-shutter_snapshot.md)	 - Run the Snapshot Hub communication module
 * [rolling-shutter snapshotkeyper](rolling-shutter_snapshotkeyper.md)	 - Run a Shutter snapshotkeyper node
 

rolling-shutter/docs/rolling-shutter_shutterservicekeyper.md

@@ -0,0 +1,35 @@
+## rolling-shutter shutterservicekeyper
+
+Run a Shutter keyper for Shutter Service
+
+### Synopsis
+
+This command runs a keyper node. It will connect to both a Shutter service and a
+Shuttermint node which have to be started separately in advance.
+
+```
+rolling-shutter shutterservicekeyper [flags]
+```
+
+### Options
+
+```
+      --config string   config file
+  -h, --help            help for shutterservicekeyper
+```
+
+### 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 shutterservicekeyper dump-config](rolling-shutter_shutterservicekeyper_dump-config.md)	 - Dump a 'shutterservicekeyper' configuration file, based on given config and env vars
+* [rolling-shutter shutterservicekeyper generate-config](rolling-shutter_shutterservicekeyper_generate-config.md)	 - Generate a 'shutterservicekeyper' configuration file
+* [rolling-shutter shutterservicekeyper initdb](rolling-shutter_shutterservicekeyper_initdb.md)	 - Initialize the database of the 'shutterservicekeyper'
+

rolling-shutter/docs/rolling-shutter_shutterservicekeyper_dump-config.md

@@ -0,0 +1,29 @@
+## rolling-shutter shutterservicekeyper dump-config
+
+Dump a 'shutterservicekeyper' configuration file, based on given config and env vars
+
+```
+rolling-shutter shutterservicekeyper dump-config [flags]
+```
+
+### Options
+
+```
+      --config string   config file
+  -f, --force           overwrite existing 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 shutterservicekeyper](rolling-shutter_shutterservicekeyper.md)	 - Run a Shutter keyper for Shutter Service
+

rolling-shutter/docs/rolling-shutter_shutterservicekeyper_generate-config.md

@@ -0,0 +1,29 @@
+## rolling-shutter shutterservicekeyper generate-config
+
+Generate a 'shutterservicekeyper' configuration file
+
+```
+rolling-shutter shutterservicekeyper generate-config [flags]
+```
+
+### Options
+
+```
+  -f, --force           overwrite existing file
+  -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 shutterservicekeyper](rolling-shutter_shutterservicekeyper.md)	 - Run a Shutter keyper for Shutter Service
+

rolling-shutter/docs/rolling-shutter_shutterservicekeyper_initdb.md

@@ -0,0 +1,27 @@
+## rolling-shutter shutterservicekeyper initdb
+
+Initialize the database of the 'shutterservicekeyper'
+
+```
+rolling-shutter shutterservicekeyper initdb [flags]
+```
+
+### Options
+
+```
+  -h, --help   help for initdb
+```
+
+### 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 shutterservicekeyper](rolling-shutter_shutterservicekeyper.md)	 - Run a Shutter keyper for Shutter Service
+

rolling-shutter/go.mod

@@ -31,6 +31,7 @@ require (
 	github.com/pkg/errors v0.9.1
 	github.com/prometheus/client_golang v1.19.1
 	github.com/rs/zerolog v1.28.0
+	github.com/shutter-network/contracts/v2 v2.0.0-beta.2.0.20250108084129-3b743179373a
 	github.com/shutter-network/gnosh-contracts v0.4.0
 	github.com/shutter-network/shop-contracts v0.0.0-20240407151512-08ef5d8355b6
 	github.com/shutter-network/shutter/shlib v0.1.19

rolling-shutter/go.sum

@@ -864,6 +864,8 @@ github.com/shurcooL/sanitized_anchor_name v0.0.0-20170918181015-86672fcb3f95/go.
 github.com/shurcooL/sanitized_anchor_name v1.0.0/go.mod h1:1NzhyTcUVG4SuEtjjoZeVRXNmyL/1OwPU0+IJeTBvfc=
 github.com/shurcooL/users v0.0.0-20180125191416-49c67e49c537/go.mod h1:QJTqeLYEDaXHZDBsXlPCDqdhQuJkuw4NOtaxYe3xii4=
 github.com/shurcooL/webdavfs v0.0.0-20170829043945-18c3829fa133/go.mod h1:hKmq5kWdCj2z2KEozexVbfEZIWiTjhE0+UjmZgPqehw=
+github.com/shutter-network/contracts/v2 v2.0.0-beta.2.0.20250108084129-3b743179373a h1:hWw2nJLGPZU7Rvd6YmEEDfvlTUbwZKZl5UP2ThVVNSU=
+github.com/shutter-network/contracts/v2 v2.0.0-beta.2.0.20250108084129-3b743179373a/go.mod h1:V8KhVM75wyWVSzZJ6GeC9dWCjRrinIQVb7mYNP+knbg=
 github.com/shutter-network/gnosh-contracts v0.4.0 h1:2GJcHK9w4lJZMsccklmxDhNnrkRLJDRwsL1acBnAeak=
 github.com/shutter-network/gnosh-contracts v0.4.0/go.mod h1:QB0d64ybbVFKMrLjrc1tldri87KNjTmKQjhk9jaso2E=
 github.com/shutter-network/shop-contracts v0.0.0-20240407151512-08ef5d8355b6 h1:m6Ti1/IH+GBTtGqyAX3xbh+ruUKvC+m+/uzYDUa+JDQ=

rolling-shutter/keyperimpl/shutterservice/config.go

@@ -0,0 +1,159 @@
+package shutterservice
+
+import (
+	"io"
+
+	"github.com/ethereum/go-ethereum/common"
+
+	"github.com/shutter-network/rolling-shutter/rolling-shutter/keyper/kprconfig"
+	"github.com/shutter-network/rolling-shutter/rolling-shutter/medley/configuration"
+	"github.com/shutter-network/rolling-shutter/rolling-shutter/medley/metricsserver"
+	"github.com/shutter-network/rolling-shutter/rolling-shutter/p2p"
+)
+
+var (
+	_ configuration.Config = &Config{}
+	_ configuration.Config = &ChainConfig{}
+	_ configuration.Config = &ContractsConfig{}
+)
+
+func NewConfig() *Config {
+	c := &Config{}
+	c.Init()
+	return c
+}
+
+func (c *Config) Init() {
+	c.P2P = p2p.NewConfig()
+	c.Shuttermint = kprconfig.NewShuttermintConfig()
+	c.Metrics = metricsserver.NewConfig()
+	c.Chain = NewChainConfig()
+}
+
+type Config struct {
+	InstanceID  uint64 `shconfig:",required"`
+	DatabaseURL string `shconfig:",required" comment:"If it's empty, we use the standard PG_ environment variables"`
+
+	HTTPEnabled       bool
+	HTTPListenAddress string
+
+	Chain       *ChainConfig
+	P2P         *p2p.Config
+	Shuttermint *kprconfig.ShuttermintConfig
+	Metrics     *metricsserver.MetricsConfig
+
+	MaxNumKeysPerMessage uint64
+}
+
+func (c *Config) Validate() error {
+	// TODO: needs to be implemented
+	return nil
+}
+
+func (c *Config) Name() string {
+	return "shutterservicekeyper"
+}
+
+func (c *Config) SetDefaultValues() error {
+	c.HTTPEnabled = false
+	c.HTTPListenAddress = ":3000"
+	c.MaxNumKeysPerMessage = 500 // TODO: need to confirm on this
+	return nil
+}
+
+func (c *Config) SetExampleValues() error {
+	err := c.SetDefaultValues()
+	if err != nil {
+		return err
+	}
+	c.InstanceID = 42
+	c.DatabaseURL = "postgres://pguser:pgpassword@localhost:5432/shutter"
+
+	return nil
+}
+
+func (c Config) TOMLWriteHeader(_ io.Writer) (int, error) {
+	return 0, nil
+}
+
+func (c *Config) GetAddress() common.Address {
+	return c.Chain.Node.PrivateKey.EthereumAddress()
+}
+
+type ChainConfig struct {
+	Node                 *configuration.EthnodeConfig `shconfig:",required"`
+	Contracts            *ContractsConfig             `shconfig:",required"`
+	SyncStartBlockNumber uint64                       `shconfig:",required"`
+}
+
+func NewChainConfig() *ChainConfig {
+	c := &ChainConfig{
+		Node:                 configuration.NewEthnodeConfig(),
+		Contracts:            NewContractsConfig(),
+		SyncStartBlockNumber: 0,
+	}
+	c.Init()
+	return c
+}
+
+func (c *ChainConfig) Init() {
+	c.Node.Init()
+	c.Contracts.Init()
+}
+
+func (c *ChainConfig) Name() string {
+	return "chain"
+}
+
+func (c *ChainConfig) Validate() error {
+	return nil
+}
+
+func (c *ChainConfig) SetDefaultValues() error {
+	c.SyncStartBlockNumber = 0
+	return c.Contracts.SetDefaultValues()
+}
+
+func (c *ChainConfig) SetExampleValues() error {
+	return nil
+}
+
+func (c *ChainConfig) TOMLWriteHeader(_ io.Writer) (int, error) {
+	return 0, nil
+}
+
+type ContractsConfig struct {
+	KeyperSetManager     common.Address `shconfig:",required"`
+	ShutterRegistry      common.Address `shconfig:",required"`
+	KeyBroadcastContract common.Address `shconfig:",required"`
+}
+
+func NewContractsConfig() *ContractsConfig {
+	return &ContractsConfig{
+		KeyperSetManager:     common.Address{},
+		ShutterRegistry:      common.Address{},
+		KeyBroadcastContract: common.Address{},
+	}
+}
+
+func (c *ContractsConfig) Init() {}
+
+func (c *ContractsConfig) Name() string {
+	return "contracts"
+}
+
+func (c *ContractsConfig) Validate() error {
+	return nil
+}
+
+func (c *ContractsConfig) SetDefaultValues() error {
+	return nil
+}
+
+func (c *ContractsConfig) SetExampleValues() error {
+	return nil
+}
+
+func (c *ContractsConfig) TOMLWriteHeader(_ io.Writer) (int, error) {
+	return 0, nil
+}