support Capella LC data (#293)

Implements the light client data format for Capella: - ethereum/consensus-specs#3151
Ingridmichelledev · Jan 28, 2023 · 5649a3a · 5649a3a
1 parent 7093a42
commit 5649a3a
Show file tree

Hide file tree

Showing 10 changed files with 110 additions and 33 deletions.
diff --git a/apis/beacon/light_client/bootstrap.yaml b/apis/beacon/light_client/bootstrap.yaml
@@ -2,10 +2,10 @@ get:
   operationId: getLightClientBootstrap
   summary: Get `LightClientBootstrap` structure for a requested block root
   description: |
-    Requests the [`LightClientBootstrap`](https://github.com/ethereum/consensus-specs/blob/v1.2.0-rc.3/specs/altair/light-client/sync-protocol.md#lightclientbootstrap) structure corresponding to a given post-Altair beacon block root.
+    Requests the [`LightClientBootstrap`](https://github.com/ethereum/consensus-specs/blob/v1.3.0-rc.2/specs/altair/light-client/sync-protocol.md#lightclientbootstrap) structure corresponding to a given post-Altair beacon block root.
     Depending on the `Accept` header it can be returned either as JSON or SSZ-serialized bytes.
 
-    Servers SHOULD provide results as defined in [`create_light_client_bootstrap`](https://github.com/ethereum/consensus-specs/blob/v1.2.0-rc.3/specs/altair/light-client/full-node.md#create_light_client_bootstrap). To fulfill a request, the requested block's post state needs to be known.
+    Servers SHOULD provide results as defined in [`create_light_client_bootstrap`](https://github.com/ethereum/consensus-specs/blob/v1.3.0-rc.2/specs/altair/light-client/full-node.md#create_light_client_bootstrap). To fulfill a request, the requested block's post state needs to be known.
   tags:
     - Beacon
   parameters:
@@ -28,7 +28,9 @@ get:
               version:
                 $ref: '../../../beacon-node-oapi.yaml#/components/schemas/ConsensusVersion'
               data:
-                $ref: '../../../beacon-node-oapi.yaml#/components/schemas/Altair.LightClientBootstrap'
+                oneOf:
+                  - $ref: '../../../beacon-node-oapi.yaml#/components/schemas/Altair.LightClientBootstrap'
+                  - $ref: '../../../beacon-node-oapi.yaml#/components/schemas/Capella.LightClientBootstrap'
         application/octet-stream:
           schema:
             description: "SSZ serialized `LightClientBootstrap` bytes. Use Accept header to choose this response type"

diff --git a/apis/beacon/light_client/finality_update.yaml b/apis/beacon/light_client/finality_update.yaml
@@ -2,10 +2,10 @@ get:
   operationId: getLightClientFinalityUpdate
   summary: Get the latest known `LightClientFinalityUpdate`
   description: |
-    Requests the latest [`LightClientFinalityUpdate`](https://github.com/ethereum/consensus-specs/blob/v1.2.0-rc.3/specs/altair/light-client/sync-protocol.md#lightclientfinalityupdate) known by the server.
+    Requests the latest [`LightClientFinalityUpdate`](https://github.com/ethereum/consensus-specs/blob/v1.3.0-rc.2/specs/altair/light-client/sync-protocol.md#lightclientfinalityupdate) known by the server.
     Depending on the `Accept` header it can be returned either as JSON or SSZ-serialized bytes.
 
-    Servers SHOULD provide results as defined in [`create_light_client_finality_update`](https://github.com/ethereum/consensus-specs/blob/v1.2.0-rc.3/specs/altair/light-client/full-node.md#create_light_client_finality_update).
+    Servers SHOULD provide results as defined in [`create_light_client_finality_update`](https://github.com/ethereum/consensus-specs/blob/v1.3.0-rc.2/specs/altair/light-client/full-node.md#create_light_client_finality_update).
   tags:
     - Beacon
   responses:
@@ -23,7 +23,9 @@ get:
               version:
                 $ref: '../../../beacon-node-oapi.yaml#/components/schemas/ConsensusVersion'
               data:
-                $ref: '../../../beacon-node-oapi.yaml#/components/schemas/Altair.LightClientFinalityUpdate'
+                oneOf:
+                  - $ref: '../../../beacon-node-oapi.yaml#/components/schemas/Altair.LightClientFinalityUpdate'
+                  - $ref: '../../../beacon-node-oapi.yaml#/components/schemas/Capella.LightClientFinalityUpdate'
         application/octet-stream:
           schema:
             description: "SSZ serialized `LightClientFinalityUpdate` bytes. Use Accept header to choose this response type"

diff --git a/apis/beacon/light_client/optimistic_update.yaml b/apis/beacon/light_client/optimistic_update.yaml
@@ -2,10 +2,10 @@ get:
   operationId: getLightClientOptimisticUpdate
   summary: Get the latest known `LightClientOptimisticUpdate`
   description: |
-    Requests the latest [`LightClientOptimisticUpdate`](https://github.com/ethereum/consensus-specs/blob/v1.2.0-rc.3/specs/altair/light-client/sync-protocol.md#lightclientoptimisticupdate) known by the server.
+    Requests the latest [`LightClientOptimisticUpdate`](https://github.com/ethereum/consensus-specs/blob/v1.3.0-rc.2/specs/altair/light-client/sync-protocol.md#lightclientoptimisticupdate) known by the server.
     Depending on the `Accept` header it can be returned either as JSON or SSZ-serialized bytes.
 
-    Servers SHOULD provide results as defined in [`create_light_client_optimistic_update`](https://github.com/ethereum/consensus-specs/blob/v1.2.0-rc.3/specs/altair/light-client/full-node.md#create_light_client_optimistic_update).
+    Servers SHOULD provide results as defined in [`create_light_client_optimistic_update`](https://github.com/ethereum/consensus-specs/blob/v1.3.0-rc.2/specs/altair/light-client/full-node.md#create_light_client_optimistic_update).
   tags:
     - Beacon
   responses:
@@ -23,7 +23,9 @@ get:
               version:
                 $ref: '../../../beacon-node-oapi.yaml#/components/schemas/ConsensusVersion'
               data:
-                $ref: '../../../beacon-node-oapi.yaml#/components/schemas/Altair.LightClientOptimisticUpdate'
+                oneOf:
+                  - $ref: '../../../beacon-node-oapi.yaml#/components/schemas/Altair.LightClientOptimisticUpdate'
+                  - $ref: '../../../beacon-node-oapi.yaml#/components/schemas/Capella.LightClientOptimisticUpdate'
         application/octet-stream:
           schema:
             description: "SSZ serialized `LightClientOptimisticUpdate` bytes. Use Accept header to choose this response type"

diff --git a/apis/beacon/light_client/updates.yaml b/apis/beacon/light_client/updates.yaml
@@ -2,10 +2,10 @@ get:
   operationId: getLightClientUpdatesByRange
   summary: Get `LightClientUpdate` instances in a requested sync committee period range
   description: |
-    Requests the [`LightClientUpdate`](https://github.com/ethereum/consensus-specs/blob/v1.2.0-rc.3/specs/altair/light-client/sync-protocol.md#lightclientupdate) instances in the sync committee period range `[start_period, start_period + count)`, leading up to the current head sync committee period as selected by fork choice.
+    Requests the [`LightClientUpdate`](https://github.com/ethereum/consensus-specs/blob/v1.3.0-rc.2/specs/altair/light-client/sync-protocol.md#lightclientupdate) instances in the sync committee period range `[start_period, start_period + count)`, leading up to the current head sync committee period as selected by fork choice.
     Depending on the `Accept` header they can be returned either as JSON or SSZ-serialized bytes.
 
-    Servers SHOULD provide results as defined in [`create_light_client_update`](https://github.com/ethereum/consensus-specs/blob/v1.2.0-rc.3/specs/altair/light-client/full-node.md#create_light_client_update). They MUST respond with at least the earliest known result within the requested range, and MUST send results in consecutive order (by period). The response MUST NOT contain more than [`min(MAX_REQUEST_LIGHT_CLIENT_UPDATES, count)`](https://github.com/ethereum/consensus-specs/blob/v1.2.0-rc.3/specs/altair/light-client/p2p-interface.md#configuration) results.
+    Servers SHOULD provide results as defined in [`create_light_client_update`](https://github.com/ethereum/consensus-specs/blob/v1.3.0-rc.2/specs/altair/light-client/full-node.md#create_light_client_update). They MUST respond with at least the earliest known result within the requested range, and MUST send results in consecutive order (by period). The response MUST NOT contain more than [`min(MAX_REQUEST_LIGHT_CLIENT_UPDATES, count)`](https://github.com/ethereum/consensus-specs/blob/v1.3.0-rc.2/specs/altair/light-client/p2p-interface.md#configuration) results.
   tags:
     - Beacon
   parameters:
@@ -33,7 +33,9 @@ get:
                 version:
                   $ref: '../../../beacon-node-oapi.yaml#/components/schemas/ConsensusVersion'
                 data:
-                  $ref: '../../../beacon-node-oapi.yaml#/components/schemas/Altair.LightClientUpdate'
+                  oneOf:
+                    - $ref: '../../../beacon-node-oapi.yaml#/components/schemas/Altair.LightClientUpdate'
+                    - $ref: '../../../beacon-node-oapi.yaml#/components/schemas/Capella.LightClientUpdate'
         application/octet-stream:
           schema:
             description: |
@@ -53,10 +55,11 @@ get:
 
               Per `context = compute_fork_digest(fork_version, genesis_validators_root)`:
 
-              | `fork_version`                               | Response chunk SSZ type              |
-              | -------------------------------------------- | ------------------------------------ |
-              | `GENESIS_FORK_VERSION`                       | n/a                                  |
-              | <nobr>`ALTAIR_FORK_VERSION` and later</nobr> | `altair.LightClientUpdate`           |
+              | `fork_version`                                                      | Response chunk SSZ type               |
+              | ------------------------------------------------------------------- | ------------------------------------- |
+              | `GENESIS_FORK_VERSION`                                              | n/a                                   |
+              | <nobr>`ALTAIR_FORK_VERSION` through `BELLATRIX_FORK_VERSION`</nobr> | `altair.LightClientUpdate`            |
+              | <nobr>`CAPELLA_FORK_VERSION` and later</nobr>                       | `capella.LightClientUpdate`           |
     "400":
       description: Malformed or missing request parameter
       content:

diff --git a/beacon-node-oapi.yaml b/beacon-node-oapi.yaml
@@ -58,7 +58,7 @@ tags:
     description: Endpoints to query rewards and penalties for validators.
   - name: Experimental
     description: Endpoints that are not stable or fully implemented by each client.
-    
+
 paths:
 
   /eth/v1/beacon/genesis:
@@ -272,6 +272,10 @@ components:
       $ref: './types/http.yaml#/ErrorMessage'
     IndexedErrorMessage:
       $ref: './types/http.yaml#/IndexedErrorMessage'
+    Altair.BeaconBlock:
+      $ref: './types/altair/block.yaml#/Altair/BeaconBlock'
+    Altair.SignedBeaconBlock:
+      $ref: './types/altair/block.yaml#/Altair/SignedBeaconBlock'
     Altair.LightClientBootstrap:
       $ref: './types/altair/light_client.yaml#/Altair/LightClientBootstrap'
     Altair.LightClientUpdate:
@@ -280,10 +284,6 @@ components:
       $ref: './types/altair/light_client.yaml#/Altair/LightClientFinalityUpdate'
     Altair.LightClientOptimisticUpdate:
       $ref: './types/altair/light_client.yaml#/Altair/LightClientOptimisticUpdate'
-    Altair.SignedBeaconBlock:
-      $ref: './types/altair/block.yaml#/Altair/SignedBeaconBlock'
-    Altair.BeaconBlock:
-      $ref: './types/altair/block.yaml#/Altair/BeaconBlock'
     Altair.BeaconState:
       $ref: './types/altair/state.yaml#/Altair/BeaconState'
     Altair.SyncCommitteeSignature:
@@ -325,6 +325,14 @@ components:
       $ref: './types/capella/block.yaml#/Capella/BlindedBeaconBlock'
     Capella.SignedBlindedBeaconBlock:
       $ref: './types/capella/block.yaml#/Capella/SignedBlindedBeaconBlock'
+    Capella.LightClientBootstrap:
+      $ref: './types/capella/light_client.yaml#/Capella/LightClientBootstrap'
+    Capella.LightClientUpdate:
+      $ref: './types/capella/light_client.yaml#/Capella/LightClientUpdate'
+    Capella.LightClientFinalityUpdate:
+      $ref: './types/capella/light_client.yaml#/Capella/LightClientFinalityUpdate'
+    Capella.LightClientOptimisticUpdate:
+      $ref: './types/capella/light_client.yaml#/Capella/LightClientOptimisticUpdate'
     Node:
       $ref: './types/fork_choice.yaml#/Node'
     ExtraData:

diff --git a/types/altair/light_client.yaml b/types/altair/light_client.yaml
@@ -3,21 +3,21 @@ Altair:
     type: array
     items:
       $ref: '../primitive.yaml#/Root'
-      description: "Merkle proof consisting of [`log2trunc(FINALIZED_ROOT_INDEX])`](https://github.com/ethereum/consensus-specs/blob/v1.2.0-rc.3/specs/altair/light-client/sync-protocol.md#constants) roots"
+      description: "Merkle proof consisting of [`log2trunc(FINALIZED_ROOT_INDEX])`](https://github.com/ethereum/consensus-specs/blob/v1.3.0-rc.2/specs/altair/light-client/sync-protocol.md#constants) roots"
     minItems: 6
     maxItems: 6
   CurrentSyncCommitteeBranch:
     type: array
     items:
       $ref: '../primitive.yaml#/Root'
-      description: "Merkle proof consisting of [`log2trunc(CURRENT_SYNC_COMMITTEE_INDEX])`](https://github.com/ethereum/consensus-specs/blob/v1.2.0-rc.3/specs/altair/light-client/sync-protocol.md#constants) roots"
+      description: "Merkle proof consisting of [`log2trunc(CURRENT_SYNC_COMMITTEE_INDEX])`](https://github.com/ethereum/consensus-specs/blob/v1.3.0-rc.2/specs/altair/light-client/sync-protocol.md#constants) roots"
     minItems: 5
     maxItems: 5
   NextSyncCommitteeBranch:
     type: array
     items:
       $ref: '../primitive.yaml#/Root'
-      description: "Merkle proof consisting of [`log2trunc(NEXT_SYNC_COMMITTEE_INDEX])`](https://github.com/ethereum/consensus-specs/blob/v1.2.0-rc.3/specs/altair/light-client/sync-protocol.md#constants) roots"
+      description: "Merkle proof consisting of [`log2trunc(NEXT_SYNC_COMMITTEE_INDEX])`](https://github.com/ethereum/consensus-specs/blob/v1.3.0-rc.2/specs/altair/light-client/sync-protocol.md#constants) roots"
     minItems: 5
     maxItems: 5
 

diff --git a/types/bellatrix/transactions.yaml b/types/bellatrix/transactions.yaml
@@ -2,6 +2,5 @@ Bellatrix:
   Transactions:
       type: array
       items:
-        allOf:
-          - $ref: '../primitive.yaml#/Transaction'
+        $ref: '../primitive.yaml#/Transaction'
       maxItems: 1048576
diff --git a/types/capella/execution_payload.yaml b/types/capella/execution_payload.yaml
@@ -38,7 +38,7 @@ Capella:
       - type: object
         properties:
           transactions:
-            $ref: './transactions.yaml#/Capella/Transactions'
+            $ref: '../bellatrix/transactions.yaml#/Bellatrix/Transactions'
           withdrawals:
             $ref: './withdrawals.yaml#/Capella/Withdrawals'
 

diff --git a/types/capella/light_client.yaml b/types/capella/light_client.yaml
@@ -0,0 +1,67 @@
+Capella:
+  ExecutionBranch:
+    type: array
+    items:
+      $ref: '../primitive.yaml#/Root'
+      description: "Merkle proof consisting of [`log2trunc(EXECUTION_PAYLOAD_INDEX])`](https://github.com/ethereum/consensus-specs/blob/v1.3.0-rc.2/specs/capella/light-client/sync-protocol.md#constants) roots"
+    minItems: 4
+    maxItems: 4
+
+  LightClientHeader:
+    type: object
+    properties:
+      beacon:
+        $ref: '../block.yaml#/BeaconBlockHeader'
+      execution:
+        $ref: './execution_payload.yaml#/Capella/ExecutionPayloadHeader'
+      execution_branch:
+        $ref: '#/Capella/ExecutionBranch'
+
+  LightClientBootstrap:
+    type: object
+    properties:
+      header:
+        $ref: '#/Capella/LightClientHeader'
+      current_sync_committee:
+        $ref: '../altair/sync_committee.yaml#/Altair/SyncCommittee'
+      current_sync_committee_branch:
+        $ref: '../altair/light_client.yaml#/Altair/CurrentSyncCommitteeBranch'
+  LightClientUpdate:
+    type: object
+    properties:
+      attested_header:
+        $ref: '#/Capella/LightClientHeader'
+      next_sync_committee:
+        $ref: '../altair/sync_committee.yaml#/Altair/SyncCommittee'
+      next_sync_committee_branch:
+        $ref: '../altair/light_client.yaml#/Altair/NextSyncCommitteeBranch'
+      finalized_header:
+        $ref: '#/Capella/LightClientHeader'
+      finality_branch:
+        $ref: '../altair/light_client.yaml#/Altair/FinalityBranch'
+      sync_aggregate:
+        $ref: '../altair/sync_aggregate.yaml#/Altair/SyncAggregate'
+      signature_slot:
+        $ref: '../primitive.yaml#/Uint64'
+  LightClientFinalityUpdate:
+    type: object
+    properties:
+      attested_header:
+        $ref: '#/Capella/LightClientHeader'
+      finalized_header:
+        $ref: '#/Capella/LightClientHeader'
+      finality_branch:
+        $ref: '../altair/light_client.yaml#/Altair/FinalityBranch'
+      sync_aggregate:
+        $ref: '../altair/sync_aggregate.yaml#/Altair/SyncAggregate'
+      signature_slot:
+        $ref: '../primitive.yaml#/Uint64'
+  LightClientOptimisticUpdate:
+    type: object
+    properties:
+      attested_header:
+        $ref: '#/Capella/LightClientHeader'
+      sync_aggregate:
+        $ref: '../altair/sync_aggregate.yaml#/Altair/SyncAggregate'
+      signature_slot:
+        $ref: '../primitive.yaml#/Uint64'
diff --git a/types/capella/transactions.yaml b/types/capella/transactions.yaml