Refactor method order and add regions

Signed-off-by: Simon Dudley <[email protected]>

Author: siladu

ethereum/api/src/main/java/org/hyperledger/besu/ethereum/api/jsonrpc/internal/results/BlockResultFactory.java

@@ -39,6 +39,8 @@
 
 public class BlockResultFactory {
 
+  // region BlockResult
+
   public BlockResult transactionComplete(
       final BlockWithMetadata<TransactionWithMetadata, Hash> blockWithMetadata) {
     return transactionComplete(blockWithMetadata, false);
@@ -103,21 +105,44 @@ public BlockResult transactionComplete(final Block block) {
         block.getBody().getBlockAccessList());
   }
 
+  public BlockResult transactionHash(final BlockWithMetadata<Hash, Hash> blockWithMetadata) {
+    return transactionHash(blockWithMetadata, false);
+  }
+
+  public BlockResult transactionHash(
+      final BlockWithMetadata<Hash, Hash> blockWithMetadata, final boolean includeCoinbase) {
+    final List<TransactionResult> txs =
+        blockWithMetadata.getTransactions().stream()
+            .map(Hash::toString)
+            .map(TransactionHashResult::new)
+            .collect(Collectors.toList());
+    final List<JsonNode> ommers =
+        blockWithMetadata.getOmmers().stream()
+            .map(Hash::toString)
+            .map(TextNode::new)
+            .collect(Collectors.toList());
+    // TODO: Pass BAL once part of the block interface
+    return new BlockResult(
+        blockWithMetadata.getHeader(),
+        txs,
+        ommers,
+        blockWithMetadata.getTotalDifficulty(),
+        blockWithMetadata.getSize(),
+        includeCoinbase,
+        blockWithMetadata.getWithdrawals(),
+        Optional.empty());
+  }
+
+  // endregion BlockResult
+
+  // region EngineGetPayloadResult
+
   public EngineGetPayloadResultV1 payloadTransactionCompleteV1(final Block block) {
     final List<String> txs = txsAsHex(block);
 
     return new EngineGetPayloadResultV1(block.getHeader(), txs);
   }
 
-  private static List<String> txsAsHex(final Block block) {
-    return block.getBody().getTransactions().stream()
-        .map(
-            transaction ->
-                TransactionEncoder.encodeOpaqueBytes(transaction, EncodingContext.BLOCK_BODY))
-        .map(b -> HexUtils.toFastHex(b, true))
-        .collect(Collectors.toList());
-  }
-
   public EngineGetPayloadResultV2 payloadTransactionCompleteV2(final PayloadWrapper payload) {
     final var blockWithReceipts = payload.blockWithReceipts();
     final Block block = blockWithReceipts.getBlock();
@@ -130,15 +155,6 @@ public EngineGetPayloadResultV2 payloadTransactionCompleteV2(final PayloadWrappe
         Quantity.create(payload.blockValue()));
   }
 
-  public EngineGetPayloadBodiesResultV1 payloadBodiesCompleteV1(
-      final List<Optional<BlockBody>> blockBodies) {
-    final List<PayloadBody> payloadBodies =
-        blockBodies.stream()
-            .map(maybeBody -> maybeBody.map(PayloadBody::new).orElse(null))
-            .collect(Collectors.toList());
-    return new EngineGetPayloadBodiesResultV1(payloadBodies);
-  }
-
   public EngineGetPayloadResultV3 payloadTransactionCompleteV3(final PayloadWrapper payload) {
     final var blockWithReceipts = payload.blockWithReceipts();
     final List<String> txs = txsAsHex(blockWithReceipts.getBlock());
@@ -169,19 +185,6 @@ public EngineGetPayloadResultV4 payloadTransactionCompleteV4(final PayloadWrappe
         blobsBundleV1);
   }
 
-  private static Optional<List<String>> requestsAsHex(final PayloadWrapper payload) {
-    return payload
-        .requests()
-        .map(
-            rqs ->
-                rqs.stream()
-                    .sorted(Comparator.comparing(Request::getType))
-                    .filter(r -> !r.getData().isEmpty())
-                    .map(Request::getEncodedRequest)
-                    .map(b -> HexUtils.toFastHex(b, true))
-                    .toList());
-  }
-
   public EngineGetPayloadResultV5 payloadTransactionCompleteV5(final PayloadWrapper payload) {
     final var blockWithReceipts = payload.blockWithReceipts();
     final List<String> txs = txsAsHex(blockWithReceipts.getBlock());
@@ -229,31 +232,40 @@ public EngineGetPayloadResultV6 payloadTransactionCompleteV6(final PayloadWrappe
         blockAccessList);
   }
 
-  public BlockResult transactionHash(final BlockWithMetadata<Hash, Hash> blockWithMetadata) {
-    return transactionHash(blockWithMetadata, false);
+  private static List<String> txsAsHex(final Block block) {
+    return block.getBody().getTransactions().stream()
+        .map(
+            transaction ->
+                TransactionEncoder.encodeOpaqueBytes(transaction, EncodingContext.BLOCK_BODY))
+        .map(b -> HexUtils.toFastHex(b, true))
+        .collect(Collectors.toList());
   }
 
-  public BlockResult transactionHash(
-      final BlockWithMetadata<Hash, Hash> blockWithMetadata, final boolean includeCoinbase) {
-    final List<TransactionResult> txs =
-        blockWithMetadata.getTransactions().stream()
-            .map(Hash::toString)
-            .map(TransactionHashResult::new)
-            .collect(Collectors.toList());
-    final List<JsonNode> ommers =
-        blockWithMetadata.getOmmers().stream()
-            .map(Hash::toString)
-            .map(TextNode::new)
+  private static Optional<List<String>> requestsAsHex(final PayloadWrapper payload) {
+    return payload
+        .requests()
+        .map(
+            rqs ->
+                rqs.stream()
+                    .sorted(Comparator.comparing(Request::getType))
+                    .filter(r -> !r.getData().isEmpty())
+                    .map(Request::getEncodedRequest)
+                    .map(b -> HexUtils.toFastHex(b, true))
+                    .toList());
+  }
+
+  // endregion EngineGetPayloadResult
+
+  // region EngineGetPayloadBodiesResult
+
+  public EngineGetPayloadBodiesResultV1 payloadBodiesCompleteV1(
+      final List<Optional<BlockBody>> blockBodies) {
+    final List<PayloadBody> payloadBodies =
+        blockBodies.stream()
+            .map(maybeBody -> maybeBody.map(PayloadBody::new).orElse(null))
             .collect(Collectors.toList());
-    // TODO: Pass BAL once part of the block interface
-    return new BlockResult(
-        blockWithMetadata.getHeader(),
-        txs,
-        ommers,
-        blockWithMetadata.getTotalDifficulty(),
-        blockWithMetadata.getSize(),
-        includeCoinbase,
-        blockWithMetadata.getWithdrawals(),
-        Optional.empty());
+    return new EngineGetPayloadBodiesResultV1(payloadBodies);
   }
+
+  // endregion EngineGetPayloadBodiesResult
 }