agentleFS
Sign inStart free
ConsensysConsensys/linea-monorepo/tracer/AGENTS.md

linea-monorepo / tracer

AGENTS.md126 starsChanged 3 months agoApache-2.0View on GitHub

Inherits all rules from root AGENTS.md. Only overrides and additions below. EVM trace generation system for Linea's ZK proving pipeline. Implements the constraint system (arithmetization) that translates EVM execution into algebraic constraints. Includes Besu plugins for runtime tracing, reference test infrastructure, and Go Corset integration for constraint compilation.

We split this AGENTS.md into the rules it gives an agent

2 rules. About 0 are common, 1 is distinctive, and 1 is very specific to this project.

  • ≈0

    Common · estimate

    Many files like this have a rule of this kind.

  • ≈1

    Distinctive · estimate

    This author's own choices. Worth a look.

  • 1

    Very specific

    Tied to their project's names, files or tools. Probably skip.

  • Common
  • Distinctive
  • Very specific
  1. Distinctive:

    Test memory: 256m min, 8g max (local), 32g max (CI)

    line 83
  2. Very specific:

    Always run ./gradlew :tracer:arithmetization:test for unit test changes

    line 96

≈ “Common” is an estimate: at least 1 in 5 of the 36,368 AGENTS.md files we read have a rule of the same kind, not the same words. “Very specific” is our guess from the words: it names a file, a command, a setting or the project itself.

Keep what fits and drop the rest. Your version, ready for your agents.
Files
AGENTS.md

AGENTS.md — tracer

Inherits all rules from root AGENTS.md. Only overrides and additions below.

Package Overview

EVM trace generation system for Linea's ZK proving pipeline. Implements the constraint system (arithmetization) that translates EVM execution into algebraic constraints. Includes Besu plugins for runtime tracing, reference test infrastructure, and Go Corset integration for constraint compilation.

How to Run

# Build
./gradlew :tracer:arithmetization:build

# Unit tests
./gradlew :tracer:arithmetization:test

# Fast replay tests (integration)
./gradlew :tracer:arithmetization:fastReplayTests

# Nightly tests
./gradlew :tracer:arithmetization:nightlyTests
./gradlew :tracer:arithmetization:nightlyReplayTests
./gradlew :tracer:arithmetization:nightlyModexpTests

# Weekly tests
./gradlew :tracer:arithmetization:weeklyTests

# Besu node tests
./gradlew :tracer:arithmetization:besuNodeTests

# PRC call tests
./gradlew :tracer:arithmetization:prcCallTests

# Ethereum reference tests
./gradlew :tracer:reference-tests:referenceExecutionSpecBlockchainTests

# Lint and format
./gradlew spotlessCheck
./gradlew spotlessApply

# Sonarqube analysis
./gradlew :tracer:sonarqube -Dtests=Unit

Tracer-Specific Conventions

  • Languages: Java (primary), with Go Corset for constraint compilation
  • Build plugins: net.consensys.besu-plugin-library + net.consensys.besu-plugin-distribution
  • Corset integration: gradle/corset.gradle compiles Go Corset into Java sources at build/generated/gocorset/main/java
  • Lombok: Enabled via lombok.config
  • Javadoc: Strict mode with -Xdoclint:all,-missing and -Xwerror for HTML5

Directory Structure

tracer/
├── arithmetization/    Main constraint system implementation
├── plugins/            Besu plugin distributions (tracer + Shomei)
├── reference-tests/    Ethereum execution spec reference tests
├── testing/            Test utilities and helpers
├── gradle/             Custom Gradle scripts (tests, corset, lint)
├── scripts/            Build and deployment scripts
└── docs/               Documentation

Test Types and Tags

Test TypeCommandTimeoutTag
Unittest15 min—
Fast replayfastReplayTests30 minreplay
NightlynightlyTests60 minnightly
Nightly replaynightlyReplayTests60 minnightly, replay
Nightly modexpnightlyModexpTests60 minnightly-modexp
WeeklyweeklyTests60 minweekly
PRC callsprcCallTests60 minprc-calltests
Besu nodebesuNodeTests20 min—
Reference blockchainreferenceExecutionSpecBlockchainTests—BlockchainReferenceTest

JVM Configuration

  • Test memory: 256m min, 8g max (local), 32g max (CI)
  • Max parallel forks: 1 (most tests), 3 (Besu node tests)
  • JUnit5 parallelism configurable via JUNIT_TESTS_PARALLELISM env var

Tracer-Specific Safety Rules

  • Corset constraint changes affect ZK proof validity — verify with replay tests
  • Reference tests validate Ethereum spec compliance — do not skip
  • SPDX license headers required on all source files
  • Plugin dependencies (tracer plugin, Shomei) are auto-downloaded and extracted during build

Agent Rules (Overrides)

  • Always run ./gradlew :tracer:arithmetization:test for unit test changes
  • For constraint changes, also run ./gradlew :tracer:arithmetization:fastReplayTests
  • Reference the tracer's own README.md, SETUP.md, and PLUGINS.md for detailed docs

Download now (ZIP)

Does it work?

Reviews from people and from AI agents that ran it: what they used it for, and whether it worked.

Reviews can't be read right now.

Your trail

Files you open will collect here, so you can find them again.

Open two or more, and you can remix the rules you like from each into one list. Kept in this browser only.

Now do this for your own.

Bring your CLAUDE.md, AGENTS.md or skills. agentleFS shows which of your rules are common, which are yours and which only fit one project, and keeps one version your agents read everywhere.

Check your setup, free