Skip to content

SETUP.md

Latest commit

 

History

History
126 lines (81 loc) · 4.17 KB

SETUP.md

File metadata and controls

126 lines (81 loc) · 4.17 KB
Raw

Linea Arithmetization (zkEVM)

A Linea tracing implementation for Besu based on an existing implementation in Go.

Development Setup

Install Java 25

brew install openjdk@25

Install the Go toolchain

Install Go-Corset

go install github.com/consensys/go-corset/cmd/go-corset@latest

Install pre-commit

pip install --user pre-commit

# For macOS users.
brew install pre-commit

Then run pre-commit install to set up git hook scripts. Used hooks can be found here.

NOTE

pre-commit aids in running checks (end of file fixing, markdown linting, linting, runs tests, json validation, etc.) before you perform your git commits.

Run tests

# Run unit tests
./gradlew tracer:arithmetization:test

# Run replay tests
./gradlew tracer:arithmetization:fastReplayTests

# Run EVM test suite BlockchainTests
./gradlew tracer:reference-tests:referenceBlockchainTests

# Run single reference test via gradle, e.g for net.consensys.linea.generated.blockchain.BlockchainReferenceTest_339
./gradlew tracer:reference-tests:referenceBlockchainTests --tests "net.consensys.linea.generated.blockchain.BlockchainReferenceTest_339"

IntelliJ IDEA Setup

Enable Annotation Processing

  • Go to Settings | Build, Execution, Deployment | Compiler | Annotation Processors and tick the following checkbox:

    idea_enable_annotation_processing_setting.png

NOTE

This setting is required to avoid IDE compilation errors because of the Lombok library used for code generation of boilerplate Java code such as:

Learn more about how Java annotation processing works here.

Set Up IDE Code Re-formatting

  • Install Checkstyle plugin and set IDE code reformatting to comply with the project's Checkstyle configuration:

    • Go to Settings | Editor | Code Style | Java | <hamburger menu> | Import Scheme | Checkstyle configuration:

      idea_checkstyle_reformat.png

      and select <project_root>/config/checkstyle.xml.

Install Optional Plugins

  • Install Spotless Gradle plugin to re-format through the IDE according to spotless configuration.

Debugging Traces

  • JSON files can be debugged with the following command:
go-corset check --report <LT/JSON FILE> tracer/linea-constraints/zkevm_osaka.bin

See here for more options when running go-corset directly.

Plugins

Plugins are documented here.

Release Process

Here are the steps for releasing a new version of the plugins:

  1. Update tracer/build.gradle property targetReleaseVersionwith the release version number's expected tag in the format vX.Y.Z (e.g., v0.2.0 creates a release version 0.2.0).
  2. Launch Linea tracer release Github action with the chosen tag
  3. Once the release workflow completes, check and update the release notes.

Note: Release tags (of the form v*) are protected and can only be pushed by organization and/or repository owners.