Skip to content

AGENTS.md

Latest commit

 

History

History
61 lines (47 loc) · 2.42 KB

AGENTS.md

File metadata and controls

61 lines (47 loc) · 2.42 KB

AGENTS.md — Pluto (Rust) Porting & Review Guide

Scope

Pluto is an alternative implementation of Charon, a distributed validator middleware client for Ethereum Staking. It enables a group of independent operators to safely run a single validator by coordinating duties across multiple nodes.

Pluto, like Charon, is used by stakers to distribute the responsibility of running Ethereum Validators across a number of different instances and client implementations.

Project Structure

Workspace layout (high level):

pluto/
  Cargo.toml               # Workspace members, shared deps, lints
  crates/                  # Workspace crates (Rust source lives here)
    app/                   # Application crate
    build-proto/           # Protobuf/build-time code generation
    cli/                   # `pluto` CLI binary and command wiring
    cluster/               # Cluster types and helpers
    core/                  # Core domain logic
    crypto/                # Cryptographic primitives and helpers
    dkg/                   # Distributed key generation logic
    eth2api/               # Beacon-node API client types/helpers
    eth2util/              # Ethereum consensus utility code
    k1util/                # Secp256k1 utilities
    p2p/                   # P2P networking (libp2p)
    peerinfo/              # Peer info utilities
    relay-server/          # Relay server implementation
    testutil/              # Test helpers/fixtures (workspace-internal)
    tracing/               # Observability/tracing utilities
  test-infra/              # Docker-compose and local infra for integration testing/observability
  deny.toml                # `cargo deny` policy
  rust-toolchain.toml      # Rust toolchain pin
  rustfmt.toml             # Formatting rules
  clippy.toml              # Clippy configuration

Golden Rules

  • NEVER IMPLEMENT WITHOUT AN APPROVED PLAN

  • ALWAYS READ THE GO SOURCE — NEVER GUESS BEHAVIOR

  • ASK QUESTION IF UNDERSPECIFY

  • Default to functional equivalence with the Go implementation.

Tooling / Quality Gates

Environment:

  • Recommended dev setup: nix develop (see pluto/CONTRIBUTING.md).
  • Rust toolchain is pinned in pluto/rust-toolchain.toml.

Commands (run from pluto/):

cargo +nightly fmt --all --check
cargo clippy --workspace --all-targets --all-features -- -D warnings
cargo test --workspace --all-features
cargo deny check