Haoyu/scroll-v5.7.11_broadcast

.gitattributes

@@ -1,3 +1,4 @@
 # Auto detect text files and perform LF normalization
 * text=auto
 *.sol linguist-language=Solidity
+*.go text eol=lf

.github/pull_request_template.md

@@ -0,0 +1,34 @@
+## 1. Purpose or design rationale of this PR
+
+...
+
+
+## 2. 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
+
+
+## 3. Deployment tag versioning
+
+Has the version in `params/version.go` been updated?
+
+- [ ] This PR doesn't involve a new deployment, git tag, docker image tag, and it doesn't affect traces
+- [ ] Yes
+
+
+## 4. Breaking change label
+
+Does this PR have the `breaking-change` label?
+
+- [ ] This PR is not a breaking change
+- [ ] Yes

.github/scripts/bump_version_dot_go.mjs

@@ -0,0 +1,35 @@
+import { URL } from "url";
+import { readFileSync, writeFileSync } from "fs";
+
+const versionFilePath = new URL(
+  "../../params/version.go",
+  import.meta.url
+).pathname;
+
+const versionFileContent = readFileSync(versionFilePath, { encoding: "utf-8" });
+
+const currentVersionPatch = versionFileContent.match(
+  /VersionPatch = (?<patch>\d+)/
+).groups.patch;
+
+try {
+  parseInt(currentVersionPatch);
+} catch (err) {
+  console.error(new Error("Failed to parse version in version.go file"));
+  throw err;
+}
+
+// prettier-ignore
+const newVersionPatch = `${parseInt(currentVersionPatch) + 1}`;
+
+console.log(
+  `Bump version from ${currentVersionPatch} to ${newVersionPatch}`
+);
+
+writeFileSync(
+  versionFilePath,
+  versionFileContent.replace(
+    `VersionPatch = ${currentVersionPatch}`,
+    `VersionPatch = ${newVersionPatch}`
+  )
+);

.github/workflows/bump_version.yml

@@ -0,0 +1,63 @@
+name: Bump version
+
+on:
+  pull_request:
+    branches: [ develop ]
+    types:
+      - opened
+      - reopened
+      - synchronize
+      - ready_for_review
+      - labeled
+
+jobs:
+  try-to-bump:
+    if: contains(github.event.pull_request.labels.*.name, 'bump-version')
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v3
+        with:
+          ref: ${{ github.head_ref }}
+      - name: check diff
+        id: check_diff
+        run: |
+          set -euo pipefail
+
+          # fetch develop branch so that we can diff against later
+          git fetch origin develop
+
+          echo 'checking verion changes in diff...'
+
+          # check if version changed in version.go
+          # note: the grep will fail if use \d instead of [0-9]
+          git diff HEAD..origin/develop --text --no-ext-diff --unified=0 --no-prefix params/version.go | grep -E '^\+\s*VersionPatch' && true
+
+          exit_code=$?
+
+          # auto bump if version is not bumped manually
+          echo '> require auto version bump?'
+
+          if [ $exit_code -eq 0 ]; then
+            echo '> no, already bumped'
+            echo "result=no-bump" >> "$GITHUB_OUTPUT"
+          else
+            echo '> yes'
+            echo "result=bump" >> "$GITHUB_OUTPUT"
+          fi
+      - name: Install Node.js 16
+        if: steps.check_diff.outputs.result == 'bump'
+        uses: actions/setup-node@v3
+        with:
+          node-version: 16
+      - name: bump version in params/version.go
+        if: steps.check_diff.outputs.result == 'bump'
+        run: node .github/scripts/bump_version_dot_go.mjs
+
+        # Commits made by this Action do not trigger new Workflow runs
+      - uses: stefanzweifel/git-auto-commit-action@3ea6ae190baf489ba007f7c92608f33ce20ef04a
+        if: steps.check_diff.outputs.result == 'bump'
+        with:
+          skip_fetch: true # already did fetch in check diff
+          file_pattern: "params/version.go"
+          commit_message: "chore: auto version bump [bot]"

.github/workflows/docker-arm64.yaml

@@ -0,0 +1,41 @@
+name: Docker-arm64
+
+on:
+  workflow_dispatch:
+    inputs:
+      tag:
+        description: "tag of this image (suffix -arm64 is added automatically)"
+        required: true
+        type: string
+
+jobs:
+  build-and-push-arm64-image:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        arch:
+          - aarch64
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v2
+      - name: Set up QEMU
+        run: |
+          docker run --rm --privileged multiarch/qemu-user-static --reset -p yes
+          docker buildx create --name multiarch --driver docker-container --use
+      - name: Set up Docker Buildx
+        id: buildx
+        uses: docker/setup-buildx-action@v2
+      - name: Login to Docker Hub
+        uses: docker/login-action@v2
+        with:
+          username: ${{ secrets.DOCKERHUB_USERNAME }}
+          password: ${{ secrets.DOCKERHUB_TOKEN }}
+      - name: Build docker image
+        uses: docker/build-push-action@v2
+        with:
+          platforms: linux/arm64
+          context: .
+          file: Dockerfile
+          push: true
+          tags: scrolltech/l2geth:${{inputs.tag}}-arm64

.github/workflows/docker.yaml

@@ -0,0 +1,45 @@
+name: Docker
+
+on:
+  push:
+    tags:
+      - '*'
+  release:
+    types: [published]
+
+jobs:
+  build-and-push:
+    runs-on: ubuntu-latest
+    steps:
+    - name: Checkout code
+      uses: actions/checkout@v2
+    - name: Set up QEMU
+      uses: docker/setup-qemu-action@v2
+    - name: Set up Docker Buildx
+      uses: docker/setup-buildx-action@v2
+    - name: Extract docker metadata
+      id: meta
+      uses: docker/metadata-action@v3
+      with:
+        images: scrolltech/l2geth
+        tags: |
+          type=ref,event=tag,enable=${{ github.event_name == 'push' }}
+          type=raw,value=latest,enable=${{ github.event_name == 'release' }}
+        flavor: |
+          latest=false
+    - name: Login to Docker Hub
+      uses: docker/login-action@v2
+      with:
+        username: ${{ secrets.DOCKERHUB_USERNAME }}
+        password: ${{ secrets.DOCKERHUB_TOKEN }}
+    - name: Build docker image
+      uses: docker/build-push-action@v2
+      with:
+        context: .
+        file: Dockerfile
+        # push: ${{ startsWith(github.ref, 'refs/tags/') }}
+        push: true
+        tags: ${{ steps.meta.outputs.tags }}
+        labels: ${{ steps.meta.outputs.labels }}
+        # cache-from: type=gha,scope=${{ github.workflow }}
+        # cache-to: type=gha,scope=${{ github.workflow }}

.github/workflows/l2geth_ci.yml

@@ -0,0 +1,114 @@
+on:
+  push:
+    branches: # we keep this to avoid triggering `push` & `pull_request` every time we update a PR
+      - main
+      - staging
+      - develop
+      - alpha
+  pull_request:
+    types:
+      - opened
+      - reopened
+      - synchronize
+      - ready_for_review
+name: CI
+jobs:
+  build-mock-ccc-geth: # build geth with mock circuit capacity checker
+    if: github.event.pull_request.draft == false
+    runs-on: ubuntu-latest
+    steps:
+    - name: Install Go
+      uses: actions/setup-go@v2
+      with:
+        go-version: 1.21.x
+    - name: Checkout code
+      uses: actions/checkout@v2
+    - name: Build
+      run: |
+        make nccc_geth
+  build-geth: # build geth with circuit capacity checker
+    if: github.event_name == 'push' # will only be triggered when pushing to main & staging & develop & alpha
+    runs-on: ubuntu-latest
+    steps:
+    - name: Install Go
+      uses: actions/setup-go@v2
+      with:
+        go-version: 1.21.x
+    - name: Install rust
+      uses: actions-rs/toolchain@v1
+      with:
+        toolchain: nightly-2022-12-10
+        override: true
+        components: rustfmt, clippy
+    - name: Checkout code
+      uses: actions/checkout@v2
+    - name: Build
+      run: |
+        make libzkp
+        sudo cp ./rollup/ccc/libzkp/libzkp.so /usr/local/lib/
+        make geth
+  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.21.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.18.x
+    - name: Install goimports
+      run: go install golang.org/x/tools/cmd/goimports@v0.24.0
+    - name: Checkout code
+      uses: actions/checkout@v2
+    - run: goimports -local github.com/scroll-tech/go-ethereum/ -w .
+    # If there are any diffs from goimports, fail.
+    - name: Verify no changes from goimports
+      run: |
+        if [ -n "$(git status --porcelain)" ]; then
+          exit 1
+        fi
+  go-mod-tidy-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.21.x
+    - name: Checkout code
+      uses: actions/checkout@v2
+    - run: go mod tidy
+    # If there are any diffs from go mod tidy, fail.
+    - name: Verify no changes from go mod tidy
+      run: |
+        if [ -n "$(git status --porcelain)" ]; then
+          exit 1
+        fi
+  test:
+    if: github.event.pull_request.draft == false
+    runs-on: ubuntu-latest
+    steps:
+    - name: Install Go
+      uses: actions/setup-go@v2
+      with:
+        go-version: 1.21.x
+    - name: Checkout code
+      uses: actions/checkout@v2
+    - name: Test
+      run: |
+        make test
+    - name: Upload coverage report
+      run: bash <(curl -s https://codecov.io/bash)

.github/workflows/semgrep.yml

@@ -0,0 +1,24 @@
+on:
+  workflow_dispatch: {}
+  pull_request: {}
+  push:
+    branches:
+    - main
+    - master
+    paths:
+    - .github/workflows/semgrep.yml
+  schedule:
+  # random HH:MM to avoid a load spike on GitHub Actions at 00:00
+  - cron: 20 19 * * *
+name: Semgrep
+jobs:
+  semgrep:
+    name: semgrep/ci
+    runs-on: ubuntu-20.04
+    env:
+      SEMGREP_APP_TOKEN: ${{ secrets.SEMGREP_APP_TOKEN }}
+    container:
+      image: returntocorp/semgrep
+    steps:
+    - uses: actions/checkout@v3
+    - run: semgrep ci

.gitmodules

@@ -2,3 +2,6 @@
 	path = tests/testdata
 	url = https://github.com/ethereum/tests
 	shallow = true
+[submodule "internal/utesting/blocktraces"]
+	path = internal/utesting/blocktraces
+	url = https://github.com/scroll-tech/test-traces.git