fix serialize ABIDefinition with fallback failed && support (#302)

cyjseagull · web-flow · commit 874a00b776fd · 2021-04-20T10:11:47.000+08:00
fallback/receive functions
diff --git a/sdk-abi/src/main/java/org/fisco/bcos/sdk/abi/wrapper/ABIDefinition.java b/sdk-abi/src/main/java/org/fisco/bcos/sdk/abi/wrapper/ABIDefinition.java
@@ -1,5 +1,7 @@
 package org.fisco.bcos.sdk.abi.wrapper;
 
+import com.fasterxml.jackson.annotation.JsonIgnoreProperties;
+import com.fasterxml.jackson.annotation.JsonProperty;
 import java.util.ArrayList;
 import java.util.Arrays;
 import java.util.List;
@@ -26,16 +28,38 @@
  * blockchain state), view (specified to not modify the blockchain state), nonpayable (function does
  * not accept Ether - the default) and payable (function accepts Ether). <br>
  */
+@JsonIgnoreProperties(ignoreUnknown = true)
 public class ABIDefinition {
+    public static final String CONSTRUCTOR_TYPE = "constructor";
+    public static final String FUNCTION_TYPE = "function";
+    public static final String EVENT_TYPE = "event";
+    public static final String FALLBACK_TYPE = "fallback";
+    public static final String RECEIVE_TYPE = "receive";
+
+    @JsonProperty("name")
     private String name;
+
+    @JsonProperty("type")
     private String type;
+
+    @JsonProperty("constant")
     private boolean constant;
+
+    @JsonProperty("payable")
     private boolean payable;
+
+    @JsonProperty("anonymous")
     private boolean anonymous;
+
+    @JsonProperty("stateMutability")
     private String stateMutability;
 
+    @JsonProperty("inputs")
     private List<NamedType> inputs;
+
+    @JsonProperty("outputs")
     private List<NamedType> outputs;
+
     public static List<String> CONSTANT_KEY = Arrays.asList("view");
 
     public ABIDefinition() {}
@@ -94,14 +118,19 @@ public static ABIDefinition createDefaultConstructorABIDefinition() {
      */
     public String getMethodSignatureAsString() {
         StringBuilder result = new StringBuilder();
-        result.append(name);
+        // Fix: the name field of the fallback is empty
+        if (name != null) {
+            result.append(name);
+        }
         result.append("(");
-        String params =
-                getInputs()
-                        .stream()
-                        .map(abi -> abi.getTypeAsString())
-                        .collect(Collectors.joining(","));
-        result.append(params);
+        if (getInputs() != null) {
+            String params =
+                    getInputs()
+                            .stream()
+                            .map(abi -> abi.getTypeAsString())
+                            .collect(Collectors.joining(","));
+            result.append(params);
+        }
         result.append(")");
         return result.toString();
     }
@@ -113,8 +142,11 @@ public String getMethodSignatureAsString() {
      * @return the method id
      */
     public String getMethodId(CryptoSuite cryptoSuite) {
-        FunctionEncoder encoder = new FunctionEncoder(cryptoSuite);
-        return encoder.buildMethodId(getMethodSignatureAsString());
+        if (getType().equals(ABIDefinition.FUNCTION_TYPE)) {
+            FunctionEncoder encoder = new FunctionEncoder(cryptoSuite);
+            return encoder.buildMethodId(getMethodSignatureAsString());
+        }
+        return "";
     }
 
     public boolean isConstant() {
diff --git a/sdk-abi/src/main/java/org/fisco/bcos/sdk/abi/wrapper/ABIDefinitionFactory.java b/sdk-abi/src/main/java/org/fisco/bcos/sdk/abi/wrapper/ABIDefinitionFactory.java
@@ -1,12 +1,12 @@
 package org.fisco.bcos.sdk.abi.wrapper;
 
+import org.fisco.bcos.sdk.abi.ABICodecException;
 import org.fisco.bcos.sdk.crypto.CryptoSuite;
 import org.fisco.bcos.sdk.utils.ObjectMapperFactory;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 
 public class ABIDefinitionFactory {
-
     private static final Logger logger = LoggerFactory.getLogger(ABIDefinitionFactory.class);
 
     private CryptoSuite cryptoSuite;
@@ -28,12 +28,27 @@ public ContractABIDefinition loadABI(String abi) {
 
             ContractABIDefinition contractABIDefinition = new ContractABIDefinition(cryptoSuite);
             for (ABIDefinition abiDefinition : abiDefinitions) {
-                if (abiDefinition.getType().equals("constructor")) {
+                if (abiDefinition.getType().equals(ABIDefinition.CONSTRUCTOR_TYPE)) {
                     contractABIDefinition.setConstructor(abiDefinition);
-                } else if (abiDefinition.getType().equals("function")) {
+                } else if (abiDefinition.getType().equals(ABIDefinition.FUNCTION_TYPE)) {
                     contractABIDefinition.addFunction(abiDefinition.getName(), abiDefinition);
-                } else if (abiDefinition.getType().equals("event")) {
+                } else if (abiDefinition.getType().equals(ABIDefinition.EVENT_TYPE)) {
                     contractABIDefinition.addEvent(abiDefinition.getName(), abiDefinition);
+                } else if (abiDefinition.getType().equals(ABIDefinition.FALLBACK_TYPE)) {
+                    if (contractABIDefinition.hasFallbackFunction()) {
+                        throw new ABICodecException("only single fallback is allowed");
+                    }
+                    contractABIDefinition.setFallbackFunction(abiDefinition);
+                } else if (abiDefinition.getType().equals(ABIDefinition.RECEIVE_TYPE)) {
+                    if (contractABIDefinition.hasReceiveFunction()) {
+                        throw new ABICodecException("only single receive is allowed");
+                    }
+                    if (abiDefinition.getStateMutability().equals("payable") == false
+                            && abiDefinition.isPayable() == false) {
+                        throw new ABICodecException(
+                                "the statemutability of receive can only be payable");
+                    }
+                    contractABIDefinition.setReceiveFunction(abiDefinition);
                 } else {
                     // skip and do nothing
                 }
diff --git a/sdk-abi/src/main/java/org/fisco/bcos/sdk/abi/wrapper/ContractABIDefinition.java b/sdk-abi/src/main/java/org/fisco/bcos/sdk/abi/wrapper/ContractABIDefinition.java
@@ -18,6 +18,8 @@ public class ContractABIDefinition {
     private Map<String, List<ABIDefinition>> events = new HashMap<>();
     // method id => function
     private Map<String, ABIDefinition> methodIDToFunctions = new HashMap<>();
+    private ABIDefinition fallbackFunction;
+    private ABIDefinition receiveFunction;
     // event topic => topic
     private Map<String, ABIDefinition> eventTopicToEvents = new HashMap<>();
     private CryptoSuite cryptoSuite;
@@ -107,4 +109,28 @@ public ABIDefinition getABIDefinitionByMethodId(String methodId) {
     public ABIDefinition getABIDefinitionByEventTopic(String topic) {
         return eventTopicToEvents.get(Numeric.prependHexPrefix(topic));
     }
+
+    public ABIDefinition getFallbackFunction() {
+        return fallbackFunction;
+    }
+
+    public void setFallbackFunction(ABIDefinition fallbackFunction) {
+        this.fallbackFunction = fallbackFunction;
+    }
+
+    public boolean hasFallbackFunction() {
+        return this.fallbackFunction != null;
+    }
+
+    public boolean hasReceiveFunction() {
+        return this.receiveFunction != null;
+    }
+
+    public ABIDefinition getReceiveFunction() {
+        return receiveFunction;
+    }
+
+    public void setReceiveFunction(ABIDefinition receiveFunction) {
+        this.receiveFunction = receiveFunction;
+    }
 }
diff --git a/sdk-abi/src/test/java/org/fisco/bcos/sdk/test/abi/ABICodecTest.java b/sdk-abi/src/test/java/org/fisco/bcos/sdk/test/abi/ABICodecTest.java
@@ -1,15 +1,24 @@
 package org.fisco.bcos.sdk.test.abi;
 
+import java.io.IOException;
 import java.math.BigInteger;
 import java.util.ArrayList;
 import java.util.List;
+import java.util.Map;
+
+import com.fasterxml.jackson.core.JsonProcessingException;
+import com.fasterxml.jackson.databind.ObjectMapper;
 import org.fisco.bcos.sdk.abi.ABICodec;
 import org.fisco.bcos.sdk.abi.ABICodecException;
 import org.fisco.bcos.sdk.abi.wrapper.ABICodecObject;
 import org.fisco.bcos.sdk.abi.wrapper.ABIDefinition;
+import org.fisco.bcos.sdk.abi.wrapper.ABIDefinitionFactory;
 import org.fisco.bcos.sdk.abi.wrapper.ABIObject;
 import org.fisco.bcos.sdk.abi.wrapper.ABIObjectFactory;
 import org.fisco.bcos.sdk.abi.wrapper.ContractABIDefinition;
+import org.fisco.bcos.sdk.crypto.CryptoSuite;
+import org.fisco.bcos.sdk.model.CryptoType;
+import org.fisco.bcos.sdk.utils.ObjectMapperFactory;
 import org.junit.Assert;
 import org.junit.Test;
 
@@ -227,9 +236,13 @@ public class ABICodecTest {
                     + "                \"payable\": false,\n"
                     + "                \"stateMutability\": \"nonpayable\",\n"
                     + "                \"type\": \"fallback\"\n"
+                    + "        },\n"
+                    + "        {\n"
+                    + "                \"payable\": false,\n"
+                    + "                \"stateMutability\": \"payable\",\n"
+                    + "                \"type\": \"receive\"\n"
                     + "        }\n"
                     + "]";
-
     // int a, Info[] memory b, string memory c
     /*
     	 * {
@@ -291,7 +304,40 @@ function test(int a, Info[] memory b, string memory c) public returns(int) {
     private String encodedWithMethodId = "0x00a3c75d" + encoded;
 
     @Test
-    public void testEncodeFromString() {
+    public void testEncodeFromString() throws IOException {
+        CryptoSuite cryptoSuite = new CryptoSuite(CryptoType.ECDSA_TYPE);
+        ABIDefinitionFactory abiDefinitionFactory = new ABIDefinitionFactory(cryptoSuite);
+        ContractABIDefinition abiDefinition = abiDefinitionFactory.loadABI(abiDesc);
+        // check the fallback function
+        Assert.assertTrue(abiDefinition.getFallbackFunction() != null);
+        // check the content of the fallback function
+        Assert.assertTrue(abiDefinition.getFallbackFunction().getStateMutability().equals( "nonpayable"));
+        Assert.assertTrue(abiDefinition.getFallbackFunction().isPayable() == false);
+        Assert.assertTrue(abiDefinition.getFallbackFunction().getType().equals("fallback"));
+
+        // check receive functions
+        Assert.assertTrue(abiDefinition.getReceiveFunction() != null);
+        Assert.assertTrue(abiDefinition.getReceiveFunction().getType().equals("receive"));
+
+        // check serialization and deserialization
+        ObjectMapper objectMapper = ObjectMapperFactory.getObjectMapper();
+        byte[] encodedABIDefinitions = objectMapper.writeValueAsBytes(abiDefinition.getFallbackFunction());
+        // decode
+        ABIDefinition decodedABIDefinition = objectMapper.readValue(encodedABIDefinitions, ABIDefinition.class);
+        Assert.assertTrue(decodedABIDefinition.getStateMutability().equals( "nonpayable"));
+        Assert.assertTrue(decodedABIDefinition.isPayable() == false);
+        Assert.assertTrue(decodedABIDefinition.getType().equals("fallback"));
+        // test encode/decode for all the functions
+        for(String key : abiDefinition.getFunctions().keySet())
+        {
+            List<ABIDefinition> abiDefinitions = abiDefinition.getFunctions().get(key);
+            for(int i = 0; i < abiDefinitions.size(); i++) {
+                ABIDefinition functionAbiDefinition = abiDefinitions.get(i);
+                        encodedABIDefinitions = objectMapper.writeValueAsBytes(functionAbiDefinition);
+                decodedABIDefinition = objectMapper.readValue(encodedABIDefinitions, ABIDefinition.class);
+            }
+        }
+
         List<String> args = new ArrayList<String>();
         args.add("100");
         // [{"name": "Hello world!", "count": 100, "items": [{"a": 1, "b": 2, "c": 3}]}, {"name":
@@ -401,9 +447,21 @@ public void testEncodeByInterface() {
         argsObjects.add(a);
         try {
             String s1 = abiCodec.encodeMethodByInterface("call(uint256[2],uint256[],bytes,address)", argsObjects);
-            String abi = "[{\"constant\":false,\"inputs\":[{\"name\":\"u1\",\"type\":\"uint256[2]\"},{\"name\":\"u2\",\"type\":\"uint256[]\"},{\"name\":\"b\",\"type\":\"bytes\"},{\"name\":\"a\",\"type\":\"address\"}],\"name\":\"call\",\"outputs\":[{\"name\":\"\",\"type\":\"uint256\"}],\"payable\":false,\"stateMutability\":\"nonpayable\",\"type\":\"function\"},{\"constant\":true,\"inputs\":[],\"name\":\"get\",\"outputs\":[{\"name\":\"u\",\"type\":\"uint256\"}],\"payable\":false,\"stateMutability\":\"view\",\"type\":\"function\"},{\"constant\":false,\"inputs\":[{\"name\":\"a\",\"type\":\"uint256\"},{\"name\":\"s\",\"type\":\"string\"}],\"name\":\"add\",\"outputs\":[{\"name\":\"\",\"type\":\"uint256\"}],\"payable\":false,\"stateMutability\":\"nonpayable\",\"type\":\"function\"},{\"inputs\":[],\"payable\":false,\"stateMutability\":\"nonpayable\",\"type\":\"constructor\"},{\"anonymous\":false,\"inputs\":[{\"indexed\":false,\"name\":\"u\",\"type\":\"uint256\"},{\"indexed\":false,\"name\":\"a\",\"type\":\"uint256\"}],\"name\":\"LogAdd1\",\"type\":\"event\"},{\"anonymous\":false,\"inputs\":[{\"indexed\":true,\"name\":\"u\",\"type\":\"uint256\"},{\"indexed\":false,\"name\":\"a\",\"type\":\"uint256\"}],\"name\":\"LogAdd2\",\"type\":\"event\"},{\"anonymous\":false,\"inputs\":[{\"indexed\":true,\"name\":\"u\",\"type\":\"uint256\"},{\"indexed\":true,\"name\":\"a\",\"type\":\"uint256\"},{\"indexed\":true,\"name\":\"s\",\"type\":\"string\"}],\"name\":\"LogAdd3\",\"type\":\"event\"},{\"anonymous\":false,\"inputs\":[{\"indexed\":false,\"name\":\"a\",\"type\":\"uint256\"}],\"name\":\"LogAdd4\",\"type\":\"event\"},{\"anonymous\":false,\"inputs\":[{\"indexed\":true,\"name\":\"a\",\"type\":\"uint256\"}],\"name\":\"LogAdd5\",\"type\":\"event\"}]";
+            String abi = "[{\"inputs\":[{\"name\":\"u1\",\"type\":\"uint256[2]\"},{\"name\":\"u2\",\"type\":\"uint256[]\"},{\"name\":\"b\",\"type\":\"bytes\"},{\"name\":\"a\",\"type\":\"address\"}],\"name\":\"call\",\"outputs\":[{\"name\":\"\",\"type\":\"uint256\"}],\"payable\":false,\"stateMutability\":\"view\",\"type\":\"function\"},{\"constant\":true,\"inputs\":[],\"name\":\"get\",\"outputs\":[{\"name\":\"u\",\"type\":\"uint256\"}],\"payable\":false,\"stateMutability\":\"view\",\"type\":\"function\"},{\"constant\":false,\"inputs\":[{\"name\":\"a\",\"type\":\"uint256\"},{\"name\":\"s\",\"type\":\"string\"}],\"name\":\"add\",\"outputs\":[{\"name\":\"\",\"type\":\"uint256\"}],\"payable\":false,\"stateMutability\":\"nonpayable\",\"type\":\"function\"},{\"inputs\":[],\"payable\":false,\"stateMutability\":\"nonpayable\",\"type\":\"constructor\"},{\"anonymous\":false,\"inputs\":[{\"indexed\":false,\"name\":\"u\",\"type\":\"uint256\"},{\"indexed\":false,\"name\":\"a\",\"type\":\"uint256\"}],\"name\":\"LogAdd1\",\"type\":\"event\"},{\"anonymous\":false,\"inputs\":[{\"indexed\":true,\"name\":\"u\",\"type\":\"uint256\"},{\"indexed\":false,\"name\":\"a\",\"type\":\"uint256\"}],\"name\":\"LogAdd2\",\"type\":\"event\"},{\"anonymous\":false,\"inputs\":[{\"indexed\":true,\"name\":\"u\",\"type\":\"uint256\"},{\"indexed\":true,\"name\":\"a\",\"type\":\"uint256\"},{\"indexed\":true,\"name\":\"s\",\"type\":\"string\"}],\"name\":\"LogAdd3\",\"type\":\"event\"},{\"anonymous\":false,\"inputs\":[{\"indexed\":false,\"name\":\"a\",\"type\":\"uint256\"}],\"name\":\"LogAdd4\",\"type\":\"event\"},{\"anonymous\":false,\"inputs\":[{\"indexed\":true,\"name\":\"a\",\"type\":\"uint256\"}],\"name\":\"LogAdd5\",\"type\":\"event\"}]";
             String s2 = abiCodec.encodeMethod(abi, "call", argsObjects);
             Assert.assertEquals(s1, s2);
+            // test ABIDefinition
+            // check constant
+            CryptoSuite cryptoSuite = new CryptoSuite(CryptoType.ECDSA_TYPE);
+            ABIDefinitionFactory abiDefinitionFactory = new ABIDefinitionFactory(cryptoSuite);
+            ContractABIDefinition abiDefinition = abiDefinitionFactory.loadABI(abi);
+            Map<String, List<ABIDefinition>> functions =  abiDefinition.getFunctions();
+            Assert.assertTrue(functions.containsKey("call"));
+            List<ABIDefinition> callABIDefinition = functions.get("call");
+            Assert.assertEquals(1, callABIDefinition.size());
+            Assert.assertTrue(callABIDefinition.get(0).isConstant());
+            // check without
+
         } catch (ABICodecException e) {
             Assert.fail(e.getMessage());
         }
diff --git a/sdk-core/src/main/java/org/fisco/bcos/sdk/network/NetworkImp.java b/sdk-core/src/main/java/org/fisco/bcos/sdk/network/NetworkImp.java
@@ -154,6 +154,7 @@ public void start() throws NetworkException {
         boolean tryEcdsaConnect = false;
         CheckCertExistenceResult result = null;
         String ecdsaCryptoInfo = configOption.getCryptoMaterialConfig().toString();
+        String ecdsaErrorMessage = "";
         try {
             try {
                 result = checkCertExistence(false);
@@ -186,6 +187,7 @@ public void start() throws NetworkException {
                 }
                 // means that all the ECDSA certificates exist
                 tryEcdsaConnect = true;
+                ecdsaErrorMessage += e.getMessage();
                 connManager.stopNetty();
                 logger.debug(
                         "start connManager with the ECDSA sslContext failed, try to use SM sslContext, error info: {}",
@@ -197,7 +199,11 @@ public void start() throws NetworkException {
             if (!result.isCheckPassed()) {
                 if (tryEcdsaConnect) {
                     String errorMessage =
-                            "\n* Try init the sslContext failed.\n\n* If your blockchain channel config is NON-SM, please provide the NON-SM certificates: "
+                            "\n* Try init the NON-SM sslContext failed and the SM certificates are incomplete . error info: \n"
+                                    + ecdsaErrorMessage;
+
+                    errorMessage +=
+                            "\n* If your blockchain channel config is NON-SM, please provide the NON-SM certificates: "
                                     + ecdsaCryptoInfo
                                     + ".\n";
                     errorMessage +=
diff --git a/sdk-crypto/src/main/java/org/fisco/bcos/sdk/crypto/keystore/KeyTool.java b/sdk-crypto/src/main/java/org/fisco/bcos/sdk/crypto/keystore/KeyTool.java
@@ -306,7 +306,7 @@ private static Method getMethod(
         try {
             return ec5UtilClass.getDeclaredMethod(methodName, parameterTypes);
         } catch (NoSuchMethodException e) {
-            logger.warn("get method for EC5Util failed, method name: {}", methodName);
+            logger.debug("try to get method for EC5Util failed, method name: {}", methodName);
             return null;
         }
     }

Original file line number	Diff line number	Diff line change
`@@ -306,7 +306,7 @@ private static Method getMethod(`
`306`	`306`	`try {`
`307`	`307`	`return ec5UtilClass.getDeclaredMethod(methodName, parameterTypes);`
`308`	`308`	`} catch (NoSuchMethodException e) {`
`309`		`- logger.warn("get method for EC5Util failed, method name: {}", methodName);`
	`309`	`+ logger.debug("try to get method for EC5Util failed, method name: {}", methodName);`
`310`	`310`	`return null;`
`311`	`311`	`}`
`312`	`312`	`}`