Skip to content

docs: Expand EVM Object Format (EOF) article - #498

Merged
taxmeifyoucan merged 2 commits into
eth-protocol-fellows:mainfrom
ParthSinghPS:docs/expand-eof-article
Apr 10, 2026
Merged

docs: Expand EVM Object Format (EOF) article#498
taxmeifyoucan merged 2 commits into
eth-protocol-fellows:mainfrom
ParthSinghPS:docs/expand-eof-article

Conversation

@ParthSinghPS

@ParthSinghPS ParthSinghPS commented Apr 2, 2026

Copy link
Copy Markdown
Contributor

Summary

This PR significantly expands the existing EVM Object Format (EOF) stub article.

Changes from the Current Page

The current page is a stub with minimal content. Here's what has been added or improved:

  • Introduction: Added a detailed explanation of the EOF container structure,
    including the 0xEF00 magic bytes, versioning, and section layout, with a
    code block illustrating the bytecode layout.

  • Purpose and Benefits: Expanded from 4 brief bullet points to 6 detailed
    bullets covering Validation, Execution Efficiency, Security, Stack Reliability,
    Future-Proofing, and Code/Data Separation.

  • Related EIPs: The current page only lists 2 EIPs (EIP-3540 and EIP-7620)
    with minimal descriptions. This PR expands this section to cover all EIPs
    tracked under EIP-7692, organized into four categories:

    • Core Container & Validation (EIP-3540, EIP-3670, EIP-5450)
    • Control Flow and Subroutines (EIP-4200, EIP-4750, EIP-6206)
    • Modernized Instructions (EIP-7480, EIP-663, EIP-7069, EIP-5920, EIP-7761, EIP-7880)
    • Contract Creation & Metadata (EIP-7620, EIP-7873, EIP-7834)
    • All EIP references are hyperlinked to their canonical eips.ethereum.org pages.

  • Differences Table: Expanded from 5 rows to 7 rows, adding Stack Validation
    and Introspection rows.

  • Implementation Status & Roadmap: New section added covering EOF Devnets and historical context from the Sept 2022
    Prague core dev call.

  • Resources: Replaced the previous resource list with more relevant and
    up-to-date links:

    • Ethereum Magicians discussion thread (original EOF proposal)
    • Ethereum Notes on EOF specification
    • DeepWiki structured EOF breakdown
    • EVM | Pawel Bylica | Lecture 17 (retained from original)

Notes

Happy to adjust the wording, structure, or any details if they don't match
the wiki's style guidelines. PLease let me know if anything needs to be changed!

@github-actions

github-actions Bot commented Apr 2, 2026

Copy link
Copy Markdown

Hi @ParthSinghPS,

⚠️ Potential typos found in your pull request:

  • 📄 ./docs/eps/intro.md (line(s) 32,33,34,35,36):
    1. ❌ Matan
  • 📄 ./docs/eps/intro.md (line(s) 32,33,34,35,36):
    1. ❌ Prasma
  • 📄 ./docs/eps/intro.md (line(s) 32,33,34,35,36):
    1. ❌ Matan
  • 📄 ./docs/eps/intro.md (line(s) 32,33,34,35,36):
    1. ❌ Prasma
  • 📄 ./docs/eps/intro.md (line(s) 32,33,34,35,36):
    1. ❌ Matan
  • 📄 ./docs/eps/intro.md (line(s) 32,33,34,35,36):
    1. ❌ Prasma
  • 📄 ./docs/eps/intro.md (line(s) 32,33,34,35,36):
    1. ❌ Matan
  • 📄 ./docs/eps/intro.md (line(s) 32,33,34,35,36):
    1. ❌ Prasma
  • 📄 ./docs/eps/intro.md (line(s) 32,33,34,35,36):
    1. ❌ Matan
  • 📄 ./docs/eps/intro.md (line(s) 32,33,34,35,36):
    1. ❌ Prasma
  • 📄 ./docs/eps/intro.md (line(s) 44):
    1. ❌ Kolby
  • 📄 ./docs/eps/intro.md (line(s) 45):
    1. ❌ Gunton
  • 📄 ./docs/eps/intro.md (line(s) 45):
    1. ❌ Hagiopan
  • 📄 ./docs/wiki/Cryptography/post-quantum-cryptography.md (line(s) 60,66,76,84,106,108):
    1. ❌ FIPS
  • 📄 ./docs/wiki/Cryptography/post-quantum-cryptography.md (line(s) 60,66,76,84,106,108):
    1. ❌ FIPS
  • 📄 ./docs/wiki/Cryptography/post-quantum-cryptography.md (line(s) 66):
    1. ❌ Encaps
  • 📄 ./docs/wiki/Cryptography/post-quantum-cryptography.md (line(s) 66):
    1. ❌ Decaps
  • 📄 ./docs/wiki/Cryptography/post-quantum-cryptography.md (line(s) 66):
    1. ❌ MLWE
  • 📄 ./docs/wiki/Cryptography/post-quantum-cryptography.md (line(s) 60,66,76,84,106,108):
    1. ❌ FIPS
  • 📄 ./docs/wiki/Cryptography/post-quantum-cryptography.md (line(s) 84,91,99,100,101,102,103,104):
    1. ❌ SLH
  • 📄 ./docs/wiki/Cryptography/post-quantum-cryptography.md (line(s) 60,66,76,84,106,108):
    1. ❌ FIPS
  • 📄 ./docs/wiki/Cryptography/post-quantum-cryptography.md (line(s) 87,88):
    1. ❌ WOTS
  • 📄 ./docs/wiki/Cryptography/post-quantum-cryptography.md (line(s) 87):
    1. ❌ Winternitz
  • 📄 ./docs/wiki/Cryptography/post-quantum-cryptography.md (line(s) 87,88):
    1. ❌ WOTS
  • 📄 ./docs/wiki/Cryptography/post-quantum-cryptography.md (line(s) 89):
    1. ❌ FORS
  • 📄 ./docs/wiki/Cryptography/post-quantum-cryptography.md (line(s) 84,91,99,100,101,102,103,104):
    1. ❌ SLH
  • 📄 ./docs/wiki/Cryptography/post-quantum-cryptography.md (line(s) 84,91,99,100,101,102,103,104):
    1. ❌ SLH
  • 📄 ./docs/wiki/Cryptography/post-quantum-cryptography.md (line(s) 84,91,99,100,101,102,103,104):
    1. ❌ SLH
  • 📄 ./docs/wiki/Cryptography/post-quantum-cryptography.md (line(s) 84,91,99,100,101,102,103,104):
    1. ❌ SLH
  • 📄 ./docs/wiki/Cryptography/post-quantum-cryptography.md (line(s) 84,91,99,100,101,102,103,104):
    1. ❌ SLH
  • 📄 ./docs/wiki/Cryptography/post-quantum-cryptography.md (line(s) 84,91,99,100,101,102,103,104):
    1. ❌ SLH
  • 📄 ./docs/wiki/Cryptography/post-quantum-cryptography.md (line(s) 84,91,99,100,101,102,103,104):
    1. ❌ SLH
  • 📄 ./docs/wiki/Cryptography/post-quantum-cryptography.md (line(s) 84,91,99,100,101,102,103,104):
    1. ❌ SLH
  • 📄 ./docs/wiki/Cryptography/post-quantum-cryptography.md (line(s) 84,91,99,100,101,102,103,104):
    1. ❌ SLH
  • 📄 ./docs/wiki/Cryptography/post-quantum-cryptography.md (line(s) 84,91,99,100,101,102,103,104):
    1. ❌ SLH
  • 📄 ./docs/wiki/Cryptography/post-quantum-cryptography.md (line(s) 84,91,99,100,101,102,103,104):
    1. ❌ SLH
  • 📄 ./docs/wiki/Cryptography/post-quantum-cryptography.md (line(s) 84,91,99,100,101,102,103,104):
    1. ❌ SLH
  • 📄 ./docs/wiki/Cryptography/post-quantum-cryptography.md (line(s) 84,91,99,100,101,102,103,104):
    1. ❌ SLH
  • 📄 ./docs/wiki/Cryptography/post-quantum-cryptography.md (line(s) 60,66,76,84,106,108):
    1. ❌ FIPS
  • 📄 ./docs/wiki/Cryptography/post-quantum-cryptography.md (line(s) 108):
    1. ❌ FN
  • 📄 ./docs/wiki/Cryptography/post-quantum-cryptography.md (line(s) 60,66,76,84,106,108):
    1. ❌ FIPS
  • 📄 ./docs/wiki/Cryptography/post-quantum-cryptography.md (line(s) 108):
    1. ❌ NTRU
  • 📄 ./docs/wiki/Cryptography/post-quantum-cryptography.md (line(s) 108):
    1. ❌ FFT
  • 📄 ./docs/wiki/Cryptography/post-quantum-cryptography.md (line(s) 108):
    1. ❌ LDL
  • 📄 ./docs/wiki/Cryptography/post-quantum-cryptography.md (line(s) 108):
    1. ❌ FN
  • 📄 ./docs/wiki/EL/eof.md (line(s) 50):
    1. ❌ intra
  • 📄 ./docs/wiki/EL/eof.md (line(s) 70):
    1. ❌ InitcodeTransaction
  • 📄 ./docs/wiki/EL/eof.md (line(s) 72):
    1. ❌ CBOR
  • 📄 ./docs/wiki/EL/eof.md (line(s) 96):
    1. ❌ EOF's

ℹ️ How to fix this error:

  1. If these are actual typos:

    • Open the files at the specified line numbers and fix them

  2. If these are names or one-off nouns:

    • Wrap them in <name> tags
    • Example: <name>Alex Pereira</name>
    • Use this for people's names or unique terms that appear rarely

  3. If these are valid terms:

    • Add them to wordlist.txt (one word per line)
    • Terms must be plain text without spaces/special chars
    • The list is case-insensitive

  4. If these are code terms:

    • Wrap them in backticks (`) in your markdown

ℹ️ Checking for typos locally

  1. Install aspell for your platform
  2. Navigate to project root and run:
for f in **/*.md ; do echo $f ; aspell --lang=en_US --mode=markdown --home-dir=. --personal=wordlist.txt --ignore-case=true --camel-case --add-sgml-skip nospellcheck list < $f | sort | uniq -c ; done

Learn more about wordlist format

taxmeifyoucan
taxmeifyoucan reviewed Apr 3, 2026
View reviewed changes

@taxmeifyoucan taxmeifyoucan left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Thanks for updating this page! It's necessary because the content was old but the EOF has been rejected, so the documentation is still outdated. I would add a clear highlight that the EOF has been stale and this is more of an archive topic

Comment thread docs/wiki/EL/eof.md Outdated
Comment thread docs/wiki/EL/eof.md Outdated
Comment thread docs/wiki/EL/eof.md Outdated
Comment thread docs/wiki/EL/eof.md Outdated
Comment thread docs/wiki/EL/eof.md Outdated
@github-actions

github-actions Bot commented Apr 3, 2026

Copy link
Copy Markdown

Hi @ParthSinghPS,

⚠️ Potential typos found in your pull request:

  • 📄 ./docs/eps/intro.md (line(s) 32,33,34,35,36):
    1. ❌ Matan
  • 📄 ./docs/eps/intro.md (line(s) 32,33,34,35,36):
    1. ❌ Prasma
  • 📄 ./docs/eps/intro.md (line(s) 32,33,34,35,36):
    1. ❌ Matan
  • 📄 ./docs/eps/intro.md (line(s) 32,33,34,35,36):
    1. ❌ Prasma
  • 📄 ./docs/eps/intro.md (line(s) 32,33,34,35,36):
    1. ❌ Matan
  • 📄 ./docs/eps/intro.md (line(s) 32,33,34,35,36):
    1. ❌ Prasma
  • 📄 ./docs/eps/intro.md (line(s) 32,33,34,35,36):
    1. ❌ Matan
  • 📄 ./docs/eps/intro.md (line(s) 32,33,34,35,36):
    1. ❌ Prasma
  • 📄 ./docs/eps/intro.md (line(s) 32,33,34,35,36):
    1. ❌ Matan
  • 📄 ./docs/eps/intro.md (line(s) 32,33,34,35,36):
    1. ❌ Prasma
  • 📄 ./docs/eps/intro.md (line(s) 44):
    1. ❌ Kolby
  • 📄 ./docs/eps/intro.md (line(s) 45):
    1. ❌ Gunton
  • 📄 ./docs/eps/intro.md (line(s) 45):
    1. ❌ Hagiopan
  • 📄 ./docs/wiki/Cryptography/post-quantum-cryptography.md (line(s) 60,66,76,84,106,108):
    1. ❌ FIPS
  • 📄 ./docs/wiki/Cryptography/post-quantum-cryptography.md (line(s) 60,66,76,84,106,108):
    1. ❌ FIPS
  • 📄 ./docs/wiki/Cryptography/post-quantum-cryptography.md (line(s) 66):
    1. ❌ Encaps
  • 📄 ./docs/wiki/Cryptography/post-quantum-cryptography.md (line(s) 66):
    1. ❌ Decaps
  • 📄 ./docs/wiki/Cryptography/post-quantum-cryptography.md (line(s) 66):
    1. ❌ MLWE
  • 📄 ./docs/wiki/Cryptography/post-quantum-cryptography.md (line(s) 60,66,76,84,106,108):
    1. ❌ FIPS
  • 📄 ./docs/wiki/Cryptography/post-quantum-cryptography.md (line(s) 84,91,99,100,101,102,103,104):
    1. ❌ SLH
  • 📄 ./docs/wiki/Cryptography/post-quantum-cryptography.md (line(s) 60,66,76,84,106,108):
    1. ❌ FIPS
  • 📄 ./docs/wiki/Cryptography/post-quantum-cryptography.md (line(s) 87,88):
    1. ❌ WOTS
  • 📄 ./docs/wiki/Cryptography/post-quantum-cryptography.md (line(s) 87):
    1. ❌ Winternitz
  • 📄 ./docs/wiki/Cryptography/post-quantum-cryptography.md (line(s) 87,88):
    1. ❌ WOTS
  • 📄 ./docs/wiki/Cryptography/post-quantum-cryptography.md (line(s) 89):
    1. ❌ FORS
  • 📄 ./docs/wiki/Cryptography/post-quantum-cryptography.md (line(s) 84,91,99,100,101,102,103,104):
    1. ❌ SLH
  • 📄 ./docs/wiki/Cryptography/post-quantum-cryptography.md (line(s) 84,91,99,100,101,102,103,104):
    1. ❌ SLH
  • 📄 ./docs/wiki/Cryptography/post-quantum-cryptography.md (line(s) 84,91,99,100,101,102,103,104):
    1. ❌ SLH
  • 📄 ./docs/wiki/Cryptography/post-quantum-cryptography.md (line(s) 84,91,99,100,101,102,103,104):
    1. ❌ SLH
  • 📄 ./docs/wiki/Cryptography/post-quantum-cryptography.md (line(s) 84,91,99,100,101,102,103,104):
    1. ❌ SLH
  • 📄 ./docs/wiki/Cryptography/post-quantum-cryptography.md (line(s) 84,91,99,100,101,102,103,104):
    1. ❌ SLH
  • 📄 ./docs/wiki/Cryptography/post-quantum-cryptography.md (line(s) 84,91,99,100,101,102,103,104):
    1. ❌ SLH
  • 📄 ./docs/wiki/Cryptography/post-quantum-cryptography.md (line(s) 84,91,99,100,101,102,103,104):
    1. ❌ SLH
  • 📄 ./docs/wiki/Cryptography/post-quantum-cryptography.md (line(s) 84,91,99,100,101,102,103,104):
    1. ❌ SLH
  • 📄 ./docs/wiki/Cryptography/post-quantum-cryptography.md (line(s) 84,91,99,100,101,102,103,104):
    1. ❌ SLH
  • 📄 ./docs/wiki/Cryptography/post-quantum-cryptography.md (line(s) 84,91,99,100,101,102,103,104):
    1. ❌ SLH
  • 📄 ./docs/wiki/Cryptography/post-quantum-cryptography.md (line(s) 84,91,99,100,101,102,103,104):
    1. ❌ SLH
  • 📄 ./docs/wiki/Cryptography/post-quantum-cryptography.md (line(s) 84,91,99,100,101,102,103,104):
    1. ❌ SLH
  • 📄 ./docs/wiki/Cryptography/post-quantum-cryptography.md (line(s) 60,66,76,84,106,108):
    1. ❌ FIPS
  • 📄 ./docs/wiki/Cryptography/post-quantum-cryptography.md (line(s) 108):
    1. ❌ FN
  • 📄 ./docs/wiki/Cryptography/post-quantum-cryptography.md (line(s) 60,66,76,84,106,108):
    1. ❌ FIPS
  • 📄 ./docs/wiki/Cryptography/post-quantum-cryptography.md (line(s) 108):
    1. ❌ NTRU
  • 📄 ./docs/wiki/Cryptography/post-quantum-cryptography.md (line(s) 108):
    1. ❌ FFT
  • 📄 ./docs/wiki/Cryptography/post-quantum-cryptography.md (line(s) 108):
    1. ❌ LDL
  • 📄 ./docs/wiki/Cryptography/post-quantum-cryptography.md (line(s) 108):
    1. ❌ FN
  • 📄 ./docs/wiki/EL/eof.md (line(s) 46):
    1. ❌ intra
  • 📄 ./docs/wiki/EL/eof.md (line(s) 66):
    1. ❌ InitcodeTransaction
  • 📄 ./docs/wiki/EL/eof.md (line(s) 68):
    1. ❌ CBOR
  • 📄 ./docs/wiki/EL/eof.md (line(s) 92):
    1. ❌ Caversaccio
  • 📄 ./docs/wiki/EL/eof.md (line(s) 97):
    1. ❌ EOF's

ℹ️ How to fix this error:

  1. If these are actual typos:

    • Open the files at the specified line numbers and fix them

  2. If these are names or one-off nouns:

    • Wrap them in <name> tags
    • Example: <name>Alex Pereira</name>
    • Use this for people's names or unique terms that appear rarely

  3. If these are valid terms:

    • Add them to wordlist.txt (one word per line)
    • Terms must be plain text without spaces/special chars
    • The list is case-insensitive

  4. If these are code terms:

    • Wrap them in backticks (`) in your markdown

ℹ️ Checking for typos locally

  1. Install aspell for your platform
  2. Navigate to project root and run:
for f in **/*.md ; do echo $f ; aspell --lang=en_US --mode=markdown --home-dir=. --personal=wordlist.txt --ignore-case=true --camel-case --add-sgml-skip nospellcheck list < $f | sort | uniq -c ; done

Learn more about wordlist format

@ParthSinghPS

ParthSinghPS commented Apr 3, 2026

Copy link
Copy Markdown
Contributor Author

I have made the required changes and pushed the updated info
Please look into that and tell me if it needs any further changes

taxmeifyoucan
taxmeifyoucan approved these changes Apr 9, 2026
View reviewed changes

@taxmeifyoucan taxmeifyoucan left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Thank you!

@taxmeifyoucan
taxmeifyoucan merged commit a298839 into eth-protocol-fellows:main Apr 10, 2026
1 of 2 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@taxmeifyoucan taxmeifyoucan taxmeifyoucan approved these changes

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@ParthSinghPS @taxmeifyoucan