Checkpoint Sync API

apis/checkpoint/finalized_blocks/root.yaml

@@ -0,0 +1,57 @@
+get:
+  operationId: getFinalizedBlockRoot
+  summary: Get finalized block root
+  description: Retrieves hashTreeRoot of finalized BeaconBlock/BeaconBlockHeader. |
+    Responds with 404 if block at a slot is either unavailable or not yet finalized.
+  tags:
+    - Checkpoint
+  parameters:
+    - name: slot
+      in: path
+      required: true
+      example: "1"
+      schema:
+        type: string
+      description: |
+        Slot number.
+
+  responses:
+    "200":
+      description: Success
+      content:
+        application/json:
+          schema:
+            type: object
+            title: GetBlockRootResponse
+            properties:
+              execution_optimistic:
+                $ref: "../../../beacon-node-oapi.yaml#/components/schemas/ExecutionOptimistic"
+              data:
+                type: object
+                properties:
+                  root:
+                    allOf:
+                      - description: HashTreeRoot of BeaconBlock/BeaconBlockHeader object
+                      - $ref: '../../../beacon-node-oapi.yaml#/components/schemas/Root'
+    "400":
+      description: "The slot number supplied could not be parsed"
+      content:
+        application/json:
+          schema:
+            allOf:
+              - $ref: "../../../beacon-node-oapi.yaml#/components/schemas/ErrorMessage"
+              - example:
+                  code: 400
+                  message: "Invalid slot number: current"
+    "404":
+      description: "Block not found"
+      content:
+        application/json:
+          schema:
+            allOf:
+              - $ref: "../../../beacon-node-oapi.yaml#/components/schemas/ErrorMessage"
+              - example:
+                  code: 404
+                  message: "Block not found"
+    "500":
+      $ref: "../../../beacon-node-oapi.yaml#/components/responses/InternalError"

apis/checkpoint/finalized_state.yaml

@@ -0,0 +1,32 @@
+get:
+  operationId: "getFinalizedCheckpointState"
+  summary: "Get full BeaconState object for finalized checkpoint state"
+  description: |
+     Returns full BeaconState object for a finalized checkpoint from the WS period.
+     Returned state object MUST NOT be from an empty slot, i.e. it MUST be the post state of
+     a finalized block.
+     Returns 404 if the node is not yet fully synced, e.g. if it is tracking head optimistically.
+  tags:
+    - Checkpoint
+  responses:
+    "200":
+      description: Success
+      headers:
+        Eth-Consensus-Version:
+          $ref: '../../beacon-node-oapi.yaml#/components/headers/Eth-Consensus-Version'
+      content:
+        application/octet-stream:
+          schema:
+            description: "SSZ serialized state bytes. Use Accept header to choose this response type"
+    "404":
+      description: "State not found"
+      content:
+        application/json:
+          schema:
+            allOf:
+              - $ref: "../../beacon-node-oapi.yaml#/components/schemas/ErrorMessage"
+              - example:
+                  code: 404
+                  message: "State not found"
+    "500":
+      $ref: '../../beacon-node-oapi.yaml#/components/responses/InternalError'

beacon-node-oapi.yaml

@@ -39,6 +39,8 @@ servers:
 tags:
   - name: Beacon
     description: Set of endpoints to query beacon chain.
+  - name: Checkpoint
+    description: Set of endpoints to query checkpoint sync data.
   - name: Config
     description: Endpoints to query chain configuration, specification, and fork schedules.
   - name: Debug
@@ -191,6 +193,11 @@ paths:
   /eth/v1/events:
     $ref: "./apis/eventstream/index.yaml"
 
+  /eth/v1/checkpoint/finalized_blocks/{slot}/root:
+    $ref: "./apis/checkpoint/finalized_blocks/root.yaml"
+  /eth/v1/checkpoint/finalized_state:
+    $ref: "./apis/checkpoint/finalized_state.yaml"
+
 
 components:
   schemas: