-
Notifications
You must be signed in to change notification settings - Fork 460
Specify Client Versions on Engine API #517
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.
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
Changes from 2 commits
Commits
Show all changes
11 commits
Select commit
Hold shift + click to select a range
3016309
Expose web3_clientVersion on Engine API
ethDreamer 70c3f0e
Specify `engine_clientIdentificationV1`
ethDreamer 662693a
Rename to `engine_clientVersionV1`
ethDreamer b05fae5
Fix broken TOC link
ethDreamer 7d5718e
fix spelling
ethDreamer ad6eeb7
Remove References to web3_clientVersion
ethDreamer 68bdbd6
Rename & Accommodate Multiplexers
ethDreamer 79ffb4e
spelling..
ethDreamer 1383036
Update src/engine/identification.md
ethDreamer 364ad1b
Update src/engine/identification.md
ethDreamer 3b1e1b1
Add words to wordlist.txt
ethDreamer File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,73 @@ | ||
| # Engine API -- Client Identification | ||
|
|
||
| Engine API structures and methods specified for client identification. | ||
|
|
||
| ## Table of contents | ||
|
|
||
| <!-- START doctoc generated TOC please keep comment here to allow auto update --> | ||
| <!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE --> | ||
|
|
||
| - [Client Identification](#client-identification) | ||
| - [Structures](#structures) | ||
| - [ClientCode](#clientcode) | ||
| - [ClientIdentificationV1](#clientidentificationv1) | ||
| - [Methods](#methods) | ||
| - [engine_clientIdentificationV1](#engine_clientidentificationv1) | ||
| - [Request](#request) | ||
| - [Response](#response) | ||
| - [Specification](#specification) | ||
|
|
||
| <!-- END doctoc generated TOC please keep comment here to allow auto update --> | ||
|
|
||
| ## Client Identification | ||
|
|
||
| To facilitate a more accurate measurement of execution layer client diversity statistics, execution clients **SHOULD** support the methods described in this document. | ||
|
|
||
| ## Structures | ||
|
|
||
| ### ClientCode | ||
|
|
||
| This enum defines a standard for specifying a client with just two letters. Clients teams which have a code reserved in this list **MUST** use this code when identifying themselves. The code is specified here only to facilitate standardization and NOT to imply that these are the only supported Ethereum clients. Any clients not listed here are free to use any two letters which don't collide with an existing client code. They are encouraged to make a PR to this repo to reserve their own code. Existing codes are as follows: | ||
|
|
||
| - `BU`: besu | ||
| - `EJ`: ethereumJS | ||
| - `EG`: erigon | ||
| - `GE`: go-ethereum | ||
| - `LH`: lighthouse | ||
| - `LS`: lodestar | ||
| - `NM`: nethermind | ||
| - `NB`: nimbus | ||
| - `TK`: teku | ||
| - `PM`: prysm | ||
| - `RH`: reth | ||
|
|
||
| ### ClientIdentificationV1 | ||
|
|
||
| This structure contains information which identifies a client implementatiopn. The fields are encoded as follows: | ||
|
|
||
| - `code`: `ClientCode`, e.g. `NB` or `BU` | ||
| - `clientName`: `string`, Human-readable name of the client, e.g. `Lighthouse` or `go-ethereum` | ||
ethDreamer marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
| - `version`: `string`, the standard semantic version string of the current implementation e.g. `v4.6.0` or `1.0.0-alpha.1` or `1.0.0+20130313144700` | ||
ethDreamer marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
| - `commit`: `string`, the hex of the first 4 bytes of the latest commit hash of this build e.g. `fa4ff922` | ||
ethDreamer marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|
|
||
| Rationale: Human-readable fields like `clientName` and `version` are useful for log messages while fields like `code` and `commit` are useful for uniquely specifying clients within a limited space (e.g. in block `graffiti`). | ||
|
|
||
| ## Methods | ||
|
|
||
| ### engine_clientIdentificationV1 | ||
|
|
||
| #### Request | ||
|
|
||
| * method: `engine_clientIdentificationV1` | ||
| * params: | ||
| 1. [`ClientIdentificationV1`](#ClientIdentificationV1) - identifies the consensus client | ||
| * timeout: 1s | ||
|
|
||
| #### Response | ||
|
|
||
| * result: [`ClientIdentificationV1`](#ClientIdentificationV1) - identifies the execution client | ||
|
|
||
| #### Specification | ||
|
|
||
| 1. Consensus and execution layer clients **MAY** exchange `ClientIdentificationV1` objects. Execution clients **MUST NOT** log any error messages if this method has either never been called or hasn't been called for a significant amount of time. | ||
| 2. Clients **MUST** accomodate receiving any two-letter `ClientCode`, even if they are not reserved in the list above. Clients **MAY** log messages upon receiving an unlisted client code. | ||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.