fix(bridge-history): address validation (#1063)

Co-authored-by: colinlyguo <colinlyguo@users.noreply.github.com>

bridge-history-api/cmd/api/app/app.go

@@ -1,6 +1,7 @@
 package app
 
 import (
+	"crypto/tls"
 	"fmt"
 	"os"
 	"os/signal"
@@ -52,11 +53,16 @@ func action(ctx *cli.Context) error {
 			log.Error("failed to close db", "err", err)
 		}
 	}()
-	redisClient := redis.NewClient(&redis.Options{
+	opts := &redis.Options{
 		Addr:     cfg.Redis.Address,
+		Username: cfg.Redis.Username,
 		Password: cfg.Redis.Password,
-		DB:       cfg.Redis.DB,
-	})
+	}
+	// Production Redis service has enabled transit_encryption.
+	if !cfg.Redis.Local {
+		opts.TLSConfig = &tls.Config{MinVersion: tls.VersionTLS12}
+	}
+	redisClient := redis.NewClient(opts)
 	api.InitController(db, redisClient)
 
 	router := gin.Default()

bridge-history-api/conf/config.json

@@ -34,8 +34,7 @@
 		"USDCGatewayAddr": "0x33B60d5Dd260d453cAC3782b0bDC01ce84672142",
 		"LIDOGatewayAddr": "0x8aE8f22226B9d789A36AC81474e633f8bE2856c9",
 		"DAIGatewayAddr": "0xaC78dff3A87b5b534e366A93E785a0ce8fA6Cc62",
-		"GatewayRouterAddr": "0x4C0926FF5252A435FD19e10ED15e5a249Ba19d79",
-		"MessageQueueAddr": "0x5300000000000000000000000000000000000000"
+		"GatewayRouterAddr": "0x4C0926FF5252A435FD19e10ED15e5a249Ba19d79"
 	},
 	"db": {
 		"dsn": "postgres://postgres:123456@localhost:5444/test?sslmode=disable",
@@ -45,7 +44,8 @@
 	},
 	"redis": {
 		"address": "localhost:6379",
+		"username": "default",
 		"password": "",
-		"db": 0
+		"local": true
 	}
 }

bridge-history-api/internal/config/config.go

@@ -33,8 +33,10 @@ type LayerConfig struct {
 // RedisConfig redis config
 type RedisConfig struct {
 	Address  string `json:"address"`
+	Username string `json:"username"`
 	Password string `json:"password"`
 	DB       int    `json:"db"`
+	Local    bool   `json:"local"`
 }
 
 // Config is the configuration of the bridge history backend

bridge-history-api/internal/logic/l1_fetcher.go

@@ -66,14 +66,16 @@ func NewL1FetcherLogic(cfg *config.LayerConfig, db *gorm.DB, client *ethclient.C
 	}
 
 	// Optional erc20 gateways.
-	if cfg.USDCGatewayAddr != "" {
+	if common.HexToAddress(cfg.USDCGatewayAddr) != (common.Address{}) {
 		addressList = append(addressList, common.HexToAddress(cfg.USDCGatewayAddr))
 	}
 
-	if cfg.LIDOGatewayAddr != "" {
+	if common.HexToAddress(cfg.LIDOGatewayAddr) != (common.Address{}) {
 		addressList = append(addressList, common.HexToAddress(cfg.LIDOGatewayAddr))
 	}
 
+	log.Info("L1 Fetcher configured with the following address list", "addresses", addressList)
+
 	f := &L1FetcherLogic{
 		db:              db,
 		crossMessageOrm: orm.NewCrossMessage(db),

bridge-history-api/internal/logic/l2_fetcher.go

@@ -61,14 +61,16 @@ func NewL2FetcherLogic(cfg *config.LayerConfig, db *gorm.DB, client *ethclient.C
 	}
 
 	// Optional erc20 gateways.
-	if cfg.USDCGatewayAddr != "" {
+	if common.HexToAddress(cfg.USDCGatewayAddr) != (common.Address{}) {
 		addressList = append(addressList, common.HexToAddress(cfg.USDCGatewayAddr))
 	}
 
-	if cfg.LIDOGatewayAddr != "" {
+	if common.HexToAddress(cfg.LIDOGatewayAddr) != (common.Address{}) {
 		addressList = append(addressList, common.HexToAddress(cfg.LIDOGatewayAddr))
 	}
 
+	log.Info("L2 Fetcher configured with the following address list", "addresses", addressList)
+
 	f := &L2FetcherLogic{
 		db:              db,
 		crossMessageOrm: orm.NewCrossMessage(db),

bridge-history-api/internal/orm/batch_event.go

@@ -47,7 +47,7 @@ type BatchEvent struct {
 
 // TableName returns the table name for the BatchEvent model.
 func (*BatchEvent) TableName() string {
-	return "batch_event"
+	return "batch_event_v2"
 }
 
 // NewBatchEvent returns a new instance of BatchEvent.

bridge-history-api/internal/orm/cross_message.go

@@ -124,7 +124,7 @@ type CrossMessage struct {
 
 // TableName returns the table name for the CrossMessage model.
 func (*CrossMessage) TableName() string {
-	return "cross_message"
+	return "cross_message_v2"
 }
 
 // NewCrossMessage returns a new instance of CrossMessage.

bridge-history-api/internal/orm/migrate/migrate.go

@@ -18,7 +18,7 @@ const MigrationsDir string = "migrations"
 func init() {
 	goose.SetBaseFS(embedMigrations)
 	goose.SetSequential(true)
-	goose.SetTableName("bridge_history_migrations")
+	goose.SetTableName("bridge_historyv2_migrations")
 
 	verbose, _ := strconv.ParseBool(os.Getenv("LOG_SQL_MIGRATIONS"))
 	goose.SetVerbose(verbose)

bridge-history-api/internal/orm/migrate/migrations/00001_cross_message_v2.sql

@@ -1,6 +1,6 @@
 -- +goose Up
 -- +goose StatementBegin
-CREATE TABLE cross_message
+CREATE TABLE cross_message_v2
 (
     id                  BIGSERIAL    PRIMARY KEY,
     message_type        SMALLINT     NOT NULL,
@@ -38,20 +38,20 @@ CREATE TABLE cross_message
     deleted_at          TIMESTAMP(0) DEFAULT NULL
 );
 
-CREATE UNIQUE INDEX IF NOT EXISTS idx_cm_message_hash ON cross_message (message_hash);
-CREATE INDEX IF NOT EXISTS idx_cm_message_type_l1_block_number ON cross_message (message_type, l1_block_number DESC);
-CREATE INDEX IF NOT EXISTS idx_cm_message_type_l2_block_number ON cross_message (message_type, l2_block_number DESC);
-CREATE INDEX IF NOT EXISTS idx_cm_message_type_rollup_status_message_nonce ON cross_message (message_type, rollup_status, message_nonce DESC);
-CREATE INDEX IF NOT EXISTS idx_cm_message_type_message_nonce_tx_status_l2_block_number ON cross_message (message_type, message_nonce, tx_status, l2_block_number);
-CREATE INDEX IF NOT EXISTS idx_cm_l1_tx_hash ON cross_message (l1_tx_hash);
-CREATE INDEX IF NOT EXISTS idx_cm_l2_tx_hash ON cross_message (l2_tx_hash);
-CREATE INDEX IF NOT EXISTS idx_cm_message_type_tx_status_sender_block_timestamp ON cross_message (message_type, tx_status, sender, block_timestamp DESC);
-CREATE INDEX IF NOT EXISTS idx_cm_message_type_sender_block_timestamp ON cross_message (message_type, sender, block_timestamp DESC);
-CREATE INDEX IF NOT EXISTS idx_cm_sender_block_timestamp ON cross_message (sender, block_timestamp DESC);
+CREATE UNIQUE INDEX IF NOT EXISTS idx_cm_message_hash ON cross_message_v2 (message_hash);
+CREATE INDEX IF NOT EXISTS idx_cm_message_type_l1_block_number ON cross_message_v2 (message_type, l1_block_number DESC);
+CREATE INDEX IF NOT EXISTS idx_cm_message_type_l2_block_number ON cross_message_v2 (message_type, l2_block_number DESC);
+CREATE INDEX IF NOT EXISTS idx_cm_message_type_rollup_status_message_nonce ON cross_message_v2 (message_type, rollup_status, message_nonce DESC);
+CREATE INDEX IF NOT EXISTS idx_cm_message_type_message_nonce_tx_status_l2_block_number ON cross_message_v2 (message_type, message_nonce, tx_status, l2_block_number);
+CREATE INDEX IF NOT EXISTS idx_cm_l1_tx_hash ON cross_message_v2 (l1_tx_hash);
+CREATE INDEX IF NOT EXISTS idx_cm_l2_tx_hash ON cross_message_v2 (l2_tx_hash);
+CREATE INDEX IF NOT EXISTS idx_cm_message_type_tx_status_sender_block_timestamp ON cross_message_v2 (message_type, tx_status, sender, block_timestamp DESC);
+CREATE INDEX IF NOT EXISTS idx_cm_message_type_sender_block_timestamp ON cross_message_v2 (message_type, sender, block_timestamp DESC);
+CREATE INDEX IF NOT EXISTS idx_cm_sender_block_timestamp ON cross_message_v2 (sender, block_timestamp DESC);
 
 -- +goose StatementEnd
 
 -- +goose Down
 -- +goose StatementBegin
-DROP TABLE IF EXISTS cross_message;
+DROP TABLE IF EXISTS cross_message_v2;
 -- +goose StatementEnd

bridge-history-api/internal/orm/migrate/migrations/00002_batch_event_v2.sql

@@ -1,6 +1,6 @@
 -- +goose Up
 -- +goose StatementBegin
-CREATE TABLE batch_event
+CREATE TABLE batch_event_v2
 (
     id                  BIGSERIAL     PRIMARY KEY,
     l1_block_number     BIGINT        NOT NULL,
@@ -15,14 +15,14 @@ CREATE TABLE batch_event
     deleted_at          TIMESTAMP(0)  DEFAULT NULL
 );
 
-CREATE INDEX IF NOT EXISTS idx_be_l1_block_number ON batch_event (l1_block_number);
-CREATE INDEX IF NOT EXISTS idx_be_batch_index ON batch_event (batch_index);
-CREATE INDEX IF NOT EXISTS idx_be_batch_index_batch_hash ON batch_event (batch_index, batch_hash);
-CREATE INDEX IF NOT EXISTS idx_be_end_block_number_update_status_batch_status_batch_index ON batch_event (end_block_number, update_status, batch_status, batch_index);
+CREATE INDEX IF NOT EXISTS idx_be_l1_block_number ON batch_event_v2 (l1_block_number);
+CREATE INDEX IF NOT EXISTS idx_be_batch_index ON batch_event_v2 (batch_index);
+CREATE INDEX IF NOT EXISTS idx_be_batch_index_batch_hash ON batch_event_v2 (batch_index, batch_hash);
+CREATE INDEX IF NOT EXISTS idx_be_end_block_number_update_status_batch_status_batch_index ON batch_event_v2 (end_block_number, update_status, batch_status, batch_index);
 
 -- +goose StatementEnd
 
 -- +goose Down
 -- +goose StatementBegin
-DROP TABLE IF EXISTS batch_event;
+DROP TABLE IF EXISTS batch_event_v2;
 -- +goose StatementEnd

common/version/version.go

@@ -5,7 +5,7 @@ import (
 	"runtime/debug"
 )
 
-var tag = "v4.3.45"
+var tag = "v4.3.47"
 
 var commit = func() string {
 	if info, ok := debug.ReadBuildInfo(); ok {