release-3.1.0 doc (#1585)

FISCO-BCOS · Nov 24, 2022 · a41e02d · a41e02d
1 parent a85e7db
commit a41e02d
Show file tree

Hide file tree

Showing 20 changed files with 112 additions and 40 deletions.
diff --git a/2.x/docs/design/architecture/group.md b/2.x/docs/design/architecture/group.md
@@ -4,7 +4,7 @@
 
 ----
 
-考虑到真实的业务场景需求，FISCO BCOS引入多群组架构，支持区块链节点启动多个群组，群组间交易处理、数据存储、区块共识相互隔离，保障区块链系统隐私性的同时，降低了系统的运维复杂度。
+考虑到真实的业务场景需求，FISCO BCOS引入多群组架构，支持区块链节点启动多个群组，群组间交易处理、数据存储、区块共识相互隔离，保障区块链系统隐私性的同时，降低了系统的运维复杂度。不同群组间的交易可并行执行，提升了性能。
 
 
 ```eval_rst

diff --git a/3.x/release_note.txt b/3.x/release_note.txt
@@ -1 +1 @@
-v3.0.1
+v3.1.0
diff --git a/3.x/zh_CN/conf.py b/3.x/zh_CN/conf.py
@@ -87,7 +87,7 @@
 # The short X.Y version.
 version = '3.0'
 # The full version, including alpha/beta/rc tags.
-release = 'v3.0.1'
+release = 'v3.1.0'
 
 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.

diff --git a/3.x/zh_CN/docs/change_log/3_1_0.md b/3.x/zh_CN/docs/change_log/3_1_0.md
@@ -0,0 +1,47 @@
+# v3.1.0
+
+#### 新增
+
+* 账户冻结、解冻、废止功能
+* 网关分布式限流功能
+* 网络压缩功能
+* 共识对时功能
+* 合约二进制与ABI存储优化
+* 适配EVM的delegatecall，extCodeHash，blockHash等接口
+* BFS新增查询分页功能
+
+#### 更改
+
+* DBHash 计算逻辑更新，提升校验稳定性
+* chain配置项从config.ini中挪出，修改为在config.genesis创世块中配置
+* BFS 目录表结构性能优化
+
+#### 修复
+
+* 虚拟机接口功能问题： [#2598](https://github.com/FISCO-BCOS/FISCO-BCOS/issues/2598), [#3118](https://github.com/FISCO-BCOS/FISCO-BCOS/issues/3118)
+* tikv client 问题：[#2600](https://github.com/FISCO-BCOS/FISCO-BCOS/issues/2598)
+* 依赖库使用：[#2625](https://github.com/FISCO-BCOS/FISCO-BCOS/issues/2625)
+* CRUD接口问题：[#2910](https://github.com/FISCO-BCOS/FISCO-BCOS/issues/2910)
+* docker 镜像：[#3051](https://github.com/FISCO-BCOS/FISCO-BCOS/issues/3051)
+
+#### 兼容性
+
+* 历史链数据
+
+  当前链已有数据为如下版本时，是否可替换节点二进制完成升级
+
+  * 3.0.x：支持通过替换二进制进行灰度升级，若需使用当前版本的新特性，需在所有节点二进制替换完成后用[控制台将链版本升级为当前版本](https://fisco-bcos-doc.readthedocs.io/zh_CN/latest/docs/develop/console/console_commands.html#setsystemconfigbykey)
+  * 3.0-rc x：数据不兼容，无法升级，可考虑逐步将业务迁移至3.x正式版
+  * 2.x：数据不兼容，2.x版本仍持续维护，可考虑升级为2.x的最新版本
+
+* 组件兼容性
+
+|            | 推荐版本  | 最低版本                 | 说明                               |
+| ---------- | --------- | ------------------------ | ---------------------------------- |
+| Console    | 3.1.0     | 3.0.0                    |                                    |
+| Java SDK   | 3.1.0     | 3.0.0                    |                                    |
+| CPP SDK    | 3.0.0     | 3.0.0                    |                                    |
+| Solidity   | 0.8.11    | 最低 0.4.25，最高 0.8.11 | 需根据合约版本下载编译器（控制台） |
+| WBC-Liquid | 1.0.0-rc3 | 1.0.0-rc3                |                                    |
+
+
diff --git a/3.x/zh_CN/docs/change_log/index.rst b/3.x/zh_CN/docs/change_log/index.rst
@@ -10,6 +10,27 @@
     相关软件和环境版本说明！`请查看 <https://fisco-bcos-documentation.readthedocs.io/zh_CN/latest/docs/compatibility.html>`_
 
 
+v3.1.x
+------------------
+
+.. admonition:: FISCO BCOS 3.x Releases
+
+     - `FISCO BCOS v3.1.0 <./3_1_0.html>`_ [`release <https://github.com/FISCO-BCOS/FISCO-BCOS/releases/tag/v3.1.0>`_]
+
+
+.. admonition:: 查看节点和数据版本
+
+    - 查看Air版本FISCO BCOS节点二进制版本：``./fisco-bcos --version``
+    - 查看Pro版本FISCO BCOS节点二进制版本：``./BcosNodeService --version``, ``./BcosRpcService --version``, ``./BcosGatewayService --version``
+    - 查看Max版本FISCO BCOS节点二进制版本：``./BcosMaxNodeService --version``, ``./BcosRpcService --version``, ``./BcosGatewayService --version``, ``./BcosExecutorService --version``
+
+
+.. toctree::
+   :hidden:
+   :maxdepth: 0
+
+   3_1_0.md
+
 v3.0.x
 ------------------
 

diff --git a/3.x/zh_CN/docs/design/tx_procedure.md b/3.x/zh_CN/docs/design/tx_procedure.md
@@ -51,4 +51,8 @@
 
 ## 交易落盘
 
-在共识出块后，节点需要将区块中的交易及执行结果写入硬盘永久保存，并更新区块高度与区块哈希的映射表等内容，然后节点会从交易池中剔除已落盘的交易，以开始新一轮的出块流程。用户可以通过交易哈希等信息，在链上的历史数据中查询自己感兴趣的交易数据及回执信息。
+在共识出块后，节点需要将区块中的交易及执行结果写入硬盘永久保存，并更新区块高度与区块哈希的映射表等内容，然后节点会从交易池中剔除已落盘的交易，以开始新一轮的出块流程。用户可以通过交易哈希等信息，在链上的历史数据中查询自己感兴趣的交易数据及回执信息。
+
+## 交易原子性
+
+一笔交易在多个区块链节点上对数据状态的更新是原子性的。当出现外界影响，如断电、重启、网络波动等异常场景时，造成共识失败，各区块链节点会丢弃掉当前的执行结果，并不会将该交易对状态的修改落盘。交易在每个节点上对数据状态更新的落盘行为必须在节点达成共识之后进行，进而保证了交易的原子性。
diff --git a/3.x/zh_CN/docs/develop/console/console_config.md b/3.x/zh_CN/docs/develop/console/console_config.md
@@ -29,7 +29,7 @@ wbc-liquid编译环境搭建请参考：[wbc-liquid的环境配置](https://liqu
 ```shell
 cd ~ && mkdir -p fisco && cd fisco
 # 获取控制台下载脚本
-curl -#LO https://github.com/FISCO-BCOS/console/releases/download/v3.0.1/download_console.sh 
+curl -#LO https://github.com/FISCO-BCOS/console/releases/download/v3.1.0/download_console.sh 
 # 执行下载脚本
 bash download_console.sh
 ```

diff --git a/3.x/zh_CN/docs/develop/sdk/c_sdk/api.md b/3.x/zh_CN/docs/develop/sdk/c_sdk/api.md
@@ -32,7 +32,7 @@
   - 字符串类型，包括c-sdk的版本以及构建信息，示例:
 
   ```shell
-  FISCO BCOS C SDK Version : 3.0.1
+  FISCO BCOS C SDK Version : 3.1.0
   Build Time         : 20220915 11:11:11
   Build Type         : Darwin/appleclang/Release
   Git Branch         : main

diff --git a/3.x/zh_CN/docs/develop/sdk/java_sdk/quick_start.md b/3.x/zh_CN/docs/develop/sdk/java_sdk/quick_start.md
@@ -29,7 +29,7 @@
 在build.gradle中引入Java SDK
 
 ```gradle
-compile ('org.fisco-bcos.java-sdk:fisco-bcos-java-sdk:3.0.1')
+compile ('org.fisco-bcos.java-sdk:fisco-bcos-java-sdk:3.1.0')
 ```
 
 如果您使用maven 通过以下方法引入Java SDK
@@ -38,7 +38,7 @@ compile ('org.fisco-bcos.java-sdk:fisco-bcos-java-sdk:3.0.1')
 <dependency>
     <groupId>org.fisco-bcos.java-sdk</groupId>
     <artifactId>fisco-bcos-java-sdk</artifactId>
-    <version>3.0.1</version>
+    <version>3.1.0</version>
 </dependency>
 ```
 
@@ -62,7 +62,7 @@ mkdir -p conf && cp -r ~/fisco/nodes/127.0.0.1/sdk/* conf
 ```shell
 $ mkdir -p ~/fisco && cd ~/fisco
 # 获取控制台
-$ curl -#LO https://github.com/FISCO-BCOS/console/releases/download/v3.0.1/download_console.sh
+$ curl -#LO https://github.com/FISCO-BCOS/console/releases/download/v3.1.0/download_console.sh
 
 # 若因为网络问题导致长时间无法执行以上命令，请尝试以下命令：
 $ curl -#LO https://gitee.com/FISCO-BCOS/console/raw/master/tools/download_console.sh

diff --git a/3.x/zh_CN/docs/quick_start/air_installation.md b/3.x/zh_CN/docs/quick_start/air_installation.md
@@ -49,18 +49,18 @@ sudo yum install -y curl openssl openssl-devel wget
 
 ```eval_rst
 .. note::
-   如果因为网络问题导致长时间无法下载build_chain.sh脚本，请尝试 curl -#LO https://osp-1257653870.cos.ap-guangzhou.myqcloud.com/FISCO-BCOS/FISCO-BCOS/releases/v3.0.1/build_chain.sh && chmod u+x build_chain.sh
+   如果因为网络问题导致长时间无法下载build_chain.sh脚本，请尝试 curl -#LO https://osp-1257653870.cos.ap-guangzhou.myqcloud.com/FISCO-BCOS/FISCO-BCOS/releases/v3.1.0/build_chain.sh && chmod u+x build_chain.sh
 ```
 
 ```shell
 # 创建操作目录
 cd ~ && mkdir -p fisco && cd fisco
 
 # 下载建链脚本
-curl -#LO https://github.com/FISCO-BCOS/FISCO-BCOS/releases/download/v3.0.1/build_chain.sh && chmod u+x build_chain.sh
+curl -#LO https://github.com/FISCO-BCOS/FISCO-BCOS/releases/download/v3.1.0/build_chain.sh && chmod u+x build_chain.sh
 
 # Note: 若访问git网速太慢，可尝试如下命令下载建链脚本:
-curl -#LO https://osp-1257653870.cos.ap-guangzhou.myqcloud.com/FISCO-BCOS/FISCO-BCOS/releases/v3.0.1/build_chain.sh && chmod u+x build_chain.sh
+curl -#LO https://osp-1257653870.cos.ap-guangzhou.myqcloud.com/FISCO-BCOS/FISCO-BCOS/releases/v3.1.0/build_chain.sh && chmod u+x build_chain.sh
 ```
 
 ### 第三步. 搭建4节点非国密联盟链
@@ -181,7 +181,7 @@ sudo yum install -y java java-devel
 ### 第二步. 下载控制台
 
 ```
-cd ~/fisco && curl -LO https://github.com/FISCO-BCOS/console/releases/download/v3.0.1/download_console.sh && bash download_console.sh
+cd ~/fisco && curl -LO https://github.com/FISCO-BCOS/console/releases/download/v3.1.0/download_console.sh && bash download_console.sh
 ```
 
 ```eval_rst
@@ -229,7 +229,7 @@ cd ~/fisco/console && bash start.sh
 
 ```shell
 =============================================================================================
-Welcome to FISCO BCOS console(3.0.1)!
+Welcome to FISCO BCOS console(3.1.0)!
 Type 'help' or 'h' for help. Type 'quit' or 'q' to quit console.
  ________ ______  ______   ______   ______       _______   ______   ______   ______
 |        |      \/      \ /      \ /      \     |       \ /      \ /      \ /      \

diff --git a/3.x/zh_CN/docs/quick_start/solidity_application.md b/3.x/zh_CN/docs/quick_start/solidity_application.md
@@ -65,7 +65,7 @@ function transfer(string memory from_account, string memory to_account, uint256
 mkdir -p ~/fisco
 
 # 下载控制台
-cd ~/fisco && curl -#LO https://github.com/FISCO-BCOS/console/releases/download/v3.0.1/download_console.sh && bash download_console.sh
+cd ~/fisco && curl -#LO https://github.com/FISCO-BCOS/console/releases/download/v3.1.0/download_console.sh && bash download_console.sh
 
 # 切换到fisco/console/目录
 cd ~/fisco/console/
@@ -458,7 +458,7 @@ List spring = [
 dependencies {
     compile logger
     runtime logger
-    compile ("org.fisco-bcos.java-sdk:fisco-bcos-java-sdk:3.0.1")
+    compile ("org.fisco-bcos.java-sdk:fisco-bcos-java-sdk:3.1.0")
     compile spring
 }
 ```

diff --git a/3.x/zh_CN/docs/quick_start/wbc_liquid_application.md b/3.x/zh_CN/docs/quick_start/wbc_liquid_application.md
@@ -72,7 +72,7 @@ pub fn transfer(&mut self, from: String, to: String, value: u128) -> i16
 mkdir -p ~/fisco
 
 # 下载控制台
-cd ~/fisco && curl -#LO https://github.com/FISCO-BCOS/console/releases/download/v3.0.1/download_console.sh && bash download_console.sh
+cd ~/fisco && curl -#LO https://github.com/FISCO-BCOS/console/releases/download/v3.1.0/download_console.sh && bash download_console.sh
 
 # 切换到fisco/console/目录
 cd ~/fisco/console/
@@ -455,7 +455,7 @@ List spring = [
 dependencies {
     compile logger
     runtime logger
-    compile ("org.fisco-bcos.java-sdk:fisco-bcos-java-sdk:3.0.1")
+    compile ("org.fisco-bcos.java-sdk:fisco-bcos-java-sdk:3.1.0")
     compile spring
 }
 ```

diff --git a/3.x/zh_CN/docs/tutorial/air/build_chain.md b/3.x/zh_CN/docs/tutorial/air/build_chain.md
@@ -32,7 +32,7 @@ Usage:
     -C <Command>                        [Optional] the command, support 'deploy' and 'expand' now, default is deploy
     -g <group id>                       [Optional] set the group id, default: group0
     -I <chain id>                       [Optional] set the chain id, default: chain0
-    -v <FISCO-BCOS binary version>      [Optional] Default is the latest v3.0.1
+    -v <FISCO-BCOS binary version>      [Optional] Default is the latest v3.1.0
     -l <IP list>                        [Required] "ip1:nodeNum1,ip2:nodeNum2" e.g:"192.168.0.1:2,192.168.0.2:3"
     -L <fisco bcos lightnode exec>      [Optional] fisco bcos light node executable
     -e <fisco-bcos exec>                [Optional] fisco-bcos binary exec
@@ -146,7 +146,7 @@ $ bash build_chain.sh -l 127.0.0.1:4 -s -o gm_nodes
 该模式下 start.sh 脚本启动节点的命令如下
 
 ```shell
-docker run -d --rm --name ${nodePath} -v ${nodePath}:/data --network=host -w=/data fiscoorg/fiscobcos:v3.0.1 -c config.ini -g config.genesis
+docker run -d --rm --name ${nodePath} -v ${nodePath}:/data --network=host -w=/data fiscoorg/fiscobcos:v3.1.0 -c config.ini -g config.genesis
 ```
 
 ### **`A`权限控制选项[**Optional**]**
@@ -163,7 +163,7 @@ docker run -d --rm --name ${nodePath} -v ${nodePath}:/data --network=host -w=/da
 
 ```shell
 $ bash build_chain.sh -l 127.0.0.1:4 -A
-[INFO] Downloading fisco-bcos binary from https://osp-1257653870.cos.ap-guangzhou.myqcloud.com/FISCO-BCOS/FISCO-BCOS/releases/v3.0.1/fisco-bcos-macOS-x86_64.tar.gz ...
+[INFO] Downloading fisco-bcos binary from https://osp-1257653870.cos.ap-guangzhou.myqcloud.com/FISCO-BCOS/FISCO-BCOS/releases/v3.1.0/fisco-bcos-macOS-x86_64.tar.gz ...
 [INFO] Generate ca cert successfully!
 Processing IP:127.0.0.1 Total:4
 [INFO] Generate ./nodes/127.0.0.1/sdk cert successful!

diff --git a/3.x/zh_CN/docs/tutorial/air/multihost.md b/3.x/zh_CN/docs/tutorial/air/multihost.md
@@ -28,10 +28,10 @@
 mkdir -p ~/fisco && cd ~/fisco
 
 # download_bin.sh, 下载fisco-bcos二进制程序, v指定FISCO-BCOS版本
-./download_bin.sh -v 3.0.1
+./download_bin.sh -v 3.1.0
 
 # 下载开发部署工具build_chain
-curl -#LO https://github.com/FISCO-BCOS/FISCO-BCOS/releases/download/v3.0.1/build_chain.sh && chmod u+x build_chain.sh
+curl -#LO https://github.com/FISCO-BCOS/FISCO-BCOS/releases/download/v3.1.0/build_chain.sh && chmod u+x build_chain.sh
 ```
 
 **生成多机节点配置**
@@ -214,7 +214,7 @@ sudo yum install -y java java-devel
 # 创建操作目录
 mkdir -p ~/fisco && cd ~/fisco
 
-curl -#LO https://github.com/FISCO-BCOS/console/releases/download/v3.0.1/download_console.sh && bash download_console.sh
+curl -#LO https://github.com/FISCO-BCOS/console/releases/download/v3.1.0/download_console.sh && bash download_console.sh
 
 # 若因为网络问题导致长时间无法下载，请尝试以下命令：
 curl -#LO  https://gitee.com/FISCO-BCOS/console/raw/master/tools/download_console.sh && bash download_console.sh
@@ -251,7 +251,7 @@ bash ~/fisco/console/start.sh
 
 ```shell
 =============================================================================================
-Welcome to FISCO BCOS console(3.0.1)!
+Welcome to FISCO BCOS console(3.1.0)!
 Type 'help' or 'h' for help. Type 'quit' or 'q' to quit console.
  ________ ______  ______   ______   ______       _______   ______   ______   ______
 |        |      \/      \ /      \ /      \     |       \ /      \ /      \ /      \

diff --git a/3.x/zh_CN/docs/tutorial/air/storage_security.md b/3.x/zh_CN/docs/tutorial/air/storage_security.md
@@ -25,12 +25,12 @@
 
 下载`build_chain.sh`脚本
 ``` shell
-curl -#LO https://github.com/FISCO-BCOS/FISCO-BCOS/releases/download/v3.0.1/build_chain.sh && chmod u+x build_chain.sh
+curl -#LO https://github.com/FISCO-BCOS/FISCO-BCOS/releases/download/v3.1.0/build_chain.sh && chmod u+x build_chain.sh
 ```
 
 ```eval_rst
 .. note::
-    - 如果因为网络问题导致长时间无法下载build_chain.sh脚本，请尝试 `curl -#LO https://osp-1257653870.cos.ap-guangzhou.myqcloud.com/FISCO-BCOS/FISCO-BCOS/releases/v3.0.1/build_chain.sh && chmod u+x build_chain.sh`
+    - 如果因为网络问题导致长时间无法下载build_chain.sh脚本，请尝试 `curl -#LO https://osp-1257653870.cos.ap-guangzhou.myqcloud.com/FISCO-BCOS/FISCO-BCOS/releases/v3.1.0/build_chain.sh && chmod u+x build_chain.sh`
 ```
 
 部署四个节点：

diff --git a/3.x/zh_CN/docs/tutorial/lightnode/build_chain.md b/3.x/zh_CN/docs/tutorial/lightnode/build_chain.md
@@ -35,7 +35,7 @@ Usage:
     -C <Command>                        [Optional] the command, support 'deploy' and 'expand' now, default is deploy
     -g <group id>                       [Optional] set the group id, default: group0
     -I <chain id>                       [Optional] set the chain id, default: chain0
-    -v <FISCO-BCOS binary version>      [Optional] Default is the latest v3.0.1
+    -v <FISCO-BCOS binary version>      [Optional] Default is the latest v3.1.0
     -l <IP list>                        [Required] "ip1:nodeNum1,ip2:nodeNum2" e.g:"192.168.0.1:2,192.168.0.2:3"
     -L <fisco bcos lightnode exec>      [Optional] fisco bcos light node executable
     -e <fisco-bcos exec>                [Optional] fisco-bcos binary exec

diff --git a/3.x/zh_CN/docs/tutorial/max/installation.md b/3.x/zh_CN/docs/tutorial/max/installation.md
@@ -46,18 +46,18 @@ brew install curl docker docker-compose python3 wget
 ```eval_rst
 .. note::
    - 部署工具 ``BcosBuilder`` 配置和使用请参考 `这里 <./max_builder.html>`_
-   - 若从github下载部署工具 ``BcosBuilder`` 网速太慢，请尝试: curl -#LO https://osp-1257653870.cos.ap-guangzhou.myqcloud.com/FISCO-BCOS/FISCO-BCOS/releases/v3.0.1/BcosBuilder.tgz && tar -xvf BcosBuilder.tgz
+   - 若从github下载部署工具 ``BcosBuilder`` 网速太慢，请尝试: curl -#LO https://osp-1257653870.cos.ap-guangzhou.myqcloud.com/FISCO-BCOS/FISCO-BCOS/releases/v3.1.0/BcosBuilder.tgz && tar -xvf BcosBuilder.tgz
 ```
 
 ```shell
 # 创建操作目录
 mkdir -p ~/fisco && cd ~/fisco
 
 # 下载区块链构建工具BcosBuilder
-curl -#LO https://github.com/FISCO-BCOS/FISCO-BCOS/releases/download/v3.0.1/BcosBuilder.tgz && tar -xvf BcosBuilder.tgz
+curl -#LO https://github.com/FISCO-BCOS/FISCO-BCOS/releases/download/v3.1.0/BcosBuilder.tgz && tar -xvf BcosBuilder.tgz
 
 # Note: 若网速太慢，可尝试如下命令下载部署脚本:
-curl -#LO https://osp-1257653870.cos.ap-guangzhou.myqcloud.com/FISCO-BCOS/FISCO-BCOS/releases/v3.0.1/BcosBuilder.tgz && tar -xvf BcosBuilder.tgz
+curl -#LO https://osp-1257653870.cos.ap-guangzhou.myqcloud.com/FISCO-BCOS/FISCO-BCOS/releases/v3.1.0/BcosBuilder.tgz && tar -xvf BcosBuilder.tgz
 
 # 安装构建工具依赖包
 cd BcosBuilder && pip3 install -r requirements.txt
@@ -429,7 +429,7 @@ sudo yum install -y java java-devel
 **步骤1：下载控制台**
 
 ```shell
-cd ~/fisco && curl -LO https://github.com/FISCO-BCOS/console/releases/download/v3.0.1/download_console.sh && bash download_console.sh
+cd ~/fisco && curl -LO https://github.com/FISCO-BCOS/console/releases/download/v3.1.0/download_console.sh && bash download_console.sh
 ```
 ```eval_rst
 .. note::
@@ -464,7 +464,7 @@ cd ~/fisco/console && bash start.sh
 
 ```shell
 =============================================================================================
-Welcome to FISCO BCOS console(3.0.1)!
+Welcome to FISCO BCOS console(3.1.0)!
 Type 'help' or 'h' for help. Type 'quit' or 'q' to quit console.
  ________ ______  ______   ______   ______       _______   ______   ______   ______
 |        |      \/      \ /      \ /      \     |       \ /      \ /      \ /      \

diff --git a/3.x/zh_CN/docs/tutorial/pro/expand_group.md b/3.x/zh_CN/docs/tutorial/pro/expand_group.md
@@ -302,7 +302,7 @@ mod hello_world {
 ```shell
 $ bash start group2
 =============================================================================================
-Welcome to FISCO BCOS console(3.0.1)!
+Welcome to FISCO BCOS console(3.1.0)!
 Type 'help' or 'h' for help. Type 'quit' or 'q' to quit console.
  ________ ______  ______   ______   ______       _______   ______   ______   ______
 |        |      \/      \ /      \ /      \     |       \ /      \ /      \ /      \