chore!: move syncer to medley

Author: ezdac

rolling-shutter/keyperimpl/optimism/bootstrap/bootstrap.go

@@ -10,7 +10,7 @@ import (
 	"github.com/tendermint/tendermint/rpc/client/http"
 
 	"github.com/shutter-network/rolling-shutter/rolling-shutter/keyper/fx"
-	"github.com/shutter-network/rolling-shutter/rolling-shutter/keyperimpl/optimism/sync/event"
+	"github.com/shutter-network/rolling-shutter/rolling-shutter/medley/chainsync/event"
 	"github.com/shutter-network/rolling-shutter/rolling-shutter/shmsg"
 )
 

rolling-shutter/keyperimpl/optimism/bootstrap/keyperset.go

@@ -6,15 +6,15 @@ import (
 	"errors"
 	"os"
 
-	"github.com/shutter-network/rolling-shutter/rolling-shutter/keyperimpl/optimism/sync"
-	"github.com/shutter-network/rolling-shutter/rolling-shutter/keyperimpl/optimism/sync/event"
+	"github.com/shutter-network/rolling-shutter/rolling-shutter/medley/chainsync"
+	"github.com/shutter-network/rolling-shutter/rolling-shutter/medley/chainsync/event"
 	"github.com/shutter-network/rolling-shutter/rolling-shutter/medley/encodeable/number"
 )
 
 func GetKeyperSet(ctx context.Context, config *Config) error {
-	sl2, err := sync.NewShutterL2Client(
+	sl2, err := chainsync.NewClient(
 		ctx,
-		sync.WithClientURL(config.JSONRPCURL),
+		chainsync.WithClientURL(config.JSONRPCURL),
 	)
 	if err != nil {
 		return err

rolling-shutter/keyperimpl/optimism/keyper.go

@@ -15,10 +15,10 @@ import (
 	"github.com/shutter-network/rolling-shutter/rolling-shutter/keyper/kprconfig"
 	"github.com/shutter-network/rolling-shutter/rolling-shutter/keyperimpl/optimism/config"
 	"github.com/shutter-network/rolling-shutter/rolling-shutter/keyperimpl/optimism/database"
-	shopclient "github.com/shutter-network/rolling-shutter/rolling-shutter/keyperimpl/optimism/sync"
-	shopevent "github.com/shutter-network/rolling-shutter/rolling-shutter/keyperimpl/optimism/sync/event"
 	"github.com/shutter-network/rolling-shutter/rolling-shutter/medley"
 	"github.com/shutter-network/rolling-shutter/rolling-shutter/medley/broker"
+	"github.com/shutter-network/rolling-shutter/rolling-shutter/medley/chainsync"
+	syncevent "github.com/shutter-network/rolling-shutter/rolling-shutter/medley/chainsync/event"
 	"github.com/shutter-network/rolling-shutter/rolling-shutter/medley/configuration"
 	"github.com/shutter-network/rolling-shutter/rolling-shutter/medley/db"
 	"github.com/shutter-network/rolling-shutter/rolling-shutter/medley/identitypreimage"
@@ -30,7 +30,7 @@ var ErrParseKeyperSet = errors.New("can't parse KeyperSet")
 
 type Keyper struct {
 	core     *keyper.KeyperCore
-	l2Client *shopclient.ShutterL2Client
+	l2Client *chainsync.Client
 	dbpool   *pgxpool.Pool
 	config   *config.Config
 
@@ -78,20 +78,20 @@ func (kpr *Keyper) Start(ctx context.Context, runner service.Runner) error {
 		return errors.Wrap(err, "can't instantiate keyper core")
 	}
 	// TODO: wrap the logger and pass in
-	kpr.l2Client, err = shopclient.NewShutterL2Client(
+	kpr.l2Client, err = chainsync.NewClient(
 		ctx,
-		shopclient.WithClientURL(kpr.config.Optimism.JSONRPCURL),
-		shopclient.WithSyncNewBlock(kpr.newBlock),
-		shopclient.WithSyncNewKeyperSet(kpr.newKeyperSet),
-		shopclient.WithPrivateKey(kpr.config.Optimism.PrivateKey.Key),
+		chainsync.WithClientURL(kpr.config.Optimism.JSONRPCURL),
+		chainsync.WithSyncNewBlock(kpr.newBlock),
+		chainsync.WithSyncNewKeyperSet(kpr.newKeyperSet),
+		chainsync.WithPrivateKey(kpr.config.Optimism.PrivateKey.Key),
 	)
 	if err != nil {
 		return err
 	}
 	return runner.StartService(kpr.core, kpr.l2Client)
 }
 
-func (kpr *Keyper) newBlock(_ context.Context, ev *shopevent.LatestBlock) error {
+func (kpr *Keyper) newBlock(_ context.Context, ev *syncevent.LatestBlock) error {
 	log.Info().
 		Int64("number", ev.Number.Int64()).
 		Str("hash", ev.BlockHash.Hex()).
@@ -110,7 +110,7 @@ func (kpr *Keyper) newBlock(_ context.Context, ev *shopevent.LatestBlock) error
 	return nil
 }
 
-func (kpr *Keyper) newKeyperSet(ctx context.Context, ev *shopevent.KeyperSet) error {
+func (kpr *Keyper) newKeyperSet(ctx context.Context, ev *syncevent.KeyperSet) error {
 	log.Info().
 		Uint64("activation-block", ev.ActivationBlock).
 		Uint64("eon", ev.Eon).

rolling-shutter/keyperimpl/optimism/sync/client.go renamed to rolling-shutter/medley/chainsync/client.go

@@ -1,9 +1,8 @@
-package sync
+package chainsync
 
 import (
 	"context"
 	"crypto/ecdsa"
-	"io"
 	"math/big"
 
 	"github.com/ethereum/go-ethereum/accounts/abi/bind"
@@ -12,25 +11,19 @@ import (
 	"github.com/pkg/errors"
 	"github.com/shutter-network/shop-contracts/bindings"
 
-	"github.com/shutter-network/rolling-shutter/rolling-shutter/keyperimpl/optimism/sync/client"
-	"github.com/shutter-network/rolling-shutter/rolling-shutter/keyperimpl/optimism/sync/event"
-	"github.com/shutter-network/rolling-shutter/rolling-shutter/keyperimpl/optimism/sync/syncer"
+	"github.com/shutter-network/rolling-shutter/rolling-shutter/medley/chainsync/client"
+	"github.com/shutter-network/rolling-shutter/rolling-shutter/medley/chainsync/event"
+	"github.com/shutter-network/rolling-shutter/rolling-shutter/medley/chainsync/syncer"
 	"github.com/shutter-network/rolling-shutter/rolling-shutter/medley/encodeable/number"
 	"github.com/shutter-network/rolling-shutter/rolling-shutter/medley/logger"
 	"github.com/shutter-network/rolling-shutter/rolling-shutter/medley/service"
 )
 
 var noopLogger = &logger.NoopLogger{}
 
-var ErrServiceNotInstantiated = errors.New("service is not instantiated, pass a handler function option.")
+var ErrServiceNotInstantiated = errors.New("service is not instantiated, pass a handler function option")
 
-type ShutterSync interface {
-	io.Closer
-	// Start starts an additional worker syncing job
-	Start() error
-}
-
-type ShutterL2Client struct {
+type Client struct {
 	client.Client
 	log log.Logger
 
@@ -49,7 +42,7 @@ type ShutterL2Client struct {
 	services []service.Service
 }
 
-func NewShutterL2Client(ctx context.Context, options ...Option) (*ShutterL2Client, error) {
+func NewClient(ctx context.Context, options ...Option) (*Client, error) {
 	opts := defaultOptions()
 	for _, option := range options {
 		err := option(opts)
@@ -63,7 +56,7 @@ func NewShutterL2Client(ctx context.Context, options ...Option) (*ShutterL2Clien
 		return nil, err
 	}
 
-	c := &ShutterL2Client{
+	c := &Client{
 		log:      noopLogger,
 		services: []service.Service{},
 	}
@@ -75,11 +68,11 @@ func NewShutterL2Client(ctx context.Context, options ...Option) (*ShutterL2Clien
 	return c, nil
 }
 
-func (s *ShutterL2Client) getServices() []service.Service {
+func (s *Client) getServices() []service.Service {
 	return s.services
 }
 
-func (s *ShutterL2Client) GetShutterState(ctx context.Context) (*event.ShutterState, error) {
+func (s *Client) GetShutterState(ctx context.Context) (*event.ShutterState, error) {
 	if s.sssync == nil {
 		return nil, errors.Wrap(ErrServiceNotInstantiated, "ShutterStateSyncer service not instantiated")
 	}
@@ -89,7 +82,7 @@ func (s *ShutterL2Client) GetShutterState(ctx context.Context) (*event.ShutterSt
 	return s.sssync.GetShutterState(ctx, opts)
 }
 
-func (s *ShutterL2Client) GetKeyperSetByIndex(ctx context.Context, index uint64) (*event.KeyperSet, error) {
+func (s *Client) GetKeyperSetByIndex(ctx context.Context, index uint64) (*event.KeyperSet, error) {
 	if s.kssync == nil {
 		return nil, errors.Wrap(ErrServiceNotInstantiated, "KeyperSetSyncer service not instantiated")
 	}
@@ -99,7 +92,7 @@ func (s *ShutterL2Client) GetKeyperSetByIndex(ctx context.Context, index uint64)
 	return s.kssync.GetKeyperSetByIndex(ctx, opts, index)
 }
 
-func (s *ShutterL2Client) GetKeyperSetForBlock(ctx context.Context, b *number.BlockNumber) (*event.KeyperSet, error) {
+func (s *Client) GetKeyperSetForBlock(ctx context.Context, b *number.BlockNumber) (*event.KeyperSet, error) {
 	if s.kssync == nil {
 		return nil, errors.Wrap(ErrServiceNotInstantiated, "KeyperSetSyncer service not instantiated")
 	}
@@ -109,7 +102,7 @@ func (s *ShutterL2Client) GetKeyperSetForBlock(ctx context.Context, b *number.Bl
 	return s.kssync.GetKeyperSetForBlock(ctx, opts, b)
 }
 
-func (s *ShutterL2Client) GetEonPubKeyForEon(ctx context.Context, eon uint64) (*event.EonPublicKey, error) {
+func (s *Client) GetEonPubKeyForEon(ctx context.Context, eon uint64) (*event.EonPublicKey, error) {
 	if s.sssync == nil {
 		return nil, errors.Wrap(ErrServiceNotInstantiated, "ShutterStateSyncer service not instantiated")
 	}
@@ -119,8 +112,9 @@ func (s *ShutterL2Client) GetEonPubKeyForEon(ctx context.Context, eon uint64) (*
 	return s.epksync.GetEonPubKeyForEon(ctx, opts, eon)
 }
 
-func (s *ShutterL2Client) BroadcastEonKey(ctx context.Context, eon uint64, eonPubKey []byte) (*types.Transaction, error) {
-	// TODO: first do a getEonKey. If we already have something (ideally the same)
+func (s *Client) BroadcastEonKey(ctx context.Context, eon uint64, eonPubKey []byte) (*types.Transaction, error) {
+	// TODO: first do a getEonKey. If we already have this key, do nothing,
+	// if we have a different key, error
 	// don't do a transaction
 	// s.KeyBroadcast.GetEonKey(eon)
 	if s.privKey == nil {
@@ -140,7 +134,7 @@ func (s *ShutterL2Client) BroadcastEonKey(ctx context.Context, eon uint64, eonPu
 
 // ChainID returns the chainid of the underlying L2 chain.
 // This value is cached, since it is not expected to change.
-func (s *ShutterL2Client) ChainID(ctx context.Context) (*big.Int, error) {
+func (s *Client) ChainID(ctx context.Context) (*big.Int, error) {
 	if s.chainID == nil {
 		cid, err := s.Client.ChainID(ctx)
 		if err != nil {
@@ -151,6 +145,6 @@ func (s *ShutterL2Client) ChainID(ctx context.Context) (*big.Int, error) {
 	return s.chainID, nil
 }
 
-func (s *ShutterL2Client) Start(_ context.Context, runner service.Runner) error {
+func (s *Client) Start(_ context.Context, runner service.Runner) error {
 	return runner.StartService(s.getServices()...)
 }

rolling-shutter/keyperimpl/optimism/sync/client/client.go renamed to rolling-shutter/medley/chainsync/client/client.go

@@ -1,4 +1,4 @@
-package sync
+package chainsync
 
 import (
 	"context"
@@ -11,9 +11,9 @@ import (
 	"github.com/shutter-network/shop-contracts/bindings"
 	"github.com/shutter-network/shop-contracts/predeploy"
 
-	syncclient "github.com/shutter-network/rolling-shutter/rolling-shutter/keyperimpl/optimism/sync/client"
-	"github.com/shutter-network/rolling-shutter/rolling-shutter/keyperimpl/optimism/sync/event"
-	"github.com/shutter-network/rolling-shutter/rolling-shutter/keyperimpl/optimism/sync/syncer"
+	syncclient "github.com/shutter-network/rolling-shutter/rolling-shutter/medley/chainsync/client"
+	"github.com/shutter-network/rolling-shutter/rolling-shutter/medley/chainsync/event"
+	"github.com/shutter-network/rolling-shutter/rolling-shutter/medley/chainsync/syncer"
 	"github.com/shutter-network/rolling-shutter/rolling-shutter/medley/encodeable/number"
 	"github.com/shutter-network/rolling-shutter/rolling-shutter/medley/service"
 )
@@ -54,7 +54,7 @@ func (o *options) verify() error {
 // the context is only the initialisation context,
 // and should not be considered to handle the lifecycle
 // of shutter clients background workers.
-func (o *options) apply(ctx context.Context, c *ShutterL2Client) error {
+func (o *options) apply(ctx context.Context, c *Client) error {
 	var (
 		client syncclient.Client
 		err    error

rolling-shutter/keyperimpl/optimism/sync/event/events.go renamed to rolling-shutter/medley/chainsync/event/events.go

@@ -9,8 +9,8 @@ import (
 	"github.com/ethereum/go-ethereum/log"
 	"github.com/shutter-network/shop-contracts/bindings"
 
-	"github.com/shutter-network/rolling-shutter/rolling-shutter/keyperimpl/optimism/sync/client"
-	"github.com/shutter-network/rolling-shutter/rolling-shutter/keyperimpl/optimism/sync/event"
+	"github.com/shutter-network/rolling-shutter/rolling-shutter/medley/chainsync/client"
+	"github.com/shutter-network/rolling-shutter/rolling-shutter/medley/chainsync/event"
 	"github.com/shutter-network/rolling-shutter/rolling-shutter/medley/encodeable/number"
 	"github.com/shutter-network/rolling-shutter/rolling-shutter/medley/service"
 )

rolling-shutter/keyperimpl/optimism/sync/event/handler.go renamed to rolling-shutter/medley/chainsync/event/handler.go

@@ -9,8 +9,8 @@ import (
 	"github.com/pkg/errors"
 	"github.com/shutter-network/shop-contracts/bindings"
 
-	"github.com/shutter-network/rolling-shutter/rolling-shutter/keyperimpl/optimism/sync/client"
-	"github.com/shutter-network/rolling-shutter/rolling-shutter/keyperimpl/optimism/sync/event"
+	"github.com/shutter-network/rolling-shutter/rolling-shutter/medley/chainsync/client"
+	"github.com/shutter-network/rolling-shutter/rolling-shutter/medley/chainsync/event"
 	"github.com/shutter-network/rolling-shutter/rolling-shutter/medley/encodeable/number"
 	"github.com/shutter-network/rolling-shutter/rolling-shutter/medley/service"
 )
@@ -166,7 +166,7 @@ func (s *KeyperSetSyncer) GetKeyperSetForBlock(ctx context.Context, opts *bind.C
 }
 
 func (s *KeyperSetSyncer) newEvent(
-	ctx context.Context,
+	_ context.Context,
 	opts *bind.CallOpts,
 	keyperSetContract common.Address,
 	activationBlock uint64,