refactor(bridge-history): refactor API field naming and improve ERC721/ERC1155 batch-transfer support (#1072)

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

bridge-history-api/internal/controller/api/history_controller.go

@@ -35,7 +35,7 @@ func (c *HistoryController) GetL2UnclaimedWithdrawalsByAddress(ctx *gin.Context)
 		return
 	}
 
-	resultData := &types.ResultData{Result: pagedTxs, Total: total}
+	resultData := &types.ResultData{Results: pagedTxs, Total: total}
 	types.RenderSuccess(ctx, resultData)
 }
 
@@ -53,7 +53,7 @@ func (c *HistoryController) GetL2WithdrawalsByAddress(ctx *gin.Context) {
 		return
 	}
 
-	resultData := &types.ResultData{Result: pagedTxs, Total: total}
+	resultData := &types.ResultData{Results: pagedTxs, Total: total}
 	types.RenderSuccess(ctx, resultData)
 }
 
@@ -71,7 +71,7 @@ func (c *HistoryController) GetTxsByAddress(ctx *gin.Context) {
 		return
 	}
 
-	resultData := &types.ResultData{Result: pagedTxs, Total: total}
+	resultData := &types.ResultData{Results: pagedTxs, Total: total}
 	types.RenderSuccess(ctx, resultData)
 }
 
@@ -89,6 +89,6 @@ func (c *HistoryController) PostQueryTxsByHashes(ctx *gin.Context) {
 		return
 	}
 
-	resultData := &types.ResultData{Result: results, Total: uint64(len(results))}
+	resultData := &types.ResultData{Results: results, Total: uint64(len(results))}
 	types.RenderSuccess(ctx, resultData)
 }

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

@@ -16,6 +16,7 @@ import (
 
 	"scroll-tech/bridge-history-api/internal/orm"
 	"scroll-tech/bridge-history-api/internal/types"
+	"scroll-tech/bridge-history-api/internal/utils"
 )
 
 const (
@@ -261,40 +262,44 @@ func (h *HistoryLogic) GetTxsByHashes(ctx context.Context, txHashes []string) ([
 
 func getTxHistoryInfo(message *orm.CrossMessage) *types.TxHistoryInfo {
 	txHistory := &types.TxHistoryInfo{
-		MsgHash:        message.MessageHash,
-		Amount:         message.TokenAmounts,
-		L1Token:        message.L1TokenAddress,
-		L2Token:        message.L2TokenAddress,
-		IsL1:           orm.MessageType(message.MessageType) == orm.MessageTypeL1SentMessage,
-		TxStatus:       message.TxStatus,
+		MessageHash:    message.MessageHash,
+		TokenType:      orm.TokenType(message.TokenType),
+		TokenIDs:       utils.ConvertStringToStringArray(message.TokenIDs),
+		TokenAmounts:   utils.ConvertStringToStringArray(message.TokenAmounts),
+		L1TokenAddress: message.L1TokenAddress,
+		L2TokenAddress: message.L2TokenAddress,
+		MessageType:    orm.MessageType(message.MessageType),
+		TxStatus:       orm.TxStatusType(message.TxStatus),
 		BlockTimestamp: message.BlockTimestamp,
 	}
-	if txHistory.IsL1 {
+	if txHistory.MessageType == orm.MessageTypeL1SentMessage {
 		txHistory.Hash = message.L1TxHash
 		txHistory.ReplayTxHash = message.L1ReplayTxHash
 		txHistory.RefundTxHash = message.L1RefundTxHash
 		txHistory.BlockNumber = message.L1BlockNumber
-		txHistory.FinalizeTx = &types.Finalized{
+		txHistory.CounterpartChainTx = &types.CounterpartChainTx{
 			Hash:        message.L2TxHash,
 			BlockNumber: message.L2BlockNumber,
 		}
 	} else {
 		txHistory.Hash = message.L2TxHash
 		txHistory.BlockNumber = message.L2BlockNumber
-		txHistory.FinalizeTx = &types.Finalized{
+		txHistory.CounterpartChainTx = &types.CounterpartChainTx{
 			Hash:        message.L1TxHash,
 			BlockNumber: message.L1BlockNumber,
 		}
 		if orm.RollupStatusType(message.RollupStatus) == orm.RollupStatusTypeFinalized {
-			txHistory.ClaimInfo = &types.UserClaimInfo{
-				From:       message.MessageFrom,
-				To:         message.MessageTo,
-				Value:      message.MessageValue,
-				Nonce:      strconv.FormatUint(message.MessageNonce, 10),
-				Message:    message.MessageData,
-				Proof:      "0x" + common.Bytes2Hex(message.MerkleProof),
-				BatchIndex: strconv.FormatUint(message.BatchIndex, 10),
-				Claimable:  true,
+			txHistory.ClaimInfo = &types.ClaimInfo{
+				From:    message.MessageFrom,
+				To:      message.MessageTo,
+				Value:   message.MessageValue,
+				Nonce:   strconv.FormatUint(message.MessageNonce, 10),
+				Message: message.MessageData,
+				Proof: types.L2MessageProof{
+					BatchIndex:  strconv.FormatUint(message.BatchIndex, 10),
+					MerkleProof: "0x" + common.Bytes2Hex(message.MerkleProof),
+				},
+				Claimable: true,
 			}
 		}
 	}

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

@@ -4,6 +4,8 @@ import (
 	"net/http"
 
 	"github.com/gin-gonic/gin"
+
+	"scroll-tech/bridge-history-api/internal/orm"
 )
 
 const (
@@ -37,8 +39,8 @@ type QueryByHashRequest struct {
 
 // ResultData contains return txs and total
 type ResultData struct {
-	Result []*TxHistoryInfo `json:"result"`
-	Total  uint64           `json:"total"`
+	Results []*TxHistoryInfo `json:"results"`
+	Total   uint64           `json:"total"`
 }
 
 // Response the response schema
@@ -48,39 +50,46 @@ type Response struct {
 	Data    interface{} `json:"data"`
 }
 
-// Finalized the schema of tx finalized infos
-type Finalized struct {
+// CounterpartChainTx is the schema of counterpart chain tx info
+type CounterpartChainTx struct {
 	Hash        string `json:"hash"`
-	BlockNumber uint64 `json:"blockNumber"`
+	BlockNumber uint64 `json:"block_number"`
 }
 
-// UserClaimInfo the schema of tx claim infos
-type UserClaimInfo struct {
-	From       string `json:"from"`
-	To         string `json:"to"`
-	Value      string `json:"value"`
-	Nonce      string `json:"nonce"`
-	Message    string `json:"message"`
-	Proof      string `json:"proof"`
-	BatchIndex string `json:"batch_index"`
-	Claimable  bool   `json:"claimable"`
+// ClaimInfo is the schema of tx claim info
+type ClaimInfo struct {
+	From      string         `json:"from"`
+	To        string         `json:"to"`
+	Value     string         `json:"value"`
+	Nonce     string         `json:"nonce"`
+	Message   string         `json:"message"`
+	Proof     L2MessageProof `json:"proof"`
+	Claimable bool           `json:"claimable"`
+}
+
+// L2MessageProof is the schema of L2 message proof
+type L2MessageProof struct {
+	BatchIndex  string `json:"batch_index"`
+	MerkleProof string `json:"merkle_proof"`
 }
 
 // TxHistoryInfo the schema of tx history infos
 type TxHistoryInfo struct {
-	Hash           string         `json:"hash"`
-	ReplayTxHash   string         `json:"replayTxHash"`
-	RefundTxHash   string         `json:"refundTxHash"`
-	MsgHash        string         `json:"msgHash"`
-	Amount         string         `json:"amount"`
-	IsL1           bool           `json:"isL1"`
-	L1Token        string         `json:"l1Token"`
-	L2Token        string         `json:"l2Token"`
-	BlockNumber    uint64         `json:"blockNumber"`
-	TxStatus       int            `json:"txStatus"`
-	FinalizeTx     *Finalized     `json:"finalizeTx"`
-	ClaimInfo      *UserClaimInfo `json:"claimInfo"`
-	BlockTimestamp uint64         `json:"blockTimestamp"`
+	Hash               string              `json:"hash"`
+	ReplayTxHash       string              `json:"replay_tx_hash"`
+	RefundTxHash       string              `json:"refund_tx_hash"`
+	MessageHash        string              `json:"message_hash"`
+	TokenType          orm.TokenType       `json:"token_type"`    // 0: unknown, 1: eth, 2: erc20, 3: erc721, 4: erc1155
+	TokenIDs           []string            `json:"token_ids"`     // only for erc721 and erc1155
+	TokenAmounts       []string            `json:"token_amounts"` // for eth and erc20, the length is 1, for erc721 and erc1155, the length could be > 1
+	MessageType        orm.MessageType     `json:"message_type"`  // 0: unknown, 1: layer 1 message, 2: layer 2 message
+	L1TokenAddress     string              `json:"l1_token_address"`
+	L2TokenAddress     string              `json:"l2_token_address"`
+	BlockNumber        uint64              `json:"block_number"`
+	TxStatus           orm.TxStatusType    `json:"tx_status"` // 0: sent, 1: sent failed, 2: relayed, 3: failed relayed, 4: relayed reverted, 5: skipped, 6: dropped
+	CounterpartChainTx *CounterpartChainTx `json:"counterpart_chain_tx"`
+	ClaimInfo          *ClaimInfo          `json:"claim_info"`
+	BlockTimestamp     uint64              `json:"block_timestamp"`
 }
 
 // RenderJSON renders response with json

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

@@ -191,7 +191,19 @@ func ConvertBigIntArrayToString(array []*big.Int) string {
 	return result
 }
 
-// GetSkippedQueueIndices get the skipped queue indices
+// ConvertStringToStringArray takes a string with values separated by commas and returns a slice of strings
+func ConvertStringToStringArray(s string) []string {
+	if s == "" {
+		return []string{}
+	}
+	stringParts := strings.Split(s, ",")
+	for i, part := range stringParts {
+		stringParts[i] = strings.TrimSpace(part)
+	}
+	return stringParts
+}
+
+// GetSkippedQueueIndices gets the skipped queue indices
 func GetSkippedQueueIndices(startIndex uint64, skippedBitmap *big.Int) []uint64 {
 	var indices []uint64
 	for i := 0; i < 256; i++ {

bridge-history-api/internal/utils/utils_test.go

@@ -1,6 +1,7 @@
 package utils
 
 import (
+	"math/big"
 	"testing"
 
 	"github.com/scroll-tech/go-ethereum/common"
@@ -36,3 +37,55 @@ func TestGetBatchRangeFromCalldata(t *testing.T) {
 	assert.Equal(t, start, uint64(0))
 	assert.Equal(t, finish, uint64(0))
 }
+
+// TestConvertBigIntArrayToString tests the ConvertBigIntArrayToString function
+func TestConvertBigIntArrayToString(t *testing.T) {
+	tests := []struct {
+		array    []*big.Int
+		expected string
+	}{
+		{[]*big.Int{big.NewInt(1), big.NewInt(2), big.NewInt(3)}, "1, 2, 3"},
+		{[]*big.Int{big.NewInt(0), big.NewInt(-1)}, "0, -1"},
+		{[]*big.Int{}, ""},
+	}
+
+	for _, test := range tests {
+		got := ConvertBigIntArrayToString(test.array)
+		assert.Equal(t, test.expected, got)
+	}
+}
+
+// TestConvertStringToStringArray tests the ConvertStringToStringArray function
+func TestConvertStringToStringArray(t *testing.T) {
+	tests := []struct {
+		s        string
+		expected []string
+	}{
+		{"1, 2, 3", []string{"1", "2", "3"}},
+		{" 4 , 5 , 6 ", []string{"4", "5", "6"}},
+		{"", []string{}},
+	}
+
+	for _, test := range tests {
+		got := ConvertStringToStringArray(test.s)
+		assert.Equal(t, test.expected, got)
+	}
+}
+
+// TestGetSkippedQueueIndices tests the GetSkippedQueueIndices function
+func TestGetSkippedQueueIndices(t *testing.T) {
+	tests := []struct {
+		startIndex uint64
+		bitmap     *big.Int
+		expected   []uint64
+	}{
+		{0, big.NewInt(0b101), []uint64{0, 2}},
+		{10, big.NewInt(0b110), []uint64{11, 12}},
+		{0, big.NewInt(0), nil}, // No bits set
+	}
+
+	for _, test := range tests {
+		got := GetSkippedQueueIndices(test.startIndex, test.bitmap)
+		assert.Equal(t, test.expected, got)
+	}
+}

common/version/version.go

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