Skip to content

Engine API: Refine message ordering. Take 2 #148

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 1 commit into from
Dec 17, 2021
+4 −16
Merged

Engine API: Refine message ordering. Take 2 #148

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
20 changes: 4 additions & 16 deletions src/engine/specification.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -60,25 +60,13 @@ The versioning of the Engine API is defined as follows:
* a set of structure fields
* The specification **MAY** reference a method or a structure without the version suffix e.g. `engine_executePayload`. These statements should be read as related to all versions of the referenced method or structure.

## Constants

| Name | Value |
| - | - |
| `MESSAGE_ORDER_RESET_ID` | `0` |

## Message ordering

Consensus Layer client software **MUST** utilize JSON-RPC request IDs that are strictly increasing.
Request IDs assigned to `engine_forkchoiceUpdated` method calls **MUST** respect the order of
the corresponding fork choice update events occurring in the system.

Execution Layer client software **MUST NOT** process `engine_forkchoiceUpdated` method call
if its JSON-RPC request ID is lower than the ID assigned to the previous call of this method.
Consensus Layer client software **MUST** respect the order of the corresponding fork choice update events
when making calls to the `engine_forkchoiceUpdated` method.

Consensus Layer client software **SHOULD** use `MESSAGE_ORDER_RESET_ID` as initial value of request ID
to reset the ID cached by Execution Layer client software.
If the ID of a request equals to `MESSAGE_ORDER_RESET_ID`, Execution Layer client software **MUST** process this request
disregarding the ID of the previous one and use `MESSAGE_ORDER_RESET_ID` value as the latest previous request ID, effectively resetting the request ID event ordering.
Execution Layer client software **MUST** process `engine_forkchoiceUpdated` method calls
in the same order as they have been received.

## Load-balancing and advanced configurations

Expand Down