forked from Consensys/teku
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Migrate PostSyncCommittees to MigratingEndpointAdapter (Consensys#5634)
- Loading branch information
1 parent
051e143
commit 2a71c8a
Showing
9 changed files
with
295 additions
and
36 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
52 changes: 52 additions & 0 deletions
52
...pegasys/teku/beaconrestapi/beacon/migrated/paths/_eth_v1_beacon_pool_sync_committees.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,52 @@ | ||
| { | ||
| "post" : { | ||
| "tags" : [ "Beacon", "Validator Required Api" ], | ||
| "operationId" : "postSyncCommittees", | ||
| "summary" : "Submit sync committee messages to node", | ||
| "description" : "Submits sync committee message objects to the node.\n\nSync committee messages are not present in phase0, but are required for Altair networks.\n\nIf a sync committee message is validated successfully the node MUST publish that sync committee message on all applicable subnets.\n\nIf one or more sync committee messages fail validation the node MUST return a 400 error with details of which sync committee messages have failed, and why.", | ||
| "requestBody" : { | ||
| "content" : { | ||
| "application/json" : { | ||
| "schema" : { | ||
| "type" : "array", | ||
| "items" : { | ||
| "$ref" : "#/components/schemas/SyncCommitteeMessage" | ||
| } | ||
| } | ||
| } | ||
| } | ||
| }, | ||
| "responses" : { | ||
| "200" : { | ||
| "description" : "Sync committee signatures are stored in pool and broadcast on appropriate subnet", | ||
| "content" : { } | ||
| }, | ||
| "400" : { | ||
| "description" : "Errors with one or more sync committee signatures", | ||
| "content" : { | ||
| "application/json" : { | ||
| "schema" : { | ||
| "title" : "BadRequestResponses", | ||
| "type" : "object", | ||
| "oneOf" : [ { | ||
| "$ref" : "#/components/schemas/PostDataFailureResponse" | ||
| }, { | ||
| "$ref" : "#/components/schemas/HttpErrorResponse" | ||
| } ] | ||
| } | ||
| } | ||
| } | ||
| }, | ||
| "500" : { | ||
| "description" : "Internal server error", | ||
| "content" : { | ||
| "application/json" : { | ||
| "schema" : { | ||
| "$ref" : "#/components/schemas/HttpErrorResponse" | ||
| } | ||
| } | ||
| } | ||
| } | ||
| } | ||
| } | ||
| } |
31 changes: 31 additions & 0 deletions
31
...esources/tech/pegasys/teku/beaconrestapi/beacon/migrated/schema/SyncCommitteeMessage.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,31 @@ | ||
| { | ||
| "title" : "SyncCommitteeMessage", | ||
| "type" : "object", | ||
| "required" : [ "slot", "beacon_block_root", "validator_index", "signature" ], | ||
| "properties" : { | ||
| "slot" : { | ||
| "type" : "string", | ||
| "description" : "unsigned 64 bit integer", | ||
| "example" : "1", | ||
| "format" : "uint64" | ||
| }, | ||
| "beacon_block_root" : { | ||
| "type" : "string", | ||
| "description" : "Bytes32 hexadecimal", | ||
| "example" : "0xcf8e0d4e9587369b2301d0790347320302cc0943d5a1884560367e8208d920f2", | ||
| "format" : "byte" | ||
| }, | ||
| "validator_index" : { | ||
| "type" : "string", | ||
| "description" : "unsigned 64 bit integer", | ||
| "example" : "1", | ||
| "format" : "uint64" | ||
| }, | ||
| "signature" : { | ||
| "type" : "string", | ||
| "pattern" : "^0x[a-fA-F0-9]{2,}$", | ||
| "description" : "SSZ hexadecimal", | ||
| "format" : "bytes" | ||
| } | ||
| } | ||
| } |
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
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
104 changes: 104 additions & 0 deletions
104
.../test/java/tech/pegasys/teku/beaconrestapi/handlers/v1/beacon/PostSyncCommitteesTest.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,104 @@ | ||
| /* | ||
| * Copyright 2022 ConsenSys AG. | ||
| * | ||
| * 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.v1.beacon; | ||
|
|
||
| import static java.nio.charset.StandardCharsets.UTF_8; | ||
| import static javax.servlet.http.HttpServletResponse.SC_BAD_REQUEST; | ||
| import static javax.servlet.http.HttpServletResponse.SC_OK; | ||
| import static org.assertj.core.api.Assertions.assertThat; | ||
| import static org.mockito.ArgumentMatchers.any; | ||
| import static org.mockito.Mockito.when; | ||
| import static tech.pegasys.teku.infrastructure.http.HttpStatusCodes.SC_INTERNAL_SERVER_ERROR; | ||
| import static tech.pegasys.teku.infrastructure.restapi.MetadataTestUtil.getResponseStringFromMetadata; | ||
| import static tech.pegasys.teku.infrastructure.restapi.MetadataTestUtil.verifyMetadataEmptyResponse; | ||
| import static tech.pegasys.teku.infrastructure.restapi.MetadataTestUtil.verifyMetadataErrorResponse; | ||
|
|
||
| import com.fasterxml.jackson.core.JsonProcessingException; | ||
| import com.google.common.io.Resources; | ||
| import java.io.IOException; | ||
| import java.util.List; | ||
| import org.assertj.core.api.AssertionsForClassTypes; | ||
| import org.junit.jupiter.api.BeforeEach; | ||
| import org.junit.jupiter.api.Test; | ||
| import tech.pegasys.teku.beaconrestapi.AbstractMigratedBeaconHandlerTest; | ||
| import tech.pegasys.teku.infrastructure.async.SafeFuture; | ||
| import tech.pegasys.teku.infrastructure.http.HttpStatusCodes; | ||
| import tech.pegasys.teku.infrastructure.unsigned.UInt64; | ||
| import tech.pegasys.teku.spec.TestSpecFactory; | ||
| import tech.pegasys.teku.spec.util.DataStructureUtil; | ||
| import tech.pegasys.teku.validator.api.SubmitDataError; | ||
|
|
||
| public class PostSyncCommitteesTest extends AbstractMigratedBeaconHandlerTest { | ||
|
|
||
| @BeforeEach | ||
| void setup() { | ||
| spec = TestSpecFactory.createMinimalAltair(); | ||
| dataStructureUtil = new DataStructureUtil(spec); | ||
| setHandler(new PostSyncCommittees(validatorDataProvider)); | ||
| } | ||
|
|
||
| @Test | ||
| void shouldBeAbleToSubmitSyncCommittees() throws Exception { | ||
| request.setRequestBody(List.of(dataStructureUtil.randomSyncCommitteeMessage())); | ||
| when(validatorDataProvider.submitCommitteeSignatures(any())) | ||
| .thenReturn(SafeFuture.completedFuture(List.of())); | ||
|
|
||
| handler.handleRequest(request); | ||
|
|
||
| assertThat(request.getResponseCode()).isEqualTo(SC_OK); | ||
| assertThat(request.getResponseBody()).isNull(); | ||
| } | ||
|
|
||
| @Test | ||
| void shouldReportInvalidSyncCommittees() throws Exception { | ||
| final List<SubmitDataError> errors = List.of(new SubmitDataError(UInt64.ZERO, "Darn")); | ||
| request.setRequestBody(List.of(dataStructureUtil.randomSyncCommitteeMessage())); | ||
| when(validatorDataProvider.submitCommitteeSignatures(any())) | ||
| .thenReturn(SafeFuture.completedFuture(errors)); | ||
|
|
||
| handler.handleRequest(request); | ||
|
|
||
| assertThat(request.getResponseCode()).isEqualTo(SC_BAD_REQUEST); | ||
| assertThat(request.getResponseBody()).isEqualTo(errors); | ||
| } | ||
|
|
||
| @Test | ||
| void metadata_shouldHandle400_errorResponse() throws IOException { | ||
| List<SubmitDataError> responseData = | ||
| List.of( | ||
| new SubmitDataError(UInt64.ZERO, "Darn"), new SubmitDataError(UInt64.ONE, "Incorrect")); | ||
|
|
||
| final String data = | ||
| getResponseStringFromMetadata(handler, HttpStatusCodes.SC_BAD_REQUEST, responseData); | ||
| final String expected = | ||
| Resources.toString( | ||
| Resources.getResource(PostSyncCommitteesTest.class, "postSyncCommittees.json"), UTF_8); | ||
| AssertionsForClassTypes.assertThat(data).isEqualTo(expected); | ||
| } | ||
|
|
||
| @Test | ||
| void metadata_shouldHandle400() throws JsonProcessingException { | ||
| verifyMetadataErrorResponse(handler, SC_BAD_REQUEST); | ||
| } | ||
|
|
||
| @Test | ||
| void metadata_shouldHandle500() throws JsonProcessingException { | ||
| verifyMetadataErrorResponse(handler, SC_INTERNAL_SERVER_ERROR); | ||
| } | ||
|
|
||
| @Test | ||
| void metadata_shouldHandle200() throws IOException { | ||
| verifyMetadataEmptyResponse(handler, SC_OK); | ||
| } | ||
| } |
1 change: 1 addition & 0 deletions
1
...test/resources/tech/pegasys/teku/beaconrestapi/handlers/v1/beacon/postSyncCommittees.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 @@ | ||
| {"code":400,"message":"some failures","failures":[{"index":"0","message":"Darn"},{"index":"1","message":"Incorrect"}]} |
Oops, something went wrong.