Skip to content

Commit

Permalink
update 3.10.0 doc
Browse files Browse the repository at this point in the history
  • Loading branch information
wenlinlee committed Aug 6, 2024
1 parent b2caebf commit b23ba8d
Show file tree
Hide file tree
Showing 13 changed files with 187 additions and 30 deletions.
56 changes: 56 additions & 0 deletions 2.x/docs/compatibility.md

Large diffs are not rendered by default.

28 changes: 28 additions & 0 deletions 3.x/zh_CN/docs/introduction/change_log/3_10_0.md
Original file line number Diff line number Diff line change
Expand Up @@ -106,3 +106,31 @@
```

当前链已经完成升级,至此,**链开始以新的逻辑继续运行**,并支持了新的特性。

#### EVM升级至CANCUN使用说明

首先通过控制台命令`setSystemConfigByKey feature_evm_cancun 1`开启EVM升级至CANCUN功能,然后部署0.8.26版本的合约。

注意:在部署0.8.26版本合约时,需要在depoly 后面指定sol-version 为0.8.26,如下所示:

```
[group0]: /apps> deploy StorageSlot.sol --sol-version 0.8.26
transaction hash: 0x8f3564047e3dd2913ed30f193e10c2b8af2b24896ce10b8add8eb47b888d7505
contract address: 0x29f1926cab679bc8bdd0757fb92adf020c8bd398
currentAccount: 0x0296737557c85bde21b4cf766c3f85e2e4c14d66
// 否则使用默认0.8.11版本编译则会报错
[group0]: /apps> deploy StorageSlot.sol
Warning: SPDX license identifier not provided in source file. Before publishing, consider adding a comment containing "SPDX-License-Identifier: <SPDX-License>" to each source file. Use "SPDX-License-Identifier: UNLICENSED" for non-open-source code. Please see https://spdx.org for more information.
--> StorageSlot.sol
Error: Function "tload" not found.
--> StorageSlot.sol:127:22:
|
127 | value := tload(slot)
| ^^^^^
Error: Variable count for assignment to "value" does not match number of values (1 vs. 0)
```
19 changes: 10 additions & 9 deletions 3.x/zh_CN/docs/introduction/change_log/feature_bugfix_list.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,15 +4,16 @@

## 1. 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 | 默认关闭 |
| dmc切换至串行 | feature_dmc2serial | 关:0 | 默认关闭 |
| | 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 | 默认关闭 |
| dmc切换至串行 | feature_dmc2serial | 关:0 | 默认关闭 |
| EVM升级至CANCUN | feature_evm_cancun | 关:0 | 默认关闭 |

## 2. bugfix列表

Expand Down
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.10.x
------------------

.. admonition:: FISCO BCOS 3.x Releases

- `FISCO BCOS v3.10.0 <./3_10_0.html>`_ [`release <https://github.com/FISCO-BCOS/FISCO-BCOS/releases/tag/v3.10.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_10_0.md

v3.9.x
------------------
Expand Down
6 changes: 3 additions & 3 deletions 3.x/zh_CN/docs/quick_start/air_installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.9.0/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.10.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.9.0/build_chain.sh && chmod u+x build_chain.sh
curl -#LO https://github.com/FISCO-BCOS/FISCO-BCOS/releases/download/v3.10.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.9.0/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.10.0/build_chain.sh && chmod u+x build_chain.sh
```

### 第三步. 搭建4节点非国密联盟链
Expand Down
2 changes: 1 addition & 1 deletion 3.x/zh_CN/docs/quick_start/solidity_application.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.6.0/download_console.sh && bash download_console.sh
cd ~/fisco && curl -#LO https://github.com/FISCO-BCOS/console/releases/download/v3.10.0/download_console.sh && bash download_console.sh

# 切换到fisco/console/目录
cd ~/fisco/console/
Expand Down
2 changes: 1 addition & 1 deletion 3.x/zh_CN/docs/quick_start/wbc_liquid_application.md
Original file line number Diff line number Diff line change
Expand Up @@ -86,7 +86,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.6.0/download_console.sh && bash download_console.sh
cd ~/fisco && curl -#LO https://github.com/FISCO-BCOS/console/releases/download/v3.10.0/download_console.sh && bash download_console.sh

# 切换到fisco/console/目录
cd ~/fisco/console/
Expand Down
68 changes: 60 additions & 8 deletions 3.x/zh_CN/docs/tutorial/air/build_chain.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,18 +27,19 @@ FISCO BCOS提供了`build_chain.sh`脚本帮助用户快速搭建FISCO BCOS联

```shell
# 下载建链脚本
curl -#LO https://github.com/FISCO-BCOS/FISCO-BCOS/releases/download/v3.6.0/build_chain.sh && chmod u+x build_chain.sh
curl -#LO https://github.com/FISCO-BCOS/FISCO-BCOS/releases/download/v3.10.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.6.0/build_chain.sh && chmod u+x build_chain.sh

# 键入bash build_chain.sh -h展示脚本用法及参数
$ bash build_chain.sh
Usage:
air
-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.6.0
-v <FISCO-BCOS binary version> [Optional] Default is the latest v3.10.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 lightnode executable, input "download_binary" to download lightnode binary or assign correct lightnode binary path
-e <fisco-bcos exec> [Optional] fisco-bcos binary exec
Expand All @@ -49,28 +50,73 @@ Usage:
-H <HSM model> [Optional] Whether to use HSM(Hardware secure module), default is false
-c <Config Path> [Required when expand node] Specify the path of the expanded node config.ini, config.genesis and p2p connection file nodes.json
-d <CA cert path> [Required when expand node] When expanding the node, specify the path where the CA certificate and private key are located
-D <docker mode> Default off. If set -d, build with docker
-D <docker mode> Default off. If set -D, build with docker
-E <Enable debug log> Default off. If set -E, enable debug log
-a <Auth account> [Optional] when Auth mode Specify the admin account address.
-w <WASM mode> [Optional] Whether to use the wasm virtual machine engine, default is false
-R <Serial_mode> [Optional] Whether to use serial execute,default is true
-k <key page size> [Optional] key page size, default size is 10240
-k <key page size> [Optional] key page size, default is 10240
-m <fisco-bcos monitor> [Optional] node monitor or not, default is false
-i <fisco-bcos monitor ip/port> [Optional] When expanding the node, should specify ip and port
-M <fisco-bcos monitor> [Optional] When expanding the node, specify the path where prometheus are located
-z <Generate tar packet> [Optional] Pack the data on the chain to generate tar packet
-n <node key path> [Optional] set the path of the node key file to load nodeid
-N <node path> [Optional] set the path of the node modified to multi ca mode
-u <multi ca path> [Optional] set the path of another ca for multi ca mode
-6 <ipv6 mode> [Optional] IPv6 mode use :: as default listen ip, default is false
-T <Consensus Algorithm> [Optional] Default PBFT. Options can be pbft / rpbft, pbft is recommended
-h Help
pro or max
-C <Command> [Optional] the command, support 'deploy' 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 <chain version> [Optional] support 'air''pro''max', default is 'air'
-l <IP list> [Required] "ip1:nodeNum1,ip2:nodeNum2" e.g:"192.168.0.1:2,192.168.0.2:3"
-p <Start port> [Optional] Default 30300、20200、40400、2379 means p2p_port start from 30300, rpc_port from 20200, tars_port from 40400, tikv_port default 2379
-e <service binary path> [Optional] rpc gateway node service binary path
-y <service binary download type> [Optional] rpc gateway node service binary download type, default type is cdn
-v <service binary version> [Optional] Default is the latest v3.10.0
-r <service binary download path> [Optional] service binary download path, default is binary
-c <Config Path> [Optional] Specify the path of the deploy node config.toml
-t <deploy type> [Optional] support 'rpc''gateway''node''all', default is 'all'
-o <output dir> [Optional] output directory, default genearted
-s <SM model> [Optional] SM SSL connection or not, default is false
-h Help

deploy nodes e.g
bash build_chain.sh -p 30300,20200 -l 127.0.0.1:4 -o nodes -e ./fisco-bcos
bash build_chain.sh -p 30300,20200 -l 127.0.0.1:4 -o nodes -e ./fisco-bcos -m (部署节点带监控功能)
bash build_chain.sh -p 30300,20200 -l 127.0.0.1:4 -o nodes -e ./fisco-bcos -m
bash build_chain.sh -p 30300,20200 -l 127.0.0.1:4 -o nodes -e ./fisco-bcos -s
expand node e.g
bash build_chain.sh -C expand -c config -d config/ca -o nodes/127.0.0.1/node5 -e ./fisco-bcos
bash build_chain.sh -C expand -c config -d config/ca -o nodes/127.0.0.1/node5 -e ./fisco-bcos -m -i 127.0.0.1:5 -M monitor/prometheus/prometheus.yml (部署节点带监控功能)
bash build_chain.sh -C expand -c config -d config/ca -o nodes/127.0.0.1/node5 -e ./fisco-bcos -m -i 127.0.0.1:5 -M monitor/prometheus/prometheus.yml
bash build_chain.sh -C expand -c config -d config/ca -o nodes/127.0.0.1/node5 -e ./fisco-bcos -s
bash build_chain.sh -C expand_lightnode -c config -d config/ca -o nodes/lightnode1
bash build_chain.sh -C expand_lightnode -c config -d config/ca -o nodes/lightnode1 -L ./fisco-bcos-lightnode
modify node e.g
bash build_chain.sh -C modify -N ./node0 -u ./ca/ca.crt
bash build_chain.sh -C modify -N ./node0 -u ./ca/ca.crt -s
deploy pro service e.g
bash build_chain.sh -p 30300,20200 -l 172.31.184.227:2,172.30.93.111:2 -C deploy -V pro -o generate -t all
bash build_chain.sh -p 30300,20200 -l 172.31.184.227:2,172.30.93.111:2 -C deploy -V pro -o generate -t all -s
bash build_chain.sh -p 30300,20200 -l 172.31.184.227:2,172.30.93.111:2 -C deploy -V pro -o generate -e ./binary
bash build_chain.sh -p 30300,20200,40400 -l 172.31.184.227:2,172.30.93.111:2 -C deploy -V pro -o generate -y cdn -v v3.10.0 -r ./binaryPath
deploy max service e.g
bash build_chain.sh -p 30300,20200,40400,2379 -l 172.31.184.227:1,172.30.93.111:1,172.31.184.54:1,172.31.185.59:1 -C deploy -V max -o generate -t all
bash build_chain.sh -p 30300,20200,40400,2379 -l 172.31.184.227:1,172.30.93.111:1,172.31.184.54:1,172.31.185.59:1 -C deploy -V max -o generate -t all -e ./binary -s
bash build_chain.sh -p 30300,20200,40400,2379 -l 172.31.184.227:1,172.30.93.111:1,172.31.184.54:1,172.31.185.59:1 -C deploy -V max -o generate -y cdn -v v3.10.0 -r ./binaryPath
bash build_chain.sh -c config.toml -C deploy -V max -o generate -t all
expand pro node e.g
bash build_chain.sh -C expand_node -V pro -o expand_node -c ./config.toml
expand pro rpc/gateway e.g
bash build_chain.sh -C expand_service -V pro -o expand_service -c ./config.toml
expand pro group e.g
bash build_chain.sh -C expand_group -V pro -o expand_group -c ./config.toml
expand max node e.g
bash build_chain.sh -C expand_node -V max -o expand_node -c ./config.toml
expand max rpc/gateway e.g
bash build_chain.sh -C expand_service -V max -o expand_service -c ./config.toml

```


Expand Down Expand Up @@ -247,15 +293,21 @@ Processing IP:127.0.0.1 Total:4

查看脚本使用用法。

### **`E`选项[**Optional**]**

可选参数,当需要开启debug日志时,可通过`-E`选项设置开启debug日志。

## 2. 节点配置文件组织结构

`build_chain`生成的节点配置主要如下:

- **根证书和根证书私钥**: 位于指定的配置生成目录的`ca`文件夹。
- **节点连接证书**: 每个节点`conf`目录下均存放节点的网络连接证书,非国密节点证书和私钥主要包括`ca.crt, ssl.crt, sslkey`,国密节点证书和私钥主要包括`sm_ca.crt, sm_ssl.crt, sm_enssl.crt, sm_enssl.key, sm_ssl.key`
- **节点连接证书**: 每个节点`conf`目录下均存放节点的网络连接证书,非国密节点证书和私钥主要包括`ca.crt, ssl.crt, sslkey`
,国密节点证书和私钥主要包括`sm_ca.crt, sm_ssl.crt, sm_enssl.crt, sm_enssl.key, sm_ssl.key`
- **节点签名私钥**: 节点`conf`目录下的`node.pem`,主要位于共识模块的签名。
- **SDK连接证书**: 由`build_chain.sh`生成,客户端可拷贝该证书与节点建立SSL连接。
- **节点配置文件**: 节点目录下的`config.ini``config.genesis`配置,前者主要配置链信息,后者主要配置创世块信息,具体可参考[Air版本区块链节点配置介绍](./config.md)
- **节点配置文件**: 节点目录下的`config.ini``config.genesis`
配置,前者主要配置链信息,后者主要配置创世块信息,具体可参考[Air版本区块链节点配置介绍](./config.md)
- **启停脚本**: `start.sh``stop.sh`,用于启动和停止节点。
- **启停监控脚本**: `monitor/start_monitor.sh``monitor/stop_monitor.sh`,用于启动和停止节点监控。

Expand Down
4 changes: 2 additions & 2 deletions 3.x/zh_CN/docs/tutorial/air/multihost.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ mkdir -p ~/fisco && cd ~/fisco
./download_bin.sh -v 3.4.0

# 下载开发部署工具build_chain
curl -#LO https://github.com/FISCO-BCOS/FISCO-BCOS/releases/download/v3.6.0/build_chain.sh && chmod u+x build_chain.sh
curl -#LO https://github.com/FISCO-BCOS/FISCO-BCOS/releases/download/v3.10.0/build_chain.sh && chmod u+x build_chain.sh
```

**生成多机节点配置**
Expand Down Expand Up @@ -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.6.0/download_console.sh && bash download_console.sh
curl -#LO https://github.com/FISCO-BCOS/console/releases/download/v3.10.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
Expand Down
2 changes: 1 addition & 1 deletion 3.x/zh_CN/docs/tutorial/air/storage_security.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@

下载`build_chain.sh`脚本
``` shell
curl -#LO https://github.com/FISCO-BCOS/FISCO-BCOS/releases/download/v3.6.0/build_chain.sh && chmod u+x build_chain.sh
curl -#LO https://github.com/FISCO-BCOS/FISCO-BCOS/releases/download/v3.10.0/build_chain.sh && chmod u+x build_chain.sh
```

```eval_rst
Expand Down
2 changes: 1 addition & 1 deletion 3.x/zh_CN/docs/tutorial/air/use_hsm.md
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@ cmake .. || cat *.log
```bash
cd ~/fisco

curl -LO https://github.com/FISCO-BCOS/FISCO-BCOS/releases/download/v3.6.0/build_chain.sh && chmod u+x build_chain.sh
curl -LO https://github.com/FISCO-BCOS/FISCO-BCOS/releases/download/v3.10.0/build_chain.sh && chmod u+x build_chain.sh
```
在build_chain同级目录下,创建文件夹(例如nodeKeyDir),用于存放密码机密钥的node.pem文件(证书数目和搭建节点数一致)。
```bash
Expand Down
4 changes: 2 additions & 2 deletions 3.x/zh_CN/docs/tutorial/max/installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,7 @@ brew install curl docker docker-compose python3 wget
mkdir -p ~/fisco && cd ~/fisco

# 下载区块链构建工具BcosBuilder
curl -#LO https://github.com/FISCO-BCOS/FISCO-BCOS/releases/download/v3.6.0/BcosBuilder.tgz && tar -xvf BcosBuilder.tgz
curl -#LO https://github.com/FISCO-BCOS/FISCO-BCOS/releases/download/v3.10.0/BcosBuilder.tgz && tar -xvf BcosBuilder.tgz

# Note: 若网速太慢,可尝试如下命令下载部署脚本:
curl -#LO https://osp-1257653870.cos.ap-guangzhou.myqcloud.com/FISCO-BCOS/FISCO-BCOS/releases/v3.6.0/BcosBuilder.tgz && tar -xvf BcosBuilder.tgz
Expand Down Expand Up @@ -435,7 +435,7 @@ sudo yum install -y java java-devel
**步骤1:下载控制台**

```shell
cd ~/fisco && curl -LO https://github.com/FISCO-BCOS/console/releases/download/v3.6.0/download_console.sh && bash download_console.sh
cd ~/fisco && curl -LO https://github.com/FISCO-BCOS/console/releases/download/v3.10.0/download_console.sh && bash download_console.sh
```
```eval_rst
.. note::
Expand Down
Loading

0 comments on commit b23ba8d

Please sign in to comment.