Engine API: break down the spec by fork scopes#327
Engine API: break down the spec by fork scopes#327lightclient merged 4 commits intoethereum:mainfrom
Conversation
lightclient
left a comment
There was a problem hiding this comment.
I'm ambivalent on this. It seems a bit nicer from the perspective of an implementer, but from an observer it is sort of frustrating that the methods are now defined by fork. This is rarely the behavior observers expect (and one of my biggest complaints of the beacon spec). They end up jump through various forks until they find the method they need.
Maybe we could resolve that by having a better index of all the methods and that would be the best of both worlds. It would be nice to consider a different approach though where methods are grouped more by functionality instead and the hardfork-relevant information is noted within the method's specification.
The proposal #321 suggests to use a reference table of all methods, we may add a Description column to this table describing the origins of this or that method to make navigation easy. I can see how functionality approach is more practical in some ways, the HF-base approach has natural points of solidifying a portion of spec, and discerning solidified part from yet experimental one. Let's debate on this, I am fully open to any solution which would be convenient for spec writers, devs and observers. |
|
Updated this PR with decoupling Paris spec from the main spec document. So, Engine API spec employs the following structure: cc @djrtwo |
lightclient
left a comment
There was a problem hiding this comment.
I'm still slightly against the fork-scope format, but in the interest of moving things forward, the PR looks acceptable!
|
I have added |
In anticipation of changes proposed in #321 this PR decouples Shanghai spec from Paris.
I would also suggest we clean up the transition code in a separate PR. Currently,
newPayloadV2andforkchoiceUpdatedV2specs are based on the correspondingV1versions. To get rid of transition logic we would need the new spec to redefine the following parts:forkchoicUpdatedV2methodcc @ralexstokes