fix(bridge-history-api): Avoid cors issue in bridgehistoryapi-server (#583)

Co-authored-by: vincent <419436363@qq.com>

README.md

@@ -1,5 +1,7 @@
 # Scroll Monorepo
 
+[![codecov](https://codecov.io/gh/scroll-tech/scroll/branch/develop/graph/badge.svg?token=VJVHNQWGGW)](https://codecov.io/gh/scroll-tech/scroll)
+
 ## Prerequisites
 + Go 1.19
 + Rust (for version, see [rust-toolchain](./common/libzkp/impl/rust-toolchain))

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

@@ -5,6 +5,7 @@ import (
 	"os"
 
 	"github.com/ethereum/go-ethereum/log"
+	"github.com/iris-contrib/middleware/cors"
 	"github.com/kataras/iris/v12"
 	"github.com/kataras/iris/v12/mvc"
 	"github.com/urfave/cli/v2"
@@ -60,6 +61,11 @@ func init() {
 }
 
 func action(ctx *cli.Context) error {
+	corsOptions := cors.New(cors.Options{
+		AllowedOrigins:   []string{"*"},
+		AllowedMethods:   []string{"GET", "POST", "PUT", "DELETE"},
+		AllowCredentials: true,
+	})
 	// Load config file.
 	cfgFile := ctx.String(cutils.ConfigFileFlag.Name)
 	cfg, err := config.NewConfig(cfgFile)
@@ -72,6 +78,7 @@ func action(ctx *cli.Context) error {
 	}
 	defer database.Close()
 	bridgeApp := iris.New()
+	bridgeApp.UseRouter(corsOptions)
 	bridgeApp.Get("/ping", pong).Describe("healthcheck")
 
 	mvc.Configure(bridgeApp.Party("/api/txs"), setupQueryByAddressHandler)

bridge-history-api/go.mod

@@ -4,6 +4,7 @@ go 1.19
 
 require (
 	github.com/ethereum/go-ethereum v1.12.0
+	github.com/iris-contrib/middleware/cors v0.0.0-20230531125531-980d3a09a458
 	github.com/jmoiron/sqlx v1.3.5
 	github.com/kataras/iris/v12 v12.2.0
 	github.com/lib/pq v1.10.7

bridge-history-api/go.sum

@@ -242,6 +242,8 @@ github.com/iris-contrib/go.uuid v2.0.0+incompatible h1:XZubAYg61/JwnJNbZilGjf3b3
 github.com/iris-contrib/go.uuid v2.0.0+incompatible/go.mod h1:iz2lgM/1UnEf1kP0L/+fafWORmlnuysV2EMP8MW+qe0=
 github.com/iris-contrib/httpexpect/v2 v2.12.1 h1:3cTZSyBBen/kfjCtgNFoUKi1u0FVXNaAjyRJOo6AVS4=
 github.com/iris-contrib/jade v1.1.3/go.mod h1:H/geBymxJhShH5kecoiOCSssPX7QWYH7UaeZTSWddIk=
+github.com/iris-contrib/middleware/cors v0.0.0-20230531125531-980d3a09a458 h1:V60rHQJc6DieKV1BqHIGclraPdO4kinuFAZIrPGHN7s=
+github.com/iris-contrib/middleware/cors v0.0.0-20230531125531-980d3a09a458/go.mod h1:7eVziAp1yUwFB/ZMg71n84VWQH+7wukvxcHuF2e7cbg=
 github.com/iris-contrib/pongo2 v0.0.1/go.mod h1:Ssh+00+3GAZqSQb30AvBRNxBx7rf0GqwkjqxNd0u65g=
 github.com/iris-contrib/schema v0.0.1/go.mod h1:urYA3uvUNG1TIIjOSCzHr9/LmbQo8LrOcOqfqxa4hXw=
 github.com/iris-contrib/schema v0.0.6 h1:CPSBLyx2e91H2yJzPuhGuifVRnZBBJ3pCOMbOvPZaTw=

common/types/batch_header.go

@@ -2,6 +2,7 @@ package types
 
 import (
 	"encoding/binary"
+	"fmt"
 	"math/big"
 
 	"github.com/scroll-tech/go-ethereum/common"
@@ -17,48 +18,99 @@ type BatchHeader struct {
 	totalL1MessagePopped   uint64
 	dataHash               common.Hash
 	parentBatchHash        common.Hash
-	skippedL1MessageBitmap []*big.Int // LSB is the first L1 message
+	skippedL1MessageBitmap []byte
 }
 
 // NewBatchHeader creates a new BatchHeader
 func NewBatchHeader(version uint8, batchIndex, totalL1MessagePoppedBefore uint64, parentBatchHash common.Hash, chunks []*Chunk) (*BatchHeader, error) {
-	// TODO calculate `l1MessagePopped`, `totalL1MessagePopped`, and `skippedL1MessageBitmap` based on `chunks`
+	// buffer for storing chunk hashes in order to compute the batch data hash
 	var dataBytes []byte
-	totalL1MessagePoppedBeforeChunk := totalL1MessagePoppedBefore
+
+	// skipped L1 message bitmap, an array of 256-bit bitmaps
+	var skippedBitmap []*big.Int
+
+	// the first queue index that belongs to this batch
+	baseIndex := totalL1MessagePoppedBefore
+
+	// the next queue index that we need to process
+	nextIndex := totalL1MessagePoppedBefore
+
 	for _, chunk := range chunks {
-		// Build dataHash
+		// build data hash
+		totalL1MessagePoppedBeforeChunk := nextIndex
 		chunkBytes, err := chunk.Hash(totalL1MessagePoppedBeforeChunk)
 		if err != nil {
 			return nil, err
 		}
-		totalL1MessagePoppedBeforeChunk += chunk.NumL1Messages(totalL1MessagePoppedBeforeChunk)
-
 		dataBytes = append(dataBytes, chunkBytes...)
+
+		// build skip bitmap
+		for _, block := range chunk.Blocks {
+			for _, tx := range block.Transactions {
+				if tx.Type != 0x7E {
+					continue
+				}
+				currentIndex := tx.Nonce
+
+				if currentIndex < nextIndex {
+					return nil, fmt.Errorf("unexpected batch payload, expected queue index: %d, got: %d", nextIndex, currentIndex)
+				}
+
+				// mark skipped messages
+				for skippedIndex := nextIndex; skippedIndex < currentIndex; skippedIndex++ {
+					quo := int((skippedIndex - baseIndex) / 256)
+					rem := int((skippedIndex - baseIndex) % 256)
+					for len(skippedBitmap) <= quo {
+						bitmap := big.NewInt(0)
+						skippedBitmap = append(skippedBitmap, bitmap)
+					}
+					skippedBitmap[quo].SetBit(skippedBitmap[quo], rem, 1)
+				}
+
+				// process included message
+				quo := int((currentIndex - baseIndex) / 256)
+				for len(skippedBitmap) <= quo {
+					bitmap := big.NewInt(0)
+					skippedBitmap = append(skippedBitmap, bitmap)
+				}
+
+				nextIndex = currentIndex + 1
+			}
+		}
 	}
+
+	// compute data hash
 	dataHash := crypto.Keccak256Hash(dataBytes)
 
+	// compute skipped bitmap
+	bitmapBytes := make([]byte, len(skippedBitmap)*32)
+	for ii, num := range skippedBitmap {
+		bytes := num.Bytes()
+		padding := 32 - len(bytes)
+		copy(bitmapBytes[32*ii+padding:], bytes)
+	}
+
 	return &BatchHeader{
 		version:                version,
 		batchIndex:             batchIndex,
-		l1MessagePopped:        0,                          // TODO
-		totalL1MessagePopped:   totalL1MessagePoppedBefore, // TODO
+		l1MessagePopped:        nextIndex - totalL1MessagePoppedBefore,
+		totalL1MessagePopped:   nextIndex,
 		dataHash:               dataHash,
 		parentBatchHash:        parentBatchHash,
-		skippedL1MessageBitmap: nil, // TODO
+		skippedL1MessageBitmap: bitmapBytes,
 	}, nil
 }
 
 // Encode encodes the BatchHeader into RollupV2 BatchHeaderV0Codec Encoding.
 func (b *BatchHeader) Encode() []byte {
-	batchBytes := make([]byte, 89)
+	batchBytes := make([]byte, 89+len(b.skippedL1MessageBitmap))
 	batchBytes[0] = b.version
 	binary.BigEndian.PutUint64(batchBytes[1:], b.batchIndex)
 	binary.BigEndian.PutUint64(batchBytes[9:], b.l1MessagePopped)
 	binary.BigEndian.PutUint64(batchBytes[17:], b.totalL1MessagePopped)
 	copy(batchBytes[25:], b.dataHash[:])
 	copy(batchBytes[57:], b.parentBatchHash[:])
-	// TODO: encode skippedL1MessageBitmap
-
+	copy(batchBytes[89:], b.skippedL1MessageBitmap[:])
 	return batchBytes
 }
 

common/types/batch_header_test.go

@@ -10,6 +10,7 @@ import (
 )
 
 func TestNewBatchHeader(t *testing.T) {
+	// Without L1 Msg
 	templateBlockTrace, err := os.ReadFile("../testdata/blockTrace_02.json")
 	assert.NoError(t, err)
 
@@ -32,9 +33,100 @@ func TestNewBatchHeader(t *testing.T) {
 	batchHeader, err := NewBatchHeader(1, 1, 0, parentBatchHeader.Hash(), []*Chunk{chunk})
 	assert.NoError(t, err)
 	assert.NotNil(t, batchHeader)
+	assert.Equal(t, 0, len(batchHeader.skippedL1MessageBitmap))
+
+	// 1 L1 Msg in 1 bitmap
+	templateBlockTrace2, err := os.ReadFile("../testdata/blockTrace_04.json")
+	assert.NoError(t, err)
+
+	wrappedBlock2 := &WrappedBlock{}
+	assert.NoError(t, json.Unmarshal(templateBlockTrace2, wrappedBlock2))
+	chunk = &Chunk{
+		Blocks: []*WrappedBlock{
+			wrappedBlock2,
+		},
+	}
+	batchHeader, err = NewBatchHeader(1, 1, 0, parentBatchHeader.Hash(), []*Chunk{chunk})
+	assert.NoError(t, err)
+	assert.NotNil(t, batchHeader)
+	assert.Equal(t, 32, len(batchHeader.skippedL1MessageBitmap))
+	expectedBitmap := "00000000000000000000000000000000000000000000000000000000000003ff" // skip first 10
+	assert.Equal(t, expectedBitmap, common.Bytes2Hex(batchHeader.skippedL1MessageBitmap))
+
+	// many consecutive L1 Msgs in 1 bitmap, no leading skipped msgs
+	templateBlockTrace3, err := os.ReadFile("../testdata/blockTrace_05.json")
+	assert.NoError(t, err)
+
+	wrappedBlock3 := &WrappedBlock{}
+	assert.NoError(t, json.Unmarshal(templateBlockTrace3, wrappedBlock3))
+	chunk = &Chunk{
+		Blocks: []*WrappedBlock{
+			wrappedBlock3,
+		},
+	}
+	batchHeader, err = NewBatchHeader(1, 1, 37, parentBatchHeader.Hash(), []*Chunk{chunk})
+	assert.NoError(t, err)
+	assert.NotNil(t, batchHeader)
+	assert.Equal(t, uint64(5), batchHeader.l1MessagePopped)
+	assert.Equal(t, 32, len(batchHeader.skippedL1MessageBitmap))
+	expectedBitmap = "0000000000000000000000000000000000000000000000000000000000000000" // all bits are included, so none are skipped
+	assert.Equal(t, expectedBitmap, common.Bytes2Hex(batchHeader.skippedL1MessageBitmap))
+
+	// many consecutive L1 Msgs in 1 bitmap, with leading skipped msgs
+	chunk = &Chunk{
+		Blocks: []*WrappedBlock{
+			wrappedBlock3,
+		},
+	}
+	batchHeader, err = NewBatchHeader(1, 1, 0, parentBatchHeader.Hash(), []*Chunk{chunk})
+	assert.NoError(t, err)
+	assert.NotNil(t, batchHeader)
+	assert.Equal(t, uint64(42), batchHeader.l1MessagePopped)
+	assert.Equal(t, 32, len(batchHeader.skippedL1MessageBitmap))
+	expectedBitmap = "0000000000000000000000000000000000000000000000000000001fffffffff" // skipped the first 37 messages
+	assert.Equal(t, expectedBitmap, common.Bytes2Hex(batchHeader.skippedL1MessageBitmap))
+
+	// many sparse L1 Msgs in 1 bitmap
+	templateBlockTrace4, err := os.ReadFile("../testdata/blockTrace_06.json")
+	assert.NoError(t, err)
+
+	wrappedBlock4 := &WrappedBlock{}
+	assert.NoError(t, json.Unmarshal(templateBlockTrace4, wrappedBlock4))
+	chunk = &Chunk{
+		Blocks: []*WrappedBlock{
+			wrappedBlock4,
+		},
+	}
+	batchHeader, err = NewBatchHeader(1, 1, 0, parentBatchHeader.Hash(), []*Chunk{chunk})
+	assert.NoError(t, err)
+	assert.NotNil(t, batchHeader)
+	assert.Equal(t, uint64(10), batchHeader.l1MessagePopped)
+	assert.Equal(t, 32, len(batchHeader.skippedL1MessageBitmap))
+	expectedBitmap = "00000000000000000000000000000000000000000000000000000000000001dd" // 0111011101
+	assert.Equal(t, expectedBitmap, common.Bytes2Hex(batchHeader.skippedL1MessageBitmap))
+
+	// many L1 Msgs in each of 2 bitmaps
+	templateBlockTrace5, err := os.ReadFile("../testdata/blockTrace_07.json")
+	assert.NoError(t, err)
+
+	wrappedBlock5 := &WrappedBlock{}
+	assert.NoError(t, json.Unmarshal(templateBlockTrace5, wrappedBlock5))
+	chunk = &Chunk{
+		Blocks: []*WrappedBlock{
+			wrappedBlock5,
+		},
+	}
+	batchHeader, err = NewBatchHeader(1, 1, 0, parentBatchHeader.Hash(), []*Chunk{chunk})
+	assert.NoError(t, err)
+	assert.NotNil(t, batchHeader)
+	assert.Equal(t, uint64(257), batchHeader.l1MessagePopped)
+	assert.Equal(t, 64, len(batchHeader.skippedL1MessageBitmap))
+	expectedBitmap = "fffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffd0000000000000000000000000000000000000000000000000000000000000000"
+	assert.Equal(t, expectedBitmap, common.Bytes2Hex(batchHeader.skippedL1MessageBitmap))
 }
 
 func TestBatchHeaderEncode(t *testing.T) {
+	// Without L1 Msg
 	templateBlockTrace, err := os.ReadFile("../testdata/blockTrace_02.json")
 	assert.NoError(t, err)
 
@@ -60,9 +152,28 @@ func TestBatchHeaderEncode(t *testing.T) {
 	bytes := batchHeader.Encode()
 	assert.Equal(t, 89, len(bytes))
 	assert.Equal(t, "0100000000000000010000000000000000000000000000000010a64c9bd905f8caf5d668fbda622d6558c5a42cdb4b3895709743d159c22e534136709aabc8a23aa17fbcc833da2f7857d3c2884feec9aae73429c135f94985", common.Bytes2Hex(bytes))
+
+	// With L1 Msg
+	templateBlockTrace2, err := os.ReadFile("../testdata/blockTrace_04.json")
+	assert.NoError(t, err)
+
+	wrappedBlock2 := &WrappedBlock{}
+	assert.NoError(t, json.Unmarshal(templateBlockTrace2, wrappedBlock2))
+	chunk = &Chunk{
+		Blocks: []*WrappedBlock{
+			wrappedBlock2,
+		},
+	}
+	batchHeader, err = NewBatchHeader(1, 1, 0, parentBatchHeader.Hash(), []*Chunk{chunk})
+	assert.NoError(t, err)
+	assert.NotNil(t, batchHeader)
+	bytes = batchHeader.Encode()
+	assert.Equal(t, 121, len(bytes))
+	assert.Equal(t, "010000000000000001000000000000000b000000000000000b457a9e90e8e51ba2de2f66c6b589540b88cf594dac7fa7d04b99cdcfecf24e384136709aabc8a23aa17fbcc833da2f7857d3c2884feec9aae73429c135f9498500000000000000000000000000000000000000000000000000000000000003ff", common.Bytes2Hex(bytes))
 }
 
 func TestBatchHeaderHash(t *testing.T) {
+	// Without L1 Msg
 	templateBlockTrace, err := os.ReadFile("../testdata/blockTrace_02.json")
 	assert.NoError(t, err)
 
@@ -103,4 +214,21 @@ func TestBatchHeaderHash(t *testing.T) {
 	assert.NotNil(t, batchHeader2)
 	hash2 := batchHeader2.Hash()
 	assert.Equal(t, "34de600163aa745d4513113137a5b54960d13f0d3f2849e490c4b875028bf930", common.Bytes2Hex(hash2.Bytes()))
+
+	// With L1 Msg
+	templateBlockTrace3, err := os.ReadFile("../testdata/blockTrace_04.json")
+	assert.NoError(t, err)
+
+	wrappedBlock3 := &WrappedBlock{}
+	assert.NoError(t, json.Unmarshal(templateBlockTrace3, wrappedBlock3))
+	chunk = &Chunk{
+		Blocks: []*WrappedBlock{
+			wrappedBlock3,
+		},
+	}
+	batchHeader, err = NewBatchHeader(1, 1, 0, parentBatchHeader.Hash(), []*Chunk{chunk})
+	assert.NoError(t, err)
+	assert.NotNil(t, batchHeader)
+	hash = batchHeader.Hash()
+	assert.Equal(t, "0ec9547c6645d5f0c1254e121f49e93f54525cfda5bfb2236440fb3470f48902", common.Bytes2Hex(hash.Bytes()))
 }

common/version/version.go

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