Add 2.4.0 changeLog && update related version to 2.4.0 (#786)

* Add 2.4.0 changeLog && update related version to 2.4.0 * fix pbft_process.png spelling error
FISCO-BCOS · Apr 24, 2020 · 16a3bd0 · 16a3bd0
1 parent 555791c
commit 16a3bd0
Show file tree

Hide file tree

Showing 17 changed files with 130 additions and 18 deletions.
diff --git a/conf.py b/conf.py
@@ -107,9 +107,9 @@ def _patched_fetch_urls(lfs_url, oid_list):
 # built documents.
 #
 # The short X.Y version.
-version = '2.3'
+version = '2.4'
 # The full version, including alpha/beta/rc tags.
-release = 'v2.3.0'
+release = 'v2.4.0'
 
 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.

diff --git a/docs/change_log/2_4_0.md b/docs/change_log/2_4_0.md
@@ -0,0 +1,51 @@
+# [v2.4.0](https://github.com/FISCO-BCOS/FISCO-BCOS/releases/tag/v2.4.0)
+
+```eval_rst
+.. admonition:: v2.3.x升级到v2.4.0
+
+    - **兼容升级** ：直接替换v2.3.x节点的二进制为 `v2.4.0二进制 <https://github.com/FISCO-BCOS/FISCO-BCOS/releases/download/v2.4.0/fisco-bcos.tar.gz>`_ ，升级后的版本修复v2.3.x中的bug，并新增了2.4.0动态群组生命周期管理功能、网络统计功能，但不会包含2.4.0所有特性，普通场景下可回滚至v2.3.x。回滚方法参考本文最后一节。
+
+    - **全面升级** ：参考 `安装 <../installation.html>`_ 搭建新链，重新向新节点提交所有历史交易，升级后节点包含v2.4.0所有新特性
+
+    - `v2.4.0 Release Note <https://github.com/FISCO-BCOS/FISCO-BCOS/releases/tag/v2.4.0>`_
+```
+
+## 变更描述
+
+**新特性**
+
+- 支持动态群组生命周期管理
+- 支持网络流量和Gas统计
+- Precompiled合约支持Gas
+- 支持EVM Gas衡量标准插件化配置
+- 添加新接口SendTransactionAndGetProof推送交易和交易回执证明
+
+
+**更新**
+
+- CMake最低要求修改为3.7，支持依赖库多源下载
+
+
+**修复**
+
+- 修复国密模式下ecRecover接口不可用问题
+- 修复国密模式、非国密模式下sha256接口返回值不一致的问题
+
+**兼容性**
+
+**向前兼容**，旧版本可以直接替换程序升级，替换后的节点修复v2.3.x中的bug，并新增了2.4.0的动态群组生命周期管理功能、网络统计功能，若要启用v2.4.0版本所有新特性，需重新搭链。
+
+
+|            | 推荐版本                | 最低版本  | 说明                   |
+| ---------- | ----------------------- | --------- | ---------------------- |
+| 控制台     | 1.0.9                   | 1.0.4     |                        |
+| SDK        | 2.4.0                   | 2.0.4     |                        |
+| generator  | 1.4.0                   | 1.1.0     | 搭建新链需要使用该版本 |
+| 浏览器     | 2.0.2                   | 2.0.0-rc2 |                        |
+| Solidity   | 最高支持 solidity 0.5.2 | 0.4.11    |                        |
+| amdb-proxy | 2.3.0                   | 2.0.2     |                        |
+
+**兼容模式回滚至v2.2.x方法**
+
+当节点采用兼容模式从v2.3.x升级至v2.4.0后，可直接通过将节点二进制替换回v2.3.x完成回滚。
+
diff --git a/docs/change_log/index.rst b/docs/change_log/index.rst
@@ -2,6 +2,11 @@
 版本及兼容
 ##############################################################
 
+.. admonition:: `FISCO BCOS 2.4.0 <https://github.com/FISCO-BCOS/FISCO-BCOS/releases/tag/v2.4.0>`_
+
+     **变更描述、兼容及升级说明**
+      - `FISCO BCOS v2.4.0 <./2_4_0.html>`_
+
 .. admonition:: `FISCO BCOS 2.3.0 <https://github.com/FISCO-BCOS/FISCO-BCOS/releases/tag/v2.3.0>`_
 
      **变更描述、兼容及升级说明**
@@ -91,7 +96,8 @@
 
 .. toctree::
    :hidden:
-
+
+   2_4_0.md
    2_3_0.md
    2_2_0.md
    2_1_0.md

diff --git a/docs/installation.md b/docs/installation.md
@@ -34,7 +34,7 @@ cd ~ && mkdir -p fisco && cd fisco
 - 下载`build_chain.sh`脚本
 
 ```bash
-curl -LO https://github.com/FISCO-BCOS/FISCO-BCOS/releases/download/v2.3.0/build_chain.sh && chmod u+x build_chain.sh
+curl -LO https://github.com/FISCO-BCOS/FISCO-BCOS/releases/download/v2.4.0/build_chain.sh && chmod u+x build_chain.sh
 ```
 
 ### 搭建单群组4节点联盟链

diff --git a/docs/manual/distributed_storage.md b/docs/manual/distributed_storage.md
@@ -104,7 +104,7 @@ FISCO BCOS在2.0.0-rc3之后，支持节点通过连接池直连MySQL，相对
 ```bash
 mkdir -p ~/fisco && cd ~/fisco
 # 获取build_chain.sh脚本
-curl -LO https://github.com/FISCO-BCOS/FISCO-BCOS/releases/download/v2.3.0/build_chain.sh && chmod u+x build_chain.sh
+curl -LO https://github.com/FISCO-BCOS/FISCO-BCOS/releases/download/v2.4.0/build_chain.sh && chmod u+x build_chain.sh
 ```
 #### 生成配置文件
 ```bash
@@ -376,7 +376,7 @@ mkdir -p ~/fisco && cd ~/fisco
 - 获取`build_chain`脚本
 
 ```bash
-curl -LO https://github.com/FISCO-BCOS/FISCO-BCOS/releases/download/v2.3.0/build_chain.sh && chmod u+x build_chain.sh
+curl -LO https://github.com/FISCO-BCOS/FISCO-BCOS/releases/download/v2.4.0/build_chain.sh && chmod u+x build_chain.sh
 ```
 
 #### 生成配置文件

diff --git a/docs/manual/group_use_cases.md b/docs/manual/group_use_cases.md
@@ -74,7 +74,7 @@ mkdir -p ~/fisco && cd ~/fisco
 
 - 获取build_chain.sh脚本
 ```bash
-curl -LO https://github.com/FISCO-BCOS/FISCO-BCOS/releases/download/v2.3.0/build_chain.sh && chmod u+x build_chain.sh
+curl -LO https://github.com/FISCO-BCOS/FISCO-BCOS/releases/download/v2.4.0/build_chain.sh && chmod u+x build_chain.sh
 ```
 
 **生成星形区块链系统配置文件**
@@ -555,7 +555,7 @@ $ cd ~/fisco/nodes/127.0.0.1 && bash stop_all.sh
 ```bash
 $ mkdir -p ~/fisco && cd ~/fisco
 # 获取build_chain.sh脚本
-$ curl -LO https://github.com/FISCO-BCOS/FISCO-BCOS/releases/download/v2.3.0/build_chain.sh && chmod u+x build_chain.sh
+$ curl -LO https://github.com/FISCO-BCOS/FISCO-BCOS/releases/download/v2.4.0/build_chain.sh && chmod u+x build_chain.sh
 # 构建本机单群组四节点区块链(生产环境中，建议每个节点部署在不同物理机上)
 $ bash build_chain.sh -l "127.0.0.1:4" -o multi_nodes -p 20000,20100,7545
 Generating CA key...

diff --git a/docs/manual/guomi_crypto.md b/docs/manual/guomi_crypto.md
@@ -12,7 +12,7 @@ $ sudo apt install -y openssl curl
 # 准备环境
 $ cd ~ && mkdir -p fisco && cd fisco
 # 下载build_chain.sh脚本
-$ curl -LO https://github.com/FISCO-BCOS/FISCO-BCOS/releases/download/v2.3.0/build_chain.sh && chmod u+x build_chain.sh
+$ curl -LO https://github.com/FISCO-BCOS/FISCO-BCOS/releases/download/v2.4.0/build_chain.sh && chmod u+x build_chain.sh
 ```
 
 执行完上述步骤后，fisco目录下结构如下：

diff --git a/en/conf.py b/en/conf.py
@@ -108,9 +108,9 @@ def _patched_fetch_urls(lfs_url, oid_list):
 # built documents.
 #
 # The short X.Y version.
-version = '2.3'
+version = '2.4'
 # The full version, including alpha/beta/rc tags.
-release = 'v2.3.0'
+release = 'v2.4.0'
 
 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.

diff --git a/en/docs/change_log/2_4_0.md b/en/docs/change_log/2_4_0.md
@@ -0,0 +1,49 @@
+# [v2.3.0](https://github.com/FISCO-BCOS/FISCO-BCOS/releases/tag/v2.3.0)
+
+```eval_rst
+.. admonition:: v2.3.x upgraded to v2.4.0
+
+    - **Compatible upgrade** ：Directly replace the binary of the v2.3.x node with the `v2.4.0 binary <https://github.com/FISCO-BCOS/FISCO-BCOS/releases/download/v2.4.0/fisco-bcos.tar.gz>`_ , the upgraded version fixes bugs in v2.3.x, and includes 2.4.0 dynamic group life cycle management function, network statistics function, but will not enable all the features of 2.4.0, in normal scenarios, you can roll back to v2.3.x. For the rollback method, refer to the last section of this article.
+
+    - **Full upgrade** ：Refer to `Installation <../ installation.html>`_ to build a new chain and resubmit all historical transactions to the new node. The upgraded node includes new features in v2.4.0
+
+    - `v2.4.0 Release Note <https://github.com/FISCO-BCOS/FISCO-BCOS/releases/tag/v2.4.0>`_
+```
+
+## Change description
+
+**New features**
+
+- Support dynamic group life cycle management
+- Support network traffic and Gas statistics
+- Precompiled contract supports Gas
+- Support EVM Gas measurement standard plug-in configuration
+- Add new interface SendTransactionAndGetProof push transaction and transaction receipt proof
+
+**Update**
+
+- The minimum requirement of CMake is modified to 3.7, supporting multi-source download of dependent libraries 
+
+**Fix**
+
+- Fix the problem that the ecRecover interface is not available in the national secret mode
+- Fix the inconsistent return value of sha256 interface in national secret mode and non-national secret mode
+
+
+**compatibility**
+
+**Forward compatible**, The old version can directly replace the program upgrade, the replaced node fixes the bug in v2.3.x, and includes 2.4.0 dynamic group life cycle management function and network statistics function, to enable all new features in v2.4.0, you need to rebuild the blockchain.
+
+|                    | Recommended version | Minimum version | Description |
+| ------------------ | ------------------- | --------------- | ----------- |
+| console            | 1.0.9               | 1.0.4           |             |
+| SDK                | 2.4.0               | 2.0.4           |             |
+| generator          | 1.4.0               | 1.1.0           |             |
+| FISCO BCOS browser | 2.0.2               | 2.0.0-rc2       |             |
+| Solidity           | up to 0.5.2         | 0.4.11          |             |
+| amdb-proxy         | 2.3.0               | 2.0.2           |             |
+
+**Compatibility mode rollback to v2.2.x method**
+
+After a node is upgraded from v2.3.x to v2.4.0 in compatibility mode, the rollback can be completed directly by replacing the node binary back to v2.3.x.
+
diff --git a/en/docs/change_log/index.rst b/en/docs/change_log/index.rst
@@ -2,6 +2,11 @@
 Compatibility
 ##############################################################
 
+.. admonition:: `FISCO BCOS 2.4.0 <https://github.com/FISCO-BCOS/FISCO-BCOS/releases/tag/v2.4.0>`_
+
+     **Change description, compatibility and upgrade instructions**
+      - `FISCO BCOS v2.3.0 <./2_4_0.html>`_
+
 .. admonition:: `FISCO BCOS 2.3.0 <https://github.com/FISCO-BCOS/FISCO-BCOS/releases/tag/v2.3.0>`_
 
      **Change description, compatibility and upgrade instructions**
@@ -91,6 +96,7 @@ Compatibility
 .. toctree::
    :hidden:
 
+   2_4_0.md
    2_3_0.md
    2_2_0.md
    2_1_0.md

diff --git a/en/docs/installation.md b/en/docs/installation.md
@@ -32,7 +32,7 @@ cd ~ && mkdir -p fisco && cd fisco
 - Download `build_chain.sh` script
 
 ```bash
-curl -LO https://github.com/FISCO-BCOS/FISCO-BCOS/releases/download/v2.3.0/build_chain.sh && chmod u+x build_chain.sh
+curl -LO https://github.com/FISCO-BCOS/FISCO-BCOS/releases/download/v2.4.0/build_chain.sh && chmod u+x build_chain.sh
 ```
 
 ### Build a single-group 4-node consortium chain

diff --git a/en/docs/manual/distributed_storage.md b/en/docs/manual/distributed_storage.md
@@ -53,7 +53,7 @@ Before using distributed storage, you need to complete the establishment of the
 ```bash
 mkdir -p ~/fisco && cd ~/fisco
 # Download build_chain.sh script
-curl -LO https://github.com/FISCO-BCOS/FISCO-BCOS/releases/download/v2.3.0/build_chain.sh && chmod u+x build_chain.sh
+curl -LO https://github.com/FISCO-BCOS/FISCO-BCOS/releases/download/v2.4.0/build_chain.sh && chmod u+x build_chain.sh
 ```
 #### Generate configuration file
 ```bash
@@ -347,7 +347,7 @@ mkdir -p ~/fisco && cd ~/fisco
 - get `build_chain` script
 
 ```bash
-curl -LO https://github.com/FISCO-BCOS/FISCO-BCOS/releases/download/v2.3.0/build_chain.sh && chmod u+x build_chain.sh
+curl -LO https://github.com/FISCO-BCOS/FISCO-BCOS/releases/download/v2.4.0/build_chain.sh && chmod u+x build_chain.sh
 ```
 
 #### Generate configuration file

diff --git a/en/docs/manual/group_use_cases.md b/en/docs/manual/group_use_cases.md
@@ -79,7 +79,7 @@ mkdir -p ~/fisco && cd ~/fisco
 
 - Download the build_chain.sh script
 ```bash
-curl -LO https://github.com/FISCO-BCOS/FISCO-BCOS/releases/download/v2.3.0/build_chain.sh && chmod u+x build_chain.sh
+curl -LO https://github.com/FISCO-BCOS/FISCO-BCOS/releases/download/v2.4.0/build_chain.sh && chmod u+x build_chain.sh
 ```
 
 **Generate configuration for star networking blockchain system**
@@ -564,7 +564,7 @@ In a parallel multi-group scenario, node join and exit group operations are simi
 ```bash
 $ mkdir -p ~/fisco && cd ~/fisco
 # Download build_chain.sh script
-$ curl -LO https://github.com/FISCO-BCOS/FISCO-BCOS/releases/download/v2.3.0/build_chain.sh && chmod u+x build_chain.sh
+$ curl -LO https://github.com/FISCO-BCOS/FISCO-BCOS/releases/download/v2.4.0/build_chain.sh && chmod u+x build_chain.sh
 #Build a local single-group four-node blockchain (in a production environment, it is recommended that each node be deployed on a different physical machine)
 $ bash build_chain.sh -l "127.0.0.1:4" -o multi_nodes -p 20000,20100,7545
 Generating CA key...

diff --git a/en/docs/manual/guomi_crypto.md b/en/docs/manual/guomi_crypto.md
@@ -12,7 +12,7 @@ $ sudo apt install -y openssl curl
 # prepare environment
 $ cd ~ && mkdir -p fisco && cd fisco
 # download build_chain.sh script
-$ curl -LO https://github.com/FISCO-BCOS/FISCO-BCOS/releases/download/v2.3.0/build_chain.sh && chmod u+x build_chain.sh
+$ curl -LO https://github.com/FISCO-BCOS/FISCO-BCOS/releases/download/v2.4.0/build_chain.sh && chmod u+x build_chain.sh
 ```
 
 After performing the above steps, the structure in the fisco directory is as follows:

diff --git a/en/images/consensus/pbft_process.png b/en/images/consensus/pbft_process.png
diff --git a/images/consensus/pbft_process.png b/images/consensus/pbft_process.png
diff --git a/release_note.txt b/release_note.txt
@@ -1 +1 @@
-v2.3.0
+v2.4.0