bitcoin/json/conversion: add comments and TODOs

ConsensusJ · Jul 26, 2023 · 34f8e1c · 34f8e1c
1 parent 47689a0
commit 34f8e1c
Show file tree

Hide file tree

Showing 4 changed files with 8 additions and 4 deletions.
diff --git a/cj-btc-json/src/main/java/org/consensusj/bitcoin/json/conversion/BlockHexDeserializer.java b/cj-btc-json/src/main/java/org/consensusj/bitcoin/json/conversion/BlockHexDeserializer.java
@@ -14,8 +14,9 @@
 import java.io.IOException;
 import java.nio.ByteBuffer;
 
+// TODO: In (planned) bitcoinj 0.17-alpha2 Network/NetworkParameters is no longer needed to construct blocks
 /**
- *
+ * Deserializes a hex string as a Bitcoin {@link Block}
  */
 public class BlockHexDeserializer extends JsonDeserializer<Block> {
     private final NetworkParameters netParams;
@@ -36,6 +37,7 @@ public Block deserialize(JsonParser p, DeserializationContext ctxt) throws IOExc
             case VALUE_STRING:
                 try {
                     byte[] payload = HexUtil.hexStringToByteArray(p.getValueAsString()); // convert  to hex
+                    // TODO: return Block.read(ByteBuffer.wrap(payload));
                     return netParams.getDefaultSerializer().makeBlock(ByteBuffer.wrap(payload));
                 } catch (ProtocolException e) {
                     throw new InvalidFormatException(p, "Invalid Block", p.getValueAsString(), Block.class);

diff --git a/cj-btc-json/src/main/java/org/consensusj/bitcoin/json/conversion/RpcClientModule.java b/cj-btc-json/src/main/java/org/consensusj/bitcoin/json/conversion/RpcClientModule.java
@@ -10,8 +10,10 @@
 import org.bitcoinj.base.Sha256Hash;
 import org.bitcoinj.core.Transaction;
 
+// TODO: In (planned) bitcoinj 0.17-alpha2 Network/NetworkParameters is no longer needed to construct this class
+// TODO: After bitcoinj 0.17-alpha2 maybe merge RpcClientModule and RpcServerModule (though there are currently conflicting serializers for Transaction)
 /**
- *
+ * Jackson Module with serializers and deserializers for JSON-RPC clients.
  */
 public class RpcClientModule extends SimpleModule {
     /**

diff --git a/cj-btc-json/src/main/java/org/consensusj/bitcoin/json/conversion/RpcServerModule.java b/cj-btc-json/src/main/java/org/consensusj/bitcoin/json/conversion/RpcServerModule.java
@@ -12,7 +12,7 @@
 import org.bitcoinj.script.Script;
 
 /**
- *
+ * Jackson Module with serializers and deserializers for JSON-RPC servers.
  */
 public class RpcServerModule extends SimpleModule {
     public RpcServerModule() {

diff --git a/...c-json/src/main/java/org/consensusj/bitcoin/json/conversion/TransactionHexSerializer.java b/...c-json/src/main/java/org/consensusj/bitcoin/json/conversion/TransactionHexSerializer.java
@@ -9,7 +9,7 @@
 import java.io.IOException;
 
 /**
- *
+ * Serialize a transaction as a hex-encoded binary string.
  */
 public class TransactionHexSerializer extends JsonSerializer<Transaction> {
     @Override