refactor(test): simplify bridge tests (#472)

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

bridge/config.json

@@ -31,7 +31,7 @@
         "1212121212121212121212121212121212121212121212121212121212121212"
       ],
       "gas_oracle_sender_private_keys": [
-        "1212121212121212121212121212121212121212121212121212121212121212"
+        "1313131313131313131313131313131313131313131313131313131313131313"
       ]
     }
   },
@@ -66,10 +66,10 @@
         "1212121212121212121212121212121212121212121212121212121212121212"
       ],
       "gas_oracle_sender_private_keys": [
-        "1212121212121212121212121212121212121212121212121212121212121212"
+        "1313131313131313131313131313131313131313131313131313131313131313"
       ],
       "rollup_sender_private_keys": [
-        "1212121212121212121212121212121212121212121212121212121212121212"
+        "1414141414141414141414141414141414141414141414141414141414141414"
       ]
     },
     "batch_proposer_config": {

bridge/tests/bridge_test.go

@@ -2,31 +2,23 @@ package tests
 
 import (
 	"context"
-	"crypto/ecdsa"
-	"math/big"
 	"testing"
 
 	"github.com/scroll-tech/go-ethereum/accounts/abi/bind"
 	"github.com/scroll-tech/go-ethereum/common"
 	"github.com/scroll-tech/go-ethereum/core/types"
-	"github.com/scroll-tech/go-ethereum/crypto"
 	"github.com/scroll-tech/go-ethereum/ethclient"
-	"github.com/scroll-tech/go-ethereum/rpc"
 	"github.com/stretchr/testify/assert"
 
-	"scroll-tech/bridge/config"
+	bcmd "scroll-tech/bridge/cmd"
 	"scroll-tech/bridge/mock_bridge"
 
 	"scroll-tech/common/docker"
 )
 
 var (
-	// config
-	cfg *config.Config
-
-	// private key
-	privateKey *ecdsa.PrivateKey
-	base       *docker.App
+	base      *docker.App
+	bridgeApp *bcmd.MockApp
 
 	// clients
 	l1Client *ethclient.Client
@@ -51,99 +43,32 @@ var (
 
 func TestMain(m *testing.M) {
 	base = docker.NewDockerApp()
-
+	bridgeApp = bcmd.NewBridgeApp(base, "../config.json")
 	m.Run()
-
+	bridgeApp.Free()
 	base.Free()
 }
 
 func setupEnv(t *testing.T) {
-	var err error
-	privateKey, err = crypto.ToECDSA(common.FromHex("1212121212121212121212121212121212121212121212121212121212121212"))
-	assert.NoError(t, err)
-	messagePrivateKey, err := crypto.ToECDSA(common.FromHex("1212121212121212121212121212121212121212121212121212121212121213"))
-	assert.NoError(t, err)
-	rollupPrivateKey, err := crypto.ToECDSA(common.FromHex("1212121212121212121212121212121212121212121212121212121212121214"))
-	assert.NoError(t, err)
-	gasOraclePrivateKey, err := crypto.ToECDSA(common.FromHex("1212121212121212121212121212121212121212121212121212121212121215"))
-	assert.NoError(t, err)
-
-	// Load config.
-	cfg, err = config.NewConfig("../config.json")
-	assert.NoError(t, err)
-	cfg.L1Config.Confirmations = rpc.LatestBlockNumber
-	cfg.L1Config.RelayerConfig.MessageSenderPrivateKeys = []*ecdsa.PrivateKey{messagePrivateKey}
-	cfg.L1Config.RelayerConfig.RollupSenderPrivateKeys = []*ecdsa.PrivateKey{rollupPrivateKey}
-	cfg.L1Config.RelayerConfig.GasOracleSenderPrivateKeys = []*ecdsa.PrivateKey{gasOraclePrivateKey}
-	cfg.L2Config.Confirmations = rpc.LatestBlockNumber
-	cfg.L2Config.RelayerConfig.MessageSenderPrivateKeys = []*ecdsa.PrivateKey{messagePrivateKey}
-	cfg.L2Config.RelayerConfig.RollupSenderPrivateKeys = []*ecdsa.PrivateKey{rollupPrivateKey}
-	cfg.L2Config.RelayerConfig.GasOracleSenderPrivateKeys = []*ecdsa.PrivateKey{gasOraclePrivateKey}
 	base.RunImages(t)
 
-	// Create l1geth container.
-	cfg.L2Config.RelayerConfig.SenderConfig.Endpoint = base.L1gethImg.Endpoint()
-	cfg.L1Config.Endpoint = base.L1gethImg.Endpoint()
-
-	// Create l2geth container.
-	cfg.L1Config.RelayerConfig.SenderConfig.Endpoint = base.L2gethImg.Endpoint()
-	cfg.L2Config.Endpoint = base.L2gethImg.Endpoint()
-
-	// Create db container.
-	cfg.DBConfig = base.DBConfig
-
-	// Create l1geth and l2geth client.
-	l1Client, err = ethclient.Dial(cfg.L1Config.Endpoint)
+	var err error
+	l1Client, err = base.L1Client()
 	assert.NoError(t, err)
-	l2Client, err = ethclient.Dial(cfg.L2Config.Endpoint)
+	l2Client, err = base.L2Client()
 	assert.NoError(t, err)
 
-	// Create l1 and l2 auth
-	l1Auth = prepareAuth(t, l1Client, privateKey)
-	l2Auth = prepareAuth(t, l2Client, privateKey)
+	l1Cfg, l2Cfg := bridgeApp.Config.L1Config, bridgeApp.Config.L2Config
+	l1Cfg.Confirmations = 0
+	l1Cfg.RelayerConfig.SenderConfig.Confirmations = 0
+	l2Cfg.Confirmations = 0
+	l2Cfg.RelayerConfig.SenderConfig.Confirmations = 0
 
-	// send some balance to message and rollup sender
-	transferEther(t, l1Auth, l1Client, messagePrivateKey)
-	transferEther(t, l1Auth, l1Client, rollupPrivateKey)
-	transferEther(t, l1Auth, l1Client, gasOraclePrivateKey)
-	transferEther(t, l2Auth, l2Client, messagePrivateKey)
-	transferEther(t, l2Auth, l2Client, rollupPrivateKey)
-	transferEther(t, l2Auth, l2Client, gasOraclePrivateKey)
-}
-
-func transferEther(t *testing.T, auth *bind.TransactOpts, client *ethclient.Client, privateKey *ecdsa.PrivateKey) {
-	targetAddress := crypto.PubkeyToAddress(privateKey.PublicKey)
-
-	gasPrice, err := client.SuggestGasPrice(context.Background())
-	assert.NoError(t, err)
-	gasPrice.Mul(gasPrice, big.NewInt(2))
-
-	// Get pending nonce
-	nonce, err := client.PendingNonceAt(context.Background(), auth.From)
+	l1Auth, err = bind.NewKeyedTransactorWithChainID(bridgeApp.Config.L2Config.RelayerConfig.MessageSenderPrivateKeys[0], base.L1gethImg.ChainID())
 	assert.NoError(t, err)
 
-	// 200 ether should be enough
-	value, ok := big.NewInt(0).SetString("0xad78ebc5ac6200000", 0)
-	assert.Equal(t, ok, true)
-
-	tx := types.NewTx(&types.LegacyTx{
-		Nonce:    nonce,
-		To:       &targetAddress,
-		Value:    value,
-		Gas:      500000,
-		GasPrice: gasPrice,
-	})
-	signedTx, err := auth.Signer(auth.From, tx)
+	l2Auth, err = bind.NewKeyedTransactorWithChainID(bridgeApp.Config.L1Config.RelayerConfig.MessageSenderPrivateKeys[0], base.L2gethImg.ChainID())
 	assert.NoError(t, err)
-
-	err = client.SendTransaction(context.Background(), signedTx)
-	assert.NoError(t, err)
-
-	receipt, err := bind.WaitMined(context.Background(), client, signedTx)
-	assert.NoError(t, err)
-	if receipt.Status != types.ReceiptStatusSuccessful {
-		t.Fatalf("Call failed")
-	}
 }
 
 func prepareContracts(t *testing.T) {
@@ -168,27 +93,18 @@ func prepareContracts(t *testing.T) {
 	l2MessengerAddress, err = bind.WaitDeployed(context.Background(), l2Client, tx)
 	assert.NoError(t, err)
 
-	cfg.L1Config.L1MessengerAddress = l1MessengerAddress
-	cfg.L1Config.L1MessageQueueAddress = l1MessengerAddress
-	cfg.L1Config.ScrollChainContractAddress = scrollChainAddress
-	cfg.L1Config.RelayerConfig.MessengerContractAddress = l2MessengerAddress
-	cfg.L1Config.RelayerConfig.GasPriceOracleContractAddress = l1MessengerAddress
+	l1Config, l2Config := bridgeApp.Config.L1Config, bridgeApp.Config.L2Config
+	l1Config.L1MessengerAddress = l1MessengerAddress
+	l1Config.L1MessageQueueAddress = l1MessengerAddress
+	l1Config.ScrollChainContractAddress = scrollChainAddress
+	l1Config.RelayerConfig.MessengerContractAddress = l2MessengerAddress
+	l1Config.RelayerConfig.GasPriceOracleContractAddress = l1MessengerAddress
 
-	cfg.L2Config.L2MessengerAddress = l2MessengerAddress
-	cfg.L2Config.L2MessageQueueAddress = l2MessengerAddress
-	cfg.L2Config.RelayerConfig.MessengerContractAddress = l1MessengerAddress
-	cfg.L2Config.RelayerConfig.RollupContractAddress = scrollChainAddress
-	cfg.L2Config.RelayerConfig.GasPriceOracleContractAddress = l2MessengerAddress
-}
-
-func prepareAuth(t *testing.T, client *ethclient.Client, privateKey *ecdsa.PrivateKey) *bind.TransactOpts {
-	chainID, err := client.ChainID(context.Background())
-	assert.NoError(t, err)
-	auth, err := bind.NewKeyedTransactorWithChainID(privateKey, chainID)
-	assert.NoError(t, err)
-	auth.Value = big.NewInt(0) // in wei
-	assert.NoError(t, err)
-	return auth
+	l2Config.L2MessengerAddress = l2MessengerAddress
+	l2Config.L2MessageQueueAddress = l2MessengerAddress
+	l2Config.RelayerConfig.MessengerContractAddress = l1MessengerAddress
+	l2Config.RelayerConfig.RollupContractAddress = scrollChainAddress
+	l2Config.RelayerConfig.GasPriceOracleContractAddress = l2MessengerAddress
 }
 
 func TestFunction(t *testing.T) {

bridge/tests/gas_oracle_test.go

@@ -20,14 +20,14 @@ import (
 
 func testImportL1GasPrice(t *testing.T) {
 	// Create db handler and reset db.
-	db, err := database.NewOrmFactory(cfg.DBConfig)
+	db, err := database.NewOrmFactory(base.DBConfig)
 	assert.NoError(t, err)
 	assert.NoError(t, migrate.ResetDB(db.GetDB().DB))
 	defer db.Close()
 
 	prepareContracts(t)
 
-	l1Cfg := cfg.L1Config
+	l1Cfg := bridgeApp.Config.L1Config
 
 	// Create L1Relayer
 	l1Relayer, err := relayer.NewLayer1Relayer(context.Background(), db, l1Cfg.RelayerConfig)
@@ -70,14 +70,14 @@ func testImportL1GasPrice(t *testing.T) {
 
 func testImportL2GasPrice(t *testing.T) {
 	// Create db handler and reset db.
-	db, err := database.NewOrmFactory(cfg.DBConfig)
+	db, err := database.NewOrmFactory(base.DBConfig)
 	assert.NoError(t, err)
 	assert.NoError(t, migrate.ResetDB(db.GetDB().DB))
 	defer db.Close()
 
 	prepareContracts(t)
 
-	l2Cfg := cfg.L2Config
+	l2Cfg := bridgeApp.Config.L2Config
 
 	// Create L2Relayer
 	l2Relayer, err := relayer.NewLayer2Relayer(context.Background(), l2Client, db, l2Cfg.RelayerConfig)
@@ -104,7 +104,7 @@ func testImportL2GasPrice(t *testing.T) {
 	}
 	batchData := types.NewBatchData(parentBatch, []*types.WrappedBlock{
 		traces[0],
-	}, cfg.L2Config.BatchProposerConfig.PublicInputConfig)
+	}, l2Cfg.BatchProposerConfig.PublicInputConfig)
 
 	// add fake batch
 	dbTx, err := db.Beginx()

bridge/tests/l1_message_relay_test.go

@@ -22,15 +22,15 @@ import (
 
 func testRelayL1MessageSucceed(t *testing.T) {
 	// Create db handler and reset db.
-	db, err := database.NewOrmFactory(cfg.DBConfig)
+	db, err := database.NewOrmFactory(base.DBConfig)
 	assert.NoError(t, err)
 	assert.NoError(t, migrate.ResetDB(db.GetDB().DB))
 	defer db.Close()
 
 	prepareContracts(t)
 
-	l1Cfg := cfg.L1Config
-	l2Cfg := cfg.L2Config
+	l1Cfg := bridgeApp.Config.L1Config
+	l2Cfg := bridgeApp.Config.L2Config
 
 	// Create L1Relayer
 	l1Relayer, err := relayer.NewLayer1Relayer(context.Background(), db, l1Cfg.RelayerConfig)

bridge/tests/l2_message_relay_test.go

@@ -22,14 +22,14 @@ import (
 
 func testRelayL2MessageSucceed(t *testing.T) {
 	// Create db handler and reset db.
-	db, err := database.NewOrmFactory(cfg.DBConfig)
+	db, err := database.NewOrmFactory(base.DBConfig)
 	assert.NoError(t, err)
 	assert.NoError(t, migrate.ResetDB(db.GetDB().DB))
 	defer db.Close()
 
 	prepareContracts(t)
 
-	l2Cfg := cfg.L2Config
+	l2Cfg := bridgeApp.Config.L2Config
 
 	// Create L2Watcher
 	confirmations := rpc.LatestBlockNumber
@@ -40,7 +40,7 @@ func testRelayL2MessageSucceed(t *testing.T) {
 	assert.NoError(t, err)
 
 	// Create L1Watcher
-	l1Cfg := cfg.L1Config
+	l1Cfg := bridgeApp.Config.L1Config
 	l1Watcher := watcher.NewL1WatcherClient(context.Background(), l1Client, 0, confirmations, l1Cfg.L1MessengerAddress, l1Cfg.L1MessageQueueAddress, l1Cfg.ScrollChainContractAddress, db)
 
 	// send message through l2 messenger contract
@@ -85,7 +85,7 @@ func testRelayL2MessageSucceed(t *testing.T) {
 	}
 	batchData := types.NewBatchData(parentBatch, []*types.WrappedBlock{
 		traces[0],
-	}, cfg.L2Config.BatchProposerConfig.PublicInputConfig)
+	}, l2Cfg.BatchProposerConfig.PublicInputConfig)
 	batchHash := batchData.Hash().String()
 
 	// add fake batch

bridge/tests/rollup_test.go

@@ -11,6 +11,7 @@ import (
 	"github.com/stretchr/testify/assert"
 
 	"scroll-tech/common/types"
+	"scroll-tech/common/utils"
 
 	"scroll-tech/bridge/relayer"
 	"scroll-tech/bridge/watcher"
@@ -21,7 +22,7 @@ import (
 
 func testCommitBatchAndFinalizeBatch(t *testing.T) {
 	// Create db handler and reset db.
-	db, err := database.NewOrmFactory(cfg.DBConfig)
+	db, err := database.NewOrmFactory(base.DBConfig)
 	assert.NoError(t, err)
 	assert.NoError(t, migrate.ResetDB(db.GetDB().DB))
 	defer db.Close()
@@ -29,12 +30,12 @@ func testCommitBatchAndFinalizeBatch(t *testing.T) {
 	prepareContracts(t)
 
 	// Create L2Relayer
-	l2Cfg := cfg.L2Config
+	l2Cfg := bridgeApp.Config.L2Config
 	l2Relayer, err := relayer.NewLayer2Relayer(context.Background(), l2Client, db, l2Cfg.RelayerConfig)
 	assert.NoError(t, err)
 
 	// Create L1Watcher
-	l1Cfg := cfg.L1Config
+	l1Cfg := bridgeApp.Config.L1Config
 	l1Watcher := watcher.NewL1WatcherClient(context.Background(), l1Client, 0, l1Cfg.Confirmations, l1Cfg.L1MessengerAddress, l1Cfg.L1MessageQueueAddress, l1Cfg.ScrollChainContractAddress, db)
 
 	// add some blocks to db
@@ -63,7 +64,7 @@ func testCommitBatchAndFinalizeBatch(t *testing.T) {
 	batchData := types.NewBatchData(parentBatch, []*types.WrappedBlock{
 		wrappedBlocks[0],
 		wrappedBlocks[1],
-	}, cfg.L2Config.BatchProposerConfig.PublicInputConfig)
+	}, l2Cfg.BatchProposerConfig.PublicInputConfig)
 
 	batchHash := batchData.Hash().String()
 
@@ -80,7 +81,7 @@ func testCommitBatchAndFinalizeBatch(t *testing.T) {
 	assert.NoError(t, dbTx.Commit())
 
 	// process pending batch and check status
-	l2Relayer.SendCommitTx([]*types.BatchData{batchData})
+	assert.NoError(t, l2Relayer.SendCommitTx([]*types.BatchData{batchData}))
 
 	status, err := db.GetRollupStatus(batchHash)
 	assert.NoError(t, err)
@@ -97,9 +98,11 @@ func testCommitBatchAndFinalizeBatch(t *testing.T) {
 	// fetch rollup events
 	err = l1Watcher.FetchContractEvent()
 	assert.NoError(t, err)
-	status, err = db.GetRollupStatus(batchHash)
-	assert.NoError(t, err)
-	assert.Equal(t, types.RollupCommitted, status)
+	ok := utils.TryTimes(20, func() bool {
+		status, err = db.GetRollupStatus(batchHash)
+		return err == nil && status == types.RollupCommitted
+	})
+	assert.True(t, ok)
 
 	// add dummy proof
 	tProof := []byte{0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, 30, 31}
@@ -112,9 +115,12 @@ func testCommitBatchAndFinalizeBatch(t *testing.T) {
 	// process committed batch and check status
 	l2Relayer.ProcessCommittedBatches()
 
-	status, err = db.GetRollupStatus(batchHash)
-	assert.NoError(t, err)
-	assert.Equal(t, types.RollupFinalizing, status)
+	ok = utils.TryTimes(20, func() bool {
+		status, err = db.GetRollupStatus(batchHash)
+		return err == nil && status == types.RollupFinalizing
+	})
+	assert.True(t, ok)
+
 	finalizeTxHash, err := db.GetFinalizeTxHash(batchHash)
 	assert.NoError(t, err)
 	assert.Equal(t, true, finalizeTxHash.Valid)