jleony/nanoreth
1
0
Fork 0
mirror of https://github.com/hl-archive-node/nanoreth.git synced 2025-12-06 10:59:55 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs: add hardfork checklist (#11897)

Browse Source 
Co-authored-by: Oliver <onbjerg@users.noreply.github.com>
This commit is contained in:
Matthias Seitz
2024-10-19 18:14:02 +02:00
committed by GitHub
parent a78de201b3
commit f8969cbbc2
1 changed files with 21 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

21
HARDFORK-CHECKLIST.md Normal file
View File

@ -0,0 +1,21 @@
# Non-exhaustive checklist for integrating new changes for an upcoming hard fork/devnet
## Introducing new EIP types or changes to primitive types
- Make required changes to primitive data structures on [alloy](https://github.com/alloy-rs/alloy)
- All new EIP data structures/constants/helpers etc. go into the `alloy-eips` crate at first.
- New transaction types go into `alloy-consensus`
- If there are changes to existing data structures, such as `Header` or `Block`, apply them to the types in `alloy-consensus` (e.g. new `request_hashes` field in Prague)
## Engine API
- If there are changes to the engine API (e.g. a new `engine_newPayloadVx` and `engine_getPayloadVx` pair) add the new types to the `alloy-rpc-types-engine` crate.
- If there are new parameters to the `engine_newPayloadVx` endpoint, add them to the `ExecutionPayloadSidecar` container type. This types contains all additional parameters that are required to convert an `ExecutionPayload` to an EL block.
## Reth changes
### Updates to the engine API
- Add new endpoints to the `EngineApi` trait and implement endpoints.
- Update the `ExceuctionPayload` + `ExecutionPayloadSidecar` to `Block` conversion if there are any additional parameters.
- Update version specific validation checks in the `EngineValidator` trait.