feat(bridge-history-api): add new api to fetch all claimable txs under one address (#607)

Co-authored-by: vincent <419436363@qq.com>
Co-authored-by: georgehao <haohongfan@gmail.com>
Co-authored-by: Péter Garamvölgyi <peter@scroll.io>

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

@@ -38,6 +38,17 @@ func setupQueryByAddressHandler(backend_app *mvc.Application) {
 	backend_app.Handle(new(controller.QueryAddressController))
 }
 
+func setupQueryClaimableHandler(backend_app *mvc.Application) {
+	// Register Dependencies.
+	backend_app.Register(
+		database,
+		service.NewHistoryService,
+	)
+
+	// Register Controllers.
+	backend_app.Handle(new(controller.QueryClaimableController))
+}
+
 func setupQueryByHashHandler(backend_app *mvc.Application) {
 	backend_app.Register(
 		database,
@@ -83,6 +94,7 @@ func action(ctx *cli.Context) error {
 
 	mvc.Configure(bridgeApp.Party("/api/txs"), setupQueryByAddressHandler)
 	mvc.Configure(bridgeApp.Party("/api/txsbyhashes"), setupQueryByHashHandler)
+	mvc.Configure(bridgeApp.Party("/api/claimable"), setupQueryClaimableHandler)
 
 	// TODO: make debug mode configurable
 	err = bridgeApp.Listen(cfg.Server.HostPort, iris.WithLogLevel("debug"))

bridge-history-api/controller/controller.go

@@ -15,6 +15,23 @@ type QueryHashController struct {
 	Service service.HistoryService
 }
 
+type QueryClaimableController struct {
+	Service service.HistoryService
+}
+
+func (c *QueryClaimableController) Get(req model.QueryByAddressRequest) (*model.QueryByAddressResponse, error) {
+	txs, total, err := c.Service.GetClaimableTxsByAddress(common.HexToAddress(req.Address), int64(req.Offset), int64(req.Limit))
+	if err != nil {
+		return &model.QueryByAddressResponse{Message: "500", Data: &model.Data{}}, err
+	}
+
+	return &model.QueryByAddressResponse{Message: "ok",
+		Data: &model.Data{
+			Result: txs,
+			Total:  total,
+		}}, nil
+}
+
 func (c *QueryAddressController) Get(req model.QueryByAddressRequest) (*model.QueryByAddressResponse, error) {
 	message, total, err := c.Service.GetTxsByAddress(common.HexToAddress(req.Address), int64(req.Offset), int64(req.Limit))
 	if err != nil {

bridge-history-api/db/migrate/migrations/00002_relayed_msg.sql

@@ -19,6 +19,8 @@ CREATE INDEX idx_l1_msg_relayed_msg ON relayed_msg (layer1_hash, deleted_at);
 
 CREATE INDEX idx_l2_msg_relayed_msg ON relayed_msg (layer2_hash, deleted_at);
 
+CREATE INDEX idx_msg_hash_deleted_at_relayed_msg on relayed_msg (msg_hash, deleted_at);
+
 CREATE OR REPLACE FUNCTION update_timestamp()
 RETURNS TRIGGER AS $$
 BEGIN

bridge-history-api/db/migrate/migrations/00003_l2_sent_msg.sql

@@ -4,6 +4,7 @@ create table l2_sent_msg
 (
     id               BIGSERIAL PRIMARY KEY,
     original_sender  VARCHAR NOT NULL DEFAULT '',
+    tx_hash          VARCHAR NOT NULL,
     sender           VARCHAR NOT NULL,
     target           VARCHAR NOT NULL,
     value            VARCHAR NOT NULL,
@@ -24,6 +25,8 @@ on l2_sent_msg (msg_hash) where deleted_at IS NULL;
 create unique index uk_nonce
 on l2_sent_msg (nonce) where deleted_at IS NULL;
 
+CREATE INDEX idx_msg_hash_deleted_at_l2_sent_msg on l2_sent_msg (msg_hash, deleted_at);
+
 CREATE OR REPLACE FUNCTION update_timestamp()
 RETURNS TRIGGER AS $$
 BEGIN

bridge-history-api/db/orm/interface.go

@@ -86,6 +86,7 @@ type L2CrossMsgOrm interface {
 	DeleteL2CrossMsgFromHeightDBTx(dbTx *sqlx.Tx, height int64) error
 	UpdateL2BlockTimestamp(height uint64, timestamp time.Time) error
 	GetL2EarliestNoBlockTimestampHeight() (uint64, error)
+	GetL2CrossMsgByMsgHashList(msgHashList []string) ([]*CrossMsg, error)
 }
 
 type RelayedMsgOrm interface {
@@ -106,6 +107,8 @@ type L2SentMsgOrm interface {
 	GetL2SentMsgMsgHashByHeightRange(startHeight, endHeight uint64) ([]*L2SentMsg, error)
 	UpdateL2MessageProofInDBTx(ctx context.Context, dbTx *sqlx.Tx, msgHash string, proof string, batch_index uint64) error
 	GetLatestL2SentMsgBatchIndex() (int64, error)
+	GetClaimableL2SentMsgByAddressWithOffset(address string, offset int64, limit int64) ([]*L2SentMsg, error)
+	GetClaimableL2SentMsgByAddressTotalNum(address string) (uint64, error)
 	DeleteL2SentMsgAfterHeightDBTx(dbTx *sqlx.Tx, height int64) error
 }
 

bridge-history-api/db/orm/l2_cross_msg.go

@@ -140,3 +140,22 @@ func (l *l2CrossMsgOrm) GetL2EarliestNoBlockTimestampHeight() (uint64, error) {
 	}
 	return result, nil
 }
+
+func (l *l2CrossMsgOrm) GetL2CrossMsgByMsgHashList(msgHashList []string) ([]*CrossMsg, error) {
+	var results []*CrossMsg
+	rows, err := l.db.Queryx(`SELECT * FROM cross_message WHERE msg_hash in ($1) AND msg_type = $2 AND deleted_at IS NULL;`, msgHashList, Layer2Msg)
+	for rows.Next() {
+		msg := &CrossMsg{}
+		if err = rows.StructScan(msg); err != nil {
+			break
+		}
+		results = append(results, msg)
+	}
+	if err != nil && !errors.Is(err, sql.ErrNoRows) {
+		return nil, err
+	}
+	if len(results) == 0 {
+		log.Debug("no L2CrossMsg under given msg hashes", "msg hash list", msgHashList)
+	}
+	return results, nil
+}

bridge-history-api/db/orm/l2_sent_msg.go

@@ -12,6 +12,7 @@ import (
 type L2SentMsg struct {
 	ID             uint64     `json:"id" db:"id"`
 	OriginalSender string     `json:"original_sender" db:"original_sender"`
+	TxHash         string     `json:"tx_hash" db:"tx_hash"`
 	MsgHash        string     `json:"msg_hash" db:"msg_hash"`
 	Sender         string     `json:"sender" db:"sender"`
 	Target         string     `json:"target" db:"target"`
@@ -53,6 +54,7 @@ func (l *l2SentMsgOrm) BatchInsertL2SentMsgDBTx(dbTx *sqlx.Tx, messages []*L2Sen
 	for i, msg := range messages {
 		messageMaps[i] = map[string]interface{}{
 			"original_sender": msg.OriginalSender,
+			"tx_hash":         msg.TxHash,
 			"sender":          msg.Sender,
 			"target":          msg.Target,
 			"value":           msg.Value,
@@ -64,7 +66,7 @@ func (l *l2SentMsgOrm) BatchInsertL2SentMsgDBTx(dbTx *sqlx.Tx, messages []*L2Sen
 			"msg_data":        msg.MsgData,
 		}
 	}
-	_, err = dbTx.NamedExec(`insert into l2_sent_msg(original_sender, sender, target, value, msg_hash, height, nonce, batch_index, msg_proof, msg_data) values(:original_sender, :sender, :target, :value, :msg_hash, :height, :nonce, :batch_index, :msg_proof, :msg_data);`, messageMaps)
+	_, err = dbTx.NamedExec(`insert into l2_sent_msg(original_sender, tx_hash, sender, target, value, msg_hash, height, nonce, batch_index, msg_proof, msg_data) values(:original_sender, :tx_hash, :sender, :target, :value, :msg_hash, :height, :nonce, :batch_index, :msg_proof, :msg_data);`, messageMaps)
 	if err != nil {
 		log.Error("BatchInsertL2SentMsgDBTx: failed to insert l2 sent msgs", "err", err)
 		return err
@@ -149,3 +151,28 @@ func (l *l2SentMsgOrm) DeleteL2SentMsgAfterHeightDBTx(dbTx *sqlx.Tx, height int6
 	_, err := dbTx.Exec(`UPDATE l2_sent_msg SET deleted_at = current_timestamp WHERE height > $1;`, height)
 	return err
 }
+
+func (l *l2SentMsgOrm) GetClaimableL2SentMsgByAddressWithOffset(address string, offset int64, limit int64) ([]*L2SentMsg, error) {
+	var results []*L2SentMsg
+	rows, err := l.db.Queryx(`SELECT * FROM l2_sent_msg WHERE id NOT IN (SELECT l2_sent_msg.id FROM l2_sent_msg INNER JOIN relayed_msg ON l2_sent_msg.msg_hash = relayed_msg.msg_hash WHERE l2_sent_msg.deleted_at IS NULL AND relayed_msg.deleted_at IS NULL) AND (original_sender=$1 OR sender = $1) ORDER BY id DESC LIMIT $2 OFFSET $3;`, address, limit, offset)
+	if err != nil {
+		return nil, err
+	}
+	for rows.Next() {
+		msg := &L2SentMsg{}
+		if err = rows.StructScan(msg); err != nil {
+			break
+		}
+		results = append(results, msg)
+	}
+	return results, err
+}
+
+func (l *l2SentMsgOrm) GetClaimableL2SentMsgByAddressTotalNum(address string) (uint64, error) {
+	var count uint64
+	row := l.db.QueryRowx(`SELECT COUNT(*) FROM l2_sent_msg WHERE id NOT IN (SELECT l2_sent_msg.id FROM l2_sent_msg INNER JOIN relayed_msg ON l2_sent_msg.msg_hash = relayed_msg.msg_hash WHERE l2_sent_msg.deleted_at IS NULL AND relayed_msg.deleted_at IS NULL) AND (original_sender=$1 OR sender = $1);`, address)
+	if err := row.Scan(&count); err != nil {
+		return 0, err
+	}
+	return count, nil
+}

bridge-history-api/service/service.go

@@ -47,6 +47,7 @@ type TxHistoryInfo struct {
 type HistoryService interface {
 	GetTxsByAddress(address common.Address, offset int64, limit int64) ([]*TxHistoryInfo, uint64, error)
 	GetTxsByHashes(hashes []string) ([]*TxHistoryInfo, error)
+	GetClaimableTxsByAddress(address common.Address, offset int64, limit int64) ([]*TxHistoryInfo, uint64, error)
 }
 
 // NewHistoryService returns a service backed with a "db"
@@ -106,6 +107,47 @@ func updateCrossTxHash(msgHash string, txInfo *TxHistoryInfo, db db.OrmFactory)
 
 }
 
+func (h *historyBackend) GetClaimableTxsByAddress(address common.Address, offset int64, limit int64) ([]*TxHistoryInfo, uint64, error) {
+	var txHistories []*TxHistoryInfo
+	total, err := h.db.GetClaimableL2SentMsgByAddressTotalNum(address.Hex())
+	if err != nil || total == 0 {
+		return txHistories, 0, err
+	}
+	results, err := h.db.GetClaimableL2SentMsgByAddressWithOffset(address.Hex(), offset, limit)
+	if err != nil || len(results) == 0 {
+		return txHistories, 0, err
+	}
+	var msgHashList []string
+	for _, result := range results {
+		msgHashList = append(msgHashList, result.MsgHash)
+	}
+	crossMsgs, err := h.db.GetL2CrossMsgByMsgHashList(msgHashList)
+	if err != nil || len(crossMsgs) == 0 {
+		return txHistories, 0, err
+	}
+	crossMsgMap := make(map[string]*orm.CrossMsg)
+	for _, crossMsg := range crossMsgs {
+		crossMsgMap[crossMsg.MsgHash] = crossMsg
+	}
+	for _, result := range results {
+		txInfo := &TxHistoryInfo{
+			Hash:        result.TxHash,
+			IsL1:        false,
+			BlockNumber: result.Height,
+			FinalizeTx:  &Finalized{},
+			ClaimInfo:   GetCrossTxClaimInfo(result.MsgHash, h.db),
+		}
+		if crossMsg, exist := crossMsgMap[result.MsgHash]; exist {
+			txInfo.Amount = crossMsg.Amount
+			txInfo.To = crossMsg.Target
+			txInfo.BlockTimestamp = crossMsg.Timestamp
+			txInfo.CreatedAt = crossMsg.CreatedAt
+		}
+		txHistories = append(txHistories, txInfo)
+	}
+	return txHistories, total, err
+}
+
 func (h *historyBackend) GetTxsByAddress(address common.Address, offset int64, limit int64) ([]*TxHistoryInfo, uint64, error) {
 	var txHistories []*TxHistoryInfo
 	total, err := h.db.GetTotalCrossMsgCountByAddress(address.String())

bridge-history-api/utils/parse_event.go

@@ -222,6 +222,7 @@ func ParseBackendL2EventLogs(logs []types.Log) ([]*orm.CrossMsg, []*orm.RelayedM
 			l2SentMsgs = append(l2SentMsgs,
 				&orm.L2SentMsg{
 					Sender:  event.Sender.Hex(),
+					TxHash:  vlog.TxHash.Hex(),
 					Target:  event.Target.Hex(),
 					Value:   event.Value.String(),
 					MsgHash: msgHash.Hex(),

bridge/internal/config/l2.go

@@ -40,7 +40,7 @@ type ChunkProposerConfig struct {
 type BatchProposerConfig struct {
 	MaxChunkNumPerBatch             uint64 `json:"max_chunk_num_per_batch"`
 	MaxL1CommitGasPerBatch          uint64 `json:"max_l1_commit_gas_per_batch"`
-	MaxL1CommitCalldataSizePerBatch uint64 `json:"max_l1_commit_calldata_size_per_batch"`
+	MaxL1CommitCalldataSizePerBatch uint32 `json:"max_l1_commit_calldata_size_per_batch"`
 	MinChunkNumPerBatch             uint64 `json:"min_chunk_num_per_batch"`
 	BatchTimeoutSec                 uint64 `json:"batch_timeout_sec"`
 }

bridge/internal/controller/relayer/l1_relayer_test.go

@@ -128,8 +128,8 @@ func testL1RelayerGasOracleConfirm(t *testing.T) {
 	l1BlockOrm := orm.NewL1Block(db)
 
 	l1Block := []orm.L1Block{
-		{Hash: "gas-oracle-1", Number: 0},
-		{Hash: "gas-oracle-2", Number: 1},
+		{Hash: "gas-oracle-1", Number: 0, GasOracleStatus: int16(types.GasOraclePending), BlockStatus: int16(types.L1BlockPending)},
+		{Hash: "gas-oracle-2", Number: 1, GasOracleStatus: int16(types.GasOraclePending), BlockStatus: int16(types.L1BlockPending)},
 	}
 	// Insert test data.
 	assert.NoError(t, l1BlockOrm.InsertL1Blocks(context.Background(), l1Block))
@@ -211,7 +211,7 @@ func testL1RelayerProcessGasPriceOracle(t *testing.T) {
 			{
 				Hash:            "gas-oracle-1",
 				Number:          0,
-				GasOracleStatus: int(types.GasOraclePending),
+				GasOracleStatus: int16(types.GasOraclePending),
 			},
 		}
 		return tmpInfo, nil

bridge/internal/controller/watcher/batch_proposer.go

@@ -25,7 +25,7 @@ type BatchProposer struct {
 
 	maxChunkNumPerBatch             uint64
 	maxL1CommitGasPerBatch          uint64
-	maxL1CommitCalldataSizePerBatch uint64
+	maxL1CommitCalldataSizePerBatch uint32
 	minChunkNumPerBatch             uint64
 	batchTimeoutSec                 uint64
 }

bridge/internal/controller/watcher/l1_watcher.go

@@ -149,9 +149,11 @@ func (w *L1WatcherClient) FetchBlockHeader(blockHeight uint64) error {
 			baseFee = block.BaseFee.Uint64()
 		}
 		blocks = append(blocks, orm.L1Block{
-			Number:  uint64(height),
-			Hash:    block.Hash().String(),
-			BaseFee: baseFee,
+			Number:          uint64(height),
+			Hash:            block.Hash().String(),
+			BaseFee:         baseFee,
+			GasOracleStatus: int16(types.GasOraclePending),
+			BlockStatus:     int16(types.L1BlockPending),
 		})
 	}
 

bridge/internal/orm/batch.go

@@ -33,12 +33,12 @@ type Batch struct {
 	BatchHeader     []byte `json:"batch_header" gorm:"column:batch_header"`
 
 	// proof
-	ChunkProofsStatus int16      `json:"chunk_proofs_status" gorm:"column:chunk_proofs_status"`
+	ChunkProofsStatus int16      `json:"chunk_proofs_status" gorm:"column:chunk_proofs_status;default:1"`
 	ProvingStatus     int16      `json:"proving_status" gorm:"column:proving_status;default:1"`
 	Proof             []byte     `json:"proof" gorm:"column:proof;default:NULL"`
 	ProverAssignedAt  *time.Time `json:"prover_assigned_at" gorm:"column:prover_assigned_at;default:NULL"`
 	ProvedAt          *time.Time `json:"proved_at" gorm:"column:proved_at;default:NULL"`
-	ProofTimeSec      int        `json:"proof_time_sec" gorm:"column:proof_time_sec;default:NULL"`
+	ProofTimeSec      int32      `json:"proof_time_sec" gorm:"column:proof_time_sec;default:NULL"`
 
 	// rollup
 	RollupStatus   int16      `json:"rollup_status" gorm:"column:rollup_status;default:1"`
@@ -263,6 +263,7 @@ func (o *Batch) InsertBatch(ctx context.Context, startChunkIndex, endChunkIndex
 		ChunkProofsStatus: int16(types.ChunkProofsStatusPending),
 		ProvingStatus:     int16(types.ProvingTaskUnassigned),
 		RollupStatus:      int16(types.RollupPending),
+		OracleStatus:      int16(types.GasOraclePending),
 	}
 
 	db := o.db

bridge/internal/orm/chunk.go

@@ -25,22 +25,22 @@ type Chunk struct {
 	EndBlockHash                 string `json:"end_block_hash" gorm:"column:end_block_hash"`
 	StartBlockTime               uint64 `json:"start_block_time" gorm:"column:start_block_time"`
 	TotalL1MessagesPoppedBefore  uint64 `json:"total_l1_messages_popped_before" gorm:"column:total_l1_messages_popped_before"`
-	TotalL1MessagesPoppedInChunk uint64 `json:"total_l1_messages_popped_in_chunk" gorm:"column:total_l1_messages_popped_in_chunk"`
+	TotalL1MessagesPoppedInChunk uint32 `json:"total_l1_messages_popped_in_chunk" gorm:"column:total_l1_messages_popped_in_chunk"`
 
 	// proof
 	ProvingStatus    int16      `json:"proving_status" gorm:"column:proving_status;default:1"`
 	Proof            []byte     `json:"proof" gorm:"column:proof;default:NULL"`
 	ProverAssignedAt *time.Time `json:"prover_assigned_at" gorm:"column:prover_assigned_at;default:NULL"`
 	ProvedAt         *time.Time `json:"proved_at" gorm:"column:proved_at;default:NULL"`
-	ProofTimeSec     int        `json:"proof_time_sec" gorm:"column:proof_time_sec;default:NULL"`
+	ProofTimeSec     int32      `json:"proof_time_sec" gorm:"column:proof_time_sec;default:NULL"`
 
 	// batch
 	BatchHash string `json:"batch_hash" gorm:"column:batch_hash;default:NULL"`
 
 	// metadata
 	TotalL2TxGas              uint64         `json:"total_l2_tx_gas" gorm:"column:total_l2_tx_gas"`
-	TotalL2TxNum              uint64         `json:"total_l2_tx_num" gorm:"column:total_l2_tx_num"`
-	TotalL1CommitCalldataSize uint64         `json:"total_l1_commit_calldata_size" gorm:"column:total_l1_commit_calldata_size"`
+	TotalL2TxNum              uint32         `json:"total_l2_tx_num" gorm:"column:total_l2_tx_num"`
+	TotalL1CommitCalldataSize uint32         `json:"total_l1_commit_calldata_size" gorm:"column:total_l1_commit_calldata_size"`
 	TotalL1CommitGas          uint64         `json:"total_l1_commit_gas" gorm:"column:total_l1_commit_gas"`
 	CreatedAt                 time.Time      `json:"created_at" gorm:"column:created_at"`
 	UpdatedAt                 time.Time      `json:"updated_at" gorm:"column:updated_at"`
@@ -129,7 +129,7 @@ func (o *Chunk) InsertChunk(ctx context.Context, chunk *types.Chunk, dbTX ...*go
 	// if parentChunk!=nil then err=nil, then we fill the parentChunk-related data into the creating chunk
 	if parentChunk != nil {
 		chunkIndex = parentChunk.Index + 1
-		totalL1MessagePoppedBefore = parentChunk.TotalL1MessagesPoppedBefore + parentChunk.TotalL1MessagesPoppedInChunk
+		totalL1MessagePoppedBefore = parentChunk.TotalL1MessagesPoppedBefore + uint64(parentChunk.TotalL1MessagesPoppedInChunk)
 	}
 
 	hash, err := chunk.Hash(totalL1MessagePoppedBefore)
@@ -158,12 +158,12 @@ func (o *Chunk) InsertChunk(ctx context.Context, chunk *types.Chunk, dbTX ...*go
 		EndBlockNumber:               chunk.Blocks[numBlocks-1].Header.Number.Uint64(),
 		EndBlockHash:                 chunk.Blocks[numBlocks-1].Header.Hash().Hex(),
 		TotalL2TxGas:                 totalL2TxGas,
-		TotalL2TxNum:                 totalL2TxNum,
-		TotalL1CommitCalldataSize:    totalL1CommitCalldataSize,
+		TotalL2TxNum:                 uint32(totalL2TxNum),
+		TotalL1CommitCalldataSize:    uint32(totalL1CommitCalldataSize),
 		TotalL1CommitGas:             totalL1CommitGas,
 		StartBlockTime:               chunk.Blocks[0].Header.Time,
 		TotalL1MessagesPoppedBefore:  totalL1MessagePoppedBefore,
-		TotalL1MessagesPoppedInChunk: chunk.NumL1Messages(totalL1MessagePoppedBefore),
+		TotalL1MessagesPoppedInChunk: uint32(chunk.NumL1Messages(totalL1MessagePoppedBefore)),
 		ProvingStatus:                int16(types.ProvingTaskUnassigned),
 	}
 

bridge/internal/orm/l1_block.go

@@ -3,6 +3,7 @@ package orm
 import (
 	"context"
 	"fmt"
+	"time"
 
 	"gorm.io/gorm"
 
@@ -13,14 +14,23 @@ import (
 type L1Block struct {
 	db *gorm.DB `gorm:"column:-"`
 
-	Number          uint64 `json:"number" gorm:"column:number"`
-	Hash            string `json:"hash" gorm:"column:hash"`
-	HeaderRLP       string `json:"header_rlp" gorm:"column:header_rlp"`
-	BaseFee         uint64 `json:"base_fee" gorm:"column:base_fee"`
-	BlockStatus     int    `json:"block_status" gorm:"column:block_status;default:1"`
-	ImportTxHash    string `json:"import_tx_hash" gorm:"column:import_tx_hash;default:NULL"`
-	GasOracleStatus int    `json:"oracle_status" gorm:"column:oracle_status;default:1"`
+	// block
+	Number  uint64 `json:"number" gorm:"column:number"`
+	Hash    string `json:"hash" gorm:"column:hash"`
+	BaseFee uint64 `json:"base_fee" gorm:"column:base_fee"`
+
+	// import
+	BlockStatus  int16  `json:"block_status" gorm:"column:block_status;default:1"`
+	ImportTxHash string `json:"import_tx_hash" gorm:"column:import_tx_hash;default:NULL"`
+
+	// oracle
+	GasOracleStatus int16  `json:"oracle_status" gorm:"column:oracle_status;default:1"`
 	OracleTxHash    string `json:"oracle_tx_hash" gorm:"column:oracle_tx_hash;default:NULL"`
+
+	// metadata
+	CreatedAt time.Time      `json:"created_at" gorm:"column:created_at"`
+	UpdatedAt time.Time      `json:"updated_at" gorm:"column:updated_at"`
+	DeletedAt gorm.DeletedAt `json:"deleted_at" gorm:"column:deleted_at;default:NULL"`
 }
 
 // NewL1Block create an l1Block instance

bridge/internal/orm/l1_message.go

@@ -3,6 +3,7 @@ package orm
 import (
 	"context"
 	"database/sql"
+	"time"
 
 	"github.com/scroll-tech/go-ethereum/log"
 	"gorm.io/gorm"
@@ -25,6 +26,11 @@ type L1Message struct {
 	Layer1Hash string `json:"layer1_hash" gorm:"column:layer1_hash"`
 	Layer2Hash string `json:"layer2_hash" gorm:"column:layer2_hash;default:NULL"`
 	Status     int    `json:"status" gorm:"column:status;default:1"`
+
+	// metadata
+	CreatedAt time.Time      `json:"created_at" gorm:"column:created_at"`
+	UpdatedAt time.Time      `json:"updated_at" gorm:"column:updated_at"`
+	DeletedAt gorm.DeletedAt `json:"deleted_at" gorm:"column:deleted_at;default:NULL"`
 }
 
 // NewL1Message create an L1MessageOrm instance

bridge/internal/orm/l2_block.go

@@ -4,6 +4,7 @@ import (
 	"context"
 	"encoding/json"
 	"fmt"
+	"time"
 
 	"github.com/scroll-tech/go-ethereum/common"
 	gethTypes "github.com/scroll-tech/go-ethereum/core/types"
@@ -17,16 +18,24 @@ import (
 type L2Block struct {
 	db *gorm.DB `gorm:"column:-"`
 
+	// block
 	Number           uint64 `json:"number" gorm:"number"`
 	Hash             string `json:"hash" gorm:"hash"`
 	ParentHash       string `json:"parent_hash" gorm:"parent_hash"`
 	Header           string `json:"header" gorm:"header"`
 	Transactions     string `json:"transactions" gorm:"transactions"`
 	WithdrawTrieRoot string `json:"withdraw_trie_root" gorm:"withdraw_trie_root"`
-	TxNum            uint64 `json:"tx_num" gorm:"tx_num"`
+	TxNum            uint32 `json:"tx_num" gorm:"tx_num"`
 	GasUsed          uint64 `json:"gas_used" gorm:"gas_used"`
 	BlockTimestamp   uint64 `json:"block_timestamp" gorm:"block_timestamp"`
-	ChunkHash        string `json:"chunk_hash" gorm:"chunk_hash;default:NULL"`
+
+	// chunk
+	ChunkHash string `json:"chunk_hash" gorm:"chunk_hash;default:NULL"`
+
+	// metadata
+	CreatedAt time.Time      `json:"created_at" gorm:"column:created_at"`
+	UpdatedAt time.Time      `json:"updated_at" gorm:"column:updated_at"`
+	DeletedAt gorm.DeletedAt `json:"deleted_at" gorm:"column:deleted_at;default:NULL"`
 }
 
 // NewL2Block creates a new L2Block instance
@@ -180,7 +189,7 @@ func (o *L2Block) InsertL2Blocks(ctx context.Context, blocks []*types.WrappedBlo
 			ParentHash:       block.Header.ParentHash.String(),
 			Transactions:     string(txs),
 			WithdrawTrieRoot: block.WithdrawTrieRoot.Hex(),
-			TxNum:            uint64(len(block.Transactions)),
+			TxNum:            uint32(len(block.Transactions)),
 			GasUsed:          block.Header.GasUsed,
 			BlockTimestamp:   block.Header.Time,
 			Header:           string(header),

bridge/internal/orm/orm_test.go

@@ -227,7 +227,7 @@ func TestBatchOrm(t *testing.T) {
 	assert.NoError(t, err)
 
 	dbProof, err := batchOrm.GetVerifiedProofByHash(context.Background(), batchHash1)
-	assert.Error(t, err, gorm.ErrRecordNotFound)
+	assert.Error(t, err)
 	assert.Nil(t, dbProof)
 
 	err = batchOrm.UpdateProvingStatus(context.Background(), batchHash2, types.ProvingTaskVerified)

common/types/db.go

@@ -2,7 +2,6 @@
 package types
 
 import (
-	"database/sql"
 	"fmt"
 )
 
@@ -63,20 +62,6 @@ func (s GasOracleStatus) String() string {
 	}
 }
 
-// L1BlockInfo is structure of stored l1 block
-type L1BlockInfo struct {
-	Number    uint64 `json:"number" db:"number"`
-	Hash      string `json:"hash" db:"hash"`
-	HeaderRLP string `json:"header_rlp" db:"header_rlp"`
-	BaseFee   uint64 `json:"base_fee" db:"base_fee"`
-
-	BlockStatus     L1BlockStatus   `json:"block_status" db:"block_status"`
-	GasOracleStatus GasOracleStatus `json:"oracle_status" db:"oracle_status"`
-
-	ImportTxHash sql.NullString `json:"import_tx_hash" db:"import_tx_hash"`
-	OracleTxHash sql.NullString `json:"oracle_tx_hash" db:"oracle_tx_hash"`
-}
-
 // MsgStatus represents current layer1 transaction processing status
 type MsgStatus int
 
@@ -103,50 +88,14 @@ const (
 	MsgRelayFailed
 )
 
-// L1Message is structure of stored layer1 bridge message
-type L1Message struct {
-	QueueIndex uint64    `json:"queue_index" db:"queue_index"`
-	MsgHash    string    `json:"msg_hash" db:"msg_hash"`
-	Height     uint64    `json:"height" db:"height"`
-	Sender     string    `json:"sender" db:"sender"`
-	Value      string    `json:"value" db:"value"`
-	Target     string    `json:"target" db:"target"`
-	Calldata   string    `json:"calldata" db:"calldata"`
-	GasLimit   uint64    `json:"gas_limit" db:"gas_limit"`
-	Layer1Hash string    `json:"layer1_hash" db:"layer1_hash"`
-	Status     MsgStatus `json:"status" db:"status"`
-}
-
-// L2Message is structure of stored layer2 bridge message
-type L2Message struct {
-	Nonce      uint64    `json:"nonce" db:"nonce"`
-	MsgHash    string    `json:"msg_hash" db:"msg_hash"`
-	Height     uint64    `json:"height" db:"height"`
-	Sender     string    `json:"sender" db:"sender"`
-	Value      string    `json:"value" db:"value"`
-	Target     string    `json:"target" db:"target"`
-	Calldata   string    `json:"calldata" db:"calldata"`
-	Layer2Hash string    `json:"layer2_hash" db:"layer2_hash"`
-	Status     MsgStatus `json:"status" db:"status"`
-}
-
-// BlockInfo is structure of stored `block_trace` without `trace`
-type BlockInfo struct {
-	Number         uint64         `json:"number" db:"number"`
-	Hash           string         `json:"hash" db:"hash"`
-	ParentHash     string         `json:"parent_hash" db:"parent_hash"`
-	BatchHash      sql.NullString `json:"batch_hash" db:"batch_hash"`
-	TxNum          uint64         `json:"tx_num" db:"tx_num"`
-	GasUsed        uint64         `json:"gas_used" db:"gas_used"`
-	BlockTimestamp uint64         `json:"block_timestamp" db:"block_timestamp"`
-}
-
 // RollerProveStatus is the roller prove status of a block batch (session)
 type RollerProveStatus int32
 
 const (
+	// RollerProveStatusUndefined indicates an unknown roller proving status
+	RollerProveStatusUndefined RollerProveStatus = iota
 	// RollerAssigned indicates roller assigned but has not submitted proof
-	RollerAssigned RollerProveStatus = iota
+	RollerAssigned
 	// RollerProofValid indicates roller has submitted valid proof
 	RollerProofValid
 	// RollerProofInvalid indicates roller has submitted invalid proof
@@ -166,11 +115,19 @@ func (s RollerProveStatus) String() string {
 	}
 }
 
-// RollerStatus is the roller name and roller prove status
-type RollerStatus struct {
-	PublicKey string            `json:"public_key"`
-	Name      string            `json:"name"`
-	Status    RollerProveStatus `json:"status"`
+// RollerFailureType is the type of a roller session's failure
+type RollerFailureType int
+
+const (
+	// RollerFailureTypeUndefined indicates an unknown roller failure type
+	RollerFailureTypeUndefined RollerFailureType = iota
+)
+
+func (s RollerFailureType) String() string {
+	switch s {
+	default:
+		return fmt.Sprintf("Undefined (%d)", int32(s))
+	}
 }
 
 // ProvingStatus block_batch proving_status (unassigned, assigned, proved, verified, submitted)

common/types/message/message.go

@@ -38,8 +38,10 @@ func (r ProofType) String() string {
 }
 
 const (
+	// ProofTypeUndefined is an unknown proof type
+	ProofTypeUndefined ProofType = iota
 	// ProofTypeChunk is default roller, it only generates zk proof from traces.
-	ProofTypeChunk ProofType = iota
+	ProofTypeChunk
 	// ProofTypeBatch generates zk proof from other zk proofs and aggregate them into one proof.
 	ProofTypeBatch
 )

common/types/message/message_test.go

@@ -57,7 +57,7 @@ func TestIdentityHash(t *testing.T) {
 	hash, err := identity.Hash()
 	assert.NoError(t, err)
 
-	expectedHash := "b3f152958dc881446fc131a250526139d909710c6b91b4d3281ceded28ce2e32"
+	expectedHash := "063a3620db7f71e5ae99dd622222e1e893247344727fb2a2b022524d06f35aaf"
 	assert.Equal(t, expectedHash, hex.EncodeToString(hash))
 }
 
@@ -109,15 +109,15 @@ func TestProofDetailHash(t *testing.T) {
 	}
 	hash, err := proofDetail.Hash()
 	assert.NoError(t, err)
-	expectedHash := "fdfaae752d6fd72a7fdd2ad034ef504d3acda9e691a799323cfa6e371684ba2b"
+	expectedHash := "8ad894c2047166a98b1a389b716b06b01dc1bd29e950e2687ffbcb3c328edda5"
 	assert.Equal(t, expectedHash, hex.EncodeToString(hash))
 }
 
 func TestProveTypeString(t *testing.T) {
-	proofTypeChunk := ProofType(0)
+	proofTypeChunk := ProofType(1)
 	assert.Equal(t, "proof type chunk", proofTypeChunk.String())
 
-	proofTypeBatch := ProofType(1)
+	proofTypeBatch := ProofType(2)
 	assert.Equal(t, "proof type batch", proofTypeBatch.String())
 
 	illegalProof := ProofType(3)

common/version/version.go

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

contracts/src/L1/L1ScrollMessenger.sol

@@ -78,7 +78,7 @@ contract L1ScrollMessenger is PausableUpgradeable, ScrollMessengerBase, IL1Scrol
         bytes memory _message,
         uint256 _gasLimit
     ) external payable override whenNotPaused {
-        _sendMessage(_to, _value, _message, _gasLimit, tx.origin);
+        _sendMessage(_to, _value, _message, _gasLimit, msg.sender);
     }
 
     /// @inheritdoc IScrollMessenger

contracts/src/L1/gateways/L1CustomERC20Gateway.sol

@@ -137,7 +137,7 @@ contract L1CustomERC20Gateway is OwnableUpgradeable, ScrollGatewayBase, L1ERC20G
         );
 
         // 3. Send message to L1ScrollMessenger.
-        IL1ScrollMessenger(messenger).sendMessage{value: msg.value}(counterpart, 0, _message, _gasLimit);
+        IL1ScrollMessenger(messenger).sendMessage{value: msg.value}(counterpart, 0, _message, _gasLimit, _from);
 
         emit DepositERC20(_token, _l2Token, _from, _to, _amount, _data);
     }

contracts/src/L1/gateways/L1ERC1155Gateway.sol

@@ -183,7 +183,7 @@ contract L1ERC1155Gateway is OwnableUpgradeable, ERC1155HolderUpgradeable, Scrol
         );
 
         // 3. Send message to L1ScrollMessenger.
-        IL1ScrollMessenger(messenger).sendMessage{value: msg.value}(counterpart, 0, _message, _gasLimit);
+        IL1ScrollMessenger(messenger).sendMessage{value: msg.value}(counterpart, 0, _message, _gasLimit, msg.sender);
 
         emit DepositERC1155(_token, _l2Token, msg.sender, _to, _tokenId, _amount);
     }
@@ -226,7 +226,7 @@ contract L1ERC1155Gateway is OwnableUpgradeable, ERC1155HolderUpgradeable, Scrol
         );
 
         // 3. Send message to L1ScrollMessenger.
-        IL1ScrollMessenger(messenger).sendMessage{value: msg.value}(counterpart, 0, _message, _gasLimit);
+        IL1ScrollMessenger(messenger).sendMessage{value: msg.value}(counterpart, 0, _message, _gasLimit, msg.sender);
 
         emit BatchDepositERC1155(_token, _l2Token, msg.sender, _to, _tokenIds, _amounts);
     }

contracts/src/L1/gateways/L1ERC721Gateway.sol

@@ -173,7 +173,7 @@ contract L1ERC721Gateway is OwnableUpgradeable, ERC721HolderUpgradeable, ScrollG
         );
 
         // 3. Send message to L1ScrollMessenger.
-        IL1ScrollMessenger(messenger).sendMessage{value: msg.value}(counterpart, 0, _message, _gasLimit);
+        IL1ScrollMessenger(messenger).sendMessage{value: msg.value}(counterpart, 0, _message, _gasLimit, msg.sender);
 
         emit DepositERC721(_token, _l2Token, msg.sender, _to, _tokenId);
     }
@@ -210,7 +210,7 @@ contract L1ERC721Gateway is OwnableUpgradeable, ERC721HolderUpgradeable, ScrollG
         );
 
         // 3. Send message to L1ScrollMessenger.
-        IL1ScrollMessenger(messenger).sendMessage{value: msg.value}(counterpart, 0, _message, _gasLimit);
+        IL1ScrollMessenger(messenger).sendMessage{value: msg.value}(counterpart, 0, _message, _gasLimit, msg.sender);
 
         emit BatchDepositERC721(_token, _l2Token, msg.sender, _to, _tokenIds);
     }

contracts/src/L1/gateways/L1ETHGateway.sol

@@ -113,7 +113,7 @@ contract L1ETHGateway is Initializable, ScrollGatewayBase, IL1ETHGateway {
             _data
         );
 
-        IL1ScrollMessenger(messenger).sendMessage{value: msg.value}(counterpart, _amount, _message, _gasLimit);
+        IL1ScrollMessenger(messenger).sendMessage{value: msg.value}(counterpart, _amount, _message, _gasLimit, _from);
 
         emit DepositETH(_from, _to, _amount, _data);
     }

contracts/src/L1/gateways/L1StandardERC20Gateway.sol

@@ -97,6 +97,14 @@ contract L1StandardERC20Gateway is Initializable, ScrollGatewayBase, L1ERC20Gate
         require(_l2Token != address(0), "token address cannot be 0");
         require(getL2ERC20Address(_l1Token) == _l2Token, "l2 token mismatch");
 
+        // update `tokenMapping` on first withdraw
+        address _storedL2Token = tokenMapping[_l1Token];
+        if (_storedL2Token == address(0)) {
+            tokenMapping[_l1Token] = _l2Token;
+        } else {
+            require(_storedL2Token == _l2Token, "l2 token mismatch");
+        }
+
         // @note can possible trigger reentrant call to messenger,
         // but it seems not a big problem.
         IERC20(_l1Token).safeTransfer(_to, _amount);
@@ -126,17 +134,20 @@ contract L1StandardERC20Gateway is Initializable, ScrollGatewayBase, L1ERC20Gate
 
         // 2. Generate message passed to L2StandardERC20Gateway.
         address _l2Token = tokenMapping[_token];
-        bytes memory _l2Data = _data;
+        bytes memory _l2Data;
         if (_l2Token == address(0)) {
-            // It is a new token, compute and store mapping in storage.
+            // @note we won't update `tokenMapping` here but update the `tokenMapping` on
+            // first successful withdraw. This will prevent user to set arbitrary token
+            // metadata by setting a very small `_gasLimit` on the first tx.
             _l2Token = getL2ERC20Address(_token);
-            tokenMapping[_token] = _l2Token;
 
             // passing symbol/name/decimal in order to deploy in L2.
             string memory _symbol = IERC20Metadata(_token).symbol();
             string memory _name = IERC20Metadata(_token).name();
             uint8 _decimals = IERC20Metadata(_token).decimals();
-            _l2Data = abi.encode(_data, abi.encode(_symbol, _name, _decimals));
+            _l2Data = abi.encode(true, abi.encode(_data, abi.encode(_symbol, _name, _decimals)));
+        } else {
+            _l2Data = abi.encode(false, _data);
         }
         bytes memory _message = abi.encodeWithSelector(
             IL2ERC20Gateway.finalizeDepositERC20.selector,
@@ -149,7 +160,7 @@ contract L1StandardERC20Gateway is Initializable, ScrollGatewayBase, L1ERC20Gate
         );
 
         // 3. Send message to L1ScrollMessenger.
-        IL1ScrollMessenger(messenger).sendMessage{value: msg.value}(counterpart, 0, _message, _gasLimit);
+        IL1ScrollMessenger(messenger).sendMessage{value: msg.value}(counterpart, 0, _message, _gasLimit, _from);
 
         emit DepositERC20(_token, _l2Token, _from, _to, _amount, _data);
     }

contracts/src/L1/gateways/L1WETHGateway.sol

@@ -131,7 +131,8 @@ contract L1WETHGateway is Initializable, ScrollGatewayBase, L1ERC20Gateway {
             counterpart,
             _amount,
             _message,
-            _gasLimit
+            _gasLimit,
+            _from
         );
 
         emit DepositERC20(_token, l2WETH, _from, _to, _amount, _data);

contracts/src/L2/gateways/L2StandardERC20Gateway.sol

@@ -77,7 +77,7 @@ contract L2StandardERC20Gateway is Initializable, ScrollGatewayBase, L2ERC20Gate
         address _from,
         address _to,
         uint256 _amount,
-        bytes calldata _data
+        bytes memory _data
     ) external payable override onlyCallByCounterpart nonReentrant {
         require(msg.value == 0, "nonzero msg.value");
         require(_l1Token != address(0), "token address cannot be 0");
@@ -91,12 +91,13 @@ contract L2StandardERC20Gateway is Initializable, ScrollGatewayBase, L2ERC20Gate
             require(_l2Token == _expectedL2Token, "l2 token mismatch");
         }
 
+        bool _hasMetadata;
+        (_hasMetadata, _data) = abi.decode(_data, (bool, bytes));
+
         bytes memory _deployData;
         bytes memory _callData;
 
-        if (tokenMapping[_l2Token] == address(0)) {
-            // first deposit, update mapping
-            tokenMapping[_l2Token] = _l1Token;
+        if (_hasMetadata) {
             (_callData, _deployData) = abi.decode(_data, (bytes, bytes));
         } else {
             require(tokenMapping[_l2Token] == _l1Token, "token mapping mismatch");
@@ -104,6 +105,9 @@ contract L2StandardERC20Gateway is Initializable, ScrollGatewayBase, L2ERC20Gate
         }
 
         if (!_l2Token.isContract()) {
+            // first deposit, update mapping
+            tokenMapping[_l2Token] = _l1Token;
+
             _deployL2Token(_deployData, _l1Token);
         }
 

contracts/src/test/L1ETHGateway.t.sol

@@ -133,6 +133,7 @@ contract L1ETHGatewayTest is L1GatewayTestBase {
         );
 
         // ETH transfer failed
+        revertOnReceive = true;
         hevm.expectRevert("ETH transfer failed");
         mockMessenger.callTarget{value: amount}(
             address(gateway),

contracts/src/test/L1GatewayTestBase.t.sol

@@ -55,6 +55,14 @@ abstract contract L1GatewayTestBase is DSTestPlus {
 
     L2ScrollMessenger internal l2Messenger;
 
+    bool internal revertOnReceive;
+
+    receive() external payable {
+        if (revertOnReceive) {
+            revert("RevertOnReceive");
+        }
+    }
+
     function setUpBase() internal {
         feeVault = address(uint160(address(this)) - 1);
 

contracts/src/test/L1StandardERC20Gateway.t.sol

@@ -412,7 +412,7 @@ contract L1StandardERC20GatewayTest is L1GatewayTestBase {
             address(this),
             address(this),
             amount,
-            abi.encode(new bytes(0), abi.encode(l1Token.symbol(), l1Token.name(), l1Token.decimals()))
+            abi.encode(true, abi.encode(new bytes(0), abi.encode(l1Token.symbol(), l1Token.name(), l1Token.decimals())))
         );
         bytes memory xDomainCalldata = abi.encodeWithSignature(
             "relayMessage(address,address,uint256,uint256,bytes)",
@@ -483,7 +483,7 @@ contract L1StandardERC20GatewayTest is L1GatewayTestBase {
             address(this),
             recipient,
             amount,
-            abi.encode(new bytes(0), abi.encode(l1Token.symbol(), l1Token.name(), l1Token.decimals()))
+            abi.encode(true, abi.encode(new bytes(0), abi.encode(l1Token.symbol(), l1Token.name(), l1Token.decimals())))
         );
         bytes memory xDomainCalldata = abi.encodeWithSignature(
             "relayMessage(address,address,uint256,uint256,bytes)",
@@ -555,7 +555,7 @@ contract L1StandardERC20GatewayTest is L1GatewayTestBase {
             address(this),
             recipient,
             amount,
-            abi.encode(dataToCall, abi.encode(l1Token.symbol(), l1Token.name(), l1Token.decimals()))
+            abi.encode(true, abi.encode(dataToCall, abi.encode(l1Token.symbol(), l1Token.name(), l1Token.decimals())))
         );
         bytes memory xDomainCalldata = abi.encodeWithSignature(
             "relayMessage(address,address,uint256,uint256,bytes)",

contracts/src/test/L2StandardERC20Gateway.t.sol

@@ -83,7 +83,7 @@ contract L2StandardERC20GatewayTest is L2GatewayTestBase {
                 address(this),
                 address(this),
                 type(uint128).max,
-                abi.encode("", abi.encode("symbol", "name", 18))
+                abi.encode(true, abi.encode("", abi.encode("symbol", "name", 18)))
             )
         );
         hevm.stopPrank();
@@ -285,7 +285,7 @@ contract L2StandardERC20GatewayTest is L2GatewayTestBase {
             sender,
             address(recipient),
             amount,
-            dataToCall
+            abi.encode(false, dataToCall)
         );
         bytes memory xDomainCalldata = abi.encodeWithSignature(
             "relayMessage(address,address,uint256,uint256,bytes)",

coordinator/go.mod

@@ -7,6 +7,7 @@ require (
 	github.com/orcaman/concurrent-map v1.0.0
 	github.com/patrickmn/go-cache v2.1.0+incompatible
 	github.com/scroll-tech/go-ethereum v1.10.14-0.20230613025759-f055f50f9d56
+	github.com/shopspring/decimal v1.3.1
 	github.com/stretchr/testify v1.8.2
 	github.com/urfave/cli/v2 v2.17.2-0.20221006022127-8f469abc00aa
 	golang.org/x/exp v0.0.0-20230206171751-46f607a40771

coordinator/go.sum

@@ -85,6 +85,8 @@ github.com/scroll-tech/zktrie v0.5.3 h1:jjzQchGU6XPL5s1C5bwwivSadefSRuYASE9OL7UK
 github.com/scroll-tech/zktrie v0.5.3/go.mod h1:XvNo7vAk8yxNyTjBDj5WIiFzYW4bx/gJ78+NK6Zn6Uk=
 github.com/shirou/gopsutil v3.21.11+incompatible h1:+1+c1VGhc88SSonWP6foOcLhvnKlUeu/erjjvaPEYiI=
 github.com/shirou/gopsutil v3.21.11+incompatible/go.mod h1:5b4v6he4MtMOwMlS0TUMTu2PcXUg8+E1lC7eC3UO/RA=
+github.com/shopspring/decimal v1.3.1 h1:2Usl1nmF/WZucqkFZhnfFYxxxu8LG21F6nPQBE5gKV8=
+github.com/shopspring/decimal v1.3.1/go.mod h1:DKyhrW/HYNuLGql+MJL6WCR6knT2jwCFRcu2hWCYk4o=
 github.com/smartystreets/assertions v0.0.0-20180927180507-b2de0cb4f26d/go.mod h1:OnSkiWE9lh6wB0YB77sQom3nweQdgAjqCqsofrRNTgc=
 github.com/smartystreets/assertions v1.13.1 h1:Ef7KhSmjZcK6AVf9YbJdvPYG9avaF0ZxudX+ThRdWfU=
 github.com/smartystreets/assertions v1.13.1/go.mod h1:cXr/IwVfSo/RbCSPhoAPv73p3hlSdrBH/b3SdnW/LMY=

coordinator/internal/orm/batch.go

@@ -33,12 +33,12 @@ type Batch struct {
 	BatchHeader     []byte `json:"batch_header" gorm:"column:batch_header"`
 
 	// proof
-	ChunkProofsStatus int16      `json:"chunk_proofs_status" gorm:"column:chunk_proofs_status"`
+	ChunkProofsStatus int16      `json:"chunk_proofs_status" gorm:"column:chunk_proofs_status;default:1"`
 	ProvingStatus     int16      `json:"proving_status" gorm:"column:proving_status;default:1"`
 	Proof             []byte     `json:"proof" gorm:"column:proof;default:NULL"`
 	ProverAssignedAt  *time.Time `json:"prover_assigned_at" gorm:"column:prover_assigned_at;default:NULL"`
 	ProvedAt          *time.Time `json:"proved_at" gorm:"column:proved_at;default:NULL"`
-	ProofTimeSec      int        `json:"proof_time_sec" gorm:"column:proof_time_sec;default:NULL"`
+	ProofTimeSec      int32      `json:"proof_time_sec" gorm:"column:proof_time_sec;default:NULL"`
 
 	// rollup
 	RollupStatus   int16      `json:"rollup_status" gorm:"column:rollup_status;default:1"`
@@ -48,7 +48,7 @@ type Batch struct {
 	FinalizedAt    *time.Time `json:"finalized_at" gorm:"column:finalized_at;default:NULL"`
 
 	// gas oracle
-	OracleStatus int16  `json:"oracle_status" gorm:"column:oracle_status;default:1"`
+	OracleStatus int16  `json:"oracle_status" gorm:"column:oracle_status;default:1;default:1"`
 	OracleTxHash string `json:"oracle_tx_hash" gorm:"column:oracle_tx_hash;default:NULL"`
 
 	// metadata

coordinator/internal/orm/chunk.go

@@ -34,15 +34,15 @@ type Chunk struct {
 	Proof            []byte     `json:"proof" gorm:"column:proof;default:NULL"`
 	ProverAssignedAt *time.Time `json:"prover_assigned_at" gorm:"column:prover_assigned_at;default:NULL"`
 	ProvedAt         *time.Time `json:"proved_at" gorm:"column:proved_at;default:NULL"`
-	ProofTimeSec     int        `json:"proof_time_sec" gorm:"column:proof_time_sec;default:NULL"`
+	ProofTimeSec     int32      `json:"proof_time_sec" gorm:"column:proof_time_sec;default:NULL"`
 
 	// batch
 	BatchHash string `json:"batch_hash" gorm:"column:batch_hash;default:NULL"`
 
 	// metadata
 	TotalL2TxGas              uint64         `json:"total_l2_tx_gas" gorm:"column:total_l2_tx_gas"`
-	TotalL2TxNum              uint64         `json:"total_l2_tx_num" gorm:"column:total_l2_tx_num"`
-	TotalL1CommitCalldataSize uint64         `json:"total_l1_commit_calldata_size" gorm:"column:total_l1_commit_calldata_size"`
+	TotalL2TxNum              uint32         `json:"total_l2_tx_num" gorm:"column:total_l2_tx_num"`
+	TotalL1CommitCalldataSize uint32         `json:"total_l1_commit_calldata_size" gorm:"column:total_l1_commit_calldata_size"`
 	TotalL1CommitGas          uint64         `json:"total_l1_commit_gas" gorm:"column:total_l1_commit_gas"`
 	CreatedAt                 time.Time      `json:"created_at" gorm:"column:created_at"`
 	UpdatedAt                 time.Time      `json:"updated_at" gorm:"column:updated_at"`
@@ -224,8 +224,8 @@ func (o *Chunk) InsertChunk(ctx context.Context, chunk *types.Chunk) (*Chunk, er
 		EndBlockNumber:               chunk.Blocks[numBlocks-1].Header.Number.Uint64(),
 		EndBlockHash:                 chunk.Blocks[numBlocks-1].Header.Hash().Hex(),
 		TotalL2TxGas:                 totalL2TxGas,
-		TotalL2TxNum:                 totalL2TxNum,
-		TotalL1CommitCalldataSize:    totalL1CommitCalldataSize,
+		TotalL2TxNum:                 uint32(totalL2TxNum),
+		TotalL1CommitCalldataSize:    uint32(totalL1CommitCalldataSize),
 		TotalL1CommitGas:             totalL1CommitGas,
 		StartBlockTime:               chunk.Blocks[0].Header.Time,
 		TotalL1MessagesPoppedBefore:  totalL1MessagePoppedBefore,

coordinator/internal/orm/l2_block.go

@@ -4,6 +4,7 @@ import (
 	"context"
 	"encoding/json"
 	"fmt"
+	"time"
 
 	"github.com/scroll-tech/go-ethereum/common"
 	gethTypes "github.com/scroll-tech/go-ethereum/core/types"
@@ -17,16 +18,24 @@ import (
 type L2Block struct {
 	db *gorm.DB `gorm:"column:-"`
 
+	// block
 	Number           uint64 `json:"number" gorm:"number"`
 	Hash             string `json:"hash" gorm:"hash"`
 	ParentHash       string `json:"parent_hash" gorm:"parent_hash"`
 	Header           string `json:"header" gorm:"header"`
 	Transactions     string `json:"transactions" gorm:"transactions"`
 	WithdrawTrieRoot string `json:"withdraw_trie_root" gorm:"withdraw_trie_root"`
-	TxNum            uint64 `json:"tx_num" gorm:"tx_num"`
+	TxNum            uint32 `json:"tx_num" gorm:"tx_num"`
 	GasUsed          uint64 `json:"gas_used" gorm:"gas_used"`
 	BlockTimestamp   uint64 `json:"block_timestamp" gorm:"block_timestamp"`
-	ChunkHash        string `json:"chunk_hash" gorm:"chunk_hash;default:NULL"`
+
+	// chunk
+	ChunkHash string `json:"chunk_hash" gorm:"chunk_hash;default:NULL"`
+
+	// metadata
+	CreatedAt time.Time      `json:"created_at" gorm:"column:created_at"`
+	UpdatedAt time.Time      `json:"updated_at" gorm:"column:updated_at"`
+	DeletedAt gorm.DeletedAt `json:"deleted_at" gorm:"column:deleted_at;default:NULL"`
 }
 
 // NewL2Block creates a new L2Block instance.
@@ -95,7 +104,7 @@ func (o *L2Block) InsertL2Blocks(ctx context.Context, blocks []*types.WrappedBlo
 			ParentHash:       block.Header.ParentHash.String(),
 			Transactions:     string(txs),
 			WithdrawTrieRoot: block.WithdrawTrieRoot.Hex(),
-			TxNum:            uint64(len(block.Transactions)),
+			TxNum:            uint32(len(block.Transactions)),
 			GasUsed:          block.Header.GasUsed,
 			BlockTimestamp:   block.Header.Time,
 			Header:           string(header),

coordinator/internal/orm/orm_test.go

@@ -2,8 +2,10 @@ package orm
 
 import (
 	"context"
+	"math/big"
 	"testing"
 
+	"github.com/shopspring/decimal"
 	"github.com/stretchr/testify/assert"
 	"gorm.io/gorm"
 
@@ -60,11 +62,15 @@ func TestProverTaskOrm(t *testing.T) {
 	assert.NoError(t, err)
 	assert.NoError(t, migrate.ResetDB(sqlDB))
 
+	reward := big.NewInt(0)
+	reward.SetString("18446744073709551616", 10) // 1 << 64, uint64 maximum 1<<64 -1
+
 	proverTask := ProverTask{
 		TaskID:          "test-hash",
 		ProverName:      "roller-0",
 		ProverPublicKey: "0",
 		ProvingStatus:   int16(types.RollerAssigned),
+		Reward:          decimal.NewFromBigInt(reward, 0),
 	}
 
 	err = proverTaskOrm.SetProverTask(context.Background(), &proverTask)
@@ -74,6 +80,11 @@ func TestProverTaskOrm(t *testing.T) {
 	assert.Equal(t, 1, len(proverTasks))
 	assert.Equal(t, proverTask.ProverName, proverTasks[0].ProverName)
 
+	// test decimal reward, get reward
+	resultReward := proverTasks[0].Reward.BigInt()
+	assert.Equal(t, resultReward, reward)
+	assert.Equal(t, resultReward.String(), "18446744073709551616")
+
 	proverTask.ProvingStatus = int16(types.RollerProofValid)
 	err = proverTaskOrm.SetProverTask(context.Background(), &proverTask)
 	assert.NoError(t, err)
@@ -82,3 +93,29 @@ func TestProverTaskOrm(t *testing.T) {
 	assert.Equal(t, 1, len(proverTasks))
 	assert.Equal(t, proverTask.ProvingStatus, proverTasks[0].ProvingStatus)
 }
+
+func TestProverTaskOrmUint256(t *testing.T) {
+	sqlDB, err := db.DB()
+	assert.NoError(t, err)
+	assert.NoError(t, migrate.ResetDB(sqlDB))
+
+	// test reward for uint256 maximum 1 << 256 -1 :115792089237316195423570985008687907853269984665640564039457584007913129639935
+	rewardUint256 := big.NewInt(0)
+	rewardUint256.SetString("115792089237316195423570985008687907853269984665640564039457584007913129639935", 10)
+	proverTask := ProverTask{
+		TaskID:          "test-hash",
+		ProverName:      "roller-0",
+		ProverPublicKey: "0",
+		ProvingStatus:   int16(types.RollerAssigned),
+		Reward:          decimal.NewFromBigInt(rewardUint256, 0),
+	}
+
+	err = proverTaskOrm.SetProverTask(context.Background(), &proverTask)
+	assert.NoError(t, err)
+	proverTasksUint256, err := proverTaskOrm.GetProverTasksByHashes(context.Background(), []string{"test-hash"})
+	assert.NoError(t, err)
+	assert.Equal(t, 1, len(proverTasksUint256))
+	resultRewardUint256 := proverTasksUint256[0].Reward.BigInt()
+	assert.Equal(t, resultRewardUint256, rewardUint256)
+	assert.Equal(t, resultRewardUint256.String(), "115792089237316195423570985008687907853269984665640564039457584007913129639935")
+}

coordinator/internal/orm/prover_task.go

@@ -5,6 +5,7 @@ import (
 	"fmt"
 	"time"
 
+	"github.com/shopspring/decimal"
 	"gorm.io/gorm"
 	"gorm.io/gorm/clause"
 
@@ -16,18 +17,26 @@ import (
 type ProverTask struct {
 	db *gorm.DB `gorm:"column:-"`
 
-	ID              int64          `json:"id" gorm:"column:id"`
-	TaskID          string         `json:"task_id" gorm:"column:task_id"`
-	ProverPublicKey string         `json:"prover_public_key" gorm:"column:prover_public_key"`
-	ProverName      string         `json:"prover_name" gorm:"column:prover_name"`
-	TaskType        int16          `json:"task_type" gorm:"column:task_type;default:0"`
-	ProvingStatus   int16          `json:"proving_status" gorm:"column:proving_status;default:0"`
-	FailureType     int16          `json:"failure_type" gorm:"column:failure_type;default:0"`
-	Reward          uint64         `json:"reward" gorm:"column:reward;default:0"`
-	Proof           []byte         `json:"proof" gorm:"column:proof;default:NULL"`
-	CreatedAt       time.Time      `json:"created_at" gorm:"column:created_at"`
-	UpdatedAt       time.Time      `json:"updated_at" gorm:"column:updated_at"`
-	DeletedAt       gorm.DeletedAt `json:"deleted_at" gorm:"column:deleted_at"`
+	ID int64 `json:"id" gorm:"column:id"`
+
+	// prover
+	ProverPublicKey string `json:"prover_public_key" gorm:"column:prover_public_key"`
+	ProverName      string `json:"prover_name" gorm:"column:prover_name"`
+
+	// task
+	TaskID   string `json:"task_id" gorm:"column:task_id"`
+	TaskType int16  `json:"task_type" gorm:"column:task_type;default:0"`
+
+	// status
+	ProvingStatus int16           `json:"proving_status" gorm:"column:proving_status;default:0"`
+	FailureType   int16           `json:"failure_type" gorm:"column:failure_type;default:0"`
+	Reward        decimal.Decimal `json:"reward" gorm:"column:reward;default:0;type:decimal(78)"`
+	Proof         []byte          `json:"proof" gorm:"column:proof;default:NULL"`
+
+	// metadata
+	CreatedAt time.Time      `json:"created_at" gorm:"column:created_at"`
+	UpdatedAt time.Time      `json:"updated_at" gorm:"column:updated_at"`
+	DeletedAt gorm.DeletedAt `json:"deleted_at" gorm:"column:deleted_at"`
 }
 
 // NewProverTask creates a new ProverTask instance.

coordinator/manager.go

@@ -672,6 +672,7 @@ func (m *Manager) StartChunkProofGenerationSession(task *orm.Chunk, prevSession
 			TaskType:        int16(message.ProofTypeChunk),
 			ProverName:      roller.Name,
 			ProvingStatus:   int16(types.RollerAssigned),
+			FailureType:     int16(types.RollerFailureTypeUndefined),
 			CreatedAt:       time.Now(), // Used in proverTasks, should be explicitly assigned here.
 		}
 		// Store prover task info.
@@ -771,6 +772,7 @@ func (m *Manager) StartBatchProofGenerationSession(task *orm.Batch, prevSession
 			TaskType:        int16(message.ProofTypeBatch),
 			ProverName:      roller.Name,
 			ProvingStatus:   int16(types.RollerAssigned),
+			FailureType:     int16(types.RollerFailureTypeUndefined),
 			CreatedAt:       time.Now(), // Used in proverTasks, should be explicitly assigned here.
 		}
 		// Store session info.

database/migrate/migrations/00001_l1_message.sql

@@ -2,19 +2,22 @@
 -- +goose StatementBegin
 create table l1_message
 (
-    queue_index  BIGINT  NOT NULL,
-    msg_hash     VARCHAR NOT NULL,
-    height       BIGINT  NOT NULL,
-    gas_limit    BIGINT  NOT NULL,
-    sender       VARCHAR NOT NULL,
-    target       VARCHAR NOT NULL,
-    value        VARCHAR NOT NULL,
-    calldata     TEXT    NOT NULL,
-    layer1_hash  VARCHAR NOT NULL,
-    layer2_hash  VARCHAR DEFAULT NULL,
-    status       INTEGER NOT NULL DEFAULT 1,
-    created_at TIMESTAMP(0) NOT NULL DEFAULT CURRENT_TIMESTAMP,
-    updated_at TIMESTAMP(0) NOT NULL DEFAULT CURRENT_TIMESTAMP
+    queue_index      BIGINT           NOT NULL,
+    msg_hash         VARCHAR          NOT NULL,
+    height           BIGINT           NOT NULL,
+    gas_limit        BIGINT           NOT NULL,
+    sender           VARCHAR          NOT NULL,
+    target           VARCHAR          NOT NULL,
+    value            VARCHAR          NOT NULL,
+    calldata         TEXT             NOT NULL,
+    layer1_hash      VARCHAR          NOT NULL,
+    layer2_hash      VARCHAR          DEFAULT NULL,
+    status           INTEGER          NOT NULL DEFAULT 1,
+
+-- metadata
+    created_at       TIMESTAMP(0)     NOT NULL DEFAULT CURRENT_TIMESTAMP,
+    updated_at       TIMESTAMP(0)     NOT NULL DEFAULT CURRENT_TIMESTAMP,
+    deleted_at       TIMESTAMP(0)     DEFAULT NULL
 );
 
 comment

database/migrate/migrations/00002_l1_block.sql

@@ -3,14 +3,23 @@
 
 create table l1_block
 (
+-- block
     number                  BIGINT          NOT NULL,
     hash                    VARCHAR         NOT NULL,
-    header_rlp              TEXT            NOT NULL,
     base_fee                BIGINT          NOT NULL,
-    block_status            INTEGER         DEFAULT 1,
+
+-- import
+    block_status            SMALLINT        NOT NULL DEFAULT 1,
     import_tx_hash          VARCHAR         DEFAULT NULL,
-    oracle_status           INTEGER         DEFAULT 1,
-    oracle_tx_hash          VARCHAR         DEFAULT NULL
+
+-- oracle
+    oracle_status           SMALLINT        NOT NULL DEFAULT 1,
+    oracle_tx_hash          VARCHAR         DEFAULT NULL,
+
+-- metadata
+    created_at              TIMESTAMP(0)    NOT NULL DEFAULT CURRENT_TIMESTAMP,
+    updated_at              TIMESTAMP(0)    NOT NULL DEFAULT CURRENT_TIMESTAMP,
+    deleted_at              TIMESTAMP(0)    DEFAULT NULL
 );
 
 comment

database/migrate/migrations/00003_l2_block.sql

@@ -3,6 +3,7 @@
 
 create table l2_block
 (
+-- block
     number                  BIGINT          NOT NULL,
     hash                    VARCHAR         NOT NULL,
     parent_hash             VARCHAR         NOT NULL,
@@ -12,7 +13,14 @@ create table l2_block
     tx_num                  INTEGER         NOT NULL,
     gas_used                BIGINT          NOT NULL,
     block_timestamp         NUMERIC         NOT NULL,
-    chunk_hash              VARCHAR         DEFAULT NULL
+
+-- chunk
+    chunk_hash              VARCHAR         DEFAULT NULL,
+
+-- metadata
+    created_at              TIMESTAMP(0)    NOT NULL DEFAULT CURRENT_TIMESTAMP,
+    updated_at              TIMESTAMP(0)    NOT NULL DEFAULT CURRENT_TIMESTAMP,
+    deleted_at              TIMESTAMP(0)    DEFAULT NULL
 );
 
 create unique index l2_block_hash_uindex

database/migrate/migrations/00004_chunk.sql

@@ -11,7 +11,7 @@ create table chunk
     end_block_number                  BIGINT          NOT NULL,
     end_block_hash                    VARCHAR         NOT NULL,
     total_l1_messages_popped_before   BIGINT          NOT NULL,
-    total_l1_messages_popped_in_chunk BIGINT          NOT NULL,
+    total_l1_messages_popped_in_chunk INTEGER         NOT NULL,
     start_block_time                  BIGINT          NOT NULL,
 
 -- proof
@@ -19,15 +19,15 @@ create table chunk
     proof                             BYTEA           DEFAULT NULL,
     prover_assigned_at                TIMESTAMP(0)    DEFAULT NULL,
     proved_at                         TIMESTAMP(0)    DEFAULT NULL,
-    proof_time_sec                    SMALLINT        DEFAULT NULL,
+    proof_time_sec                    INTEGER         DEFAULT NULL,
 
 -- batch
     batch_hash                        VARCHAR         DEFAULT NULL,
 
 -- metadata
     total_l2_tx_gas                   BIGINT          NOT NULL,
-    total_l2_tx_num                   BIGINT          NOT NULL,
-    total_l1_commit_calldata_size     BIGINT          NOT NULL,
+    total_l2_tx_num                   INTEGER         NOT NULL,
+    total_l1_commit_calldata_size     INTEGER         NOT NULL,
     total_l1_commit_gas               BIGINT          NOT NULL,
     created_at                        TIMESTAMP(0)    NOT NULL DEFAULT CURRENT_TIMESTAMP,
     updated_at                        TIMESTAMP(0)    NOT NULL DEFAULT CURRENT_TIMESTAMP,

database/migrate/migrations/00005_batch.sql

@@ -15,7 +15,7 @@ create table batch
     batch_header            BYTEA           NOT NULL,
 
 -- proof
-    chunk_proofs_status     SMALLINT        NOT NULL,
+    chunk_proofs_status     SMALLINT        NOT NULL DEFAULT 1,
     proving_status          SMALLINT        NOT NULL DEFAULT 1,
     proof                   BYTEA           DEFAULT NULL,
     prover_assigned_at      TIMESTAMP(0)    DEFAULT NULL,
@@ -45,6 +45,9 @@ on batch (index);
 create unique index batch_hash_uindex
 on batch (hash);
 
+comment
+on column batch.chunk_proofs_status is 'undefined, pending, ready';
+
 comment
 on column batch.proving_status is 'undefined, unassigned, skipped, assigned, proved, verified, failed';
 

database/migrate/migrations/00006_prover_task.sql

@@ -4,14 +4,22 @@
 create table prover_task
 (
     id                  BIGSERIAL      PRIMARY KEY,
-    task_id             VARCHAR        NOT NULL,
+
+-- prover
     prover_public_key   VARCHAR        NOT NULL,
     prover_name         VARCHAR        NOT NULL,
+
+-- task
+    task_id             VARCHAR        NOT NULL,
     task_type           SMALLINT       NOT NULL DEFAULT 0,
-    proving_status      SMALLINT       NOT NULL DEFAULT 0,
-    failure_type        SMALLINT       NOT NULL DEFAULT 0,
-    reward              BIGINT         NOT NULL DEFAULT 0,
-    proof               BYTEA          DEFAULT NULL,
+
+-- status
+    proving_status      SMALLINT        NOT NULL DEFAULT 0,
+    failure_type        SMALLINT        NOT NULL DEFAULT 0,
+    reward              DECIMAL(78, 0) NOT NULL DEFAULT 0,
+    proof               BYTEA           DEFAULT NULL,
+
+-- metadata
     created_at          TIMESTAMP(0)   NOT NULL DEFAULT CURRENT_TIMESTAMP,
     updated_at          TIMESTAMP(0)   NOT NULL DEFAULT CURRENT_TIMESTAMP,
     deleted_at          TIMESTAMP(0)   DEFAULT NULL,
@@ -20,7 +28,13 @@ create table prover_task
 );
 
 comment
-on column batch.proving_status is 'roller assigned, roller proof valid, roller proof invalid';
+on column prover_task.task_type is 'undefined, chunk, batch';
+
+comment
+on column prover_task.proving_status is 'undefined, roller assigned, roller proof valid, roller proof invalid';
+
+comment
+on column prover_task.failure_type is 'undefined';
 
 -- +goose StatementEnd