-
Notifications
You must be signed in to change notification settings - Fork 278
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
PART 3 - GET/Attestation Pool API - Add API interface (#8438)
* add retrive attestations and metadata * Add GET attestations from aggregation pool V2 * fix unit test * rename json files * remove duplicate schemas * refactor tests * increase timeout for acceptance test * add changelog entry * fix open api test * add consensus version header * refactor attestations filtering * refactor committee index filtering * spotless * refactor attestation filtering * extract methods * remove else * missing finals * remove AT changes
- Loading branch information
1 parent
baa7f0f
commit cf6cc06
Showing
13 changed files
with
452 additions
and
14 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
59 changes: 59 additions & 0 deletions
59
...ources/tech/pegasys/teku/beaconrestapi/beacon/paths/_eth_v2_beacon_pool_attestations.json
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -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" | ||
| } | ||
| } | ||
| } | ||
| } | ||
| } | ||
| } | ||
| } |
23 changes: 23 additions & 0 deletions
23
...esources/tech/pegasys/teku/beaconrestapi/beacon/schema/GetPoolAttestationsV2Response.json
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -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" | ||
| } ] | ||
| } | ||
| } | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
123 changes: 123 additions & 0 deletions
123
...i/src/main/java/tech/pegasys/teku/beaconrestapi/handlers/v2/beacon/GetAttestationsV2.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -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; | ||
| } | ||
| } |
119 changes: 119 additions & 0 deletions
119
...c/test/java/tech/pegasys/teku/beaconrestapi/handlers/v2/beacon/GetAttestationsV2Test.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -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); | ||
| } | ||
| } |
Oops, something went wrong.