Skip to content

Latest commit

 

History

History
59 lines (36 loc) · 1.64 KB

README.md

File metadata and controls

59 lines (36 loc) · 1.64 KB
Raw

Coordinator

This directory contains the Scroll Coordinator module.

Prerequisites

See monorepo prerequisites.

Build

make clean
make coordinator_api
make coordinator_cron

The built coordinator binary is in the build/bin directory.

Test

Note: Our test code may not directly support Apple Silicon (M1/M2) chips. However, we've provided a Docker-based solution for local testing on M1/M2 Macs. Please refer to the Local Testing on M1/M2 Mac section in the main README for details. After preparing the environment, you can then proceed with the testing.

When developing the coordinator, use the following command to mock verifier results and run coordinator tests:

go test -tags="mock_verifier" -v -race -covermode=atomic scroll-tech/coordinator/...

Instead of using verifier/verifier.go, it will use verifier/mock.go to always return true.

Lint the files before testing or committing:

make lint

Configure

The coordinator behavior can be configured using conf/config.json. Check the code comments under ProverManager in internal/config/config.go for more details.

Start

  • Using default ports and config.json:
./build/bin/coordinator_api --http
./build/bin/coordinator_cron
  • Using manually specified ports and config.json:
./build/bin/coordinator_api --config ./config.json --http --http.addr localhost --http.port 8390
./build/bin/coordinator_cron --config ./config.json