Define primitive.yaml#/ClientCode

Author: eth2353

apis/node/version.v2.yaml

@@ -2,8 +2,8 @@ get:
   operationId: "getNodeVersionV2"
   tags:
     - Node
-  summary: "Get version information for the beacon node and execution payload validator."
-  description: "Retrieves structured information about the version of the beacon node and its attached execution payload validator."
+  summary: "Get version information for the beacon node and execution client."
+  description: "Retrieves structured information about the version of the beacon node and its attached execution client in the same format as used on the [Engine API](https://github.com/ethereum/execution-apis/blob/main/src/engine/identification.md)."
   responses:
     "200":
       description: Request successful
@@ -16,39 +16,24 @@ get:
             properties:
               data:
                 type: object
-                required: [beacon_node, execution_payload_validator]
+                required: [beacon_node, execution_client]
                 properties:
                   beacon_node:
                     $ref: '../../beacon-node-oapi.yaml#/components/schemas/ClientVersionV1'
-                  execution_payload_validator:
+                  execution_client:
                     $ref: '../../beacon-node-oapi.yaml#/components/schemas/ClientVersionV1'
-          examples:
-            Stateful Execution Payload Validator:
-              value:
-                data:
-                  beacon_node:
-                    code: "LH"
-                    name: "Lighthouse"
-                    version: "v8.0.1"
-                    commit: "ced49dd2"
-                  execution_payload_validator:
-                    code: "NM"
-                    name: "Nethermind"
-                    version: "v1.35.8"
-                    commit: "c066aee2"
-            Stateless Execution Payload Validator:
-              value:
-                data:
-                  beacon_node:
-                    code: "LS"
-                    name: "Lodestar"
-                    version: "v1.38.0"
-                    commit: "dbd94781"
-                  execution_payload_validator:
-                    code: "TBD"
-                    name: "ZK Proof Verifier"
-                    version: "v0.0.1"
-                    commit: "c066aee2"
+          example:
+            data:
+              beacon_node:
+                code: "LH"
+                name: "Lighthouse"
+                version: "v8.0.1"
+                commit: "ced49dd2"
+              execution_client:
+                code: "NM"
+                name: "Nethermind"
+                version: "v1.35.8"
+                commit: "c066aee2"
 
     "500":
       $ref: '../../beacon-node-oapi.yaml#/components/responses/InternalError'

spellcheck.yaml

@@ -70,3 +70,9 @@ matrix:
         delimiters:
           - open: 'commit:.*'
             close: '$'
+    # Ignore the 2-character ClientCode enum values (BU, EJ, EG, ...)
+    - pyspelling.filters.context:
+        context_visible_first: true
+        delimiters:
+          - open: 'enum: \[BU'
+            close: '$'

types/node.yaml

@@ -1,17 +1,19 @@
 ClientVersionV1:
   type: object
-  description: "A structure which uniquely identifies a client implementation and its version; similar to [HTTP User-Agent](https://tools.ietf.org/html/rfc7231#section-5.5.3)."
-  required: [name, version, commit]
+  description: "A structure which uniquely identifies a client implementation and its version. Mirrors the client version specification in the [Engine API](https://github.com/ethereum/execution-apis/blob/main/src/engine/identification.md)."
+  required: [code, name, version, commit]
   properties:
     code:
-      type: string
-      example: "LS"
+      $ref: './primitive.yaml#/ClientCode'
     name:
       type: string
+      description: "Human-readable name of the client, e.g. Lighthouse or go-ethereum"
       example: "Lodestar"
     version:
       type: string
+      description: "the version string of the current implementation e.g. v4.6.0 or 1.0.0-alpha.1 or 1.0.0+20130313144700"
       example: "v1.23.4"
     commit:
       type: string
+      description: "4 bytes - first four bytes of the latest commit hash of this build e.g. fa4ff922"
       example: "fa4ff922"

types/primitive.yaml

@@ -17,6 +17,12 @@ Version:
   description: "A string which uniquely identifies the client implementation and its version; similar to [HTTP User-Agent](https://tools.ietf.org/html/rfc7231#section-5.5.3)."
   example: "Lighthouse/v0.1.5 (Linux x86_64)"
 
+ClientCode:
+  type: string
+  description: "A two-character client code that uniquely maps to a client name as defined in the [Engine API](https://github.com/ethereum/execution-apis/blob/main/src/engine/identification.md#clientcode)."
+  enum: [BU, EJ, EG, GE, GR, LH, LS, NM, NB, TE, TK, PM, RH]
+  example: LS
+
 GenesisTime:
   $ref: "./primitive.yaml#/Uint64"
   example: "1590832934"

wordlist.txt

@@ -37,8 +37,5 @@ KZGProofs
 KZGCommitmentInclusionProof
 LMD
 fulu
-ZK
-Stateful
-Verifier
 LH
 ClientVersionV