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(),

common/version/version.go

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