added pending deposits and pending partial withdrawals accessors (ethereum#500)

Co-authored-by: Nico Flaig <[email protected]>

Author: rolfyone

CHANGES.md

@@ -21,7 +21,8 @@ There are likely to be descriptions etc outside of the list below, but new query
 | [#472](https://github.com/ethereum/beacon-APIs/pull/472) `single_attestation EVENT` added        |                                                  |                                                  |                                                    |                                                 |                                           |
 | [#494](https://github.com/ethereum/beacon-APIs/pull/494) `GET /eth/v1/beacon/deposit_snapshot` deprecated        |                                                  |                                                  |                                                    |                                                 |                                           |
 | [#498](https://github.com/ethereum/beacon-APIs/pull/498) `GET /eth/v1/builder/states/{state_id}/expected_withdrawals` deprecated        |                                                  |                                                  |                                                    |                                                 |                                           |
-
+| [#500](https://github.com/ethereum/beacon-APIs/pull/500) `GET /eth/v1/beacon/states/{state_id}/pending_deposits` added        |                                                  |                                                  |                                                    |                                                 |                                           |
+| [#500](https://github.com/ethereum/beacon-APIs/pull/500) `GET /eth/v1/beacon/states/{state_id}/pending_partial_withdrawals` added         |                                                  |                                                  |                                                    |                                                 |                                           |
 
 The Following are no longer in the Standard API, removed since the latest version.
 

apis/beacon/states/pending_deposits.yaml

@@ -0,0 +1,49 @@
+get:
+  operationId: "getPendingDeposits"
+  summary: "Get State Pending Deposits"
+  description: |
+    Returns pending deposits for state with given 'stateId'. Should return 400 if the state retrieved is prior to Electra.
+  tags:
+    - Beacon
+  parameters:
+    - name: state_id
+      in: path
+      $ref: '../../../beacon-node-oapi.yaml#/components/parameters/StateId'
+  responses:
+    "200":
+      description: Success
+      headers:
+        Eth-Consensus-Version:
+          $ref: '../../../beacon-node-oapi.yaml#/components/headers/Eth-Consensus-Version'
+          description: "The active consensus version to which the pending deposits belong."
+      content:
+        application/json:
+          schema:
+            title: GetPendingDepositsResponse
+            type: object
+            required: [version, execution_optimistic, finalized, data]
+            properties:
+              version:
+                $ref: "../../../beacon-node-oapi.yaml#/components/schemas/ConsensusVersion"
+                example: "electra"
+              execution_optimistic:
+                $ref: "../../../beacon-node-oapi.yaml#/components/schemas/ExecutionOptimistic"
+              finalized:
+                $ref: "../../../beacon-node-oapi.yaml#/components/schemas/Finalized"
+              data:
+                type: array
+                items:
+                  $ref: "../../../beacon-node-oapi.yaml#/components/schemas/Electra.PendingDeposit"
+                maxItems: 134217728
+        application/octet-stream:
+          schema:
+            description: "SSZ serialized `List[PendingDeposit, PENDING_DEPOSITS_LIMIT]` bytes. Use Accept header to choose this response type"
+    "400":
+      $ref: '../../../beacon-node-oapi.yaml#/components/responses/InvalidRequest'
+    "404":
+      $ref: '../../../beacon-node-oapi.yaml#/components/responses/NotFound'
+    "415":
+      $ref: '../../../beacon-node-oapi.yaml#/components/responses/UnsupportedMediaType'
+    "500":
+      $ref: '../../../beacon-node-oapi.yaml#/components/responses/InternalError'
+

apis/beacon/states/pending_partial_withdrawals.yaml

@@ -0,0 +1,49 @@
+get:
+  operationId: "getPendingPartialWithdrawals"
+  summary: "Get State Pending Partial Withdrawals"
+  description: |
+    Returns pending partial withdrawals for state with given 'stateId'. Should return 400 if the state retrieved is prior to Electra.
+  tags:
+    - Beacon
+  parameters:
+    - name: state_id
+      in: path
+      $ref: '../../../beacon-node-oapi.yaml#/components/parameters/StateId'
+  responses:
+    "200":
+      description: Success
+      headers:
+        Eth-Consensus-Version:
+          $ref: '../../../beacon-node-oapi.yaml#/components/headers/Eth-Consensus-Version'
+          description: "The active consensus version to which the pending partial withdrawals belong."
+      content:
+        application/json:
+          schema:
+            title: GetPendingPartialWithdrawalsResponse
+            type: object
+            required: [version, execution_optimistic, finalized, data]
+            properties:
+              version:
+                $ref: "../../../beacon-node-oapi.yaml#/components/schemas/ConsensusVersion"
+                example: "electra"
+              execution_optimistic:
+                $ref: "../../../beacon-node-oapi.yaml#/components/schemas/ExecutionOptimistic"
+              finalized:
+                $ref: "../../../beacon-node-oapi.yaml#/components/schemas/Finalized"
+              data:
+                type: array
+                items:
+                  $ref: "../../../beacon-node-oapi.yaml#/components/schemas/Electra.PendingPartialWithdrawal"
+                maxItems: 134217728
+        application/octet-stream:
+          schema:
+            description: "SSZ serialized `List[PendingPartialWithdrawals, PENDING_PARTIAL_WITHDRAWALS_LIMIT]` bytes. Use Accept header to choose this response type"
+    "400":
+      $ref: '../../../beacon-node-oapi.yaml#/components/responses/InvalidRequest'
+    "404":
+      $ref: '../../../beacon-node-oapi.yaml#/components/responses/NotFound'
+    "415":
+      $ref: '../../../beacon-node-oapi.yaml#/components/responses/UnsupportedMediaType'
+    "500":
+      $ref: '../../../beacon-node-oapi.yaml#/components/responses/InternalError'
+

beacon-node-oapi.yaml

@@ -89,6 +89,11 @@ paths:
     $ref: "./apis/beacon/states/sync_committees.yaml"
   /eth/v1/beacon/states/{state_id}/randao:
     $ref: "./apis/beacon/states/randao.yaml"
+  /eth/v1/beacon/states/{state_id}/pending_deposits:
+    $ref: "./apis/beacon/states/pending_deposits.yaml"
+  /eth/v1/beacon/states/{state_id}/pending_partial_withdrawals:
+    $ref: "./apis/beacon/states/pending_partial_withdrawals.yaml"
+
   /eth/v1/beacon/headers:
     $ref: "./apis/beacon/blocks/headers.yaml"
   /eth/v1/beacon/headers/{block_id}:
@@ -425,6 +430,10 @@ components:
       $ref: './types/electra/light_client.yaml#/Electra/LightClientOptimisticUpdate'
     Electra.BlobSidecars:
       $ref: './types/electra/blob_sidecar.yaml#/Electra/BlobSidecars'
+    Electra.PendingDeposit:
+      $ref: './types/electra/deposit.yaml#/Electra/PendingDeposit'
+    Electra.PendingPartialWithdrawal:
+      $ref: './types/electra/withdrawal.yaml#/Electra/PendingPartialWithdrawal'
     Node:
       $ref: './types/fork_choice.yaml#/Node'
     ExtraData: