Skip to content

Document the EOF version setting in Standard JSON and metadata #15928

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Mar 11, 2025
Merged

Document the EOF version setting in Standard JSON and metadata #15928

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
a61cbb4
Document the eofVersion field in StandardJSON and metadata
cameel Mar 11, 2025
643caa3
Mark the evmVersion field in StandardJSON as optional
cameel Mar 11, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions docs/metadata.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -134,6 +134,8 @@ explanatory purposes.
},
// Required for Solidity.
"evmVersion": "london",
// Optional: Only present if not null.
"eofVersion": 1,
// Required for Solidity: Addresses for libraries used.
"libraries": {
"MyLib": "0x123123..."
Expand Down
5 changes: 4 additions & 1 deletion docs/using-the-compiler.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -353,11 +353,14 @@ Input Description
}
}
},
// Version of the EVM to compile for.
// Version of the EVM to compile for (optional).
// Affects type checking and code generation. Can be homestead,
// tangerineWhistle, spuriousDragon, byzantium, constantinople,
// petersburg, istanbul, berlin, london, paris, shanghai, cancun (default), prague (experimental) or osaka (experimental).
"evmVersion": "cancun",
// EVM Object Format version to compile for (optional, experimental).
// Currently the only valid value is 1. If not specified, legacy non-EOF bytecode will be generated.
"eofVersion": null,
// Optional: Change compilation pipeline to go through the Yul intermediate representation.
// This is false by default.
"viaIR": true,
Expand Down