Skip to content

Add a README.md section about using EELS with Monad#11

Merged
pdobacz merged 2 commits intoforks/monad_ninefrom
monad-readme
Feb 20, 2026
Merged

Add a README.md section about using EELS with Monad#11
pdobacz merged 2 commits intoforks/monad_ninefrom
monad-readme

Conversation

@pdobacz
Copy link
Collaborator

@pdobacz pdobacz commented Feb 18, 2026

Add a simple getting started to filling spec tests for Monad into the README.md. Requested by @DanielVF

It duplicates a bit of upstream documentation (which is also a bit scattered RN), but should provide a primer for anyone wanting to clone the repo and fill themselves.

@pdobacz pdobacz requested review from QEDK and mijovic February 18, 2026 17:13
@greptile-apps
Copy link

greptile-apps bot commented Feb 18, 2026

Greptile Summary

This PR adds a Monad-specific "Getting Started" section at the top of the README.md, providing documentation for developers wanting to use this execution-specs fork with Monad. It covers:

  • Installation steps using uv and Python 3.12
  • How to fill (generate) spec test fixtures for Monad hardforks
  • Explanation of key uv run fill CLI flags (-m, --from, --until, --chain-id, -n auto)
  • Notes on test organization and gotchas around Ethereum-only features, upstream sync, and new fork creation

Issues found:

  • Typo: "invokation" should be "invocation" (line 53)
  • References monad_nine test directory which does not yet exist in the repo

Confidence Score: 4/5

  • This PR is safe to merge — it only adds documentation to the README with no code changes.
  • Documentation-only change with minor issues (typo and a reference to a not-yet-existing directory). No code logic is affected. All referenced file paths, fork identifiers, and CLI flags were verified against the codebase.
  • No files require special attention — only README.md was changed with documentation additions.

Important Files Changed

Filename Overview
README.md Adds a Monad-specific getting started section covering installation, test filling, CLI flags, and gotchas. Contains a typo ("invokation") and references a monad_nine test directory that doesn't exist yet.

Flowchart

%%{init: {'theme': 'neutral'}}%%
flowchart TD
    A[Clone repo & install uv] --> B[uv python install 3.12 & uv sync]
    B --> C[uv run fill with flags]
    C --> D{Test Discovery}
    D --> E[tests/monad_eight/]
    D --> F[tests/prague/eip7702_set_code_tx/]
    D --> G[Other upstream test dirs]
    E --> H[Python EELS fills tests]
    F --> H
    G --> H
    H --> I[JSON fixtures in fixtures/]
    I --> J[Consumed by monad client]
Loading

Last reviewed commit: 03afa4c

Copy link

@greptile-apps greptile-apps bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

1 file reviewed, 2 comments

Edit Code Review Agent Settings | Greptile

Co-authored-by: greptile-apps[bot] <165735046+greptile-apps[bot]@users.noreply.github.com>
@pdobacz pdobacz merged commit dbc48e9 into forks/monad_nine Feb 20, 2026
3 checks passed
@pdobacz pdobacz deleted the monad-readme branch February 20, 2026 09:29
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants