Hacktoberfest 2026: le issue che i maintainer hanno segnato per ottobre, aperte e adatte ai principianti. Sfoglia le issue Hacktoberfest

Consolidate the three parallel SSZ stacks

Aperta
  • Qualcosa non va?
#615 0 commenti 0 reazioni 0 assegnatari Vedi su GitHub

I maintainer di solito rispondono entro 4 giorni

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
5/5
Tempo stimato
Più di una settimana
Idoneità per principianti
20/100
Tipo di issue
Refactoring
Chiarezza
Abbastanza chiara
Stato di attività
Tranquilla
Stack tecnologico
rust
Ambito
blockchain, distributed-systems, testing

Direzione di ricerca

Inizia da crates/ssz/src/hasher.rs e dai test esistenti di hasher, quindi esegui il corpus di golden file di verify_hashes per stabilire il comportamento attuale di Charon/fastssz. Esamina crates/ssz/types.rs e crates/core/src/ssz_codec.rs insieme agli helper e ai codec non testati elencati. Il lavoro è completato quando gli stack condividono interfacce e tipi dove compatibili, la copertura include i confini indicati e i codec specifici di Charon rimangono eccezioni documentate.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Descrizione

enhancement rust

Summary

SSZ spans ~9,100 LOC across 22 files in three stacks that don't share types, hashing, or error handling:

  1. ethereum_ssz + tree_hash derives for consensus-spec containers (crates/eth2api/src/spec/, 3,498 LOC). Every container repeats a 5-derive line plus per-field #[serde_as] attributes — 93 derive lines, 155 Hex0x occurrences. ssz_types is not a dependency, so crates/ssz/types.rs reimplements SszList/SszVector/BitList/BitVector with 12 manual Encode/Decode/TreeHash impls (844 LOC).
  2. A hand-ported fastssz Hasher (crates/ssz/src/hasher.rs, 640 LOC) driving cluster/src/ssz.rs — 29 versioned free functions selected via function-pointer tables, plus an SSZError<H> that duplicates pluto_ssz::Error — and a second locally-declared SszHashable trait in app/src/obolapi/exit.rs#L30-L39.
  3. Hand-written byte-level codecs for Charon wire formats (core/src/ssz_codec.rs, 1,261 LOC), including deliberate deviations from what a derive would emit (documented in unsigneddata.rs: Charon emits an offset table even for fixed-size containers).

Consequences: two incompatible hash-tree-root paths, invisible semantic differences between types (some deliberately omit TreeHash and nothing flags it), and duplicated list/vector plumbing that upstream ssz_types already provides.

Proposed change

  • Before touching any stack: pin the current hasher against Charon/fastssz with golden-vector tests (known input → known 32-byte root, expected values captured from the Go side). The existing hasher.rs tests are self-consistency checks (manual-tree comparisons, bitlist guards) — nothing cross-implementation. Add binary round-trip tests for the zero-test codec helpers (encode.rs, decode.rs) at the same time; they are part of the surface being consolidated. Same for the crate's other untested seams: helpers.rs put_byte_list/put_bytes_n IncorrectListSize, serde_utils.rs ssz_list_u64_string_serde (string/int parse, MAX rejection, round-trip), the binary Encode/Decode bound checks of SszList/SszVector (only the JSON path is tested today), and the hasher's CountGreaterThanLimit and get_depth/next_power_of_two/calculate_limit boundaries.
  • Adopt ssz_types for List/Vector/Bitfield and delete most of crates/ssz/types.rs.
  • Merge the two hasher-side interfaces (SszHashable in obolapi vs the free-function tables in cluster) into one, e.g. a version-aware trait in pluto_ssz; collapse the duplicated error enum.
  • Keep the Charon wire-format codecs (ssz_codec.rs) as explicit, documented exceptions — they encode incompatibilities that derives cannot express.

Open question

The cluster config/definition/lock hashes must byte-match Charon's fastssz output. Before replacing the custom Hasher with tree_hash, prove equivalence on the existing fixture corpus (the verify_hashes golden files) — if fastssz semantics differ (they do for e.g. bitlist mixins and string hashing), the custom hasher stays and only the interface around it is consolidated.

Lingua principale
Rust
Stelle
8
Fork
6
Merge medio
4g 20h
PR unite (30g)
21

Preparare l'ambiente

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Altre issue di NethermindEth/pluto

Tutte le issue di NethermindEth/pluto

Issue simili

Altre issue su Rust

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.