chore: code comments improvements

cardano-foundation · Nov 14, 2023 · e3e4e8b · e3e4e8b
1 parent 6c10c26
commit e3e4e8b
Show file tree

Hide file tree

Showing 6 changed files with 12 additions and 13 deletions.
diff --git a/...src/main/java/org/cardano/foundation/voting/resource/DiscordUserVerificationResource.java b/...src/main/java/org/cardano/foundation/voting/resource/DiscordUserVerificationResource.java
@@ -58,7 +58,7 @@ public class DiscordUserVerificationResource {
                                             schema = @Schema(implementation = Problem.class))
                             }
                     ),
-                    @ApiResponse(responseCode = "500", description = "Server error")
+                    @ApiResponse(responseCode = "500", description = "Internal server error")
             }
     )
     public ResponseEntity<?> isDiscordUserVerified(@PathVariable("discordIdHash") String discordIdHash) {
@@ -99,7 +99,7 @@ public ResponseEntity<?> isDiscordUserVerified(@PathVariable("discordIdHash") St
                                             schema = @Schema(implementation = Problem.class))
                             }
                     ),
-                    @ApiResponse(responseCode = "500", description = "Server error")
+                    @ApiResponse(responseCode = "500", description = "Internal server error")
             }
     )
     public ResponseEntity<?> startVerification(@RequestBody @Valid DiscordStartVerificationRequest startVerificationRequest) {
@@ -136,7 +136,7 @@ public ResponseEntity<?> startVerification(@RequestBody @Valid DiscordStartVerif
                                             schema = @Schema(implementation = Problem.class))
                             }
                     ),
-                    @ApiResponse(responseCode = "500", description = "Server error")
+                    @ApiResponse(responseCode = "500", description = "Internal server error")
             }
     )
     public ResponseEntity<?> checkVerification(@RequestBody @Valid DiscordCheckVerificationRequest checkVerificationRequest) {

diff --git a/...ice/src/main/java/org/cardano/foundation/voting/resource/SMSUserVerificationResource.java b/...ice/src/main/java/org/cardano/foundation/voting/resource/SMSUserVerificationResource.java
@@ -54,7 +54,7 @@ public class SMSUserVerificationResource {
                                             schema = @Schema(implementation = Problem.class))
                             }
                     ),
-                    @ApiResponse(responseCode = "500", description = "Server error")
+                    @ApiResponse(responseCode = "500", description = "Internal server error")
             }
     )
     public ResponseEntity<?> startVerification(@RequestBody @Valid SMSStartVerificationRequest startVerificationRequest) {
@@ -90,13 +90,13 @@ public ResponseEntity<?> startVerification(@RequestBody @Valid SMSStartVerificat
                     ),
                     @ApiResponse(
                             responseCode = "400",
-                            description = "Bad request, possibly due to an invalid checkVerificationRequest.",
+                            description = "Bad request, possibly due to an invalid SMS code in the check verification request.",
                             content = {
                                     @Content(mediaType = "application/json",
                                             schema = @Schema(implementation = Problem.class))
                             }
                     ),
-                    @ApiResponse(responseCode = "500", description = "Server error")
+                    @ApiResponse(responseCode = "500", description = "Internal server error")
             }
     )
     public ResponseEntity<?> checkVerification(@RequestBody @Valid SMSCheckVerificationRequest checkVerificationRequest) {

diff --git a/...ervice/src/main/java/org/cardano/foundation/voting/resource/UserVerificationResource.java b/...ervice/src/main/java/org/cardano/foundation/voting/resource/UserVerificationResource.java
@@ -50,7 +50,7 @@ public class UserVerificationResource {
                                             schema = @Schema(implementation = Problem.class))
                             }
                     ),
-                    @ApiResponse(responseCode = "500", description = "Server error")
+                    @ApiResponse(responseCode = "500", description = "Internal server error")
             }
     )
     public ResponseEntity<?> isVerified(@PathVariable("eventId") String eventId,

diff --git a/...es/vote-commitment-app/src/main/java/org/cardano/foundation/voting/VoteCommitmentApp.java b/...es/vote-commitment-app/src/main/java/org/cardano/foundation/voting/VoteCommitmentApp.java
@@ -1,12 +1,10 @@
 package org.cardano.foundation.voting;
 
 import com.bloxbean.cardano.client.backend.blockfrost.service.http.*;
-import com.bloxbean.cardano.client.backend.model.TransactionContent;
 import io.micrometer.core.aop.TimedAspect;
 import lombok.SneakyThrows;
 import lombok.extern.slf4j.Slf4j;
 import org.aspectj.lang.ProceedingJoinPoint;
-import org.springframework.aot.hint.ExecutableMode;
 import org.springframework.aot.hint.RuntimeHints;
 import org.springframework.aot.hint.RuntimeHintsRegistrar;
 import org.springframework.boot.CommandLineRunner;

diff --git a/...rc/main/java/org/cardano/foundation/voting/service/merkle_tree/VoteCommitmentService.java b/...rc/main/java/org/cardano/foundation/voting/service/merkle_tree/VoteCommitmentService.java
@@ -98,6 +98,7 @@ private List<L1MerkleCommitment> getValidL1MerkleCommitments() {
         var allFinishedEventsWithClosedCommitmentWindow = allFinishedEventsWithClosedCommitmentWindowE.get();
 
         List<ChainFollowerClient.EventSummary> eventsToProcess2 = allFinishedEventsWithClosedCommitmentWindow.stream()
+                // if we find at least one vote merkle proof which is not validated
                 .filter(eventSummary -> !voteMerkleProofService.findTop1InvalidatedByEventId(eventSummary.id()).isEmpty())
                 .toList();
 

diff --git a/...mitment-app/src/main/java/org/cardano/foundation/voting/service/yaci/RollbackHandler.java b/...mitment-app/src/main/java/org/cardano/foundation/voting/service/yaci/RollbackHandler.java
@@ -82,7 +82,7 @@ public void onBlock(Era era, Block block, List<Transaction> transactions) {
 
             @Override
             public void onRollback(Point point) {
-                Either<Problem, List<ChainFollowerClient.EventSummary>> allCommitmentWindowOpenEventsE = chainFollowerClient.findAllCommitmentWindowOpenEvents();
+                var allCommitmentWindowOpenEventsE = chainFollowerClient.findAllCommitmentWindowOpenEvents();
 
                 if (allCommitmentWindowOpenEventsE.isEmpty()) {
                     var issue = allCommitmentWindowOpenEventsE.swap().get();
@@ -91,17 +91,17 @@ public void onRollback(Point point) {
                     return;
                 }
 
-                List<ChainFollowerClient.EventSummary> allCommitmentWindowOpenEvents = allCommitmentWindowOpenEventsE.get();
+                var allCommitmentWindowOpenEvents = allCommitmentWindowOpenEventsE.get();
 
                 if (allCommitmentWindowOpenEvents.isEmpty()) {
                     log.info("No commitment window open events found. Skipping rollback handler...");
 
                     return;
                 }
 
-                long absoluteSlot = point.getSlot();
+                var absoluteSlot = point.getSlot();
 
-                for (ChainFollowerClient.EventSummary eventSummary : allCommitmentWindowOpenEvents) {
+                for (var eventSummary : allCommitmentWindowOpenEvents) {
                     String eventId = eventSummary.id();
 
                     log.info("Processing rollback for eventId: {}, absoluteSlot: {}", eventId, absoluteSlot);