fix(bridge-history): add cache key prefix (#1067)

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/history_logic.go

@@ -19,10 +19,16 @@ import (
 )
 
 const (
-	cacheKeyPrefixL2ClaimableWithdrawalsByAddr = "l2ClaimableWithdrawalsByAddr:"
-	cacheKeyPrefixL2WithdrawalsByAddr          = "l2WithdrawalsByAddr:"
-	cacheKeyPrefixTxsByAddr                    = "txsByAddr:"
-	cacheKeyPrefixQueryTxsByHashes             = "queryTxsByHashes:"
+	// cacheKeyPrefixBridgeHistory serves as a specific namespace for all Redis cache keys
+	// associated with the 'bridge-history' user. This prefix is used to enforce access controls
+	// in Redis, allowing permissions to be set such that only users with the appropriate
+	// access rights can read or write to keys starting with "bridge-history".
+	cacheKeyPrefixBridgeHistory = "bridge-history-"
+
+	cacheKeyPrefixL2ClaimableWithdrawalsByAddr = cacheKeyPrefixBridgeHistory + "l2ClaimableWithdrawalsByAddr:"
+	cacheKeyPrefixL2WithdrawalsByAddr          = cacheKeyPrefixBridgeHistory + "l2WithdrawalsByAddr:"
+	cacheKeyPrefixTxsByAddr                    = cacheKeyPrefixBridgeHistory + "txsByAddr:"
+	cacheKeyPrefixQueryTxsByHashes             = cacheKeyPrefixBridgeHistory + "queryTxsByHashes:"
 	cacheKeyExpiredTime                        = 1 * time.Minute
 )
 

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.
@@ -55,7 +55,7 @@ func NewBatchEvent(db *gorm.DB) *BatchEvent {
 	return &BatchEvent{db: db}
 }
 
-// GetBatchEventSyncedHeightInDB returns the maximum l1_block_number from the batch_event table.
+// GetBatchEventSyncedHeightInDB returns the maximum l1_block_number from the batch_event_v2 table.
 func (c *BatchEvent) GetBatchEventSyncedHeightInDB(ctx context.Context) (uint64, error) {
 	var batch BatchEvent
 	db := c.db.WithContext(ctx)

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.
@@ -475,9 +475,9 @@ func (c *CrossMessage) InsertOrUpdateL2RelayedMessagesOfL1Deposits(ctx context.C
 			Exprs: []clause.Expression{
 				clause.And(
 					// do not over-write terminal statuses.
-					clause.Neq{Column: "cross_message.tx_status", Value: TxStatusTypeRelayed},
-					clause.Neq{Column: "cross_message.tx_status", Value: TxStatusTypeFailedRelayed},
-					clause.Neq{Column: "cross_message.tx_status", Value: TxStatusTypeDropped},
+					clause.Neq{Column: "cross_message_v2.tx_status", Value: TxStatusTypeRelayed},
+					clause.Neq{Column: "cross_message_v2.tx_status", Value: TxStatusTypeFailedRelayed},
+					clause.Neq{Column: "cross_message_v2.tx_status", Value: TxStatusTypeDropped},
 				),
 			},
 		},
@@ -531,9 +531,9 @@ func (c *CrossMessage) InsertOrUpdateL1RelayedMessagesOfL2Withdrawals(ctx contex
 			Exprs: []clause.Expression{
 				clause.And(
 					// do not over-write terminal statuses.
-					clause.Neq{Column: "cross_message.tx_status", Value: TxStatusTypeRelayed},
-					clause.Neq{Column: "cross_message.tx_status", Value: TxStatusTypeFailedRelayed},
-					clause.Neq{Column: "cross_message.tx_status", Value: TxStatusTypeDropped},
+					clause.Neq{Column: "cross_message_v2.tx_status", Value: TxStatusTypeRelayed},
+					clause.Neq{Column: "cross_message_v2.tx_status", Value: TxStatusTypeFailedRelayed},
+					clause.Neq{Column: "cross_message_v2.tx_status", Value: TxStatusTypeDropped},
 				),
 			},
 		},

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.49"
 
 var commit = func() string {
 	if info, ok := debug.ReadBuildInfo(); ok {

contracts/src/L1/ecc.sol

@@ -1,134 +0,0 @@
-// SPDX-License-Identifier: GPL-3.0
-
-pragma solidity >=0.7.0 <0.9.0;
-
-contract Ecc {
-    /* ECC Functions */
-    // https://etherscan.io/address/0x41bf00f080ed41fa86201eac56b8afb170d9e36d#code
-    function ecAdd(uint256[2] memory p0, uint256[2] memory p1) public view
-        returns (uint256[2] memory retP)
-    {
-        uint256[4] memory i = [p0[0], p0[1], p1[0], p1[1]];
-
-        assembly {
-            // call ecadd precompile
-            // inputs are: x1, y1, x2, y2
-            if iszero(staticcall(not(0), 0x06, i, 0x80, retP, 0x40)) {
-                revert(0, 0)
-            }
-        }
-    }
-
-    // https://etherscan.io/address/0x41bf00f080ed41fa86201eac56b8afb170d9e36d#code
-    function ecMul(uint256[2] memory p, uint256 s) public view
-        returns (uint256[2] memory retP)
-    {
-        // With a public key (x, y), this computes p = scalar * (x, y).
-        uint256[3] memory i = [p[0], p[1], s];
-
-        assembly {
-            // call ecmul precompile
-            // inputs are: x, y, scalar
-            if iszero(staticcall(not(0), 0x07, i, 0x60, retP, 0x40)) {
-                revert(0, 0)
-            }
-        }
-    }
-
-    // scroll-tech/scroll/contracts/src/libraries/verifier/RollupVerifier.sol
-    struct G1Point {
-        uint256 x;
-        uint256 y;
-    }
-    struct G2Point {
-        uint256[2] x;
-        uint256[2] y;
-    }
-    function ecPairing(G1Point[] memory p1, G2Point[] memory p2) internal view returns (bool) {
-        uint256 length = p1.length * 6;
-        uint256[] memory input = new uint256[](length);
-        uint256[1] memory result;
-        bool ret;
-
-        require(p1.length == p2.length);
-
-        for (uint256 i = 0; i < p1.length; i++) {
-            input[0 + i * 6] = p1[i].x;
-            input[1 + i * 6] = p1[i].y;
-            input[2 + i * 6] = p2[i].x[0];
-            input[3 + i * 6] = p2[i].x[1];
-            input[4 + i * 6] = p2[i].y[0];
-            input[5 + i * 6] = p2[i].y[1];
-        }
-
-        assembly {
-            ret := staticcall(gas(), 8, add(input, 0x20), mul(length, 0x20), result, 0x20)
-        }
-        require(ret);
-        return result[0] != 0;
-    }
-
-    /* Bench */
-    function ecAdds(uint256 n) public
-    {
-        uint256[2] memory p0;
-        p0[0] = 1;
-        p0[1] = 2;
-        uint256[2] memory p1;
-        p1[0] = 1;
-        p1[1] = 2;
-
-        for (uint i = 0; i < n; i++) {
-            ecAdd(p0, p1);
-        }
-    }
-
-    function ecMuls(uint256 n) public
-    {
-        uint256[2] memory p0;
-        p0[0] = 1;
-        p0[1] = 2;
-
-        for (uint i = 0; i < n; i++) {
-            ecMul(p0, 3);
-        }
-    }
-
-    function ecPairings(uint256 n) public
-    {
-        G1Point[] memory g1_points = new G1Point[](2);
-        G2Point[] memory g2_points = new G2Point[](2);
-        g1_points[0].x = 0x0000000000000000000000000000000000000000000000000000000000000001;
-        g1_points[0].y = 0x0000000000000000000000000000000000000000000000000000000000000002;
-        g2_points[0].x[1] = 0x1800deef121f1e76426a00665e5c4479674322d4f75edadd46debd5cd992f6ed;
-        g2_points[0].x[0] = 0x198e9393920d483a7260bfb731fb5d25f1aa493335a9e71297e485b7aef312c2;
-        g2_points[0].y[1] = 0x12c85ea5db8c6deb4aab71808dcb408fe3d1e7690c43d37b4ce6cc0166fa7daa;
-        g2_points[0].y[0] = 0x090689d0585ff075ec9e99ad690c3395bc4b313370b38ef355acdadcd122975b;
-        g1_points[1].x = 0x1aa125a22bd902874034e67868aed40267e5575d5919677987e3bc6dd42a32fe;
-        g1_points[1].y = 0x1bacc186725464068956d9a191455c2d6f6db282d83645c610510d8d4efbaee0;
-        g2_points[1].x[1] = 0x1b7734c80605f71f1e2de61e998ce5854ff2abebb76537c3d67e50d71422a852;
-        g2_points[1].x[0] = 0x10d5a1e34b2388a5ebe266033a5e0e63c89084203784da0c6bd9b052a78a2cac;
-        g2_points[1].y[1] = 0x275739c5c2cdbc72e37c689e2ab441ea76c1d284b9c46ae8f5c42ead937819e1;
-        g2_points[1].y[0] = 0x018de34c5b7c3d3d75428bbe050f1449ea3d9961d563291f307a1874f7332e65;
-
-        for (uint i = 0; i < n; i++) {
-            ecPairing(g1_points, g2_points);
-            // bool checked = false;
-            // checked = ecPairing(g1_points, g2_points);
-            // require(checked);
-        }
-    }
-
-    // https://github.com/OpenZeppelin/openzeppelin-contracts/blob/8a0b7bed82d6b8053872c3fd40703efd58f5699d/test/utils/cryptography/ECDSA.test.js#L230
-    function ecRecovers(uint256 n) public
-    {
-        bytes32 hash = 0xb94d27b9934d3e08a52e52d7da7dabfac484efe37a5380ee9088f7ace2efcde9;
-        bytes32 r = 0xe742ff452d41413616a5bf43fe15dd88294e983d3d36206c2712f39083d638bd;
-        uint8 v = 0x1b;
-        bytes32 s = 0xe0a0fc89be718fbc1033e1d30d78be1c68081562ed2e97af876f286f3453231d;
-
-        for (uint i = 0; i < n; i++) {
-            ecrecover(hash, v, r, s);
-        }
-    }
-}