feat(jsonrpc): jsonrpc set error resolver (#6369)

* JsonRpc:setTronErrorResolver

* fix: add resData.length check while throw JsonRpcInternalException

* add data field in TronException

* feat(api): rename JsonRpcErrorResolver, add unit test

* feat(api): add note and test

* feat(api): add JsonRpcException.java

* feat(api): remove logs and unnecessary test case

* feat(api): enhance estimateGas error handling to include data field

* refactor: optimize JsonRpcErrorResolver error data resolution

Author: 0xbigapple

common/src/main/java/org/tron/common/utils/ByteArray.java

@@ -14,7 +14,7 @@
 import org.apache.commons.lang3.ArrayUtils;
 import org.apache.commons.lang3.StringUtils;
 import org.bouncycastle.util.encoders.Hex;
-import org.tron.core.exception.JsonRpcInvalidParamsException;
+import org.tron.core.exception.jsonrpc.JsonRpcInvalidParamsException;
 
 /*
  * Copyright (c) [2016] [ <ether.camp> ]

common/src/main/java/org/tron/core/exception/jsonrpc/JsonRpcException.java

@@ -0,0 +1,32 @@
+package org.tron.core.exception.jsonrpc;
+
+import lombok.Getter;
+import org.tron.core.exception.TronException;
+
+@Getter
+public class JsonRpcException extends TronException {
+  private Object data = null;
+
+  public JsonRpcException() {
+    super();
+    report();
+  }
+
+  public JsonRpcException(String message, Object data) {
+    super(message);
+    this.data = data;
+    report();
+  }
+
+  public JsonRpcException(String message) {
+    super(message);
+    report();
+  }
+
+  public JsonRpcException(String message, Throwable cause) {
+    super(message, cause);
+    report();
+  }
+
+
+}

common/src/main/java/org/tron/core/exception/JsonRpcInternalException.java renamed to common/src/main/java/org/tron/core/exception/jsonrpc/JsonRpcInternalException.java

@@ -1,6 +1,6 @@
-package org.tron.core.exception;
+package org.tron.core.exception.jsonrpc;
 
-public class JsonRpcInternalException extends TronException {
+public class JsonRpcInternalException extends JsonRpcException {
 
   public JsonRpcInternalException() {
     super();
@@ -13,4 +13,8 @@ public JsonRpcInternalException(String message) {
   public JsonRpcInternalException(String message, Throwable cause) {
     super(message, cause);
   }
+
+  public JsonRpcInternalException(String message, Object data) {
+    super(message, data);
+  }
 }

common/src/main/java/org/tron/core/exception/JsonRpcInvalidParamsException.java renamed to common/src/main/java/org/tron/core/exception/jsonrpc/JsonRpcInvalidParamsException.java

@@ -1,6 +1,6 @@
-package org.tron.core.exception;
+package org.tron.core.exception.jsonrpc;
 
-public class JsonRpcInvalidParamsException extends TronException {
+public class JsonRpcInvalidParamsException extends JsonRpcException {
 
   public JsonRpcInvalidParamsException() {
     super();

common/src/main/java/org/tron/core/exception/JsonRpcInvalidRequestException.java renamed to common/src/main/java/org/tron/core/exception/jsonrpc/JsonRpcInvalidRequestException.java

@@ -1,6 +1,6 @@
-package org.tron.core.exception;
+package org.tron.core.exception.jsonrpc;
 
-public class JsonRpcInvalidRequestException extends TronException {
+public class JsonRpcInvalidRequestException extends JsonRpcException {
 
   public JsonRpcInvalidRequestException() {
     super();

common/src/main/java/org/tron/core/exception/JsonRpcMethodNotFoundException.java renamed to common/src/main/java/org/tron/core/exception/jsonrpc/JsonRpcMethodNotFoundException.java

@@ -1,6 +1,6 @@
-package org.tron.core.exception;
+package org.tron.core.exception.jsonrpc;
 
-public class JsonRpcMethodNotFoundException extends TronException {
+public class JsonRpcMethodNotFoundException extends JsonRpcException {
 
   public JsonRpcMethodNotFoundException() {
     super();

common/src/main/java/org/tron/core/exception/JsonRpcTooManyResultException.java renamed to common/src/main/java/org/tron/core/exception/jsonrpc/JsonRpcTooManyResultException.java

@@ -1,6 +1,6 @@
-package org.tron.core.exception;
+package org.tron.core.exception.jsonrpc;
 
-public class JsonRpcTooManyResultException extends TronException {
+public class JsonRpcTooManyResultException extends JsonRpcException {
 
   public JsonRpcTooManyResultException() {
     super();

framework/src/main/java/org/tron/core/Wallet.java

@@ -177,7 +177,6 @@
 import org.tron.core.exception.DupTransactionException;
 import org.tron.core.exception.HeaderNotFound;
 import org.tron.core.exception.ItemNotFoundException;
-import org.tron.core.exception.JsonRpcInvalidParamsException;
 import org.tron.core.exception.NonUniqueObjectException;
 import org.tron.core.exception.PermissionException;
 import org.tron.core.exception.SignatureFormatException;
@@ -188,6 +187,7 @@
 import org.tron.core.exception.VMIllegalException;
 import org.tron.core.exception.ValidateSignatureException;
 import org.tron.core.exception.ZksnarkException;
+import org.tron.core.exception.jsonrpc.JsonRpcInvalidParamsException;
 import org.tron.core.net.TronNetDelegate;
 import org.tron.core.net.TronNetService;
 import org.tron.core.net.message.adv.TransactionMessage;

framework/src/main/java/org/tron/core/services/jsonrpc/JsonRpcApiUtil.java

@@ -26,7 +26,7 @@
 import org.tron.common.utils.Sha256Hash;
 import org.tron.common.utils.StringUtil;
 import org.tron.core.Wallet;
-import org.tron.core.exception.JsonRpcInvalidParamsException;
+import org.tron.core.exception.jsonrpc.JsonRpcInvalidParamsException;
 import org.tron.protos.Protocol.Block;
 import org.tron.protos.Protocol.Transaction;
 import org.tron.protos.Protocol.Transaction.Contract.ContractType;

framework/src/main/java/org/tron/core/services/jsonrpc/JsonRpcErrorResolver.java

@@ -0,0 +1,81 @@
+package org.tron.core.services.jsonrpc;
+
+import com.fasterxml.jackson.databind.JsonNode;
+import com.googlecode.jsonrpc4j.ErrorData;
+import com.googlecode.jsonrpc4j.ErrorResolver;
+import com.googlecode.jsonrpc4j.JsonRpcError;
+import com.googlecode.jsonrpc4j.JsonRpcErrors;
+import com.googlecode.jsonrpc4j.ReflectionUtil;
+import java.lang.reflect.Method;
+import java.util.List;
+import org.tron.core.exception.jsonrpc.JsonRpcException;
+
+/**
+ * {@link ErrorResolver} that uses annotations.
+ */
+public enum JsonRpcErrorResolver implements ErrorResolver {
+  INSTANCE;
+
+  /**
+   * {@inheritDoc}
+   */
+  @Override
+  public JsonError resolveError(
+      Throwable thrownException, Method method, List<JsonNode> arguments) {
+    JsonRpcError resolver = getResolverForException(thrownException, method);
+    if (notFoundResolver(resolver)) {
+      return null;
+    }
+
+    String message = hasErrorMessage(resolver) ? resolver.message() : thrownException.getMessage();
+
+    // data priority: exception > annotation > default ErrorData
+    Object data = null;
+    if (thrownException instanceof JsonRpcException) {
+      JsonRpcException jsonRpcException = (JsonRpcException) thrownException;
+      data = jsonRpcException.getData();
+    }
+
+    if (data == null) {
+      data = hasErrorData(resolver)
+          ? resolver.data()
+          : new ErrorData(resolver.exception().getName(), message);
+    }
+    
+    return new JsonError(resolver.code(), message, data);
+  }
+
+  private JsonRpcError getResolverForException(Throwable thrownException, Method method) {
+    JsonRpcErrors errors = ReflectionUtil.getAnnotation(method, JsonRpcErrors.class);
+    if (hasAnnotations(errors)) {
+      for (JsonRpcError errorDefined : errors.value()) {
+        if (isExceptionInstanceOfError(thrownException, errorDefined)) {
+          return errorDefined;
+        }
+      }
+    }
+    return null;
+  }
+
+  private boolean notFoundResolver(JsonRpcError resolver) {
+    return resolver == null;
+  }
+
+  private boolean hasErrorMessage(JsonRpcError em) {
+    // noinspection ConstantConditions
+    return em.message() != null && !em.message().trim().isEmpty();
+  }
+
+  private boolean hasErrorData(JsonRpcError em) {
+    // noinspection ConstantConditions
+    return em.data() != null && !em.data().trim().isEmpty();
+  }
+
+  private boolean hasAnnotations(JsonRpcErrors errors) {
+    return errors != null;
+  }
+
+  private boolean isExceptionInstanceOfError(Throwable target, JsonRpcError em) {
+    return em.exception().isInstance(target);
+  }
+}