PART 3 - GET/Attestation Pool API - Add API interface

CHANGELOG.md

@@ -15,6 +15,7 @@
 - Added a state pruner that can limit the number of finalized states stored when running an archive node.
 - Updated bootnodes for Sepolia network.
 - Implemented [GetBlockAttestationV2](https://ethereum.github.io/beacon-APIs/?urls.primaryName=dev#/Beacon/getBlockAttestationsV2) (adding support for Electra attestations)
+- Implemented [GetAttestationsV2](https://ethereum.github.io/beacon-APIs/?urls.primaryName=dev#/Beacon/getPoolAttestationsV2) (adding support for Electra attestations)
 - Implemented [GetAggregateAttestationV2](https://ethereum.github.io/beacon-APIs/?urls.primaryName=dev#/Validator/getAggregatedAttestationV2) (adding support for Electra attestations)
 - Updated a number of parameters to reduce issues when using `p2p-subscribe-all-subnets-enabled`. If you have adjusted queue sizes manually when using all-subnets, please refer to details below. Manual settings will still override these defaults.
 - When `p2p-subscribe-all-subnets-enabled`, `p2p-peer-lower-bound` now defaults to 60 (previously 64), and `p2p-peer-upper-bound` now defaults to 80 (previously 100).

data/beaconrestapi/src/integration-test/resources/tech/pegasys/teku/beaconrestapi/beacon/paths/_eth_v1_beacon_pool_attestations.json

@@ -4,6 +4,7 @@
     "operationId" : "getPoolAttestations",
     "summary" : "Get Attestations from operations pool",
     "description" : "Retrieves attestations known by the node but not necessarily incorporated into any block.",
+    "deprecated" : true,
     "parameters" : [ {
       "name" : "slot",
       "in" : "query",

data/beaconrestapi/src/integration-test/resources/tech/pegasys/teku/beaconrestapi/beacon/paths/_eth_v2_beacon_pool_attestations.json

@@ -0,0 +1,59 @@
+{
+  "get" : {
+    "tags" : [ "Beacon" ],
+    "operationId" : "getPoolAttestationsV2",
+    "summary" : "Get Attestations from operations pool",
+    "description" : "Retrieves attestations known by the node but not necessarily incorporated into any block.",
+    "parameters" : [ {
+      "name" : "slot",
+      "in" : "query",
+      "schema" : {
+        "type" : "string",
+        "description" : "`UInt64` Slot to query in the canonical chain.",
+        "example" : "1",
+        "format" : "uint64"
+      }
+    }, {
+      "name" : "committee_index",
+      "in" : "query",
+      "schema" : {
+        "type" : "string",
+        "description" : "`uint64` Committee index to query.",
+        "example" : "1",
+        "format" : "uint64"
+      }
+    } ],
+    "responses" : {
+      "200" : {
+        "description" : "Request successful",
+        "content" : {
+          "application/json" : {
+            "schema" : {
+              "$ref" : "#/components/schemas/GetPoolAttestationsV2Response"
+            }
+          }
+        }
+      },
+      "400" : {
+        "description" : "The request could not be processed, check the response for more information.",
+        "content" : {
+          "application/json" : {
+            "schema" : {
+              "$ref" : "#/components/schemas/HttpErrorResponse"
+            }
+          }
+        }
+      },
+      "500" : {
+        "description" : "Internal server error",
+        "content" : {
+          "application/json" : {
+            "schema" : {
+              "$ref" : "#/components/schemas/HttpErrorResponse"
+            }
+          }
+        }
+      }
+    }
+  }
+}

data/beaconrestapi/src/integration-test/resources/tech/pegasys/teku/beaconrestapi/beacon/schema/GetPoolAttestationsV2Response.json

@@ -0,0 +1,23 @@
+{
+  "title" : "GetPoolAttestationsV2Response",
+  "type" : "object",
+  "required" : [ "version", "data" ],
+  "properties" : {
+    "version" : {
+      "type" : "string",
+      "enum" : [ "phase0", "altair", "bellatrix", "capella", "deneb", "electra" ]
+    },
+    "data" : {
+      "type" : "array",
+      "items" : {
+        "title" : "Attestation",
+        "type" : "object",
+        "oneOf" : [ {
+          "$ref" : "#/components/schemas/AttestationPhase0"
+        }, {
+          "$ref" : "#/components/schemas/AttestationElectra"
+        } ]
+      }
+    }
+  }
+}

data/beaconrestapi/src/main/java/tech/pegasys/teku/beaconrestapi/JsonTypeDefinitionBeaconRestApi.java

@@ -101,6 +101,7 @@
 import tech.pegasys.teku.beaconrestapi.handlers.v1.validator.PostSyncCommitteeSubscriptions;
 import tech.pegasys.teku.beaconrestapi.handlers.v1.validator.PostSyncDuties;
 import tech.pegasys.teku.beaconrestapi.handlers.v1.validator.PostValidatorLiveness;
+import tech.pegasys.teku.beaconrestapi.handlers.v2.beacon.GetAttestationsV2;
 import tech.pegasys.teku.beaconrestapi.handlers.v2.beacon.GetAttesterSlashingsV2;
 import tech.pegasys.teku.beaconrestapi.handlers.v2.beacon.GetBlock;
 import tech.pegasys.teku.beaconrestapi.handlers.v2.beacon.GetBlockAttestationsV2;
@@ -236,6 +237,7 @@ private static RestApi create(
             .endpoint(new GetBlockAttestations(dataProvider, spec))
             .endpoint(new GetBlockAttestationsV2(dataProvider, schemaCache))
             .endpoint(new GetAttestations(dataProvider, spec))
+            .endpoint(new GetAttestationsV2(dataProvider, schemaCache))
             .endpoint(new PostAttestation(dataProvider, schemaCache))
             .endpoint(new GetAttesterSlashings(dataProvider, spec))
             .endpoint(new GetAttesterSlashingsV2(dataProvider, schemaCache))

data/beaconrestapi/src/main/java/tech/pegasys/teku/beaconrestapi/handlers/v1/beacon/GetAttestations.java

@@ -52,6 +52,7 @@ public GetAttestations(final NodeDataProvider nodeDataProvider, final Spec spec)
             .description(
                 "Retrieves attestations known by the node but not necessarily incorporated into any block.")
             .tags(TAG_BEACON)
+            .deprecated(true)
             .queryParam(SLOT_PARAMETER.withDescription(SLOT_QUERY_DESCRIPTION))
             .queryParam(COMMITTEE_INDEX_PARAMETER)
             .response(SC_OK, "Request successful", getResponseType(spec))
@@ -70,7 +71,6 @@ public void handleRequest(final RestApiRequest request) throws JsonProcessingExc
     request.respondOk(nodeDataProvider.getAttestations(slot, committeeIndex));
   }
 
-  // TODO EIP-7549 handle Electra attestations
   private static SerializableTypeDefinition<List<Attestation>> getResponseType(final Spec spec) {
     return SerializableTypeDefinition.<List<Attestation>>object()
         .name("GetPoolAttestationsResponse")

data/beaconrestapi/src/main/java/tech/pegasys/teku/beaconrestapi/handlers/v2/beacon/GetAttestationsV2.java

@@ -0,0 +1,123 @@
+/*
+ * Copyright Consensys Software Inc., 2024
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with
+ * the License. You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on
+ * an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the
+ * specific language governing permissions and limitations under the License.
+ */
+
+package tech.pegasys.teku.beaconrestapi.handlers.v2.beacon;
+
+import static tech.pegasys.teku.beaconrestapi.BeaconRestApiTypes.COMMITTEE_INDEX_PARAMETER;
+import static tech.pegasys.teku.beaconrestapi.BeaconRestApiTypes.SLOT_PARAMETER;
+import static tech.pegasys.teku.beaconrestapi.handlers.v1.beacon.MilestoneDependentTypesUtil.getMultipleSchemaDefinitionFromMilestone;
+import static tech.pegasys.teku.ethereum.json.types.EthereumTypes.MILESTONE_TYPE;
+import static tech.pegasys.teku.infrastructure.http.HttpStatusCodes.SC_OK;
+import static tech.pegasys.teku.infrastructure.http.RestApiConstants.CACHE_NONE;
+import static tech.pegasys.teku.infrastructure.http.RestApiConstants.HEADER_CONSENSUS_VERSION;
+import static tech.pegasys.teku.infrastructure.http.RestApiConstants.SLOT_QUERY_DESCRIPTION;
+import static tech.pegasys.teku.infrastructure.http.RestApiConstants.TAG_BEACON;
+import static tech.pegasys.teku.infrastructure.json.types.SerializableTypeDefinition.listOf;
+
+import com.fasterxml.jackson.core.JsonProcessingException;
+import io.javalin.http.Header;
+import java.util.ArrayList;
+import java.util.List;
+import java.util.Optional;
+import tech.pegasys.teku.api.DataProvider;
+import tech.pegasys.teku.api.NodeDataProvider;
+import tech.pegasys.teku.api.schema.Version;
+import tech.pegasys.teku.beaconrestapi.handlers.v1.beacon.MilestoneDependentTypesUtil;
+import tech.pegasys.teku.infrastructure.json.types.SerializableTypeDefinition;
+import tech.pegasys.teku.infrastructure.restapi.endpoints.EndpointMetadata;
+import tech.pegasys.teku.infrastructure.restapi.endpoints.RestApiEndpoint;
+import tech.pegasys.teku.infrastructure.restapi.endpoints.RestApiRequest;
+import tech.pegasys.teku.infrastructure.unsigned.UInt64;
+import tech.pegasys.teku.spec.SpecMilestone;
+import tech.pegasys.teku.spec.datastructures.metadata.ObjectAndMetaData;
+import tech.pegasys.teku.spec.datastructures.operations.Attestation;
+import tech.pegasys.teku.spec.schemas.SchemaDefinitionCache;
+import tech.pegasys.teku.spec.schemas.SchemaDefinitions;
+
+public class GetAttestationsV2 extends RestApiEndpoint {
+
+  public static final String ROUTE = "/eth/v2/beacon/pool/attestations";
+
+  private final NodeDataProvider nodeDataProvider;
+
+  public GetAttestationsV2(
+      final DataProvider dataProvider, final SchemaDefinitionCache schemaDefinitionCache) {
+
+    this(dataProvider.getNodeDataProvider(), schemaDefinitionCache);
+  }
+
+  public GetAttestationsV2(
+      final NodeDataProvider nodeDataProvider, final SchemaDefinitionCache schemaDefinitionCache) {
+    super(
+        EndpointMetadata.get(ROUTE)
+            .operationId("getPoolAttestationsV2")
+            .summary("Get Attestations from operations pool")
+            .description(
+                "Retrieves attestations known by the node but not necessarily incorporated into any block.")
+            .tags(TAG_BEACON)
+            .queryParam(SLOT_PARAMETER.withDescription(SLOT_QUERY_DESCRIPTION))
+            .queryParam(COMMITTEE_INDEX_PARAMETER)
+            .response(SC_OK, "Request successful", getResponseType(schemaDefinitionCache))
+            .build());
+    this.nodeDataProvider = nodeDataProvider;
+  }
+
+  @Override
+  public void handleRequest(final RestApiRequest request) throws JsonProcessingException {
+    request.header(Header.CACHE_CONTROL, CACHE_NONE);
+    final Optional<UInt64> slot =
+        request.getOptionalQueryParameter(SLOT_PARAMETER.withDescription(SLOT_QUERY_DESCRIPTION));
+    final Optional<UInt64> committeeIndex =
+        request.getOptionalQueryParameter(COMMITTEE_INDEX_PARAMETER);
+    final ObjectAndMetaData<List<Attestation>> attestationsAndMetaData =
+        nodeDataProvider.getAttestationsAndMetaData(slot, committeeIndex);
+
+    request.header(
+        HEADER_CONSENSUS_VERSION,
+        Version.fromMilestone(attestationsAndMetaData.getMilestone()).name());
+    request.respondOk(attestationsAndMetaData);
+  }
+
+  private static SerializableTypeDefinition<ObjectAndMetaData<List<Attestation>>> getResponseType(
+      final SchemaDefinitionCache schemaDefinitionCache) {
+
+    final List<MilestoneDependentTypesUtil.ConditionalSchemaGetter<Attestation>> schemaGetters =
+        generateAttestationSchemaGetters(schemaDefinitionCache);
+
+    final SerializableTypeDefinition<Attestation> attestationType =
+        getMultipleSchemaDefinitionFromMilestone(
+            schemaDefinitionCache, "Attestation", schemaGetters);
+
+    return SerializableTypeDefinition.<ObjectAndMetaData<List<Attestation>>>object()
+        .name("GetPoolAttestationsV2Response")
+        .withField("version", MILESTONE_TYPE, ObjectAndMetaData::getMilestone)
+        .withField("data", listOf(attestationType), ObjectAndMetaData::getData)
+        .build();
+  }
+
+  private static List<MilestoneDependentTypesUtil.ConditionalSchemaGetter<Attestation>>
+      generateAttestationSchemaGetters(final SchemaDefinitionCache schemaDefinitionCache) {
+    final List<MilestoneDependentTypesUtil.ConditionalSchemaGetter<Attestation>> schemaGetterList =
+        new ArrayList<>();
+
+    schemaGetterList.add(
+        new MilestoneDependentTypesUtil.ConditionalSchemaGetter<>(
+            (attestation, milestone) ->
+                schemaDefinitionCache
+                    .milestoneAtSlot(attestation.getData().getSlot())
+                    .equals(milestone),
+            SpecMilestone.PHASE0,
+            SchemaDefinitions::getAttestationSchema));
+    return schemaGetterList;
+  }
+}

data/beaconrestapi/src/test/java/tech/pegasys/teku/beaconrestapi/handlers/v2/beacon/GetAttestationsV2Test.java

@@ -0,0 +1,119 @@
+/*
+ * Copyright Consensys Software Inc., 2024
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with
+ * the License. You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on
+ * an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the
+ * specific language governing permissions and limitations under the License.
+ */
+
+package tech.pegasys.teku.beaconrestapi.handlers.v2.beacon;
+
+import static java.nio.charset.StandardCharsets.UTF_8;
+import static org.assertj.core.api.AssertionsForClassTypes.assertThat;
+import static org.mockito.ArgumentMatchers.any;
+import static org.mockito.Mockito.when;
+import static tech.pegasys.teku.infrastructure.http.HttpStatusCodes.SC_BAD_REQUEST;
+import static tech.pegasys.teku.infrastructure.http.HttpStatusCodes.SC_INTERNAL_SERVER_ERROR;
+import static tech.pegasys.teku.infrastructure.http.HttpStatusCodes.SC_OK;
+import static tech.pegasys.teku.infrastructure.http.RestApiConstants.HEADER_CONSENSUS_VERSION;
+import static tech.pegasys.teku.infrastructure.restapi.MetadataTestUtil.getResponseStringFromMetadata;
+import static tech.pegasys.teku.infrastructure.restapi.MetadataTestUtil.verifyMetadataErrorResponse;
+import static tech.pegasys.teku.spec.SpecMilestone.ELECTRA;
+import static tech.pegasys.teku.spec.SpecMilestone.PHASE0;
+
+import com.fasterxml.jackson.core.JsonProcessingException;
+import com.fasterxml.jackson.databind.JsonNode;
+import com.google.common.io.Resources;
+import java.io.IOException;
+import java.util.Collections;
+import java.util.List;
+import org.junit.jupiter.api.BeforeEach;
+import org.junit.jupiter.api.TestTemplate;
+import tech.pegasys.teku.api.schema.Version;
+import tech.pegasys.teku.beaconrestapi.AbstractMigratedBeaconHandlerTest;
+import tech.pegasys.teku.infrastructure.json.JsonTestUtil;
+import tech.pegasys.teku.spec.SpecMilestone;
+import tech.pegasys.teku.spec.TestSpecContext;
+import tech.pegasys.teku.spec.TestSpecInvocationContextProvider;
+import tech.pegasys.teku.spec.datastructures.metadata.ObjectAndMetaData;
+import tech.pegasys.teku.spec.datastructures.operations.Attestation;
+import tech.pegasys.teku.spec.schemas.SchemaDefinitionCache;
+import tech.pegasys.teku.spec.util.DataStructureUtil;
+
+@TestSpecContext(milestone = {PHASE0, ELECTRA})
+public class GetAttestationsV2Test extends AbstractMigratedBeaconHandlerTest {
+
+  private SpecMilestone specMilestone;
+
+  @BeforeEach
+  void setup(final TestSpecInvocationContextProvider.SpecContext specContext) {
+    spec = specContext.getSpec();
+    dataStructureUtil = new DataStructureUtil(spec);
+    specMilestone = specContext.getSpecMilestone();
+    setHandler(new GetAttestationsV2(nodeDataProvider, new SchemaDefinitionCache(spec)));
+  }
+
+  @TestTemplate
+  public void shouldReturnAttestationsWhenFound() throws JsonProcessingException {
+    final List<Attestation> attestations =
+        List.of(dataStructureUtil.randomAttestation(), dataStructureUtil.randomAttestation());
+    final ObjectAndMetaData<List<Attestation>> attestationsAndMetaData =
+        new ObjectAndMetaData<>(
+            attestations, spec.getGenesisSpec().getMilestone(), false, false, false);
+    when(nodeDataProvider.getAttestationsAndMetaData(any(), any()))
+        .thenReturn(attestationsAndMetaData);
+
+    handler.handleRequest(request);
+    assertThat(request.getResponseCode()).isEqualTo(SC_OK);
+    assertThat(request.getResponseBody()).isEqualTo(attestationsAndMetaData);
+    assertThat(request.getResponseHeaders(HEADER_CONSENSUS_VERSION))
+        .isEqualTo(Version.fromMilestone(specMilestone).name());
+  }
+
+  @TestTemplate
+  public void shouldReturnEmptyListWhenNoAttestations() throws JsonProcessingException {
+    final ObjectAndMetaData<List<Attestation>> attestationsAndMetaData =
+        new ObjectAndMetaData<>(
+            Collections.emptyList(), spec.getGenesisSpec().getMilestone(), false, false, false);
+    when(nodeDataProvider.getAttestationsAndMetaData(any(), any()))
+        .thenReturn(attestationsAndMetaData);
+
+    handler.handleRequest(request);
+    assertThat(request.getResponseCode()).isEqualTo(SC_OK);
+    assertThat(request.getResponseBody()).isEqualTo(attestationsAndMetaData);
+    assertThat(request.getResponseHeaders(HEADER_CONSENSUS_VERSION))
+        .isEqualTo(Version.fromMilestone(specMilestone).name());
+  }
+
+  @TestTemplate
+  void metadata_shouldHandle400() throws JsonProcessingException {
+    verifyMetadataErrorResponse(handler, SC_BAD_REQUEST);
+  }
+
+  @TestTemplate
+  void metadata_shouldHandle500() throws JsonProcessingException {
+    verifyMetadataErrorResponse(handler, SC_INTERNAL_SERVER_ERROR);
+  }
+
+  @TestTemplate
+  void metadata_shouldHandle200() throws Exception {
+    final List<Attestation> attestations =
+        List.of(dataStructureUtil.randomAttestation(), dataStructureUtil.randomAttestation());
+    final ObjectAndMetaData<List<Attestation>> responseData = withMetaData(attestations);
+    final String responseDataAsString = getResponseStringFromMetadata(handler, SC_OK, responseData);
+    final JsonNode responseDataAsJsonNode = JsonTestUtil.parseAsJsonNode(responseDataAsString);
+    final String expected = getExpectedResponseAsJson(specMilestone);
+    final JsonNode expectedAsJsonNode = JsonTestUtil.parseAsJsonNode(expected);
+    assertThat(responseDataAsJsonNode).isEqualTo(expectedAsJsonNode);
+  }
+
+  private String getExpectedResponseAsJson(final SpecMilestone specMilestone) throws IOException {
+    final String fileName = String.format("getAttestations%s.json", specMilestone.name());
+    return Resources.toString(Resources.getResource(GetAttestationsV2Test.class, fileName), UTF_8);
+  }
+}