Merge 9640b51 into 0d7c686

Author: kyonRay

.ci/ci_check.sh

@@ -157,15 +157,11 @@ pwd
 ls -la
 export JAVA_TOOL_OPTIONS=-Dfile.encoding=UTF8
 download_tassl
-LOG_INFO "------ download_build_chain: v3.3.0---------"
-download_binary "v3.3.0"
-download_build_chain "v3.3.0"
+LOG_INFO "------ download_binary: v3.0.0---------"
+download_build_chain "v3.0.0"
+download_binary "v3.0.0"
 LOG_INFO "------ check_standard_node---------"
-check_standard_node "false" "sm" "-s"
-LOG_INFO "------ check_wasm_node---------"
-check_wasm_node "true"
-LOG_INFO "------ check_basic---------"
-check_basic
+check_standard_node
 rm -rf ./bin
 
 LOG_INFO "------ download_binary: v3.2.0---------"
@@ -182,9 +178,18 @@ LOG_INFO "------ check_standard_node---------"
 check_standard_node
 rm -rf ./bin
 
-LOG_INFO "------ download_binary: v3.0.0---------"
-download_build_chain "v3.0.0"
-download_binary "v3.0.0"
+LOG_INFO "------ download_binary: v3.2.0---------"
+download_build_chain "v3.2.0"
+download_binary "v3.2.0"
 LOG_INFO "------ check_standard_node---------"
-check_standard_node
-rm -rf ./bin
+check_standard_node "true" "sm" "-s -A"
+rm -rf ./bin
+
+LOG_INFO "------ download_build_chain: v3.3.0---------"
+download_binary "v3.3.0"
+download_build_chain "v3.3.0"
+LOG_INFO "------ check_wasm_node---------"
+check_wasm_node "false"
+LOG_INFO "------ check_standard_node---------"
+check_standard_node "true" "sm" "-s"
+rm -rf ./bin

.github/workflows/workflow.yml

@@ -78,7 +78,9 @@ jobs:
       - name: install CentOS dependencies
         run: yum install -y epel-release centos-release-scl wget which git openssl-devel openssl java java-devel tree
       - name: run build test
-        run: /bin/bash gradlew build --info && tree ./build/reports
+        run: /bin/bash gradlew build --info
+      - name: run integration testing
+        run: /bin/bash .ci/ci_check.sh && tree ./build/reports
       - name: upload unittest coverage
         run: curl -LO https://codecov.io/bash && /bin/bash ./bash
       #        uses: codecov/codecov-action@v3
@@ -87,6 +89,4 @@ jobs:
       #          files: ./build/reports/jacoco/test/jacocoTestReport.xml
       #          flags: unittest
       #          fail_ci_if_error: true
-      #          verbose: true
-      - name: run integration testing
-        run: /bin/bash .ci/ci_check.sh
+      #          verbose: true

Changelog.md

@@ -1,3 +1,86 @@
+## v3.4.0
+(2023-06-09)
+
+请阅读Java SDK v3.x+文档：
+
+- [中文用户手册](https://fisco-bcos-doc.readthedocs.io/zh_CN/latest/docs/develop/sdk/java_sdk/index.html)
+
+### 新增
+
+- 新增call with sign接口，支持在发起static call请求时使用私钥对请求体(to+data)进行签名，在节点侧将会对应恢复出签名对应的用户地址，合约中可以取到call请求时的tx.origin和msg.sender，达到用户身份认证的目的。
+- `Client`类新增`isEnableCommittee()`方法，与`isAuthCheck()`进行区分，用于判断当前链是否启用了治理委员会。
+- `Client`类新增 `getChainCompatibilityVersion()`，用于获取当前链的数据兼容版本号。
+
+### 更新
+
+- 将`Client`类的`getChainVersion()`设置为@Deprecated，建议使用`getChainCompatibilityVersion()`。
+
+### 修复
+
+- 修复了开启治理委员会后，发起 `addSealerProposal` 提案时可能出现的观察节点未达到块高差值门限的问题。
+- 修复回执中状态数据与节点不匹配的问题。
+
+### 兼容性说明
+
+- 不兼容 FISCO BCOS 2.0+ 版本
+- 兼容java-sdk v3.0+的历史版本
+- 支持[FISCO BCOS 3.4.0](https://github.com/FISCO-BCOS/FISCO-BCOS/releases/tag/v3.4.0)版本，以及3.0.0正式版以来的所有版本。
+- 账户权限管理接口、BFS新增的list分页接口与link接口只在 FISCO BCOS 3.1.0支持使用。
+- 新增的CRUD接口，如条件范围遍历查询、修改、删除等接口，只在FISCO BCOS 3.2.0支持使用。
+- 新增的ShardService, 只在FISCO BCOS 3.3.0支持使用。
+
+### 遗留问题说明
+
+在工作量与收益之间做平衡之后，目前还遗留以下几种场景的编解码仍然可能会有问题，欢迎社区用户贡献解决方案或实现代码 :-)
+- 三维及以上的数组作为输入输出参数时，使用`contract2java`编译成Java文件后，方法接口可能会出现调用错误。
+- 在使用类似 `bytes[2][]` 这样的动态数组套静态数组，且基础类型仍然是动态类型的类型时，使用`contract2java`编译成Java文件后，方法接口调用时编解码可能会出现问题。
+- 在使用liquid合约时，如果使用上一条所述的类型作为输入输出参数，在合约方法接口调用时编解码可能会出现问题。
+- 在使用liquid合约时，将u256与i256类型的输入输出参数，如果输入最大值，BigInteger生成的bytes会超过大小限制。
+- 在使用liquid合约时，因为liquid合约的事件编码与Solidity合约的事件编码不同，所以在使用liquid合约的事件时，会出现Java sdk解析失败的问题。
+
+---
+
+## v3.4.0
+(2023-06-09)
+Please refer to the Java SDK v3.x+ documentation:
+
+- [Chinese User Manual](https://fisco-bcos-doc.readthedocs.io/zh_CN/latest/docs/develop/sdk/java_sdk/index.html)
+
+### Added
+
+- Added the "call with sign" interface, which supports signing the request body (to+data) with a private key when initiating a static call request. The corresponding user address will be recovered with the signature on the node side, and the tx.origin and msg.sender at the time of the call request can be obtained in the contract, achieving user identity authentication.
+- Added the `isEnableCommittee()` method to the `Client` class, which is used to determine whether the current chain has enabled the governance committee, differentiating it from `isAuthCheck()`.
+- Added the `getChainCompatibilityVersion()` method to the `Client` class, which is used to obtain the data compatibility version of the current chain.
+
+### Updated
+
+- Deprecated the `getChainVersion()` method of the `Client` class, and recommend using `getChainCompatibilityVersion()` instead.
+
+### Fixed
+
+- Fixed the issue where when the governance committee is enabled, there might be a problem with the observer nodes not reaching the block height difference threshold when initiating the `addSealerProposal` proposal.
+- Fixed the issue where the status data in the receipt does not match the chain node.
+
+### Compatibility Notes
+
+- Not compatible with FISCO BCOS 2.0+ versions.
+- Compatible with historical versions of java-sdk v3.0+.
+- Supports [FISCO BCOS 3.4.0](https://github.com/FISCO-BCOS/FISCO-BCOS/releases/tag/v3.4.0) version and all versions since the official release of 3.0.0.
+- The account permission management interface, list pagination interface, and link interface added by BFS are only supported in FISCO BCOS 3.1.0.
+- The newly added CRUD interfaces, such as conditional range traversal query, modification, deletion, etc., are only supported in FISCO BCOS 3.2.0.
+- The newly added ShardService is only supported in FISCO BCOS 3.3.0.
+
+### Known Issues
+
+After balancing the workload and benefits, there are still potential issues with the following scenarios in the encoding and decoding process. Community users are welcome to contribute solutions or implementation code :-)
+- When using arrays of three dimensions or more as input or output parameters, there may be invocation errors in the method interface after compiling into Java files using `contract2java`.
+- When using a dynamic array nested in a static array, such as `bytes[2][]`, and the base type is still a dynamic type, there may be issues with encoding and decoding in the method interface when compiling into Java files using `contract2java`.
+- When using the liquid contract, if the aforementioned types are used as input or output parameters, there may be issues with encoding and decoding in the method interface when calling the contract.
+- When using the liquid contract, if the u256 and i256 types are used as input or output parameters and the maximum value is input, the bytes generated by BigInteger may exceed the size limit.
+- When using the liquid contract, because the event encoding of the liquid contract is different from that of Solidity contract, there may be issues with Java SDK parsing when using the events of the liquid contract.
+
+---
+
 ## v3.3.0
 (2023-04-17)
 
@@ -40,9 +123,10 @@
 
 - 不兼容 FISCO BCOS 2.0+ 版本
 - 兼容java-sdk v3.0+的历史版本
-- 支持[FISCO BCOS 3.2.0](https://github.com/FISCO-BCOS/FISCO-BCOS/releases/tag/v3.2.0)版本
+- 支持[FISCO BCOS 3.3.0](https://github.com/FISCO-BCOS/FISCO-BCOS/releases/tag/v3.3.0)版本
 - 账户权限管理接口、BFS新增的list分页接口与link接口只在 FISCO BCOS 3.1.0支持使用。
 - 新增的CRUD接口，如条件范围遍历查询、修改、删除等接口，只在FISCO BCOS 3.2.0支持使用。
+- 新增的ShardService, 只在FISCO BCOS 3.3.0支持使用。
 
 ### 遗留问题说明
 

build.gradle

@@ -25,7 +25,7 @@ ext {
     junitVersion = '4.13.2'
     commonsCollections4Version = "4.4"
     guavaVersion = '31.1-jre'
-    bcosSdkJniVersion = "3.3.0"
+    bcosSdkJniVersion = "3.4.0"
     slf4jApiVerison = '1.7.36'
     mockitoVersion = '4.8.0'
     gsonVersion = '2.10.1'
@@ -35,7 +35,7 @@ ext {
 // integrationTest.mustRunAfter test
 allprojects {
     group = 'org.fisco-bcos.java-sdk'
-    version = '3.4.0-SNAPSHOT'
+    version = '3.4.0'
 
     apply plugin: 'maven-publish'
     apply plugin: 'idea'
@@ -53,12 +53,6 @@ allprojects {
     jacoco {
         toolVersion = "0.8.6"
     }
-    jacocoTestReport {
-        reports {
-            xml.enabled true
-            html.enabled false
-        }
-    }
     sourceCompatibility = 1.8
     targetCompatibility = 1.8
 
@@ -169,11 +163,13 @@ configurations {
 }
 
 task integrationTest(type: Test) {
+    dependsOn test
     testClassesDirs = sourceSets.integrationTest.output.classesDirs
     classpath = sourceSets.integrationTest.runtimeClasspath
 }
 
 task integrationWasmTest(type: Test) {
+    dependsOn test
     testClassesDirs = sourceSets.integrationWasmTest.output.classesDirs
     classpath = sourceSets.integrationWasmTest.runtimeClasspath
 }
@@ -194,6 +190,22 @@ task javadocJar(type: Jar) {
     archiveClassifier = 'javadoc'
 }
 
+jacocoTestReport {
+    // The JaCoCo plugin adds a JacocoTaskExtension extension to all tasks of type Test.
+    // Use task state to include or not task execution data
+    // https://docs.gradle.org/current/javadoc/org/gradle/api/tasks/TaskState.html
+    // This declaration will be used as a closure, notice there no wrapping parenthesis
+    executionData { tasks.withType(Test).findAll { it.jacoco.destinationFile.exists() }*.jacoco.destinationFile }
+    reports {
+        xml.enabled true
+        html.enabled true
+    }
+}
+
+tasks.withType(Test) {
+    finalizedBy jacocoTestReport
+}
+
 publishing {
     publications {
         mavenJava(MavenPublication) {

src/integration-test/java/org/fisco/bcos/sdk/v3/test/BcosSDKTest.java

@@ -336,7 +336,7 @@ public void onError(Response errorResponse) {
         String txHash = receipt.getTransactionHash();
         BcosTransaction transaction1 = client.getTransaction(txHash, false);
         BcosTransactionReceipt transactionReceipt = client.getTransactionReceipt(txHash, false);
-        if (client.getChainVersion().compareTo(EnumNodeVersion.BCOS_3_2_0) >= 0) {
+        if (client.getChainCompatibilityVersion().compareTo(EnumNodeVersion.BCOS_3_2_0.toVersionObj()) >= 0) {
             Assert.assertEquals(extraData, transaction1.getResult().getExtraData());
             Assert.assertEquals(extraData, transactionReceipt.getResult().getExtraData());
         }

src/integration-test/java/org/fisco/bcos/sdk/v3/test/precompiled/PrecompiledTest.java

@@ -60,6 +60,8 @@
 import org.junit.Test;
 import org.junit.runners.MethodSorters;
 
+import static org.fisco.bcos.sdk.v3.contract.precompiled.sysconfig.SystemConfigService.AUTH_STATUS;
+
 @FixMethodOrder(MethodSorters.NAME_ASCENDING)
 public class PrecompiledTest {
     private static final String configFile =
@@ -158,7 +160,14 @@ public void test3SystemConfigService() throws ConfigException, ContractException
 
         CryptoKeyPair cryptoKeyPair = client.getCryptoSuite().getCryptoKeyPair();
         SystemConfigService systemConfigService = new SystemConfigService(client, cryptoKeyPair);
-        if (client.isAuthCheck()) {
+        boolean authCheck = client.isAuthCheck();
+        if (client.getChainCompatibilityVersion().compareTo(EnumNodeVersion.BCOS_3_3_0.toVersionObj()) >= 0) {
+            String value = client.getSystemConfigByKey(AUTH_STATUS).getSystemConfig().getValue();
+            if (Objects.equals(value, "0")) {
+                authCheck = false;
+            }
+        }
+        if (authCheck) {
             RetCode retCode = systemConfigService.setValueByKey("tx_count_limit", "100");
             Assert.assertEquals(retCode.code, PrecompiledRetCode.CODE_NO_AUTHORIZED.code);
             return;
@@ -200,7 +209,7 @@ public void test5CRUDService() throws ConfigException, ContractException {
         }
         RetCode code;
         Map<String, List<String>> desc;
-        if (client.getChainVersion().compareToVersion(EnumNodeVersion.BCOS_3_2_0) >= 0) {
+        if (client.getChainCompatibilityVersion().compareTo(EnumNodeVersion.BCOS_3_2_0.toVersionObj()) >= 0) {
             code = tableCRUDService.createTable(tableName, Common.TableKeyOrder.valueOf(0), key, valueFields);
             desc = tableCRUDService.descWithKeyOrder(tableName);
         } else {
@@ -222,7 +231,7 @@ public void test5CRUDService() throws ConfigException, ContractException {
         // select key
         Map<String, String> result = tableCRUDService.select(tableName, "key1");
 
-        if (client.getChainVersion().compareToVersion(EnumNodeVersion.BCOS_3_2_0) >= 0) {
+        if (client.getChainCompatibilityVersion().compareTo(EnumNodeVersion.BCOS_3_2_0.toVersionObj()) >= 0) {
             ConditionV320 condition = new ConditionV320();
             condition.EQ(key, "key1");
             condition.setLimit(0, 10);
@@ -269,7 +278,7 @@ public void test51SyncCRUDService() throws ConfigException, ContractException, J
         List<String> valueFiled = new ArrayList<>();
         valueFiled.add("field");
         RetCode retCode;
-        if (client.getChainVersion().compareToVersion(EnumNodeVersion.BCOS_3_2_0) >= 0) {
+        if (client.getChainCompatibilityVersion().compareTo(EnumNodeVersion.BCOS_3_2_0.toVersionObj()) >= 0) {
             retCode = crudService.createTable(tableName, Common.TableKeyOrder.valueOf(0), "key", valueFiled);
         } else {
             retCode = crudService.createTable(tableName, "key", valueFiled);
@@ -346,7 +355,7 @@ public void test52AsyncCRUDService()
         List<String> valueFiled = new ArrayList<>();
         valueFiled.add("field");
         String key = "key";
-        if (client.getChainVersion().compareToVersion(EnumNodeVersion.BCOS_3_2_0) >= 0) {
+        if (client.getChainCompatibilityVersion().compareTo(EnumNodeVersion.BCOS_3_2_0.toVersionObj()) >= 0) {
             crudService.createTable(tableName, Common.TableKeyOrder.valueOf(0), key, valueFiled);
         } else {
             crudService.createTable(tableName, key, valueFiled);
@@ -415,7 +424,7 @@ public void test6KVService() throws ConfigException, ContractException {
         Assert.assertEquals(0, code.getCode());
         // desc
         Map<String, String> desc;
-        if (client.getChainVersion().compareToVersion(EnumNodeVersion.BCOS_3_2_0) >= 0) {
+        if (client.getChainCompatibilityVersion().compareTo(EnumNodeVersion.BCOS_3_2_0.toVersionObj()) >= 0) {
             desc = kvTableService.descWithKeyOrder(tableName);
         } else {
             desc = kvTableService.desc(tableName);

src/integration-test/java/org/fisco/bcos/sdk/v3/test/transaction/manager/AssembleTransactionProcessorTest.java

@@ -103,13 +103,13 @@ public void test1HelloWorld() throws Exception {
         Assert.assertTrue(Objects.nonNull(transactionReceipt.getOutput()) && StringUtils.isNotBlank(transactionReceipt.getOutput()));
         Assert.assertTrue(Objects.nonNull(transactionReceipt.getReceiptHash()) && StringUtils.isNotBlank(transactionReceipt.getReceiptHash()));
         Assert.assertTrue(Objects.nonNull(transactionReceipt.getFrom()) && StringUtils.isNotBlank(transactionReceipt.getFrom()));
-        if (client.getChainVersion().compareToVersion(EnumNodeVersion.BCOS_3_1_0) >= 0) {
+        if (client.getChainCompatibilityVersion().compareTo(EnumNodeVersion.BCOS_3_1_0.toVersionObj()) >= 0) {
             Assert.assertTrue(Objects.nonNull(transactionReceipt.getChecksumContractAddress()) && StringUtils.isNotBlank(transactionReceipt.getChecksumContractAddress()));
             Assert.assertTrue(transactionReceipt.getChecksumContractAddress().equalsIgnoreCase(transactionReceipt.getContractAddress()));
         }
         Assert.assertTrue(Objects.nonNull(transactionReceipt.getTo()));
 
-        if (client.getChainVersion().compareToVersion(EnumNodeVersion.BCOS_3_3_0) >= 0) {
+        if (client.getChainCompatibilityVersion().compareTo(EnumNodeVersion.BCOS_3_3_0.toVersionObj()) >= 0) {
             Assert.assertTrue(Objects.nonNull(transactionReceipt.getInput()) && StringUtils.isNotBlank(transactionReceipt.getInput()));
         }
 
@@ -561,7 +561,7 @@ public void test11CallWithSign() throws Exception {
                 TransactionProcessorFactory.createAssembleTransactionProcessor(
                         this.client, this.cryptoKeyPair, ABI_FILE, BIN_FILE);
 
-        if(client.getChainVersion().compareToVersion(EnumNodeVersion.BCOS_3_4_0) < 0){
+        if(client.getChainCompatibilityVersion().compareTo(EnumNodeVersion.BCOS_3_4_0.toVersionObj()) < 0){
             return;
         }
         String contractAddress = null;

src/main/java/org/fisco/bcos/sdk/v3/client/Client.java

@@ -133,7 +133,15 @@ static Client build(String groupId, ConfigOption configOption, long nativePointe
      */
     Boolean isAuthCheck();
 
+    /**
+     * Whether is committee enable in chain
+     *
+     * @return true when chain can use committee
+     */
+    Boolean isEnableCommittee();
+
     Boolean isSerialExecute();
+
     /**
      * get groupId of the client
      *
@@ -911,15 +919,20 @@ void getTransactionReceiptAsync(
      * get the chain compatibility version
      *
      * @return the chain compatibility version
+     * @deprecated use getChainCompatibilityVersion instead, because older version sdk did not
+     *     recognize newer chain node
      */
+    @Deprecated
     EnumNodeVersion getChainVersion();
 
+    EnumNodeVersion.Version getChainCompatibilityVersion();
+
     /**
      * async get the chain compatibility version
      *
      * @param versionRespCallback the callback instance
      */
-    void getChainVersionAsync(RespCallback<EnumNodeVersion> versionRespCallback);
+    void getChainVersionAsync(RespCallback<EnumNodeVersion.Version> versionRespCallback);
 
     void start();