Make MaxNumKeysPerMessage a config option

jannikluhn · jannikluhn · commit 5c5eea1c2ace · 2024-06-23T22:55:57.000+02:00
diff --git a/rolling-shutter/keyper/epochkghandler/benchmark_test.go b/rolling-shutter/keyper/epochkghandler/benchmark_test.go
@@ -18,8 +18,8 @@ import (
 )
 
 // The number of identity preimages to generate for each of the benchmark runs. Note that this must
-// be smaller than MaxNumKeysPerMessage, otherwise the benchmarks will fail.
-const numIdentityPreimages = 100
+// be smaller than config.GetMaxNumKeysPerMessage(), otherwise the benchmarks will fail.
+const numIdentityPreimages = 1000
 
 func prepareBenchmark(ctx context.Context, b *testing.B, dbpool *pgxpool.Pool) (*testkeygen.EonKeys, []identitypreimage.IdentityPreimage) {
 	b.Helper()
diff --git a/rolling-shutter/keyper/epochkghandler/key.go b/rolling-shutter/keyper/epochkghandler/key.go
@@ -19,8 +19,6 @@ import (
 	"github.com/shutter-network/rolling-shutter/rolling-shutter/shdb"
 )
 
-const MaxNumKeysPerMessage = 128
-
 func NewDecryptionKeyHandler(config Config, dbpool *pgxpool.Pool) p2p.MessageHandler {
 	return &DecryptionKeyHandler{config: config, dbpool: dbpool}
 }
@@ -73,8 +71,8 @@ func (handler *DecryptionKeyHandler) ValidateMessage(ctx context.Context, msg p2
 	if len(key.Keys) == 0 {
 		return pubsub.ValidationReject, errors.New("no keys in message")
 	}
-	if len(key.Keys) > MaxNumKeysPerMessage {
-		return pubsub.ValidationReject, errors.Errorf("too many keys in message (%d > %d)", len(key.Keys), MaxNumKeysPerMessage)
+	if len(key.Keys) > int(handler.config.GetMaxNumKeysPerMessage()) {
+		return pubsub.ValidationReject, errors.Errorf("too many keys in message (%d > %d)", len(key.Keys), handler.config.GetMaxNumKeysPerMessage())
 	}
 	for i, k := range key.Keys {
 		epochSecretKey, err := k.GetEpochSecretKey()
diff --git a/rolling-shutter/keyper/epochkghandler/keyshare.go b/rolling-shutter/keyper/epochkghandler/keyshare.go
@@ -73,8 +73,8 @@ func (handler *DecryptionKeyShareHandler) ValidateMessage(ctx context.Context, m
 	if len(keyShare.Shares) == 0 {
 		return pubsub.ValidationReject, errors.New("no key shares in message")
 	}
-	if len(keyShare.Shares) > MaxNumKeysPerMessage {
-		return pubsub.ValidationReject, errors.Errorf("too many key shares in message (%d > %d)", len(keyShare.Shares), MaxNumKeysPerMessage)
+	if len(keyShare.Shares) > int(handler.config.GetMaxNumKeysPerMessage()) {
+		return pubsub.ValidationReject, errors.Errorf("too many key shares in message (%d > %d)", len(keyShare.Shares), handler.config.GetMaxNumKeysPerMessage())
 	}
 	shares := keyShare.GetShares()
 	for i, share := range shares {
diff --git a/rolling-shutter/keyper/epochkghandler/sendkeyshare.go b/rolling-shutter/keyper/epochkghandler/sendkeyshare.go
@@ -17,6 +17,7 @@ import (
 type Config interface {
 	GetAddress() common.Address
 	GetInstanceID() uint64
+	GetMaxNumKeysPerMessage() uint64
 }
 
 type DecryptionTrigger struct {
@@ -54,8 +55,8 @@ func (ksh *KeyShareHandler) ConstructDecryptionKeyShares(
 	if len(identityPreimages) == 0 {
 		return nil, errors.New("cannot generate empty decryption key share")
 	}
-	if len(identityPreimages) > MaxNumKeysPerMessage {
-		return nil, errors.Errorf("too many decryption key shares for message (%d > %d)", len(identityPreimages), MaxNumKeysPerMessage)
+	if len(identityPreimages) > int(ksh.MaxNumKeysPerMessage) {
+		return nil, errors.Errorf("too many decryption key shares for message (%d > %d)", len(identityPreimages), ksh.MaxNumKeysPerMessage)
 	}
 
 	db := database.New(ksh.DBPool)
diff --git a/rolling-shutter/keyper/epochkghandler/service.go b/rolling-shutter/keyper/epochkghandler/service.go
@@ -18,9 +18,10 @@ import (
 var DefaultKeyShareHandlerRetryOpts = []retry.Option{}
 
 type KeyShareHandler struct {
-	InstanceID    uint64
-	KeyperAddress common.Address
-	DBPool        *pgxpool.Pool
+	InstanceID           uint64
+	KeyperAddress        common.Address
+	MaxNumKeysPerMessage uint64
+	DBPool               *pgxpool.Pool
 
 	Messaging p2p.Messaging
 	Trigger   <-chan *broker.Event[*DecryptionTrigger]
diff --git a/rolling-shutter/keyper/epochkghandler/setup_test.go b/rolling-shutter/keyper/epochkghandler/setup_test.go
@@ -28,4 +28,8 @@ func (c *TestConfig) GetCollatorKey() *ecdsa.PrivateKey {
 	return nil
 }
 
+func (c *TestConfig) GetMaxNumKeysPerMessage() uint64 {
+	return 1024
+}
+
 var _ testsetup.TestConfig = &TestConfig{}
diff --git a/rolling-shutter/keyper/epochkghandler/trigger_test.go b/rolling-shutter/keyper/epochkghandler/trigger_test.go
@@ -39,11 +39,12 @@ func TestHandleDecryptionTriggerIntegration(t *testing.T) {
 	assert.NilError(t, err)
 
 	ksh := &KeyShareHandler{
-		InstanceID:    config.GetInstanceID(),
-		KeyperAddress: config.GetAddress(),
-		DBPool:        dbpool,
-		Messaging:     messaging,
-		Trigger:       decrTrigChan,
+		InstanceID:           config.GetInstanceID(),
+		KeyperAddress:        config.GetAddress(),
+		MaxNumKeysPerMessage: config.GetMaxNumKeysPerMessage(),
+		DBPool:               dbpool,
+		Messaging:            messaging,
+		Trigger:              decrTrigChan,
 	}
 	group, cleanup := service.RunBackground(
 		ctx,
diff --git a/rolling-shutter/keyper/keyper.go b/rolling-shutter/keyper/keyper.go
@@ -185,11 +185,12 @@ func (kpr *KeyperCore) getServices() []service.Service {
 		keyTrigger = fanIn.C
 	}
 	keyShareHandler := &epochkghandler.KeyShareHandler{
-		InstanceID:    kpr.config.GetInstanceID(),
-		KeyperAddress: kpr.config.GetAddress(),
-		DBPool:        kpr.dbpool,
-		Messaging:     kpr.messaging,
-		Trigger:       keyTrigger,
+		InstanceID:           kpr.config.GetInstanceID(),
+		KeyperAddress:        kpr.config.GetAddress(),
+		MaxNumKeysPerMessage: kpr.config.GetMaxNumKeysPerMessage(),
+		DBPool:               kpr.dbpool,
+		Messaging:            kpr.messaging,
+		Trigger:              keyTrigger,
 	}
 	services = append(services, keyShareHandler)
 	if kpr.config.Metrics.Enabled {
diff --git a/rolling-shutter/keyper/kprconfig/config.go b/rolling-shutter/keyper/kprconfig/config.go
@@ -29,6 +29,8 @@ type Config struct {
 	Shuttermint *ShuttermintConfig
 	Ethereum    *configuration.EthnodeConfig
 	Metrics     *metricsserver.MetricsConfig
+
+	MaxNumKeysPerMessage uint64
 }
 
 func (c *Config) GetAddress() common.Address {
@@ -57,6 +59,10 @@ func (c *Config) GetHTTPListenAddress() string {
 	return c.HTTPListenAddress
 }
 
+func (c *Config) GetMaxNumKeysPerMessage() uint64 {
+	return c.MaxNumKeysPerMessage
+}
+
 func NewShuttermintConfig() *ShuttermintConfig {
 	c := &ShuttermintConfig{}
 	c.Init()
diff --git a/rolling-shutter/keyperimpl/gnosis/config.go b/rolling-shutter/keyperimpl/gnosis/config.go
@@ -49,6 +49,8 @@ type Config struct {
 	P2P         *p2p.Config
 	Shuttermint *kprconfig.ShuttermintConfig
 	Metrics     *metricsserver.MetricsConfig
+
+	MaxNumKeysPerMessage uint64
 }
 
 func (c *Config) Validate() error {
@@ -71,6 +73,7 @@ func (c *Config) SetDefaultValues() error {
 	c.HTTPListenAddress = ":3000"
 	c.Gnosis.EncryptedGasLimit = 1_000_000
 	c.Gnosis.MinGasPerTransaction = 21_000
+	c.MaxNumKeysPerMessage = 500
 	return nil
 }
 
diff --git a/rolling-shutter/keyperimpl/gnosis/keyper.go b/rolling-shutter/keyperimpl/gnosis/keyper.go
@@ -108,14 +108,15 @@ func (kpr *Keyper) Start(ctx context.Context, runner service.Runner) error {
 
 	kpr.core, err = keyper.New(
 		&kprconfig.Config{
-			InstanceID:        kpr.config.InstanceID,
-			DatabaseURL:       kpr.config.DatabaseURL,
-			HTTPEnabled:       kpr.config.HTTPEnabled,
-			HTTPListenAddress: kpr.config.HTTPListenAddress,
-			P2P:               kpr.config.P2P,
-			Ethereum:          kpr.config.Gnosis.Node,
-			Shuttermint:       kpr.config.Shuttermint,
-			Metrics:           kpr.config.Metrics,
+			InstanceID:           kpr.config.InstanceID,
+			DatabaseURL:          kpr.config.DatabaseURL,
+			HTTPEnabled:          kpr.config.HTTPEnabled,
+			HTTPListenAddress:    kpr.config.HTTPListenAddress,
+			P2P:                  kpr.config.P2P,
+			Ethereum:             kpr.config.Gnosis.Node,
+			Shuttermint:          kpr.config.Shuttermint,
+			Metrics:              kpr.config.Metrics,
+			MaxNumKeysPerMessage: kpr.config.MaxNumKeysPerMessage,
 		},
 		kpr.decryptionTriggerChannel,
 		keyper.WithDBPool(kpr.dbpool),
diff --git a/rolling-shutter/keyperimpl/optimism/config/config.go b/rolling-shutter/keyperimpl/optimism/config/config.go
@@ -37,6 +37,8 @@ type Config struct {
 	Optimism    *OptimismConfig
 	Shuttermint *kprconfig.ShuttermintConfig
 	Metrics     *metricsserver.MetricsConfig
+
+	MaxNumKeysPerMessage uint64
 }
 
 func (c *Config) Validate() error {
@@ -50,6 +52,7 @@ func (c *Config) Name() string {
 func (c *Config) SetDefaultValues() error {
 	c.HTTPEnabled = false
 	c.HTTPListenAddress = ":3000"
+	c.MaxNumKeysPerMessage = 500
 	return nil
 }
 
diff --git a/rolling-shutter/keyperimpl/optimism/keyper.go b/rolling-shutter/keyperimpl/optimism/keyper.go
@@ -60,14 +60,15 @@ func (kpr *Keyper) Start(ctx context.Context, runner service.Runner) error {
 	ethConfig.PrivateKey = kpr.config.Optimism.PrivateKey
 	kpr.core, err = keyper.New(
 		&kprconfig.Config{
-			InstanceID:        kpr.config.InstanceID,
-			DatabaseURL:       kpr.config.DatabaseURL,
-			HTTPEnabled:       kpr.config.HTTPEnabled,
-			HTTPListenAddress: kpr.config.HTTPListenAddress,
-			P2P:               kpr.config.P2P,
-			Ethereum:          ethConfig,
-			Shuttermint:       kpr.config.Shuttermint,
-			Metrics:           kpr.config.Metrics,
+			InstanceID:           kpr.config.InstanceID,
+			DatabaseURL:          kpr.config.DatabaseURL,
+			HTTPEnabled:          kpr.config.HTTPEnabled,
+			HTTPListenAddress:    kpr.config.HTTPListenAddress,
+			P2P:                  kpr.config.P2P,
+			Ethereum:             ethConfig,
+			Shuttermint:          kpr.config.Shuttermint,
+			Metrics:              kpr.config.Metrics,
+			MaxNumKeysPerMessage: kpr.config.MaxNumKeysPerMessage,
 		},
 		trigger,
 		keyper.WithDBPool(dbpool),
diff --git a/rolling-shutter/keyperimpl/snapshot/config.go b/rolling-shutter/keyperimpl/snapshot/config.go
@@ -37,6 +37,8 @@ type Config struct {
 	Ethereum    *configuration.EthnodeConfig
 	Shuttermint *kprconfig.ShuttermintConfig
 	Metrics     *metricsserver.MetricsConfig
+
+	MaxNumKeysPerMessage uint64
 }
 
 func (c *Config) Validate() error {
@@ -50,6 +52,7 @@ func (c *Config) Name() string {
 func (c *Config) SetDefaultValues() error {
 	c.HTTPEnabled = false
 	c.HTTPListenAddress = ":3000"
+	c.MaxNumKeysPerMessage = 500
 	return nil
 }
 
diff --git a/rolling-shutter/keyperimpl/snapshot/keyper.go b/rolling-shutter/keyperimpl/snapshot/keyper.go
@@ -63,14 +63,15 @@ func (kpr *Keyper) Start(ctx context.Context, runner service.Runner) error {
 	}
 	kpr.core, err = keyper.New(
 		&kprconfig.Config{
-			InstanceID:        kpr.config.InstanceID,
-			DatabaseURL:       kpr.config.DatabaseURL,
-			HTTPEnabled:       kpr.config.HTTPEnabled,
-			HTTPListenAddress: kpr.config.HTTPListenAddress,
-			P2P:               kpr.config.P2P,
-			Ethereum:          kpr.config.Ethereum,
-			Shuttermint:       kpr.config.Shuttermint,
-			Metrics:           kpr.config.Metrics,
+			InstanceID:           kpr.config.InstanceID,
+			DatabaseURL:          kpr.config.DatabaseURL,
+			HTTPEnabled:          kpr.config.HTTPEnabled,
+			HTTPListenAddress:    kpr.config.HTTPListenAddress,
+			P2P:                  kpr.config.P2P,
+			Ethereum:             kpr.config.Ethereum,
+			Shuttermint:          kpr.config.Shuttermint,
+			Metrics:              kpr.config.Metrics,
+			MaxNumKeysPerMessage: kpr.config.MaxNumKeysPerMessage,
 		},
 		decrTrigChan,
 		keyper.WithMessageHandler(NewDecryptionTriggerHandler(*kpr.config, dbpool, kpr.trigger)),

Original file line number	Diff line number	Diff line change
`@@ -18,8 +18,8 @@ import (`
`18`	`18`	`)`
`19`	`19`
`20`	`20`	`// The number of identity preimages to generate for each of the benchmark runs. Note that this must`
`21`		`-// be smaller than MaxNumKeysPerMessage, otherwise the benchmarks will fail.`
`22`		`-const numIdentityPreimages = 100`
	`21`	`+// be smaller than config.GetMaxNumKeysPerMessage(), otherwise the benchmarks will fail.`
	`22`	`+const numIdentityPreimages = 1000`
`23`	`23`
`24`	`24`	`func prepareBenchmark(ctx context.Context, b testing.B, dbpool pgxpool.Pool) (*testkeygen.EonKeys, []identitypreimage.IdentityPreimage) {`
`25`	`25`	`b.Helper()`
Original file line number	Diff line number	Diff line change
`@@ -19,8 +19,6 @@ import (`
`19`	`19`	`"github.com/shutter-network/rolling-shutter/rolling-shutter/shdb"`
`20`	`20`	`)`
`21`	`21`
`22`		`-const MaxNumKeysPerMessage = 128`
`23`		`-`
`24`	`22`	`func NewDecryptionKeyHandler(config Config, dbpool *pgxpool.Pool) p2p.MessageHandler {`
`25`	`23`	`return &DecryptionKeyHandler{config: config, dbpool: dbpool}`
`26`	`24`	`}`
`@@ -73,8 +71,8 @@ func (handler *DecryptionKeyHandler) ValidateMessage(ctx context.Context, msg p2`
`73`	`71`	`if len(key.Keys) == 0 {`
`74`	`72`	`return pubsub.ValidationReject, errors.New("no keys in message")`
`75`	`73`	`}`
`76`		`- if len(key.Keys) > MaxNumKeysPerMessage {`
`77`		`- return pubsub.ValidationReject, errors.Errorf("too many keys in message (%d > %d)", len(key.Keys), MaxNumKeysPerMessage)`
	`74`	`+ if len(key.Keys) > int(handler.config.GetMaxNumKeysPerMessage()) {`
	`75`	`+ return pubsub.ValidationReject, errors.Errorf("too many keys in message (%d > %d)", len(key.Keys), handler.config.GetMaxNumKeysPerMessage())`
`78`	`76`	`}`
`79`	`77`	`for i, k := range key.Keys {`
`80`	`78`	`epochSecretKey, err := k.GetEpochSecretKey()`
Original file line number	Diff line number	Diff line change
`@@ -73,8 +73,8 @@ func (handler *DecryptionKeyShareHandler) ValidateMessage(ctx context.Context, m`
`73`	`73`	`if len(keyShare.Shares) == 0 {`
`74`	`74`	`return pubsub.ValidationReject, errors.New("no key shares in message")`
`75`	`75`	`}`
`76`		`- if len(keyShare.Shares) > MaxNumKeysPerMessage {`
`77`		`- return pubsub.ValidationReject, errors.Errorf("too many key shares in message (%d > %d)", len(keyShare.Shares), MaxNumKeysPerMessage)`
	`76`	`+ if len(keyShare.Shares) > int(handler.config.GetMaxNumKeysPerMessage()) {`
	`77`	`+ return pubsub.ValidationReject, errors.Errorf("too many key shares in message (%d > %d)", len(keyShare.Shares), handler.config.GetMaxNumKeysPerMessage())`
`78`	`78`	`}`
`79`	`79`	`shares := keyShare.GetShares()`
`80`	`80`	`for i, share := range shares {`
Original file line number	Diff line number	Diff line change
`@@ -17,6 +17,7 @@ import (`
`17`	`17`	`type Config interface {`
`18`	`18`	`GetAddress() common.Address`
`19`	`19`	`GetInstanceID() uint64`
	`20`	`+ GetMaxNumKeysPerMessage() uint64`
`20`	`21`	`}`
`21`	`22`
`22`	`23`	`type DecryptionTrigger struct {`
`@@ -54,8 +55,8 @@ func (ksh *KeyShareHandler) ConstructDecryptionKeyShares(`
`54`	`55`	`if len(identityPreimages) == 0 {`
`55`	`56`	`return nil, errors.New("cannot generate empty decryption key share")`
`56`	`57`	`}`
`57`		`- if len(identityPreimages) > MaxNumKeysPerMessage {`
`58`		`- return nil, errors.Errorf("too many decryption key shares for message (%d > %d)", len(identityPreimages), MaxNumKeysPerMessage)`
	`58`	`+ if len(identityPreimages) > int(ksh.MaxNumKeysPerMessage) {`
	`59`	`+ return nil, errors.Errorf("too many decryption key shares for message (%d > %d)", len(identityPreimages), ksh.MaxNumKeysPerMessage)`
`59`	`60`	`}`
`60`	`61`
`61`	`62`	`db := database.New(ksh.DBPool)`
Original file line number	Diff line number	Diff line change
`@@ -28,4 +28,8 @@ func (c TestConfig) GetCollatorKey() ecdsa.PrivateKey {`
`28`	`28`	`return nil`
`29`	`29`	`}`
`30`	`30`
	`31`	`+func (c *TestConfig) GetMaxNumKeysPerMessage() uint64 {`
	`32`	`+ return 1024`
	`33`	`+}`
	`34`	`+`
`31`	`35`	`var _ testsetup.TestConfig = &TestConfig{}`
Original file line number	Diff line number	Diff line change
`@@ -49,6 +49,8 @@ type Config struct {`
`49`	`49`	`P2P *p2p.Config`
`50`	`50`	`Shuttermint *kprconfig.ShuttermintConfig`
`51`	`51`	`Metrics *metricsserver.MetricsConfig`
	`52`	`+`
	`53`	`+ MaxNumKeysPerMessage uint64`
`52`	`54`	`}`
`53`	`55`
`54`	`56`	`func (c *Config) Validate() error {`
`@@ -71,6 +73,7 @@ func (c *Config) SetDefaultValues() error {`
`71`	`73`	`c.HTTPListenAddress = ":3000"`
`72`	`74`	`c.Gnosis.EncryptedGasLimit = 1_000_000`
`73`	`75`	`c.Gnosis.MinGasPerTransaction = 21_000`
	`76`	`+ c.MaxNumKeysPerMessage = 500`
`74`	`77`	`return nil`
`75`	`78`	`}`
`76`	`79`