fix: comments

optimism-java · Dec 16, 2023 · 6c1b32c · 6c1b32c
1 parent 0d2eec1
commit 6c1b32c
Show file tree

Hide file tree

Showing 3 changed files with 24 additions and 3 deletions.
diff --git a/hildr-node/src/main/java/io/optimism/engine/Engine.java b/hildr-node/src/main/java/io/optimism/engine/Engine.java
@@ -80,14 +80,13 @@ OpEthForkChoiceUpdate forkchoiceUpdated(ForkchoiceState forkchoiceState, Payload
      * <p>Specification method: engine_getPayloadV2 params: - [PayloadId]: DATA, 8 Bytes - Identifier
      * of the payload build process timeout: 1s returns: - [ExecutionPayload] potential errors: - code
      * and message set in case an exception happens while getting the payload. Refer to <a
-     * href="https://github.com/ethereum-optimism/optimism/blob/develop/specs/exec-engine.md#engine_getpayloadv2">Optimism
-     * Specs</a>
+     *     href="https://github.com/ethereum-optimism/optimism/blob/develop/specs/exec-engine.md#engine_getpayloadv2">Optimism Specs</a>
      *
      * @param payloadId the payload id
      * @return the payload v2
      * @throws IOException the io exception
      * @see <a
-     *     href="https://github.com/ethereum/execution-apis/blob/main/src/engine/shanghai.md#engine_getpayloadv2</a>
+     *     href="https://github.com/ethereum/execution-apis/blob/main/src/engine/shanghai.md#engine_getpayloadv2"></a>
      */
     OpEthExecutionPayload getPayloadV2(BigInteger payloadId) throws IOException;
 }
diff --git a/hildr-node/src/main/java/io/optimism/engine/ExecutionPayload.java b/hildr-node/src/main/java/io/optimism/engine/ExecutionPayload.java
@@ -197,6 +197,7 @@ public static ExecutionPayload from(ExecutionPayloadSSZ payload) {
      * @param extraData 0 to 32 byte value for extra data.
      * @param baseFeePerGas 256 bits for the base fee per gas.
      * @param blockHash The 32 byte block hash.
+     * @param withdrawals The withdrawals list.
      * @param transactions An array of transaction objects where each object is a byte list.
      */
     public record ExecutionPayloadReq(

diff --git a/hildr-node/src/main/java/io/optimism/engine/OpEthExecutionPayload.java b/hildr-node/src/main/java/io/optimism/engine/OpEthExecutionPayload.java
@@ -53,20 +53,41 @@ public void setResult(ExecutionPayloadObj result) {
         super.setResult(result);
     }
 
+    /**
+     * The type Execution payload obj.
+     * @since 0.2.6
+     */
     public static class ExecutionPayloadObj {
 
+        /** The Execution payload result. */
         private ExecutionPayload.ExecutionPayloadRes executionPayload;
 
+        /** Instantiates a new Execution payload obj. */
         public ExecutionPayloadObj() {}
 
+        /**
+         * Instantiates a new Execution payload obj.
+         *
+         * @param executionPayload the execution payload result
+         */
         public ExecutionPayloadObj(ExecutionPayload.ExecutionPayloadRes executionPayload) {
             this.executionPayload = executionPayload;
         }
 
+        /**
+         * Gets execution payload result.
+         *
+         * @return the execution payload result
+         */
         public ExecutionPayload.ExecutionPayloadRes getExecutionPayload() {
             return executionPayload;
         }
 
+        /**
+         * Sets execution payload.
+         *
+         * @param executionPayload the execution payload result
+         */
         public void setExecutionPayload(ExecutionPayload.ExecutionPayloadRes executionPayload) {
             this.executionPayload = executionPayload;
         }