add back receipt checking

This reverts commit bda2219631.

.github/workflows/contracts.yml

@@ -0,0 +1,138 @@
+name: Contracts
+
+on:
+  push:
+    branches:
+      - main
+      - staging
+      - develop
+      - alpha
+    paths:
+      - 'contracts/**'
+      - '.github/workflows/contracts.yaml'
+  pull_request:
+    types:
+      - opened
+      - reopened
+      - synchronize
+      - ready_for_review
+    paths:
+      - 'contracts/**'
+      - '.github/workflows/contracts.yaml'
+
+defaults:
+  run:
+    working-directory: 'contracts'
+
+jobs:
+  foundry:
+    if: github.event.pull_request.draft == false
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout sources
+        uses: actions/checkout@v4
+        with:
+          submodules: recursive
+
+      - name: Install Foundry
+        uses: foundry-rs/foundry-toolchain@v1
+        with:
+          version: nightly
+
+      - name: Setup LCOV
+        uses: hrishikesh-kadam/setup-lcov@v1
+
+      - name: Install Node.js 18
+        uses: actions/setup-node@v2
+        with:
+          node-version: '18'
+
+      - name: Get yarn cache directory path
+        id: yarn-cache-dir-path
+        run: echo "::set-output name=dir::$(yarn cache dir)"
+
+      - name: Cache yarn dependencies
+        uses: actions/cache@v2
+        id: yarn-cache # use this to check for `cache-hit` (`steps.yarn-cache.outputs.cache-hit != 'true'`)
+        with:
+          path: ${{ steps.yarn-cache-dir-path.outputs.dir }}
+          key: ${{ runner.os }}-yarn-${{ hashFiles('contracts/yarn.lock') }}
+          restore-keys: |
+            ${{ runner.os }}-yarn-
+
+      - name: Cache node_modules
+        id: npm_cache
+        uses: actions/cache@v2
+        with:
+          path: node_modules
+          key: node_modules-${{ hashFiles('contracts/yarn.lock') }}
+
+      - name: yarn install
+        # if: steps.npm_cache.outputs.cache-hit != 'true'
+        run: yarn install
+
+      - name: Compile with foundry
+        run: forge build --evm-version cancun
+
+      - name: Run foundry tests
+        run: forge test --evm-version cancun -vvv
+
+      - name: Run foundry coverage
+        run : forge coverage --evm-version cancun --report lcov
+
+      - name : Prune coverage
+        run : lcov --rc branch_coverage=1 --remove ./lcov.info -o ./lcov.info.pruned 'src/mocks/*' 'src/test/*' 'scripts/*' 'node_modules/*' 'lib/*'
+
+      - name: Upload coverage reports to Codecov
+        uses: codecov/codecov-action@v3
+        env:
+          CODECOV_TOKEN: ${{ secrets.CODECOV_TOKEN }}
+        with:
+          files: contracts/lcov.info.pruned
+          flags: contracts
+
+  hardhat:
+    if: github.event.pull_request.draft == false
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout sources
+        uses: actions/checkout@v4
+        with:
+          submodules: recursive
+
+      - name: Install Node.js 18
+        uses: actions/setup-node@v2
+        with:
+          node-version: '18'
+
+      - name: Get yarn cache directory path
+        id: yarn-cache-dir-path
+        run: echo "::set-output name=dir::$(yarn cache dir)"
+
+      - name: Cache yarn dependencies
+        uses: actions/cache@v2
+        id: yarn-cache # use this to check for `cache-hit` (`steps.yarn-cache.outputs.cache-hit != 'true'`)
+        with:
+          path: ${{ steps.yarn-cache-dir-path.outputs.dir }}
+          key: ${{ runner.os }}-yarn-${{ hashFiles('contracts/yarn.lock') }}
+          restore-keys: |
+            ${{ runner.os }}-yarn-
+
+      - name: Cache node_modules
+        id: npm_cache
+        uses: actions/cache@v2
+        with:
+          path: node_modules
+          key: node_modules-${{ hashFiles('contracts/yarn.lock') }}
+
+      - name: yarn install
+        # if: steps.npm_cache.outputs.cache-hit != 'true'
+        run: yarn install
+
+      - name: Compile with hardhat
+        run: npx hardhat compile
+
+      - name: Run hardhat tests
+        run: npx hardhat test

.github/workflows/docker-coordinator-api-arm64.yml

@@ -1,41 +0,0 @@
-name: Docker-coordinator-api-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: ./build/dockerfiles/coordinator-api.Dockerfile
-          push: true
-          tags: scrolltech/coordinator-api:${{inputs.tag}}-arm64

.github/workflows/docker.yml

@@ -9,6 +9,51 @@ env:
   AWS_REGION: us-west-2
 
 jobs:
+  event_watcher:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+      - name: Set up QEMU
+        uses: docker/setup-qemu-action@v2
+      - name: Set up Docker 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: Configure AWS credentials
+        uses: aws-actions/configure-aws-credentials@v4
+        with:
+          aws-access-key-id: ${{ secrets.AWS_ACCESS_KEY_ID }}
+          aws-secret-access-key: ${{ secrets.AWS_SECRET_ACCESS_KEY }}
+          aws-region: ${{ env.AWS_REGION }}
+      - name: Login to Amazon ECR
+        id: login-ecr
+        uses: aws-actions/amazon-ecr-login@v2
+      - name: check repo and create it if not exist
+        env:
+          REPOSITORY: event-watcher
+        run: |
+          aws --region ${{ env.AWS_REGION }} ecr describe-repositories --repository-names ${{ env.REPOSITORY }} && : || aws --region ${{ env.AWS_REGION }} ecr create-repository --repository-name ${{ env.REPOSITORY }}
+      - name: Build and push
+        uses: docker/build-push-action@v3
+        env:
+          ECR_REGISTRY: ${{ steps.login-ecr.outputs.registry }}
+          REPOSITORY: event-watcher
+          IMAGE_TAG: ${{ github.ref_name }}
+        with:
+          context: .
+          file: ./build/dockerfiles/event_watcher.Dockerfile
+          platforms: linux/amd64
+          push: true
+          tags: |
+            ${{ secrets.DOCKERHUB_USERNAME }}/${{ env.REPOSITORY }}:${{ env.IMAGE_TAG }}
+            ${{ secrets.DOCKERHUB_USERNAME }}/${{ env.REPOSITORY }}:latest
+            ${{ env.ECR_REGISTRY }}/${{ env.REPOSITORY }}:${{ env.IMAGE_TAG }}
+            ${{ env.ECR_REGISTRY }}/${{ env.REPOSITORY }}:latest
+
   gas_oracle:
     runs-on: ubuntu-latest
     steps:
@@ -46,7 +91,7 @@ jobs:
         with:
           context: .
           file: ./build/dockerfiles/gas_oracle.Dockerfile
-          platforms: linux/amd64,linux/arm64
+          platforms: linux/amd64
           push: true
           tags: |
             ${{ secrets.DOCKERHUB_USERNAME }}/${{ env.REPOSITORY }}:${{ env.IMAGE_TAG }}
@@ -91,7 +136,7 @@ jobs:
         with:
           context: .
           file: ./build/dockerfiles/rollup_relayer.Dockerfile
-          platforms: linux/amd64,linux/arm64
+          platforms: linux/amd64
           push: true
           tags: |
             ${{ secrets.DOCKERHUB_USERNAME }}/${{ env.REPOSITORY }}:${{ env.IMAGE_TAG }}
@@ -234,51 +279,6 @@ jobs:
             ${{ env.ECR_REGISTRY }}/${{ env.REPOSITORY }}:${{ env.IMAGE_TAG }}
             ${{ env.ECR_REGISTRY }}/${{ env.REPOSITORY }}:latest
 
-  bridgehistoryapi-db-cli:
-    runs-on: ubuntu-latest
-    steps:
-      - name: Checkout code
-        uses: actions/checkout@v4
-      - name: Set up QEMU
-        uses: docker/setup-qemu-action@v2
-      - name: Set up Docker 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: Configure AWS credentials
-        uses: aws-actions/configure-aws-credentials@v4
-        with:
-          aws-access-key-id: ${{ secrets.AWS_ACCESS_KEY_ID }}
-          aws-secret-access-key: ${{ secrets.AWS_SECRET_ACCESS_KEY }}
-          aws-region: ${{ env.AWS_REGION }}
-      - name: Login to Amazon ECR
-        id: login-ecr
-        uses: aws-actions/amazon-ecr-login@v2
-      - name: check repo and create it if not exist
-        env:
-          REPOSITORY: bridgehistoryapi-db-cli
-        run: |
-          aws --region ${{ env.AWS_REGION }} ecr describe-repositories --repository-names ${{ env.REPOSITORY }} && : || aws --region ${{ env.AWS_REGION }} ecr create-repository --repository-name ${{ env.REPOSITORY }}
-      - name: Build and push
-        uses: docker/build-push-action@v3
-        env:
-          ECR_REGISTRY: ${{ steps.login-ecr.outputs.registry }}
-          REPOSITORY: bridgehistoryapi-db-cli
-          IMAGE_TAG: ${{ github.ref_name }}
-        with:
-          context: .
-          file: ./build/dockerfiles/bridgehistoryapi-db-cli.Dockerfile
-          platforms: linux/amd64,linux/arm64
-          push: true
-          tags: |
-            ${{ secrets.DOCKERHUB_USERNAME }}/${{ env.REPOSITORY }}:${{ env.IMAGE_TAG }}
-            ${{ secrets.DOCKERHUB_USERNAME }}/${{ env.REPOSITORY }}:latest
-            ${{ env.ECR_REGISTRY }}/${{ env.REPOSITORY }}:${{ env.IMAGE_TAG }}
-            ${{ env.ECR_REGISTRY }}/${{ env.REPOSITORY }}:latest
-
   coordinator-api:
     runs-on: ubuntu-latest
     steps:
@@ -316,6 +316,7 @@ jobs:
         with:
           context: .
           file: ./build/dockerfiles/coordinator-api.Dockerfile
+          platforms: linux/amd64
           push: true
           tags: |
             ${{ secrets.DOCKERHUB_USERNAME }}/${{ env.REPOSITORY }}:${{ env.IMAGE_TAG }}

.github/workflows/intermediate-docker.yml

@@ -4,65 +4,32 @@ on:
   workflow_dispatch:
     inputs:
       GO_VERSION:
-        description: "Go version"
+        description: 'Go version'
         required: true
-        type: choice
-        options:
-          - "1.20"
-          - "1.21"
-          - "1.22"
-          - "1.23"
-        default: "1.21"
+        type: string
+        default: '1.21'
       RUST_VERSION:
-        description: "Rust toolchain version"
+        description: 'Rust toolchain version'
         required: true
-        type: choice
-        options:
-          - nightly-2023-12-03
-          - nightly-2022-12-10
-        default: "nightly-2023-12-03"
+        type: string
+        default: 'nightly-2023-12-03'
       PYTHON_VERSION:
-        description: "Python version"
+        description: 'Python version'
         required: false
-        type: choice
-        options:
-          - "3.10"
-        default: "3.10"
+        type: string
+        default: '3.10'
       CUDA_VERSION:
-        description: "Cuda version"
+        description: 'Cuda version'
         required: false
-        type: choice
-        options:
-          - "11.7.1"
-          - "12.2.2"
-        default: "11.7.1"
-      CARGO_CHEF_TAG:
-        description: "Cargo chef version"
-        required: true
-        default: "0.1.41"
-        type: choice
-        options:
-          - 0.1.41
-      BASE_IMAGE:
-        description: "which intermediate image you want to update"
-        required: true
-        default: "go-alpine-builder"
-        type: choice
-        options:
-          - cuda-go-rust-builder
-          - go-rust-builder
-          - go-alpine-builder
-          - rust-builder
-          - rust-alpine-builder
-          - go-rust-alpine-builder
-          - py-runner
+        type: string
+        default: '11.7.1'
 
 defaults:
   run:
-    working-directory: "build/dockerfiles/intermediate"
+    working-directory: 'build/dockerfiles/intermediate'
 
 jobs:
-  build-and-publish-intermediate:
+  build-and-publish-cuda-go-rust-builder:
     runs-on: ubuntu-latest
     steps:
       - name: Checkout code
@@ -76,37 +43,177 @@ jobs:
         with:
           username: ${{ secrets.DOCKERHUB_USERNAME }}
           password: ${{ secrets.DOCKERHUB_TOKEN }}
-      - name: set tag env
-        run: |
-          if [ ${{github.event.inputs.BASE_IMAGE}} == "cuda-go-rust-builder" ]; then
-            echo "TAG=cuda-${{ github.event.inputs.CUDA_VERSION }}-go-${{ github.event.inputs.GO_VERSION }}-rust-${{ github.event.inputs.RUST_VERSION }}" >> $GITHUB_ENV
-          elif [ ${{github.event.inputs.BASE_IMAGE}} == "go-rust-builder" ]; then
-            echo "TAG=go-${{ github.event.inputs.GO_VERSION }}-rust-${{ github.event.inputs.RUST_VERSION }}" >> $GITHUB_ENV
-          elif [ ${{github.event.inputs.BASE_IMAGE}} == "go-alpine-builder" ]; then
-            echo "TAG=${{ github.event.inputs.GO_VERSION }}" >> $GITHUB_ENV
-          elif [ ${{github.event.inputs.BASE_IMAGE}} == "rust-builder" ]; then
-            echo "TAG=${{ github.event.inputs.RUST_VERSION }}" >> $GITHUB_ENV
-          elif [ ${{github.event.inputs.BASE_IMAGE}} == "rust-alpine-builder" ]; then
-            echo "TAG=${{ github.event.inputs.RUST_VERSION }}" >> $GITHUB_ENV
-          elif [ ${{github.event.inputs.BASE_IMAGE}} == "go-rust-alpine-builder" ]; then
-            echo "TAG=go-${{ github.event.inputs.GO_VERSION }}-rust-${{ github.event.inputs.RUST_VERSION }}" >> $GITHUB_ENV
-          elif [ ${{github.event.inputs.BASE_IMAGE}} == "py-runner" ]; then
-            echo "TAG=${{ github.event.inputs.PYTHON_VERSION }}" >> $GITHUB_ENV
-          else
-            echo "no BASE_IMAGE match"
-          fi
       - name: Build image
         id: build
         uses: docker/build-push-action@v5
         with:
           context: .
           push: true
-          file: build/dockerfiles/intermediate/${{ github.event.inputs.BASE_IMAGE }}.Dockerfile
-          platforms: linux/amd64,linux/arm64
-          tags: scrolltech/${{ github.event.inputs.BASE_IMAGE }}:${{ env.TAG }}
+          file: build/dockerfiles/intermediate/cuda-go-rust-builder.Dockerfile
+          tags: scrolltech/cuda-go-rust-builder:cuda-${{ github.event.inputs.CUDA_VERSION }}-go-${{ github.event.inputs.GO_VERSION }}-rust-${{ github.event.inputs.RUST_VERSION }}
           build-args: |
-            CUDA_VERSION=${{ github.event.inputs.CUDA_VERSION }}
-            GO_VERSION=${{ github.event.inputs.GO_VERSION }}
-            RUST_VERSION=${{ github.event.inputs.RUST_VERSION }}
-            PYTHON_VERSION=${{ github.event.inputs.PYTHON_VERSION }}
-            CARGO_CHEF_TAG=${{ github.event.inputs.CARGO_CHEF_TAG }}
+            CUDA_VERSION: ${{ github.event.inputs.CUDA_VERSION }}
+            GO_VERSION: ${{ github.event.inputs.GO_VERSION }}
+            RUST_VERSION: ${{ github.event.inputs.RUST_VERSION }}
+
+  build-and-publish-go-rust-builder:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+      - name: Set up QEMU
+        uses: docker/setup-qemu-action@v2
+      - name: Set up Docker 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 image
+        id: build
+        uses: docker/build-push-action@v5
+        with:
+          context: .
+          push: true
+          file: build/dockerfiles/intermediate/go-rust-builder.Dockerfile
+          platforms: linux/amd64,linux/arm64
+          tags: scrolltech/go-rust-builder:go-${{ github.event.inputs.GO_VERSION }}-rust-${{ github.event.inputs.RUST_VERSION }}
+          build-args: |
+            GO_VERSION: ${{ github.event.inputs.GO_VERSION }}
+            RUST_VERSION: ${{ github.event.inputs.RUST_VERSION }}
+
+  build-and-publish-go-alpine-builder:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+      - name: Set up QEMU
+        uses: docker/setup-qemu-action@v2
+      - name: Set up Docker 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 image
+        id: build
+        uses: docker/build-push-action@v5
+        with:
+          context: .
+          push: true
+          file: build/dockerfiles/intermediate/go-alpine-builder.Dockerfile
+          platforms: linux/amd64,linux/arm64
+          tags: scrolltech/go-alpine-builder:${{ github.event.inputs.GO_VERSION }}
+          build-args: |
+            GO_VERSION: ${{ github.event.inputs.GO_VERSION }}
+            RUST_VERSION: ${{ github.event.inputs.RUST_VERSION }}
+
+  build-and-publish-rust-builder:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+      - name: Set up QEMU
+        uses: docker/setup-qemu-action@v2
+      - name: Set up Docker 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 image
+        id: build
+        uses: docker/build-push-action@v5
+        with:
+          context: .
+          push: true
+          file: build/dockerfiles/intermediate/rust-builder.Dockerfile
+          platforms: linux/amd64,linux/arm64
+          tags: scrolltech/rust-builder:${{ github.event.inputs.RUST_VERSION }}
+          build-args: |
+            RUST_VERSION: ${{ github.event.inputs.RUST_VERSION }}
+
+  build-and-publish-rust-alpine-builder:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+      - name: Set up QEMU
+        uses: docker/setup-qemu-action@v2
+      - name: Set up Docker 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 image
+        id: build
+        uses: docker/build-push-action@v5
+        with:
+          context: .
+          push: true
+          file: build/dockerfiles/intermediate/rust-alpine-builder.Dockerfile
+          platforms: linux/amd64,linux/arm64
+          tags: scrolltech/rust-alpine-builder:${{ github.event.inputs.RUST_VERSION }}
+          build-args: |
+            RUST_VERSION: ${{ github.event.inputs.RUST_VERSION }}
+
+  build-and-publish-go-rust-alpine-builder:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+      - name: Set up QEMU
+        uses: docker/setup-qemu-action@v2
+      - name: Set up Docker 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 image
+        id: build
+        uses: docker/build-push-action@v5
+        with:
+          context: .
+          push: true
+          file: build/dockerfiles/intermediate/go-rust-alpine-builder.Dockerfile
+          platforms: linux/amd64,linux/arm64
+          tags: scrolltech/go-rust-alpine-builder:go-${{ github.event.inputs.GO_VERSION }}-rust-${{ github.event.inputs.RUST_VERSION }}
+          build-args: |
+            GO_VERSION: ${{ github.event.inputs.GO_VERSION }}
+            RUST_VERSION: ${{ github.event.inputs.RUST_VERSION }}
+
+  build-and-publish-py-runner:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+      - name: Set up QEMU
+        uses: docker/setup-qemu-action@v2
+      - name: Set up Docker 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 image
+        id: build
+        uses: docker/build-push-action@v5
+        with:
+          context: .
+          push: true
+          file: build/dockerfiles/intermediate/py-runner.Dockerfile
+          platforms: linux/amd64,linux/arm64
+          tags: scrolltech/py-runner:${{ github.event.inputs.PYTHON_VERSION }}
+          build-args: |
+            CUDA_VERSION: ${{ github.event.inputs.CUDA_VERSION }}
+            GO_VERSION: ${{ github.event.inputs.GO_VERSION }}
+            RUST_VERSION: ${{ github.event.inputs.RUST_VERSION }}
+

.github/workflows/prover.yml

@@ -25,75 +25,78 @@ defaults:
     working-directory: 'prover'
 
 jobs:
-  skip_check:
+  test:
+    if: github.event.pull_request.draft == false
     runs-on: ubuntu-latest
-    outputs:
-      should_skip: ${{ steps.skip_check.outputs.should_skip }}
     steps:
-      - id: skip_check
-        uses: fkirc/skip-duplicate-actions@v5
-        with:
-          cancel_others: 'true'
-          concurrent_skipping: 'same_content_newer'
-          paths_ignore: '["**/README.md"]'
-
-  fmt:
-    needs: [skip_check]
-    if: |
-      github.event.pull_request.draft == false &&
-      (github.event.action == 'ready_for_review' || needs.skip_check.outputs.should_skip != 'true')
-    runs-on: ubuntu-latest
-    timeout-minutes: 5
-    steps:
-      - uses: actions/checkout@v4
-      - uses: dtolnay/rust-toolchain@master
-        with:
-          toolchain: nightly-2023-12-03
-          components: rustfmt
-      - name: Cargo cache
-        uses: Swatinem/rust-cache@v2
-        with:
-          workspaces: "prover -> target"
-      - name: Cargo check
-        run: cargo check --all-features
-      - name: Cargo fmt
-        run: cargo fmt --all -- --check
-  
-  clippy:
-    needs: [skip_check, fmt]
-    if: |
-      github.event.pull_request.draft == false &&
-      (github.event.action == 'ready_for_review' || needs.skip_check.outputs.should_skip != 'true')
-    runs-on: ubuntu-latest
-    timeout-minutes: 30
-    steps:
-      - uses: actions/checkout@v4
-      - uses: dtolnay/rust-toolchain@master
-        with:
-          toolchain: nightly-2023-12-03
-          components: clippy
-      - name: Cargo cache
-        uses: Swatinem/rust-cache@v2
-        with:
-          workspaces: "prover -> target"
-      - name: Run clippy
-        run: cargo clippy --all-features --all-targets -- -D warnings
-
+    - name: Install Go
+      uses: actions/setup-go@v2
+      with:
+        go-version: 1.21.x
+    - name: Checkout code
+      uses: actions/checkout@v4
+    - name: Test
+      run: |
+        go test -tags="mock_prover" -v -coverprofile=coverage.txt ./...
+    - name: Upload coverage reports to Codecov
+      uses: codecov/codecov-action@v3
+      env:
+        CODECOV_TOKEN: ${{ secrets.CODECOV_TOKEN }}
+      with:
+        flags: prover
   compile:
-    needs: [skip_check, clippy]
-    if: |
-      github.event.pull_request.draft == false &&
-      (github.event.action == 'ready_for_review' || needs.skip_check.outputs.should_skip != 'true')
+    if: github.event_name == 'push' # will only be triggered when pushing to main & staging & develop & alpha
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v4
-      - uses: dtolnay/rust-toolchain@master
-        with:
-          toolchain: nightly-2023-12-03
-      - name: Cache cargo
-        uses: Swatinem/rust-cache@v2
-        with:
-          workspaces: "prover -> target"
-      - name: Test
-        run: |
-          make prover
+    - uses: actions-rs/toolchain@v1
+      with:
+        toolchain: nightly-2023-12-03
+        override: true
+        components: rustfmt, clippy
+    - name: Install Go
+      uses: actions/setup-go@v2
+      with:
+        go-version: 1.21.x
+    - name: Checkout code
+      uses: actions/checkout@v4
+    - name: Cache cargo
+      uses: Swatinem/rust-cache@v2
+      with:
+        workspaces: "common/libzkp/impl -> target"
+    - name: Test
+      run: |
+        make prover
+  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@v4
+    - 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.21.x
+    - name: Checkout code
+      uses: actions/checkout@v4
+    - name: Install goimports
+      run: go install golang.org/x/tools/cmd/goimports
+    - run: goimports -local scroll-tech/prover/ -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

.github/workflows/rollup.yml

@@ -105,7 +105,7 @@ jobs:
     - name: Test rollup packages
       working-directory: 'rollup'
       run: |
-        make test
+        ./run_test.sh
     - name: Upload coverage reports to Codecov
       uses: codecov/codecov-action@v3
       env:

.gitignore

@@ -4,8 +4,6 @@ assets/seed
 
 # Built binaries
 build/bin
-verifier.test
-core.test
 
 coverage.txt
 *.integration.txt
@@ -22,5 +20,3 @@ coverage.txt
 # misc
 sftp-config.json
 *~
-
-target

.gitmodules

@@ -1,3 +1,12 @@
-[submodule "scroll-contracts"]
-	path = scroll-contracts
-	url = https://github.com/scroll-tech/scroll-contracts.git
+[submodule "l2geth"]
+	path = l2geth
+	url = git@github.com:scroll-tech/go-ethereum.git
+[submodule "contracts/lib/ds-test"]
+	path = contracts/lib/ds-test
+	url = https://github.com/dapphub/ds-test
+[submodule "contracts/lib/forge-std"]
+	path = contracts/lib/forge-std
+	url = https://github.com/foundry-rs/forge-std
+[submodule "contracts/lib/solmate"]
+	path = contracts/lib/solmate
+	url = https://github.com/rari-capital/solmate

Makefile

@@ -1,33 +1,36 @@
 .PHONY: fmt dev_docker build_test_docker run_test_docker clean update
 
-L2GETH_TAG=scroll-v5.6.3
+L2GETH_TAG=scroll-v5.3.0
 
 help: ## Display this help message
 	@grep -h \
 		-E '^[a-zA-Z_-]+:.*?## .*$$' $(MAKEFILE_LIST) | \
 		awk 'BEGIN {FS = ":.*?## "}; {printf "\033[36m%-30s\033[0m %s\n", $$1, $$2}'
-update: ## Update dependencies
+update:
 	go work sync
 	cd $(PWD)/bridge-history-api/ && go get -u github.com/scroll-tech/go-ethereum@${L2GETH_TAG} && go mod tidy
 	cd $(PWD)/common/ && go get -u github.com/scroll-tech/go-ethereum@${L2GETH_TAG}&& go mod tidy
 	cd $(PWD)/coordinator/ && go get -u github.com/scroll-tech/go-ethereum@${L2GETH_TAG} && go mod tidy
 	cd $(PWD)/database/ && go get -u github.com/scroll-tech/go-ethereum@${L2GETH_TAG} && go mod tidy
+	cd $(PWD)/prover/ && go get -u github.com/scroll-tech/go-ethereum@${L2GETH_TAG}&& go mod tidy
 	cd $(PWD)/rollup/ && go get -u github.com/scroll-tech/go-ethereum@${L2GETH_TAG} && go mod tidy
 	cd $(PWD)/tests/integration-test/ && go get -u github.com/scroll-tech/go-ethereum@${L2GETH_TAG} && go mod tidy
 
-lint: ## The code's format and security checks
+lint: ## The code's format and security checks.
 	make -C rollup lint
 	make -C common lint
 	make -C coordinator lint
 	make -C database lint
+	make -C prover lint
 	make -C bridge-history-api lint
 
-fmt: ## Format the code
+fmt: ## format the code
 	go work sync
 	cd $(PWD)/bridge-history-api/ && go mod tidy
 	cd $(PWD)/common/ && go mod tidy
 	cd $(PWD)/coordinator/ && go mod tidy
 	cd $(PWD)/database/ && go mod tidy
+	cd $(PWD)/prover/ && go mod tidy
 	cd $(PWD)/rollup/ && go mod tidy
 	cd $(PWD)/tests/integration-test/ && go mod tidy
 
@@ -35,13 +38,14 @@ fmt: ## Format the code
 	goimports -local $(PWD)/common/ -w .
 	goimports -local $(PWD)/coordinator/ -w .
 	goimports -local $(PWD)/database/ -w .
+	goimports -local $(PWD)/prover/ -w .
 	goimports -local $(PWD)/rollup/ -w .
 	goimports -local $(PWD)/tests/integration-test/ -w .
 
-dev_docker: ## Build docker images for development/testing usages
+dev_docker: ## build docker images for development/testing usages
 	docker pull postgres
-	docker build -t scroll_l1geth --platform linux/amd64 ./common/testcontainers/docker/l1geth/
-	docker build -t scroll_l2geth --platform linux/amd64 ./common/testcontainers/docker/l2geth/
+	docker build -t scroll_l1geth ./common/testcontainers/docker/l1geth/
+	docker build -t scroll_l2geth ./common/testcontainers/docker/l2geth/
 
 clean: ## Empty out the bin folder
 	@rm -rf build/bin

README.md

@@ -1,6 +1,7 @@
 # Scroll Monorepo
 
 [![rollup](https://github.com/scroll-tech/scroll/actions/workflows/rollup.yml/badge.svg)](https://github.com/scroll-tech/scroll/actions/workflows/rollup.yml)
+[![contracts](https://github.com/scroll-tech/scroll/actions/workflows/contracts.yml/badge.svg)](https://github.com/scroll-tech/scroll/actions/workflows/contracts.yml)
 [![bridge-history](https://github.com/scroll-tech/scroll/actions/workflows/bridge_history_api.yml/badge.svg)](https://github.com/scroll-tech/scroll/actions/workflows/bridge_history_api.yml)
 [![coordinator](https://github.com/scroll-tech/scroll/actions/workflows/coordinator.yml/badge.svg)](https://github.com/scroll-tech/scroll/actions/workflows/coordinator.yml)
 [![prover](https://github.com/scroll-tech/scroll/actions/workflows/prover.yml/badge.svg)](https://github.com/scroll-tech/scroll/actions/workflows/prover.yml)
@@ -16,9 +17,10 @@
 ├── <a href="./common/">common</a>: Common libraries and types
 ├── <a href="./coordinator/">coordinator</a>: Prover coordinator service that dispatches proving tasks to provers
 ├── <a href="./database">database</a>: Database client and schema definition
+├── <a href="./src">l2geth</a>: Scroll execution node
 ├── <a href="./prover">prover</a>: Prover client that runs proof generation for zkEVM circuit and aggregation circuit
 ├── <a href="./rollup">rollup</a>: Rollup-related services
-├── <a href="https://github.com/scroll-tech/scroll-contracts.git">scroll-contracts</a>: solidity code for Scroll L1 bridge and rollup contracts and L2 bridge and pre-deployed contracts.
+├── <a href="./rpc-gateway">rpc-gateway</a>: RPC gateway external repo
 └── <a href="./tests">tests</a>: Integration tests
 </pre>
 
@@ -44,12 +46,30 @@ make dev_docker
 Run the tests using the following commands:
 
 ```bash
+export LIBSCROLL_ZSTD_VERSION=v0.0.0-rc0-ubuntu20.04
+export SCROLL_LIB_PATH=/scroll/lib
+
+sudo mkdir -p $SCROLL_LIB_PATH
+
+sudo wget -O $SCROLL_LIB_PATH/libzktrie.so https://github.com/scroll-tech/da-codec/releases/download/$LIBSCROLL_ZSTD_VERSION/libzktrie.so
+sudo wget -O $SCROLL_LIB_PATH/libscroll_zstd.so https://github.com/scroll-tech/da-codec/releases/download/$LIBSCROLL_ZSTD_VERSION/libscroll_zstd.so
+
+export LD_LIBRARY_PATH=$LD_LIBRARY_PATH:$SCROLL_LIB_PATH
+export CGO_LDFLAGS="-L$SCROLL_LIB_PATH -Wl,-rpath,$SCROLL_LIB_PATH"
+
 go test -v -race -covermode=atomic scroll-tech/rollup/...
+
 go test -tags="mock_verifier" -v -race -covermode=atomic scroll-tech/coordinator/...
 go test -v -race -covermode=atomic scroll-tech/database/...
 go test -v -race -covermode=atomic scroll-tech/common/...
 ```
 
+## Testing Contracts
+
+You can find the unit tests in [`contracts/src/test/`](/contracts/src/test/), and integration tests in [`contracts/integration-test/`](/contracts/integration-test/).
+
+See [`contracts`](/contracts) for more details on the contracts.
+
 ## License
 
 Scroll Monorepo is licensed under the [MIT](./LICENSE) license.

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

@@ -96,7 +96,7 @@ func action(ctx *cli.Context) error {
 	return nil
 }
 
-// Run bridge-history-backend api cmd instance.
+// Run event watcher cmd instance.
 func Run() {
 	if err := app.Run(os.Args); err != nil {
 		_, _ = fmt.Fprintln(os.Stderr, err)

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

@@ -84,7 +84,7 @@ func action(ctx *cli.Context) error {
 	return nil
 }
 
-// Run bridge-history-backend fetcher cmd instance.
+// Run event watcher cmd instance.
 func Run() {
 	if err := app.Run(os.Args); err != nil {
 		_, _ = fmt.Fprintln(os.Stderr, err)

bridge-history-api/conf/config.json

@@ -19,9 +19,7 @@
 		"ScrollChainAddr": "0xa13BAF47339d63B743e7Da8741db5456DAc1E556",
 		"GatewayRouterAddr": "0xF8B1378579659D8F7EE5f3C929c2f3E332E41Fd6",
 		"MessageQueueAddr": "0x0d7E906BD9cAFa154b048cFa766Cc1E54E39AF9B",
-		"BatchBridgeGatewayAddr": "0x5Bcfd99c34cf7E06fc756f6f5aE7400504852bc4",
-		"GasTokenGatewayAddr": "0x0000000000000000000000000000000000000000",
-		"WrappedTokenGatewayAddr": "0x0000000000000000000000000000000000000000"
+		"BatchBridgeGatewayAddr": "0x0000000000000000000000000000000000000000"
 	},
 	"L2": {
 		"confirmation": 0,
@@ -41,7 +39,7 @@
 		"PufferGatewayAddr": "0x9eBf2f33526CD571f8b2ad312492cb650870CFd6",
 		"GatewayRouterAddr": "0x4C0926FF5252A435FD19e10ED15e5a249Ba19d79",
 		"MessageQueueAddr": "0x5300000000000000000000000000000000000000",
-		"BatchBridgeGatewayAddr": "0xa1a12158bE6269D7580C63eC5E609Cdc0ddD82bC"
+		"BatchBridgeGatewayAddr": "0x0000000000000000000000000000000000000000"
 	},
 	"db": {
 		"dsn": "postgres://postgres:123456@localhost:5444/test?sslmode=disable",

bridge-history-api/go.mod

@@ -8,10 +8,10 @@ require (
 	github.com/go-redis/redis/v8 v8.11.5
 	github.com/pressly/goose/v3 v3.16.0
 	github.com/prometheus/client_golang v1.19.0
-	github.com/scroll-tech/go-ethereum v1.10.14-0.20240626125436-418bc6f728b6
+	github.com/scroll-tech/go-ethereum v1.10.14-0.20240426041101-a860446ebaea
 	github.com/stretchr/testify v1.9.0
 	github.com/urfave/cli/v2 v2.25.7
-	golang.org/x/sync v0.7.0
+	golang.org/x/sync v0.6.0
 	gorm.io/gorm v1.25.7-0.20240204074919-46816ad31dde
 )
 
@@ -19,7 +19,7 @@ require (
 	dario.cat/mergo v1.0.0 // indirect
 	github.com/VictoriaMetrics/fastcache v1.12.1 // indirect
 	github.com/beorn7/perks v1.0.1 // indirect
-	github.com/bits-and-blooms/bitset v1.13.0 // indirect
+	github.com/bits-and-blooms/bitset v1.12.0 // indirect
 	github.com/btcsuite/btcd v0.20.1-beta // indirect
 	github.com/bytedance/sonic v1.10.1 // indirect
 	github.com/cespare/xxhash/v2 v2.2.0 // indirect
@@ -36,7 +36,7 @@ require (
 	github.com/docker/docker v26.1.0+incompatible // indirect
 	github.com/docker/go-connections v0.5.0 // indirect
 	github.com/edsrzf/mmap-go v1.0.0 // indirect
-	github.com/ethereum/c-kzg-4844 v1.0.2 // indirect
+	github.com/ethereum/c-kzg-4844/bindings/go v0.0.0-20230126171313-363c7d7593b4 // indirect
 	github.com/fjl/memsize v0.0.2 // indirect
 	github.com/fsnotify/fsnotify v1.6.0 // indirect
 	github.com/gabriel-vasile/mimetype v1.4.2 // indirect
@@ -57,7 +57,7 @@ require (
 	github.com/holiman/bloomfilter/v2 v2.0.3 // indirect
 	github.com/holiman/uint256 v1.2.4 // indirect
 	github.com/huin/goupnp v1.3.0 // indirect
-	github.com/iden3/go-iden3-crypto v0.0.16 // indirect
+	github.com/iden3/go-iden3-crypto v0.0.15 // indirect
 	github.com/jackc/pgx/v5 v5.5.4 // indirect
 	github.com/jackpal/go-nat-pmp v1.0.2 // indirect
 	github.com/jinzhu/inflection v1.0.0 // indirect
@@ -65,6 +65,7 @@ require (
 	github.com/json-iterator/go v1.1.12 // indirect
 	github.com/klauspost/compress v1.17.4 // indirect
 	github.com/klauspost/cpuid/v2 v2.2.5 // indirect
+	github.com/kr/text v0.2.0 // indirect
 	github.com/leodido/go-urn v1.2.4 // indirect
 	github.com/mattn/go-colorable v0.1.13 // indirect
 	github.com/mattn/go-isatty v0.0.20 // indirect
@@ -89,28 +90,29 @@ require (
 	github.com/rjeczalik/notify v0.9.1 // indirect
 	github.com/rs/cors v1.7.0 // indirect
 	github.com/russross/blackfriday/v2 v2.1.0 // indirect
-	github.com/scroll-tech/da-codec v0.0.0-20240730031611-1b736159d5cb // indirect
-	github.com/scroll-tech/zktrie v0.8.4 // indirect
+	github.com/scroll-tech/zktrie v0.8.2 // indirect
 	github.com/sethvargo/go-retry v0.2.4 // indirect
 	github.com/shirou/gopsutil v3.21.11+incompatible // indirect
 	github.com/status-im/keycard-go v0.2.0 // indirect
-	github.com/supranational/blst v0.3.12 // indirect
+	github.com/supranational/blst v0.3.11 // indirect
 	github.com/syndtr/goleveldb v1.0.1-0.20210819022825-2ae1ddf74ef7 // indirect
-	github.com/tklauser/go-sysconf v0.3.14 // indirect
-	github.com/tklauser/numcpus v0.8.0 // indirect
+	github.com/tklauser/go-sysconf v0.3.12 // indirect
+	github.com/tklauser/numcpus v0.6.1 // indirect
 	github.com/twitchyliquid64/golang-asm v0.15.1 // indirect
 	github.com/tyler-smith/go-bip39 v1.1.0 // indirect
 	github.com/ugorji/go/codec v1.2.11 // indirect
 	github.com/xrash/smetrics v0.0.0-20201216005158-039620a65673 // indirect
-	github.com/yusufpapurcu/wmi v1.2.4 // indirect
+	github.com/yusufpapurcu/wmi v1.2.3 // indirect
 	go.opentelemetry.io/otel/trace v1.24.0 // indirect
 	go.uber.org/multierr v1.11.0 // indirect
 	golang.org/x/arch v0.5.0 // indirect
-	golang.org/x/crypto v0.24.0 // indirect
-	golang.org/x/net v0.25.0 // indirect
-	golang.org/x/sys v0.21.0 // indirect
-	golang.org/x/text v0.16.0 // indirect
+	golang.org/x/crypto v0.19.0 // indirect
+	golang.org/x/mod v0.16.0 // indirect
+	golang.org/x/net v0.20.0 // indirect
+	golang.org/x/sys v0.17.0 // indirect
+	golang.org/x/text v0.14.0 // indirect
 	golang.org/x/time v0.3.0 // indirect
+	golang.org/x/tools v0.17.0 // indirect
 	google.golang.org/genproto/googleapis/rpc v0.0.0-20231127180814-3a041ad873d4 // indirect
 	google.golang.org/protobuf v1.33.0 // indirect
 	gopkg.in/natefinch/npipe.v2 v2.0.0-20160621034901-c1b8fa8bdcce // indirect

bridge-history-api/go.sum

@@ -23,8 +23,8 @@ github.com/andybalholm/brotli v1.0.6/go.mod h1:fO7iG3H7G2nSZ7m0zPUDn85XEX2GTukHG
 github.com/beorn7/perks v0.0.0-20180321164747-3a771d992973/go.mod h1:Dwedo/Wpr24TaqPxmxbtue+5NUziq4I4S80YR8gNf3Q=
 github.com/beorn7/perks v1.0.1 h1:VlbKKnNfV8bJzeqoa4cOKqO6bYr3WgKZxO8Z16+hsOM=
 github.com/beorn7/perks v1.0.1/go.mod h1:G2ZrVWU2WbWT9wwq4/hrbKbnv/1ERSJQ0ibhJ6rlkpw=
-github.com/bits-and-blooms/bitset v1.13.0 h1:bAQ9OPNFYbGHV6Nez0tmNI0RiEu7/hxlYJRUA0wFAVE=
-github.com/bits-and-blooms/bitset v1.13.0/go.mod h1:7hO7Gc7Pp1vODcmWvKMRA9BNmbv6a/7QIWpPxHddWR8=
+github.com/bits-and-blooms/bitset v1.12.0 h1:U/q1fAF7xXRhFCrhROzIfffYnu+dlS38vCZtmFVPHmA=
+github.com/bits-and-blooms/bitset v1.12.0/go.mod h1:7hO7Gc7Pp1vODcmWvKMRA9BNmbv6a/7QIWpPxHddWR8=
 github.com/btcsuite/btcd v0.20.1-beta h1:Ik4hyJqN8Jfyv3S4AGBOmyouMsYE3EdYODkMbQjwPGw=
 github.com/btcsuite/btcd v0.20.1-beta/go.mod h1:wVuoA8VJLEcwgqHBwHmzLRazpKxTv13Px/pDuV7OomQ=
 github.com/btcsuite/btclog v0.0.0-20170628155309-84c8d2346e9f/go.mod h1:TdznJufoqS23FtqVCzL0ZqgP5MqXbb4fg/WgDys70nA=
@@ -61,6 +61,7 @@ github.com/cpuguy83/go-md2man/v2 v2.0.3 h1:qMCsGGgs+MAzDFyp9LpAe1Lqy/fY/qCovCm0q
 github.com/cpuguy83/go-md2man/v2 v2.0.3/go.mod h1:tgQtvFlXSQOSOSIRvRPT7W67SCa46tRHOmNcaadrF8o=
 github.com/crate-crypto/go-kzg-4844 v1.0.0 h1:TsSgHwrkTKecKJ4kadtHi4b3xHW5dCFUDFnUp1TsawI=
 github.com/crate-crypto/go-kzg-4844 v1.0.0/go.mod h1:1kMhvPgI0Ky3yIa+9lFySEBUBXkYxeOi8ZF1sYioxhc=
+github.com/creack/pty v1.1.9/go.mod h1:oKZEueFk5CKHvIhNR5MUki03XCEU+Q6VDXinZuGJ33E=
 github.com/davecgh/go-spew v0.0.0-20171005155431-ecdeabc65495/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=
 github.com/davecgh/go-spew v1.1.0/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=
 github.com/davecgh/go-spew v1.1.1 h1:vj9j/u1bqnvCEfJOwUhtlOARqs3+rkHYY13jYWTU97c=
@@ -86,8 +87,8 @@ github.com/elastic/go-sysinfo v1.11.1 h1:g9mwl05njS4r69TisC+vwHWTSKywZFYYUu3so3T
 github.com/elastic/go-sysinfo v1.11.1/go.mod h1:6KQb31j0QeWBDF88jIdWSxE8cwoOB9tO4Y4osN7Q70E=
 github.com/elastic/go-windows v1.0.1 h1:AlYZOldA+UJ0/2nBuqWdo90GFCgG9xuyw9SYzGUtJm0=
 github.com/elastic/go-windows v1.0.1/go.mod h1:FoVvqWSun28vaDQPbj2Elfc0JahhPB7WQEGa3c814Ss=
-github.com/ethereum/c-kzg-4844 v1.0.2 h1:8tV84BCEiPeOkiVgW9mpYBeBUir2bkCNVqxPwwVeO+s=
-github.com/ethereum/c-kzg-4844 v1.0.2/go.mod h1:VewdlzQmpT5QSrVhbBuGoCdFJkpaJlO1aQputP83wc0=
+github.com/ethereum/c-kzg-4844/bindings/go v0.0.0-20230126171313-363c7d7593b4 h1:B2mpK+MNqgPqk2/KNi1LbqwtZDy5F7iy0mynQiBr8VA=
+github.com/ethereum/c-kzg-4844/bindings/go v0.0.0-20230126171313-363c7d7593b4/go.mod h1:y4GA2JbAUama1S4QwYjC2hefgGLU8Ul0GMtL/ADMF1c=
 github.com/fjl/memsize v0.0.2 h1:27txuSD9or+NZlnOWdKUxeBzTAUkWCVh+4Gf2dWFOzA=
 github.com/fjl/memsize v0.0.2/go.mod h1:VvhXpOYNQvB+uIk2RvXzuaQtkQJzzIx6lSBe1xv7hi0=
 github.com/fsnotify/fsnotify v1.4.7/go.mod h1:jwhsz4b93w/PPRr/qN1Yymfu8t87LnFCMoQvtojpjFo=
@@ -175,8 +176,8 @@ github.com/holiman/uint256 v1.2.4/go.mod h1:EOMSn4q6Nyt9P6efbI3bueV4e1b3dGlUCXei
 github.com/hpcloud/tail v1.0.0/go.mod h1:ab1qPbhIpdTxEkNHXyeSf5vhxWSCs/tWer42PpOxQnU=
 github.com/huin/goupnp v1.3.0 h1:UvLUlWDNpoUdYzb2TCn+MuTWtcjXKSza2n6CBdQ0xXc=
 github.com/huin/goupnp v1.3.0/go.mod h1:gnGPsThkYa7bFi/KWmEysQRf48l2dvR5bxr2OFckNX8=
-github.com/iden3/go-iden3-crypto v0.0.16 h1:zN867xiz6HgErXVIV/6WyteGcOukE9gybYTorBMEdsk=
-github.com/iden3/go-iden3-crypto v0.0.16/go.mod h1:dLpM4vEPJ3nDHzhWFXDjzkn1qHoBeOT/3UEhXsEsP3E=
+github.com/iden3/go-iden3-crypto v0.0.15 h1:4MJYlrot1l31Fzlo2sF56u7EVFeHHJkxGXXZCtESgK4=
+github.com/iden3/go-iden3-crypto v0.0.15/go.mod h1:dLpM4vEPJ3nDHzhWFXDjzkn1qHoBeOT/3UEhXsEsP3E=
 github.com/jackc/pgpassfile v1.0.0 h1:/6Hmqy13Ss2zCq62VdNG8tM1wchn8zjSGOBJ6icpsIM=
 github.com/jackc/pgpassfile v1.0.0/go.mod h1:CEx0iS5ambNFdcRtxPj5JhEz+xB6uRky5eyVu/W2HEg=
 github.com/jackc/pgservicefile v0.0.0-20221227161230-091c0ba34f0a h1:bbPeKD0xmW/Y25WS6cokEszi5g+S0QxI/d45PkRi7Nk=
@@ -308,12 +309,10 @@ github.com/rs/cors v1.7.0 h1:+88SsELBHx5r+hZ8TCkggzSstaWNbDvThkVK8H6f9ik=
 github.com/rs/cors v1.7.0/go.mod h1:gFx+x8UowdsKA9AchylcLynDq+nNFfI8FkUZdN/jGCU=
 github.com/russross/blackfriday/v2 v2.1.0 h1:JIOH55/0cWyOuilr9/qlrm0BSXldqnqwMsf35Ld67mk=
 github.com/russross/blackfriday/v2 v2.1.0/go.mod h1:+Rmxgy9KzJVeS9/2gXHxylqXiyQDYRxCVz55jmeOWTM=
-github.com/scroll-tech/da-codec v0.0.0-20240730031611-1b736159d5cb h1:uOKdmDT0LsuS3gfynEjR4zA3Ooh6p2Z3O+IMRj2r8LA=
-github.com/scroll-tech/da-codec v0.0.0-20240730031611-1b736159d5cb/go.mod h1:D6XEESeNVJkQJlv3eK+FyR+ufPkgVQbJzERylQi53Bs=
-github.com/scroll-tech/go-ethereum v1.10.14-0.20240626125436-418bc6f728b6 h1:Q8YyvrcPIcXQwE4ucm4bqmPh6TP6IB1GUTXripf2WyQ=
-github.com/scroll-tech/go-ethereum v1.10.14-0.20240626125436-418bc6f728b6/go.mod h1:byf/mZ8jLYUCnUePTicjJWn+RvKdxDn7buS6glTnMwQ=
-github.com/scroll-tech/zktrie v0.8.4 h1:UagmnZ4Z3ITCk+aUq9NQZJNAwnWl4gSxsLb2Nl7IgRE=
-github.com/scroll-tech/zktrie v0.8.4/go.mod h1:XvNo7vAk8yxNyTjBDj5WIiFzYW4bx/gJ78+NK6Zn6Uk=
+github.com/scroll-tech/go-ethereum v1.10.14-0.20240426041101-a860446ebaea h1:CH1WXWrpEpLaP3N+bFs2a1xdE0+lRm1AuJQb5YvE6Ls=
+github.com/scroll-tech/go-ethereum v1.10.14-0.20240426041101-a860446ebaea/go.mod h1:i4VBgWoaW/y0D8MmQb7hSOulyw1dKhuiSFAbznwivCA=
+github.com/scroll-tech/zktrie v0.8.2 h1:UMuIfA+jdgWMLmTgTL64Emo+zzMOdcnH0+eYdDcshxQ=
+github.com/scroll-tech/zktrie v0.8.2/go.mod h1:XvNo7vAk8yxNyTjBDj5WIiFzYW4bx/gJ78+NK6Zn6Uk=
 github.com/segmentio/asm v1.2.0 h1:9BQrFxC+YOHJlTlHGkTrFWf59nbL3XnCoFLTwDCI7ys=
 github.com/segmentio/asm v1.2.0/go.mod h1:BqMnlJP91P8d+4ibuonYZw9mfnzI9HfxselHZr5aAcs=
 github.com/sethvargo/go-retry v0.2.4 h1:T+jHEQy/zKJf5s95UkguisicE0zuF9y7+/vgz08Ocec=
@@ -340,14 +339,14 @@ github.com/stretchr/testify v1.8.2/go.mod h1:w2LPCIKwWwSfY2zedu0+kehJoqGctiVI29o
 github.com/stretchr/testify v1.8.4/go.mod h1:sz/lmYIOXD/1dqDmKjjqLyZ2RngseejIcXlSw2iwfAo=
 github.com/stretchr/testify v1.9.0 h1:HtqpIVDClZ4nwg75+f6Lvsy/wHu+3BoSGCbBAcpTsTg=
 github.com/stretchr/testify v1.9.0/go.mod h1:r2ic/lqez/lEtzL7wO/rwa5dbSLXVDPFyf8C91i36aY=
-github.com/supranational/blst v0.3.12 h1:Vfas2U2CFHhniv2QkUm2OVa1+pGTdqtpqm9NnhUUbZ8=
-github.com/supranational/blst v0.3.12/go.mod h1:jZJtfjgudtNl4en1tzwPIV3KjUnQUvG3/j+w+fVonLw=
+github.com/supranational/blst v0.3.11 h1:LyU6FolezeWAhvQk0k6O/d49jqgO52MSDDfYgbeoEm4=
+github.com/supranational/blst v0.3.11/go.mod h1:jZJtfjgudtNl4en1tzwPIV3KjUnQUvG3/j+w+fVonLw=
 github.com/syndtr/goleveldb v1.0.1-0.20210819022825-2ae1ddf74ef7 h1:epCh84lMvA70Z7CTTCmYQn2CKbY8j86K7/FAIr141uY=
 github.com/syndtr/goleveldb v1.0.1-0.20210819022825-2ae1ddf74ef7/go.mod h1:q4W45IWZaF22tdD+VEXcAWRA037jwmWEB5VWYORlTpc=
-github.com/tklauser/go-sysconf v0.3.14 h1:g5vzr9iPFFz24v2KZXs/pvpvh8/V9Fw6vQK5ZZb78yU=
-github.com/tklauser/go-sysconf v0.3.14/go.mod h1:1ym4lWMLUOhuBOPGtRcJm7tEGX4SCYNEEEtghGG/8uY=
-github.com/tklauser/numcpus v0.8.0 h1:Mx4Wwe/FjZLeQsK/6kt2EOepwwSl7SmJrK5bV/dXYgY=
-github.com/tklauser/numcpus v0.8.0/go.mod h1:ZJZlAY+dmR4eut8epnzf0u/VwodKmryxR8txiloSqBE=
+github.com/tklauser/go-sysconf v0.3.12 h1:0QaGUFOdQaIVdPgfITYzaTegZvdCjmYO52cSFAEVmqU=
+github.com/tklauser/go-sysconf v0.3.12/go.mod h1:Ho14jnntGE1fpdOqQEEaiKRpvIavV0hSfmBq8nJbHYI=
+github.com/tklauser/numcpus v0.6.1 h1:ng9scYS7az0Bk4OZLvrNXNSAO2Pxr1XXRAPyjhIx+Fk=
+github.com/tklauser/numcpus v0.6.1/go.mod h1:1XfjsgE2zo8GVw7POkMbHENHzVg3GzmoZ9fESEdAacY=
 github.com/twitchyliquid64/golang-asm v0.15.1 h1:SU5vSMR7hnwNxj24w34ZyCi/FmDZTkS4MhqMhdFk5YI=
 github.com/twitchyliquid64/golang-asm v0.15.1/go.mod h1:a1lVb/DtPvCB8fslRZhAngC2+aY1QWCk3Cedj/Gdt08=
 github.com/tyler-smith/go-bip39 v1.1.0 h1:5eUemwrMargf3BSLRRCalXT93Ns6pQJIjYQN2nyfOP8=
@@ -370,8 +369,8 @@ github.com/ydb-platform/ydb-go-genproto v0.0.0-20231012155159-f85a672542fd h1:dz
 github.com/ydb-platform/ydb-go-genproto v0.0.0-20231012155159-f85a672542fd/go.mod h1:Er+FePu1dNUieD+XTMDduGpQuCPssK5Q4BjF+IIXJ3I=
 github.com/ydb-platform/ydb-go-sdk/v3 v3.54.2 h1:E0yUuuX7UmPxXm92+yQCjMveLFO3zfvYFIJVuAqsVRA=
 github.com/ydb-platform/ydb-go-sdk/v3 v3.54.2/go.mod h1:fjBLQ2TdQNl4bMjuWl9adoTGBypwUTPoGC+EqYqiIcU=
-github.com/yusufpapurcu/wmi v1.2.4 h1:zFUKzehAFReQwLys1b/iSMl+JQGSCSjtVqQn9bBrPo0=
-github.com/yusufpapurcu/wmi v1.2.4/go.mod h1:SBZ9tNy3G9/m5Oi98Zks0QjeHVDvuK0qfxQmPyzfmi0=
+github.com/yusufpapurcu/wmi v1.2.3 h1:E1ctvB7uKFMOJw3fdOW32DwGE9I7t++CRUEMKvFoFiw=
+github.com/yusufpapurcu/wmi v1.2.3/go.mod h1:SBZ9tNy3G9/m5Oi98Zks0QjeHVDvuK0qfxQmPyzfmi0=
 go.opentelemetry.io/otel v1.24.0 h1:0LAOdjNmQeSTzGBzduGe/rU4tZhMwL5rWgtp9Ku5Jfo=
 go.opentelemetry.io/otel v1.24.0/go.mod h1:W7b9Ozg4nkF5tWI5zsXkaKKDjdVjpD4oAt9Qi/MArHo=
 go.opentelemetry.io/otel/trace v1.24.0 h1:CsKnnL4dUAr/0llH9FKuc698G04IrpWV0MQA/Y1YELI=
@@ -384,21 +383,21 @@ golang.org/x/arch v0.5.0/go.mod h1:5om86z9Hs0C8fWVUuoMHwpExlXzs5Tkyp9hOrfG7pp8=
 golang.org/x/crypto v0.0.0-20170930174604-9419663f5a44/go.mod h1:6SG95UA2DQfeDnfUPMdvaQW0Q7yPrPDi9nlGo2tz2b4=
 golang.org/x/crypto v0.0.0-20190308221718-c2843e01d9a2/go.mod h1:djNgcEr1/C05ACkg1iLfiJU5Ep61QUkGW8qpdssI0+w=
 golang.org/x/crypto v0.0.0-20200622213623-75b288015ac9/go.mod h1:LzIPMQfyMNhhGPhUkYOs5KpL4U8rLKemX1yGLhDgUto=
-golang.org/x/crypto v0.24.0 h1:mnl8DM0o513X8fdIkmyFE/5hTYxbwYOjDS/+rK6qpRI=
-golang.org/x/crypto v0.24.0/go.mod h1:Z1PMYSOR5nyMcyAVAIQSKCDwalqy85Aqn1x3Ws4L5DM=
-golang.org/x/mod v0.17.0 h1:zY54UmvipHiNd+pm+m0x9KhZ9hl1/7QNMyxXbc6ICqA=
-golang.org/x/mod v0.17.0/go.mod h1:hTbmBsO62+eylJbnUtE2MGJUyE7QWk4xUqPFrRgJ+7c=
+golang.org/x/crypto v0.19.0 h1:ENy+Az/9Y1vSrlrvBSyna3PITt4tiZLf7sgCjZBX7Wo=
+golang.org/x/crypto v0.19.0/go.mod h1:Iy9bg/ha4yyC70EfRS8jz+B6ybOBKMaSxLj6P6oBDfU=
+golang.org/x/mod v0.16.0 h1:QX4fJ0Rr5cPQCF7O9lh9Se4pmwfwskqZfq5moyldzic=
+golang.org/x/mod v0.16.0/go.mod h1:hTbmBsO62+eylJbnUtE2MGJUyE7QWk4xUqPFrRgJ+7c=
 golang.org/x/net v0.0.0-20180906233101-161cd47e91fd/go.mod h1:mL1N/T3taQHkDXs73rZJwtUhF3w3ftmwwsq0BUmARs4=
 golang.org/x/net v0.0.0-20190404232315-eb5bcb51f2a3/go.mod h1:t9HGtf8HONx5eT2rtn7q6eTqICYqUVnKs3thJo3Qplg=
 golang.org/x/net v0.0.0-20200520004742-59133d7f0dd7/go.mod h1:qpuaurCH72eLCgpAm/N6yyVIVM9cpaDIP3A8BGJEC5A=
 golang.org/x/net v0.0.0-20200813134508-3edf25e44fcc/go.mod h1:/O7V0waA8r7cgGh81Ro3o1hOxt32SMVPicZroKQ2sZA=
-golang.org/x/net v0.25.0 h1:d/OCCoBEUq33pjydKrGQhw7IlUPI2Oylr+8qLx49kac=
-golang.org/x/net v0.25.0/go.mod h1:JkAGAh7GEvH74S6FOH42FLoXpXbE/aqXSrIQjXgsiwM=
+golang.org/x/net v0.20.0 h1:aCL9BSgETF1k+blQaYUBx9hJ9LOGP3gAVemcZlf1Kpo=
+golang.org/x/net v0.20.0/go.mod h1:z8BVo6PvndSri0LbOE3hAn0apkU+1YvI6E70E9jsnvY=
 golang.org/x/sync v0.0.0-20180314180146-1d60e4601c6f/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM=
 golang.org/x/sync v0.0.0-20181108010431-42b317875d0f/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM=
 golang.org/x/sync v0.0.0-20210220032951-036812b2e83c/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM=
-golang.org/x/sync v0.7.0 h1:YsImfSBoP9QPYL0xyKJPq0gcaJdG3rInoqxTWbfQu9M=
-golang.org/x/sync v0.7.0/go.mod h1:Czt+wKu1gCyEFDUtn0jG5QVvpJ6rzVqr5aXyt9drQfk=
+golang.org/x/sync v0.6.0 h1:5BMeUDZ7vkXGfEr1x9B4bRcTH4lpkTkpdh0T/J+qjbQ=
+golang.org/x/sync v0.6.0/go.mod h1:Czt+wKu1gCyEFDUtn0jG5QVvpJ6rzVqr5aXyt9drQfk=
 golang.org/x/sys v0.0.0-20180909124046-d0be0721c37e/go.mod h1:STP8DvDyc/dI5b8T5hshtkjS+E42TnysNCUPdjciGhY=
 golang.org/x/sys v0.0.0-20181107165924-66b7b1311ac8/go.mod h1:STP8DvDyc/dI5b8T5hshtkjS+E42TnysNCUPdjciGhY=
 golang.org/x/sys v0.0.0-20190215142949-d0b11bdaac8a/go.mod h1:STP8DvDyc/dI5b8T5hshtkjS+E42TnysNCUPdjciGhY=
@@ -415,18 +414,20 @@ golang.org/x/sys v0.0.0-20220908164124-27713097b956/go.mod h1:oPkhp1MJrh7nUepCBc
 golang.org/x/sys v0.1.0/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
 golang.org/x/sys v0.5.0/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
 golang.org/x/sys v0.6.0/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
-golang.org/x/sys v0.21.0 h1:rF+pYz3DAGSQAxAu1CbC7catZg4ebC4UIeIhKxBZvws=
-golang.org/x/sys v0.21.0/go.mod h1:/VUhepiaJMQUp4+oa/7Zr1D23ma6VTLIYjOOTFZPUcA=
+golang.org/x/sys v0.8.0/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
+golang.org/x/sys v0.11.0/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
+golang.org/x/sys v0.17.0 h1:25cE3gD+tdBA7lp7QfhuV+rJiE9YXTcS3VG1SqssI/Y=
+golang.org/x/sys v0.17.0/go.mod h1:/VUhepiaJMQUp4+oa/7Zr1D23ma6VTLIYjOOTFZPUcA=
 golang.org/x/text v0.3.0/go.mod h1:NqM8EUOU14njkJ3fqMW+pc6Ldnwhi/IjpwHt7yyuwOQ=
 golang.org/x/text v0.3.2/go.mod h1:bEr9sfX3Q8Zfm5fL9x+3itogRgK3+ptLWKqgva+5dAk=
 golang.org/x/text v0.3.3/go.mod h1:5Zoc/QRtKVWzQhOtBMvqHzDpF6irO9z98xDceosuGiQ=
-golang.org/x/text v0.16.0 h1:a94ExnEXNtEwYLGJSIUxnWoxoRz/ZcCsV63ROupILh4=
-golang.org/x/text v0.16.0/go.mod h1:GhwF1Be+LQoKShO3cGOHzqOgRrGaYc9AvblQOmPVHnI=
+golang.org/x/text v0.14.0 h1:ScX5w1eTa3QqT8oi6+ziP7dTV1S2+ALU0bI+0zXKWiQ=
+golang.org/x/text v0.14.0/go.mod h1:18ZOQIKpY8NJVqYksKHtTdi31H5itFRjB5/qKTNYzSU=
 golang.org/x/time v0.3.0 h1:rg5rLMjNzMS1RkNLzCG38eapWhnYLFYXDXj2gOlr8j4=
 golang.org/x/time v0.3.0/go.mod h1:tRJNPiyCQ0inRvYxbN9jk5I+vvW/OXSQhTDSoE431IQ=
 golang.org/x/tools v0.0.0-20180917221912-90fa682c2a6e/go.mod h1:n7NCudcB/nEzxVGmLbDWY5pfWTLqBcC2KZ6jyYvM4mQ=
-golang.org/x/tools v0.21.1-0.20240508182429-e35e4ccd0d2d h1:vU5i/LfpvrRCpgM/VPfJLg5KjxD3E+hfT1SH+d9zLwg=
-golang.org/x/tools v0.21.1-0.20240508182429-e35e4ccd0d2d/go.mod h1:aiJjzUbINMkxbQROHiO6hDPo2LHcIPhhQsa9DLh0yGk=
+golang.org/x/tools v0.17.0 h1:FvmRgNOcs3kOa+T20R1uhfP9F6HgG2mfxDv1vrx1Htc=
+golang.org/x/tools v0.17.0/go.mod h1:xsh6VxdV005rRVaS6SSAf9oiAqljS7UZUacMZ8Bnsps=
 golang.org/x/xerrors v0.0.0-20191204190536-9bdfabe68543/go.mod h1:I/5z698sn9Ka8TeJc9MKroUUfqBBauWjQqLJ2OPfmY0=
 golang.org/x/xerrors v0.0.0-20200804184101-5ec99f83aff1/go.mod h1:I/5z698sn9Ka8TeJc9MKroUUfqBBauWjQqLJ2OPfmY0=
 google.golang.org/genproto/googleapis/rpc v0.0.0-20231127180814-3a041ad873d4 h1:DC7wcm+i+P1rN3Ff07vL+OndGg5OhNddHyTA+ocPqYE=

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

@@ -6,7 +6,6 @@ import (
 	"path/filepath"
 
 	"scroll-tech/common/database"
-	"scroll-tech/common/utils"
 )
 
 // FetcherConfig is the configuration of Layer1 or Layer2 fetcher.
@@ -31,8 +30,6 @@ type FetcherConfig struct {
 	GatewayRouterAddr        string `json:"GatewayRouterAddr"`
 	MessageQueueAddr         string `json:"MessageQueueAddr"`
 	BatchBridgeGatewayAddr   string `json:"BatchBridgeGatewayAddr"`
-	GasTokenGatewayAddr      string `json:"GasTokenGatewayAddr"`
-	WrappedTokenGatewayAddr  string `json:"WrappedTokenGatewayAddr"`
 }
 
 // RedisConfig redis config
@@ -67,11 +64,5 @@ func NewConfig(file string) (*Config, error) {
 		return nil, err
 	}
 
-	// Override config with environment variables
-	err = utils.OverrideConfigWithEnv(cfg, "SCROLL_BRIDGE_HISTORY")
-	if err != nil {
-		return nil, err
-	}
-
 	return cfg, nil
 }

bridge-history-api/internal/controller/fetcher/l2_fetcher.go

@@ -141,7 +141,7 @@ func (c *L2MessageFetcher) fetchAndSaveEvents(confirmation uint64) {
 			return
 		}
 
-		if updateErr := c.eventUpdateLogic.UpdateL2WithdrawMessageProofs(c.ctx, c.l2SyncHeight); updateErr != nil {
+		if updateErr := c.eventUpdateLogic.UpdateL1BatchIndexAndStatus(c.ctx, c.l2SyncHeight); updateErr != nil {
 			log.Error("failed to update L1 batch index and status", "from", from, "to", to, "err", updateErr)
 			return
 		}

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

@@ -2,7 +2,7 @@ package logic
 
 import (
 	"context"
-	"errors"
+	"fmt"
 
 	"github.com/prometheus/client_golang/prometheus"
 	"github.com/prometheus/client_golang/prometheus/promauto"
@@ -125,11 +125,6 @@ func (b *EventUpdateLogic) L1InsertOrUpdate(ctx context.Context, l1FetcherResult
 }
 
 func (b *EventUpdateLogic) updateL2WithdrawMessageInfos(ctx context.Context, batchIndex, startBlock, endBlock uint64) error {
-	if startBlock > endBlock {
-		log.Warn("start block is greater than end block", "start", startBlock, "end", endBlock)
-		return nil
-	}
-
 	l2WithdrawMessages, err := b.crossMessageOrm.GetL2WithdrawalsByBlockRange(ctx, startBlock, endBlock)
 	if err != nil {
 		log.Error("failed to get L2 withdrawals by batch index", "batch index", batchIndex, "err", err)
@@ -152,8 +147,8 @@ func (b *EventUpdateLogic) updateL2WithdrawMessageInfos(ctx context.Context, bat
 	}
 
 	if withdrawTrie.NextMessageNonce != l2WithdrawMessages[0].MessageNonce {
-		log.Error("nonce mismatch", "expected next message nonce", withdrawTrie.NextMessageNonce, "actual next message nonce", l2WithdrawMessages[0].MessageNonce)
-		return errors.New("nonce mismatch")
+		log.Error("nonce mismatch", "expected next message nonce", withdrawTrie.NextMessageNonce, "actuall next message nonce", l2WithdrawMessages[0].MessageNonce)
+		return fmt.Errorf("nonce mismatch")
 	}
 
 	messageHashes := make([]common.Hash, len(l2WithdrawMessages))
@@ -178,42 +173,24 @@ func (b *EventUpdateLogic) updateL2WithdrawMessageInfos(ctx context.Context, bat
 	return nil
 }
 
-// UpdateL2WithdrawMessageProofs updates L2 withdrawal message proofs.
-func (b *EventUpdateLogic) UpdateL2WithdrawMessageProofs(ctx context.Context, height uint64) error {
-	lastUpdatedFinalizedBlockHeight, err := b.batchEventOrm.GetLastUpdatedFinalizedBlockHeight(ctx)
+// UpdateL1BatchIndexAndStatus updates L1 finalized batch index and status
+func (b *EventUpdateLogic) UpdateL1BatchIndexAndStatus(ctx context.Context, height uint64) error {
+	finalizedBatches, err := b.batchEventOrm.GetFinalizedBatchesLEBlockHeight(ctx, height)
 	if err != nil {
-		log.Error("failed to get last updated finalized block height", "error", err)
-		return err
-	}
-
-	finalizedBatches, err := b.batchEventOrm.GetUnupdatedFinalizedBatchesLEBlockHeight(ctx, height)
-	if err != nil {
-		log.Error("failed to get unupdated finalized batches >= block height", "error", err)
+		log.Error("failed to get batches >= block height", "error", err)
 		return err
 	}
 
 	for _, finalizedBatch := range finalizedBatches {
-		log.Info("update finalized batch or bundle info of L2 withdrawals", "index", finalizedBatch.BatchIndex, "lastUpdatedFinalizedBlockHeight", lastUpdatedFinalizedBlockHeight, "start", finalizedBatch.StartBlockNumber, "end", finalizedBatch.EndBlockNumber)
-		// This method is compatible with both "finalize by batch" and "finalize by bundle" modes:
-		// - In "finalize by batch" mode, each batch emits a FinalizedBatch event.
-		// - In "finalize by bundle" mode, all batches in the bundle emit only one FinalizedBatch event, using the last batch's index and hash.
-		//
-		// The method updates two types of information in L2 withdrawal messages:
-		// 1. Withdraw proof generation:
-		//    - finalize by batch: Generates proofs for each batch.
-		//    - finalize by bundle: Generates proofs for the entire bundle at once.
-		// 2. Batch index updating:
-		//    - finalize by batch: Updates the batch index for withdrawal messages in each processed batch.
-		//    - finalize by bundle: Updates the batch index for all withdrawal messages in the bundle, using the index of the last batch in the bundle.
-		if updateErr := b.updateL2WithdrawMessageInfos(ctx, finalizedBatch.BatchIndex, lastUpdatedFinalizedBlockHeight+1, finalizedBatch.EndBlockNumber); updateErr != nil {
-			log.Error("failed to update L2 withdraw message infos", "index", finalizedBatch.BatchIndex, "lastUpdatedFinalizedBlockHeight", lastUpdatedFinalizedBlockHeight, "start", finalizedBatch.StartBlockNumber, "end", finalizedBatch.EndBlockNumber, "error", updateErr)
+		log.Info("update finalized batch info of L2 withdrawals", "index", finalizedBatch.BatchIndex, "start", finalizedBatch.StartBlockNumber, "end", finalizedBatch.EndBlockNumber)
+		if updateErr := b.updateL2WithdrawMessageInfos(ctx, finalizedBatch.BatchIndex, finalizedBatch.StartBlockNumber, finalizedBatch.EndBlockNumber); updateErr != nil {
+			log.Error("failed to update L2 withdraw message infos", "index", finalizedBatch.BatchIndex, "start", finalizedBatch.StartBlockNumber, "end", finalizedBatch.EndBlockNumber, "error", updateErr)
 			return updateErr
 		}
 		if dbErr := b.batchEventOrm.UpdateBatchEventStatus(ctx, finalizedBatch.BatchIndex); dbErr != nil {
-			log.Error("failed to update batch event status as updated", "index", finalizedBatch.BatchIndex, "lastUpdatedFinalizedBlockHeight", lastUpdatedFinalizedBlockHeight, "start", finalizedBatch.StartBlockNumber, "end", finalizedBatch.EndBlockNumber, "error", dbErr)
+			log.Error("failed to update batch event status as updated", "index", finalizedBatch.BatchIndex, "start", finalizedBatch.StartBlockNumber, "end", finalizedBatch.EndBlockNumber, "error", dbErr)
 			return dbErr
 		}
-		lastUpdatedFinalizedBlockHeight = finalizedBatch.EndBlockNumber
 		b.eventUpdateLogicL1FinalizeBatchEventL2BlockUpdateHeight.Set(float64(finalizedBatch.EndBlockNumber))
 	}
 	return nil

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

@@ -407,7 +407,7 @@ func (h *HistoryLogic) cacheTxsInfo(ctx context.Context, cacheKey string, txs []
 				return err
 			}
 		} else {
-			// The transactions are sorted, thus we set the score as their index.
+			// The transactions are sorted, thus we set the score as their indices.
 			for _, tx := range txs {
 				txBytes, err := json.Marshal(tx)
 				if err != nil {

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

@@ -168,14 +168,6 @@ func (e *L1EventParser) ParseL1SingleCrossChainEventLogs(ctx context.Context, lo
 			lastMessage.L2TokenAddress = event.L2Token.String()
 			lastMessage.TokenIDs = utils.ConvertBigIntArrayToString(event.TokenIDs)
 			lastMessage.TokenAmounts = utils.ConvertBigIntArrayToString(event.TokenAmounts)
-		case backendabi.L1DepositWrappedTokenSig:
-			event := backendabi.WrappedTokenMessageEvent{}
-			if err := utils.UnpackLog(backendabi.L1WrappedTokenGatewayABI, &event, "DepositWrappedToken", vlog); err != nil {
-				log.Error("Failed to unpack DepositWrappedToken event", "err", err)
-				return nil, nil, err
-			}
-			lastMessage := l1DepositMessages[len(l1DepositMessages)-1]
-			lastMessage.Sender = event.From.String()
 		case backendabi.L1SentMessageEventSig:
 			event := backendabi.L1SentMessageEvent{}
 			if err := utils.UnpackLog(backendabi.IL1ScrollMessengerABI, &event, "SentMessage", vlog); err != nil {
@@ -328,16 +320,6 @@ func (e *L1EventParser) ParseL1MessageQueueEventLogs(logs []types.Log, l1Deposit
 					QueueIndex: index,
 				})
 			}
-		case backendabi.L1ResetDequeuedTransactionEventSig:
-			event := backendabi.L1ResetDequeuedTransactionEvent{}
-			if err := utils.UnpackLog(backendabi.IL1MessageQueueABI, &event, "ResetDequeuedTransaction", vlog); err != nil {
-				log.Error("Failed to unpack ResetDequeuedTransaction event", "err", err)
-				return nil, err
-			}
-			l1MessageQueueEvents = append(l1MessageQueueEvents, &orm.MessageQueueEvent{
-				EventType:  btypes.MessageQueueEventTypeResetDequeuedTransaction,
-				QueueIndex: event.StartIndex.Uint64(),
-			})
 		case backendabi.L1DropTransactionEventSig:
 			event := backendabi.L1DropTransactionEvent{}
 			if err := utils.UnpackLog(backendabi.IL1MessageQueueABI, &event, "DropTransaction", vlog); err != nil {

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

@@ -51,8 +51,11 @@ type L1FetcherLogic struct {
 // NewL1FetcherLogic creates L1 fetcher logic
 func NewL1FetcherLogic(cfg *config.FetcherConfig, db *gorm.DB, client *ethclient.Client) *L1FetcherLogic {
 	addressList := []common.Address{
+		common.HexToAddress(cfg.ETHGatewayAddr),
+
 		common.HexToAddress(cfg.StandardERC20GatewayAddr),
 		common.HexToAddress(cfg.CustomERC20GatewayAddr),
+		common.HexToAddress(cfg.WETHGatewayAddr),
 		common.HexToAddress(cfg.DAIGatewayAddr),
 
 		common.HexToAddress(cfg.ERC721GatewayAddr),
@@ -66,8 +69,11 @@ func NewL1FetcherLogic(cfg *config.FetcherConfig, db *gorm.DB, client *ethclient
 	}
 
 	gatewayList := []common.Address{
+		common.HexToAddress(cfg.ETHGatewayAddr),
+
 		common.HexToAddress(cfg.StandardERC20GatewayAddr),
 		common.HexToAddress(cfg.CustomERC20GatewayAddr),
+		common.HexToAddress(cfg.WETHGatewayAddr),
 		common.HexToAddress(cfg.DAIGatewayAddr),
 
 		common.HexToAddress(cfg.ERC721GatewayAddr),
@@ -99,26 +105,6 @@ func NewL1FetcherLogic(cfg *config.FetcherConfig, db *gorm.DB, client *ethclient
 		gatewayList = append(gatewayList, common.HexToAddress(cfg.BatchBridgeGatewayAddr))
 	}
 
-	if common.HexToAddress(cfg.ETHGatewayAddr) != (common.Address{}) {
-		addressList = append(addressList, common.HexToAddress(cfg.ETHGatewayAddr))
-		gatewayList = append(gatewayList, common.HexToAddress(cfg.ETHGatewayAddr))
-	}
-
-	if common.HexToAddress(cfg.WETHGatewayAddr) != (common.Address{}) {
-		addressList = append(addressList, common.HexToAddress(cfg.WETHGatewayAddr))
-		gatewayList = append(gatewayList, common.HexToAddress(cfg.WETHGatewayAddr))
-	}
-
-	if common.HexToAddress(cfg.GasTokenGatewayAddr) != (common.Address{}) {
-		addressList = append(addressList, common.HexToAddress(cfg.GasTokenGatewayAddr))
-		gatewayList = append(gatewayList, common.HexToAddress(cfg.GasTokenGatewayAddr))
-	}
-
-	if common.HexToAddress(cfg.WrappedTokenGatewayAddr) != (common.Address{}) {
-		addressList = append(addressList, common.HexToAddress(cfg.WrappedTokenGatewayAddr))
-		gatewayList = append(gatewayList, common.HexToAddress(cfg.WrappedTokenGatewayAddr))
-	}
-
 	log.Info("L1 Fetcher configured with the following address list", "addresses", addressList, "gateways", gatewayList)
 
 	f := &L1FetcherLogic{
@@ -224,7 +210,7 @@ func (f *L1FetcherLogic) l1FetcherLogs(ctx context.Context, from, to uint64) ([]
 		Topics:    make([][]common.Hash, 1),
 	}
 
-	query.Topics[0] = make([]common.Hash, 16)
+	query.Topics[0] = make([]common.Hash, 14)
 	query.Topics[0][0] = backendabi.L1DepositETHSig
 	query.Topics[0][1] = backendabi.L1DepositERC20Sig
 	query.Topics[0][2] = backendabi.L1DepositERC721Sig
@@ -238,9 +224,7 @@ func (f *L1FetcherLogic) l1FetcherLogs(ctx context.Context, from, to uint64) ([]
 	query.Topics[0][10] = backendabi.L1QueueTransactionEventSig
 	query.Topics[0][11] = backendabi.L1DequeueTransactionEventSig
 	query.Topics[0][12] = backendabi.L1DropTransactionEventSig
-	query.Topics[0][13] = backendabi.L1ResetDequeuedTransactionEventSig
-	query.Topics[0][14] = backendabi.L1BridgeBatchDepositSig
-	query.Topics[0][15] = backendabi.L1DepositWrappedTokenSig
+	query.Topics[0][13] = backendabi.L1BridgeBatchDepositSig
 
 	eventLogs, err := f.client.FilterLogs(ctx, query)
 	if err != nil {
@@ -355,10 +339,6 @@ func (f *L1FetcherLogic) updateMetrics(res L1FilterResult) {
 			f.l1FetcherLogicFetchedTotal.WithLabelValues("L1_skip_message").Add(1)
 		case btypes.MessageQueueEventTypeDropTransaction:
 			f.l1FetcherLogicFetchedTotal.WithLabelValues("L1_drop_message").Add(1)
-		// one ResetDequeuedTransaction event could indicate reset multiple skipped messages,
-		// this metric only counts the number of events, not the number of skipped messages.
-		case btypes.MessageQueueEventTypeResetDequeuedTransaction:
-			f.l1FetcherLogicFetchedTotal.WithLabelValues("L1_reset_skipped_messages").Add(1)
 		}
 	}
 

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

@@ -54,6 +54,7 @@ func NewL2FetcherLogic(cfg *config.FetcherConfig, db *gorm.DB, client *ethclient
 
 		common.HexToAddress(cfg.StandardERC20GatewayAddr),
 		common.HexToAddress(cfg.CustomERC20GatewayAddr),
+		common.HexToAddress(cfg.WETHGatewayAddr),
 		common.HexToAddress(cfg.DAIGatewayAddr),
 
 		common.HexToAddress(cfg.ERC721GatewayAddr),
@@ -67,6 +68,7 @@ func NewL2FetcherLogic(cfg *config.FetcherConfig, db *gorm.DB, client *ethclient
 
 		common.HexToAddress(cfg.StandardERC20GatewayAddr),
 		common.HexToAddress(cfg.CustomERC20GatewayAddr),
+		common.HexToAddress(cfg.WETHGatewayAddr),
 		common.HexToAddress(cfg.DAIGatewayAddr),
 
 		common.HexToAddress(cfg.ERC721GatewayAddr),
@@ -98,11 +100,6 @@ func NewL2FetcherLogic(cfg *config.FetcherConfig, db *gorm.DB, client *ethclient
 		gatewayList = append(gatewayList, common.HexToAddress(cfg.BatchBridgeGatewayAddr))
 	}
 
-	if common.HexToAddress(cfg.WETHGatewayAddr) != (common.Address{}) {
-		addressList = append(addressList, common.HexToAddress(cfg.WETHGatewayAddr))
-		gatewayList = append(gatewayList, common.HexToAddress(cfg.WETHGatewayAddr))
-	}
-
 	log.Info("L2 Fetcher configured with the following address list", "addresses", addressList, "gateways", gatewayList)
 
 	f := &L2FetcherLogic{

bridge-history-api/internal/orm/batch_event.go

@@ -53,26 +53,8 @@ func (c *BatchEvent) GetBatchEventSyncedHeightInDB(ctx context.Context) (uint64,
 	return batch.L1BlockNumber, nil
 }
 
-// GetLastUpdatedFinalizedBlockHeight returns the last updated finalized block height in db.
-func (c *BatchEvent) GetLastUpdatedFinalizedBlockHeight(ctx context.Context) (uint64, error) {
-	var batch BatchEvent
-	db := c.db.WithContext(ctx)
-	db = db.Model(&BatchEvent{})
-	db = db.Where("batch_status = ?", btypes.BatchStatusTypeFinalized)
-	db = db.Where("update_status = ?", btypes.UpdateStatusTypeUpdated)
-	db = db.Order("batch_index desc")
-	if err := db.First(&batch).Error; err != nil {
-		if err == gorm.ErrRecordNotFound {
-			// No finalized batch found, return genesis batch's end block number.
-			return 0, nil
-		}
-		return 0, fmt.Errorf("failed to get last updated finalized block height, error: %w", err)
-	}
-	return batch.EndBlockNumber, nil
-}
-
-// GetUnupdatedFinalizedBatchesLEBlockHeight returns the finalized batches with end block <= given block height in db.
-func (c *BatchEvent) GetUnupdatedFinalizedBatchesLEBlockHeight(ctx context.Context, blockHeight uint64) ([]*BatchEvent, error) {
+// GetFinalizedBatchesLEBlockHeight returns the finalized batches with end block <= given block height in db.
+func (c *BatchEvent) GetFinalizedBatchesLEBlockHeight(ctx context.Context, blockHeight uint64) ([]*BatchEvent, error) {
 	var batches []*BatchEvent
 	db := c.db.WithContext(ctx)
 	db = db.Model(&BatchEvent{})
@@ -84,7 +66,7 @@ func (c *BatchEvent) GetUnupdatedFinalizedBatchesLEBlockHeight(ctx context.Conte
 		if err == gorm.ErrRecordNotFound {
 			return nil, nil
 		}
-		return nil, fmt.Errorf("failed to get unupdated finalized batches >= block height, error: %w", err)
+		return nil, fmt.Errorf("failed to get batches >= block height, error: %w", err)
 	}
 	return batches, nil
 }
@@ -110,7 +92,6 @@ func (c *BatchEvent) InsertOrUpdateBatchEvents(ctx context.Context, l1BatchEvent
 			db = db.Where("batch_index = ?", l1BatchEvent.BatchIndex)
 			db = db.Where("batch_hash = ?", l1BatchEvent.BatchHash)
 			updateFields["batch_status"] = btypes.BatchStatusTypeFinalized
-			updateFields["l1_block_number"] = l1BatchEvent.L1BlockNumber
 			if err := db.Updates(updateFields).Error; err != nil {
 				return fmt.Errorf("failed to update batch event, error: %w", err)
 			}

bridge-history-api/internal/orm/cross_message.go

@@ -217,12 +217,6 @@ func (c *CrossMessage) UpdateL1MessageQueueEventsInfo(ctx context.Context, l1Mes
 			db = db.Where("message_nonce = ?", l1MessageQueueEvent.QueueIndex)
 			db = db.Where("message_type = ?", btypes.MessageTypeL1SentMessage)
 			txStatusUpdateFields["tx_status"] = types.TxStatusTypeDropped
-		case btypes.MessageQueueEventTypeResetDequeuedTransaction:
-			db = db.Where("tx_status = ?", types.TxStatusTypeSkipped)
-			// reset skipped messages that the nonce is greater than or equal to the queue index.
-			db = db.Where("message_nonce >= ?", l1MessageQueueEvent.QueueIndex)
-			db = db.Where("message_type = ?", btypes.MessageTypeL1SentMessage)
-			txStatusUpdateFields["tx_status"] = types.TxStatusTypeSent
 		}
 		if err := db.Updates(txStatusUpdateFields).Error; err != nil {
 			return fmt.Errorf("failed to update tx statuses of L1 message queue events, update fields: %v, error: %w", txStatusUpdateFields, err)
@@ -236,7 +230,7 @@ func (c *CrossMessage) UpdateL1MessageQueueEventsInfo(ctx context.Context, l1Mes
 		db = db.Model(&CrossMessage{})
 		txHashUpdateFields := make(map[string]interface{})
 		switch l1MessageQueueEvent.EventType {
-		case btypes.MessageQueueEventTypeDequeueTransaction, btypes.MessageQueueEventTypeResetDequeuedTransaction:
+		case btypes.MessageQueueEventTypeDequeueTransaction:
 			continue
 		case btypes.MessageQueueEventTypeQueueTransaction:
 			// only replayMessages or enforced txs (whose message hashes would not be found), sendMessages have been filtered out.

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

@@ -70,7 +70,6 @@ const (
 	MessageQueueEventTypeQueueTransaction
 	MessageQueueEventTypeDequeueTransaction
 	MessageQueueEventTypeDropTransaction
-	MessageQueueEventTypeResetDequeuedTransaction
 )
 
 // BatchStatusType represents the type of batch status.

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

@@ -38,7 +38,7 @@ func GetBlockNumber(ctx context.Context, client *ethclient.Client, confirmations
 // @todo: add unit test.
 func UnpackLog(c *abi.ABI, out interface{}, event string, log types.Log) error {
 	if log.Topics[0] != c.Events[event].ID {
-		return errors.New("event signature mismatch")
+		return fmt.Errorf("event signature mismatch")
 	}
 	if len(log.Data) > 0 {
 		if err := c.UnpackIntoInterface(out, event, log.Data); err != nil {
@@ -66,55 +66,32 @@ func ComputeMessageHash(
 	return common.BytesToHash(crypto.Keccak256(data))
 }
 
+type commitBatchArgs struct {
+	Version                uint8
+	ParentBatchHeader      []byte
+	Chunks                 [][]byte
+	SkippedL1MessageBitmap []byte
+}
+
 // GetBatchRangeFromCalldata find the block range from calldata, both inclusive.
-func GetBatchRangeFromCalldata(txData []byte) (uint64, uint64, error) {
-	const methodIDLength = 4
-	if len(txData) < methodIDLength {
-		return 0, 0, fmt.Errorf("transaction data is too short, length of tx data: %v, minimum length required: %v", len(txData), methodIDLength)
-	}
-	method, err := backendabi.IScrollChainABI.MethodById(txData[:methodIDLength])
+func GetBatchRangeFromCalldata(calldata []byte) (uint64, uint64, error) {
+	method := backendabi.IScrollChainABI.Methods["commitBatch"]
+	values, err := method.Inputs.Unpack(calldata[4:])
 	if err != nil {
-		return 0, 0, fmt.Errorf("failed to get method by ID, ID: %v, err: %w", txData[:methodIDLength], err)
+		// special case: import genesis batch
+		method = backendabi.IScrollChainABI.Methods["importGenesisBatch"]
+		_, err2 := method.Inputs.Unpack(calldata[4:])
+		if err2 == nil {
+			// genesis batch
+			return 0, 0, nil
+		}
+		// none of "commitBatch" and "importGenesisBatch" match, give up
+		return 0, 0, err
 	}
-	values, err := method.Inputs.Unpack(txData[methodIDLength:])
+	args := commitBatchArgs{}
+	err = method.Inputs.Copy(&args, values)
 	if err != nil {
-		return 0, 0, fmt.Errorf("failed to unpack transaction data using ABI, tx data: %v, err: %w", txData, err)
-	}
-
-	var chunks [][]byte
-
-	if method.Name == "importGenesisBatch" {
-		return 0, 0, nil
-	} else if method.Name == "commitBatch" {
-		type commitBatchArgs struct {
-			Version                uint8
-			ParentBatchHeader      []byte
-			Chunks                 [][]byte
-			SkippedL1MessageBitmap []byte
-		}
-
-		var args commitBatchArgs
-		if err = method.Inputs.Copy(&args, values); err != nil {
-			return 0, 0, fmt.Errorf("failed to decode calldata into commitBatch args, values: %+v, err: %w", values, err)
-		}
-
-		chunks = args.Chunks
-
-	} else if method.Name == "commitBatchWithBlobProof" {
-		type commitBatchWithBlobProofArgs struct {
-			Version                uint8
-			ParentBatchHeader      []byte
-			Chunks                 [][]byte
-			SkippedL1MessageBitmap []byte
-			BlobDataProof          []byte
-		}
-
-		var args commitBatchWithBlobProofArgs
-		if err = method.Inputs.Copy(&args, values); err != nil {
-			return 0, 0, fmt.Errorf("failed to decode calldata into commitBatchWithBlobProofArgs args, values: %+v, err: %w", values, err)
-		}
-
-		chunks = args.Chunks
+		return 0, 0, err
 	}
 
 	var startBlock uint64
@@ -123,14 +100,14 @@ func GetBatchRangeFromCalldata(txData []byte) (uint64, uint64, error) {
 	// decode blocks from chunk and assume that there's no empty chunk
 	// |   1 byte   | 60 bytes | ... | 60 bytes |
 	// | num blocks |  block 1 | ... |  block n |
-	if len(chunks) == 0 {
+	if len(args.Chunks) == 0 {
 		return 0, 0, errors.New("invalid chunks")
 	}
-	chunk := chunks[0]
+	chunk := args.Chunks[0]
 	block := chunk[1:61] // first block in chunk
 	startBlock = binary.BigEndian.Uint64(block[0:8])
 
-	chunk = chunks[len(chunks)-1]
+	chunk = args.Chunks[len(args.Chunks)-1]
 	lastBlockIndex := int(chunk[0]) - 1
 	block = chunk[1+lastBlockIndex*60 : 1+lastBlockIndex*60+60] // last block in chunk
 	finishBlock = binary.BigEndian.Uint64(block[0:8])

build/dockerfiles/bridgehistoryapi-api.Dockerfile

@@ -1,5 +1,5 @@
 # Download Go dependencies
-FROM scrolltech/go-rust-builder:go-1.21-rust-nightly-2023-12-03 as base
+FROM golang:1.21-alpine3.19 as base
 
 WORKDIR /src
 COPY go.mod* ./
@@ -11,12 +11,11 @@ FROM base as builder
 
 RUN --mount=target=. \
     --mount=type=cache,target=/root/.cache/go-build \
-    cd /src/bridge-history-api/cmd/api && CGO_LDFLAGS="-Wl,--no-as-needed -ldl" go build -v -p 4 -o /bin/bridgehistoryapi-api
+    cd /src/bridge-history-api/cmd/api && go build -v -p 4 -o /bin/bridgehistoryapi-api
 
-# Pull bridgehistoryapi-api into a second stage deploy ubuntu container
-FROM ubuntu:20.04
+# Pull bridgehistoryapi-api into a second stage deploy alpine container
+FROM alpine:latest
 
-ENV CGO_LDFLAGS="-Wl,--no-as-needed -ldl"
 COPY --from=builder /bin/bridgehistoryapi-api /bin/
 WORKDIR /app
-ENTRYPOINT ["bridgehistoryapi-api"]
+ENTRYPOINT ["bridgehistoryapi-api"]

build/dockerfiles/bridgehistoryapi-fetcher.Dockerfile

@@ -1,5 +1,5 @@
 # Download Go dependencies
-FROM scrolltech/go-rust-builder:go-1.21-rust-nightly-2023-12-03 as base
+FROM golang:1.21-alpine3.19 as base
 
 WORKDIR /src
 COPY go.mod* ./
@@ -11,14 +11,11 @@ FROM base as builder
 
 RUN --mount=target=. \
     --mount=type=cache,target=/root/.cache/go-build \
-    cd /src/bridge-history-api/cmd/fetcher && CGO_LDFLAGS="-Wl,--no-as-needed -ldl" go build -v -p 4 -o /bin/bridgehistoryapi-fetcher
+    cd /src/bridge-history-api/cmd/fetcher && go build -v -p 4 -o /bin/bridgehistoryapi-fetcher
 
-# Pull bridgehistoryapi-fetcher into a second stage deploy ubuntu container
-FROM ubuntu:20.04
+# Pull bridgehistoryapi-fetcher into a second stage deploy alpine container
+FROM alpine:latest
 
-ENV CGO_LDFLAGS="-Wl,--no-as-needed -ldl"
-RUN apt update && apt install ca-certificates -y
-RUN update-ca-certificates
 COPY --from=builder /bin/bridgehistoryapi-fetcher /bin/
 WORKDIR /app
-ENTRYPOINT ["bridgehistoryapi-fetcher"]
+ENTRYPOINT ["bridgehistoryapi-fetcher"]

build/dockerfiles/coordinator-api.Dockerfile

@@ -13,6 +13,7 @@ RUN cargo chef cook --release --recipe-path recipe.json
 
 COPY ./common/libzkp/impl .
 RUN cargo build --release
+RUN find ./ | grep libzktrie.so | xargs -I{} cp {} /app/target/release/
 
 
 # Download Go dependencies
@@ -23,6 +24,7 @@ COPY ./rollup/go.* ./rollup/
 COPY ./common/go.* ./common/
 COPY ./coordinator/go.* ./coordinator/
 COPY ./database/go.* ./database/
+COPY ./prover/go.* ./prover/
 COPY ./tests/integration-test/go.* ./tests/integration-test/
 COPY ./bridge-history-api/go.* ./bridge-history-api/
 RUN go mod download -x
@@ -33,12 +35,12 @@ FROM base as builder
 COPY . .
 RUN cp -r ./common/libzkp/interface ./coordinator/internal/logic/verifier/lib
 COPY --from=zkp-builder /app/target/release/libzkp.so ./coordinator/internal/logic/verifier/lib/
-RUN cd ./coordinator && CGO_LDFLAGS="-Wl,--no-as-needed -ldl" make coordinator_api_skip_libzkp && mv ./build/bin/coordinator_api /bin/coordinator_api && mv internal/logic/verifier/lib /bin/
+COPY --from=zkp-builder /app/target/release/libzktrie.so ./coordinator/internal/logic/verifier/lib/
+RUN cd ./coordinator && make coordinator_api_skip_libzkp && mv ./build/bin/coordinator_api /bin/coordinator_api && mv internal/logic/verifier/lib /bin/
 
-# Pull coordinator into a second stage deploy ubuntu container
+# Pull coordinator into a second stage deploy alpine container
 FROM ubuntu:20.04
 ENV LD_LIBRARY_PATH=$LD_LIBRARY_PATH:/src/coordinator/internal/logic/verifier/lib
-ENV CGO_LDFLAGS="-Wl,--no-as-needed -ldl"
 # ENV CHAIN_ID=534353
 RUN mkdir -p /src/coordinator/internal/logic/verifier/lib
 COPY --from=builder /bin/lib /src/coordinator/internal/logic/verifier/lib

build/dockerfiles/coordinator-cron.Dockerfile

@@ -1,5 +1,5 @@
 # Download Go dependencies
-FROM scrolltech/go-rust-builder:go-1.21-rust-nightly-2023-12-03 as base
+FROM scrolltech/go-alpine-builder:1.21 as base
 
 WORKDIR /src
 COPY go.work* ./
@@ -7,6 +7,7 @@ COPY ./rollup/go.* ./rollup/
 COPY ./common/go.* ./common/
 COPY ./coordinator/go.* ./coordinator/
 COPY ./database/go.* ./database/
+COPY ./prover/go.* ./prover/
 COPY ./tests/integration-test/go.* ./tests/integration-test/
 COPY ./bridge-history-api/go.* ./bridge-history-api/
 RUN go mod download -x
@@ -15,13 +16,10 @@ RUN go mod download -x
 FROM base as builder
 RUN --mount=target=. \
     --mount=type=cache,target=/root/.cache/go-build \
-    cd /src/coordinator/cmd/cron/ && CGO_LDFLAGS="-Wl,--no-as-needed -ldl" go build -v -p 4 -o /bin/coordinator_cron
-
-# Pull coordinator into a second stage deploy ubuntu container
-FROM ubuntu:20.04
-
-ENV CGO_LDFLAGS="-Wl,--no-as-needed -ldl"
+    cd /src/coordinator/cmd/cron/ && go build -v -p 4 -o /bin/coordinator_cron
 
+# Pull coordinator into a second stage deploy alpine container
+FROM alpine:latest
 COPY --from=builder /bin/coordinator_cron /bin/
 WORKDIR /app
-ENTRYPOINT ["coordinator_cron"]
+ENTRYPOINT ["coordinator_cron"]

build/dockerfiles/db_cli.Dockerfile

@@ -7,6 +7,7 @@ COPY ./rollup/go.* ./rollup/
 COPY ./common/go.* ./common/
 COPY ./coordinator/go.* ./coordinator/
 COPY ./database/go.* ./database/
+COPY ./prover/go.* ./prover/
 COPY ./tests/integration-test/go.* ./tests/integration-test/
 COPY ./bridge-history-api/go.* ./bridge-history-api/
 RUN go mod download -x

build/dockerfiles/event_watcher.Dockerfile

@@ -0,0 +1,56 @@
+ARG LIBSCROLL_ZSTD_VERSION=v0.0.0-rc0-ubuntu20.04
+ARG SCROLL_LIB_PATH=/scroll/lib
+
+# Download Go dependencies
+FROM scrolltech/go-rust-builder:go-1.21-rust-nightly-2023-12-03 as base
+
+WORKDIR /src
+COPY go.work* ./
+COPY ./rollup/go.* ./rollup/
+COPY ./common/go.* ./common/
+COPY ./coordinator/go.* ./coordinator/
+COPY ./database/go.* ./database/
+COPY ./prover/go.* ./prover/
+COPY ./tests/integration-test/go.* ./tests/integration-test/
+COPY ./bridge-history-api/go.* ./bridge-history-api/
+RUN go mod download -x
+
+# Build event_watcher
+FROM base as builder
+
+ARG LIBSCROLL_ZSTD_VERSION
+ARG SCROLL_LIB_PATH
+
+RUN mkdir -p $SCROLL_LIB_PATH
+
+RUN apt-get -qq update && apt-get -qq install -y wget
+
+RUN wget -O $SCROLL_LIB_PATH/libzktrie.so https://github.com/scroll-tech/da-codec/releases/download/$LIBSCROLL_ZSTD_VERSION/libzktrie.so
+RUN wget -O $SCROLL_LIB_PATH/libscroll_zstd.so https://github.com/scroll-tech/da-codec/releases/download/$LIBSCROLL_ZSTD_VERSION/libscroll_zstd.so
+
+ENV LD_LIBRARY_PATH=$SCROLL_LIB_PATH
+ENV CGO_LDFLAGS="-L$SCROLL_LIB_PATH -Wl,-rpath,$SCROLL_LIB_PATH"
+
+RUN --mount=target=. \
+    --mount=type=cache,target=/root/.cache/go-build \
+    cd /src/rollup/cmd/event_watcher/ && go build -v -p 4 -o /bin/event_watcher
+
+# Pull event_watcher into a second stage deploy alpine container
+FROM ubuntu:20.04
+
+ARG LIBSCROLL_ZSTD_VERSION
+ARG SCROLL_LIB_PATH
+
+RUN mkdir -p $SCROLL_LIB_PATH
+
+RUN apt-get -qq update && apt-get -qq install -y wget
+
+RUN wget -O $SCROLL_LIB_PATH/libzktrie.so https://github.com/scroll-tech/da-codec/releases/download/$LIBSCROLL_ZSTD_VERSION/libzktrie.so
+RUN wget -O $SCROLL_LIB_PATH/libscroll_zstd.so https://github.com/scroll-tech/da-codec/releases/download/$LIBSCROLL_ZSTD_VERSION/libscroll_zstd.so
+
+ENV LD_LIBRARY_PATH=$SCROLL_LIB_PATH
+ENV CGO_LDFLAGS="-L$SCROLL_LIB_PATH -Wl,-rpath,$SCROLL_LIB_PATH"
+
+COPY --from=builder /bin/event_watcher /bin/
+WORKDIR /app
+ENTRYPOINT ["event_watcher"]

build/dockerfiles/event_watcher.Dockerfile.dockerignore

@@ -0,0 +1,5 @@
+assets/
+docs/
+l2geth/
+rpc-gateway/
+*target/*

build/dockerfiles/gas_oracle.Dockerfile

@@ -1,3 +1,6 @@
+ARG LIBSCROLL_ZSTD_VERSION=v0.0.0-rc0-ubuntu20.04
+ARG SCROLL_LIB_PATH=/scroll/lib
+
 # Download Go dependencies
 FROM scrolltech/go-rust-builder:go-1.21-rust-nightly-2023-12-03 as base
 
@@ -7,6 +10,7 @@ COPY ./rollup/go.* ./rollup/
 COPY ./common/go.* ./common/
 COPY ./coordinator/go.* ./coordinator/
 COPY ./database/go.* ./database/
+COPY ./prover/go.* ./prover/
 COPY ./tests/integration-test/go.* ./tests/integration-test/
 COPY ./bridge-history-api/go.* ./bridge-history-api/
 RUN go mod download -x
@@ -14,17 +18,39 @@ RUN go mod download -x
 # Build gas_oracle
 FROM base as builder
 
+ARG LIBSCROLL_ZSTD_VERSION
+ARG SCROLL_LIB_PATH
+
+RUN mkdir -p $SCROLL_LIB_PATH
+
+RUN apt-get -qq update && apt-get -qq install -y wget
+
+RUN wget -O $SCROLL_LIB_PATH/libzktrie.so https://github.com/scroll-tech/da-codec/releases/download/$LIBSCROLL_ZSTD_VERSION/libzktrie.so
+RUN wget -O $SCROLL_LIB_PATH/libscroll_zstd.so https://github.com/scroll-tech/da-codec/releases/download/$LIBSCROLL_ZSTD_VERSION/libscroll_zstd.so
+
+ENV LD_LIBRARY_PATH=$SCROLL_LIB_PATH
+ENV CGO_LDFLAGS="-L$SCROLL_LIB_PATH -Wl,-rpath,$SCROLL_LIB_PATH"
+
 RUN --mount=target=. \
     --mount=type=cache,target=/root/.cache/go-build \
-    cd /src/rollup/cmd/gas_oracle/ && CGO_LDFLAGS="-ldl" go build -v -p 4 -o /bin/gas_oracle
+    cd /src/rollup/cmd/gas_oracle/ && go build -v -p 4 -o /bin/gas_oracle
 
-# Pull gas_oracle into a second stage deploy ubuntu container
+# Pull gas_oracle into a second stage deploy alpine container
 FROM ubuntu:20.04
 
-RUN apt update && apt install ca-certificates -y
+ARG LIBSCROLL_ZSTD_VERSION
+ARG SCROLL_LIB_PATH
 
-ENV CGO_LDFLAGS="-ldl"
+RUN mkdir -p $SCROLL_LIB_PATH
+
+RUN apt-get -qq update && apt-get -qq install -y wget
+
+RUN wget -O $SCROLL_LIB_PATH/libzktrie.so https://github.com/scroll-tech/da-codec/releases/download/$LIBSCROLL_ZSTD_VERSION/libzktrie.so
+RUN wget -O $SCROLL_LIB_PATH/libscroll_zstd.so https://github.com/scroll-tech/da-codec/releases/download/$LIBSCROLL_ZSTD_VERSION/libscroll_zstd.so
+
+ENV LD_LIBRARY_PATH=$SCROLL_LIB_PATH
+ENV CGO_LDFLAGS="-L$SCROLL_LIB_PATH -Wl,-rpath,$SCROLL_LIB_PATH"
 
 COPY --from=builder /bin/gas_oracle /bin/
 WORKDIR /app
-ENTRYPOINT ["gas_oracle"]
+ENTRYPOINT ["gas_oracle"]

build/dockerfiles/intermediate/cuda-go-rust-builder.Dockerfile

@@ -29,14 +29,7 @@ RUN cargo install cargo-chef --locked --version ${CARGO_CHEF_TAG} \
 # Install Go
 ARG GO_VERSION
 RUN rm -rf /usr/local/go
-RUN if [ "$(uname -m)" = "x86_64" ]; then \
-    echo amd64 >/tmp/arch; \
-    elif [ "$(uname -m)" = "aarch64" ]; then \
-    echo arm64 >/tmp/arch; \
-    else \
-    echo "Unsupported architecture"; exit 1; \
-    fi
-RUN wget https://go.dev/dl/go${GO_VERSION}.1.linux-$(cat /tmp/arch).tar.gz
-RUN tar -C /usr/local -xzf go${GO_VERSION}.1.linux-$(cat /tmp/arch).tar.gz
-RUN rm go${GO_VERSION}.1.linux-$(cat /tmp/arch).tar.gz && rm /tmp/arch
+RUN wget https://go.dev/dl/go${GO_VERSION}.1.linux-amd64.tar.gz
+RUN tar -C /usr/local -xzf go${GO_VERSION}.1.linux-amd64.tar.gz
+RUN rm go${GO_VERSION}.1.linux-amd64.tar.gz
 ENV PATH="/usr/local/go/bin:${PATH}"

build/dockerfiles/intermediate/go-rust-builder.Dockerfile

@@ -25,14 +25,7 @@ RUN cargo install cargo-chef --locked --version ${CARGO_CHEF_TAG} \
 # Install Go
 ARG GO_VERSION
 RUN rm -rf /usr/local/go
-RUN if [ "$(uname -m)" = "x86_64" ]; then \
-    echo amd64 >/tmp/arch; \
-    elif [ "$(uname -m)" = "aarch64" ]; then \
-    echo arm64 >/tmp/arch; \
-    else \
-    echo "Unsupported architecture"; exit 1; \
-    fi
-RUN wget https://go.dev/dl/go${GO_VERSION}.1.linux-$(cat /tmp/arch).tar.gz
-RUN tar -C /usr/local -xzf go${GO_VERSION}.1.linux-$(cat /tmp/arch).tar.gz
-RUN rm go${GO_VERSION}.1.linux-$(cat /tmp/arch).tar.gz && rm /tmp/arch
+RUN wget https://go.dev/dl/go${GO_VERSION}.1.linux-amd64.tar.gz
+RUN tar -C /usr/local -xzf go${GO_VERSION}.1.linux-amd64.tar.gz
+RUN rm go${GO_VERSION}.1.linux-amd64.tar.gz
 ENV PATH="/usr/local/go/bin:${PATH}"

build/dockerfiles/rollup_relayer.Dockerfile

@@ -1,3 +1,6 @@
+ARG LIBSCROLL_ZSTD_VERSION=v0.0.0-rc0-ubuntu20.04
+ARG SCROLL_LIB_PATH=/scroll/lib
+
 # Download Go dependencies
 FROM scrolltech/go-rust-builder:go-1.21-rust-nightly-2023-12-03 as base
 
@@ -7,6 +10,7 @@ COPY ./rollup/go.* ./rollup/
 COPY ./common/go.* ./common/
 COPY ./coordinator/go.* ./coordinator/
 COPY ./database/go.* ./database/
+COPY ./prover/go.* ./prover/
 COPY ./tests/integration-test/go.* ./tests/integration-test/
 COPY ./bridge-history-api/go.* ./bridge-history-api/
 RUN go mod download -x
@@ -14,16 +18,38 @@ RUN go mod download -x
 # Build rollup_relayer
 FROM base as builder
 
+ARG LIBSCROLL_ZSTD_VERSION
+ARG SCROLL_LIB_PATH
+
+RUN mkdir -p $SCROLL_LIB_PATH
+
+RUN apt-get -qq update && apt-get -qq install -y wget
+
+RUN wget -O $SCROLL_LIB_PATH/libzktrie.so https://github.com/scroll-tech/da-codec/releases/download/$LIBSCROLL_ZSTD_VERSION/libzktrie.so
+RUN wget -O $SCROLL_LIB_PATH/libscroll_zstd.so https://github.com/scroll-tech/da-codec/releases/download/$LIBSCROLL_ZSTD_VERSION/libscroll_zstd.so
+
+ENV LD_LIBRARY_PATH=$SCROLL_LIB_PATH
+ENV CGO_LDFLAGS="-L$SCROLL_LIB_PATH -Wl,-rpath,$SCROLL_LIB_PATH"
+
 RUN --mount=target=. \
     --mount=type=cache,target=/root/.cache/go-build \
-    cd /src/rollup/cmd/rollup_relayer/ && CGO_LDFLAGS="-ldl" go build -v -p 4 -o /bin/rollup_relayer
+    cd /src/rollup/cmd/rollup_relayer/ && go build -v -p 4 -o /bin/rollup_relayer
 
-# Pull rollup_relayer into a second stage deploy ubuntu container
+# Pull rollup_relayer into a second stage deploy alpine container
 FROM ubuntu:20.04
 
-RUN apt update && apt install ca-certificates -y
+ARG LIBSCROLL_ZSTD_VERSION
+ARG SCROLL_LIB_PATH
 
-ENV CGO_LDFLAGS="-ldl"
+RUN mkdir -p $SCROLL_LIB_PATH
+
+RUN apt-get -qq update && apt-get -qq install -y wget
+
+RUN wget -O $SCROLL_LIB_PATH/libzktrie.so https://github.com/scroll-tech/da-codec/releases/download/$LIBSCROLL_ZSTD_VERSION/libzktrie.so
+RUN wget -O $SCROLL_LIB_PATH/libscroll_zstd.so https://github.com/scroll-tech/da-codec/releases/download/$LIBSCROLL_ZSTD_VERSION/libscroll_zstd.so
+
+ENV LD_LIBRARY_PATH=$SCROLL_LIB_PATH
+ENV CGO_LDFLAGS="-L$SCROLL_LIB_PATH -Wl,-rpath,$SCROLL_LIB_PATH"
 
 COPY --from=builder /bin/rollup_relayer /bin/
 WORKDIR /app

common/forks/forks.go

@@ -1,56 +1,89 @@
 package forks
 
 import (
+	"math"
 	"math/big"
+	"sort"
 
-	"github.com/scroll-tech/da-codec/encoding"
 	"github.com/scroll-tech/go-ethereum/params"
 )
 
-// GetHardforkName returns the name of the hardfork active at the given block height and timestamp.
-// It checks the chain configuration to determine which hardfork is active.
-func GetHardforkName(config *params.ChainConfig, blockHeight, blockTimestamp uint64) string {
-	if !config.IsBernoulli(new(big.Int).SetUint64(blockHeight)) {
-		return "homestead"
-	} else if !config.IsCurie(new(big.Int).SetUint64(blockHeight)) {
-		return "bernoulli"
-	} else if !config.IsDarwin(blockTimestamp) {
-		return "curie"
-	} else if !config.IsDarwinV2(blockTimestamp) {
-		return "darwin"
-	} else {
-		return "darwinV2"
+// CollectSortedForkHeights returns a sorted set of block numbers that one or more forks are activated on
+func CollectSortedForkHeights(config *params.ChainConfig) ([]uint64, map[uint64]bool, map[string]uint64) {
+	type nameFork struct {
+		name  string
+		block *big.Int
 	}
+
+	forkHeightNameMap := make(map[uint64]string)
+
+	for _, fork := range []nameFork{
+		{name: "homestead", block: config.HomesteadBlock},
+		{name: "daoFork", block: config.DAOForkBlock},
+		{name: "eip150", block: config.EIP150Block},
+		{name: "eip155", block: config.EIP155Block},
+		{name: "eip158", block: config.EIP158Block},
+		{name: "byzantium", block: config.ByzantiumBlock},
+		{name: "constantinople", block: config.ConstantinopleBlock},
+		{name: "petersburg", block: config.PetersburgBlock},
+		{name: "istanbul", block: config.IstanbulBlock},
+		{name: "muirGlacier", block: config.MuirGlacierBlock},
+		{name: "berlin", block: config.BerlinBlock},
+		{name: "london", block: config.LondonBlock},
+		{name: "arrowGlacier", block: config.ArrowGlacierBlock},
+		{name: "archimedes", block: config.ArchimedesBlock},
+		{name: "shanghai", block: config.ShanghaiBlock},
+		{name: "bernoulli", block: config.BernoulliBlock},
+		{name: "curie", block: config.CurieBlock},
+	} {
+		if fork.block == nil {
+			continue
+		}
+		height := fork.block.Uint64()
+
+		// only keep latest fork for at each height, discard the rest
+		forkHeightNameMap[height] = fork.name
+	}
+
+	forkHeightsMap := make(map[uint64]bool)
+	forkNameHeightMap := make(map[string]uint64)
+
+	for height, name := range forkHeightNameMap {
+		forkHeightsMap[height] = true
+		forkNameHeightMap[name] = height
+	}
+
+	var forkHeights []uint64
+	for height := range forkHeightsMap {
+		forkHeights = append(forkHeights, height)
+	}
+	sort.Slice(forkHeights, func(i, j int) bool {
+		return forkHeights[i] < forkHeights[j]
+	})
+	return forkHeights, forkHeightsMap, forkNameHeightMap
 }
 
-// GetCodecVersion returns the encoding codec version for the given block height and timestamp.
-// It determines the appropriate codec version based on the active hardfork.
-func GetCodecVersion(config *params.ChainConfig, blockHeight, blockTimestamp uint64) encoding.CodecVersion {
-	if !config.IsBernoulli(new(big.Int).SetUint64(blockHeight)) {
-		return encoding.CodecV0
-	} else if !config.IsCurie(new(big.Int).SetUint64(blockHeight)) {
-		return encoding.CodecV1
-	} else if !config.IsDarwin(blockTimestamp) {
-		return encoding.CodecV2
-	} else if !config.IsDarwinV2(blockTimestamp) {
-		return encoding.CodecV3
-	} else {
-		return encoding.CodecV4
+// BlocksUntilFork returns the number of blocks until the next fork
+// returns 0 if there is no fork scheduled for the future
+func BlocksUntilFork(blockHeight uint64, forkHeights []uint64) uint64 {
+	for _, forkHeight := range forkHeights {
+		if forkHeight > blockHeight {
+			return forkHeight - blockHeight
+		}
 	}
+	return 0
 }
 
-// GetMaxChunksPerBatch returns the maximum number of chunks allowed per batch for the given block height and timestamp.
-// This value may change depending on the active hardfork.
-func GetMaxChunksPerBatch(config *params.ChainConfig, blockHeight, blockTimestamp uint64) uint64 {
-	if !config.IsBernoulli(new(big.Int).SetUint64(blockHeight)) {
-		return 15
-	} else if !config.IsCurie(new(big.Int).SetUint64(blockHeight)) {
-		return 15
-	} else if !config.IsDarwin(blockTimestamp) {
-		return 45
-	} else if !config.IsDarwinV2(blockTimestamp) {
-		return 45
-	} else {
-		return 45
+// BlockRange returns the block range of the hard fork
+// Need ensure the forkHeights is incremental
+func BlockRange(currentForkHeight uint64, forkHeights []uint64) (from, to uint64) {
+	to = math.MaxInt64
+	for _, height := range forkHeights {
+		if currentForkHeight < height {
+			to = height
+			return
+		}
+		from = height
 	}
+	return
 }

common/forks/forks_test.go

@@ -0,0 +1,142 @@
+package forks
+
+import (
+	"math"
+	"math/big"
+	"testing"
+
+	"github.com/scroll-tech/go-ethereum/params"
+	"github.com/stretchr/testify/require"
+)
+
+func TestCollectSortedForkBlocks(t *testing.T) {
+	l, m, n := CollectSortedForkHeights(&params.ChainConfig{
+		ArchimedesBlock: big.NewInt(0),
+		ShanghaiBlock:   big.NewInt(3),
+		BernoulliBlock:  big.NewInt(3),
+		CurieBlock:      big.NewInt(4),
+	})
+	require.Equal(t, l, []uint64{
+		0,
+		3,
+		4,
+	})
+	require.Equal(t, map[uint64]bool{
+		3: true,
+		4: true,
+		0: true,
+	}, m)
+	require.Equal(t, map[string]uint64{
+		"archimedes": 0,
+		"bernoulli":  3,
+		"curie":      4,
+	}, n)
+}
+
+func TestBlocksUntilFork(t *testing.T) {
+	tests := map[string]struct {
+		block    uint64
+		forks    []uint64
+		expected uint64
+	}{
+		"NoFork": {
+			block:    44,
+			forks:    []uint64{},
+			expected: 0,
+		},
+		"BeforeFork": {
+			block:    0,
+			forks:    []uint64{1, 5},
+			expected: 1,
+		},
+		"OnFork": {
+			block:    1,
+			forks:    []uint64{1, 5},
+			expected: 4,
+		},
+		"OnLastFork": {
+			block:    5,
+			forks:    []uint64{1, 5},
+			expected: 0,
+		},
+		"AfterFork": {
+			block:    5,
+			forks:    []uint64{1, 5},
+			expected: 0,
+		},
+	}
+
+	for name, test := range tests {
+		t.Run(name, func(t *testing.T) {
+			require.Equal(t, test.expected, BlocksUntilFork(test.block, test.forks))
+		})
+	}
+}
+
+func TestBlockRange(t *testing.T) {
+	tests := []struct {
+		name         string
+		forkHeight   uint64
+		forkHeights  []uint64
+		expectedFrom uint64
+		expectedTo   uint64
+	}{
+		{
+			name:         "ToInfinite",
+			forkHeight:   300,
+			forkHeights:  []uint64{100, 200, 300},
+			expectedFrom: 300,
+			expectedTo:   math.MaxInt64,
+		},
+		{
+			name:         "To300",
+			forkHeight:   200,
+			forkHeights:  []uint64{100, 200, 300},
+			expectedFrom: 200,
+			expectedTo:   300,
+		},
+		{
+			name:         "To200",
+			forkHeight:   100,
+			forkHeights:  []uint64{100, 200, 300},
+			expectedFrom: 100,
+			expectedTo:   200,
+		},
+		{
+			name:         "To100",
+			forkHeight:   0,
+			forkHeights:  []uint64{100, 200, 300},
+			expectedFrom: 0,
+			expectedTo:   100,
+		},
+		{
+			name:         "To200-1",
+			forkHeight:   100,
+			forkHeights:  []uint64{100, 200},
+			expectedFrom: 100,
+			expectedTo:   200,
+		},
+		{
+			name:         "To2",
+			forkHeight:   1,
+			forkHeights:  []uint64{1, 2},
+			expectedFrom: 1,
+			expectedTo:   2,
+		},
+		{
+			name:         "ToInfinite-1",
+			forkHeight:   0,
+			forkHeights:  []uint64{0},
+			expectedFrom: 0,
+			expectedTo:   math.MaxInt64,
+		},
+	}
+
+	for _, test := range tests {
+		t.Run(test.name, func(t *testing.T) {
+			from, to := BlockRange(test.forkHeight, test.forkHeights)
+			require.Equal(t, test.expectedFrom, from)
+			require.Equal(t, test.expectedTo, to)
+		})
+	}
+}

common/go.mod

@@ -4,7 +4,7 @@ go 1.21
 
 require (
 	github.com/Masterminds/semver/v3 v3.2.1
-	github.com/bits-and-blooms/bitset v1.13.0
+	github.com/bits-and-blooms/bitset v1.12.0
 	github.com/docker/docker v26.1.0+incompatible
 	github.com/gin-contrib/pprof v1.4.0
 	github.com/gin-gonic/gin v1.9.1
@@ -13,8 +13,7 @@ require (
 	github.com/modern-go/reflect2 v1.0.2
 	github.com/orcaman/concurrent-map v1.0.0
 	github.com/prometheus/client_golang v1.19.0
-	github.com/scroll-tech/da-codec v0.0.0-20240730031611-1b736159d5cb
-	github.com/scroll-tech/go-ethereum v1.10.14-0.20240626125436-418bc6f728b6
+	github.com/scroll-tech/go-ethereum v1.10.14-0.20240426041101-a860446ebaea
 	github.com/stretchr/testify v1.9.0
 	github.com/testcontainers/testcontainers-go v0.30.0
 	github.com/testcontainers/testcontainers-go/modules/compose v0.30.0
@@ -78,7 +77,7 @@ require (
 	github.com/docker/go-units v0.5.0 // indirect
 	github.com/edsrzf/mmap-go v1.0.0 // indirect
 	github.com/emicklei/go-restful/v3 v3.10.1 // indirect
-	github.com/ethereum/c-kzg-4844 v1.0.2 // indirect
+	github.com/ethereum/c-kzg-4844/bindings/go v0.0.0-20230126171313-363c7d7593b4 // indirect
 	github.com/felixge/httpsnoop v1.0.4 // indirect
 	github.com/fjl/memsize v0.0.2 // indirect
 	github.com/fsnotify/fsevents v0.1.1 // indirect
@@ -120,7 +119,7 @@ require (
 	github.com/holiman/bloomfilter/v2 v2.0.3 // indirect
 	github.com/holiman/uint256 v1.2.4 // indirect
 	github.com/huin/goupnp v1.3.0 // indirect
-	github.com/iden3/go-iden3-crypto v0.0.16 // indirect
+	github.com/iden3/go-iden3-crypto v0.0.15 // indirect
 	github.com/imdario/mergo v0.3.16 // indirect
 	github.com/in-toto/in-toto-golang v0.5.0 // indirect
 	github.com/inconshreveable/mousetrap v1.1.0 // indirect
@@ -183,7 +182,7 @@ require (
 	github.com/rjeczalik/notify v0.9.1 // indirect
 	github.com/rs/cors v1.7.0 // indirect
 	github.com/russross/blackfriday/v2 v2.1.0 // indirect
-	github.com/scroll-tech/zktrie v0.8.4 // indirect
+	github.com/scroll-tech/zktrie v0.8.2 // indirect
 	github.com/secure-systems-lab/go-securesystemslib v0.4.0 // indirect
 	github.com/serialx/hashring v0.0.0-20190422032157-8b2912629002 // indirect
 	github.com/shibumi/go-pathspec v1.3.0 // indirect
@@ -195,12 +194,12 @@ require (
 	github.com/spf13/pflag v1.0.5 // indirect
 	github.com/spf13/viper v1.4.0 // indirect
 	github.com/status-im/keycard-go v0.2.0 // indirect
-	github.com/supranational/blst v0.3.12 // indirect
+	github.com/supranational/blst v0.3.11 // indirect
 	github.com/syndtr/goleveldb v1.0.1-0.20210819022825-2ae1ddf74ef7 // indirect
 	github.com/theupdateframework/notary v0.7.0 // indirect
 	github.com/tilt-dev/fsnotify v1.4.8-0.20220602155310-fff9c274a375 // indirect
-	github.com/tklauser/go-sysconf v0.3.14 // indirect
-	github.com/tklauser/numcpus v0.8.0 // indirect
+	github.com/tklauser/go-sysconf v0.3.12 // indirect
+	github.com/tklauser/numcpus v0.6.1 // indirect
 	github.com/tonistiigi/fsutil v0.0.0-20230825212630-f09800878302 // indirect
 	github.com/tonistiigi/units v0.0.0-20180711220420-6950e57a87ea // indirect
 	github.com/tonistiigi/vt100 v0.0.0-20230623042737-f9a4f7ef6531 // indirect
@@ -211,7 +210,7 @@ require (
 	github.com/xeipuuv/gojsonreference v0.0.0-20180127040603-bd5ef7bd5415 // indirect
 	github.com/xeipuuv/gojsonschema v1.2.0 // indirect
 	github.com/xrash/smetrics v0.0.0-20201216005158-039620a65673 // indirect
-	github.com/yusufpapurcu/wmi v1.2.4 // indirect
+	github.com/yusufpapurcu/wmi v1.2.3 // indirect
 	go.opentelemetry.io/contrib/instrumentation/google.golang.org/grpc/otelgrpc v0.45.0 // indirect
 	go.opentelemetry.io/contrib/instrumentation/net/http/httptrace/otelhttptrace v0.45.0 // indirect
 	go.opentelemetry.io/contrib/instrumentation/net/http/otelhttp v0.49.0 // indirect
@@ -230,17 +229,17 @@ require (
 	go.opentelemetry.io/proto/otlp v1.0.0 // indirect
 	go.uber.org/mock v0.4.0 // indirect
 	golang.org/x/arch v0.5.0 // indirect
-	golang.org/x/crypto v0.24.0 // indirect
+	golang.org/x/crypto v0.19.0 // indirect
 	golang.org/x/exp v0.0.0-20240112132812-db7319d0e0e3 // indirect
-	golang.org/x/mod v0.17.0 // indirect
-	golang.org/x/net v0.25.0 // indirect
+	golang.org/x/mod v0.16.0 // indirect
+	golang.org/x/net v0.20.0 // indirect
 	golang.org/x/oauth2 v0.16.0 // indirect
-	golang.org/x/sync v0.7.0 // indirect
-	golang.org/x/sys v0.21.0 // indirect
-	golang.org/x/term v0.21.0 // indirect
-	golang.org/x/text v0.16.0 // indirect
+	golang.org/x/sync v0.6.0 // indirect
+	golang.org/x/sys v0.17.0 // indirect
+	golang.org/x/term v0.17.0 // indirect
+	golang.org/x/text v0.14.0 // indirect
 	golang.org/x/time v0.3.0 // indirect
-	golang.org/x/tools v0.21.1-0.20240508182429-e35e4ccd0d2d // indirect
+	golang.org/x/tools v0.17.0 // indirect
 	google.golang.org/appengine v1.6.7 // indirect
 	google.golang.org/genproto v0.0.0-20230822172742-b8732ec3820d // indirect
 	google.golang.org/genproto/googleapis/api v0.0.0-20230822172742-b8732ec3820d // indirect

common/go.sum

@@ -70,8 +70,8 @@ github.com/beorn7/perks v1.0.1 h1:VlbKKnNfV8bJzeqoa4cOKqO6bYr3WgKZxO8Z16+hsOM=
 github.com/beorn7/perks v1.0.1/go.mod h1:G2ZrVWU2WbWT9wwq4/hrbKbnv/1ERSJQ0ibhJ6rlkpw=
 github.com/bitly/go-hostpool v0.1.0/go.mod h1:4gOCgp6+NZnVqlKyZ/iBZFTAJKembaVENUpMkpg42fw=
 github.com/bitly/go-simplejson v0.5.0/go.mod h1:cXHtHw4XUPsvGaxgjIAn8PhEWG9NfngEKAMDJEczWVA=
-github.com/bits-and-blooms/bitset v1.13.0 h1:bAQ9OPNFYbGHV6Nez0tmNI0RiEu7/hxlYJRUA0wFAVE=
-github.com/bits-and-blooms/bitset v1.13.0/go.mod h1:7hO7Gc7Pp1vODcmWvKMRA9BNmbv6a/7QIWpPxHddWR8=
+github.com/bits-and-blooms/bitset v1.12.0 h1:U/q1fAF7xXRhFCrhROzIfffYnu+dlS38vCZtmFVPHmA=
+github.com/bits-and-blooms/bitset v1.12.0/go.mod h1:7hO7Gc7Pp1vODcmWvKMRA9BNmbv6a/7QIWpPxHddWR8=
 github.com/bmizerany/assert v0.0.0-20160611221934-b7ed37b82869/go.mod h1:Ekp36dRnpXw/yCqJaO+ZrUyxD+3VXMFFr56k5XYrpB4=
 github.com/btcsuite/btcd v0.20.1-beta h1:Ik4hyJqN8Jfyv3S4AGBOmyouMsYE3EdYODkMbQjwPGw=
 github.com/btcsuite/btcd v0.20.1-beta/go.mod h1:wVuoA8VJLEcwgqHBwHmzLRazpKxTv13Px/pDuV7OomQ=
@@ -212,8 +212,8 @@ github.com/envoyproxy/protoc-gen-validate v0.1.0/go.mod h1:iSmxcyjqTsJpI2R4NaDN7
 github.com/envoyproxy/protoc-gen-validate v1.0.2 h1:QkIBuU5k+x7/QXPvPPnWXWlCdaBFApVqftFV6k087DA=
 github.com/envoyproxy/protoc-gen-validate v1.0.2/go.mod h1:GpiZQP3dDbg4JouG/NNS7QWXpgx6x8QiMKdmN72jogE=
 github.com/erikstmartin/go-testdb v0.0.0-20160219214506-8d10e4a1bae5/go.mod h1:a2zkGnVExMxdzMo3M0Hi/3sEU+cWnZpSni0O6/Yb/P0=
-github.com/ethereum/c-kzg-4844 v1.0.2 h1:8tV84BCEiPeOkiVgW9mpYBeBUir2bkCNVqxPwwVeO+s=
-github.com/ethereum/c-kzg-4844 v1.0.2/go.mod h1:VewdlzQmpT5QSrVhbBuGoCdFJkpaJlO1aQputP83wc0=
+github.com/ethereum/c-kzg-4844/bindings/go v0.0.0-20230126171313-363c7d7593b4 h1:B2mpK+MNqgPqk2/KNi1LbqwtZDy5F7iy0mynQiBr8VA=
+github.com/ethereum/c-kzg-4844/bindings/go v0.0.0-20230126171313-363c7d7593b4/go.mod h1:y4GA2JbAUama1S4QwYjC2hefgGLU8Ul0GMtL/ADMF1c=
 github.com/felixge/httpsnoop v1.0.4 h1:NFTV2Zj1bL4mc9sqWACXbQFVBBg2W3GPvqp8/ESS2Wg=
 github.com/felixge/httpsnoop v1.0.4/go.mod h1:m8KPJKqk1gH5J9DgRY2ASl2lWCfGKXixSwevea8zH2U=
 github.com/fjl/memsize v0.0.2 h1:27txuSD9or+NZlnOWdKUxeBzTAUkWCVh+4Gf2dWFOzA=
@@ -384,8 +384,8 @@ github.com/holiman/uint256 v1.2.4/go.mod h1:EOMSn4q6Nyt9P6efbI3bueV4e1b3dGlUCXei
 github.com/hpcloud/tail v1.0.0/go.mod h1:ab1qPbhIpdTxEkNHXyeSf5vhxWSCs/tWer42PpOxQnU=
 github.com/huin/goupnp v1.3.0 h1:UvLUlWDNpoUdYzb2TCn+MuTWtcjXKSza2n6CBdQ0xXc=
 github.com/huin/goupnp v1.3.0/go.mod h1:gnGPsThkYa7bFi/KWmEysQRf48l2dvR5bxr2OFckNX8=
-github.com/iden3/go-iden3-crypto v0.0.16 h1:zN867xiz6HgErXVIV/6WyteGcOukE9gybYTorBMEdsk=
-github.com/iden3/go-iden3-crypto v0.0.16/go.mod h1:dLpM4vEPJ3nDHzhWFXDjzkn1qHoBeOT/3UEhXsEsP3E=
+github.com/iden3/go-iden3-crypto v0.0.15 h1:4MJYlrot1l31Fzlo2sF56u7EVFeHHJkxGXXZCtESgK4=
+github.com/iden3/go-iden3-crypto v0.0.15/go.mod h1:dLpM4vEPJ3nDHzhWFXDjzkn1qHoBeOT/3UEhXsEsP3E=
 github.com/imdario/mergo v0.3.16 h1:wwQJbIsHYGMUyLSPrEq1CT16AhnhNJQ51+4fdHUnCl4=
 github.com/imdario/mergo v0.3.16/go.mod h1:WBLT9ZmE3lPoWsEzCh9LPo3TiwVN+ZKEjmz+hD27ysY=
 github.com/in-toto/in-toto-golang v0.5.0 h1:hb8bgwr0M2hGdDsLjkJ3ZqJ8JFLL/tgYdAxF/XEFBbY=
@@ -633,12 +633,10 @@ github.com/rs/cors v1.7.0 h1:+88SsELBHx5r+hZ8TCkggzSstaWNbDvThkVK8H6f9ik=
 github.com/rs/cors v1.7.0/go.mod h1:gFx+x8UowdsKA9AchylcLynDq+nNFfI8FkUZdN/jGCU=
 github.com/russross/blackfriday/v2 v2.1.0 h1:JIOH55/0cWyOuilr9/qlrm0BSXldqnqwMsf35Ld67mk=
 github.com/russross/blackfriday/v2 v2.1.0/go.mod h1:+Rmxgy9KzJVeS9/2gXHxylqXiyQDYRxCVz55jmeOWTM=
-github.com/scroll-tech/da-codec v0.0.0-20240730031611-1b736159d5cb h1:uOKdmDT0LsuS3gfynEjR4zA3Ooh6p2Z3O+IMRj2r8LA=
-github.com/scroll-tech/da-codec v0.0.0-20240730031611-1b736159d5cb/go.mod h1:D6XEESeNVJkQJlv3eK+FyR+ufPkgVQbJzERylQi53Bs=
-github.com/scroll-tech/go-ethereum v1.10.14-0.20240626125436-418bc6f728b6 h1:Q8YyvrcPIcXQwE4ucm4bqmPh6TP6IB1GUTXripf2WyQ=
-github.com/scroll-tech/go-ethereum v1.10.14-0.20240626125436-418bc6f728b6/go.mod h1:byf/mZ8jLYUCnUePTicjJWn+RvKdxDn7buS6glTnMwQ=
-github.com/scroll-tech/zktrie v0.8.4 h1:UagmnZ4Z3ITCk+aUq9NQZJNAwnWl4gSxsLb2Nl7IgRE=
-github.com/scroll-tech/zktrie v0.8.4/go.mod h1:XvNo7vAk8yxNyTjBDj5WIiFzYW4bx/gJ78+NK6Zn6Uk=
+github.com/scroll-tech/go-ethereum v1.10.14-0.20240426041101-a860446ebaea h1:CH1WXWrpEpLaP3N+bFs2a1xdE0+lRm1AuJQb5YvE6Ls=
+github.com/scroll-tech/go-ethereum v1.10.14-0.20240426041101-a860446ebaea/go.mod h1:i4VBgWoaW/y0D8MmQb7hSOulyw1dKhuiSFAbznwivCA=
+github.com/scroll-tech/zktrie v0.8.2 h1:UMuIfA+jdgWMLmTgTL64Emo+zzMOdcnH0+eYdDcshxQ=
+github.com/scroll-tech/zktrie v0.8.2/go.mod h1:XvNo7vAk8yxNyTjBDj5WIiFzYW4bx/gJ78+NK6Zn6Uk=
 github.com/secure-systems-lab/go-securesystemslib v0.4.0 h1:b23VGrQhTA8cN2CbBw7/FulN9fTtqYUdS5+Oxzt+DUE=
 github.com/secure-systems-lab/go-securesystemslib v0.4.0/go.mod h1:FGBZgq2tXWICsxWQW1msNf49F0Pf2Op5Htayx335Qbs=
 github.com/serialx/hashring v0.0.0-20190422032157-8b2912629002 h1:ka9QPuQg2u4LGipiZGsgkg3rJCo4iIUCy75FddM0GRQ=
@@ -702,8 +700,8 @@ github.com/stretchr/testify v1.8.2/go.mod h1:w2LPCIKwWwSfY2zedu0+kehJoqGctiVI29o
 github.com/stretchr/testify v1.8.4/go.mod h1:sz/lmYIOXD/1dqDmKjjqLyZ2RngseejIcXlSw2iwfAo=
 github.com/stretchr/testify v1.9.0 h1:HtqpIVDClZ4nwg75+f6Lvsy/wHu+3BoSGCbBAcpTsTg=
 github.com/stretchr/testify v1.9.0/go.mod h1:r2ic/lqez/lEtzL7wO/rwa5dbSLXVDPFyf8C91i36aY=
-github.com/supranational/blst v0.3.12 h1:Vfas2U2CFHhniv2QkUm2OVa1+pGTdqtpqm9NnhUUbZ8=
-github.com/supranational/blst v0.3.12/go.mod h1:jZJtfjgudtNl4en1tzwPIV3KjUnQUvG3/j+w+fVonLw=
+github.com/supranational/blst v0.3.11 h1:LyU6FolezeWAhvQk0k6O/d49jqgO52MSDDfYgbeoEm4=
+github.com/supranational/blst v0.3.11/go.mod h1:jZJtfjgudtNl4en1tzwPIV3KjUnQUvG3/j+w+fVonLw=
 github.com/syndtr/goleveldb v1.0.1-0.20210819022825-2ae1ddf74ef7 h1:epCh84lMvA70Z7CTTCmYQn2CKbY8j86K7/FAIr141uY=
 github.com/syndtr/goleveldb v1.0.1-0.20210819022825-2ae1ddf74ef7/go.mod h1:q4W45IWZaF22tdD+VEXcAWRA037jwmWEB5VWYORlTpc=
 github.com/testcontainers/testcontainers-go v0.30.0 h1:jmn/XS22q4YRrcMwWg0pAwlClzs/abopbsBzrepyc4E=
@@ -716,12 +714,10 @@ github.com/theupdateframework/notary v0.7.0 h1:QyagRZ7wlSpjT5N2qQAh/pN+DVqgekv4D
 github.com/theupdateframework/notary v0.7.0/go.mod h1:c9DRxcmhHmVLDay4/2fUYdISnHqbFDGRSlXPO0AhYWw=
 github.com/tilt-dev/fsnotify v1.4.8-0.20220602155310-fff9c274a375 h1:QB54BJwA6x8QU9nHY3xJSZR2kX9bgpZekRKGkLTmEXA=
 github.com/tilt-dev/fsnotify v1.4.8-0.20220602155310-fff9c274a375/go.mod h1:xRroudyp5iVtxKqZCrA6n2TLFRBf8bmnjr1UD4x+z7g=
+github.com/tklauser/go-sysconf v0.3.12 h1:0QaGUFOdQaIVdPgfITYzaTegZvdCjmYO52cSFAEVmqU=
 github.com/tklauser/go-sysconf v0.3.12/go.mod h1:Ho14jnntGE1fpdOqQEEaiKRpvIavV0hSfmBq8nJbHYI=
-github.com/tklauser/go-sysconf v0.3.14 h1:g5vzr9iPFFz24v2KZXs/pvpvh8/V9Fw6vQK5ZZb78yU=
-github.com/tklauser/go-sysconf v0.3.14/go.mod h1:1ym4lWMLUOhuBOPGtRcJm7tEGX4SCYNEEEtghGG/8uY=
+github.com/tklauser/numcpus v0.6.1 h1:ng9scYS7az0Bk4OZLvrNXNSAO2Pxr1XXRAPyjhIx+Fk=
 github.com/tklauser/numcpus v0.6.1/go.mod h1:1XfjsgE2zo8GVw7POkMbHENHzVg3GzmoZ9fESEdAacY=
-github.com/tklauser/numcpus v0.8.0 h1:Mx4Wwe/FjZLeQsK/6kt2EOepwwSl7SmJrK5bV/dXYgY=
-github.com/tklauser/numcpus v0.8.0/go.mod h1:ZJZlAY+dmR4eut8epnzf0u/VwodKmryxR8txiloSqBE=
 github.com/tmc/grpc-websocket-proxy v0.0.0-20190109142713-0ad062ec5ee5/go.mod h1:ncp9v5uamzpCO7NfCPTXjqaC+bZgJeR0sMTm6dMHP7U=
 github.com/tonistiigi/fsutil v0.0.0-20230825212630-f09800878302 h1:ZT8ibgassurSISJ1Pj26NsM3vY2jxFZn63Nd/TpHmRw=
 github.com/tonistiigi/fsutil v0.0.0-20230825212630-f09800878302/go.mod h1:9kMVqMyQ/Sx2df5LtnGG+nbrmiZzCS7V6gjW3oGHsvI=
@@ -758,9 +754,8 @@ github.com/xrash/smetrics v0.0.0-20201216005158-039620a65673/go.mod h1:N3UwUGtsr
 github.com/yuin/goldmark v1.1.27/go.mod h1:3hX8gzYuyVAZsxl0MRgGTJEmQBFcNTphYh9decYSb74=
 github.com/yuin/goldmark v1.2.1/go.mod h1:3hX8gzYuyVAZsxl0MRgGTJEmQBFcNTphYh9decYSb74=
 github.com/yuin/goldmark v1.4.13/go.mod h1:6yULJ656Px+3vBD8DxQVa3kxgyrAnzto9xy5taEt/CY=
+github.com/yusufpapurcu/wmi v1.2.3 h1:E1ctvB7uKFMOJw3fdOW32DwGE9I7t++CRUEMKvFoFiw=
 github.com/yusufpapurcu/wmi v1.2.3/go.mod h1:SBZ9tNy3G9/m5Oi98Zks0QjeHVDvuK0qfxQmPyzfmi0=
-github.com/yusufpapurcu/wmi v1.2.4 h1:zFUKzehAFReQwLys1b/iSMl+JQGSCSjtVqQn9bBrPo0=
-github.com/yusufpapurcu/wmi v1.2.4/go.mod h1:SBZ9tNy3G9/m5Oi98Zks0QjeHVDvuK0qfxQmPyzfmi0=
 github.com/zmap/zcrypto v0.0.0-20230310154051-c8b263fd8300 h1:DZH5n7L3L8RxKdSyJHZt7WePgwdhHnPhQFdQSJaHF+o=
 github.com/zmap/zcrypto v0.0.0-20230310154051-c8b263fd8300/go.mod h1:mOd4yUMgn2fe2nV9KXsa9AyQBFZGzygVPovsZR+Rl5w=
 github.com/zmap/zlint/v3 v3.5.0 h1:Eh2B5t6VKgVH0DFmTwOqE50POvyDhUaU9T2mJOe1vfQ=
@@ -820,8 +815,8 @@ golang.org/x/crypto v0.0.0-20200622213623-75b288015ac9/go.mod h1:LzIPMQfyMNhhGPh
 golang.org/x/crypto v0.0.0-20201117144127-c1f2f97bffc9/go.mod h1:jdWPYTVW3xRLrWPugEBEK3UY2ZEsg3UU495nc5E+M+I=
 golang.org/x/crypto v0.0.0-20210711020723-a769d52b0f97/go.mod h1:GvvjBRRGRdwPK5ydBHafDWAxML/pGHZbMvKqRZ5+Abc=
 golang.org/x/crypto v0.0.0-20210921155107-089bfa567519/go.mod h1:GvvjBRRGRdwPK5ydBHafDWAxML/pGHZbMvKqRZ5+Abc=
-golang.org/x/crypto v0.24.0 h1:mnl8DM0o513X8fdIkmyFE/5hTYxbwYOjDS/+rK6qpRI=
-golang.org/x/crypto v0.24.0/go.mod h1:Z1PMYSOR5nyMcyAVAIQSKCDwalqy85Aqn1x3Ws4L5DM=
+golang.org/x/crypto v0.19.0 h1:ENy+Az/9Y1vSrlrvBSyna3PITt4tiZLf7sgCjZBX7Wo=
+golang.org/x/crypto v0.19.0/go.mod h1:Iy9bg/ha4yyC70EfRS8jz+B6ybOBKMaSxLj6P6oBDfU=
 golang.org/x/exp v0.0.0-20190121172915-509febef88a4/go.mod h1:CJ0aWSM057203Lf6IL+f9T1iT9GByDxfZKAQTCR3kQA=
 golang.org/x/exp v0.0.0-20240112132812-db7319d0e0e3 h1:hNQpMuAJe5CtcUqCXaWga3FHu+kQvCqcsoVaQgSV60o=
 golang.org/x/exp v0.0.0-20240112132812-db7319d0e0e3/go.mod h1:idGWGoKP1toJGkd5/ig9ZLuPcZBC3ewk7SzmH0uou08=
@@ -831,8 +826,8 @@ golang.org/x/lint v0.0.0-20190313153728-d0100b6bd8b3/go.mod h1:6SW0HCj/g11FgYtHl
 golang.org/x/mod v0.2.0/go.mod h1:s0Qsj1ACt9ePp/hMypM3fl4fZqREWJwdYDEqhRiZZUA=
 golang.org/x/mod v0.3.0/go.mod h1:s0Qsj1ACt9ePp/hMypM3fl4fZqREWJwdYDEqhRiZZUA=
 golang.org/x/mod v0.6.0-dev.0.20220419223038-86c51ed26bb4/go.mod h1:jJ57K6gSWd91VN4djpZkiMVwK6gcyfeH4XE8wZrZaV4=
-golang.org/x/mod v0.17.0 h1:zY54UmvipHiNd+pm+m0x9KhZ9hl1/7QNMyxXbc6ICqA=
-golang.org/x/mod v0.17.0/go.mod h1:hTbmBsO62+eylJbnUtE2MGJUyE7QWk4xUqPFrRgJ+7c=
+golang.org/x/mod v0.16.0 h1:QX4fJ0Rr5cPQCF7O9lh9Se4pmwfwskqZfq5moyldzic=
+golang.org/x/mod v0.16.0/go.mod h1:hTbmBsO62+eylJbnUtE2MGJUyE7QWk4xUqPFrRgJ+7c=
 golang.org/x/net v0.0.0-20180724234803-3673e40ba225/go.mod h1:mL1N/T3taQHkDXs73rZJwtUhF3w3ftmwwsq0BUmARs4=
 golang.org/x/net v0.0.0-20180826012351-8a410e7b638d/go.mod h1:mL1N/T3taQHkDXs73rZJwtUhF3w3ftmwwsq0BUmARs4=
 golang.org/x/net v0.0.0-20180906233101-161cd47e91fd/go.mod h1:mL1N/T3taQHkDXs73rZJwtUhF3w3ftmwwsq0BUmARs4=
@@ -851,8 +846,8 @@ golang.org/x/net v0.0.0-20200813134508-3edf25e44fcc/go.mod h1:/O7V0waA8r7cgGh81R
 golang.org/x/net v0.0.0-20201021035429-f5854403a974/go.mod h1:sp8m0HH+o8qH0wwXwYZr8TS3Oi6o0r6Gce1SSxlDquU=
 golang.org/x/net v0.0.0-20210226172049-e18ecbb05110/go.mod h1:m0MpNAwzfU5UDzcl9v0D8zg8gWTRqZa9RBIspLL5mdg=
 golang.org/x/net v0.0.0-20220722155237-a158d28d115b/go.mod h1:XRhObCWvk6IyKnWLug+ECip1KBveYUHfp+8e9klMJ9c=
-golang.org/x/net v0.25.0 h1:d/OCCoBEUq33pjydKrGQhw7IlUPI2Oylr+8qLx49kac=
-golang.org/x/net v0.25.0/go.mod h1:JkAGAh7GEvH74S6FOH42FLoXpXbE/aqXSrIQjXgsiwM=
+golang.org/x/net v0.20.0 h1:aCL9BSgETF1k+blQaYUBx9hJ9LOGP3gAVemcZlf1Kpo=
+golang.org/x/net v0.20.0/go.mod h1:z8BVo6PvndSri0LbOE3hAn0apkU+1YvI6E70E9jsnvY=
 golang.org/x/oauth2 v0.0.0-20180821212333-d2e6202438be/go.mod h1:N/0e6XlmueqKjAGxoOufVs8QHGRruUQn6yWY3a++T0U=
 golang.org/x/oauth2 v0.16.0 h1:aDkGMBSYxElaoP81NpoUoz2oo2R2wHdZpGToUxfyQrQ=
 golang.org/x/oauth2 v0.16.0/go.mod h1:hqZ+0LWXsiVoZpeld6jVt06P3adbS2Uu911W1SsJv2o=
@@ -864,8 +859,8 @@ golang.org/x/sync v0.0.0-20190911185100-cd5d95a43a6e/go.mod h1:RxMgew5VJxzue5/jJ
 golang.org/x/sync v0.0.0-20201020160332-67f06af15bc9/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM=
 golang.org/x/sync v0.0.0-20210220032951-036812b2e83c/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM=
 golang.org/x/sync v0.0.0-20220722155255-886fb9371eb4/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM=
-golang.org/x/sync v0.7.0 h1:YsImfSBoP9QPYL0xyKJPq0gcaJdG3rInoqxTWbfQu9M=
-golang.org/x/sync v0.7.0/go.mod h1:Czt+wKu1gCyEFDUtn0jG5QVvpJ6rzVqr5aXyt9drQfk=
+golang.org/x/sync v0.6.0 h1:5BMeUDZ7vkXGfEr1x9B4bRcTH4lpkTkpdh0T/J+qjbQ=
+golang.org/x/sync v0.6.0/go.mod h1:Czt+wKu1gCyEFDUtn0jG5QVvpJ6rzVqr5aXyt9drQfk=
 golang.org/x/sys v0.0.0-20180830151530-49385e6e1522/go.mod h1:STP8DvDyc/dI5b8T5hshtkjS+E42TnysNCUPdjciGhY=
 golang.org/x/sys v0.0.0-20180905080454-ebe1bf3edb33/go.mod h1:STP8DvDyc/dI5b8T5hshtkjS+E42TnysNCUPdjciGhY=
 golang.org/x/sys v0.0.0-20180909124046-d0be0721c37e/go.mod h1:STP8DvDyc/dI5b8T5hshtkjS+E42TnysNCUPdjciGhY=
@@ -906,21 +901,21 @@ golang.org/x/sys v0.6.0/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
 golang.org/x/sys v0.8.0/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
 golang.org/x/sys v0.11.0/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
 golang.org/x/sys v0.15.0/go.mod h1:/VUhepiaJMQUp4+oa/7Zr1D23ma6VTLIYjOOTFZPUcA=
-golang.org/x/sys v0.21.0 h1:rF+pYz3DAGSQAxAu1CbC7catZg4ebC4UIeIhKxBZvws=
-golang.org/x/sys v0.21.0/go.mod h1:/VUhepiaJMQUp4+oa/7Zr1D23ma6VTLIYjOOTFZPUcA=
+golang.org/x/sys v0.17.0 h1:25cE3gD+tdBA7lp7QfhuV+rJiE9YXTcS3VG1SqssI/Y=
+golang.org/x/sys v0.17.0/go.mod h1:/VUhepiaJMQUp4+oa/7Zr1D23ma6VTLIYjOOTFZPUcA=
 golang.org/x/term v0.0.0-20201117132131-f5c789dd3221/go.mod h1:Nr5EML6q2oocZ2LXRh80K7BxOlk5/8JxuGnuhpl+muw=
 golang.org/x/term v0.0.0-20201126162022-7de9c90e9dd1/go.mod h1:bj7SfCRtBDWHUb9snDiAeCFNEtKQo2Wmx5Cou7ajbmo=
 golang.org/x/term v0.0.0-20210927222741-03fcf44c2211/go.mod h1:jbD1KX2456YbFQfuXm/mYQcufACuNUgVhRMnK/tPxf8=
-golang.org/x/term v0.21.0 h1:WVXCp+/EBEHOj53Rvu+7KiT/iElMrO8ACK16SMZ3jaA=
-golang.org/x/term v0.21.0/go.mod h1:ooXLefLobQVslOqselCNF4SxFAaoS6KujMbsGzSDmX0=
+golang.org/x/term v0.17.0 h1:mkTF7LCd6WGJNL3K1Ad7kwxNfYAW6a8a8QqtMblp/4U=
+golang.org/x/term v0.17.0/go.mod h1:lLRBjIVuehSbZlaOtGMbcMncT+aqLLLmKrsjNrUguwk=
 golang.org/x/text v0.3.0/go.mod h1:NqM8EUOU14njkJ3fqMW+pc6Ldnwhi/IjpwHt7yyuwOQ=
 golang.org/x/text v0.3.2/go.mod h1:bEr9sfX3Q8Zfm5fL9x+3itogRgK3+ptLWKqgva+5dAk=
 golang.org/x/text v0.3.3/go.mod h1:5Zoc/QRtKVWzQhOtBMvqHzDpF6irO9z98xDceosuGiQ=
 golang.org/x/text v0.3.6/go.mod h1:5Zoc/QRtKVWzQhOtBMvqHzDpF6irO9z98xDceosuGiQ=
 golang.org/x/text v0.3.7/go.mod h1:u+2+/6zg+i71rQMx5EYifcz6MCKuco9NR6JIITiCfzQ=
 golang.org/x/text v0.4.0/go.mod h1:mrYo+phRRbMaCq/xk9113O4dZlRixOauAjOtrjsXDZ8=
-golang.org/x/text v0.16.0 h1:a94ExnEXNtEwYLGJSIUxnWoxoRz/ZcCsV63ROupILh4=
-golang.org/x/text v0.16.0/go.mod h1:GhwF1Be+LQoKShO3cGOHzqOgRrGaYc9AvblQOmPVHnI=
+golang.org/x/text v0.14.0 h1:ScX5w1eTa3QqT8oi6+ziP7dTV1S2+ALU0bI+0zXKWiQ=
+golang.org/x/text v0.14.0/go.mod h1:18ZOQIKpY8NJVqYksKHtTdi31H5itFRjB5/qKTNYzSU=
 golang.org/x/time v0.0.0-20190308202827-9d24e82272b4/go.mod h1:tRJNPiyCQ0inRvYxbN9jk5I+vvW/OXSQhTDSoE431IQ=
 golang.org/x/time v0.3.0 h1:rg5rLMjNzMS1RkNLzCG38eapWhnYLFYXDXj2gOlr8j4=
 golang.org/x/time v0.3.0/go.mod h1:tRJNPiyCQ0inRvYxbN9jk5I+vvW/OXSQhTDSoE431IQ=
@@ -935,8 +930,8 @@ golang.org/x/tools v0.0.0-20200619180055-7c47624df98f/go.mod h1:EkVYQZoAsY45+roY
 golang.org/x/tools v0.0.0-20201224043029-2b0845dc783e/go.mod h1:emZCQorbCU4vsT4fOWvOPXz4eW1wZW4PmDk9uLelYpA=
 golang.org/x/tools v0.0.0-20210106214847-113979e3529a/go.mod h1:emZCQorbCU4vsT4fOWvOPXz4eW1wZW4PmDk9uLelYpA=
 golang.org/x/tools v0.1.12/go.mod h1:hNGJHUnrk76NpqgfD5Aqm5Crs+Hm0VOH/i9J2+nxYbc=
-golang.org/x/tools v0.21.1-0.20240508182429-e35e4ccd0d2d h1:vU5i/LfpvrRCpgM/VPfJLg5KjxD3E+hfT1SH+d9zLwg=
-golang.org/x/tools v0.21.1-0.20240508182429-e35e4ccd0d2d/go.mod h1:aiJjzUbINMkxbQROHiO6hDPo2LHcIPhhQsa9DLh0yGk=
+golang.org/x/tools v0.17.0 h1:FvmRgNOcs3kOa+T20R1uhfP9F6HgG2mfxDv1vrx1Htc=
+golang.org/x/tools v0.17.0/go.mod h1:xsh6VxdV005rRVaS6SSAf9oiAqljS7UZUacMZ8Bnsps=
 golang.org/x/xerrors v0.0.0-20190717185122-a985d3407aa7/go.mod h1:I/5z698sn9Ka8TeJc9MKroUUfqBBauWjQqLJ2OPfmY0=
 golang.org/x/xerrors v0.0.0-20191011141410-1b5146add898/go.mod h1:I/5z698sn9Ka8TeJc9MKroUUfqBBauWjQqLJ2OPfmY0=
 golang.org/x/xerrors v0.0.0-20191204190536-9bdfabe68543/go.mod h1:I/5z698sn9Ka8TeJc9MKroUUfqBBauWjQqLJ2OPfmY0=

common/libzkp/.gitignore

@@ -1,4 +0,0 @@
-outputs
-libzkp.so
-test_zkp_test/
-*log

common/libzkp/e2e-test.sh

@@ -1,30 +0,0 @@
-set -xeu
-set -o pipefail
-
-export CHAIN_ID=534352
-export RUST_BACKTRACE=full
-export RUST_LOG=debug
-export RUST_MIN_STACK=100000000
-export PROVER_OUTPUT_DIR=test_zkp_test
-export SCROLL_PROVER_ASSETS_DIR=/assets/test_assets
-export DARWIN_V2_TEST_DIR=/assets
-#export LD_LIBRARY_PATH=/:/usr/local/cuda/lib64
-
-mkdir -p $PROVER_OUTPUT_DIR
-
-REPO=$(realpath ../..)
-
-function build_test_bins() {
-    cd $REPO/prover
-    make tests_binary
-    cd $REPO/coordinator
-    make libzkp
-    go test -tags="gpu ffi" -timeout 0 -c ./internal/logic/verifier
-    cd $REPO/common/libzkp
-}
-
-build_test_bins
-rm -rf $PROVER_OUTPUT_DIR/*
-#rm -rf prover.log verifier.log
-$REPO/prover/prover.test --exact zk_circuits_handler::darwin_v2::tests::test_circuits 2>&1 | tee prover.log
-$REPO/coordinator/verifier.test -test.v 2>&1 | tee verifier.log

common/libzkp/impl/Cargo.toml

@@ -13,6 +13,8 @@ halo2curves = { git = "https://github.com/scroll-tech/halo2curves", branch = "v0
 ethers-core = { git = "https://github.com/scroll-tech/ethers-rs.git", branch = "v2.0.7" }
 ethers-providers = { git = "https://github.com/scroll-tech/ethers-rs.git", branch = "v2.0.7" }
 ethers-signers  = { git = "https://github.com/scroll-tech/ethers-rs.git", branch = "v2.0.7" }
+#ethers-etherscan = { git = "https://github.com/scroll-tech/ethers-rs.git", branch = "v2.0.7" }
+#ethers = { git = "https://github.com/scroll-tech/ethers-rs.git", branch = "v2.0.7" }
 [patch."https://github.com/privacy-scaling-explorations/halo2.git"]
 halo2_proofs = { git = "https://github.com/scroll-tech/halo2.git", branch = "v1.1"  }
 [patch."https://github.com/privacy-scaling-explorations/poseidon.git"]
@@ -23,11 +25,7 @@ bls12_381 = { git = "https://github.com/scroll-tech/bls12_381", branch = "feat/i
 [dependencies]
 halo2_proofs = { git = "https://github.com/scroll-tech/halo2.git", branch = "v1.1" }
 snark-verifier-sdk = { git = "https://github.com/scroll-tech/snark-verifier", branch = "develop", default-features = false, features = ["loader_halo2", "loader_evm", "halo2-pse"] }
-
-# darwin
-prover_v4 = { git = "https://github.com/scroll-tech/zkevm-circuits.git", tag = "v0.12.2", package = "prover", default-features = false, features = ["parallel_syn", "scroll"] }
-# darwin_v2
-prover_v5 = { git = "https://github.com/scroll-tech/zkevm-circuits.git", tag = "v0.13.1", package = "prover", default-features = false, features = ["parallel_syn", "scroll"] }
+prover = { git = "https://github.com/scroll-tech/zkevm-circuits.git", tag = "v0.10.3", default-features = false, features = ["parallel_syn", "scroll", "shanghai"] }
 
 base64 = "0.13.0"
 env_logger = "0.9.0"
@@ -37,7 +35,6 @@ once_cell = "1.19"
 serde = "1.0"
 serde_derive = "1.0"
 serde_json = "1.0.66"
-anyhow = "1.0.86"
 
 [profile.test]
 opt-level = 3

common/libzkp/impl/Makefile

@@ -1,8 +1,5 @@
 .PHONY: help fmt clippy test test-ci test-all
 
-build:
-	@cargo build --release
-
 fmt:
 	@cargo fmt --all -- --check
 

common/libzkp/impl/src/batch.rs

@@ -0,0 +1,194 @@
+use crate::{
+    types::{CheckChunkProofsResponse, ProofResult},
+    utils::{
+        c_char_to_str, c_char_to_vec, file_exists, panic_catch, string_to_c_char, vec_to_c_char,
+        OUTPUT_DIR,
+    },
+};
+use libc::c_char;
+use prover::{
+    aggregator::{Prover, Verifier},
+    consts::AGG_VK_FILENAME,
+    utils::{chunk_trace_to_witness_block, init_env_and_log},
+    BatchProof, BlockTrace, ChunkHash, ChunkProof,
+};
+use snark_verifier_sdk::verify_evm_calldata;
+use std::{cell::OnceCell, env, ptr::null};
+
+static mut PROVER: OnceCell<Prover> = OnceCell::new();
+static mut VERIFIER: OnceCell<Verifier> = OnceCell::new();
+
+/// # Safety
+#[no_mangle]
+pub unsafe extern "C" fn init_batch_prover(params_dir: *const c_char, assets_dir: *const c_char) {
+    init_env_and_log("ffi_batch_prove");
+
+    let params_dir = c_char_to_str(params_dir);
+    let assets_dir = c_char_to_str(assets_dir);
+
+    // TODO: add a settings in scroll-prover.
+    env::set_var("SCROLL_PROVER_ASSETS_DIR", assets_dir);
+
+    // VK file must exist, it is optional and logged as a warning in prover.
+    if !file_exists(assets_dir, &AGG_VK_FILENAME) {
+        panic!("{} must exist in folder {}", *AGG_VK_FILENAME, assets_dir);
+    }
+
+    let prover = Prover::from_dirs(params_dir, assets_dir);
+
+    PROVER.set(prover).unwrap();
+}
+
+/// # Safety
+#[no_mangle]
+pub unsafe extern "C" fn init_batch_verifier(params_dir: *const c_char, assets_dir: *const c_char) {
+    init_env_and_log("ffi_batch_verify");
+
+    let params_dir = c_char_to_str(params_dir);
+    let assets_dir = c_char_to_str(assets_dir);
+
+    // TODO: add a settings in scroll-prover.
+    env::set_var("SCROLL_PROVER_ASSETS_DIR", assets_dir);
+    let verifier = Verifier::from_dirs(params_dir, assets_dir);
+
+    VERIFIER.set(verifier).unwrap();
+}
+
+/// # Safety
+#[no_mangle]
+pub unsafe extern "C" fn get_batch_vk() -> *const c_char {
+    let vk_result = panic_catch(|| PROVER.get_mut().unwrap().get_vk());
+
+    vk_result
+        .ok()
+        .flatten()
+        .map_or(null(), |vk| string_to_c_char(base64::encode(vk)))
+}
+
+/// # Safety
+#[no_mangle]
+pub unsafe extern "C" fn check_chunk_proofs(chunk_proofs: *const c_char) -> *const c_char {
+    let check_result: Result<bool, String> = panic_catch(|| {
+        let chunk_proofs = c_char_to_vec(chunk_proofs);
+        let chunk_proofs = serde_json::from_slice::<Vec<ChunkProof>>(&chunk_proofs)
+            .map_err(|e| format!("failed to deserialize chunk proofs: {e:?}"))?;
+
+        if chunk_proofs.is_empty() {
+            return Err("provided chunk proofs are empty.".to_string());
+        }
+
+        let prover_ref = PROVER.get().expect("failed to get reference to PROVER.");
+
+        let valid = prover_ref.check_chunk_proofs(&chunk_proofs);
+        Ok(valid)
+    })
+    .unwrap_or_else(|e| Err(format!("unwind error: {e:?}")));
+
+    let r = match check_result {
+        Ok(valid) => CheckChunkProofsResponse {
+            ok: valid,
+            error: None,
+        },
+        Err(err) => CheckChunkProofsResponse {
+            ok: false,
+            error: Some(err),
+        },
+    };
+
+    serde_json::to_vec(&r).map_or(null(), vec_to_c_char)
+}
+
+/// # Safety
+#[no_mangle]
+pub unsafe extern "C" fn gen_batch_proof(
+    chunk_hashes: *const c_char,
+    chunk_proofs: *const c_char,
+) -> *const c_char {
+    let proof_result: Result<Vec<u8>, String> = panic_catch(|| {
+        let chunk_hashes = c_char_to_vec(chunk_hashes);
+        let chunk_proofs = c_char_to_vec(chunk_proofs);
+
+        let chunk_hashes = serde_json::from_slice::<Vec<ChunkHash>>(&chunk_hashes)
+            .map_err(|e| format!("failed to deserialize chunk hashes: {e:?}"))?;
+        let chunk_proofs = serde_json::from_slice::<Vec<ChunkProof>>(&chunk_proofs)
+            .map_err(|e| format!("failed to deserialize chunk proofs: {e:?}"))?;
+
+        if chunk_hashes.len() != chunk_proofs.len() {
+            return Err(format!("chunk hashes and chunk proofs lengths mismatch: chunk_hashes.len() = {}, chunk_proofs.len() = {}",
+                chunk_hashes.len(), chunk_proofs.len()));
+        }
+
+        let chunk_hashes_proofs = chunk_hashes
+            .into_iter()
+            .zip(chunk_proofs)
+            .collect();
+
+        let proof = PROVER
+            .get_mut()
+            .expect("failed to get mutable reference to PROVER.")
+            .gen_agg_evm_proof(chunk_hashes_proofs, None, OUTPUT_DIR.as_deref())
+            .map_err(|e| format!("failed to generate proof: {e:?}"))?;
+
+        serde_json::to_vec(&proof).map_err(|e| format!("failed to serialize the proof: {e:?}"))
+    })
+    .unwrap_or_else(|e| Err(format!("unwind error: {e:?}")));
+
+    let r = match proof_result {
+        Ok(proof_bytes) => ProofResult {
+            message: Some(proof_bytes),
+            error: None,
+        },
+        Err(err) => ProofResult {
+            message: None,
+            error: Some(err),
+        },
+    };
+
+    serde_json::to_vec(&r).map_or(null(), vec_to_c_char)
+}
+
+/// # Safety
+#[no_mangle]
+pub unsafe extern "C" fn verify_batch_proof(
+    proof: *const c_char,
+    fork_name: *const c_char,
+) -> c_char {
+    let proof = c_char_to_vec(proof);
+    let proof = serde_json::from_slice::<BatchProof>(proof.as_slice()).unwrap();
+    let fork_name_str = c_char_to_str(fork_name);
+    let fork_id = match fork_name_str {
+        "" => 0,
+        "shanghai" => 0,
+        "bernoulli" => 1,
+        _ => {
+            log::warn!("unexpected fork_name {fork_name_str}, treated as bernoulli");
+            1
+        }
+    };
+    let verified = panic_catch(|| {
+        if fork_id == 0 {
+            // before upgrade#2(EIP4844)
+            verify_evm_calldata(
+                include_bytes!("evm_verifier_fork_1.bin").to_vec(),
+                proof.calldata(),
+            )
+        } else {
+            VERIFIER.get().unwrap().verify_agg_evm_proof(proof)
+        }
+    });
+    verified.unwrap_or(false) as c_char
+}
+
+// This function is only used for debugging on Go side.
+/// # Safety
+#[no_mangle]
+pub unsafe extern "C" fn block_traces_to_chunk_info(block_traces: *const c_char) -> *const c_char {
+    let block_traces = c_char_to_vec(block_traces);
+    let block_traces = serde_json::from_slice::<Vec<BlockTrace>>(&block_traces).unwrap();
+
+    let witness_block = chunk_trace_to_witness_block(block_traces).unwrap();
+    let chunk_info = ChunkHash::from_witness_block(&witness_block, false);
+
+    let chunk_info_bytes = serde_json::to_vec(&chunk_info).unwrap();
+    vec_to_c_char(chunk_info_bytes)
+}

common/libzkp/impl/src/chunk.rs

@@ -0,0 +1,107 @@
+use crate::{
+    types::ProofResult,
+    utils::{
+        c_char_to_str, c_char_to_vec, file_exists, panic_catch, string_to_c_char, vec_to_c_char,
+        OUTPUT_DIR,
+    },
+};
+use libc::c_char;
+use prover::{
+    consts::CHUNK_VK_FILENAME,
+    utils::init_env_and_log,
+    zkevm::{Prover, Verifier},
+    BlockTrace, ChunkProof,
+};
+use std::{cell::OnceCell, env, ptr::null};
+
+static mut PROVER: OnceCell<Prover> = OnceCell::new();
+static mut VERIFIER: OnceCell<Verifier> = OnceCell::new();
+
+/// # Safety
+#[no_mangle]
+pub unsafe extern "C" fn init_chunk_prover(params_dir: *const c_char, assets_dir: *const c_char) {
+    init_env_and_log("ffi_chunk_prove");
+
+    let params_dir = c_char_to_str(params_dir);
+    let assets_dir = c_char_to_str(assets_dir);
+
+    // TODO: add a settings in scroll-prover.
+    env::set_var("SCROLL_PROVER_ASSETS_DIR", assets_dir);
+
+    // VK file must exist, it is optional and logged as a warning in prover.
+    if !file_exists(assets_dir, &CHUNK_VK_FILENAME) {
+        panic!("{} must exist in folder {}", *CHUNK_VK_FILENAME, assets_dir);
+    }
+
+    let prover = Prover::from_dirs(params_dir, assets_dir);
+
+    PROVER.set(prover).unwrap();
+}
+
+/// # Safety
+#[no_mangle]
+pub unsafe extern "C" fn init_chunk_verifier(params_dir: *const c_char, assets_dir: *const c_char) {
+    init_env_and_log("ffi_chunk_verify");
+
+    let params_dir = c_char_to_str(params_dir);
+    let assets_dir = c_char_to_str(assets_dir);
+
+    // TODO: add a settings in scroll-prover.
+    env::set_var("SCROLL_PROVER_ASSETS_DIR", assets_dir);
+    let verifier = Verifier::from_dirs(params_dir, assets_dir);
+
+    VERIFIER.set(verifier).unwrap();
+}
+
+/// # Safety
+#[no_mangle]
+pub unsafe extern "C" fn get_chunk_vk() -> *const c_char {
+    let vk_result = panic_catch(|| PROVER.get_mut().unwrap().get_vk());
+
+    vk_result
+        .ok()
+        .flatten()
+        .map_or(null(), |vk| string_to_c_char(base64::encode(vk)))
+}
+
+/// # Safety
+#[no_mangle]
+pub unsafe extern "C" fn gen_chunk_proof(block_traces: *const c_char) -> *const c_char {
+    let proof_result: Result<Vec<u8>, String> = panic_catch(|| {
+        let block_traces = c_char_to_vec(block_traces);
+        let block_traces = serde_json::from_slice::<Vec<BlockTrace>>(&block_traces)
+            .map_err(|e| format!("failed to deserialize block traces: {e:?}"))?;
+
+        let proof = PROVER
+            .get_mut()
+            .expect("failed to get mutable reference to PROVER.")
+            .gen_chunk_proof(block_traces, None, None, OUTPUT_DIR.as_deref())
+            .map_err(|e| format!("failed to generate proof: {e:?}"))?;
+
+        serde_json::to_vec(&proof).map_err(|e| format!("failed to serialize the proof: {e:?}"))
+    })
+    .unwrap_or_else(|e| Err(format!("unwind error: {e:?}")));
+
+    let r = match proof_result {
+        Ok(proof_bytes) => ProofResult {
+            message: Some(proof_bytes),
+            error: None,
+        },
+        Err(err) => ProofResult {
+            message: None,
+            error: Some(err),
+        },
+    };
+
+    serde_json::to_vec(&r).map_or(null(), vec_to_c_char)
+}
+
+/// # Safety
+#[no_mangle]
+pub unsafe extern "C" fn verify_chunk_proof(proof: *const c_char) -> c_char {
+    let proof = c_char_to_vec(proof);
+    let proof = serde_json::from_slice::<ChunkProof>(proof.as_slice()).unwrap();
+
+    let verified = panic_catch(|| VERIFIER.get().unwrap().verify_chunk_proof(proof));
+    verified.unwrap_or(false) as c_char
+}

common/libzkp/impl/src/lib.rs

@@ -1,63 +1,4 @@
+mod batch;
+mod chunk;
+mod types;
 mod utils;
-mod verifier;
-
-use crate::utils::{c_char_to_str, c_char_to_vec};
-use libc::c_char;
-use prover_v5::utils::init_env_and_log;
-use verifier::{TaskType, VerifierConfig};
-
-/// # Safety
-#[no_mangle]
-pub unsafe extern "C" fn init(config: *const c_char) {
-    init_env_and_log("ffi_init");
-
-    let config_str = c_char_to_str(config);
-    let verifier_config = serde_json::from_str::<VerifierConfig>(config_str).unwrap();
-    verifier::init(verifier_config);
-}
-
-/// # Safety
-#[no_mangle]
-pub unsafe extern "C" fn verify_chunk_proof(
-    proof: *const c_char,
-    fork_name: *const c_char,
-) -> c_char {
-    verify_proof(proof, fork_name, TaskType::Chunk)
-}
-
-fn verify_proof(proof: *const c_char, fork_name: *const c_char, task_type: TaskType) -> c_char {
-    let proof = c_char_to_vec(proof);
-
-    let fork_name_str = c_char_to_str(fork_name);
-    let verifier = verifier::get_verifier(fork_name_str);
-
-    if let Err(e) = verifier {
-        log::warn!("failed to get verifier, error: {:#}", e);
-        return 0 as c_char;
-    }
-    match verifier.unwrap().verify(task_type, proof) {
-        Err(e) => {
-            log::error!("{:?} verify failed, error: {:#}", task_type, e);
-            false as c_char
-        }
-        Ok(result) => result as c_char,
-    }
-}
-
-/// # Safety
-#[no_mangle]
-pub unsafe extern "C" fn verify_batch_proof(
-    proof: *const c_char,
-    fork_name: *const c_char,
-) -> c_char {
-    verify_proof(proof, fork_name, TaskType::Batch)
-}
-
-/// # Safety
-#[no_mangle]
-pub unsafe extern "C" fn verify_bundle_proof(
-    proof: *const c_char,
-    fork_name: *const c_char,
-) -> c_char {
-    verify_proof(proof, fork_name, TaskType::Bundle)
-}

common/libzkp/impl/src/types.rs

@@ -0,0 +1,22 @@
+use serde::{Deserialize, Serialize};
+
+// Represents the result of a chunk proof checking operation.
+// `ok` indicates whether the proof checking was successful.
+// `error` provides additional details in case the check failed.
+#[derive(Debug, Clone, Deserialize, Serialize)]
+pub struct CheckChunkProofsResponse {
+    pub ok: bool,
+    #[serde(skip_serializing_if = "Option::is_none")]
+    pub error: Option<String>,
+}
+
+// Encapsulates the result from generating a proof.
+// `message` holds the generated proof in byte slice format.
+// `error` provides additional details in case the proof generation failed.
+#[derive(Debug, Clone, Deserialize, Serialize)]
+pub struct ProofResult {
+    #[serde(skip_serializing_if = "Option::is_none")]
+    pub message: Option<Vec<u8>>,
+    #[serde(skip_serializing_if = "Option::is_none")]
+    pub error: Option<String>,
+}

common/libzkp/impl/src/utils.rs

@@ -1,9 +1,29 @@
+use once_cell::sync::Lazy;
 use std::{
-    ffi::CStr,
+    env,
+    ffi::{CStr, CString},
     os::raw::c_char,
     panic::{catch_unwind, AssertUnwindSafe},
+    path::PathBuf,
 };
 
+// Only used for debugging.
+pub(crate) static OUTPUT_DIR: Lazy<Option<String>> =
+    Lazy::new(|| env::var("PROVER_OUTPUT_DIR").ok());
+
+/// # Safety
+#[no_mangle]
+pub extern "C" fn free_c_chars(ptr: *mut c_char) {
+    if ptr.is_null() {
+        log::warn!("Try to free an empty pointer!");
+        return;
+    }
+
+    unsafe {
+        let _ = CString::from_raw(ptr);
+    }
+}
+
 pub(crate) fn c_char_to_str(c: *const c_char) -> &'static str {
     let cstr = unsafe { CStr::from_ptr(c) };
     cstr.to_str().unwrap()
@@ -14,6 +34,21 @@ pub(crate) fn c_char_to_vec(c: *const c_char) -> Vec<u8> {
     cstr.to_bytes().to_vec()
 }
 
+pub(crate) fn string_to_c_char(string: String) -> *const c_char {
+    CString::new(string).unwrap().into_raw()
+}
+
+pub(crate) fn vec_to_c_char(bytes: Vec<u8>) -> *const c_char {
+    CString::new(bytes).unwrap().into_raw()
+}
+
+pub(crate) fn file_exists(dir: &str, filename: &str) -> bool {
+    let mut path = PathBuf::from(dir);
+    path.push(filename);
+
+    path.exists()
+}
+
 pub(crate) fn panic_catch<F: FnOnce() -> R, R>(f: F) -> Result<R, String> {
     catch_unwind(AssertUnwindSafe(f)).map_err(|err| {
         if let Some(s) = err.downcast_ref::<String>() {

common/libzkp/impl/src/verifier.rs

@@ -1,110 +0,0 @@
-mod darwin;
-mod darwin_v2;
-
-use anyhow::{bail, Result};
-use darwin::DarwinVerifier;
-use darwin_v2::DarwinV2Verifier;
-use halo2_proofs::{halo2curves::bn256::Bn256, poly::kzg::commitment::ParamsKZG};
-use prover_v4::utils::load_params;
-use serde::{Deserialize, Serialize};
-use std::{cell::OnceCell, collections::BTreeMap, rc::Rc};
-
-#[derive(Debug, Clone, Copy, PartialEq)]
-pub enum TaskType {
-    Chunk,
-    Batch,
-    Bundle,
-}
-
-pub trait ProofVerifier {
-    fn verify(&self, task_type: TaskType, proof: Vec<u8>) -> Result<bool>;
-}
-
-#[derive(Debug, Serialize, Deserialize)]
-pub struct CircuitConfig {
-    pub fork_name: String,
-    pub params_path: String,
-    pub assets_path: String,
-}
-
-#[derive(Debug, Serialize, Deserialize)]
-pub struct VerifierConfig {
-    pub low_version_circuit: CircuitConfig,
-    pub high_version_circuit: CircuitConfig,
-}
-
-type HardForkName = String;
-
-struct VerifierPair(HardForkName, Rc<Box<dyn ProofVerifier>>);
-
-static mut VERIFIER_HIGH: OnceCell<VerifierPair> = OnceCell::new();
-static mut VERIFIER_LOW: OnceCell<VerifierPair> = OnceCell::new();
-static mut PARAMS_MAP: OnceCell<BTreeMap<u32, ParamsKZG<Bn256>>> = OnceCell::new();
-
-pub fn init(config: VerifierConfig) {
-    let low_conf = config.low_version_circuit;
-
-    std::env::set_var("SCROLL_PROVER_ASSETS_DIR", &low_conf.assets_path);
-    let params_degrees = [
-        *prover_v4::config::LAYER2_DEGREE,
-        *prover_v4::config::LAYER4_DEGREE,
-    ];
-
-    // params should be shared between low and high
-    let mut params_map = BTreeMap::new();
-    for degree in params_degrees {
-        if let std::collections::btree_map::Entry::Vacant(e) = params_map.entry(degree) {
-            match load_params(&low_conf.params_path, degree, None) {
-                Ok(params) => {
-                    e.insert(params);
-                }
-                Err(e) => panic!(
-                    "failed to load params, degree {}, dir {}, err {}",
-                    degree, low_conf.params_path, e
-                ),
-            }
-        }
-    }
-    unsafe {
-        PARAMS_MAP.set(params_map).unwrap_unchecked();
-    }
-
-    let verifier = DarwinVerifier::new(unsafe { PARAMS_MAP.get().unwrap() }, &low_conf.assets_path);
-
-    unsafe {
-        VERIFIER_LOW
-            .set(VerifierPair(
-                low_conf.fork_name,
-                Rc::new(Box::new(verifier)),
-            ))
-            .unwrap_unchecked();
-    }
-    let high_conf = config.high_version_circuit;
-    let verifier =
-        DarwinV2Verifier::new(unsafe { PARAMS_MAP.get().unwrap() }, &high_conf.assets_path);
-    unsafe {
-        VERIFIER_HIGH
-            .set(VerifierPair(
-                high_conf.fork_name,
-                Rc::new(Box::new(verifier)),
-            ))
-            .unwrap_unchecked();
-    }
-}
-
-pub fn get_verifier(fork_name: &str) -> Result<Rc<Box<dyn ProofVerifier>>> {
-    unsafe {
-        if let Some(verifier) = VERIFIER_LOW.get() {
-            if verifier.0 == fork_name {
-                return Ok(verifier.1.clone());
-            }
-        }
-
-        if let Some(verifier) = VERIFIER_HIGH.get() {
-            if verifier.0 == fork_name {
-                return Ok(verifier.1.clone());
-            }
-        }
-    }
-    bail!("failed to get verifier, key not found, {}", fork_name)
-}

common/libzkp/impl/src/verifier/darwin.rs

@@ -1,48 +0,0 @@
-use super::{ProofVerifier, TaskType};
-
-use anyhow::Result;
-use halo2_proofs::{halo2curves::bn256::Bn256, poly::kzg::commitment::ParamsKZG};
-
-use crate::utils::panic_catch;
-use prover_v4::{
-    aggregator::Verifier as AggVerifier, zkevm::Verifier, BatchProof, BundleProof, ChunkProof,
-};
-use std::{collections::BTreeMap, env};
-
-pub struct DarwinVerifier<'params> {
-    verifier: Verifier<'params>,
-    agg_verifier: AggVerifier<'params>,
-}
-
-impl<'params> DarwinVerifier<'params> {
-    pub fn new(params_map: &'params BTreeMap<u32, ParamsKZG<Bn256>>, assets_dir: &str) -> Self {
-        env::set_var("SCROLL_PROVER_ASSETS_DIR", assets_dir);
-        let verifier = Verifier::from_params_and_assets(params_map, assets_dir);
-        let agg_verifier = AggVerifier::from_params_and_assets(params_map, assets_dir);
-
-        Self {
-            verifier,
-            agg_verifier,
-        }
-    }
-}
-
-impl<'params> ProofVerifier for DarwinVerifier<'params> {
-    fn verify(&self, task_type: super::TaskType, proof: Vec<u8>) -> Result<bool> {
-        let result = panic_catch(|| match task_type {
-            TaskType::Chunk => {
-                let proof = serde_json::from_slice::<ChunkProof>(proof.as_slice()).unwrap();
-                self.verifier.verify_chunk_proof(proof)
-            }
-            TaskType::Batch => {
-                let proof = serde_json::from_slice::<BatchProof>(proof.as_slice()).unwrap();
-                self.agg_verifier.verify_batch_proof(&proof)
-            }
-            TaskType::Bundle => {
-                let proof = serde_json::from_slice::<BundleProof>(proof.as_slice()).unwrap();
-                self.agg_verifier.verify_bundle_proof(proof)
-            }
-        });
-        result.map_err(|e| anyhow::anyhow!(e))
-    }
-}

common/libzkp/impl/src/verifier/darwin_v2.rs

@@ -1,48 +0,0 @@
-use super::{ProofVerifier, TaskType};
-
-use anyhow::Result;
-use halo2_proofs::{halo2curves::bn256::Bn256, poly::kzg::commitment::ParamsKZG};
-
-use crate::utils::panic_catch;
-use prover_v5::{
-    aggregator::Verifier as AggVerifier, zkevm::Verifier, BatchProof, BundleProof, ChunkProof,
-};
-use std::{collections::BTreeMap, env};
-
-pub struct DarwinV2Verifier<'params> {
-    verifier: Verifier<'params>,
-    agg_verifier: AggVerifier<'params>,
-}
-
-impl<'params> DarwinV2Verifier<'params> {
-    pub fn new(params_map: &'params BTreeMap<u32, ParamsKZG<Bn256>>, assets_dir: &str) -> Self {
-        env::set_var("SCROLL_PROVER_ASSETS_DIR", assets_dir);
-        let verifier = Verifier::from_params_and_assets(params_map, assets_dir);
-        let agg_verifier = AggVerifier::from_params_and_assets(params_map, assets_dir);
-
-        Self {
-            verifier,
-            agg_verifier,
-        }
-    }
-}
-
-impl<'params> ProofVerifier for DarwinV2Verifier<'params> {
-    fn verify(&self, task_type: super::TaskType, proof: Vec<u8>) -> Result<bool> {
-        let result = panic_catch(|| match task_type {
-            TaskType::Chunk => {
-                let proof = serde_json::from_slice::<ChunkProof>(proof.as_slice()).unwrap();
-                self.verifier.verify_chunk_proof(proof)
-            }
-            TaskType::Batch => {
-                let proof = serde_json::from_slice::<BatchProof>(proof.as_slice()).unwrap();
-                self.agg_verifier.verify_batch_proof(&proof)
-            }
-            TaskType::Bundle => {
-                let proof = serde_json::from_slice::<BundleProof>(proof.as_slice()).unwrap();
-                self.agg_verifier.verify_bundle_proof(proof)
-            }
-        });
-        result.map_err(|e| anyhow::anyhow!(e))
-    }
-}

common/libzkp/interface/libzkp.h

@@ -1,10 +1,15 @@
-// BatchVerifier is used to:
-// - Verify a batch proof
-// - Verify a bundle proof
-void init(char* config);
-
+void init_batch_prover(char* params_dir, char* assets_dir);
+void init_batch_verifier(char* params_dir, char* assets_dir);
+char* get_batch_vk();
+char* check_chunk_proofs(char* chunk_proofs);
+char* gen_batch_proof(char* chunk_hashes, char* chunk_proofs);
 char verify_batch_proof(char* proof, char* fork_name);
 
-char verify_bundle_proof(char* proof, char* fork_name);
+void init_chunk_prover(char* params_dir, char* assets_dir);
+void init_chunk_verifier(char* params_dir, char* assets_dir);
+char* get_chunk_vk();
+char* gen_chunk_proof(char* block_traces);
+char verify_chunk_proof(char* proof);
 
-char verify_chunk_proof(char* proof, char* fork_name);
+char* block_traces_to_chunk_info(char* block_traces);
+void free_c_chars(char* ptr);

common/testcontainers/testcontainers.go

@@ -2,7 +2,6 @@ package testcontainers
 
 import (
 	"context"
-	"errors"
 	"fmt"
 	"log"
 	"os"
@@ -115,7 +114,7 @@ func (t *TestcontainerApps) StartPoSL1Container() error {
 // GetPoSL1EndPoint returns the endpoint of the running PoS L1 endpoint
 func (t *TestcontainerApps) GetPoSL1EndPoint() (string, error) {
 	if t.poSL1Container == nil {
-		return "", errors.New("PoS L1 container is not running")
+		return "", fmt.Errorf("PoS L1 container is not running")
 	}
 	contrainer, err := t.poSL1Container.ServiceContainer(context.Background(), "geth")
 	if err != nil {
@@ -136,7 +135,7 @@ func (t *TestcontainerApps) GetPoSL1Client() (*ethclient.Client, error) {
 // GetDBEndPoint returns the endpoint of the running postgres container
 func (t *TestcontainerApps) GetDBEndPoint() (string, error) {
 	if t.postgresContainer == nil || !t.postgresContainer.IsRunning() {
-		return "", errors.New("postgres is not running")
+		return "", fmt.Errorf("postgres is not running")
 	}
 	return t.postgresContainer.ConnectionString(context.Background(), "sslmode=disable")
 }
@@ -144,7 +143,7 @@ func (t *TestcontainerApps) GetDBEndPoint() (string, error) {
 // GetL2GethEndPoint returns the endpoint of the running L2Geth container
 func (t *TestcontainerApps) GetL2GethEndPoint() (string, error) {
 	if t.l2GethContainer == nil || !t.l2GethContainer.IsRunning() {
-		return "", errors.New("l2 geth is not running")
+		return "", fmt.Errorf("l2 geth is not running")
 	}
 	endpoint, err := t.l2GethContainer.PortEndpoint(context.Background(), "8546/tcp", "ws")
 	if err != nil {
@@ -218,7 +217,7 @@ func findProjectRootDir() (string, error) {
 
 		parentDir := filepath.Dir(currentDir)
 		if parentDir == currentDir {
-			return "", errors.New("go.work file not found in any parent directory")
+			return "", fmt.Errorf("go.work file not found in any parent directory")
 		}
 
 		currentDir = parentDir

common/types/db.go

@@ -109,10 +109,6 @@ const (
 	ProverTaskFailureTypeVerifiedFailed
 	// ProverTaskFailureTypeServerError collect occur error
 	ProverTaskFailureTypeServerError
-	// ProverTaskFailureTypeObjectAlreadyVerified object(batch/chunk) already verified, may exists in test env when ENABLE_TEST_ENV_BYPASS_FEATURES is true
-	ProverTaskFailureTypeObjectAlreadyVerified
-	// ProverTaskFailureTypeReassignedByAdmin reassigned by admin, this value is used in admin-system and defined here for clarity
-	ProverTaskFailureTypeReassignedByAdmin
 )
 
 func (r ProverTaskFailureType) String() string {
@@ -127,10 +123,6 @@ func (r ProverTaskFailureType) String() string {
 		return "prover task failure verified failed"
 	case ProverTaskFailureTypeServerError:
 		return "prover task failure server exception"
-	case ProverTaskFailureTypeObjectAlreadyVerified:
-		return "prover task failure object already verified"
-	case ProverTaskFailureTypeReassignedByAdmin:
-		return "prover task failure reassigned by admin"
 	default:
 		return fmt.Sprintf("illegal prover task failure type (%d)", int32(r))
 	}
@@ -196,31 +188,6 @@ func (s ChunkProofsStatus) String() string {
 	}
 }
 
-// BatchProofsStatus describes the proving status of batches that belong to a bundle.
-type BatchProofsStatus int
-
-const (
-	// BatchProofsStatusUndefined represents an undefined batch proofs status
-	BatchProofsStatusUndefined BatchProofsStatus = iota
-
-	// BatchProofsStatusPending means that some batches that belong to this bundle have not been proven
-	BatchProofsStatusPending
-
-	// BatchProofsStatusReady means that all batches that belong to this bundle have been proven
-	BatchProofsStatusReady
-)
-
-func (s BatchProofsStatus) String() string {
-	switch s {
-	case BatchProofsStatusPending:
-		return "BatchProofsStatusPending"
-	case BatchProofsStatusReady:
-		return "BatchProofsStatusReady"
-	default:
-		return fmt.Sprintf("Undefined BatchProofsStatus (%d)", int32(s))
-	}
-}
-
 // RollupStatus block_batch rollup_status (pending, committing, committed, commit_failed, finalizing, finalized, finalize_skipped, finalize_failed)
 type RollupStatus int
 

common/types/message/auth_msg.go

@@ -0,0 +1,91 @@
+package message
+
+import (
+	"crypto/ecdsa"
+
+	"github.com/scroll-tech/go-ethereum/common"
+	"github.com/scroll-tech/go-ethereum/common/hexutil"
+	"github.com/scroll-tech/go-ethereum/crypto"
+	"github.com/scroll-tech/go-ethereum/rlp"
+)
+
+// AuthMsg is the first message exchanged from the Prover to the Sequencer.
+// It effectively acts as a registration, and makes the Prover identification
+// known to the Sequencer.
+type AuthMsg struct {
+	// Message fields
+	Identity *Identity `json:"message"`
+	// Prover signature
+	Signature string `json:"signature"`
+}
+
+// Identity contains all the fields to be signed by the prover.
+type Identity struct {
+	// ProverName the prover name
+	ProverName string `json:"prover_name"`
+	// ProverVersion the prover version
+	ProverVersion string `json:"prover_version"`
+	// Challenge unique challenge generated by manager
+	Challenge string `json:"challenge"`
+	// HardForkName the hard fork name
+	HardForkName string `json:"hard_fork_name"`
+}
+
+// SignWithKey auth message with private key and set public key in auth message's Identity
+func (a *AuthMsg) SignWithKey(priv *ecdsa.PrivateKey) error {
+	// Hash identity content
+	hash, err := a.Identity.Hash()
+	if err != nil {
+		return err
+	}
+
+	// Sign register message
+	sig, err := crypto.Sign(hash, priv)
+	if err != nil {
+		return err
+	}
+	a.Signature = hexutil.Encode(sig)
+
+	return nil
+}
+
+// Verify verifies the message of auth.
+func (a *AuthMsg) Verify() (bool, error) {
+	hash, err := a.Identity.Hash()
+	if err != nil {
+		return false, err
+	}
+	sig := common.FromHex(a.Signature)
+
+	pk, err := crypto.SigToPub(hash, sig)
+	if err != nil {
+		return false, err
+	}
+	return crypto.VerifySignature(crypto.CompressPubkey(pk), hash, sig[:len(sig)-1]), nil
+}
+
+// PublicKey return public key from signature
+func (a *AuthMsg) PublicKey() (string, error) {
+	hash, err := a.Identity.Hash()
+	if err != nil {
+		return "", err
+	}
+	sig := common.FromHex(a.Signature)
+	// recover public key
+	pk, err := crypto.SigToPub(hash, sig)
+	if err != nil {
+		return "", err
+	}
+	return common.Bytes2Hex(crypto.CompressPubkey(pk)), nil
+}
+
+// Hash returns the hash of the auth message, which should be the message used
+// to construct the Signature.
+func (i *Identity) Hash() ([]byte, error) {
+	byt, err := rlp.EncodeToBytes(i)
+	if err != nil {
+		return nil, err
+	}
+	hash := crypto.Keccak256Hash(byt)
+	return hash[:], nil
+}

common/types/message/legacy_auth_msg.go

@@ -0,0 +1,89 @@
+package message
+
+import (
+	"crypto/ecdsa"
+
+	"github.com/scroll-tech/go-ethereum/common"
+	"github.com/scroll-tech/go-ethereum/common/hexutil"
+	"github.com/scroll-tech/go-ethereum/crypto"
+	"github.com/scroll-tech/go-ethereum/rlp"
+)
+
+// LegacyAuthMsg is the old auth message exchanged from the Prover to the Sequencer.
+// It effectively acts as a registration, and makes the Prover identification
+// known to the Sequencer.
+type LegacyAuthMsg struct {
+	// Message fields
+	Identity *LegacyIdentity `json:"message"`
+	// Prover signature
+	Signature string `json:"signature"`
+}
+
+// LegacyIdentity contains all the fields to be signed by the prover.
+type LegacyIdentity struct {
+	// ProverName the prover name
+	ProverName string `json:"prover_name"`
+	// ProverVersion the prover version
+	ProverVersion string `json:"prover_version"`
+	// Challenge unique challenge generated by manager
+	Challenge string `json:"challenge"`
+}
+
+// SignWithKey auth message with private key and set public key in auth message's Identity
+func (a *LegacyAuthMsg) SignWithKey(priv *ecdsa.PrivateKey) error {
+	// Hash identity content
+	hash, err := a.Identity.Hash()
+	if err != nil {
+		return err
+	}
+
+	// Sign register message
+	sig, err := crypto.Sign(hash, priv)
+	if err != nil {
+		return err
+	}
+	a.Signature = hexutil.Encode(sig)
+
+	return nil
+}
+
+// Verify verifies the message of auth.
+func (a *LegacyAuthMsg) Verify() (bool, error) {
+	hash, err := a.Identity.Hash()
+	if err != nil {
+		return false, err
+	}
+	sig := common.FromHex(a.Signature)
+
+	pk, err := crypto.SigToPub(hash, sig)
+	if err != nil {
+		return false, err
+	}
+	return crypto.VerifySignature(crypto.CompressPubkey(pk), hash, sig[:len(sig)-1]), nil
+}
+
+// PublicKey return public key from signature
+func (a *LegacyAuthMsg) PublicKey() (string, error) {
+	hash, err := a.Identity.Hash()
+	if err != nil {
+		return "", err
+	}
+	sig := common.FromHex(a.Signature)
+	// recover public key
+	pk, err := crypto.SigToPub(hash, sig)
+	if err != nil {
+		return "", err
+	}
+	return common.Bytes2Hex(crypto.CompressPubkey(pk)), nil
+}
+
+// Hash returns the hash of the auth message, which should be the message used
+// to construct the Signature.
+func (i *LegacyIdentity) Hash() ([]byte, error) {
+	byt, err := rlp.EncodeToBytes(i)
+	if err != nil {
+		return nil, err
+	}
+	hash := crypto.Keccak256Hash(byt)
+	return hash[:], nil
+}

common/types/message/message.go

@@ -1,10 +1,28 @@
 package message
 
 import (
+	"crypto/ecdsa"
+	"crypto/rand"
+	"encoding/hex"
 	"errors"
 	"fmt"
 
 	"github.com/scroll-tech/go-ethereum/common"
+	"github.com/scroll-tech/go-ethereum/common/hexutil"
+	"github.com/scroll-tech/go-ethereum/crypto"
+	"github.com/scroll-tech/go-ethereum/rlp"
+)
+
+// ProofFailureType the proof failure type
+type ProofFailureType int
+
+const (
+	// ProofFailureUndefined the undefined type proof failure type
+	ProofFailureUndefined ProofFailureType = iota
+	// ProofFailurePanic proof failure for prover panic
+	ProofFailurePanic
+	// ProofFailureNoPanic proof failure for no prover panic
+	ProofFailureNoPanic
 )
 
 // RespStatus represents status code from prover to scroll
@@ -17,7 +35,7 @@ const (
 	StatusProofError
 )
 
-// ProofType represents the type of task.
+// ProofType represents the type of prover.
 type ProofType uint8
 
 func (r ProofType) String() string {
@@ -26,8 +44,6 @@ func (r ProofType) String() string {
 		return "proof type chunk"
 	case ProofTypeBatch:
 		return "proof type batch"
-	case ProofTypeBundle:
-		return "proof type bundle"
 	default:
 		return fmt.Sprintf("illegal proof type: %d", r)
 	}
@@ -36,14 +52,93 @@ func (r ProofType) String() string {
 const (
 	// ProofTypeUndefined is an unknown proof type
 	ProofTypeUndefined ProofType = iota
-	// ProofTypeChunk generates a proof for a ZkEvm chunk, where the inputs are the execution traces for blocks contained in the chunk. ProofTypeChunk is the default proof type.
+	// ProofTypeChunk is default prover, it only generates zk proof from traces.
 	ProofTypeChunk
-	// ProofTypeBatch generates zk proof from chunk proofs
+	// ProofTypeBatch generates zk proof from other zk proofs and aggregate them into one proof.
 	ProofTypeBatch
-	// ProofTypeBundle generates zk proof from batch proofs
-	ProofTypeBundle
 )
 
+// GenerateToken generates token
+func GenerateToken() (string, error) {
+	b := make([]byte, 16)
+	if _, err := rand.Read(b); err != nil {
+		return "", err
+	}
+	return hex.EncodeToString(b), nil
+}
+
+// ProofMsg is the data structure sent to the coordinator.
+type ProofMsg struct {
+	*ProofDetail `json:"zkProof"`
+	// Prover signature
+	Signature string `json:"signature"`
+
+	// Prover public key
+	publicKey string
+}
+
+// Sign signs the ProofMsg.
+func (a *ProofMsg) Sign(priv *ecdsa.PrivateKey) error {
+	hash, err := a.ProofDetail.Hash()
+	if err != nil {
+		return err
+	}
+	sig, err := crypto.Sign(hash, priv)
+	if err != nil {
+		return err
+	}
+	a.Signature = hexutil.Encode(sig)
+	return nil
+}
+
+// Verify verifies ProofMsg.Signature.
+func (a *ProofMsg) Verify() (bool, error) {
+	hash, err := a.ProofDetail.Hash()
+	if err != nil {
+		return false, err
+	}
+	sig := common.FromHex(a.Signature)
+	// recover public key
+	if a.publicKey == "" {
+		pk, err := crypto.SigToPub(hash, sig)
+		if err != nil {
+			return false, err
+		}
+		a.publicKey = common.Bytes2Hex(crypto.CompressPubkey(pk))
+	}
+
+	return crypto.VerifySignature(common.FromHex(a.publicKey), hash, sig[:len(sig)-1]), nil
+}
+
+// PublicKey return public key from signature
+func (a *ProofMsg) PublicKey() (string, error) {
+	if a.publicKey == "" {
+		hash, err := a.ProofDetail.Hash()
+		if err != nil {
+			return "", err
+		}
+		sig := common.FromHex(a.Signature)
+		// recover public key
+		pk, err := crypto.SigToPub(hash, sig)
+		if err != nil {
+			return "", err
+		}
+		a.publicKey = common.Bytes2Hex(crypto.CompressPubkey(pk))
+		return a.publicKey, nil
+	}
+
+	return a.publicKey, nil
+}
+
+// TaskMsg is a wrapper type around db ProveTask type.
+type TaskMsg struct {
+	UUID            string           `json:"uuid"`
+	ID              string           `json:"id"`
+	Type            ProofType        `json:"type,omitempty"`
+	BatchTaskDetail *BatchTaskDetail `json:"batch_task_detail,omitempty"`
+	ChunkTaskDetail *ChunkTaskDetail `json:"chunk_task_detail,omitempty"`
+}
+
 // ChunkTaskDetail is a type containing ChunkTask detail.
 type ChunkTaskDetail struct {
 	BlockHashes []common.Hash `json:"block_hashes"`
@@ -53,13 +148,28 @@ type ChunkTaskDetail struct {
 type BatchTaskDetail struct {
 	ChunkInfos  []*ChunkInfo  `json:"chunk_infos"`
 	ChunkProofs []*ChunkProof `json:"chunk_proofs"`
-	BatchHeader interface{}   `json:"batch_header"`
-	BlobBytes   []byte        `json:"blob_bytes"`
 }
 
-// BundleTaskDetail consists of all the information required to describe the task to generate a proof for a bundle of batches.
-type BundleTaskDetail struct {
-	BatchProofs []*BatchProof `json:"batch_proofs"`
+// ProofDetail is the message received from provers that contains zk proof, the status of
+// the proof generation succeeded, and an error message if proof generation failed.
+type ProofDetail struct {
+	ID         string      `json:"id"`
+	Type       ProofType   `json:"type,omitempty"`
+	Status     RespStatus  `json:"status"`
+	ChunkProof *ChunkProof `json:"chunk_proof,omitempty"`
+	BatchProof *BatchProof `json:"batch_proof,omitempty"`
+	Error      string      `json:"error,omitempty"`
+}
+
+// Hash return proofMsg content hash.
+func (z *ProofDetail) Hash() ([]byte, error) {
+	byt, err := rlp.EncodeToBytes(z)
+	if err != nil {
+		return nil, err
+	}
+
+	hash := crypto.Keccak256Hash(byt)
+	return hash[:], nil
 }
 
 // ChunkInfo is for calculating pi_hash for chunk
@@ -73,12 +183,6 @@ type ChunkInfo struct {
 	TxBytes       []byte      `json:"tx_bytes"`
 }
 
-// SubCircuitRowUsage tracing info added in v0.11.0rc8
-type SubCircuitRowUsage struct {
-	Name      string `json:"name"`
-	RowNumber uint64 `json:"row_number"`
-}
-
 // ChunkProof includes the proof info that are required for chunk verification and rollup.
 type ChunkProof struct {
 	StorageTrace []byte `json:"storage_trace,omitempty"`
@@ -87,23 +191,21 @@ type ChunkProof struct {
 	Instances    []byte `json:"instances"`
 	Vk           []byte `json:"vk"`
 	// cross-reference between cooridinator computation and prover compution
-	ChunkInfo  *ChunkInfo           `json:"chunk_info,omitempty"`
-	GitVersion string               `json:"git_version,omitempty"`
-	RowUsages  []SubCircuitRowUsage `json:"row_usages,omitempty"`
+	ChunkInfo  *ChunkInfo `json:"chunk_info,omitempty"`
+	GitVersion string     `json:"git_version,omitempty"`
 }
 
 // BatchProof includes the proof info that are required for batch verification and rollup.
 type BatchProof struct {
-	Protocol  []byte `json:"protocol"`
 	Proof     []byte `json:"proof"`
 	Instances []byte `json:"instances"`
 	Vk        []byte `json:"vk"`
 	// cross-reference between cooridinator computation and prover compution
-	BatchHash  common.Hash `json:"batch_hash"`
-	GitVersion string      `json:"git_version,omitempty"`
+	GitVersion string `json:"git_version,omitempty"`
 }
 
-// SanityCheck checks whether a BatchProof is in a legal format
+// SanityCheck checks whether an BatchProof is in a legal format
+// TODO: change to check Proof&Instance when upgrading to snark verifier v0.4
 func (ap *BatchProof) SanityCheck() error {
 	if ap == nil {
 		return errors.New("agg_proof is nil")
@@ -112,51 +214,8 @@ func (ap *BatchProof) SanityCheck() error {
 	if len(ap.Proof) == 0 {
 		return errors.New("proof not ready")
 	}
-
 	if len(ap.Proof)%32 != 0 {
-		return fmt.Errorf("proof buffer length must be a multiple of 32, got: %d", len(ap.Proof))
-	}
-
-	if len(ap.Instances) == 0 {
-		return errors.New("instance not ready")
-	}
-
-	if len(ap.Vk) == 0 {
-		return errors.New("vk not ready")
-	}
-
-	return nil
-}
-
-// BundleProof includes the proof info that are required for verification of a bundle of batch proofs.
-type BundleProof struct {
-	Proof     []byte `json:"proof"`
-	Instances []byte `json:"instances"`
-	Vk        []byte `json:"vk"`
-	// cross-reference between cooridinator computation and prover compution
-	GitVersion string `json:"git_version,omitempty"`
-}
-
-// SanityCheck checks whether a BundleProof is in a legal format
-func (ap *BundleProof) SanityCheck() error {
-	if ap == nil {
-		return errors.New("agg_proof is nil")
-	}
-
-	if len(ap.Proof) == 0 {
-		return errors.New("proof not ready")
-	}
-
-	if len(ap.Proof)%32 != 0 {
-		return fmt.Errorf("proof buffer length must be a multiple of 32, got: %d", len(ap.Proof))
-	}
-
-	if len(ap.Instances) == 0 {
-		return errors.New("instance not ready")
-	}
-
-	if len(ap.Vk) == 0 {
-		return errors.New("vk not ready")
+		return fmt.Errorf("proof buffer has wrong length, expected: 32, got: %d", len(ap.Proof))
 	}
 
 	return nil

common/types/message/message_test.go

@@ -0,0 +1,158 @@
+package message
+
+import (
+	"encoding/hex"
+	"testing"
+
+	"github.com/scroll-tech/go-ethereum/common"
+	"github.com/scroll-tech/go-ethereum/crypto"
+	"github.com/stretchr/testify/assert"
+)
+
+func TestAuthMessageSignAndVerify(t *testing.T) {
+	privkey, err := crypto.GenerateKey()
+	assert.NoError(t, err)
+
+	authMsg := &AuthMsg{
+		Identity: &Identity{
+			Challenge:     "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJleHAiOjE2OTEwMzgxNzUsIm9yaWdfaWF0IjoxNjkxMDM0NTc1fQ.HybBMsEJFhyZqtIa2iVcHUP7CEFttf708jmTMAImAWA",
+			ProverName:    "test",
+			ProverVersion: "v1.0.0",
+		},
+	}
+	assert.NoError(t, authMsg.SignWithKey(privkey))
+
+	// Check public key.
+	pk, err := authMsg.PublicKey()
+	assert.NoError(t, err)
+	assert.Equal(t, common.Bytes2Hex(crypto.CompressPubkey(&privkey.PublicKey)), pk)
+
+	ok, err := authMsg.Verify()
+	assert.NoError(t, err)
+	assert.Equal(t, true, ok)
+
+	// Check public key is ok.
+	pub, err := authMsg.PublicKey()
+	assert.NoError(t, err)
+	pubkey := crypto.CompressPubkey(&privkey.PublicKey)
+	assert.Equal(t, pub, common.Bytes2Hex(pubkey))
+}
+
+func TestGenerateToken(t *testing.T) {
+	token, err := GenerateToken()
+	assert.NoError(t, err)
+	assert.Equal(t, 32, len(token))
+}
+
+func TestIdentityHash(t *testing.T) {
+	identity := &Identity{
+		Challenge:     "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJleHAiOjE2OTEwMzM0MTksIm9yaWdfaWF0IjoxNjkxMDI5ODE5fQ.EhkLZsj__rNPVC3ZDYBtvdh0nB8mmM_Hl82hObaIWOs",
+		ProverName:    "test",
+		ProverVersion: "v1.0.0",
+	}
+
+	hash, err := identity.Hash()
+	assert.NoError(t, err)
+
+	expectedHash := "9b8b00f5655411ec1d68ba1666261281c5414aedbda932e5b6a9f7f1b114fdf2"
+	assert.Equal(t, expectedHash, hex.EncodeToString(hash))
+}
+
+func TestProofMessageSignVerifyPublicKey(t *testing.T) {
+	privkey, err := crypto.GenerateKey()
+	assert.NoError(t, err)
+
+	proofMsg := &ProofMsg{
+		ProofDetail: &ProofDetail{
+			ID:     "testID",
+			Type:   ProofTypeChunk,
+			Status: StatusOk,
+			ChunkProof: &ChunkProof{
+				StorageTrace: []byte("testStorageTrace"),
+				Protocol:     []byte("testProtocol"),
+				Proof:        []byte("testProof"),
+				Instances:    []byte("testInstance"),
+				Vk:           []byte("testVk"),
+				ChunkInfo:    nil,
+			},
+			Error: "testError",
+		},
+	}
+	assert.NoError(t, proofMsg.Sign(privkey))
+
+	// Test when publicKey is not set.
+	ok, err := proofMsg.Verify()
+	assert.NoError(t, err)
+	assert.Equal(t, true, ok)
+
+	// Test when publicKey is already set.
+	ok, err = proofMsg.Verify()
+	assert.NoError(t, err)
+	assert.Equal(t, true, ok)
+}
+
+func TestProofDetailHash(t *testing.T) {
+	proofDetail := &ProofDetail{
+		ID:     "testID",
+		Type:   ProofTypeChunk,
+		Status: StatusOk,
+		ChunkProof: &ChunkProof{
+			StorageTrace: []byte("testStorageTrace"),
+			Protocol:     []byte("testProtocol"),
+			Proof:        []byte("testProof"),
+			Instances:    []byte("testInstance"),
+			Vk:           []byte("testVk"),
+			ChunkInfo:    nil,
+		},
+		Error: "testError",
+	}
+	hash, err := proofDetail.Hash()
+	assert.NoError(t, err)
+	expectedHash := "d3b57cb84b0da8043373eeb3612806fb7248d6d1b6e089846ccf3ccce2d9f31c"
+	assert.Equal(t, expectedHash, hex.EncodeToString(hash))
+}
+
+func TestProveTypeString(t *testing.T) {
+	proofTypeChunk := ProofType(1)
+	assert.Equal(t, "proof type chunk", proofTypeChunk.String())
+
+	proofTypeBatch := ProofType(2)
+	assert.Equal(t, "proof type batch", proofTypeBatch.String())
+
+	illegalProof := ProofType(3)
+	assert.Equal(t, "illegal proof type: 3", illegalProof.String())
+}
+
+func TestProofMsgPublicKey(t *testing.T) {
+	privkey, err := crypto.GenerateKey()
+	assert.NoError(t, err)
+
+	proofMsg := &ProofMsg{
+		ProofDetail: &ProofDetail{
+			ID:     "testID",
+			Type:   ProofTypeChunk,
+			Status: StatusOk,
+			ChunkProof: &ChunkProof{
+				StorageTrace: []byte("testStorageTrace"),
+				Protocol:     []byte("testProtocol"),
+				Proof:        []byte("testProof"),
+				Instances:    []byte("testInstance"),
+				Vk:           []byte("testVk"),
+				ChunkInfo:    nil,
+			},
+			Error: "testError",
+		},
+	}
+	assert.NoError(t, proofMsg.Sign(privkey))
+
+	// Test when publicKey is not set.
+	pk, err := proofMsg.PublicKey()
+	assert.NoError(t, err)
+	assert.Equal(t, common.Bytes2Hex(crypto.CompressPubkey(&privkey.PublicKey)), pk)
+
+	// Test when publicKey is already set.
+	proofMsg.publicKey = common.Bytes2Hex(crypto.CompressPubkey(&privkey.PublicKey))
+	pk, err = proofMsg.PublicKey()
+	assert.NoError(t, err)
+	assert.Equal(t, common.Bytes2Hex(crypto.CompressPubkey(&privkey.PublicKey)), pk)
+}

common/utils/keystore.go

@@ -2,7 +2,6 @@ package utils
 
 import (
 	"crypto/ecdsa"
-	"errors"
 	"fmt"
 	"os"
 	"path/filepath"
@@ -29,7 +28,7 @@ func LoadOrCreateKey(keystorePath string, keystorePassword string) (*ecdsa.Priva
 	} else if err != nil {
 		return nil, err
 	} else if fi.IsDir() {
-		return nil, errors.New("keystorePath cannot be a dir")
+		return nil, fmt.Errorf("keystorePath cannot be a dir")
 	}
 
 	keyjson, err := os.ReadFile(filepath.Clean(keystorePath))

common/utils/simulation.go

@@ -12,8 +12,12 @@ import (
 type MockAppName string
 
 var (
+	// EventWatcherApp the name of mock event-watcher app.
+	EventWatcherApp MockAppName = "event-watcher-test"
 	// GasOracleApp the name of mock gas-oracle app.
 	GasOracleApp MockAppName = "gas-oracle-test"
+	// MessageRelayerApp the name of mock message-relayer app.
+	MessageRelayerApp MockAppName = "message-relayer-test"
 	// RollupRelayerApp the name of mock rollup-relayer app.
 	RollupRelayerApp MockAppName = "rollup-relayer-test"
 
@@ -24,6 +28,11 @@ var (
 	CoordinatorAPIApp MockAppName = "coordinator-api-test"
 	// CoordinatorCronApp the name of mock coordinator cron app.
 	CoordinatorCronApp MockAppName = "coordinator-cron-test"
+
+	// ChunkProverApp the name of mock chunk prover app.
+	ChunkProverApp MockAppName = "chunkProver-test"
+	// BatchProverApp the name of mock batch prover app.
+	BatchProverApp MockAppName = "batchProver-test"
 )
 
 // RegisterSimulation register initializer function for integration-test.

common/utils/utils.go

@@ -9,14 +9,10 @@ import (
 	"math/big"
 	"os"
 	"path/filepath"
-	"reflect"
-	"strconv"
-	"strings"
 	"time"
 
 	"github.com/modern-go/reflect2"
 	"github.com/scroll-tech/go-ethereum/core"
-	"github.com/scroll-tech/go-ethereum/log"
 )
 
 // TryTimes try run several times until the function return true.
@@ -82,89 +78,3 @@ func ReadGenesis(genesisPath string) (*core.Genesis, error) {
 	}
 	return genesis, file.Close()
 }
-
-// OverrideConfigWithEnv recursively overrides config values with environment variables
-func OverrideConfigWithEnv(cfg interface{}, prefix string) error {
-	v := reflect.ValueOf(cfg)
-	if v.Kind() != reflect.Ptr || v.IsNil() {
-		return nil
-	}
-	v = v.Elem()
-
-	t := v.Type()
-	for i := 0; i < t.NumField(); i++ {
-		field := t.Field(i)
-		fieldValue := v.Field(i)
-
-		if !fieldValue.CanSet() {
-			continue
-		}
-
-		tag := field.Tag.Get("json")
-		if tag == "" {
-			tag = strings.ToLower(field.Name)
-		}
-
-		envKey := prefix + "_" + strings.ToUpper(tag)
-
-		switch fieldValue.Kind() {
-		case reflect.Ptr:
-			if !fieldValue.IsNil() {
-				err := OverrideConfigWithEnv(fieldValue.Interface(), envKey)
-				if err != nil {
-					return err
-				}
-			}
-		case reflect.Struct:
-			err := OverrideConfigWithEnv(fieldValue.Addr().Interface(), envKey)
-			if err != nil {
-				return err
-			}
-		default:
-			if envValue, exists := os.LookupEnv(envKey); exists {
-				log.Info("Overriding config with env var", "key", envKey)
-				err := setField(fieldValue, envValue)
-				if err != nil {
-					return err
-				}
-			}
-		}
-	}
-
-	return nil
-}
-
-// setField sets the value of a field based on the environment variable value
-func setField(field reflect.Value, value string) error {
-	switch field.Kind() {
-	case reflect.String:
-		field.SetString(value)
-	case reflect.Int, reflect.Int8, reflect.Int16, reflect.Int32, reflect.Int64:
-		intValue, err := strconv.ParseInt(value, 10, 64)
-		if err != nil {
-			return err
-		}
-		field.SetInt(intValue)
-	case reflect.Uint, reflect.Uint8, reflect.Uint16, reflect.Uint32, reflect.Uint64:
-		uintValue, err := strconv.ParseUint(value, 10, 64)
-		if err != nil {
-			return err
-		}
-		field.SetUint(uintValue)
-	case reflect.Float32, reflect.Float64:
-		floatValue, err := strconv.ParseFloat(value, 64)
-		if err != nil {
-			return err
-		}
-		field.SetFloat(floatValue)
-	case reflect.Bool:
-		boolValue, err := strconv.ParseBool(value)
-		if err != nil {
-			return err
-		}
-		field.SetBool(boolValue)
-	default:
-		return fmt.Errorf("unsupported type: %v", field.Kind())
-	}
-	return nil
-}

common/version/version.go

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

contracts/.env.example

@@ -0,0 +1,12 @@
+### NOTE: DO NOT USE THIS FILE IF USING TESTNET'S .ENV
+ETHERSCAN_API_KEY=ABC123ABC123ABC123ABC123ABC123ABC1
+
+RINKEBY_RPC=https://eth-rinkeby.alchemyapi.io/v2/<YOUR ALCHEMY KEY>
+SCROLL_L1_RPC=https://prealpha.scroll.io/l1
+SCROLL_L2_RPC=https://prealpha.scroll.io/l2
+
+RINKEBY_PRIVATE_KEY=0xabc123abc123abc123abc123abc123abc123abc123abc123abc123abc123abc1
+L1_DEPLOYER_PRIVATE_KEY=0xabc123abc123abc123abc123abc123abc123abc123abc123abc123abc123abc1
+L2_DEPLOYER_PRIVATE_KEY=0xabc123abc123abc123abc123abc123abc123abc123abc123abc123abc123abc1
+
+CHAIN_ID_L2="5343541"

contracts/.eslintignore

@@ -0,0 +1,4 @@
+node_modules
+artifacts
+cache
+coverage

contracts/.eslintrc.js

@@ -0,0 +1,24 @@
+module.exports = {
+  env: {
+    browser: false,
+    es2021: true,
+    mocha: true,
+    node: true,
+  },
+  plugins: ["@typescript-eslint"],
+  extends: [
+    "standard",
+    "plugin:prettier/recommended",
+    "plugin:node/recommended",
+  ],
+  parser: "@typescript-eslint/parser",
+  parserOptions: {
+    ecmaVersion: 12,
+  },
+  rules: {
+    "node/no-unsupported-features/es-syntax": [
+      "error",
+      { ignores: ["modules"] },
+    ],
+  },
+};

contracts/.gitignore

@@ -0,0 +1,17 @@
+node_modules
+.env
+coverage
+coverage.json
+typechain
+
+# Hardhat/Foundry files
+cache
+cache-hardhat
+artifacts
+broadcast
+
+# logs
+*.log
+
+# eslint
+.eslintcache

contracts/.husky/pre-commit

@@ -0,0 +1,5 @@
+#!/usr/bin/env sh
+. "$(dirname -- "$0")/_/husky.sh"
+
+cd contracts
+yarn lint-staged

contracts/.npmignore

@@ -0,0 +1,3 @@
+hardhat.config.ts
+scripts
+test

contracts/.nvmrc

@@ -0,0 +1 @@
+v18.15.0

contracts/.prettierignore

@@ -0,0 +1,8 @@
+node_modules
+artifacts
+cache
+coverage*
+gasReporterOutput.json
+src/libraries/verifier/ZkTrieVerifier.sol
+src/libraries/verifier/PatriciaMerkleTrieVerifier.sol
+src/L2/predeploys/L1BlockContainer.sol

contracts/.prettierrc

@@ -0,0 +1,28 @@
+{
+  "printWidth": 120,
+  "singleQuote": false,
+  "tabWidth": 2,
+  "bracketSpacing": true,
+  "overrides": [
+    {
+      "files": "src/**/*.sol",
+      "options": {
+        "printWidth": 120,
+        "tabWidth": 4,
+        "useTabs": false,
+        "singleQuote": false,
+        "bracketSpacing": false
+      }
+    },
+    {
+        "files": "scripts/**/*.sol",
+        "options": {
+          "printWidth": 120,
+          "tabWidth": 4,
+          "useTabs": false,
+          "singleQuote": false,
+          "bracketSpacing": false
+        }
+      }
+  ]
+}

contracts/.solcover.js

@@ -0,0 +1,10 @@
+module.exports = {
+  skipFiles: [
+    'mocks',
+    'test',
+    'L2/predeploys/L1BlockContainer.sol',
+    'libraries/verifier/ZkTrieVerifier.sol',
+    'libraries/verifier/PatriciaMerkleTrieVerifier.sol'
+  ],
+  istanbulReporter: ["lcov", "json"]
+};

contracts/.solhint.json

@@ -0,0 +1,7 @@
+{
+  "extends": "solhint:recommended",
+  "rules": {
+    "compiler-version": ["error", "^0.8.0"],
+    "func-visibility": ["warn", { "ignoreConstructors": true }]
+  }
+}

contracts/.solhintignore

@@ -0,0 +1 @@
+node_modules

contracts/README.md

@@ -0,0 +1,78 @@
+# Scroll Contracts
+
+This directory contains the solidity code for Scroll L1 bridge and rollup contracts and L2 bridge and pre-deployed contracts. You can also find contract APIs and more details in the [`docs`](./docs) folder.
+
+## Directory Structure
+
+<pre>
+├── <a href="./docs/">docs</a>: Documentation for the contracts
+├── <a href="./integration-test/">integration-test</a>: Hardhat integration tests
+├── <a href="./lib/">lib</a>: External libraries and testing tools
+├── <a href="./scripts">scripts</a>: Deployment scripts
+├── <a href="./src">src</a>
+│   ├── <a href="./src/gas-swap/">gas-swap</a>: Utility contract that allows gas payment in other tokens
+│   ├── <a href="./src/interfaces/">interfaces</a>: Common contract interfaces
+│   ├── <a href="./src/L1/">L1</a>: Contracts deployed on the L1 (Ethereum)
+│   │   ├── <a href="./src/L1/gateways/">gateways</a>: Gateway router and token gateway contracts
+│   │   ├── <a href="./src/L1/rollup/">rollup</a>: Rollup contracts for data availability and finalization
+│   │   ├── <a href="./src/L1/IL1ScrollMessenger.sol">IL1ScrollMessenger.sol</a>: L1 Scroll messenger interface
+│   │   └── <a href="./src/L1/L1ScrollMessenger.sol">L1ScrollMessenger.sol</a>: L1 Scroll messenger contract
+│   ├── <a href="./src/L2/">L2</a>: Contracts deployed on the L2 (Scroll)
+│   │   ├── <a href="./src/L2/gateways/">gateways</a>: Gateway router and token gateway contracts
+│   │   ├── <a href="./src/L2/predeploys/">predeploys</a>: Pre-deployed contracts on L2
+│   │   ├── <a href="./src/L2/IL2ScrollMessenger.sol">IL2ScrollMessenger.sol</a>: L2 Scroll messenger interface
+│   │   └── <a href="./src/L2/L2ScrollMessenger.sol">L2ScrollMessenger.sol</a>: L2 Scroll messenger contract
+│   ├── <a href="./src/libraries/">libraries</a>: Shared contract libraries
+│   ├── <a href="./src/misc/">misc</a>: Miscellaneous contracts
+│   ├── <a href="./src/mocks/">mocks</a>: Mock contracts used in the testing
+│   ├── <a href="./src/rate-limiter/">rate-limiter</a>: Rater limiter contract
+│   └── <a href="./src/test/">test</a>: Unit tests in solidity
+├── <a href="./foundry.toml">foundry.toml</a>: Foundry configuration
+├── <a href="./hardhat.config.ts">hardhat.config.ts</a>: Hardhat configuration
+├── <a href="./remappings.txt">remappings.txt</a>: Foundry dependency mappings
+...
+</pre>
+
+## Dependencies
+
+### Node.js
+
+First install [`Node.js`](https://nodejs.org/en) and [`npm`](https://www.npmjs.com/).
+Run the following command to install [`yarn`](https://classic.yarnpkg.com/en/):
+
+```bash
+npm install --global yarn
+```
+
+### Foundry
+
+Install `foundryup`, the Foundry toolchain installer:
+
+```bash
+curl -L https://foundry.paradigm.xyz | bash
+```
+
+If you do not want to use the redirect, feel free to manually download the `foundryup` installation script from [here](https://raw.githubusercontent.com/foundry-rs/foundry/master/foundryup/foundryup).
+
+Then, run `foundryup` in a new terminal session or after reloading `PATH`.
+
+Other ways to install Foundry can be found [here](https://github.com/foundry-rs/foundry#installation).
+
+### Hardhat
+
+Run the following command to install [Hardhat](https://hardhat.org/) and other dependencies.
+
+```
+yarn install
+```
+
+## Build
+
+- Run `git submodule update --init --recursive` to initialize git submodules.
+- Run `yarn prettier:solidity` to run linting in fix mode, will auto-format all solidity codes.
+- Run `yarn prettier` to run linting in fix mode, will auto-format all typescript codes.
+- Run `yarn prepare` to install the precommit linting hook.
+- Run `forge build` to compile contracts with foundry.
+- Run `npx hardhat compile` to compile with hardhat.
+- Run `forge test -vvv` to run foundry units tests. It will compile all contracts before running the unit tests.
+- Run `npx hardhat test` to run integration tests. It may not compile all contracts before running, it's better to run `npx hardhat compile` first.

contracts/circomlib.d.ts

@@ -0,0 +1,3 @@
+declare module "circomlib/src/evmasm";
+declare module "circomlib/src/poseidon_gencontract";
+declare module "circomlib/src/poseidon_constants";

contracts/deployments/README.md

@@ -0,0 +1,16 @@
+# Deployments
+
+## local testnet
+
+```bash
+# start local hardhat node
+npx hardhat node
+```
+
+### layer 1
+
+Contract addresses can be found in [deployments](./l1geth.json).
+
+### layer 2
+
+Contract addresses can be found in [deployments](./l2geth.json).

contracts/deployments/l1geth.json

@@ -0,0 +1,23 @@
+{
+  "ProxyAdmin": null,
+  "ZKRollup": {
+    "implementation": null,
+    "proxy": null
+  },
+  "L1ScrollMessenger": {
+    "implementation": null,
+    "proxy": null
+  },
+  "L1GatewayRouter": {
+    "implementation": null,
+    "proxy": null
+  },
+  "L1StandardERC20Gateway": {
+    "implementation": null,
+    "proxy": null
+  },
+  "L1WETHGateway": {
+    "implementation": null,
+    "proxy": null
+  }
+}

contracts/deployments/l2geth.json

@@ -0,0 +1,20 @@
+{
+  "ProxyAdmin": null,
+  "WETH": null,
+  "Whitelist": null,
+  "ScrollStandardERC20": null,
+  "ScrollStandardERC20Factory": null,
+  "L2ScrollMessenger": null,
+  "L2GatewayRouter": {
+    "implementation": null,
+    "proxy": null
+  },
+  "L2StandardERC20Gateway": {
+    "implementation": null,
+    "proxy": null
+  },
+  "L2WETHGateway": {
+    "implementation": null,
+    "proxy": null
+  }
+}

contracts/docs/apis/L1ERC1155Gateway.md

@@ -0,0 +1,599 @@
+# L1ERC1155Gateway
+
+
+
+> L1ERC1155Gateway
+
+The `L1ERC1155Gateway` is used to deposit ERC1155 compatible NFT on layer 1 and finalize withdraw the NFTs from layer 2.
+
+*The deposited NFTs are held in this gateway. On finalizing withdraw, the corresponding NFT will be transfer to the recipient directly. This will be changed if we have more specific scenarios.*
+
+## Methods
+
+### batchDepositERC1155
+
+```solidity
+function batchDepositERC1155(address _token, uint256[] _tokenIds, uint256[] _amounts, uint256 _gasLimit) external payable
+```
+
+Deposit a list of some ERC1155 NFT to caller's account on layer 2.
+
+
+
+#### Parameters
+
+| Name | Type | Description |
+|---|---|---|
+| _token | address | The address of ERC1155 NFT on layer 1. |
+| _tokenIds | uint256[] | The list of token ids to deposit. |
+| _amounts | uint256[] | The list of corresponding number of token to deposit. |
+| _gasLimit | uint256 | Estimated gas limit required to complete the deposit on layer 2. |
+
+### batchDepositERC1155
+
+```solidity
+function batchDepositERC1155(address _token, address _to, uint256[] _tokenIds, uint256[] _amounts, uint256 _gasLimit) external payable
+```
+
+Deposit a list of some ERC1155 NFT to a recipient's account on layer 2.
+
+
+
+#### Parameters
+
+| Name | Type | Description |
+|---|---|---|
+| _token | address | The address of ERC1155 NFT on layer 1. |
+| _to | address | The address of recipient on layer 2. |
+| _tokenIds | uint256[] | The list of token ids to deposit. |
+| _amounts | uint256[] | The list of corresponding number of token to deposit. |
+| _gasLimit | uint256 | Estimated gas limit required to complete the deposit on layer 2. |
+
+### counterpart
+
+```solidity
+function counterpart() external view returns (address)
+```
+
+The address of corresponding L1/L2 Gateway contract.
+
+
+
+
+#### Returns
+
+| Name | Type | Description |
+|---|---|---|
+| _0 | address | undefined |
+
+### depositERC1155
+
+```solidity
+function depositERC1155(address _token, address _to, uint256 _tokenId, uint256 _amount, uint256 _gasLimit) external payable
+```
+
+Deposit some ERC1155 NFT to a recipient's account on layer 2.
+
+
+
+#### Parameters
+
+| Name | Type | Description |
+|---|---|---|
+| _token | address | The address of ERC1155 NFT on layer 1. |
+| _to | address | The address of recipient on layer 2. |
+| _tokenId | uint256 | The token id to deposit. |
+| _amount | uint256 | The amount of token to deposit. |
+| _gasLimit | uint256 | Estimated gas limit required to complete the deposit on layer 2. |
+
+### depositERC1155
+
+```solidity
+function depositERC1155(address _token, uint256 _tokenId, uint256 _amount, uint256 _gasLimit) external payable
+```
+
+Deposit some ERC1155 NFT to caller's account on layer 2.
+
+
+
+#### Parameters
+
+| Name | Type | Description |
+|---|---|---|
+| _token | address | The address of ERC1155 NFT on layer 1. |
+| _tokenId | uint256 | The token id to deposit. |
+| _amount | uint256 | The amount of token to deposit. |
+| _gasLimit | uint256 | Estimated gas limit required to complete the deposit on layer 2. |
+
+### finalizeBatchWithdrawERC1155
+
+```solidity
+function finalizeBatchWithdrawERC1155(address _l1Token, address _l2Token, address _from, address _to, uint256[] _tokenIds, uint256[] _amounts) external nonpayable
+```
+
+Complete ERC1155 batch withdraw from layer 2 to layer 1 and send fund to recipient's account on layer 1.      The function should only be called by L1ScrollMessenger.      The function should also only be called by L2ERC1155Gateway on layer 2.
+
+
+
+#### Parameters
+
+| Name | Type | Description |
+|---|---|---|
+| _l1Token | address | The address of corresponding layer 1 token. |
+| _l2Token | address | The address of corresponding layer 2 token. |
+| _from | address | The address of account who withdraw the token on layer 2. |
+| _to | address | The address of recipient on layer 1 to receive the token. |
+| _tokenIds | uint256[] | The list of token ids to withdraw. |
+| _amounts | uint256[] | The list of corresponding number of token to withdraw. |
+
+### finalizeWithdrawERC1155
+
+```solidity
+function finalizeWithdrawERC1155(address _l1Token, address _l2Token, address _from, address _to, uint256 _tokenId, uint256 _amount) external nonpayable
+```
+
+Complete ERC1155 withdraw from layer 2 to layer 1 and send fund to recipient's account on layer 1.      The function should only be called by L1ScrollMessenger.      The function should also only be called by L2ERC1155Gateway on layer 2.
+
+
+
+#### Parameters
+
+| Name | Type | Description |
+|---|---|---|
+| _l1Token | address | The address of corresponding layer 1 token. |
+| _l2Token | address | The address of corresponding layer 2 token. |
+| _from | address | The address of account who withdraw the token on layer 2. |
+| _to | address | The address of recipient on layer 1 to receive the token. |
+| _tokenId | uint256 | The token id to withdraw. |
+| _amount | uint256 | The amount of token to withdraw. |
+
+### initialize
+
+```solidity
+function initialize(address _counterpart, address _messenger) external nonpayable
+```
+
+Initialize the storage of L1ERC1155Gateway.
+
+
+
+#### Parameters
+
+| Name | Type | Description |
+|---|---|---|
+| _counterpart | address | The address of L2ERC1155Gateway in L2. |
+| _messenger | address | The address of L1ScrollMessenger in L1. |
+
+### messenger
+
+```solidity
+function messenger() external view returns (address)
+```
+
+The address of corresponding L1ScrollMessenger/L2ScrollMessenger contract.
+
+
+
+
+#### Returns
+
+| Name | Type | Description |
+|---|---|---|
+| _0 | address | undefined |
+
+### onDropMessage
+
+```solidity
+function onDropMessage(bytes _message) external payable
+```
+
+
+
+
+
+#### Parameters
+
+| Name | Type | Description |
+|---|---|---|
+| _message | bytes | undefined |
+
+### onERC1155BatchReceived
+
+```solidity
+function onERC1155BatchReceived(address, address, uint256[], uint256[], bytes) external nonpayable returns (bytes4)
+```
+
+
+
+
+
+#### Parameters
+
+| Name | Type | Description |
+|---|---|---|
+| _0 | address | undefined |
+| _1 | address | undefined |
+| _2 | uint256[] | undefined |
+| _3 | uint256[] | undefined |
+| _4 | bytes | undefined |
+
+#### Returns
+
+| Name | Type | Description |
+|---|---|---|
+| _0 | bytes4 | undefined |
+
+### onERC1155Received
+
+```solidity
+function onERC1155Received(address, address, uint256, uint256, bytes) external nonpayable returns (bytes4)
+```
+
+
+
+
+
+#### Parameters
+
+| Name | Type | Description |
+|---|---|---|
+| _0 | address | undefined |
+| _1 | address | undefined |
+| _2 | uint256 | undefined |
+| _3 | uint256 | undefined |
+| _4 | bytes | undefined |
+
+#### Returns
+
+| Name | Type | Description |
+|---|---|---|
+| _0 | bytes4 | undefined |
+
+### owner
+
+```solidity
+function owner() external view returns (address)
+```
+
+
+
+*Returns the address of the current owner.*
+
+
+#### Returns
+
+| Name | Type | Description |
+|---|---|---|
+| _0 | address | undefined |
+
+### renounceOwnership
+
+```solidity
+function renounceOwnership() external nonpayable
+```
+
+
+
+*Leaves the contract without owner. It will not be possible to call `onlyOwner` functions. Can only be called by the current owner. NOTE: Renouncing ownership will leave the contract without an owner, thereby disabling any functionality that is only available to the owner.*
+
+
+### router
+
+```solidity
+function router() external view returns (address)
+```
+
+The address of L1GatewayRouter/L2GatewayRouter contract.
+
+
+
+
+#### Returns
+
+| Name | Type | Description |
+|---|---|---|
+| _0 | address | undefined |
+
+### supportsInterface
+
+```solidity
+function supportsInterface(bytes4 interfaceId) external view returns (bool)
+```
+
+
+
+*See {IERC165-supportsInterface}.*
+
+#### Parameters
+
+| Name | Type | Description |
+|---|---|---|
+| interfaceId | bytes4 | undefined |
+
+#### Returns
+
+| Name | Type | Description |
+|---|---|---|
+| _0 | bool | undefined |
+
+### tokenMapping
+
+```solidity
+function tokenMapping(address) external view returns (address)
+```
+
+Mapping from l1 token address to l2 token address for ERC1155 NFT.
+
+
+
+#### Parameters
+
+| Name | Type | Description |
+|---|---|---|
+| _0 | address | undefined |
+
+#### Returns
+
+| Name | Type | Description |
+|---|---|---|
+| _0 | address | undefined |
+
+### transferOwnership
+
+```solidity
+function transferOwnership(address newOwner) external nonpayable
+```
+
+
+
+*Transfers ownership of the contract to a new account (`newOwner`). Can only be called by the current owner.*
+
+#### Parameters
+
+| Name | Type | Description |
+|---|---|---|
+| newOwner | address | undefined |
+
+### updateTokenMapping
+
+```solidity
+function updateTokenMapping(address _l1Token, address _l2Token) external nonpayable
+```
+
+Update layer 2 to layer 2 token mapping.
+
+
+
+#### Parameters
+
+| Name | Type | Description |
+|---|---|---|
+| _l1Token | address | The address of ERC1155 token on layer 1. |
+| _l2Token | address | The address of corresponding ERC1155 token on layer 2. |
+
+
+
+## Events
+
+### BatchDepositERC1155
+
+```solidity
+event BatchDepositERC1155(address indexed _l1Token, address indexed _l2Token, address indexed _from, address _to, uint256[] _tokenIds, uint256[] _amounts)
+```
+
+Emitted when the ERC1155 NFT is batch deposited to gateway on layer 1.
+
+
+
+#### Parameters
+
+| Name | Type | Description |
+|---|---|---|
+| _l1Token `indexed` | address | The address of ERC1155 NFT on layer 1. |
+| _l2Token `indexed` | address | The address of ERC1155 NFT on layer 2. |
+| _from `indexed` | address | The address of sender on layer 1. |
+| _to  | address | The address of recipient on layer 2. |
+| _tokenIds  | uint256[] | The list of token ids of the ERC1155 NFT to deposit on layer 1. |
+| _amounts  | uint256[] | The list of corresponding number of token to deposit on layer 1. |
+
+### BatchRefundERC1155
+
+```solidity
+event BatchRefundERC1155(address indexed token, address indexed recipient, uint256[] tokenIds, uint256[] amounts)
+```
+
+Emitted when some ERC1155 token is refunded.
+
+
+
+#### Parameters
+
+| Name | Type | Description |
+|---|---|---|
+| token `indexed` | address | The address of the token in L1. |
+| recipient `indexed` | address | The address of receiver in L1. |
+| tokenIds  | uint256[] | The list of ids of token refunded. |
+| amounts  | uint256[] | The list of amount of token refunded. |
+
+### DepositERC1155
+
+```solidity
+event DepositERC1155(address indexed _l1Token, address indexed _l2Token, address indexed _from, address _to, uint256 _tokenId, uint256 _amount)
+```
+
+Emitted when the ERC1155 NFT is deposited to gateway on layer 1.
+
+
+
+#### Parameters
+
+| Name | Type | Description |
+|---|---|---|
+| _l1Token `indexed` | address | The address of ERC1155 NFT on layer 1. |
+| _l2Token `indexed` | address | The address of ERC1155 NFT on layer 2. |
+| _from `indexed` | address | The address of sender on layer 1. |
+| _to  | address | The address of recipient on layer 2. |
+| _tokenId  | uint256 | The token id of the ERC1155 NFT to deposit on layer 1. |
+| _amount  | uint256 | The number of token to deposit on layer 1. |
+
+### FinalizeBatchWithdrawERC1155
+
+```solidity
+event FinalizeBatchWithdrawERC1155(address indexed _l1Token, address indexed _l2Token, address indexed _from, address _to, uint256[] _tokenIds, uint256[] _amounts)
+```
+
+Emitted when the ERC1155 NFT is batch transferred to recipient on layer 1.
+
+
+
+#### Parameters
+
+| Name | Type | Description |
+|---|---|---|
+| _l1Token `indexed` | address | The address of ERC1155 NFT on layer 1. |
+| _l2Token `indexed` | address | The address of ERC1155 NFT on layer 2. |
+| _from `indexed` | address | The address of sender on layer 2. |
+| _to  | address | The address of recipient on layer 1. |
+| _tokenIds  | uint256[] | The list of token ids of the ERC1155 NFT to withdraw from layer 2. |
+| _amounts  | uint256[] | The list of corresponding number of token to withdraw from layer 2. |
+
+### FinalizeWithdrawERC1155
+
+```solidity
+event FinalizeWithdrawERC1155(address indexed _l1Token, address indexed _l2Token, address indexed _from, address _to, uint256 _tokenId, uint256 _amount)
+```
+
+Emitted when the ERC1155 NFT is transferred to recipient on layer 1.
+
+
+
+#### Parameters
+
+| Name | Type | Description |
+|---|---|---|
+| _l1Token `indexed` | address | The address of ERC1155 NFT on layer 1. |
+| _l2Token `indexed` | address | The address of ERC1155 NFT on layer 2. |
+| _from `indexed` | address | The address of sender on layer 2. |
+| _to  | address | The address of recipient on layer 1. |
+| _tokenId  | uint256 | The token id of the ERC1155 NFT to withdraw from layer 2. |
+| _amount  | uint256 | The number of token to withdraw from layer 2. |
+
+### Initialized
+
+```solidity
+event Initialized(uint8 version)
+```
+
+
+
+*Triggered when the contract has been initialized or reinitialized.*
+
+#### Parameters
+
+| Name | Type | Description |
+|---|---|---|
+| version  | uint8 | undefined |
+
+### OwnershipTransferred
+
+```solidity
+event OwnershipTransferred(address indexed previousOwner, address indexed newOwner)
+```
+
+
+
+
+
+#### Parameters
+
+| Name | Type | Description |
+|---|---|---|
+| previousOwner `indexed` | address | undefined |
+| newOwner `indexed` | address | undefined |
+
+### RefundERC1155
+
+```solidity
+event RefundERC1155(address indexed token, address indexed recipient, uint256 tokenId, uint256 amount)
+```
+
+Emitted when some ERC1155 token is refunded.
+
+
+
+#### Parameters
+
+| Name | Type | Description |
+|---|---|---|
+| token `indexed` | address | The address of the token in L1. |
+| recipient `indexed` | address | The address of receiver in L1. |
+| tokenId  | uint256 | The id of token refunded. |
+| amount  | uint256 | The amount of token refunded. |
+
+### UpdateTokenMapping
+
+```solidity
+event UpdateTokenMapping(address indexed l1Token, address indexed oldL2Token, address indexed newL2Token)
+```
+
+Emitted when token mapping for ERC1155 token is updated.
+
+
+
+#### Parameters
+
+| Name | Type | Description |
+|---|---|---|
+| l1Token `indexed` | address | The address of ERC1155 token in layer 1. |
+| oldL2Token `indexed` | address | The address of the old corresponding ERC1155 token in layer 2. |
+| newL2Token `indexed` | address | The address of the new corresponding ERC1155 token in layer 2. |
+
+
+
+## Errors
+
+### ErrorCallerIsNotCounterpartGateway
+
+```solidity
+error ErrorCallerIsNotCounterpartGateway()
+```
+
+
+
+*Thrown when the cross chain sender is not the counterpart gateway contract.*
+
+
+### ErrorCallerIsNotMessenger
+
+```solidity
+error ErrorCallerIsNotMessenger()
+```
+
+
+
+*Thrown when the caller is not corresponding `L1ScrollMessenger` or `L2ScrollMessenger`.*
+
+
+### ErrorNotInDropMessageContext
+
+```solidity
+error ErrorNotInDropMessageContext()
+```
+
+
+
+*Thrown when ScrollMessenger is not dropping message.*
+
+
+### ErrorZeroAddress
+
+```solidity
+error ErrorZeroAddress()
+```
+
+
+
+*Thrown when the given address is `address(0)`.*
+
+
+

contracts/docs/apis/L1ERC721Gateway.md

@@ -0,0 +1,538 @@
+# L1ERC721Gateway
+
+
+
+> L1ERC721Gateway
+
+The `L1ERC721Gateway` is used to deposit ERC721 compatible NFT on layer 1 and finalize withdraw the NFTs from layer 2.
+
+*The deposited NFTs are held in this gateway. On finalizing withdraw, the corresponding NFT will be transfer to the recipient directly. This will be changed if we have more specific scenarios.*
+
+## Methods
+
+### batchDepositERC721
+
+```solidity
+function batchDepositERC721(address _token, address _to, uint256[] _tokenIds, uint256 _gasLimit) external payable
+```
+
+Deposit a list of some ERC721 NFT to a recipient's account on layer 2.
+
+
+
+#### Parameters
+
+| Name | Type | Description |
+|---|---|---|
+| _token | address | The address of ERC721 NFT on layer 1. |
+| _to | address | The address of recipient on layer 2. |
+| _tokenIds | uint256[] | The list of token ids to deposit. |
+| _gasLimit | uint256 | Estimated gas limit required to complete the deposit on layer 2. |
+
+### batchDepositERC721
+
+```solidity
+function batchDepositERC721(address _token, uint256[] _tokenIds, uint256 _gasLimit) external payable
+```
+
+Deposit a list of some ERC721 NFT to caller's account on layer 2.
+
+
+
+#### Parameters
+
+| Name | Type | Description |
+|---|---|---|
+| _token | address | The address of ERC721 NFT on layer 1. |
+| _tokenIds | uint256[] | The list of token ids to deposit. |
+| _gasLimit | uint256 | Estimated gas limit required to complete the deposit on layer 2. |
+
+### counterpart
+
+```solidity
+function counterpart() external view returns (address)
+```
+
+The address of corresponding L1/L2 Gateway contract.
+
+
+
+
+#### Returns
+
+| Name | Type | Description |
+|---|---|---|
+| _0 | address | undefined |
+
+### depositERC721
+
+```solidity
+function depositERC721(address _token, address _to, uint256 _tokenId, uint256 _gasLimit) external payable
+```
+
+Deposit some ERC721 NFT to a recipient's account on layer 2.
+
+
+
+#### Parameters
+
+| Name | Type | Description |
+|---|---|---|
+| _token | address | The address of ERC721 NFT on layer 1. |
+| _to | address | The address of recipient on layer 2. |
+| _tokenId | uint256 | The token id to deposit. |
+| _gasLimit | uint256 | Estimated gas limit required to complete the deposit on layer 2. |
+
+### depositERC721
+
+```solidity
+function depositERC721(address _token, uint256 _tokenId, uint256 _gasLimit) external payable
+```
+
+Deposit some ERC721 NFT to caller's account on layer 2.
+
+
+
+#### Parameters
+
+| Name | Type | Description |
+|---|---|---|
+| _token | address | The address of ERC721 NFT on layer 1. |
+| _tokenId | uint256 | The token id to deposit. |
+| _gasLimit | uint256 | Estimated gas limit required to complete the deposit on layer 2. |
+
+### finalizeBatchWithdrawERC721
+
+```solidity
+function finalizeBatchWithdrawERC721(address _l1Token, address _l2Token, address _from, address _to, uint256[] _tokenIds) external nonpayable
+```
+
+Complete ERC721 batch withdraw from layer 2 to layer 1 and send NFT to recipient's account on layer 1.
+
+*Requirements:  - The function should only be called by L1ScrollMessenger.  - The function should also only be called by L2ERC721Gateway on layer 2.*
+
+#### Parameters
+
+| Name | Type | Description |
+|---|---|---|
+| _l1Token | address | The address of corresponding layer 1 token. |
+| _l2Token | address | The address of corresponding layer 2 token. |
+| _from | address | The address of account who withdraw the token on layer 2. |
+| _to | address | The address of recipient on layer 1 to receive the token. |
+| _tokenIds | uint256[] | The list of token ids to withdraw. |
+
+### finalizeWithdrawERC721
+
+```solidity
+function finalizeWithdrawERC721(address _l1Token, address _l2Token, address _from, address _to, uint256 _tokenId) external nonpayable
+```
+
+Complete ERC721 withdraw from layer 2 to layer 1 and send NFT to recipient's account on layer 1.
+
+*Requirements:  - The function should only be called by L1ScrollMessenger.  - The function should also only be called by L2ERC721Gateway on layer 2.*
+
+#### Parameters
+
+| Name | Type | Description |
+|---|---|---|
+| _l1Token | address | The address of corresponding layer 1 token. |
+| _l2Token | address | The address of corresponding layer 2 token. |
+| _from | address | The address of account who withdraw the token on layer 2. |
+| _to | address | The address of recipient on layer 1 to receive the token. |
+| _tokenId | uint256 | The token id to withdraw. |
+
+### initialize
+
+```solidity
+function initialize(address _counterpart, address _messenger) external nonpayable
+```
+
+Initialize the storage of L1ERC721Gateway.
+
+*The parameters `_counterpart` and `_messenger` are no longer used.*
+
+#### Parameters
+
+| Name | Type | Description |
+|---|---|---|
+| _counterpart | address | The address of L2ERC721Gateway in L2. |
+| _messenger | address | The address of L1ScrollMessenger in L1. |
+
+### messenger
+
+```solidity
+function messenger() external view returns (address)
+```
+
+The address of corresponding L1ScrollMessenger/L2ScrollMessenger contract.
+
+
+
+
+#### Returns
+
+| Name | Type | Description |
+|---|---|---|
+| _0 | address | undefined |
+
+### onDropMessage
+
+```solidity
+function onDropMessage(bytes _message) external payable
+```
+
+
+
+
+
+#### Parameters
+
+| Name | Type | Description |
+|---|---|---|
+| _message | bytes | undefined |
+
+### onERC721Received
+
+```solidity
+function onERC721Received(address, address, uint256, bytes) external nonpayable returns (bytes4)
+```
+
+
+
+*See {IERC721Receiver-onERC721Received}. Always returns `IERC721Receiver.onERC721Received.selector`.*
+
+#### Parameters
+
+| Name | Type | Description |
+|---|---|---|
+| _0 | address | undefined |
+| _1 | address | undefined |
+| _2 | uint256 | undefined |
+| _3 | bytes | undefined |
+
+#### Returns
+
+| Name | Type | Description |
+|---|---|---|
+| _0 | bytes4 | undefined |
+
+### owner
+
+```solidity
+function owner() external view returns (address)
+```
+
+
+
+*Returns the address of the current owner.*
+
+
+#### Returns
+
+| Name | Type | Description |
+|---|---|---|
+| _0 | address | undefined |
+
+### renounceOwnership
+
+```solidity
+function renounceOwnership() external nonpayable
+```
+
+
+
+*Leaves the contract without owner. It will not be possible to call `onlyOwner` functions. Can only be called by the current owner. NOTE: Renouncing ownership will leave the contract without an owner, thereby disabling any functionality that is only available to the owner.*
+
+
+### router
+
+```solidity
+function router() external view returns (address)
+```
+
+The address of L1GatewayRouter/L2GatewayRouter contract.
+
+
+
+
+#### Returns
+
+| Name | Type | Description |
+|---|---|---|
+| _0 | address | undefined |
+
+### tokenMapping
+
+```solidity
+function tokenMapping(address) external view returns (address)
+```
+
+Mapping from l1 token address to l2 token address for ERC721 NFT.
+
+
+
+#### Parameters
+
+| Name | Type | Description |
+|---|---|---|
+| _0 | address | undefined |
+
+#### Returns
+
+| Name | Type | Description |
+|---|---|---|
+| _0 | address | undefined |
+
+### transferOwnership
+
+```solidity
+function transferOwnership(address newOwner) external nonpayable
+```
+
+
+
+*Transfers ownership of the contract to a new account (`newOwner`). Can only be called by the current owner.*
+
+#### Parameters
+
+| Name | Type | Description |
+|---|---|---|
+| newOwner | address | undefined |
+
+### updateTokenMapping
+
+```solidity
+function updateTokenMapping(address _l1Token, address _l2Token) external nonpayable
+```
+
+Update layer 2 to layer 2 token mapping.
+
+
+
+#### Parameters
+
+| Name | Type | Description |
+|---|---|---|
+| _l1Token | address | The address of ERC721 token on layer 1. |
+| _l2Token | address | The address of corresponding ERC721 token on layer 2. |
+
+
+
+## Events
+
+### BatchDepositERC721
+
+```solidity
+event BatchDepositERC721(address indexed _l1Token, address indexed _l2Token, address indexed _from, address _to, uint256[] _tokenIds)
+```
+
+Emitted when the ERC721 NFT is batch deposited to gateway on layer 1.
+
+
+
+#### Parameters
+
+| Name | Type | Description |
+|---|---|---|
+| _l1Token `indexed` | address | The address of ERC721 NFT on layer 1. |
+| _l2Token `indexed` | address | The address of ERC721 NFT on layer 2. |
+| _from `indexed` | address | The address of sender on layer 1. |
+| _to  | address | The address of recipient on layer 2. |
+| _tokenIds  | uint256[] | The list of token ids of the ERC721 NFT to deposit on layer 1. |
+
+### BatchRefundERC721
+
+```solidity
+event BatchRefundERC721(address indexed token, address indexed recipient, uint256[] tokenIds)
+```
+
+Emitted when a batch of ERC721 tokens are refunded.
+
+
+
+#### Parameters
+
+| Name | Type | Description |
+|---|---|---|
+| token `indexed` | address | The address of the token in L1. |
+| recipient `indexed` | address | The address of receiver in L1. |
+| tokenIds  | uint256[] | The list of token ids of the ERC721 NFT refunded. |
+
+### DepositERC721
+
+```solidity
+event DepositERC721(address indexed _l1Token, address indexed _l2Token, address indexed _from, address _to, uint256 _tokenId)
+```
+
+Emitted when the ERC721 NFT is deposited to gateway on layer 1.
+
+
+
+#### Parameters
+
+| Name | Type | Description |
+|---|---|---|
+| _l1Token `indexed` | address | The address of ERC721 NFT on layer 1. |
+| _l2Token `indexed` | address | The address of ERC721 NFT on layer 2. |
+| _from `indexed` | address | The address of sender on layer 1. |
+| _to  | address | The address of recipient on layer 2. |
+| _tokenId  | uint256 | The token id of the ERC721 NFT to deposit on layer 1. |
+
+### FinalizeBatchWithdrawERC721
+
+```solidity
+event FinalizeBatchWithdrawERC721(address indexed _l1Token, address indexed _l2Token, address indexed _from, address _to, uint256[] _tokenIds)
+```
+
+Emitted when the ERC721 NFT is batch transferred to recipient on layer 1.
+
+
+
+#### Parameters
+
+| Name | Type | Description |
+|---|---|---|
+| _l1Token `indexed` | address | The address of ERC721 NFT on layer 1. |
+| _l2Token `indexed` | address | The address of ERC721 NFT on layer 2. |
+| _from `indexed` | address | The address of sender on layer 2. |
+| _to  | address | The address of recipient on layer 1. |
+| _tokenIds  | uint256[] | The list of token ids of the ERC721 NFT to withdraw from layer 2. |
+
+### FinalizeWithdrawERC721
+
+```solidity
+event FinalizeWithdrawERC721(address indexed _l1Token, address indexed _l2Token, address indexed _from, address _to, uint256 _tokenId)
+```
+
+Emitted when the ERC721 NFT is transferred to recipient on layer 1.
+
+
+
+#### Parameters
+
+| Name | Type | Description |
+|---|---|---|
+| _l1Token `indexed` | address | The address of ERC721 NFT on layer 1. |
+| _l2Token `indexed` | address | The address of ERC721 NFT on layer 2. |
+| _from `indexed` | address | The address of sender on layer 2. |
+| _to  | address | The address of recipient on layer 1. |
+| _tokenId  | uint256 | The token id of the ERC721 NFT to withdraw from layer 2. |
+
+### Initialized
+
+```solidity
+event Initialized(uint8 version)
+```
+
+
+
+*Triggered when the contract has been initialized or reinitialized.*
+
+#### Parameters
+
+| Name | Type | Description |
+|---|---|---|
+| version  | uint8 | undefined |
+
+### OwnershipTransferred
+
+```solidity
+event OwnershipTransferred(address indexed previousOwner, address indexed newOwner)
+```
+
+
+
+
+
+#### Parameters
+
+| Name | Type | Description |
+|---|---|---|
+| previousOwner `indexed` | address | undefined |
+| newOwner `indexed` | address | undefined |
+
+### RefundERC721
+
+```solidity
+event RefundERC721(address indexed token, address indexed recipient, uint256 tokenId)
+```
+
+Emitted when some ERC721 token is refunded.
+
+
+
+#### Parameters
+
+| Name | Type | Description |
+|---|---|---|
+| token `indexed` | address | The address of the token in L1. |
+| recipient `indexed` | address | The address of receiver in L1. |
+| tokenId  | uint256 | The id of token refunded. |
+
+### UpdateTokenMapping
+
+```solidity
+event UpdateTokenMapping(address indexed l1Token, address indexed oldL2Token, address indexed newL2Token)
+```
+
+Emitted when token mapping for ERC721 token is updated.
+
+
+
+#### Parameters
+
+| Name | Type | Description |
+|---|---|---|
+| l1Token `indexed` | address | The address of ERC721 token in layer 1. |
+| oldL2Token `indexed` | address | The address of the old corresponding ERC721 token in layer 2. |
+| newL2Token `indexed` | address | The address of the new corresponding ERC721 token in layer 2. |
+
+
+
+## Errors
+
+### ErrorCallerIsNotCounterpartGateway
+
+```solidity
+error ErrorCallerIsNotCounterpartGateway()
+```
+
+
+
+*Thrown when the cross chain sender is not the counterpart gateway contract.*
+
+
+### ErrorCallerIsNotMessenger
+
+```solidity
+error ErrorCallerIsNotMessenger()
+```
+
+
+
+*Thrown when the caller is not corresponding `L1ScrollMessenger` or `L2ScrollMessenger`.*
+
+
+### ErrorNotInDropMessageContext
+
+```solidity
+error ErrorNotInDropMessageContext()
+```
+
+
+
+*Thrown when ScrollMessenger is not dropping message.*
+
+
+### ErrorZeroAddress
+
+```solidity
+error ErrorZeroAddress()
+```
+
+
+
+*Thrown when the given address is `address(0)`.*
+
+
+

contracts/docs/apis/L1GatewayRouter.md

@@ -0,0 +1,620 @@
+# L1GatewayRouter
+
+
+
+> L1GatewayRouter
+
+The `L1GatewayRouter` is the main entry for depositing Ether and ERC20 tokens. All deposited tokens are routed to corresponding gateways.
+
+*One can also use this contract to query L1/L2 token address mapping. In the future, ERC-721 and ERC-1155 tokens will be added to the router too.*
+
+## Methods
+
+### ERC20Gateway
+
+```solidity
+function ERC20Gateway(address) external view returns (address)
+```
+
+Mapping from ERC20 token address to corresponding L1ERC20Gateway.
+
+
+
+#### Parameters
+
+| Name | Type | Description |
+|---|---|---|
+| _0 | address | undefined |
+
+#### Returns
+
+| Name | Type | Description |
+|---|---|---|
+| _0 | address | undefined |
+
+### defaultERC20Gateway
+
+```solidity
+function defaultERC20Gateway() external view returns (address)
+```
+
+The addess of default ERC20 gateway, normally the L1StandardERC20Gateway contract.
+
+
+
+
+#### Returns
+
+| Name | Type | Description |
+|---|---|---|
+| _0 | address | undefined |
+
+### depositERC20
+
+```solidity
+function depositERC20(address _token, uint256 _amount, uint256 _gasLimit) external payable
+```
+
+Deposit some token to a caller's account on L2.
+
+*Make this function payable to send relayer fee in Ether.*
+
+#### Parameters
+
+| Name | Type | Description |
+|---|---|---|
+| _token | address | The address of token in L1. |
+| _amount | uint256 | The amount of token to transfer. |
+| _gasLimit | uint256 | Gas limit required to complete the deposit on L2. |
+
+### depositERC20
+
+```solidity
+function depositERC20(address _token, address _to, uint256 _amount, uint256 _gasLimit) external payable
+```
+
+Deposit some token to a recipient's account on L2.
+
+*Make this function payable to send relayer fee in Ether.*
+
+#### Parameters
+
+| Name | Type | Description |
+|---|---|---|
+| _token | address | The address of token in L1. |
+| _to | address | The address of recipient's account on L2. |
+| _amount | uint256 | The amount of token to transfer. |
+| _gasLimit | uint256 | Gas limit required to complete the deposit on L2. |
+
+### depositERC20AndCall
+
+```solidity
+function depositERC20AndCall(address _token, address _to, uint256 _amount, bytes _data, uint256 _gasLimit) external payable
+```
+
+Deposit some token to a recipient's account on L2 and call.
+
+*Make this function payable to send relayer fee in Ether.*
+
+#### Parameters
+
+| Name | Type | Description |
+|---|---|---|
+| _token | address | The address of token in L1. |
+| _to | address | The address of recipient's account on L2. |
+| _amount | uint256 | The amount of token to transfer. |
+| _data | bytes | Optional data to forward to recipient's account. |
+| _gasLimit | uint256 | Gas limit required to complete the deposit on L2. |
+
+### depositETH
+
+```solidity
+function depositETH(uint256 _amount, uint256 _gasLimit) external payable
+```
+
+Deposit ETH to caller's account in L2.
+
+
+
+#### Parameters
+
+| Name | Type | Description |
+|---|---|---|
+| _amount | uint256 | undefined |
+| _gasLimit | uint256 | undefined |
+
+### depositETH
+
+```solidity
+function depositETH(address _to, uint256 _amount, uint256 _gasLimit) external payable
+```
+
+Deposit ETH to some recipient's account in L2.
+
+
+
+#### Parameters
+
+| Name | Type | Description |
+|---|---|---|
+| _to | address | undefined |
+| _amount | uint256 | undefined |
+| _gasLimit | uint256 | undefined |
+
+### depositETHAndCall
+
+```solidity
+function depositETHAndCall(address _to, uint256 _amount, bytes _data, uint256 _gasLimit) external payable
+```
+
+Deposit ETH to some recipient's account in L2 and call the target contract.
+
+
+
+#### Parameters
+
+| Name | Type | Description |
+|---|---|---|
+| _to | address | undefined |
+| _amount | uint256 | undefined |
+| _data | bytes | undefined |
+| _gasLimit | uint256 | undefined |
+
+### ethGateway
+
+```solidity
+function ethGateway() external view returns (address)
+```
+
+The address of L1ETHGateway.
+
+
+
+
+#### Returns
+
+| Name | Type | Description |
+|---|---|---|
+| _0 | address | undefined |
+
+### finalizeWithdrawERC20
+
+```solidity
+function finalizeWithdrawERC20(address, address, address, address, uint256, bytes) external payable
+```
+
+Complete ERC20 withdraw from L2 to L1 and send fund to recipient's account in L1.
+
+*Make this function payable to handle WETH deposit/withdraw.      The function should only be called by L1ScrollMessenger.      The function should also only be called by L2ERC20Gateway in L2.*
+
+#### Parameters
+
+| Name | Type | Description |
+|---|---|---|
+| _0 | address | undefined |
+| _1 | address | undefined |
+| _2 | address | undefined |
+| _3 | address | undefined |
+| _4 | uint256 | undefined |
+| _5 | bytes | undefined |
+
+### finalizeWithdrawETH
+
+```solidity
+function finalizeWithdrawETH(address, address, uint256, bytes) external payable
+```
+
+Complete ETH withdraw from L2 to L1 and send fund to recipient's account in L1.
+
+*This function should only be called by L1ScrollMessenger.      This function should also only be called by L1ETHGateway in L2.*
+
+#### Parameters
+
+| Name | Type | Description |
+|---|---|---|
+| _0 | address | undefined |
+| _1 | address | undefined |
+| _2 | uint256 | undefined |
+| _3 | bytes | undefined |
+
+### gatewayInContext
+
+```solidity
+function gatewayInContext() external view returns (address)
+```
+
+The address of gateway in current execution context.
+
+
+
+
+#### Returns
+
+| Name | Type | Description |
+|---|---|---|
+| _0 | address | undefined |
+
+### getERC20Gateway
+
+```solidity
+function getERC20Gateway(address _token) external view returns (address)
+```
+
+Return the corresponding gateway address for given token address.
+
+
+
+#### Parameters
+
+| Name | Type | Description |
+|---|---|---|
+| _token | address | The address of token to query. |
+
+#### Returns
+
+| Name | Type | Description |
+|---|---|---|
+| _0 | address | undefined |
+
+### getL2ERC20Address
+
+```solidity
+function getL2ERC20Address(address _l1Address) external view returns (address)
+```
+
+Return the corresponding l2 token address given l1 token address.
+
+
+
+#### Parameters
+
+| Name | Type | Description |
+|---|---|---|
+| _l1Address | address | undefined |
+
+#### Returns
+
+| Name | Type | Description |
+|---|---|---|
+| _0 | address | undefined |
+
+### initialize
+
+```solidity
+function initialize(address _ethGateway, address _defaultERC20Gateway) external nonpayable
+```
+
+Initialize the storage of L1GatewayRouter.
+
+
+
+#### Parameters
+
+| Name | Type | Description |
+|---|---|---|
+| _ethGateway | address | The address of L1ETHGateway contract. |
+| _defaultERC20Gateway | address | The address of default ERC20 Gateway contract. |
+
+### owner
+
+```solidity
+function owner() external view returns (address)
+```
+
+
+
+*Returns the address of the current owner.*
+
+
+#### Returns
+
+| Name | Type | Description |
+|---|---|---|
+| _0 | address | undefined |
+
+### renounceOwnership
+
+```solidity
+function renounceOwnership() external nonpayable
+```
+
+
+
+*Leaves the contract without owner. It will not be possible to call `onlyOwner` functions. Can only be called by the current owner. NOTE: Renouncing ownership will leave the contract without an owner, thereby disabling any functionality that is only available to the owner.*
+
+
+### requestERC20
+
+```solidity
+function requestERC20(address _sender, address _token, uint256 _amount) external nonpayable returns (uint256)
+```
+
+Request ERC20 token transfer from users to gateways.
+
+*All the gateways should have reentrancy guard to prevent potential attack though this function.*
+
+#### Parameters
+
+| Name | Type | Description |
+|---|---|---|
+| _sender | address | undefined |
+| _token | address | undefined |
+| _amount | uint256 | undefined |
+
+#### Returns
+
+| Name | Type | Description |
+|---|---|---|
+| _0 | uint256 | undefined |
+
+### setDefaultERC20Gateway
+
+```solidity
+function setDefaultERC20Gateway(address _newDefaultERC20Gateway) external nonpayable
+```
+
+Update the address of default ERC20 gateway contract.
+
+*This function should only be called by contract owner.*
+
+#### Parameters
+
+| Name | Type | Description |
+|---|---|---|
+| _newDefaultERC20Gateway | address | undefined |
+
+### setERC20Gateway
+
+```solidity
+function setERC20Gateway(address[] _tokens, address[] _gateways) external nonpayable
+```
+
+Update the mapping from token address to gateway address.
+
+*This function should only be called by contract owner.*
+
+#### Parameters
+
+| Name | Type | Description |
+|---|---|---|
+| _tokens | address[] | The list of addresses of tokens to update. |
+| _gateways | address[] | The list of addresses of gateways to update. |
+
+### setETHGateway
+
+```solidity
+function setETHGateway(address _newEthGateway) external nonpayable
+```
+
+Update the address of ETH gateway contract.
+
+*This function should only be called by contract owner.*
+
+#### Parameters
+
+| Name | Type | Description |
+|---|---|---|
+| _newEthGateway | address | undefined |
+
+### transferOwnership
+
+```solidity
+function transferOwnership(address newOwner) external nonpayable
+```
+
+
+
+*Transfers ownership of the contract to a new account (`newOwner`). Can only be called by the current owner.*
+
+#### Parameters
+
+| Name | Type | Description |
+|---|---|---|
+| newOwner | address | undefined |
+
+
+
+## Events
+
+### DepositERC20
+
+```solidity
+event DepositERC20(address indexed l1Token, address indexed l2Token, address indexed from, address to, uint256 amount, bytes data)
+```
+
+Emitted when someone deposit ERC20 token from L1 to L2.
+
+
+
+#### Parameters
+
+| Name | Type | Description |
+|---|---|---|
+| l1Token `indexed` | address | The address of the token in L1. |
+| l2Token `indexed` | address | The address of the token in L2. |
+| from `indexed` | address | The address of sender in L1. |
+| to  | address | The address of recipient in L2. |
+| amount  | uint256 | The amount of token will be deposited from L1 to L2. |
+| data  | bytes | The optional calldata passed to recipient in L2. |
+
+### DepositETH
+
+```solidity
+event DepositETH(address indexed from, address indexed to, uint256 amount, bytes data)
+```
+
+Emitted when someone deposit ETH from L1 to L2.
+
+
+
+#### Parameters
+
+| Name | Type | Description |
+|---|---|---|
+| from `indexed` | address | The address of sender in L1. |
+| to `indexed` | address | The address of recipient in L2. |
+| amount  | uint256 | The amount of ETH will be deposited from L1 to L2. |
+| data  | bytes | The optional calldata passed to recipient in L2. |
+
+### FinalizeWithdrawERC20
+
+```solidity
+event FinalizeWithdrawERC20(address indexed l1Token, address indexed l2Token, address indexed from, address to, uint256 amount, bytes data)
+```
+
+Emitted when ERC20 token is withdrawn from L2 to L1 and transfer to recipient.
+
+
+
+#### Parameters
+
+| Name | Type | Description |
+|---|---|---|
+| l1Token `indexed` | address | The address of the token in L1. |
+| l2Token `indexed` | address | The address of the token in L2. |
+| from `indexed` | address | The address of sender in L2. |
+| to  | address | The address of recipient in L1. |
+| amount  | uint256 | The amount of token withdrawn from L2 to L1. |
+| data  | bytes | The optional calldata passed to recipient in L1. |
+
+### FinalizeWithdrawETH
+
+```solidity
+event FinalizeWithdrawETH(address indexed from, address indexed to, uint256 amount, bytes data)
+```
+
+Emitted when ETH is withdrawn from L2 to L1 and transfer to recipient.
+
+
+
+#### Parameters
+
+| Name | Type | Description |
+|---|---|---|
+| from `indexed` | address | The address of sender in L2. |
+| to `indexed` | address | The address of recipient in L1. |
+| amount  | uint256 | The amount of ETH withdrawn from L2 to L1. |
+| data  | bytes | The optional calldata passed to recipient in L1. |
+
+### Initialized
+
+```solidity
+event Initialized(uint8 version)
+```
+
+
+
+*Triggered when the contract has been initialized or reinitialized.*
+
+#### Parameters
+
+| Name | Type | Description |
+|---|---|---|
+| version  | uint8 | undefined |
+
+### OwnershipTransferred
+
+```solidity
+event OwnershipTransferred(address indexed previousOwner, address indexed newOwner)
+```
+
+
+
+
+
+#### Parameters
+
+| Name | Type | Description |
+|---|---|---|
+| previousOwner `indexed` | address | undefined |
+| newOwner `indexed` | address | undefined |
+
+### RefundERC20
+
+```solidity
+event RefundERC20(address indexed token, address indexed recipient, uint256 amount)
+```
+
+Emitted when some ERC20 token is refunded.
+
+
+
+#### Parameters
+
+| Name | Type | Description |
+|---|---|---|
+| token `indexed` | address | The address of the token in L1. |
+| recipient `indexed` | address | The address of receiver in L1. |
+| amount  | uint256 | The amount of token refunded to receiver. |
+
+### RefundETH
+
+```solidity
+event RefundETH(address indexed recipient, uint256 amount)
+```
+
+Emitted when some ETH is refunded.
+
+
+
+#### Parameters
+
+| Name | Type | Description |
+|---|---|---|
+| recipient `indexed` | address | The address of receiver in L1. |
+| amount  | uint256 | The amount of ETH refunded to receiver. |
+
+### SetDefaultERC20Gateway
+
+```solidity
+event SetDefaultERC20Gateway(address indexed oldDefaultERC20Gateway, address indexed newDefaultERC20Gateway)
+```
+
+Emitted when the address of default ERC20 Gateway is updated.
+
+
+
+#### Parameters
+
+| Name | Type | Description |
+|---|---|---|
+| oldDefaultERC20Gateway `indexed` | address | The address of the old default ERC20 Gateway. |
+| newDefaultERC20Gateway `indexed` | address | The address of the new default ERC20 Gateway. |
+
+### SetERC20Gateway
+
+```solidity
+event SetERC20Gateway(address indexed token, address indexed oldGateway, address indexed newGateway)
+```
+
+Emitted when the `gateway` for `token` is updated.
+
+
+
+#### Parameters
+
+| Name | Type | Description |
+|---|---|---|
+| token `indexed` | address | The address of token updated. |
+| oldGateway `indexed` | address | The corresponding address of the old gateway. |
+| newGateway `indexed` | address | The corresponding address of the new gateway. |
+
+### SetETHGateway
+
+```solidity
+event SetETHGateway(address indexed oldETHGateway, address indexed newEthGateway)
+```
+
+Emitted when the address of ETH Gateway is updated.
+
+
+
+#### Parameters
+
+| Name | Type | Description |
+|---|---|---|
+| oldETHGateway `indexed` | address | The address of the old ETH Gateway. |
+| newEthGateway `indexed` | address | The address of the new ETH Gateway. |
+
+
+

contracts/docs/apis/L1ScrollMessenger.md

@@ -0,0 +1,627 @@
+# L1ScrollMessenger
+
+
+
+> L1ScrollMessenger
+
+The `L1ScrollMessenger` contract can: 1. send messages from layer 1 to layer 2; 2. relay messages from layer 2 layer 1; 3. replay failed message by replacing the gas limit; 4. drop expired message due to sequencer problems.
+
+*All deposited Ether (including `WETH` deposited throng `L1WETHGateway`) will locked in this contract.*
+
+## Methods
+
+### counterpart
+
+```solidity
+function counterpart() external view returns (address)
+```
+
+The address of counterpart ScrollMessenger contract in L1/L2.
+
+
+
+
+#### Returns
+
+| Name | Type | Description |
+|---|---|---|
+| _0 | address | undefined |
+
+### dropMessage
+
+```solidity
+function dropMessage(address _from, address _to, uint256 _value, uint256 _messageNonce, bytes _message) external nonpayable
+```
+
+Drop a skipped message.
+
+
+
+#### Parameters
+
+| Name | Type | Description |
+|---|---|---|
+| _from | address | undefined |
+| _to | address | undefined |
+| _value | uint256 | undefined |
+| _messageNonce | uint256 | undefined |
+| _message | bytes | undefined |
+
+### feeVault
+
+```solidity
+function feeVault() external view returns (address)
+```
+
+The address of fee vault, collecting cross domain messaging fee.
+
+
+
+
+#### Returns
+
+| Name | Type | Description |
+|---|---|---|
+| _0 | address | undefined |
+
+### initialize
+
+```solidity
+function initialize(address _counterpart, address _feeVault, address _rollup, address _messageQueue) external nonpayable
+```
+
+Initialize the storage of L1ScrollMessenger.
+
+*The parameters `_counterpart`, `_rollup` and `_messageQueue` are no longer used.*
+
+#### Parameters
+
+| Name | Type | Description |
+|---|---|---|
+| _counterpart | address | The address of L2ScrollMessenger contract in L2. |
+| _feeVault | address | The address of fee vault, which will be used to collect relayer fee. |
+| _rollup | address | The address of ScrollChain contract. |
+| _messageQueue | address | The address of L1MessageQueue contract. |
+
+### isL1MessageDropped
+
+```solidity
+function isL1MessageDropped(bytes32) external view returns (bool)
+```
+
+Mapping from L1 message hash to drop status.
+
+
+
+#### Parameters
+
+| Name | Type | Description |
+|---|---|---|
+| _0 | bytes32 | undefined |
+
+#### Returns
+
+| Name | Type | Description |
+|---|---|---|
+| _0 | bool | undefined |
+
+### isL2MessageExecuted
+
+```solidity
+function isL2MessageExecuted(bytes32) external view returns (bool)
+```
+
+Mapping from L2 message hash to a boolean value indicating if the message has been successfully executed.
+
+
+
+#### Parameters
+
+| Name | Type | Description |
+|---|---|---|
+| _0 | bytes32 | undefined |
+
+#### Returns
+
+| Name | Type | Description |
+|---|---|---|
+| _0 | bool | undefined |
+
+### maxReplayTimes
+
+```solidity
+function maxReplayTimes() external view returns (uint256)
+```
+
+The maximum number of times each L1 message can be replayed.
+
+
+
+
+#### Returns
+
+| Name | Type | Description |
+|---|---|---|
+| _0 | uint256 | undefined |
+
+### messageQueue
+
+```solidity
+function messageQueue() external view returns (address)
+```
+
+The address of L1MessageQueue contract.
+
+
+
+
+#### Returns
+
+| Name | Type | Description |
+|---|---|---|
+| _0 | address | undefined |
+
+### messageSendTimestamp
+
+```solidity
+function messageSendTimestamp(bytes32) external view returns (uint256)
+```
+
+Mapping from L1 message hash to the timestamp when the message is sent.
+
+
+
+#### Parameters
+
+| Name | Type | Description |
+|---|---|---|
+| _0 | bytes32 | undefined |
+
+#### Returns
+
+| Name | Type | Description |
+|---|---|---|
+| _0 | uint256 | undefined |
+
+### owner
+
+```solidity
+function owner() external view returns (address)
+```
+
+
+
+*Returns the address of the current owner.*
+
+
+#### Returns
+
+| Name | Type | Description |
+|---|---|---|
+| _0 | address | undefined |
+
+### paused
+
+```solidity
+function paused() external view returns (bool)
+```
+
+
+
+*Returns true if the contract is paused, and false otherwise.*
+
+
+#### Returns
+
+| Name | Type | Description |
+|---|---|---|
+| _0 | bool | undefined |
+
+### prevReplayIndex
+
+```solidity
+function prevReplayIndex(uint256) external view returns (uint256)
+```
+
+Mapping from queue index to previous replay queue index.
+
+*If a message `x` was replayed 3 times with index `q1`, `q2` and `q3`, the value of `prevReplayIndex` and `replayStates` will be `replayStates[hash(x)].lastIndex = q3`, `replayStates[hash(x)].times = 3`, `prevReplayIndex[q3] = q2`, `prevReplayIndex[q2] = q1`, `prevReplayIndex[q1] = x` and `prevReplayIndex[x]=nil`.The index `x` that `prevReplayIndex[x]=nil` is used as the termination of the list. Usually we use `0` to represent `nil`, but we cannot distinguish it with the first message with index zero. So a nonzero offset `1` is added to the value of `prevReplayIndex[x]` to avoid such situation.*
+
+#### Parameters
+
+| Name | Type | Description |
+|---|---|---|
+| _0 | uint256 | undefined |
+
+#### Returns
+
+| Name | Type | Description |
+|---|---|---|
+| _0 | uint256 | undefined |
+
+### relayMessageWithProof
+
+```solidity
+function relayMessageWithProof(address _from, address _to, uint256 _value, uint256 _nonce, bytes _message, IL1ScrollMessenger.L2MessageProof _proof) external nonpayable
+```
+
+
+
+
+
+#### Parameters
+
+| Name | Type | Description |
+|---|---|---|
+| _from | address | undefined |
+| _to | address | undefined |
+| _value | uint256 | undefined |
+| _nonce | uint256 | undefined |
+| _message | bytes | undefined |
+| _proof | IL1ScrollMessenger.L2MessageProof | undefined |
+
+### renounceOwnership
+
+```solidity
+function renounceOwnership() external nonpayable
+```
+
+
+
+*Leaves the contract without owner. It will not be possible to call `onlyOwner` functions. Can only be called by the current owner. NOTE: Renouncing ownership will leave the contract without an owner, thereby disabling any functionality that is only available to the owner.*
+
+
+### replayMessage
+
+```solidity
+function replayMessage(address _from, address _to, uint256 _value, uint256 _messageNonce, bytes _message, uint32 _newGasLimit, address _refundAddress) external payable
+```
+
+Replay an existing message.
+
+
+
+#### Parameters
+
+| Name | Type | Description |
+|---|---|---|
+| _from | address | undefined |
+| _to | address | undefined |
+| _value | uint256 | undefined |
+| _messageNonce | uint256 | undefined |
+| _message | bytes | undefined |
+| _newGasLimit | uint32 | undefined |
+| _refundAddress | address | undefined |
+
+### replayStates
+
+```solidity
+function replayStates(bytes32) external view returns (uint128 times, uint128 lastIndex)
+```
+
+Mapping from L1 message hash to replay state.
+
+
+
+#### Parameters
+
+| Name | Type | Description |
+|---|---|---|
+| _0 | bytes32 | undefined |
+
+#### Returns
+
+| Name | Type | Description |
+|---|---|---|
+| times | uint128 | undefined |
+| lastIndex | uint128 | undefined |
+
+### rollup
+
+```solidity
+function rollup() external view returns (address)
+```
+
+The address of Rollup contract.
+
+
+
+
+#### Returns
+
+| Name | Type | Description |
+|---|---|---|
+| _0 | address | undefined |
+
+### sendMessage
+
+```solidity
+function sendMessage(address _to, uint256 _value, bytes _message, uint256 _gasLimit, address _refundAddress) external payable
+```
+
+Send cross chain message from L1 to L2 or L2 to L1.
+
+
+
+#### Parameters
+
+| Name | Type | Description |
+|---|---|---|
+| _to | address | undefined |
+| _value | uint256 | undefined |
+| _message | bytes | undefined |
+| _gasLimit | uint256 | undefined |
+| _refundAddress | address | undefined |
+
+### sendMessage
+
+```solidity
+function sendMessage(address _to, uint256 _value, bytes _message, uint256 _gasLimit) external payable
+```
+
+Send cross chain message from L1 to L2 or L2 to L1.
+
+
+
+#### Parameters
+
+| Name | Type | Description |
+|---|---|---|
+| _to | address | undefined |
+| _value | uint256 | undefined |
+| _message | bytes | undefined |
+| _gasLimit | uint256 | undefined |
+
+### setPause
+
+```solidity
+function setPause(bool _status) external nonpayable
+```
+
+Pause the contract
+
+*This function can only called by contract owner.*
+
+#### Parameters
+
+| Name | Type | Description |
+|---|---|---|
+| _status | bool | The pause status to update. |
+
+### transferOwnership
+
+```solidity
+function transferOwnership(address newOwner) external nonpayable
+```
+
+
+
+*Transfers ownership of the contract to a new account (`newOwner`). Can only be called by the current owner.*
+
+#### Parameters
+
+| Name | Type | Description |
+|---|---|---|
+| newOwner | address | undefined |
+
+### updateFeeVault
+
+```solidity
+function updateFeeVault(address _newFeeVault) external nonpayable
+```
+
+Update fee vault contract.
+
+*This function can only called by contract owner.*
+
+#### Parameters
+
+| Name | Type | Description |
+|---|---|---|
+| _newFeeVault | address | The address of new fee vault contract. |
+
+### updateMaxReplayTimes
+
+```solidity
+function updateMaxReplayTimes(uint256 _newMaxReplayTimes) external nonpayable
+```
+
+Update max replay times.
+
+*This function can only called by contract owner.*
+
+#### Parameters
+
+| Name | Type | Description |
+|---|---|---|
+| _newMaxReplayTimes | uint256 | The new max replay times. |
+
+### xDomainMessageSender
+
+```solidity
+function xDomainMessageSender() external view returns (address)
+```
+
+See {IScrollMessenger-xDomainMessageSender}
+
+
+
+
+#### Returns
+
+| Name | Type | Description |
+|---|---|---|
+| _0 | address | undefined |
+
+
+
+## Events
+
+### FailedRelayedMessage
+
+```solidity
+event FailedRelayedMessage(bytes32 indexed messageHash)
+```
+
+Emitted when a cross domain message is failed to relay.
+
+
+
+#### Parameters
+
+| Name | Type | Description |
+|---|---|---|
+| messageHash `indexed` | bytes32 | The hash of the message. |
+
+### Initialized
+
+```solidity
+event Initialized(uint8 version)
+```
+
+
+
+*Triggered when the contract has been initialized or reinitialized.*
+
+#### Parameters
+
+| Name | Type | Description |
+|---|---|---|
+| version  | uint8 | undefined |
+
+### OwnershipTransferred
+
+```solidity
+event OwnershipTransferred(address indexed previousOwner, address indexed newOwner)
+```
+
+
+
+
+
+#### Parameters
+
+| Name | Type | Description |
+|---|---|---|
+| previousOwner `indexed` | address | undefined |
+| newOwner `indexed` | address | undefined |
+
+### Paused
+
+```solidity
+event Paused(address account)
+```
+
+
+
+*Emitted when the pause is triggered by `account`.*
+
+#### Parameters
+
+| Name | Type | Description |
+|---|---|---|
+| account  | address | undefined |
+
+### RelayedMessage
+
+```solidity
+event RelayedMessage(bytes32 indexed messageHash)
+```
+
+Emitted when a cross domain message is relayed successfully.
+
+
+
+#### Parameters
+
+| Name | Type | Description |
+|---|---|---|
+| messageHash `indexed` | bytes32 | The hash of the message. |
+
+### SentMessage
+
+```solidity
+event SentMessage(address indexed sender, address indexed target, uint256 value, uint256 messageNonce, uint256 gasLimit, bytes message)
+```
+
+Emitted when a cross domain message is sent.
+
+
+
+#### Parameters
+
+| Name | Type | Description |
+|---|---|---|
+| sender `indexed` | address | The address of the sender who initiates the message. |
+| target `indexed` | address | The address of target contract to call. |
+| value  | uint256 | The amount of value passed to the target contract. |
+| messageNonce  | uint256 | The nonce of the message. |
+| gasLimit  | uint256 | The optional gas limit passed to L1 or L2. |
+| message  | bytes | The calldata passed to the target contract. |
+
+### Unpaused
+
+```solidity
+event Unpaused(address account)
+```
+
+
+
+*Emitted when the pause is lifted by `account`.*
+
+#### Parameters
+
+| Name | Type | Description |
+|---|---|---|
+| account  | address | undefined |
+
+### UpdateFeeVault
+
+```solidity
+event UpdateFeeVault(address _oldFeeVault, address _newFeeVault)
+```
+
+Emitted when owner updates fee vault contract.
+
+
+
+#### Parameters
+
+| Name | Type | Description |
+|---|---|---|
+| _oldFeeVault  | address | The address of old fee vault contract. |
+| _newFeeVault  | address | The address of new fee vault contract. |
+
+### UpdateMaxReplayTimes
+
+```solidity
+event UpdateMaxReplayTimes(uint256 oldMaxReplayTimes, uint256 newMaxReplayTimes)
+```
+
+Emitted when the maximum number of times each message can be replayed is updated.
+
+
+
+#### Parameters
+
+| Name | Type | Description |
+|---|---|---|
+| oldMaxReplayTimes  | uint256 | The old maximum number of times each message can be replayed. |
+| newMaxReplayTimes  | uint256 | The new maximum number of times each message can be replayed. |
+
+
+
+## Errors
+
+### ErrorZeroAddress
+
+```solidity
+error ErrorZeroAddress()
+```
+
+
+
+*Thrown when the given address is `address(0)`.*
+
+
+

contracts/docs/apis/L1StandardERC20Gateway.md

@@ -0,0 +1,423 @@
+# L1StandardERC20Gateway
+
+
+
+> L1StandardERC20Gateway
+
+The `L1StandardERC20Gateway` is used to deposit standard ERC20 tokens on layer 1 and finalize withdraw the tokens from layer 2.
+
+*The deposited ERC20 tokens are held in this gateway. On finalizing withdraw, the corresponding token will be transfer to the recipient directly. Any ERC20 that requires non-standard functionality should use a separate gateway.*
+
+## Methods
+
+### counterpart
+
+```solidity
+function counterpart() external view returns (address)
+```
+
+The address of corresponding L1/L2 Gateway contract.
+
+
+
+
+#### Returns
+
+| Name | Type | Description |
+|---|---|---|
+| _0 | address | undefined |
+
+### depositERC20
+
+```solidity
+function depositERC20(address _token, uint256 _amount, uint256 _gasLimit) external payable
+```
+
+Deposit some token to a caller's account on L2.
+
+*Make this function payable to send relayer fee in Ether.*
+
+#### Parameters
+
+| Name | Type | Description |
+|---|---|---|
+| _token | address | The address of token in L1. |
+| _amount | uint256 | The amount of token to transfer. |
+| _gasLimit | uint256 | Gas limit required to complete the deposit on L2. |
+
+### depositERC20
+
+```solidity
+function depositERC20(address _token, address _to, uint256 _amount, uint256 _gasLimit) external payable
+```
+
+Deposit some token to a recipient's account on L2.
+
+*Make this function payable to send relayer fee in Ether.*
+
+#### Parameters
+
+| Name | Type | Description |
+|---|---|---|
+| _token | address | The address of token in L1. |
+| _to | address | The address of recipient's account on L2. |
+| _amount | uint256 | The amount of token to transfer. |
+| _gasLimit | uint256 | Gas limit required to complete the deposit on L2. |
+
+### depositERC20AndCall
+
+```solidity
+function depositERC20AndCall(address _token, address _to, uint256 _amount, bytes _data, uint256 _gasLimit) external payable
+```
+
+Deposit some token to a recipient's account on L2 and call.
+
+*Make this function payable to send relayer fee in Ether.*
+
+#### Parameters
+
+| Name | Type | Description |
+|---|---|---|
+| _token | address | The address of token in L1. |
+| _to | address | The address of recipient's account on L2. |
+| _amount | uint256 | The amount of token to transfer. |
+| _data | bytes | Optional data to forward to recipient's account. |
+| _gasLimit | uint256 | Gas limit required to complete the deposit on L2. |
+
+### finalizeWithdrawERC20
+
+```solidity
+function finalizeWithdrawERC20(address _l1Token, address _l2Token, address _from, address _to, uint256 _amount, bytes _data) external payable
+```
+
+Complete ERC20 withdraw from L2 to L1 and send fund to recipient's account in L1.
+
+*Make this function payable to handle WETH deposit/withdraw.      The function should only be called by L1ScrollMessenger.      The function should also only be called by L2ERC20Gateway in L2.*
+
+#### Parameters
+
+| Name | Type | Description |
+|---|---|---|
+| _l1Token | address | The address of corresponding L1 token. |
+| _l2Token | address | The address of corresponding L2 token. |
+| _from | address | The address of account who withdraw the token in L2. |
+| _to | address | The address of recipient in L1 to receive the token. |
+| _amount | uint256 | The amount of the token to withdraw. |
+| _data | bytes | Optional data to forward to recipient's account. |
+
+### getL2ERC20Address
+
+```solidity
+function getL2ERC20Address(address _l1Token) external view returns (address)
+```
+
+Return the corresponding l2 token address given l1 token address.
+
+
+
+#### Parameters
+
+| Name | Type | Description |
+|---|---|---|
+| _l1Token | address | The address of l1 token. |
+
+#### Returns
+
+| Name | Type | Description |
+|---|---|---|
+| _0 | address | undefined |
+
+### initialize
+
+```solidity
+function initialize(address _counterpart, address _router, address _messenger, address, address) external nonpayable
+```
+
+Initialize the storage of L1StandardERC20Gateway.
+
+*The parameters `_counterpart`, `_router`, `_messenger`, `_l2TokenImplementation` and `_l2TokenFactory` are no longer used.*
+
+#### Parameters
+
+| Name | Type | Description |
+|---|---|---|
+| _counterpart | address | The address of L2StandardERC20Gateway in L2. |
+| _router | address | The address of L1GatewayRouter in L1. |
+| _messenger | address | The address of L1ScrollMessenger in L1. |
+| _3 | address | undefined |
+| _4 | address | undefined |
+
+### l2TokenFactory
+
+```solidity
+function l2TokenFactory() external view returns (address)
+```
+
+The address of ScrollStandardERC20Factory contract in L2.
+
+
+
+
+#### Returns
+
+| Name | Type | Description |
+|---|---|---|
+| _0 | address | undefined |
+
+### l2TokenImplementation
+
+```solidity
+function l2TokenImplementation() external view returns (address)
+```
+
+The address of ScrollStandardERC20 implementation in L2.
+
+
+
+
+#### Returns
+
+| Name | Type | Description |
+|---|---|---|
+| _0 | address | undefined |
+
+### messenger
+
+```solidity
+function messenger() external view returns (address)
+```
+
+The address of corresponding L1ScrollMessenger/L2ScrollMessenger contract.
+
+
+
+
+#### Returns
+
+| Name | Type | Description |
+|---|---|---|
+| _0 | address | undefined |
+
+### onDropMessage
+
+```solidity
+function onDropMessage(bytes _message) external payable
+```
+
+
+
+
+
+#### Parameters
+
+| Name | Type | Description |
+|---|---|---|
+| _message | bytes | undefined |
+
+### owner
+
+```solidity
+function owner() external view returns (address)
+```
+
+
+
+*Returns the address of the current owner.*
+
+
+#### Returns
+
+| Name | Type | Description |
+|---|---|---|
+| _0 | address | undefined |
+
+### renounceOwnership
+
+```solidity
+function renounceOwnership() external nonpayable
+```
+
+
+
+*Leaves the contract without owner. It will not be possible to call `onlyOwner` functions. Can only be called by the current owner. NOTE: Renouncing ownership will leave the contract without an owner, thereby disabling any functionality that is only available to the owner.*
+
+
+### router
+
+```solidity
+function router() external view returns (address)
+```
+
+The address of L1GatewayRouter/L2GatewayRouter contract.
+
+
+
+
+#### Returns
+
+| Name | Type | Description |
+|---|---|---|
+| _0 | address | undefined |
+
+### transferOwnership
+
+```solidity
+function transferOwnership(address newOwner) external nonpayable
+```
+
+
+
+*Transfers ownership of the contract to a new account (`newOwner`). Can only be called by the current owner.*
+
+#### Parameters
+
+| Name | Type | Description |
+|---|---|---|
+| newOwner | address | undefined |
+
+
+
+## Events
+
+### DepositERC20
+
+```solidity
+event DepositERC20(address indexed l1Token, address indexed l2Token, address indexed from, address to, uint256 amount, bytes data)
+```
+
+Emitted when someone deposit ERC20 token from L1 to L2.
+
+
+
+#### Parameters
+
+| Name | Type | Description |
+|---|---|---|
+| l1Token `indexed` | address | The address of the token in L1. |
+| l2Token `indexed` | address | The address of the token in L2. |
+| from `indexed` | address | The address of sender in L1. |
+| to  | address | The address of recipient in L2. |
+| amount  | uint256 | The amount of token will be deposited from L1 to L2. |
+| data  | bytes | The optional calldata passed to recipient in L2. |
+
+### FinalizeWithdrawERC20
+
+```solidity
+event FinalizeWithdrawERC20(address indexed l1Token, address indexed l2Token, address indexed from, address to, uint256 amount, bytes data)
+```
+
+Emitted when ERC20 token is withdrawn from L2 to L1 and transfer to recipient.
+
+
+
+#### Parameters
+
+| Name | Type | Description |
+|---|---|---|
+| l1Token `indexed` | address | The address of the token in L1. |
+| l2Token `indexed` | address | The address of the token in L2. |
+| from `indexed` | address | The address of sender in L2. |
+| to  | address | The address of recipient in L1. |
+| amount  | uint256 | The amount of token withdrawn from L2 to L1. |
+| data  | bytes | The optional calldata passed to recipient in L1. |
+
+### Initialized
+
+```solidity
+event Initialized(uint8 version)
+```
+
+
+
+*Triggered when the contract has been initialized or reinitialized.*
+
+#### Parameters
+
+| Name | Type | Description |
+|---|---|---|
+| version  | uint8 | undefined |
+
+### OwnershipTransferred
+
+```solidity
+event OwnershipTransferred(address indexed previousOwner, address indexed newOwner)
+```
+
+
+
+
+
+#### Parameters
+
+| Name | Type | Description |
+|---|---|---|
+| previousOwner `indexed` | address | undefined |
+| newOwner `indexed` | address | undefined |
+
+### RefundERC20
+
+```solidity
+event RefundERC20(address indexed token, address indexed recipient, uint256 amount)
+```
+
+Emitted when some ERC20 token is refunded.
+
+
+
+#### Parameters
+
+| Name | Type | Description |
+|---|---|---|
+| token `indexed` | address | The address of the token in L1. |
+| recipient `indexed` | address | The address of receiver in L1. |
+| amount  | uint256 | The amount of token refunded to receiver. |
+
+
+
+## Errors
+
+### ErrorCallerIsNotCounterpartGateway
+
+```solidity
+error ErrorCallerIsNotCounterpartGateway()
+```
+
+
+
+*Thrown when the cross chain sender is not the counterpart gateway contract.*
+
+
+### ErrorCallerIsNotMessenger
+
+```solidity
+error ErrorCallerIsNotMessenger()
+```
+
+
+
+*Thrown when the caller is not corresponding `L1ScrollMessenger` or `L2ScrollMessenger`.*
+
+
+### ErrorNotInDropMessageContext
+
+```solidity
+error ErrorNotInDropMessageContext()
+```
+
+
+
+*Thrown when ScrollMessenger is not dropping message.*
+
+
+### ErrorZeroAddress
+
+```solidity
+error ErrorZeroAddress()
+```
+
+
+
+*Thrown when the given address is `address(0)`.*
+
+
+

contracts/docs/apis/L1WETHGateway.md

@@ -0,0 +1,421 @@
+# L1WETHGateway
+
+
+
+> L1WETHGateway
+
+The `L1WETHGateway` contract is used to deposit `WETH` token on layer 1 and finalize withdraw `WETH` from layer 2.
+
+*The deposited WETH tokens are not held in the gateway. It will first be unwrapped as Ether and then the Ether will be sent to the `L1ScrollMessenger` contract. On finalizing withdraw, the Ether will be transferred from `L1ScrollMessenger`, then wrapped as WETH and finally transfer to recipient.*
+
+## Methods
+
+### WETH
+
+```solidity
+function WETH() external view returns (address)
+```
+
+The address of L1 WETH address.
+
+
+
+
+#### Returns
+
+| Name | Type | Description |
+|---|---|---|
+| _0 | address | undefined |
+
+### counterpart
+
+```solidity
+function counterpart() external view returns (address)
+```
+
+The address of corresponding L1/L2 Gateway contract.
+
+
+
+
+#### Returns
+
+| Name | Type | Description |
+|---|---|---|
+| _0 | address | undefined |
+
+### depositERC20
+
+```solidity
+function depositERC20(address _token, uint256 _amount, uint256 _gasLimit) external payable
+```
+
+Deposit some token to a caller's account on L2.
+
+*Make this function payable to send relayer fee in Ether.*
+
+#### Parameters
+
+| Name | Type | Description |
+|---|---|---|
+| _token | address | The address of token in L1. |
+| _amount | uint256 | The amount of token to transfer. |
+| _gasLimit | uint256 | Gas limit required to complete the deposit on L2. |
+
+### depositERC20
+
+```solidity
+function depositERC20(address _token, address _to, uint256 _amount, uint256 _gasLimit) external payable
+```
+
+Deposit some token to a recipient's account on L2.
+
+*Make this function payable to send relayer fee in Ether.*
+
+#### Parameters
+
+| Name | Type | Description |
+|---|---|---|
+| _token | address | The address of token in L1. |
+| _to | address | The address of recipient's account on L2. |
+| _amount | uint256 | The amount of token to transfer. |
+| _gasLimit | uint256 | Gas limit required to complete the deposit on L2. |
+
+### depositERC20AndCall
+
+```solidity
+function depositERC20AndCall(address _token, address _to, uint256 _amount, bytes _data, uint256 _gasLimit) external payable
+```
+
+Deposit some token to a recipient's account on L2 and call.
+
+*Make this function payable to send relayer fee in Ether.*
+
+#### Parameters
+
+| Name | Type | Description |
+|---|---|---|
+| _token | address | The address of token in L1. |
+| _to | address | The address of recipient's account on L2. |
+| _amount | uint256 | The amount of token to transfer. |
+| _data | bytes | Optional data to forward to recipient's account. |
+| _gasLimit | uint256 | Gas limit required to complete the deposit on L2. |
+
+### finalizeWithdrawERC20
+
+```solidity
+function finalizeWithdrawERC20(address _l1Token, address _l2Token, address _from, address _to, uint256 _amount, bytes _data) external payable
+```
+
+Complete ERC20 withdraw from L2 to L1 and send fund to recipient's account in L1.
+
+*Make this function payable to handle WETH deposit/withdraw.      The function should only be called by L1ScrollMessenger.      The function should also only be called by L2ERC20Gateway in L2.*
+
+#### Parameters
+
+| Name | Type | Description |
+|---|---|---|
+| _l1Token | address | The address of corresponding L1 token. |
+| _l2Token | address | The address of corresponding L2 token. |
+| _from | address | The address of account who withdraw the token in L2. |
+| _to | address | The address of recipient in L1 to receive the token. |
+| _amount | uint256 | The amount of the token to withdraw. |
+| _data | bytes | Optional data to forward to recipient's account. |
+
+### getL2ERC20Address
+
+```solidity
+function getL2ERC20Address(address) external view returns (address)
+```
+
+Return the corresponding l2 token address given l1 token address.
+
+
+
+#### Parameters
+
+| Name | Type | Description |
+|---|---|---|
+| _0 | address | undefined |
+
+#### Returns
+
+| Name | Type | Description |
+|---|---|---|
+| _0 | address | undefined |
+
+### initialize
+
+```solidity
+function initialize(address _counterpart, address _router, address _messenger) external nonpayable
+```
+
+Initialize the storage of L1WETHGateway.
+
+*The parameters `_counterpart`, `_router` and `_messenger` are no longer used.*
+
+#### Parameters
+
+| Name | Type | Description |
+|---|---|---|
+| _counterpart | address | The address of L2ETHGateway in L2. |
+| _router | address | The address of L1GatewayRouter in L1. |
+| _messenger | address | The address of L1ScrollMessenger in L1. |
+
+### l2WETH
+
+```solidity
+function l2WETH() external view returns (address)
+```
+
+The address of L2 WETH address.
+
+
+
+
+#### Returns
+
+| Name | Type | Description |
+|---|---|---|
+| _0 | address | undefined |
+
+### messenger
+
+```solidity
+function messenger() external view returns (address)
+```
+
+The address of corresponding L1ScrollMessenger/L2ScrollMessenger contract.
+
+
+
+
+#### Returns
+
+| Name | Type | Description |
+|---|---|---|
+| _0 | address | undefined |
+
+### onDropMessage
+
+```solidity
+function onDropMessage(bytes _message) external payable
+```
+
+
+
+
+
+#### Parameters
+
+| Name | Type | Description |
+|---|---|---|
+| _message | bytes | undefined |
+
+### owner
+
+```solidity
+function owner() external view returns (address)
+```
+
+
+
+*Returns the address of the current owner.*
+
+
+#### Returns
+
+| Name | Type | Description |
+|---|---|---|
+| _0 | address | undefined |
+
+### renounceOwnership
+
+```solidity
+function renounceOwnership() external nonpayable
+```
+
+
+
+*Leaves the contract without owner. It will not be possible to call `onlyOwner` functions. Can only be called by the current owner. NOTE: Renouncing ownership will leave the contract without an owner, thereby disabling any functionality that is only available to the owner.*
+
+
+### router
+
+```solidity
+function router() external view returns (address)
+```
+
+The address of L1GatewayRouter/L2GatewayRouter contract.
+
+
+
+
+#### Returns
+
+| Name | Type | Description |
+|---|---|---|
+| _0 | address | undefined |
+
+### transferOwnership
+
+```solidity
+function transferOwnership(address newOwner) external nonpayable
+```
+
+
+
+*Transfers ownership of the contract to a new account (`newOwner`). Can only be called by the current owner.*
+
+#### Parameters
+
+| Name | Type | Description |
+|---|---|---|
+| newOwner | address | undefined |
+
+
+
+## Events
+
+### DepositERC20
+
+```solidity
+event DepositERC20(address indexed l1Token, address indexed l2Token, address indexed from, address to, uint256 amount, bytes data)
+```
+
+Emitted when someone deposit ERC20 token from L1 to L2.
+
+
+
+#### Parameters
+
+| Name | Type | Description |
+|---|---|---|
+| l1Token `indexed` | address | The address of the token in L1. |
+| l2Token `indexed` | address | The address of the token in L2. |
+| from `indexed` | address | The address of sender in L1. |
+| to  | address | The address of recipient in L2. |
+| amount  | uint256 | The amount of token will be deposited from L1 to L2. |
+| data  | bytes | The optional calldata passed to recipient in L2. |
+
+### FinalizeWithdrawERC20
+
+```solidity
+event FinalizeWithdrawERC20(address indexed l1Token, address indexed l2Token, address indexed from, address to, uint256 amount, bytes data)
+```
+
+Emitted when ERC20 token is withdrawn from L2 to L1 and transfer to recipient.
+
+
+
+#### Parameters
+
+| Name | Type | Description |
+|---|---|---|
+| l1Token `indexed` | address | The address of the token in L1. |
+| l2Token `indexed` | address | The address of the token in L2. |
+| from `indexed` | address | The address of sender in L2. |
+| to  | address | The address of recipient in L1. |
+| amount  | uint256 | The amount of token withdrawn from L2 to L1. |
+| data  | bytes | The optional calldata passed to recipient in L1. |
+
+### Initialized
+
+```solidity
+event Initialized(uint8 version)
+```
+
+
+
+*Triggered when the contract has been initialized or reinitialized.*
+
+#### Parameters
+
+| Name | Type | Description |
+|---|---|---|
+| version  | uint8 | undefined |
+
+### OwnershipTransferred
+
+```solidity
+event OwnershipTransferred(address indexed previousOwner, address indexed newOwner)
+```
+
+
+
+
+
+#### Parameters
+
+| Name | Type | Description |
+|---|---|---|
+| previousOwner `indexed` | address | undefined |
+| newOwner `indexed` | address | undefined |
+
+### RefundERC20
+
+```solidity
+event RefundERC20(address indexed token, address indexed recipient, uint256 amount)
+```
+
+Emitted when some ERC20 token is refunded.
+
+
+
+#### Parameters
+
+| Name | Type | Description |
+|---|---|---|
+| token `indexed` | address | The address of the token in L1. |
+| recipient `indexed` | address | The address of receiver in L1. |
+| amount  | uint256 | The amount of token refunded to receiver. |
+
+
+
+## Errors
+
+### ErrorCallerIsNotCounterpartGateway
+
+```solidity
+error ErrorCallerIsNotCounterpartGateway()
+```
+
+
+
+*Thrown when the cross chain sender is not the counterpart gateway contract.*
+
+
+### ErrorCallerIsNotMessenger
+
+```solidity
+error ErrorCallerIsNotMessenger()
+```
+
+
+
+*Thrown when the caller is not corresponding `L1ScrollMessenger` or `L2ScrollMessenger`.*
+
+
+### ErrorNotInDropMessageContext
+
+```solidity
+error ErrorNotInDropMessageContext()
+```
+
+
+
+*Thrown when ScrollMessenger is not dropping message.*
+
+
+### ErrorZeroAddress
+
+```solidity
+error ErrorZeroAddress()
+```
+
+
+
+*Thrown when the given address is `address(0)`.*
+
+
+

contracts/docs/apis/L2ERC1155Gateway.md

@@ -0,0 +1,545 @@
+# L2ERC1155Gateway
+
+
+
+> L2ERC1155Gateway
+
+The `L2ERC1155Gateway` is used to withdraw ERC1155 compatible NFTs on layer 2 and finalize deposit the NFTs from layer 1.
+
+*The withdrawn NFTs tokens will be burned directly. On finalizing deposit, the corresponding NFT will be minted and transferred to the recipient. This will be changed if we have more specific scenarios.*
+
+## Methods
+
+### batchWithdrawERC1155
+
+```solidity
+function batchWithdrawERC1155(address _token, uint256[] _tokenIds, uint256[] _amounts, uint256 _gasLimit) external payable
+```
+
+Batch withdraw a list of ERC1155 NFT to caller's account on layer 1.
+
+
+
+#### Parameters
+
+| Name | Type | Description |
+|---|---|---|
+| _token | address | undefined |
+| _tokenIds | uint256[] | undefined |
+| _amounts | uint256[] | undefined |
+| _gasLimit | uint256 | undefined |
+
+### batchWithdrawERC1155
+
+```solidity
+function batchWithdrawERC1155(address _token, address _to, uint256[] _tokenIds, uint256[] _amounts, uint256 _gasLimit) external payable
+```
+
+Batch withdraw a list of ERC1155 NFT to caller's account on layer 1.
+
+
+
+#### Parameters
+
+| Name | Type | Description |
+|---|---|---|
+| _token | address | undefined |
+| _to | address | undefined |
+| _tokenIds | uint256[] | undefined |
+| _amounts | uint256[] | undefined |
+| _gasLimit | uint256 | undefined |
+
+### counterpart
+
+```solidity
+function counterpart() external view returns (address)
+```
+
+The address of corresponding L1/L2 Gateway contract.
+
+
+
+
+#### Returns
+
+| Name | Type | Description |
+|---|---|---|
+| _0 | address | undefined |
+
+### finalizeBatchDepositERC1155
+
+```solidity
+function finalizeBatchDepositERC1155(address _l1Token, address _l2Token, address _from, address _to, uint256[] _tokenIds, uint256[] _amounts) external nonpayable
+```
+
+Complete ERC1155 deposit from layer 1 to layer 2 and send NFT to recipient's account on layer 2.
+
+*Requirements:  - The function should only be called by L2ScrollMessenger.  - The function should also only be called by L1ERC1155Gateway on layer 1.*
+
+#### Parameters
+
+| Name | Type | Description |
+|---|---|---|
+| _l1Token | address | undefined |
+| _l2Token | address | undefined |
+| _from | address | undefined |
+| _to | address | undefined |
+| _tokenIds | uint256[] | undefined |
+| _amounts | uint256[] | undefined |
+
+### finalizeDepositERC1155
+
+```solidity
+function finalizeDepositERC1155(address _l1Token, address _l2Token, address _from, address _to, uint256 _tokenId, uint256 _amount) external nonpayable
+```
+
+Complete ERC1155 deposit from layer 1 to layer 2 and send NFT to recipient's account on layer 2.
+
+*Requirements:  - The function should only be called by L2ScrollMessenger.  - The function should also only be called by L1ERC1155Gateway on layer 1.*
+
+#### Parameters
+
+| Name | Type | Description |
+|---|---|---|
+| _l1Token | address | undefined |
+| _l2Token | address | undefined |
+| _from | address | undefined |
+| _to | address | undefined |
+| _tokenId | uint256 | undefined |
+| _amount | uint256 | undefined |
+
+### initialize
+
+```solidity
+function initialize(address _counterpart, address _messenger) external nonpayable
+```
+
+Initialize the storage of `L2ERC1155Gateway`.
+
+*The parameters `_counterpart` and `_messenger` are no longer used.*
+
+#### Parameters
+
+| Name | Type | Description |
+|---|---|---|
+| _counterpart | address | The address of `L1ERC1155Gateway` contract in L1. |
+| _messenger | address | The address of `L2ScrollMessenger` contract in L2. |
+
+### messenger
+
+```solidity
+function messenger() external view returns (address)
+```
+
+The address of corresponding L1ScrollMessenger/L2ScrollMessenger contract.
+
+
+
+
+#### Returns
+
+| Name | Type | Description |
+|---|---|---|
+| _0 | address | undefined |
+
+### onERC1155BatchReceived
+
+```solidity
+function onERC1155BatchReceived(address, address, uint256[], uint256[], bytes) external nonpayable returns (bytes4)
+```
+
+
+
+
+
+#### Parameters
+
+| Name | Type | Description |
+|---|---|---|
+| _0 | address | undefined |
+| _1 | address | undefined |
+| _2 | uint256[] | undefined |
+| _3 | uint256[] | undefined |
+| _4 | bytes | undefined |
+
+#### Returns
+
+| Name | Type | Description |
+|---|---|---|
+| _0 | bytes4 | undefined |
+
+### onERC1155Received
+
+```solidity
+function onERC1155Received(address, address, uint256, uint256, bytes) external nonpayable returns (bytes4)
+```
+
+
+
+
+
+#### Parameters
+
+| Name | Type | Description |
+|---|---|---|
+| _0 | address | undefined |
+| _1 | address | undefined |
+| _2 | uint256 | undefined |
+| _3 | uint256 | undefined |
+| _4 | bytes | undefined |
+
+#### Returns
+
+| Name | Type | Description |
+|---|---|---|
+| _0 | bytes4 | undefined |
+
+### owner
+
+```solidity
+function owner() external view returns (address)
+```
+
+
+
+*Returns the address of the current owner.*
+
+
+#### Returns
+
+| Name | Type | Description |
+|---|---|---|
+| _0 | address | undefined |
+
+### renounceOwnership
+
+```solidity
+function renounceOwnership() external nonpayable
+```
+
+
+
+*Leaves the contract without owner. It will not be possible to call `onlyOwner` functions. Can only be called by the current owner. NOTE: Renouncing ownership will leave the contract without an owner, thereby disabling any functionality that is only available to the owner.*
+
+
+### router
+
+```solidity
+function router() external view returns (address)
+```
+
+The address of L1GatewayRouter/L2GatewayRouter contract.
+
+
+
+
+#### Returns
+
+| Name | Type | Description |
+|---|---|---|
+| _0 | address | undefined |
+
+### supportsInterface
+
+```solidity
+function supportsInterface(bytes4 interfaceId) external view returns (bool)
+```
+
+
+
+*See {IERC165-supportsInterface}.*
+
+#### Parameters
+
+| Name | Type | Description |
+|---|---|---|
+| interfaceId | bytes4 | undefined |
+
+#### Returns
+
+| Name | Type | Description |
+|---|---|---|
+| _0 | bool | undefined |
+
+### tokenMapping
+
+```solidity
+function tokenMapping(address) external view returns (address)
+```
+
+Mapping from layer 2 token address to layer 1 token address for ERC1155 NFT.
+
+
+
+#### Parameters
+
+| Name | Type | Description |
+|---|---|---|
+| _0 | address | undefined |
+
+#### Returns
+
+| Name | Type | Description |
+|---|---|---|
+| _0 | address | undefined |
+
+### transferOwnership
+
+```solidity
+function transferOwnership(address newOwner) external nonpayable
+```
+
+
+
+*Transfers ownership of the contract to a new account (`newOwner`). Can only be called by the current owner.*
+
+#### Parameters
+
+| Name | Type | Description |
+|---|---|---|
+| newOwner | address | undefined |
+
+### updateTokenMapping
+
+```solidity
+function updateTokenMapping(address _l2Token, address _l1Token) external nonpayable
+```
+
+Update layer 2 to layer 1 token mapping.
+
+
+
+#### Parameters
+
+| Name | Type | Description |
+|---|---|---|
+| _l2Token | address | The address of corresponding ERC1155 token on layer 2. |
+| _l1Token | address | The address of ERC1155 token on layer 1. |
+
+### withdrawERC1155
+
+```solidity
+function withdrawERC1155(address _token, uint256 _tokenId, uint256 _amount, uint256 _gasLimit) external payable
+```
+
+Withdraw some ERC1155 NFT to caller's account on layer 1.
+
+
+
+#### Parameters
+
+| Name | Type | Description |
+|---|---|---|
+| _token | address | undefined |
+| _tokenId | uint256 | undefined |
+| _amount | uint256 | undefined |
+| _gasLimit | uint256 | undefined |
+
+### withdrawERC1155
+
+```solidity
+function withdrawERC1155(address _token, address _to, uint256 _tokenId, uint256 _amount, uint256 _gasLimit) external payable
+```
+
+Withdraw some ERC1155 NFT to caller's account on layer 1.
+
+
+
+#### Parameters
+
+| Name | Type | Description |
+|---|---|---|
+| _token | address | undefined |
+| _to | address | undefined |
+| _tokenId | uint256 | undefined |
+| _amount | uint256 | undefined |
+| _gasLimit | uint256 | undefined |
+
+
+
+## Events
+
+### BatchWithdrawERC1155
+
+```solidity
+event BatchWithdrawERC1155(address indexed l1Token, address indexed l2Token, address indexed from, address to, uint256[] tokenIds, uint256[] amounts)
+```
+
+Emitted when the ERC1155 NFT is batch transferred to gateway on layer 2.
+
+
+
+#### Parameters
+
+| Name | Type | Description |
+|---|---|---|
+| l1Token `indexed` | address | The address of ERC1155 NFT on layer 1. |
+| l2Token `indexed` | address | The address of ERC1155 NFT on layer 2. |
+| from `indexed` | address | The address of sender on layer 2. |
+| to  | address | The address of recipient on layer 1. |
+| tokenIds  | uint256[] | The list of token ids of the ERC1155 NFT to withdraw on layer 2. |
+| amounts  | uint256[] | The list of corresponding amounts to withdraw. |
+
+### FinalizeBatchDepositERC1155
+
+```solidity
+event FinalizeBatchDepositERC1155(address indexed l1Token, address indexed l2Token, address indexed from, address to, uint256[] tokenIds, uint256[] amounts)
+```
+
+Emitted when the ERC1155 NFT is batch transferred to recipient on layer 2.
+
+
+
+#### Parameters
+
+| Name | Type | Description |
+|---|---|---|
+| l1Token `indexed` | address | The address of ERC1155 NFT on layer 1. |
+| l2Token `indexed` | address | The address of ERC1155 NFT on layer 2. |
+| from `indexed` | address | The address of sender on layer 1. |
+| to  | address | The address of recipient on layer 2. |
+| tokenIds  | uint256[] | The list of token ids of the ERC1155 NFT deposited on layer 1. |
+| amounts  | uint256[] | The list of corresponding amounts deposited. |
+
+### FinalizeDepositERC1155
+
+```solidity
+event FinalizeDepositERC1155(address indexed l1Token, address indexed l2Token, address indexed from, address to, uint256 tokenId, uint256 amount)
+```
+
+Emitted when the ERC1155 NFT is transferred to recipient on layer 2.
+
+
+
+#### Parameters
+
+| Name | Type | Description |
+|---|---|---|
+| l1Token `indexed` | address | The address of ERC1155 NFT on layer 1. |
+| l2Token `indexed` | address | The address of ERC1155 NFT on layer 2. |
+| from `indexed` | address | The address of sender on layer 1. |
+| to  | address | The address of recipient on layer 2. |
+| tokenId  | uint256 | The token id of the ERC1155 NFT deposited on layer 1. |
+| amount  | uint256 | The amount of token deposited. |
+
+### Initialized
+
+```solidity
+event Initialized(uint8 version)
+```
+
+
+
+*Triggered when the contract has been initialized or reinitialized.*
+
+#### Parameters
+
+| Name | Type | Description |
+|---|---|---|
+| version  | uint8 | undefined |
+
+### OwnershipTransferred
+
+```solidity
+event OwnershipTransferred(address indexed previousOwner, address indexed newOwner)
+```
+
+
+
+
+
+#### Parameters
+
+| Name | Type | Description |
+|---|---|---|
+| previousOwner `indexed` | address | undefined |
+| newOwner `indexed` | address | undefined |
+
+### UpdateTokenMapping
+
+```solidity
+event UpdateTokenMapping(address indexed l2Token, address indexed oldL1Token, address indexed newL1Token)
+```
+
+Emitted when token mapping for ERC1155 token is updated.
+
+
+
+#### Parameters
+
+| Name | Type | Description |
+|---|---|---|
+| l2Token `indexed` | address | The address of corresponding ERC1155 token in layer 2. |
+| oldL1Token `indexed` | address | The address of the old corresponding ERC1155 token in layer 1. |
+| newL1Token `indexed` | address | The address of the new corresponding ERC1155 token in layer 1. |
+
+### WithdrawERC1155
+
+```solidity
+event WithdrawERC1155(address indexed l1Token, address indexed l2Token, address indexed from, address to, uint256 tokenId, uint256 amount)
+```
+
+Emitted when the ERC1155 NFT is transferred to gateway on layer 2.
+
+
+
+#### Parameters
+
+| Name | Type | Description |
+|---|---|---|
+| l1Token `indexed` | address | The address of ERC1155 NFT on layer 1. |
+| l2Token `indexed` | address | The address of ERC1155 NFT on layer 2. |
+| from `indexed` | address | The address of sender on layer 2. |
+| to  | address | The address of recipient on layer 1. |
+| tokenId  | uint256 | The token id of the ERC1155 NFT to withdraw on layer 2. |
+| amount  | uint256 | The amount of token to withdraw. |
+
+
+
+## Errors
+
+### ErrorCallerIsNotCounterpartGateway
+
+```solidity
+error ErrorCallerIsNotCounterpartGateway()
+```
+
+
+
+*Thrown when the cross chain sender is not the counterpart gateway contract.*
+
+
+### ErrorCallerIsNotMessenger
+
+```solidity
+error ErrorCallerIsNotMessenger()
+```
+
+
+
+*Thrown when the caller is not corresponding `L1ScrollMessenger` or `L2ScrollMessenger`.*
+
+
+### ErrorNotInDropMessageContext
+
+```solidity
+error ErrorNotInDropMessageContext()
+```
+
+
+
+*Thrown when ScrollMessenger is not dropping message.*
+
+
+### ErrorZeroAddress
+
+```solidity
+error ErrorZeroAddress()
+```
+
+
+
+*Thrown when the given address is `address(0)`.*
+
+
+

contracts/docs/apis/L2ERC721Gateway.md

@@ -0,0 +1,486 @@
+# L2ERC721Gateway
+
+
+
+> L2ERC721Gateway
+
+The `L2ERC721Gateway` is used to withdraw ERC721 compatible NFTs on layer 2 and finalize deposit the NFTs from layer 1.
+
+*The withdrawn NFTs tokens will be burned directly. On finalizing deposit, the corresponding NFT will be minted and transferred to the recipient. This will be changed if we have more specific scenarios.*
+
+## Methods
+
+### batchWithdrawERC721
+
+```solidity
+function batchWithdrawERC721(address _token, uint256[] _tokenIds, uint256 _gasLimit) external payable
+```
+
+Batch withdraw a list of ERC721 NFT to caller's account on layer 1.
+
+
+
+#### Parameters
+
+| Name | Type | Description |
+|---|---|---|
+| _token | address | undefined |
+| _tokenIds | uint256[] | undefined |
+| _gasLimit | uint256 | undefined |
+
+### batchWithdrawERC721
+
+```solidity
+function batchWithdrawERC721(address _token, address _to, uint256[] _tokenIds, uint256 _gasLimit) external payable
+```
+
+Batch withdraw a list of ERC721 NFT to caller's account on layer 1.
+
+
+
+#### Parameters
+
+| Name | Type | Description |
+|---|---|---|
+| _token | address | undefined |
+| _to | address | undefined |
+| _tokenIds | uint256[] | undefined |
+| _gasLimit | uint256 | undefined |
+
+### counterpart
+
+```solidity
+function counterpart() external view returns (address)
+```
+
+The address of corresponding L1/L2 Gateway contract.
+
+
+
+
+#### Returns
+
+| Name | Type | Description |
+|---|---|---|
+| _0 | address | undefined |
+
+### finalizeBatchDepositERC721
+
+```solidity
+function finalizeBatchDepositERC721(address _l1Token, address _l2Token, address _from, address _to, uint256[] _tokenIds) external nonpayable
+```
+
+Complete ERC721 deposit from layer 1 to layer 2 and send NFT to recipient's account on layer 2.
+
+*Requirements:  - The function should only be called by L2ScrollMessenger.  - The function should also only be called by L1ERC721Gateway on layer 1.*
+
+#### Parameters
+
+| Name | Type | Description |
+|---|---|---|
+| _l1Token | address | undefined |
+| _l2Token | address | undefined |
+| _from | address | undefined |
+| _to | address | undefined |
+| _tokenIds | uint256[] | undefined |
+
+### finalizeDepositERC721
+
+```solidity
+function finalizeDepositERC721(address _l1Token, address _l2Token, address _from, address _to, uint256 _tokenId) external nonpayable
+```
+
+Complete ERC721 deposit from layer 1 to layer 2 and send NFT to recipient's account on layer 2.
+
+*Requirements:  - The function should only be called by L2ScrollMessenger.  - The function should also only be called by L1ERC721Gateway on layer 1.*
+
+#### Parameters
+
+| Name | Type | Description |
+|---|---|---|
+| _l1Token | address | undefined |
+| _l2Token | address | undefined |
+| _from | address | undefined |
+| _to | address | undefined |
+| _tokenId | uint256 | undefined |
+
+### initialize
+
+```solidity
+function initialize(address _counterpart, address _messenger) external nonpayable
+```
+
+Initialize the storage of `L2ERC721Gateway`.
+
+*The parameters `_counterpart` and `_messenger` are no longer used.*
+
+#### Parameters
+
+| Name | Type | Description |
+|---|---|---|
+| _counterpart | address | The address of `L1ERC721Gateway` contract in L1. |
+| _messenger | address | The address of `L2ScrollMessenger` contract in L2. |
+
+### messenger
+
+```solidity
+function messenger() external view returns (address)
+```
+
+The address of corresponding L1ScrollMessenger/L2ScrollMessenger contract.
+
+
+
+
+#### Returns
+
+| Name | Type | Description |
+|---|---|---|
+| _0 | address | undefined |
+
+### onERC721Received
+
+```solidity
+function onERC721Received(address, address, uint256, bytes) external nonpayable returns (bytes4)
+```
+
+
+
+*See {IERC721Receiver-onERC721Received}. Always returns `IERC721Receiver.onERC721Received.selector`.*
+
+#### Parameters
+
+| Name | Type | Description |
+|---|---|---|
+| _0 | address | undefined |
+| _1 | address | undefined |
+| _2 | uint256 | undefined |
+| _3 | bytes | undefined |
+
+#### Returns
+
+| Name | Type | Description |
+|---|---|---|
+| _0 | bytes4 | undefined |
+
+### owner
+
+```solidity
+function owner() external view returns (address)
+```
+
+
+
+*Returns the address of the current owner.*
+
+
+#### Returns
+
+| Name | Type | Description |
+|---|---|---|
+| _0 | address | undefined |
+
+### renounceOwnership
+
+```solidity
+function renounceOwnership() external nonpayable
+```
+
+
+
+*Leaves the contract without owner. It will not be possible to call `onlyOwner` functions. Can only be called by the current owner. NOTE: Renouncing ownership will leave the contract without an owner, thereby disabling any functionality that is only available to the owner.*
+
+
+### router
+
+```solidity
+function router() external view returns (address)
+```
+
+The address of L1GatewayRouter/L2GatewayRouter contract.
+
+
+
+
+#### Returns
+
+| Name | Type | Description |
+|---|---|---|
+| _0 | address | undefined |
+
+### tokenMapping
+
+```solidity
+function tokenMapping(address) external view returns (address)
+```
+
+Mapping from layer 2 token address to layer 1 token address for ERC721 NFT.
+
+
+
+#### Parameters
+
+| Name | Type | Description |
+|---|---|---|
+| _0 | address | undefined |
+
+#### Returns
+
+| Name | Type | Description |
+|---|---|---|
+| _0 | address | undefined |
+
+### transferOwnership
+
+```solidity
+function transferOwnership(address newOwner) external nonpayable
+```
+
+
+
+*Transfers ownership of the contract to a new account (`newOwner`). Can only be called by the current owner.*
+
+#### Parameters
+
+| Name | Type | Description |
+|---|---|---|
+| newOwner | address | undefined |
+
+### updateTokenMapping
+
+```solidity
+function updateTokenMapping(address _l2Token, address _l1Token) external nonpayable
+```
+
+Update layer 2 to layer 1 token mapping.
+
+
+
+#### Parameters
+
+| Name | Type | Description |
+|---|---|---|
+| _l2Token | address | The address of corresponding ERC721 token on layer 2. |
+| _l1Token | address | The address of ERC721 token on layer 1. |
+
+### withdrawERC721
+
+```solidity
+function withdrawERC721(address _token, uint256 _tokenId, uint256 _gasLimit) external payable
+```
+
+Withdraw some ERC721 NFT to caller's account on layer 1.
+
+
+
+#### Parameters
+
+| Name | Type | Description |
+|---|---|---|
+| _token | address | undefined |
+| _tokenId | uint256 | undefined |
+| _gasLimit | uint256 | undefined |
+
+### withdrawERC721
+
+```solidity
+function withdrawERC721(address _token, address _to, uint256 _tokenId, uint256 _gasLimit) external payable
+```
+
+Withdraw some ERC721 NFT to caller's account on layer 1.
+
+
+
+#### Parameters
+
+| Name | Type | Description |
+|---|---|---|
+| _token | address | undefined |
+| _to | address | undefined |
+| _tokenId | uint256 | undefined |
+| _gasLimit | uint256 | undefined |
+
+
+
+## Events
+
+### BatchWithdrawERC721
+
+```solidity
+event BatchWithdrawERC721(address indexed l1Token, address indexed l2Token, address indexed from, address to, uint256[] tokenIds)
+```
+
+Emitted when the ERC721 NFT is batch transferred to gateway on layer 2.
+
+
+
+#### Parameters
+
+| Name | Type | Description |
+|---|---|---|
+| l1Token `indexed` | address | The address of ERC721 NFT on layer 1. |
+| l2Token `indexed` | address | The address of ERC721 NFT on layer 2. |
+| from `indexed` | address | The address of sender on layer 2. |
+| to  | address | The address of recipient on layer 1. |
+| tokenIds  | uint256[] | The list of token ids of the ERC721 NFT to withdraw on layer 2. |
+
+### FinalizeBatchDepositERC721
+
+```solidity
+event FinalizeBatchDepositERC721(address indexed l1Token, address indexed l2Token, address indexed from, address to, uint256[] tokenIds)
+```
+
+Emitted when the ERC721 NFT is batch transferred to recipient on layer 2.
+
+
+
+#### Parameters
+
+| Name | Type | Description |
+|---|---|---|
+| l1Token `indexed` | address | The address of ERC721 NFT on layer 1. |
+| l2Token `indexed` | address | The address of ERC721 NFT on layer 2. |
+| from `indexed` | address | The address of sender on layer 1. |
+| to  | address | The address of recipient on layer 2. |
+| tokenIds  | uint256[] | The list of token ids of the ERC721 NFT deposited on layer 1. |
+
+### FinalizeDepositERC721
+
+```solidity
+event FinalizeDepositERC721(address indexed l1Token, address indexed l2Token, address indexed from, address to, uint256 tokenId)
+```
+
+Emitted when the ERC721 NFT is transferred to recipient on layer 2.
+
+
+
+#### Parameters
+
+| Name | Type | Description |
+|---|---|---|
+| l1Token `indexed` | address | The address of ERC721 NFT on layer 1. |
+| l2Token `indexed` | address | The address of ERC721 NFT on layer 2. |
+| from `indexed` | address | The address of sender on layer 1. |
+| to  | address | The address of recipient on layer 2. |
+| tokenId  | uint256 | The token id of the ERC721 NFT deposited on layer 1. |
+
+### Initialized
+
+```solidity
+event Initialized(uint8 version)
+```
+
+
+
+*Triggered when the contract has been initialized or reinitialized.*
+
+#### Parameters
+
+| Name | Type | Description |
+|---|---|---|
+| version  | uint8 | undefined |
+
+### OwnershipTransferred
+
+```solidity
+event OwnershipTransferred(address indexed previousOwner, address indexed newOwner)
+```
+
+
+
+
+
+#### Parameters
+
+| Name | Type | Description |
+|---|---|---|
+| previousOwner `indexed` | address | undefined |
+| newOwner `indexed` | address | undefined |
+
+### UpdateTokenMapping
+
+```solidity
+event UpdateTokenMapping(address indexed l2Token, address indexed oldL1Token, address indexed newL1Token)
+```
+
+Emitted when token mapping for ERC721 token is updated.
+
+
+
+#### Parameters
+
+| Name | Type | Description |
+|---|---|---|
+| l2Token `indexed` | address | The address of corresponding ERC721 token in layer 2. |
+| oldL1Token `indexed` | address | The address of the old corresponding ERC721 token in layer 1. |
+| newL1Token `indexed` | address | The address of the new corresponding ERC721 token in layer 1. |
+
+### WithdrawERC721
+
+```solidity
+event WithdrawERC721(address indexed l1Token, address indexed l2Token, address indexed from, address to, uint256 tokenId)
+```
+
+Emitted when the ERC721 NFT is transferred to gateway on layer 2.
+
+
+
+#### Parameters
+
+| Name | Type | Description |
+|---|---|---|
+| l1Token `indexed` | address | The address of ERC721 NFT on layer 1. |
+| l2Token `indexed` | address | The address of ERC721 NFT on layer 2. |
+| from `indexed` | address | The address of sender on layer 2. |
+| to  | address | The address of recipient on layer 1. |
+| tokenId  | uint256 | The token id of the ERC721 NFT to withdraw on layer 2. |
+
+
+
+## Errors
+
+### ErrorCallerIsNotCounterpartGateway
+
+```solidity
+error ErrorCallerIsNotCounterpartGateway()
+```
+
+
+
+*Thrown when the cross chain sender is not the counterpart gateway contract.*
+
+
+### ErrorCallerIsNotMessenger
+
+```solidity
+error ErrorCallerIsNotMessenger()
+```
+
+
+
+*Thrown when the caller is not corresponding `L1ScrollMessenger` or `L2ScrollMessenger`.*
+
+
+### ErrorNotInDropMessageContext
+
+```solidity
+error ErrorNotInDropMessageContext()
+```
+
+
+
+*Thrown when ScrollMessenger is not dropping message.*
+
+
+### ErrorZeroAddress
+
+```solidity
+error ErrorZeroAddress()
+```
+
+
+
+*Thrown when the given address is `address(0)`.*
+
+
+

contracts/docs/apis/L2GatewayRouter.md

@@ -0,0 +1,566 @@
+# L2GatewayRouter
+
+
+
+> L2GatewayRouter
+
+The `L2GatewayRouter` is the main entry for withdrawing Ether and ERC20 tokens. All deposited tokens are routed to corresponding gateways.
+
+*One can also use this contract to query L1/L2 token address mapping. In the future, ERC-721 and ERC-1155 tokens will be added to the router too.*
+
+## Methods
+
+### ERC20Gateway
+
+```solidity
+function ERC20Gateway(address) external view returns (address)
+```
+
+Mapping from L2 ERC20 token address to corresponding L2ERC20Gateway.
+
+
+
+#### Parameters
+
+| Name | Type | Description |
+|---|---|---|
+| _0 | address | undefined |
+
+#### Returns
+
+| Name | Type | Description |
+|---|---|---|
+| _0 | address | undefined |
+
+### defaultERC20Gateway
+
+```solidity
+function defaultERC20Gateway() external view returns (address)
+```
+
+The addess of default L2 ERC20 gateway, normally the L2StandardERC20Gateway contract.
+
+
+
+
+#### Returns
+
+| Name | Type | Description |
+|---|---|---|
+| _0 | address | undefined |
+
+### ethGateway
+
+```solidity
+function ethGateway() external view returns (address)
+```
+
+The address of L2ETHGateway.
+
+
+
+
+#### Returns
+
+| Name | Type | Description |
+|---|---|---|
+| _0 | address | undefined |
+
+### finalizeDepositERC20
+
+```solidity
+function finalizeDepositERC20(address, address, address, address, uint256, bytes) external payable
+```
+
+Complete a deposit from L1 to L2 and send fund to recipient's account in L2.
+
+*Make this function payable to handle WETH deposit/withdraw.      The function should only be called by L2ScrollMessenger.      The function should also only be called by L1ERC20Gateway in L1.*
+
+#### Parameters
+
+| Name | Type | Description |
+|---|---|---|
+| _0 | address | undefined |
+| _1 | address | undefined |
+| _2 | address | undefined |
+| _3 | address | undefined |
+| _4 | uint256 | undefined |
+| _5 | bytes | undefined |
+
+### finalizeDepositETH
+
+```solidity
+function finalizeDepositETH(address, address, uint256, bytes) external payable
+```
+
+Complete ETH deposit from L1 to L2 and send fund to recipient's account in L2.
+
+*This function should only be called by L2ScrollMessenger.      This function should also only be called by L1GatewayRouter in L1.*
+
+#### Parameters
+
+| Name | Type | Description |
+|---|---|---|
+| _0 | address | undefined |
+| _1 | address | undefined |
+| _2 | uint256 | undefined |
+| _3 | bytes | undefined |
+
+### getERC20Gateway
+
+```solidity
+function getERC20Gateway(address _token) external view returns (address)
+```
+
+Return the corresponding gateway address for given token address.
+
+
+
+#### Parameters
+
+| Name | Type | Description |
+|---|---|---|
+| _token | address | The address of token to query. |
+
+#### Returns
+
+| Name | Type | Description |
+|---|---|---|
+| _0 | address | undefined |
+
+### getL1ERC20Address
+
+```solidity
+function getL1ERC20Address(address _l2Address) external view returns (address)
+```
+
+Return the corresponding l1 token address given l2 token address.
+
+
+
+#### Parameters
+
+| Name | Type | Description |
+|---|---|---|
+| _l2Address | address | undefined |
+
+#### Returns
+
+| Name | Type | Description |
+|---|---|---|
+| _0 | address | undefined |
+
+### getL2ERC20Address
+
+```solidity
+function getL2ERC20Address(address) external pure returns (address)
+```
+
+Return the corresponding l2 token address given l1 token address.
+
+
+
+#### Parameters
+
+| Name | Type | Description |
+|---|---|---|
+| _0 | address | undefined |
+
+#### Returns
+
+| Name | Type | Description |
+|---|---|---|
+| _0 | address | undefined |
+
+### initialize
+
+```solidity
+function initialize(address _ethGateway, address _defaultERC20Gateway) external nonpayable
+```
+
+
+
+
+
+#### Parameters
+
+| Name | Type | Description |
+|---|---|---|
+| _ethGateway | address | undefined |
+| _defaultERC20Gateway | address | undefined |
+
+### owner
+
+```solidity
+function owner() external view returns (address)
+```
+
+
+
+*Returns the address of the current owner.*
+
+
+#### Returns
+
+| Name | Type | Description |
+|---|---|---|
+| _0 | address | undefined |
+
+### renounceOwnership
+
+```solidity
+function renounceOwnership() external nonpayable
+```
+
+
+
+*Leaves the contract without owner. It will not be possible to call `onlyOwner` functions. Can only be called by the current owner. NOTE: Renouncing ownership will leave the contract without an owner, thereby disabling any functionality that is only available to the owner.*
+
+
+### setDefaultERC20Gateway
+
+```solidity
+function setDefaultERC20Gateway(address _newDefaultERC20Gateway) external nonpayable
+```
+
+Update the address of default ERC20 gateway contract.
+
+*This function should only be called by contract owner.*
+
+#### Parameters
+
+| Name | Type | Description |
+|---|---|---|
+| _newDefaultERC20Gateway | address | The address to update. |
+
+### setERC20Gateway
+
+```solidity
+function setERC20Gateway(address[] _tokens, address[] _gateways) external nonpayable
+```
+
+Update the mapping from token address to gateway address.
+
+*This function should only be called by contract owner.*
+
+#### Parameters
+
+| Name | Type | Description |
+|---|---|---|
+| _tokens | address[] | The list of addresses of tokens to update. |
+| _gateways | address[] | The list of addresses of gateways to update. |
+
+### setETHGateway
+
+```solidity
+function setETHGateway(address _newEthGateway) external nonpayable
+```
+
+Update the address of ETH gateway contract.
+
+*This function should only be called by contract owner.*
+
+#### Parameters
+
+| Name | Type | Description |
+|---|---|---|
+| _newEthGateway | address | The address to update. |
+
+### transferOwnership
+
+```solidity
+function transferOwnership(address newOwner) external nonpayable
+```
+
+
+
+*Transfers ownership of the contract to a new account (`newOwner`). Can only be called by the current owner.*
+
+#### Parameters
+
+| Name | Type | Description |
+|---|---|---|
+| newOwner | address | undefined |
+
+### withdrawERC20
+
+```solidity
+function withdrawERC20(address _token, uint256 _amount, uint256 _gasLimit) external payable
+```
+
+Withdraw of some token to a caller's account on L1.
+
+*Make this function payable to send relayer fee in Ether.*
+
+#### Parameters
+
+| Name | Type | Description |
+|---|---|---|
+| _token | address | undefined |
+| _amount | uint256 | undefined |
+| _gasLimit | uint256 | undefined |
+
+### withdrawERC20
+
+```solidity
+function withdrawERC20(address _token, address _to, uint256 _amount, uint256 _gasLimit) external payable
+```
+
+Withdraw of some token to a recipient's account on L1.
+
+*Make this function payable to send relayer fee in Ether.*
+
+#### Parameters
+
+| Name | Type | Description |
+|---|---|---|
+| _token | address | undefined |
+| _to | address | undefined |
+| _amount | uint256 | undefined |
+| _gasLimit | uint256 | undefined |
+
+### withdrawERC20AndCall
+
+```solidity
+function withdrawERC20AndCall(address _token, address _to, uint256 _amount, bytes _data, uint256 _gasLimit) external payable
+```
+
+Withdraw of some token to a recipient's account on L1 and call.
+
+*Make this function payable to send relayer fee in Ether.*
+
+#### Parameters
+
+| Name | Type | Description |
+|---|---|---|
+| _token | address | undefined |
+| _to | address | undefined |
+| _amount | uint256 | undefined |
+| _data | bytes | undefined |
+| _gasLimit | uint256 | undefined |
+
+### withdrawETH
+
+```solidity
+function withdrawETH(address _to, uint256 _amount, uint256 _gasLimit) external payable
+```
+
+Withdraw ETH to caller's account in L1.
+
+
+
+#### Parameters
+
+| Name | Type | Description |
+|---|---|---|
+| _to | address | undefined |
+| _amount | uint256 | undefined |
+| _gasLimit | uint256 | undefined |
+
+### withdrawETH
+
+```solidity
+function withdrawETH(uint256 _amount, uint256 _gasLimit) external payable
+```
+
+Withdraw ETH to caller's account in L1.
+
+
+
+#### Parameters
+
+| Name | Type | Description |
+|---|---|---|
+| _amount | uint256 | undefined |
+| _gasLimit | uint256 | undefined |
+
+### withdrawETHAndCall
+
+```solidity
+function withdrawETHAndCall(address _to, uint256 _amount, bytes _data, uint256 _gasLimit) external payable
+```
+
+Withdraw ETH to caller's account in L1.
+
+
+
+#### Parameters
+
+| Name | Type | Description |
+|---|---|---|
+| _to | address | undefined |
+| _amount | uint256 | undefined |
+| _data | bytes | undefined |
+| _gasLimit | uint256 | undefined |
+
+
+
+## Events
+
+### FinalizeDepositERC20
+
+```solidity
+event FinalizeDepositERC20(address indexed l1Token, address indexed l2Token, address indexed from, address to, uint256 amount, bytes data)
+```
+
+Emitted when ERC20 token is deposited from L1 to L2 and transfer to recipient.
+
+
+
+#### Parameters
+
+| Name | Type | Description |
+|---|---|---|
+| l1Token `indexed` | address | The address of the token in L1. |
+| l2Token `indexed` | address | The address of the token in L2. |
+| from `indexed` | address | The address of sender in L1. |
+| to  | address | The address of recipient in L2. |
+| amount  | uint256 | The amount of token withdrawn from L1 to L2. |
+| data  | bytes | The optional calldata passed to recipient in L2. |
+
+### FinalizeDepositETH
+
+```solidity
+event FinalizeDepositETH(address indexed from, address indexed to, uint256 amount, bytes data)
+```
+
+Emitted when ETH is deposited from L1 to L2 and transfer to recipient.
+
+
+
+#### Parameters
+
+| Name | Type | Description |
+|---|---|---|
+| from `indexed` | address | The address of sender in L1. |
+| to `indexed` | address | The address of recipient in L2. |
+| amount  | uint256 | The amount of ETH deposited from L1 to L2. |
+| data  | bytes | The optional calldata passed to recipient in L2. |
+
+### Initialized
+
+```solidity
+event Initialized(uint8 version)
+```
+
+
+
+*Triggered when the contract has been initialized or reinitialized.*
+
+#### Parameters
+
+| Name | Type | Description |
+|---|---|---|
+| version  | uint8 | undefined |
+
+### OwnershipTransferred
+
+```solidity
+event OwnershipTransferred(address indexed previousOwner, address indexed newOwner)
+```
+
+
+
+
+
+#### Parameters
+
+| Name | Type | Description |
+|---|---|---|
+| previousOwner `indexed` | address | undefined |
+| newOwner `indexed` | address | undefined |
+
+### SetDefaultERC20Gateway
+
+```solidity
+event SetDefaultERC20Gateway(address indexed oldDefaultERC20Gateway, address indexed newDefaultERC20Gateway)
+```
+
+Emitted when the address of default ERC20 Gateway is updated.
+
+
+
+#### Parameters
+
+| Name | Type | Description |
+|---|---|---|
+| oldDefaultERC20Gateway `indexed` | address | The address of the old default ERC20 Gateway. |
+| newDefaultERC20Gateway `indexed` | address | The address of the new default ERC20 Gateway. |
+
+### SetERC20Gateway
+
+```solidity
+event SetERC20Gateway(address indexed token, address indexed oldGateway, address indexed newGateway)
+```
+
+Emitted when the `gateway` for `token` is updated.
+
+
+
+#### Parameters
+
+| Name | Type | Description |
+|---|---|---|
+| token `indexed` | address | The address of token updated. |
+| oldGateway `indexed` | address | The corresponding address of the old gateway. |
+| newGateway `indexed` | address | The corresponding address of the new gateway. |
+
+### SetETHGateway
+
+```solidity
+event SetETHGateway(address indexed oldETHGateway, address indexed newEthGateway)
+```
+
+Emitted when the address of ETH Gateway is updated.
+
+
+
+#### Parameters
+
+| Name | Type | Description |
+|---|---|---|
+| oldETHGateway `indexed` | address | The address of the old ETH Gateway. |
+| newEthGateway `indexed` | address | The address of the new ETH Gateway. |
+
+### WithdrawERC20
+
+```solidity
+event WithdrawERC20(address indexed l1Token, address indexed l2Token, address indexed from, address to, uint256 amount, bytes data)
+```
+
+Emitted when someone withdraw ERC20 token from L2 to L1.
+
+
+
+#### Parameters
+
+| Name | Type | Description |
+|---|---|---|
+| l1Token `indexed` | address | The address of the token in L1. |
+| l2Token `indexed` | address | The address of the token in L2. |
+| from `indexed` | address | The address of sender in L2. |
+| to  | address | The address of recipient in L1. |
+| amount  | uint256 | The amount of token will be deposited from L2 to L1. |
+| data  | bytes | The optional calldata passed to recipient in L1. |
+
+### WithdrawETH
+
+```solidity
+event WithdrawETH(address indexed from, address indexed to, uint256 amount, bytes data)
+```
+
+Emitted when someone withdraw ETH from L2 to L1.
+
+
+
+#### Parameters
+
+| Name | Type | Description |
+|---|---|---|
+| from `indexed` | address | The address of sender in L2. |
+| to `indexed` | address | The address of recipient in L1. |
+| amount  | uint256 | The amount of ETH will be deposited from L2 to L1. |
+| data  | bytes | The optional calldata passed to recipient in L1. |
+
+
+

contracts/docs/apis/L2ScrollMessenger.md

@@ -0,0 +1,464 @@
+# L2ScrollMessenger
+
+
+
+> L2ScrollMessenger
+
+The `L2ScrollMessenger` contract can: 1. send messages from layer 2 to layer 1; 2. relay messages from layer 1 layer 2; 3. drop expired message due to sequencer problems.
+
+*It should be a predeployed contract on layer 2 and should hold infinite amount of Ether (Specifically, `uint256(-1)`), which can be initialized in Genesis Block.*
+
+## Methods
+
+### counterpart
+
+```solidity
+function counterpart() external view returns (address)
+```
+
+The address of counterpart ScrollMessenger contract in L1/L2.
+
+
+
+
+#### Returns
+
+| Name | Type | Description |
+|---|---|---|
+| _0 | address | undefined |
+
+### feeVault
+
+```solidity
+function feeVault() external view returns (address)
+```
+
+The address of fee vault, collecting cross domain messaging fee.
+
+
+
+
+#### Returns
+
+| Name | Type | Description |
+|---|---|---|
+| _0 | address | undefined |
+
+### initialize
+
+```solidity
+function initialize(address) external nonpayable
+```
+
+
+
+
+
+#### Parameters
+
+| Name | Type | Description |
+|---|---|---|
+| _0 | address | undefined |
+
+### isL1MessageExecuted
+
+```solidity
+function isL1MessageExecuted(bytes32) external view returns (bool)
+```
+
+Mapping from L1 message hash to a boolean value indicating if the message has been successfully executed.
+
+
+
+#### Parameters
+
+| Name | Type | Description |
+|---|---|---|
+| _0 | bytes32 | undefined |
+
+#### Returns
+
+| Name | Type | Description |
+|---|---|---|
+| _0 | bool | undefined |
+
+### messageQueue
+
+```solidity
+function messageQueue() external view returns (address)
+```
+
+The address of L2MessageQueue.
+
+
+
+
+#### Returns
+
+| Name | Type | Description |
+|---|---|---|
+| _0 | address | undefined |
+
+### messageSendTimestamp
+
+```solidity
+function messageSendTimestamp(bytes32) external view returns (uint256)
+```
+
+Mapping from L2 message hash to the timestamp when the message is sent.
+
+
+
+#### Parameters
+
+| Name | Type | Description |
+|---|---|---|
+| _0 | bytes32 | undefined |
+
+#### Returns
+
+| Name | Type | Description |
+|---|---|---|
+| _0 | uint256 | undefined |
+
+### owner
+
+```solidity
+function owner() external view returns (address)
+```
+
+
+
+*Returns the address of the current owner.*
+
+
+#### Returns
+
+| Name | Type | Description |
+|---|---|---|
+| _0 | address | undefined |
+
+### paused
+
+```solidity
+function paused() external view returns (bool)
+```
+
+
+
+*Returns true if the contract is paused, and false otherwise.*
+
+
+#### Returns
+
+| Name | Type | Description |
+|---|---|---|
+| _0 | bool | undefined |
+
+### relayMessage
+
+```solidity
+function relayMessage(address _from, address _to, uint256 _value, uint256 _nonce, bytes _message) external nonpayable
+```
+
+execute L1 => L2 message
+
+*Make sure this is only called by privileged accounts.*
+
+#### Parameters
+
+| Name | Type | Description |
+|---|---|---|
+| _from | address | undefined |
+| _to | address | undefined |
+| _value | uint256 | undefined |
+| _nonce | uint256 | undefined |
+| _message | bytes | undefined |
+
+### renounceOwnership
+
+```solidity
+function renounceOwnership() external nonpayable
+```
+
+
+
+*Leaves the contract without owner. It will not be possible to call `onlyOwner` functions. Can only be called by the current owner. NOTE: Renouncing ownership will leave the contract without an owner, thereby disabling any functionality that is only available to the owner.*
+
+
+### sendMessage
+
+```solidity
+function sendMessage(address _to, uint256 _value, bytes _message, uint256 _gasLimit, address) external payable
+```
+
+Send cross chain message from L1 to L2 or L2 to L1.
+
+
+
+#### Parameters
+
+| Name | Type | Description |
+|---|---|---|
+| _to | address | undefined |
+| _value | uint256 | undefined |
+| _message | bytes | undefined |
+| _gasLimit | uint256 | undefined |
+| _4 | address | undefined |
+
+### sendMessage
+
+```solidity
+function sendMessage(address _to, uint256 _value, bytes _message, uint256 _gasLimit) external payable
+```
+
+Send cross chain message from L1 to L2 or L2 to L1.
+
+
+
+#### Parameters
+
+| Name | Type | Description |
+|---|---|---|
+| _to | address | undefined |
+| _value | uint256 | undefined |
+| _message | bytes | undefined |
+| _gasLimit | uint256 | undefined |
+
+### setPause
+
+```solidity
+function setPause(bool _status) external nonpayable
+```
+
+Pause the contract
+
+*This function can only called by contract owner.*
+
+#### Parameters
+
+| Name | Type | Description |
+|---|---|---|
+| _status | bool | The pause status to update. |
+
+### transferOwnership
+
+```solidity
+function transferOwnership(address newOwner) external nonpayable
+```
+
+
+
+*Transfers ownership of the contract to a new account (`newOwner`). Can only be called by the current owner.*
+
+#### Parameters
+
+| Name | Type | Description |
+|---|---|---|
+| newOwner | address | undefined |
+
+### updateFeeVault
+
+```solidity
+function updateFeeVault(address _newFeeVault) external nonpayable
+```
+
+Update fee vault contract.
+
+*This function can only called by contract owner.*
+
+#### Parameters
+
+| Name | Type | Description |
+|---|---|---|
+| _newFeeVault | address | The address of new fee vault contract. |
+
+### xDomainMessageSender
+
+```solidity
+function xDomainMessageSender() external view returns (address)
+```
+
+See {IScrollMessenger-xDomainMessageSender}
+
+
+
+
+#### Returns
+
+| Name | Type | Description |
+|---|---|---|
+| _0 | address | undefined |
+
+
+
+## Events
+
+### FailedRelayedMessage
+
+```solidity
+event FailedRelayedMessage(bytes32 indexed messageHash)
+```
+
+Emitted when a cross domain message is failed to relay.
+
+
+
+#### Parameters
+
+| Name | Type | Description |
+|---|---|---|
+| messageHash `indexed` | bytes32 | The hash of the message. |
+
+### Initialized
+
+```solidity
+event Initialized(uint8 version)
+```
+
+
+
+*Triggered when the contract has been initialized or reinitialized.*
+
+#### Parameters
+
+| Name | Type | Description |
+|---|---|---|
+| version  | uint8 | undefined |
+
+### OwnershipTransferred
+
+```solidity
+event OwnershipTransferred(address indexed previousOwner, address indexed newOwner)
+```
+
+
+
+
+
+#### Parameters
+
+| Name | Type | Description |
+|---|---|---|
+| previousOwner `indexed` | address | undefined |
+| newOwner `indexed` | address | undefined |
+
+### Paused
+
+```solidity
+event Paused(address account)
+```
+
+
+
+*Emitted when the pause is triggered by `account`.*
+
+#### Parameters
+
+| Name | Type | Description |
+|---|---|---|
+| account  | address | undefined |
+
+### RelayedMessage
+
+```solidity
+event RelayedMessage(bytes32 indexed messageHash)
+```
+
+Emitted when a cross domain message is relayed successfully.
+
+
+
+#### Parameters
+
+| Name | Type | Description |
+|---|---|---|
+| messageHash `indexed` | bytes32 | The hash of the message. |
+
+### SentMessage
+
+```solidity
+event SentMessage(address indexed sender, address indexed target, uint256 value, uint256 messageNonce, uint256 gasLimit, bytes message)
+```
+
+Emitted when a cross domain message is sent.
+
+
+
+#### Parameters
+
+| Name | Type | Description |
+|---|---|---|
+| sender `indexed` | address | The address of the sender who initiates the message. |
+| target `indexed` | address | The address of target contract to call. |
+| value  | uint256 | The amount of value passed to the target contract. |
+| messageNonce  | uint256 | The nonce of the message. |
+| gasLimit  | uint256 | The optional gas limit passed to L1 or L2. |
+| message  | bytes | The calldata passed to the target contract. |
+
+### Unpaused
+
+```solidity
+event Unpaused(address account)
+```
+
+
+
+*Emitted when the pause is lifted by `account`.*
+
+#### Parameters
+
+| Name | Type | Description |
+|---|---|---|
+| account  | address | undefined |
+
+### UpdateFeeVault
+
+```solidity
+event UpdateFeeVault(address _oldFeeVault, address _newFeeVault)
+```
+
+Emitted when owner updates fee vault contract.
+
+
+
+#### Parameters
+
+| Name | Type | Description |
+|---|---|---|
+| _oldFeeVault  | address | The address of old fee vault contract. |
+| _newFeeVault  | address | The address of new fee vault contract. |
+
+### UpdateMaxFailedExecutionTimes
+
+```solidity
+event UpdateMaxFailedExecutionTimes(uint256 oldMaxFailedExecutionTimes, uint256 newMaxFailedExecutionTimes)
+```
+
+Emitted when the maximum number of times each message can fail in L2 is updated.
+
+
+
+#### Parameters
+
+| Name | Type | Description |
+|---|---|---|
+| oldMaxFailedExecutionTimes  | uint256 | The old maximum number of times each message can fail in L2. |
+| newMaxFailedExecutionTimes  | uint256 | The new maximum number of times each message can fail in L2. |
+
+
+
+## Errors
+
+### ErrorZeroAddress
+
+```solidity
+error ErrorZeroAddress()
+```
+
+
+
+*Thrown when the given address is `address(0)`.*
+
+
+

contracts/docs/apis/L2StandardERC20Gateway.md

@@ -0,0 +1,393 @@
+# L2StandardERC20Gateway
+
+
+
+> L2StandardERC20Gateway
+
+The `L2StandardERC20Gateway` is used to withdraw standard ERC20 tokens on layer 2 and finalize deposit the tokens from layer 1.
+
+*The withdrawn ERC20 tokens will be burned directly. On finalizing deposit, the corresponding token will be minted and transferred to the recipient. Any ERC20 that requires non-standard functionality should use a separate gateway.*
+
+## Methods
+
+### counterpart
+
+```solidity
+function counterpart() external view returns (address)
+```
+
+The address of corresponding L1/L2 Gateway contract.
+
+
+
+
+#### Returns
+
+| Name | Type | Description |
+|---|---|---|
+| _0 | address | undefined |
+
+### finalizeDepositERC20
+
+```solidity
+function finalizeDepositERC20(address _l1Token, address _l2Token, address _from, address _to, uint256 _amount, bytes _data) external payable
+```
+
+Complete a deposit from L1 to L2 and send fund to recipient's account in L2.
+
+*Make this function payable to handle WETH deposit/withdraw.      The function should only be called by L2ScrollMessenger.      The function should also only be called by L1ERC20Gateway in L1.*
+
+#### Parameters
+
+| Name | Type | Description |
+|---|---|---|
+| _l1Token | address | undefined |
+| _l2Token | address | undefined |
+| _from | address | undefined |
+| _to | address | undefined |
+| _amount | uint256 | undefined |
+| _data | bytes | undefined |
+
+### getL1ERC20Address
+
+```solidity
+function getL1ERC20Address(address _l2Token) external view returns (address)
+```
+
+Return the corresponding l1 token address given l2 token address.
+
+
+
+#### Parameters
+
+| Name | Type | Description |
+|---|---|---|
+| _l2Token | address | undefined |
+
+#### Returns
+
+| Name | Type | Description |
+|---|---|---|
+| _0 | address | undefined |
+
+### getL2ERC20Address
+
+```solidity
+function getL2ERC20Address(address _l1Token) external view returns (address)
+```
+
+Return the corresponding l2 token address given l1 token address.
+
+
+
+#### Parameters
+
+| Name | Type | Description |
+|---|---|---|
+| _l1Token | address | undefined |
+
+#### Returns
+
+| Name | Type | Description |
+|---|---|---|
+| _0 | address | undefined |
+
+### initialize
+
+```solidity
+function initialize(address _counterpart, address _router, address _messenger, address) external nonpayable
+```
+
+Initialize the storage of L2StandardERC20Gateway.
+
+*The parameters `_counterpart`, `_router`, `_messenger` and `_tokenFactory` are no longer used.*
+
+#### Parameters
+
+| Name | Type | Description |
+|---|---|---|
+| _counterpart | address | The address of `L1StandardERC20Gateway` contract in L1. |
+| _router | address | The address of `L2GatewayRouter` contract in L2. |
+| _messenger | address | The address of `L2ScrollMessenger` contract in L2. |
+| _3 | address | undefined |
+
+### messenger
+
+```solidity
+function messenger() external view returns (address)
+```
+
+The address of corresponding L1ScrollMessenger/L2ScrollMessenger contract.
+
+
+
+
+#### Returns
+
+| Name | Type | Description |
+|---|---|---|
+| _0 | address | undefined |
+
+### owner
+
+```solidity
+function owner() external view returns (address)
+```
+
+
+
+*Returns the address of the current owner.*
+
+
+#### Returns
+
+| Name | Type | Description |
+|---|---|---|
+| _0 | address | undefined |
+
+### renounceOwnership
+
+```solidity
+function renounceOwnership() external nonpayable
+```
+
+
+
+*Leaves the contract without owner. It will not be possible to call `onlyOwner` functions. Can only be called by the current owner. NOTE: Renouncing ownership will leave the contract without an owner, thereby disabling any functionality that is only available to the owner.*
+
+
+### router
+
+```solidity
+function router() external view returns (address)
+```
+
+The address of L1GatewayRouter/L2GatewayRouter contract.
+
+
+
+
+#### Returns
+
+| Name | Type | Description |
+|---|---|---|
+| _0 | address | undefined |
+
+### tokenFactory
+
+```solidity
+function tokenFactory() external view returns (address)
+```
+
+The address of ScrollStandardERC20Factory.
+
+
+
+
+#### Returns
+
+| Name | Type | Description |
+|---|---|---|
+| _0 | address | undefined |
+
+### transferOwnership
+
+```solidity
+function transferOwnership(address newOwner) external nonpayable
+```
+
+
+
+*Transfers ownership of the contract to a new account (`newOwner`). Can only be called by the current owner.*
+
+#### Parameters
+
+| Name | Type | Description |
+|---|---|---|
+| newOwner | address | undefined |
+
+### withdrawERC20
+
+```solidity
+function withdrawERC20(address _token, uint256 _amount, uint256 _gasLimit) external payable
+```
+
+Withdraw of some token to a caller's account on L1.
+
+*Make this function payable to send relayer fee in Ether.*
+
+#### Parameters
+
+| Name | Type | Description |
+|---|---|---|
+| _token | address | undefined |
+| _amount | uint256 | undefined |
+| _gasLimit | uint256 | undefined |
+
+### withdrawERC20
+
+```solidity
+function withdrawERC20(address _token, address _to, uint256 _amount, uint256 _gasLimit) external payable
+```
+
+Withdraw of some token to a recipient's account on L1.
+
+*Make this function payable to send relayer fee in Ether.*
+
+#### Parameters
+
+| Name | Type | Description |
+|---|---|---|
+| _token | address | undefined |
+| _to | address | undefined |
+| _amount | uint256 | undefined |
+| _gasLimit | uint256 | undefined |
+
+### withdrawERC20AndCall
+
+```solidity
+function withdrawERC20AndCall(address _token, address _to, uint256 _amount, bytes _data, uint256 _gasLimit) external payable
+```
+
+Withdraw of some token to a recipient's account on L1 and call.
+
+*Make this function payable to send relayer fee in Ether.*
+
+#### Parameters
+
+| Name | Type | Description |
+|---|---|---|
+| _token | address | undefined |
+| _to | address | undefined |
+| _amount | uint256 | undefined |
+| _data | bytes | undefined |
+| _gasLimit | uint256 | undefined |
+
+
+
+## Events
+
+### FinalizeDepositERC20
+
+```solidity
+event FinalizeDepositERC20(address indexed l1Token, address indexed l2Token, address indexed from, address to, uint256 amount, bytes data)
+```
+
+Emitted when ERC20 token is deposited from L1 to L2 and transfer to recipient.
+
+
+
+#### Parameters
+
+| Name | Type | Description |
+|---|---|---|
+| l1Token `indexed` | address | The address of the token in L1. |
+| l2Token `indexed` | address | The address of the token in L2. |
+| from `indexed` | address | The address of sender in L1. |
+| to  | address | The address of recipient in L2. |
+| amount  | uint256 | The amount of token withdrawn from L1 to L2. |
+| data  | bytes | The optional calldata passed to recipient in L2. |
+
+### Initialized
+
+```solidity
+event Initialized(uint8 version)
+```
+
+
+
+*Triggered when the contract has been initialized or reinitialized.*
+
+#### Parameters
+
+| Name | Type | Description |
+|---|---|---|
+| version  | uint8 | undefined |
+
+### OwnershipTransferred
+
+```solidity
+event OwnershipTransferred(address indexed previousOwner, address indexed newOwner)
+```
+
+
+
+
+
+#### Parameters
+
+| Name | Type | Description |
+|---|---|---|
+| previousOwner `indexed` | address | undefined |
+| newOwner `indexed` | address | undefined |
+
+### WithdrawERC20
+
+```solidity
+event WithdrawERC20(address indexed l1Token, address indexed l2Token, address indexed from, address to, uint256 amount, bytes data)
+```
+
+Emitted when someone withdraw ERC20 token from L2 to L1.
+
+
+
+#### Parameters
+
+| Name | Type | Description |
+|---|---|---|
+| l1Token `indexed` | address | The address of the token in L1. |
+| l2Token `indexed` | address | The address of the token in L2. |
+| from `indexed` | address | The address of sender in L2. |
+| to  | address | The address of recipient in L1. |
+| amount  | uint256 | The amount of token will be deposited from L2 to L1. |
+| data  | bytes | The optional calldata passed to recipient in L1. |
+
+
+
+## Errors
+
+### ErrorCallerIsNotCounterpartGateway
+
+```solidity
+error ErrorCallerIsNotCounterpartGateway()
+```
+
+
+
+*Thrown when the cross chain sender is not the counterpart gateway contract.*
+
+
+### ErrorCallerIsNotMessenger
+
+```solidity
+error ErrorCallerIsNotMessenger()
+```
+
+
+
+*Thrown when the caller is not corresponding `L1ScrollMessenger` or `L2ScrollMessenger`.*
+
+
+### ErrorNotInDropMessageContext
+
+```solidity
+error ErrorNotInDropMessageContext()
+```
+
+
+
+*Thrown when ScrollMessenger is not dropping message.*
+
+
+### ErrorZeroAddress
+
+```solidity
+error ErrorZeroAddress()
+```
+
+
+
+*Thrown when the given address is `address(0)`.*
+
+
+

contracts/docs/apis/L2WETHGateway.md

@@ -0,0 +1,409 @@
+# L2WETHGateway
+
+
+
+> L2WETHGateway
+
+The `L2WETHGateway` contract is used to withdraw `WETH` token on layer 2 and finalize deposit `WETH` from layer 1.
+
+*The WETH tokens are not held in the gateway. It will first be unwrapped as Ether and then the Ether will be sent to the `L2ScrollMessenger` contract. On finalizing deposit, the Ether will be transferred from `L2ScrollMessenger`, then wrapped as WETH and finally transfer to recipient.*
+
+## Methods
+
+### WETH
+
+```solidity
+function WETH() external view returns (address)
+```
+
+The address of L2 WETH address.
+
+
+
+
+#### Returns
+
+| Name | Type | Description |
+|---|---|---|
+| _0 | address | undefined |
+
+### counterpart
+
+```solidity
+function counterpart() external view returns (address)
+```
+
+The address of corresponding L1/L2 Gateway contract.
+
+
+
+
+#### Returns
+
+| Name | Type | Description |
+|---|---|---|
+| _0 | address | undefined |
+
+### finalizeDepositERC20
+
+```solidity
+function finalizeDepositERC20(address _l1Token, address _l2Token, address _from, address _to, uint256 _amount, bytes _data) external payable
+```
+
+Complete a deposit from L1 to L2 and send fund to recipient's account in L2.
+
+*Make this function payable to handle WETH deposit/withdraw.      The function should only be called by L2ScrollMessenger.      The function should also only be called by L1ERC20Gateway in L1.*
+
+#### Parameters
+
+| Name | Type | Description |
+|---|---|---|
+| _l1Token | address | undefined |
+| _l2Token | address | undefined |
+| _from | address | undefined |
+| _to | address | undefined |
+| _amount | uint256 | undefined |
+| _data | bytes | undefined |
+
+### getL1ERC20Address
+
+```solidity
+function getL1ERC20Address(address) external view returns (address)
+```
+
+Return the corresponding l1 token address given l2 token address.
+
+
+
+#### Parameters
+
+| Name | Type | Description |
+|---|---|---|
+| _0 | address | undefined |
+
+#### Returns
+
+| Name | Type | Description |
+|---|---|---|
+| _0 | address | undefined |
+
+### getL2ERC20Address
+
+```solidity
+function getL2ERC20Address(address) external view returns (address)
+```
+
+Return the corresponding l2 token address given l1 token address.
+
+
+
+#### Parameters
+
+| Name | Type | Description |
+|---|---|---|
+| _0 | address | undefined |
+
+#### Returns
+
+| Name | Type | Description |
+|---|---|---|
+| _0 | address | undefined |
+
+### initialize
+
+```solidity
+function initialize(address _counterpart, address _router, address _messenger) external nonpayable
+```
+
+Initialize the storage of `L2WETHGateway`.
+
+*The parameters `_counterpart`, `_router` and `_messenger` are no longer used.*
+
+#### Parameters
+
+| Name | Type | Description |
+|---|---|---|
+| _counterpart | address | The address of `L1WETHGateway` contract in L1. |
+| _router | address | The address of `L2GatewayRouter` contract in L2. |
+| _messenger | address | The address of `L2ScrollMessenger` contract in L2. |
+
+### l1WETH
+
+```solidity
+function l1WETH() external view returns (address)
+```
+
+The address of L1 WETH address.
+
+
+
+
+#### Returns
+
+| Name | Type | Description |
+|---|---|---|
+| _0 | address | undefined |
+
+### messenger
+
+```solidity
+function messenger() external view returns (address)
+```
+
+The address of corresponding L1ScrollMessenger/L2ScrollMessenger contract.
+
+
+
+
+#### Returns
+
+| Name | Type | Description |
+|---|---|---|
+| _0 | address | undefined |
+
+### owner
+
+```solidity
+function owner() external view returns (address)
+```
+
+
+
+*Returns the address of the current owner.*
+
+
+#### Returns
+
+| Name | Type | Description |
+|---|---|---|
+| _0 | address | undefined |
+
+### renounceOwnership
+
+```solidity
+function renounceOwnership() external nonpayable
+```
+
+
+
+*Leaves the contract without owner. It will not be possible to call `onlyOwner` functions. Can only be called by the current owner. NOTE: Renouncing ownership will leave the contract without an owner, thereby disabling any functionality that is only available to the owner.*
+
+
+### router
+
+```solidity
+function router() external view returns (address)
+```
+
+The address of L1GatewayRouter/L2GatewayRouter contract.
+
+
+
+
+#### Returns
+
+| Name | Type | Description |
+|---|---|---|
+| _0 | address | undefined |
+
+### transferOwnership
+
+```solidity
+function transferOwnership(address newOwner) external nonpayable
+```
+
+
+
+*Transfers ownership of the contract to a new account (`newOwner`). Can only be called by the current owner.*
+
+#### Parameters
+
+| Name | Type | Description |
+|---|---|---|
+| newOwner | address | undefined |
+
+### withdrawERC20
+
+```solidity
+function withdrawERC20(address _token, uint256 _amount, uint256 _gasLimit) external payable
+```
+
+Withdraw of some token to a caller's account on L1.
+
+*Make this function payable to send relayer fee in Ether.*
+
+#### Parameters
+
+| Name | Type | Description |
+|---|---|---|
+| _token | address | undefined |
+| _amount | uint256 | undefined |
+| _gasLimit | uint256 | undefined |
+
+### withdrawERC20
+
+```solidity
+function withdrawERC20(address _token, address _to, uint256 _amount, uint256 _gasLimit) external payable
+```
+
+Withdraw of some token to a recipient's account on L1.
+
+*Make this function payable to send relayer fee in Ether.*
+
+#### Parameters
+
+| Name | Type | Description |
+|---|---|---|
+| _token | address | undefined |
+| _to | address | undefined |
+| _amount | uint256 | undefined |
+| _gasLimit | uint256 | undefined |
+
+### withdrawERC20AndCall
+
+```solidity
+function withdrawERC20AndCall(address _token, address _to, uint256 _amount, bytes _data, uint256 _gasLimit) external payable
+```
+
+Withdraw of some token to a recipient's account on L1 and call.
+
+*Make this function payable to send relayer fee in Ether.*
+
+#### Parameters
+
+| Name | Type | Description |
+|---|---|---|
+| _token | address | undefined |
+| _to | address | undefined |
+| _amount | uint256 | undefined |
+| _data | bytes | undefined |
+| _gasLimit | uint256 | undefined |
+
+
+
+## Events
+
+### FinalizeDepositERC20
+
+```solidity
+event FinalizeDepositERC20(address indexed l1Token, address indexed l2Token, address indexed from, address to, uint256 amount, bytes data)
+```
+
+Emitted when ERC20 token is deposited from L1 to L2 and transfer to recipient.
+
+
+
+#### Parameters
+
+| Name | Type | Description |
+|---|---|---|
+| l1Token `indexed` | address | The address of the token in L1. |
+| l2Token `indexed` | address | The address of the token in L2. |
+| from `indexed` | address | The address of sender in L1. |
+| to  | address | The address of recipient in L2. |
+| amount  | uint256 | The amount of token withdrawn from L1 to L2. |
+| data  | bytes | The optional calldata passed to recipient in L2. |
+
+### Initialized
+
+```solidity
+event Initialized(uint8 version)
+```
+
+
+
+*Triggered when the contract has been initialized or reinitialized.*
+
+#### Parameters
+
+| Name | Type | Description |
+|---|---|---|
+| version  | uint8 | undefined |
+
+### OwnershipTransferred
+
+```solidity
+event OwnershipTransferred(address indexed previousOwner, address indexed newOwner)
+```
+
+
+
+
+
+#### Parameters
+
+| Name | Type | Description |
+|---|---|---|
+| previousOwner `indexed` | address | undefined |
+| newOwner `indexed` | address | undefined |
+
+### WithdrawERC20
+
+```solidity
+event WithdrawERC20(address indexed l1Token, address indexed l2Token, address indexed from, address to, uint256 amount, bytes data)
+```
+
+Emitted when someone withdraw ERC20 token from L2 to L1.
+
+
+
+#### Parameters
+
+| Name | Type | Description |
+|---|---|---|
+| l1Token `indexed` | address | The address of the token in L1. |
+| l2Token `indexed` | address | The address of the token in L2. |
+| from `indexed` | address | The address of sender in L2. |
+| to  | address | The address of recipient in L1. |
+| amount  | uint256 | The amount of token will be deposited from L2 to L1. |
+| data  | bytes | The optional calldata passed to recipient in L1. |
+
+
+
+## Errors
+
+### ErrorCallerIsNotCounterpartGateway
+
+```solidity
+error ErrorCallerIsNotCounterpartGateway()
+```
+
+
+
+*Thrown when the cross chain sender is not the counterpart gateway contract.*
+
+
+### ErrorCallerIsNotMessenger
+
+```solidity
+error ErrorCallerIsNotMessenger()
+```
+
+
+
+*Thrown when the caller is not corresponding `L1ScrollMessenger` or `L2ScrollMessenger`.*
+
+
+### ErrorNotInDropMessageContext
+
+```solidity
+error ErrorNotInDropMessageContext()
+```
+
+
+
+*Thrown when ScrollMessenger is not dropping message.*
+
+
+### ErrorZeroAddress
+
+```solidity
+error ErrorZeroAddress()
+```
+
+
+
+*Thrown when the given address is `address(0)`.*
+
+
+

contracts/docs/apis/ScrollStandardERC20Factory.md

@@ -0,0 +1,159 @@
+# ScrollStandardERC20Factory
+
+
+
+> ScrollStandardERC20Factory
+
+The `ScrollStandardERC20Factory` is used to deploy `ScrollStandardERC20` for `L2StandardERC20Gateway`. It uses the `Clones` contract to deploy contract with minimum gas usage.
+
+*The implementation of deployed token is non-upgradable. This design may be changed in the future.*
+
+## Methods
+
+### computeL2TokenAddress
+
+```solidity
+function computeL2TokenAddress(address _gateway, address _l1Token) external view returns (address)
+```
+
+Compute the corresponding l2 token address given l1 token address.
+
+
+
+#### Parameters
+
+| Name | Type | Description |
+|---|---|---|
+| _gateway | address | The address of gateway contract. |
+| _l1Token | address | The address of l1 token. |
+
+#### Returns
+
+| Name | Type | Description |
+|---|---|---|
+| _0 | address | undefined |
+
+### deployL2Token
+
+```solidity
+function deployL2Token(address _gateway, address _l1Token) external nonpayable returns (address)
+```
+
+Deploy the corresponding l2 token address given l1 token address.
+
+*This function should only be called by owner to avoid DDoS attack on StandardTokenBridge.*
+
+#### Parameters
+
+| Name | Type | Description |
+|---|---|---|
+| _gateway | address | The address of gateway contract. |
+| _l1Token | address | The address of l1 token. |
+
+#### Returns
+
+| Name | Type | Description |
+|---|---|---|
+| _0 | address | undefined |
+
+### implementation
+
+```solidity
+function implementation() external view returns (address)
+```
+
+The address of `ScrollStandardERC20` implementation.
+
+
+
+
+#### Returns
+
+| Name | Type | Description |
+|---|---|---|
+| _0 | address | undefined |
+
+### owner
+
+```solidity
+function owner() external view returns (address)
+```
+
+
+
+*Returns the address of the current owner.*
+
+
+#### Returns
+
+| Name | Type | Description |
+|---|---|---|
+| _0 | address | undefined |
+
+### renounceOwnership
+
+```solidity
+function renounceOwnership() external nonpayable
+```
+
+
+
+*Leaves the contract without owner. It will not be possible to call `onlyOwner` functions. Can only be called by the current owner. NOTE: Renouncing ownership will leave the contract without an owner, thereby disabling any functionality that is only available to the owner.*
+
+
+### transferOwnership
+
+```solidity
+function transferOwnership(address newOwner) external nonpayable
+```
+
+
+
+*Transfers ownership of the contract to a new account (`newOwner`). Can only be called by the current owner.*
+
+#### Parameters
+
+| Name | Type | Description |
+|---|---|---|
+| newOwner | address | undefined |
+
+
+
+## Events
+
+### DeployToken
+
+```solidity
+event DeployToken(address indexed _l1Token, address indexed _l2Token)
+```
+
+Emitted when a l2 token is deployed.
+
+
+
+#### Parameters
+
+| Name | Type | Description |
+|---|---|---|
+| _l1Token `indexed` | address | The address of the l1 token. |
+| _l2Token `indexed` | address | The address of the l2 token. |
+
+### OwnershipTransferred
+
+```solidity
+event OwnershipTransferred(address indexed previousOwner, address indexed newOwner)
+```
+
+
+
+
+
+#### Parameters
+
+| Name | Type | Description |
+|---|---|---|
+| previousOwner `indexed` | address | undefined |
+| newOwner `indexed` | address | undefined |
+
+
+