feat: add codecv0 and codecv1

.github/pull_request_template.md

@@ -0,0 +1,26 @@
+### Purpose or design rationale of this PR
+
+*Describe your change. Make sure to answer these three questions: What does this PR do? Why does it do it? How does it do it?*
+
+
+### PR title
+
+Your PR title must follow [conventional commits](https://www.conventionalcommits.org/en/v1.0.0/#summary) (as we are doing squash merge for each PR), so it must start with one of the following [types](https://github.com/angular/angular/blob/22b96b9/CONTRIBUTING.md#type):
+
+- [ ] build: Changes that affect the build system or external dependencies (example scopes: yarn, eslint, typescript)
+- [ ] ci: Changes to our CI configuration files and scripts (example scopes: vercel, github, cypress)
+- [ ] docs: Documentation-only changes
+- [ ] feat: A new feature
+- [ ] fix: A bug fix
+- [ ] perf: A code change that improves performance
+- [ ] refactor: A code change that doesn't fix a bug, or add a feature, or improves performance
+- [ ] style: Changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons, etc)
+- [ ] test: Adding missing tests or correcting existing tests
+
+
+### Breaking change label
+
+Does this PR have the `breaking-change` label?
+
+- [ ] No, this PR is not a breaking change
+- [ ] Yes

.github/workflows/codec.yml

@@ -0,0 +1,68 @@
+name: ChainMonitor
+
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+    types:
+      - opened
+      - reopened
+      - synchronize
+      - ready_for_review
+
+jobs:
+  check:
+     if: github.event.pull_request.draft == false
+     runs-on: ubuntu-latest
+     steps:
+     - name: Install Go
+       uses: actions/setup-go@v2
+       with:
+         go-version: 1.20.x
+     - name: Checkout code
+       uses: actions/checkout@v2
+     - name: Lint
+       run: |
+         rm -rf $HOME/.cache/golangci-lint
+         make lint
+  goimports-lint:
+    if: github.event.pull_request.draft == false
+    runs-on: ubuntu-latest
+    steps:
+      - name: Install Go
+        uses: actions/setup-go@v2
+        with:
+          go-version: 1.20.x
+      - name: Checkout code
+        uses: actions/checkout@v2
+      - name: Install goimports
+        run: go install golang.org/x/tools/cmd/goimports@latest
+      - run: goimports -local github.com/scroll-tech/encoding/ -w .
+      - run: go mod tidy
+      # If there are any diffs from goimports or go mod tidy, fail.
+      - name: Verify no changes from goimports and go mod tidy
+        run: |
+          if [ -n "$(git status --porcelain)" ]; then
+            exit 1
+          fi
+  tests:
+    if: github.event.pull_request.draft == false
+    runs-on: ubuntu-latest
+    steps:
+    - name: Install Go
+      uses: actions/setup-go@v2
+      with:
+        go-version: 1.20.x
+    - name: Checkout code
+      uses: actions/checkout@v2
+    - name: Test codec packages
+      working-directory: '.'
+      run: |
+        make test
+    - name: Upload coverage reports to Codecov
+      uses: codecov/codecov-action@v3
+      env:
+        CODECOV_TOKEN: ${{ secrets.CHAIN_MONITOR_CODECOV_TOKEN }}
+      with:
+        flags: codec

.gitignore

@@ -19,3 +19,22 @@
 
 # Go workspace file
 go.work
+
+# Built binaries
+build/bin
+
+coverage.txt
+*.integration.txt
+
+# Visual Studio Code
+.vscode
+
+# IntelliJ
+.idea
+
+# MacOS
+.DS_Store
+
+# misc
+sftp-config.json
+*~

Makefile

@@ -0,0 +1,12 @@
+.PHONY: fmt lint test
+
+lint:
+	GOBIN=$(PWD)/build/bin go run ./build/lint.go
+
+fmt:
+	go mod tidy
+	goimports -w .
+	gofumpt -l -w .
+
+test:
+	go test -v -race -gcflags="-l" -ldflags="-s=false" -coverprofile=coverage.txt -covermode=atomic ./...

bitmap.go

@@ -0,0 +1,64 @@
+package encoding
+
+import (
+	"fmt"
+	"math/big"
+
+	"github.com/scroll-tech/go-ethereum/core/types"
+)
+
+// ConstructSkippedBitmap constructs skipped L1 message bitmap of the batch.
+func ConstructSkippedBitmap(batchIndex uint64, chunks []*Chunk, totalL1MessagePoppedBefore uint64) ([]byte, uint64, error) {
+	// 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 chunkID, chunk := range chunks {
+		for blockID, block := range chunk.Blocks {
+			for _, tx := range block.Transactions {
+				if tx.Type != types.L1MessageTxType {
+					continue
+				}
+				currentIndex := tx.Nonce
+
+				if currentIndex < nextIndex {
+					return nil, 0, fmt.Errorf("unexpected batch payload, expected queue index: %d, got: %d. Batch index: %d, chunk index in batch: %d, block index in chunk: %d, block hash: %v, transaction hash: %v", nextIndex, currentIndex, batchIndex, chunkID, blockID, block.Header.Hash(), tx.TxHash)
+				}
+
+				// 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
+			}
+		}
+	}
+
+	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 bitmapBytes, nextIndex, nil
+}