chore(relayer): delete duplicate DB interface (#17698)

taikoxyz · Jul 1, 2024 · c28c984 · c28c984
1 parent a3e1cf7
commit c28c984
Show file tree

Hide file tree

Showing 10 changed files with 31 additions and 45 deletions.
diff --git a/packages/relayer/indexer/config.go b/packages/relayer/indexer/config.go
@@ -52,7 +52,7 @@ type Config struct {
 	BackOffMaxRetries                uint64
 	MinFeeToIndex                    uint64
 	OpenQueueFunc                    func() (queue.Queue, error)
-	OpenDBFunc                       func() (DB, error)
+	OpenDBFunc                       func() (db.DB, error)
 }
 
 // NewConfigFromCliContext creates a new config instance from command line flags.
@@ -94,7 +94,7 @@ func NewConfigFromCliContext(c *cli.Context) (*Config, error) {
 			}
 			return nil
 		}(),
-		OpenDBFunc: func() (DB, error) {
+		OpenDBFunc: func() (db.DB, error) {
 			return db.OpenDBConnection(db.DBConnectionOpts{
 				Name:            c.String(flags.DatabaseUsername.Name),
 				Password:        c.String(flags.DatabasePassword.Name),

diff --git a/packages/relayer/indexer/config_test.go b/packages/relayer/indexer/config_test.go
@@ -5,11 +5,13 @@ import (
 
 	"github.com/ethereum/go-ethereum/common"
 	"github.com/stretchr/testify/assert"
+	"github.com/urfave/cli/v2"
+
 	"github.com/taikoxyz/taiko-mono/packages/relayer"
 	"github.com/taikoxyz/taiko-mono/packages/relayer/cmd/flags"
+	"github.com/taikoxyz/taiko-mono/packages/relayer/pkg/db"
 	"github.com/taikoxyz/taiko-mono/packages/relayer/pkg/mock"
 	"github.com/taikoxyz/taiko-mono/packages/relayer/pkg/queue"
-	"github.com/urfave/cli/v2"
 )
 
 var (
@@ -69,7 +71,7 @@ func TestNewConfigFromCliContext(t *testing.T) {
 		assert.Equal(t, WatchMode(watchMode), c.WatchMode)
 		assert.Equal(t, eventName, c.EventName)
 
-		c.OpenDBFunc = func() (DB, error) {
+		c.OpenDBFunc = func() (db.DB, error) {
 			return &mock.DB{}, nil
 		}
 

diff --git a/packages/relayer/indexer/indexer.go b/packages/relayer/indexer/indexer.go
@@ -2,7 +2,6 @@ package indexer
 
 import (
 	"context"
-	"database/sql"
 	"fmt"
 	"log/slog"
 	"math/big"
@@ -17,16 +16,16 @@ import (
 	"github.com/ethereum/go-ethereum/core/types"
 	"github.com/ethereum/go-ethereum/crypto"
 	"github.com/ethereum/go-ethereum/ethclient"
+	"github.com/urfave/cli/v2"
+	"golang.org/x/sync/errgroup"
+
 	"github.com/taikoxyz/taiko-mono/packages/relayer"
 	"github.com/taikoxyz/taiko-mono/packages/relayer/bindings/bridge"
 	"github.com/taikoxyz/taiko-mono/packages/relayer/bindings/signalservice"
 	"github.com/taikoxyz/taiko-mono/packages/relayer/bindings/taikol1"
 	"github.com/taikoxyz/taiko-mono/packages/relayer/pkg/queue"
 	"github.com/taikoxyz/taiko-mono/packages/relayer/pkg/repo"
 	"github.com/taikoxyz/taiko-mono/packages/relayer/pkg/utils"
-	"github.com/urfave/cli/v2"
-	"golang.org/x/sync/errgroup"
-	"gorm.io/gorm"
 )
 
 var (
@@ -74,12 +73,6 @@ type ethClient interface {
 	TransactionByHash(ctx context.Context, txHash common.Hash) (*types.Transaction, bool, error)
 }
 
-// DB is a local interface that lets us narrow down a database type for testing.
-type DB interface {
-	DB() (*sql.DB, error)
-	GormDB() *gorm.DB
-}
-
 // Indexer is the main struct of this package, containing all dependencies necessary for indexing
 // relayer-related chain data. All database repositories, contract implementations,
 // and configurations will be injected here.

diff --git a/packages/relayer/pkg/db/db.go b/packages/relayer/pkg/db/db.go
@@ -13,6 +13,7 @@ var (
 	ErrNoDB = errors.Validation.NewWithKeyAndDetail("ERR_NO_DB", "no db")
 )
 
+// DB is a local interface that lets us narrow down a database type for testing.
 type DB interface {
 	DB() (*sql.DB, error)
 	GormDB() *gorm.DB

diff --git a/packages/relayer/processor/config.go b/packages/relayer/processor/config.go
@@ -7,15 +7,16 @@ import (
 	"github.com/ethereum-optimism/optimism/op-service/txmgr"
 	"github.com/ethereum/go-ethereum/common"
 	"github.com/ethereum/go-ethereum/crypto"
+	"github.com/urfave/cli/v2"
+	"gorm.io/driver/mysql"
+	"gorm.io/gorm"
+	"gorm.io/gorm/logger"
+
 	"github.com/taikoxyz/taiko-mono/packages/relayer/cmd/flags"
 	"github.com/taikoxyz/taiko-mono/packages/relayer/pkg/db"
 	pkgFlags "github.com/taikoxyz/taiko-mono/packages/relayer/pkg/flags"
 	"github.com/taikoxyz/taiko-mono/packages/relayer/pkg/queue"
 	"github.com/taikoxyz/taiko-mono/packages/relayer/pkg/queue/rabbitmq"
-	"github.com/urfave/cli/v2"
-	"gorm.io/driver/mysql"
-	"gorm.io/gorm"
-	"gorm.io/gorm/logger"
 )
 
 // hopConfig is a config struct that must be provided for an individual
@@ -76,7 +77,7 @@ type Config struct {
 	DestRPCUrl       string
 	ETHClientTimeout uint64
 	OpenQueueFunc    func() (queue.Queue, error)
-	OpenDBFunc       func() (DB, error)
+	OpenDBFunc       func() (db.DB, error)
 
 	hopConfigs []hopConfig
 
@@ -178,7 +179,7 @@ func NewConfigFromCliContext(c *cli.Context) (*Config, error) {
 		),
 		MaxMessageRetries: c.Uint64(flags.MaxMessageRetries.Name),
 		MinFeeToProcess:   c.Uint64(flags.MinFeeToProcess.Name),
-		OpenDBFunc: func() (DB, error) {
+		OpenDBFunc: func() (db.DB, error) {
 			return db.OpenDBConnection(db.DBConnectionOpts{
 				Name:            c.String(flags.DatabaseUsername.Name),
 				Password:        c.String(flags.DatabasePassword.Name),

diff --git a/packages/relayer/processor/config_test.go b/packages/relayer/processor/config_test.go
@@ -5,10 +5,12 @@ import (
 
 	"github.com/ethereum/go-ethereum/common"
 	"github.com/stretchr/testify/assert"
+	"github.com/urfave/cli/v2"
+
 	"github.com/taikoxyz/taiko-mono/packages/relayer/cmd/flags"
+	"github.com/taikoxyz/taiko-mono/packages/relayer/pkg/db"
 	"github.com/taikoxyz/taiko-mono/packages/relayer/pkg/mock"
 	"github.com/taikoxyz/taiko-mono/packages/relayer/pkg/queue"
-	"github.com/urfave/cli/v2"
 )
 
 var (
@@ -71,7 +73,7 @@ func TestNewConfigFromCliContext(t *testing.T) {
 		assert.Equal(t, uint64(100), c.QueuePrefetch)
 		assert.Equal(t, true, c.EnableTaikoL2)
 
-		c.OpenDBFunc = func() (DB, error) {
+		c.OpenDBFunc = func() (db.DB, error) {
 			return &mock.DB{}, nil
 		}
 

diff --git a/packages/relayer/processor/processor.go b/packages/relayer/processor/processor.go
@@ -3,7 +3,6 @@ package processor
 import (
 	"context"
 	"crypto/ecdsa"
-	"database/sql"
 	"encoding/json"
 	"errors"
 	"fmt"
@@ -15,6 +14,8 @@ import (
 	"time"
 
 	"github.com/cenkalti/backoff/v4"
+	"github.com/ethereum-optimism/optimism/op-service/txmgr"
+	txmgrMetrics "github.com/ethereum-optimism/optimism/op-service/txmgr/metrics"
 	"github.com/ethereum/go-ethereum"
 	"github.com/ethereum/go-ethereum/common"
 	"github.com/ethereum/go-ethereum/core/types"
@@ -23,10 +24,7 @@ import (
 	"github.com/ethereum/go-ethereum/log"
 	"github.com/ethereum/go-ethereum/rpc"
 	"github.com/urfave/cli/v2"
-	"gorm.io/gorm"
 
-	"github.com/ethereum-optimism/optimism/op-service/txmgr"
-	txmgrMetrics "github.com/ethereum-optimism/optimism/op-service/txmgr/metrics"
 	"github.com/taikoxyz/taiko-mono/packages/relayer"
 	"github.com/taikoxyz/taiko-mono/packages/relayer/bindings/bridge"
 	"github.com/taikoxyz/taiko-mono/packages/relayer/bindings/erc1155vault"
@@ -41,11 +39,6 @@ import (
 	"github.com/taikoxyz/taiko-mono/packages/relayer/pkg/utils"
 )
 
-type DB interface {
-	DB() (*sql.DB, error)
-	GormDB() *gorm.DB
-}
-
 // ethClient is a slimmed down interface of a go-ethereum ethclient.Client
 // we can use for mocking and testing
 type ethClient interface {

diff --git a/packages/relayer/watchdog/config.go b/packages/relayer/watchdog/config.go
@@ -55,7 +55,7 @@ type Config struct {
 	DestRPCUrl       string
 	ETHClientTimeout uint64
 	OpenQueueFunc    func() (queue.Queue, error)
-	OpenDBFunc       func() (DB, error)
+	OpenDBFunc       func() (db.DB, error)
 
 	SrcTxmgrConfigs  *txmgr.CLIConfig
 	DestTxmgrConfigs *txmgr.CLIConfig
@@ -94,7 +94,7 @@ func NewConfigFromCliContext(c *cli.Context) (*Config, error) {
 		BackoffRetryInterval:    c.Uint64(flags.BackOffRetryInterval.Name),
 		BackOffMaxRetrys:        c.Uint64(flags.BackOffMaxRetrys.Name),
 		ETHClientTimeout:        c.Uint64(flags.ETHClientTimeout.Name),
-		OpenDBFunc: func() (DB, error) {
+		OpenDBFunc: func() (db.DB, error) {
 			return db.OpenDBConnection(db.DBConnectionOpts{
 				Name:            c.String(flags.DatabaseUsername.Name),
 				Password:        c.String(flags.DatabasePassword.Name),

diff --git a/packages/relayer/watchdog/config_test.go b/packages/relayer/watchdog/config_test.go
@@ -5,10 +5,12 @@ import (
 
 	"github.com/ethereum/go-ethereum/common"
 	"github.com/stretchr/testify/assert"
+	"github.com/urfave/cli/v2"
+
 	"github.com/taikoxyz/taiko-mono/packages/relayer/cmd/flags"
+	"github.com/taikoxyz/taiko-mono/packages/relayer/pkg/db"
 	"github.com/taikoxyz/taiko-mono/packages/relayer/pkg/mock"
 	"github.com/taikoxyz/taiko-mono/packages/relayer/pkg/queue"
-	"github.com/urfave/cli/v2"
 )
 
 var (
@@ -64,7 +66,7 @@ func TestNewConfigFromCliContext(t *testing.T) {
 		assert.Equal(t, uint64(10), c.ETHClientTimeout)
 		assert.Equal(t, uint64(100), c.QueuePrefetch)
 
-		c.OpenDBFunc = func() (DB, error) {
+		c.OpenDBFunc = func() (db.DB, error) {
 			return &mock.DB{}, nil
 		}
 

diff --git a/packages/relayer/watchdog/watchdog.go b/packages/relayer/watchdog/watchdog.go
@@ -3,7 +3,6 @@ package watchdog
 import (
 	"context"
 	"crypto/ecdsa"
-	"database/sql"
 	"encoding/json"
 	"fmt"
 	"log/slog"
@@ -14,30 +13,23 @@ import (
 	"github.com/cenkalti/backoff/v4"
 	"github.com/cyberhorsey/errors"
 	"github.com/ethereum-optimism/optimism/op-service/txmgr"
+	txmgrMetrics "github.com/ethereum-optimism/optimism/op-service/txmgr/metrics"
 	"github.com/ethereum/go-ethereum"
 	"github.com/ethereum/go-ethereum/accounts/abi/bind"
 	"github.com/ethereum/go-ethereum/common"
 	"github.com/ethereum/go-ethereum/core/types"
 	"github.com/ethereum/go-ethereum/crypto"
 	"github.com/ethereum/go-ethereum/ethclient"
 	"github.com/ethereum/go-ethereum/log"
-	"github.com/urfave/cli/v2"
-	"gorm.io/gorm"
-
-	txmgrMetrics "github.com/ethereum-optimism/optimism/op-service/txmgr/metrics"
 	"github.com/taikoxyz/taiko-mono/packages/relayer"
 	"github.com/taikoxyz/taiko-mono/packages/relayer/bindings/bridge"
 	"github.com/taikoxyz/taiko-mono/packages/relayer/pkg/encoding"
 	"github.com/taikoxyz/taiko-mono/packages/relayer/pkg/queue"
 	"github.com/taikoxyz/taiko-mono/packages/relayer/pkg/repo"
 	"github.com/taikoxyz/taiko-mono/packages/relayer/pkg/utils"
+	"github.com/urfave/cli/v2"
 )
 
-type DB interface {
-	DB() (*sql.DB, error)
-	GormDB() *gorm.DB
-}
-
 type ethClient interface {
 	PendingNonceAt(ctx context.Context, account common.Address) (uint64, error)
 	TransactionReceipt(ctx context.Context, txHash common.Hash) (*types.Receipt, error)