Skip to content

Commit

Permalink
Merge pull request #1790 from wenlinlee/0328
Browse files Browse the repository at this point in the history
add 3.7.0 doc
  • Loading branch information
wenlinlee authored Mar 28, 2024
2 parents db80574 + 17b0109 commit e176bbe
Show file tree
Hide file tree
Showing 3 changed files with 149 additions and 0 deletions.
29 changes: 29 additions & 0 deletions 2.x/docs/compatibility.md
Original file line number Diff line number Diff line change
Expand Up @@ -83,6 +83,7 @@ FISCO-BCOS 3.0.0 及之后的版本之间相互兼容。FISCO-BCOS 3.0.0-rc的
- [v3.4.0](https://fisco-bcos-documentation.readthedocs.io/zh_CN/latest/docs/compatibility.html#fisco-bcos-v3-4-x)
- [v3.5.0](https://fisco-bcos-documentation.readthedocs.io/zh_CN/latest/docs/compatibility.html#fisco-bcos-v3-5-x)
- [v3.6.0](https://fisco-bcos-documentation.readthedocs.io/zh_CN/latest/docs/compatibility.html#fisco-bcos-v3-6-x)
- [v3.7.0](https://fisco-bcos-documentation.readthedocs.io/zh_CN/latest/docs/compatibility.html#fisco-bcos-v3-7-x)

#### 3.2.1. FISCO-BCOS v3.0.0-rc1

Expand Down Expand Up @@ -419,3 +420,31 @@ FISCO-BCOS 3.0.0 及之后的版本之间相互兼容。FISCO-BCOS 3.0.0-rc的
| WeBankBlockchain-Governance-Key | 私钥管理组件 | v1.0.2 | [文档](https://governance-doc.readthedocs.io/zh_CN/latest/docs/WeBankBlockchain-Governance-Key/index.html) | [github](https://github.com/WeBankBlockchain/Governance-Key) | [gitee](https://gitee.com/WeBankBlockchain/Governance-Key) | |
| WeBankBlockchain-Governance-Authority | 权限治理组件 | V3 | [文档](https://governance-doc.readthedocs.io/zh_CN/v3.0.0/docs/WeBankBlockchain-Governance-Acct/index.html) | [github](https://github.com/WeBankBlockchain/Governance-Account/tree/V3) | [gitee](https://gitee.com/WeBankBlockchain/Governance-Account/tree/V3/) | |
| WeBankBlockchain-Governance-Account | 账户治理组件 | V3 | [文档](https://governance-doc.readthedocs.io/zh_CN/v3.0.0/docs/WeBankBlockchain-Governance-Auth/index.html) | [github](https://github.com/WeBankBlockchain/Governance-Authority/tree/V3) | [gitee](https://gitee.com/WeBankBlockchain/Governance-Authority/tree/V3/) | |

#### 3.2.12. FISCO-BCOS v3.7.x

| 项目 | 功能简介 | 版本 | 文档 | github | gitee | 备注 |
|---------------------------------------|------------------------|-------------|-----------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------|---------------------------------------------------------------------------|--------------------------|
| FISCO-BCOS | 区块链底层平台 | v3.7.x | [文档](https://fisco-bcos-doc.readthedocs.io/zh_CN/latest/) | [github](https://github.com/FISCO-BCOS/FISCO-BCOS/tree/v3.5.0) | [gitee](https://gitee.com/FISCO-BCOS/FISCO-BCOS/tree/v3.5.0) | |
| Solidity | solidity智能合约 | v0.8.11 | [文档](https://docs.soliditylang.org/en/v0.8.11) | | | **最高支持solidity v0.8.11** |
| JavaSDK | Java语言SDK | v3.5.x | [文档](https://fisco-bcos-doc.readthedocs.io/zh_CN/latest/docs/develop/sdk/java_sdk/index.html) | [github](https://github.com/FISCO-BCOS/java-sdk/tree/v3.5.0) | [gitee](https://gitee.com/FISCO-BCOS/java-sdk/tree/v3.5.0) | |
| GoSDK | Go语言SDK | 开发中 | | [github](https://github.com/FISCO-BCOS/go-sdk) | | |
| PythonSDK | Python语言SDK | 暂不支持 | | | | |
| 控制台(console) | 交互式命令行工具 | v3.7.x | [文档](https://fisco-bcos-doc.readthedocs.io/zh_CN/latest/docs/develop/console/index.html) | [github](https://github.com/FISCO-BCOS/console/tree/v3.5.0) | [gitee](https://gitee.com/FISCO-BCOS/console/tree/v3.5.0) | |
| java-sdk-demo | Java压测工具 | v3.7.x | [文档](https://fisco-bcos-doc.readthedocs.io/zh_CN/latest/docs/develop/stress_testing.html) | [github](https://github.com/FISCO-BCOS/java-sdk-demo/tree/3.5.0) | [gitee](https://gitee.com/FISCO-BCOS/java-sdk-demo/tree/3.5.0) | |
| spring-boot-starter | Gradle SpringBoot 应用示例 | v3.0.0 | [文档](https://github.com/FISCO-BCOS/spring-boot-starter/tree/v3.0.0-rc4#spring-boot-starter) | [github](https://github.com/FISCO-BCOS/spring-boot-starter/tree/v3.0.0) | [gitee](https://gitee.com/FISCO-BCOS/spring-boot-starter/tree/v3.0.0) | |
| spring-boot-crud | Maven SpringBoot 应用示例 | v3.0.0 | [文档](https://github.com/FISCO-BCOS/spring-boot-crud/tree/v3.0.0-rc4#spring-boot-crud) | [github](https://github.com/FISCO-BCOS/spring-boot-crud/tree/v3.0.0) | [gitee](https://gitee.com/FISCO-BCOS/spring-boot-crud/tree/v3.0.0) | |
| generator | 企业区块链部署工具 | 不支持 | | | | |
| WeBASE | 区块链中间件平台 | v3.0.2 | [文档](https://webasedoc.readthedocs.io/zh_CN/lab/) | [github](https://github.com/WeBankBlockchain/WeBASE/tree/master-3.0) | [gitee](https://gitee.com/WeBank/WeBASE/tree/master-3.0) | |
| WeCross | 跨链协作平台 | v1.3.0 | | | | |
| WeIdentity | 分布式身份解决方案 | v3.0.0-rc.1 | [文档](https://weidentity.readthedocs.io/zh_CN/latest/) | [github](https://github.com/WeBankBlockchain/WeIdentity) | [gitee](https://gitee.com/WeBank/WeIdentity) | |
| WeBankBlockchain-Data-Export | 数据导出组件 | V3 | [文档](https://data-doc.readthedocs.io/zh_CN/data_export_3.0/docs/WeBankBlockchain-Data-Export/index.html) | [github](https://github.com/WeBankBlockchain/Data-Export/tree/V3) | [gitee](https://gitee.com/WeBankBlockchain/Data-Export/tree/V3/) | |
| WeBankBlockchain-Data-Stash | 数据仓库组件 | 不支持 | | | | |
| WeBankBlockchain-Data-Reconcile | 数据对账组件 | v1.0.0 | [文档](https://data-doc.readthedocs.io/zh_CN/latest/docs/WeBankBlockchain-Data-Reconcile/index.html) | [github](https://github.com/WeBankBlockchain/Data-Reconcile) | [gitee](https://gitee.com/WeBankBlockchain/Data-Reconcile) | |
| WeBankBlockchain-SmartDev-Scaffold | 应用开发脚手架 | V3 | [文档](https://toolkit-doc.readthedocs.io/zh_CN/latest/docs/WeBankBlockchain-SmartDev-Scaffold/index.html) | [github](https://github.com/WeBankBlockchain/SmartDev-Scaffold/tree/V3) | [gitee](https://gitee.com/WeBankBlockchain/SmartDev-Scaffold/tree/V3/) | |
| WeBankBlockchain-SmartDev-SCGP | 智能合约编译插件 | v1.0.1 | [文档](https://toolkit-doc.readthedocs.io/zh_CN/latest/docs/WeBankBlockchain-SmartDev-SCGP/index.html) | [github](https://github.com/WeBankBlockchain/SmartDev-SCGP) | [gitee](https://gitee.com/WeBankBlockchain/SmartDev-SCGP) | |
| WeBankBlockchain-SmartDev-Contract | 智能合约库 | v1.0.0 | [文档](https://toolkit-doc.readthedocs.io/zh_CN/latest/docs/WeBankBlockchain-SmartDev-Contract/index.html) | [github](https://github.com/WeBankBlockchain/SmartDev-Contract) | [gitee](https://gitee.com/WeBankBlockchain/SmartDev-Contract) | |
| WeBankBlockchain-Governance-Cert | 证书管理组件 | v1.0.1 | [文档](https://governance-doc.readthedocs.io/zh_CN/latest/docs/WeBankBlockchain-Governance-Cert/index.html) | [github](https://github.com/WeBankBlockchain/Governance-Cert) | [gitee](https://gitee.com/WeBankBlockchain/Governance-Cert) | |
| WeBankBlockchain-Governance-Key | 私钥管理组件 | v1.0.2 | [文档](https://governance-doc.readthedocs.io/zh_CN/latest/docs/WeBankBlockchain-Governance-Key/index.html) | [github](https://github.com/WeBankBlockchain/Governance-Key) | [gitee](https://gitee.com/WeBankBlockchain/Governance-Key) | |
| WeBankBlockchain-Governance-Authority | 权限治理组件 | V3 | [文档](https://governance-doc.readthedocs.io/zh_CN/v3.0.0/docs/WeBankBlockchain-Governance-Acct/index.html) | [github](https://github.com/WeBankBlockchain/Governance-Account/tree/V3) | [gitee](https://gitee.com/WeBankBlockchain/Governance-Account/tree/V3/) | |
| WeBankBlockchain-Governance-Account | 账户治理组件 | V3 | [文档](https://governance-doc.readthedocs.io/zh_CN/v3.0.0/docs/WeBankBlockchain-Governance-Auth/index.html) | [github](https://github.com/WeBankBlockchain/Governance-Authority/tree/V3) | [gitee](https://gitee.com/WeBankBlockchain/Governance-Authority/tree/V3/) | |
100 changes: 100 additions & 0 deletions 3.x/zh_CN/docs/introduction/change_log/3_7_0.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,100 @@
# v3.7.0

#### 新增

* [交易数据结构新增memo字段](https://github.com/FISCO-BCOS/FISCO-BCOS/pull/4253)

#### 修复

* [更新 tikv_client/bcos-wasm/wedprcrypto和rust工具链版本](https://github.com/FISCO-BCOS/FISCO-BCOS/pull/4255)
* [更新TASSL以解决mac上的编译问题](https://github.com/FISCO-BCOS/FISCO-BCOS/pull/4289)
* [修复已部署空abi,部署相同的合约getABI失败的问题](https://github.com/FISCO-BCOS/FISCO-BCOS/pull/4276)
* [修复开启合约部署权限后账户资产转移受限的问题](https://github.com/FISCO-BCOS/FISCO-BCOS/pull/4252)
* [修复build_chain.sh一键搭建pro/max区块链过程中安装python失败的问题](https://github.com/FISCO-BCOS/FISCO-BCOS/pull/4307)


* 历史版本升级

需要升级的链的“数据兼容版本号([compatibility_version](#id5))”为如下版本时:

* 3.4.x、3.5.x,3.6.x、3.7.x:数据完全兼容当前版本,直接替换二进制即可完成升级
*
3.3.x、3.2.x、3.1.x、3.0.x:支持通过替换二进制进行灰度升级,若需使用当前版本的新特性,需升级数据兼容版本号,操作见[文档](#id5)
* 3.0-rc x:数据不兼容,无法升级,可考虑逐步将业务迁移至3.x正式版
* 2.x:数据不兼容,2.x版本仍持续维护,可考虑升级为2.x的最新版本


* 开启实验功能

效果:通过feature开关控制实验功能的开启

操作:升级节点可执行程序后,通过控制台命令`setSystemConfigByKey <feature名> 1` 开启对应实验功能,具体操作见文档升级方法部分

注意事项:
* feature操作不可逆,打开后不可关闭
* 需确认所有可执行程序版本相同后,再进行feature开启操作

| | Feature 名 | 默认状态 | 说明 |
|-----------|----------------------------|------|--------------------------------------------|
| 资产管理 | feature_balance | 关:0 | 默认关闭 |
| 资产操作预编译合约 | feature_balance_precompile | 关:0 | 默认关闭 |
| 计费模式 | feature_policy1 | 关:0 | 默认关闭 |
| 块内分片 | feature_sharding | 关:0 | 默认关闭,仅在从3.3、3.4升级至当前版本时,feature_sharding打开 |
| 同态加密 | feature_paillier | 关:0 | 默认关闭 |
| rpbft共识 | feature_rpbft | 关:0 | 默认关闭 |
| bug修复 | bugfix_\<bug_name\> | 开:1 | 从低版本升级默认关闭 |

**组件兼容性**

| | 推荐版本 | 最低版本 | 说明 |
|------------|-------------|---------------------|-------------------|
| WeBASE | 3.0.2 | 3.0.2 | |
| WeIdentity | v3.0.0-rc.1 | v3.0.0-rc.1 | |
| Console | 3.7.0 | 3.0.0 | |
| Java SDK | 3.7.0 | 3.0.0 | |
| CPP SDK | 3.7.0 | 3.0.0 | |
| Solidity | 0.8.11 | 最低 0.4.25,最高 0.8.11 | 需根据合约版本下载编译器(控制台) |
| WBC-Liquid | 1.0.0-rc3 | 1.0.0-rc3 | |

#### 升级方法

该操作仅支持将3.x版本升级为本版本,不支持3.0-rc或2.x的升级。

##### 查询数据兼容版本号(compatibility_version)

[控制台](https://fisco-bcos-doc.readthedocs.io/zh_CN/latest/docs/operation_and_maintenance/console/console_commands.html#getsystemconfigbykey)
进行查询,如当前返回的版本为3.6.0

```
[group0]: /apps> getSystemConfigByKey compatibility_version
3.6.0
```

##### 替换节点二进制

需将**所有节点**
的二进制逐步替换为当前版本。为了不影响业务,替换过程能够以灰度方式进行,逐个替换并重启节点。替换过程中,当前的链仍然会以旧的数据兼容版本号的逻辑继续执行。当所有节点二进制替换完成并重启后,需用控制台修改数据兼容版本号为当前版本。

##### 设置数据兼容版本号(compatibility_version)

[控制台](https://fisco-bcos-doc.readthedocs.io/zh_CN/latest/docs/operation_and_maintenance/console/console_commands.html#setsystemconfigbykey)
设置数据兼容版本号,如当前版本为3.7.0。

```
[group0]: /apps> setSystemConfigByKey compatibility_version 3.7.0
{
"code":0,
"msg":"success"
}
注:若开启权限治理功能,需要使用 setSysConfigProposal 命令
```

设置成功,再次查询,得到当前版本已升级为3.7.0

```
[group0]: /apps> getSystemConfigByKey compatibility_version
3.7.0
```

当前链已经完成升级,至此,**链开始以新的逻辑继续运行**,并支持了新的特性。
20 changes: 20 additions & 0 deletions 3.x/zh_CN/docs/introduction/change_log/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,26 @@ FISCO BCOS 设计 Feature控制特性功能开启关闭,用户可以根据自
:maxdepth: 0

upgrade.md
v3.7.x
------------------

.. admonition:: FISCO BCOS 3.x Releases

- `FISCO BCOS v3.7.0 <./3_7_0.html>`_ [`release <https://github.com/FISCO-BCOS/FISCO-BCOS/releases/tag/v3.7.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``
- 查看轻节点二进制版本:``../fisco-bcos-lightnode --version``
- 查看轻节点相关文档,请参考 [`轻节点搭建工具 <https://fisco-bcos-doc.readthedocs.io/zh_CN/latest/docs/tutorial/lightnode.html>`_]

.. toctree::
:hidden:
:maxdepth: 0

3_7_0.md

v3.6.x
------------------
Expand Down

0 comments on commit e176bbe

Please sign in to comment.