Merge pull request #4642 from tronprotocol/feature/graph_jsonrpc

waynercheung · web-flow · commit 63c268d514c6 · 2022-09-15T19:06:45.000+08:00
feat: optimize default values for jsonrpc api results
diff --git a/framework/src/main/java/org/tron/core/services/jsonrpc/TronJsonRpc.java b/framework/src/main/java/org/tron/core/services/jsonrpc/TronJsonRpc.java
@@ -152,7 +152,7 @@ TransactionResult getTransactionByBlockNumberAndIndex(String blockNumOrTag, Stri
       @JsonRpcError(exception = JsonRpcInvalidParamsException.class, code = -32602, data = "{}"),
       @JsonRpcError(exception = JsonRpcInternalException.class, code = -32000, data = "{}"),
   })
-  String getCall(CallArguments transactionCall, String blockNumOrTag)
+  String getCall(CallArguments transactionCall, Object blockNumOrTag)
       throws JsonRpcInvalidParamsException, JsonRpcInvalidRequestException,
       JsonRpcInternalException;
 
diff --git a/framework/src/main/java/org/tron/core/services/jsonrpc/TronJsonRpcImpl.java b/framework/src/main/java/org/tron/core/services/jsonrpc/TronJsonRpcImpl.java
@@ -14,6 +14,7 @@
 import com.google.protobuf.ByteString;
 import com.google.protobuf.GeneratedMessageV3;
 import java.util.Arrays;
+import java.util.HashMap;
 import java.util.Iterator;
 import java.util.List;
 import java.util.Map;
@@ -134,6 +135,8 @@ public enum RequestSource {
   private static final String TAG_NOT_SUPPORT_ERROR = "TAG [earliest | pending] not supported";
   private static final String QUANTITY_NOT_SUPPORT_ERROR =
       "QUANTITY not supported, just support TAG as latest";
+  private static final String NO_BLOCK_HEADER = "header not found";
+  private static final String NO_BLOCK_HEADER_BY_HASH = "header for hash not found";
 
   private static final String ERROR_SELECTOR = "08c379a0"; // Function selector for Error(string)
   /**
@@ -716,9 +719,54 @@ public TransactionReceipt getTransactionReceipt(String txId)
   }
 
   @Override
-  public String getCall(CallArguments transactionCall, String blockNumOrTag)
+  public String getCall(CallArguments transactionCall, Object blockParamObj)
       throws JsonRpcInvalidParamsException, JsonRpcInvalidRequestException,
       JsonRpcInternalException {
+
+    String blockNumOrTag;
+    if (blockParamObj instanceof HashMap) {
+      HashMap<String, String> paramMap;
+      paramMap = (HashMap<String, String>) blockParamObj;
+
+      if (paramMap.containsKey("blockNumber")) {
+        try {
+          blockNumOrTag = paramMap.get("blockNumber");
+        } catch (ClassCastException e) {
+          throw new JsonRpcInvalidRequestException(JSON_ERROR);
+        }
+
+        long blockNumber;
+        try {
+          blockNumber = ByteArray.hexToBigInteger(blockNumOrTag).longValue();
+        } catch (Exception e) {
+          throw new JsonRpcInvalidParamsException(BLOCK_NUM_ERROR);
+        }
+
+        if (wallet.getBlockByNum(blockNumber) == null) {
+          throw new JsonRpcInternalException(NO_BLOCK_HEADER);
+        }
+
+      } else if (paramMap.containsKey("blockHash")) {
+        try {
+          blockNumOrTag = paramMap.get("blockHash");
+        } catch (ClassCastException e) {
+          throw new JsonRpcInvalidRequestException(JSON_ERROR);
+        }
+
+        if (getBlockByJsonHash(blockNumOrTag) == null) {
+          throw new JsonRpcInternalException(NO_BLOCK_HEADER_BY_HASH);
+        }
+      } else {
+        throw new JsonRpcInvalidRequestException(JSON_ERROR);
+      }
+
+      blockNumOrTag = LATEST_STR;
+    } else if (blockParamObj instanceof String) {
+      blockNumOrTag = (String) blockParamObj;
+    } else {
+      throw new JsonRpcInvalidRequestException(JSON_ERROR);
+    }
+
     if (EARLIEST_STR.equalsIgnoreCase(blockNumOrTag)
         || PENDING_STR.equalsIgnoreCase(blockNumOrTag)) {
       throw new JsonRpcInvalidParamsException(TAG_NOT_SUPPORT_ERROR);
diff --git a/framework/src/main/java/org/tron/core/services/jsonrpc/types/BlockResult.java b/framework/src/main/java/org/tron/core/services/jsonrpc/types/BlockResult.java
@@ -79,10 +79,10 @@ public class BlockResult {
 
   @Getter
   @Setter
-  private String baseFeePerGas = null;
+  private String baseFeePerGas = "0x0";
   @Getter
   @Setter
-  private String mixHash = null;
+  private String mixHash = ByteArray.toJsonHex(new byte[32]);
 
   public BlockResult(Block block, boolean fullTx, Wallet wallet) {
     BlockCapsule blockCapsule = new BlockCapsule(block);
@@ -91,20 +91,25 @@ public BlockResult(Block block, boolean fullTx, Wallet wallet) {
     hash = ByteArray.toJsonHex(blockCapsule.getBlockId().getBytes());
     parentHash =
         ByteArray.toJsonHex(block.getBlockHeader().getRawData().getParentHash().toByteArray());
-    nonce = null; // no value
-    sha3Uncles = null; // no value
+    nonce = ByteArray.toJsonHex(new byte[8]); // no value
+    sha3Uncles = ByteArray.toJsonHex(new byte[32]); // no value
     logsBloom = ByteArray.toJsonHex(new byte[256]); // no value
     transactionsRoot = ByteArray
         .toJsonHex(block.getBlockHeader().getRawData().getTxTrieRoot().toByteArray());
-    stateRoot = ByteArray
-        .toJsonHex(block.getBlockHeader().getRawData().getAccountStateRoot().toByteArray());
-    receiptsRoot = null; // no value
-    miner = ByteArray.toJsonHexAddress(blockCapsule.getWitnessAddress().toByteArray());
-    difficulty = null; // no value
-    totalDifficulty = null; // no value
-    extraData = null; // no value
+    stateRoot = ByteArray.toJsonHex(new byte[32]);
+    receiptsRoot = ByteArray.toJsonHex(new byte[32]); // no value
+
+    if (blockCapsule.getNum() == 0) {
+      miner = ByteArray.toJsonHex(new byte[20]);
+    } else {
+      miner = ByteArray.toJsonHexAddress(blockCapsule.getWitnessAddress().toByteArray());
+    }
+
+    difficulty = "0x0"; // no value
+    totalDifficulty = "0x0"; // no value
+    extraData = "0x"; // no value
     size = ByteArray.toJsonHex(block.getSerializedSize());
-    timestamp = ByteArray.toJsonHex(blockCapsule.getTimeStamp());
+    timestamp = ByteArray.toJsonHex(blockCapsule.getTimeStamp() / 1000);
 
     long gasUsedInBlock = 0;
     long gasLimitInBlock = 0;
diff --git a/framework/src/main/java/org/tron/core/services/jsonrpc/types/TransactionResult.java b/framework/src/main/java/org/tron/core/services/jsonrpc/types/TransactionResult.java
@@ -15,6 +15,8 @@
 import org.tron.protos.Protocol;
 import org.tron.protos.Protocol.Transaction;
 import org.tron.protos.Protocol.Transaction.Contract;
+import org.tron.protos.Protocol.Transaction.Contract.ContractType;
+import org.tron.protos.contract.SmartContractOuterClass.TriggerSmartContract;
 
 @JsonPropertyOrder(alphabetic = true)
 @ToString
@@ -56,9 +58,9 @@ public class TransactionResult {
   private void parseSignature(Transaction tx) {
 
     if (tx.getSignatureCount() == 0) {
-      v = null;
-      r = null;
-      s = null;
+      v = ByteArray.toJsonHex(new byte[1]);
+      r = ByteArray.toJsonHex(new byte[32]);
+      s = ByteArray.toJsonHex(new byte[32]);
       return;
     }
 
@@ -75,12 +77,34 @@ private void parseSignature(Transaction tx) {
     s = ByteArray.toJsonHex(sByte);
   }
 
+  private String parseInput(Transaction tx) {
+    String data;
+    if (tx.getRawData().getContractCount() == 0) {
+      data = "0x";
+    } else {
+      Contract contract = tx.getRawData().getContract(0);
+      if (contract.getType() == ContractType.TriggerSmartContract) {
+        try {
+          TriggerSmartContract triggerSmartContract = contract.getParameter()
+              .unpack(TriggerSmartContract.class);
+          data = ByteArray.toJsonHex(triggerSmartContract.getData().toByteArray());
+        } catch (Exception e) {
+          data = "0x";
+        }
+      } else {
+        data = "0x";
+      }
+    }
+
+    return data;
+  }
+
   public TransactionResult(BlockCapsule blockCapsule, int index, Protocol.Transaction tx,
       long energyUsageTotal, long energyFee, Wallet wallet) {
     TransactionCapsule capsule = new TransactionCapsule(tx);
     byte[] txId = capsule.getTransactionId().getBytes();
     hash = ByteArray.toJsonHex(txId);
-    nonce = null; // no value
+    nonce = ByteArray.toJsonHex(new byte[8]); // no value
     blockHash = ByteArray.toJsonHex(blockCapsule.getBlockId().getBytes());
     blockNumber = ByteArray.toJsonHex(blockCapsule.getNum());
     transactionIndex = ByteArray.toJsonHex(index);
@@ -89,18 +113,24 @@ public TransactionResult(BlockCapsule blockCapsule, int index, Protocol.Transact
       Contract contract = tx.getRawData().getContract(0);
       byte[] fromByte = capsule.getOwnerAddress();
       byte[] toByte = getToAddress(tx);
-      from = ByteArray.toJsonHexAddress(fromByte);
+
+      if (blockCapsule.getNum() == 0) {
+        from = ByteArray.toJsonHex(new byte[20]);
+      } else {
+        from = ByteArray.toJsonHexAddress(fromByte);
+      }
+
       to = ByteArray.toJsonHexAddress(toByte);
       value = ByteArray.toJsonHex(getTransactionAmount(contract, hash, wallet));
     } else {
-      from = null;
-      to = null;
-      value = null;
+      from = ByteArray.toJsonHex(new byte[20]);
+      to = ByteArray.toJsonHex(new byte[20]);
+      value = "0x0";
     }
 
     gas = ByteArray.toJsonHex(energyUsageTotal);
     gasPrice = ByteArray.toJsonHex(energyFee);
-    input = ByteArray.toJsonHex(tx.getRawData().getData().toByteArray());
+    input = parseInput(tx);
 
     parseSignature(tx);
   }
@@ -109,7 +139,7 @@ public TransactionResult(Transaction tx, Wallet wallet) {
     TransactionCapsule capsule = new TransactionCapsule(tx);
     byte[] txid = capsule.getTransactionId().getBytes();
     hash = ByteArray.toJsonHex(txid);
-    nonce = null; // no value
+    nonce = ByteArray.toJsonHex(new byte[8]); // no value
     blockHash = "0x";
     blockNumber = "0x";
     transactionIndex = "0x";
@@ -122,14 +152,14 @@ public TransactionResult(Transaction tx, Wallet wallet) {
       to = ByteArray.toJsonHexAddress(toByte);
       value = ByteArray.toJsonHex(getTransactionAmount(contract, hash, wallet));
     } else {
-      from = null;
-      to = null;
-      value = null;
+      from = ByteArray.toJsonHex(new byte[20]);
+      to = ByteArray.toJsonHex(new byte[20]);
+      value = "0x0";
     }
 
     gas = "0x0";
     gasPrice = "0x";
-    input = ByteArray.toJsonHex(tx.getRawData().getData().toByteArray());
+    input = parseInput(tx);
 
     parseSignature(tx);
   }
diff --git a/framework/src/test/java/org/tron/core/jsonrpc/JsonrpcServiceTest.java b/framework/src/test/java/org/tron/core/jsonrpc/JsonrpcServiceTest.java
@@ -1,6 +1,5 @@
 package org.tron.core.jsonrpc;
 
-import com.google.protobuf.Any;
 import com.google.protobuf.ByteString;
 import java.io.File;
 import lombok.extern.slf4j.Slf4j;
@@ -230,8 +229,7 @@ public void testGetBlockByNumber() {
     Assert.assertEquals(ByteArray.toJsonHex(blockCapsule.getNum()), blockResult.getNumber());
     Assert
         .assertEquals(blockCapsule.getTransactions().size(), blockResult.getTransactions().length);
-    Assert.assertNull(blockResult.getNonce());
-
+    Assert.assertEquals("0x0000000000000000", blockResult.getNonce());
   }
 
 
