4. 轻节点部署工具¶

标签：轻节点 搭建轻节点

重要

相关软件和环境版本说明！请查看

重要

本部署工具 build_chain.sh 脚本目标是让用户最快的使用FISCO BCOS 轻节点。

FISCO BCOS提供了build_chain.sh脚本帮助用户快速搭建FISCO BCOS轻节点。

本文仅介绍如何使用build_chain.sh搭建轻节点，如果要查询build_chian.sh的完整用法，请查看 <https://fisco-bcos-documentation.readthedocs.io/zh_CN/latest/docs/tutorial/air/build_chain.html>

1. 编译轻节点¶

请查看编译文档 <https://fisco-bcos-documentation.readthedocs.io/zh_CN/latest/docs/compile_binary.html>

cmake配置时，增加选项-DWITH_LIGHTNODE=ON，轻节点程序将生成到build/lightnode/fisco-bcos-lightnode目录中。

2. 搭建轻节点¶

build_chain.sh脚本用于快速轻节点，脚本的源码位于github源码, gitee源码。

# 键入bash build_chain.sh -h展示脚本用法及参数
$ bash build_chain.sh
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.6.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
    -t <mtail exec>                     [Optional] mtail binary exec
    -o <output dir>                     [Optional] output directory, default ./nodes
    -p <Start port>                     [Optional] Default 30300,20200 means p2p_port start from 30300, rpc_port from 20200
    -s <SM model>                       [Optional] SM SSL connection or not, 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
    -A <Auth mode>                      Default off. If set -A, build chain with auth, and generate admin account.
    -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 false
    -k <key page size>                  [Optional] key page size, default size 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
    -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 -s
    bash build_chain.sh -p 30300,20200 -l 127.0.0.1:4 -o nodes -e ./fisco-bcos -m(部署节点带监控功能)
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 -s
    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(部署节点带监控功能)

`L`选项[Optional]¶

用于配置开启FISCO BCOS轻节点模式，需要开启轻节点时，使用L选项指定轻节点程序的路径或输入”download_binary”自动下载最新二进制，build_chain.sh将自动生成轻节点到o选项指定的目录中。执行以下命令，在搭建air区块链的同时，生成轻节点。

案例：

# 四个节点的P2P服务分别占用30300-30303端口
# RPC服务分别占用20200-20203端口
# 轻节点将生成到nodes/lightnode中，P2P与RPC服务分别占用30304与20204端口
$ bash build_chain.sh -p 30300,20200 -l 127.0.0.1:4 -e ./bin/fisco-bcos -L ./bin/fisco-bcos-lightnode
$ bash build_chain.sh -p 30300,20200 -l 127.0.0.1:4 -L download_binary

build_chain.sh将生成nodes目录，轻节点位于nodes目录的lightnode中。

[INFO] Use binary ./bin/fisco-bcos
[INFO] Use lightnode binary ./bin/fisco-bcos-lightnode
[INFO] Generate ca cert successfully!
Processing IP:127.0.0.1 Total:4
writing RSA key
[INFO] Generate ./nodes/127.0.0.1/sdk cert successful!
writing RSA key
[INFO] Generate ./nodes/127.0.0.1/node0/conf cert successful!
writing RSA key
[INFO] Generate ./nodes/127.0.0.1/node1/conf cert successful!
writing RSA key
[INFO] Generate ./nodes/127.0.0.1/node2/conf cert successful!
writing RSA key
[INFO] Generate ./nodes/127.0.0.1/node3/conf cert successful!
[INFO] Generate uuid success: F3D04B9D-3DE5-47CD-9A32-F4A06B55B6C1
[INFO] Generate uuid success: 7B886EA7-1ADD-4537-AF55-4D6E5569B03F
[INFO] Generate uuid success: F6EAECD5-CA49-43CC-8452-4D0E273CA201
[INFO] Generate uuid success: 42A82084-D647-4233-83F0-32F0A19D76B8
writing RSA key
[INFO] Generate ./nodes/lightnode/conf cert successful!
[INFO] Generate uuid success: 60DF6258-D573-487A-9894-DFA5DEFC27EE
==============================================================
[INFO] GroupID               : group0
[INFO] ChainID               : chain0
[INFO] fisco-bcos path      : ../../build/fisco-bcos-air/fisco-bcos
[INFO] Auth mode            : false
[INFO] Start port           : 30300 20200
[INFO] Server IP            : 127.0.0.1:4
[INFO] SM model             : false
[INFO] enable HSM           : false
[INFO] Output dir           : ./nodes
[INFO] All completed. Files in ./nodes

3. 轻节点配置文件组织结构¶

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目录下的node.pem，主要位于共识模块的签名。
SDK连接证书: 由build_chain.sh生成，客户端可拷贝该证书与节点建立SSL连接。
节点配置文件: 节点目录下的config.ini和config.genesis配置，前者主要配置链信息，后者主要配置创世块信息，轻节点的信息要与全节点保持一致，具体可参考Air版本区块链节点配置介绍。
启停脚本: start.sh和stop.sh，用于启动和停止节点。

轻的配置文件组织示例如下:

lightnode/
├── conf # 证书配置，与全节点相同
│   ├── ca.crt
│   ├── cert.cnf
│   ├── node.nodeid
│   ├── node.pem
│   ├── ssl.crt
│   └── ssl.key
├── config.genesis # 创世块配置，与全节点相同
├── config.ini # 轻节点配置
├── data # 轻节点数据目录
├── fisco-bcos-lightnode # 轻节点程序
├── log # 轻节点日志
└── nodes.json # 轻节点P2P配置，填写全节点的ip和端口列表

4. 启动轻节点¶

确保全节点已经全部启动，进入lightnode目录，执行：

bash start.sh

lightnode start successfully pid=72369

即可启动轻节点，随后按类似全节点的方法，使用控制台或SDK连接轻节点来进行使用，使用体验与全节点基本类似。

5. 轻节点限制¶

轻节点不存储全量账本数据，意味着大部分信息要从全节点获取，轻节点保证从全节点获取的信息可信不可篡改，如果轻节点连接的全节点发生故障不可用，轻节点也将无法使用。

轻节点支持以下RPC接口：

getBlockByHash
getBlockNumber
getBlockByNumber
getBlockHashByNumber
getBlockHeaderByHash
getBlockHeaderByNumber
getTransactionByHash
getTransactionReceipt
getTransactionByHashWithProof
getTransactionReceiptByHashWithProof
call
sendTransaction
listAbi

各个RPC接口具体使用方式可参考文档控制台命令列表。

6. 轻节点扩容¶

FISCOBCOS 3.3版本开始，支持通过build_chain.sh脚本扩容轻节点，具体操作流程如下：

在建链脚本build_chain.sh同级目录下，新建文件夹config；
将nodes下的根证书文件夹ca拷贝至config文件夹中，cp -r nodes/ca config ;
从已存在lightnode文件夹中拷贝config.genesis、config.ini以及nodes.json至config文件夹中；

cp nodes/lightnode/config.* config
cp nodes/lightnode/nodes.json config 

修改config.ini中rpc与p2p的port字段，将端口号+1（例如原config.ini文件中rpc端口为20202，修改为20203）；
执行脚本命令，具体有执行轻节点二进制文件路径以及自动拉取最新轻节点二进制两种扩容方式，如下所示:

bash build_chain.sh -C expand_lightnode -c config(config文件夹) -d config/ca -o nodes/lightnode1
bash build_chain.sh -C expand_lightnode -c config(config文件夹) -d config/ca -o nodes/lightnode1 -L + 指定轻节点二进制下载路径

扩容成功后生成新的轻节点目录nodes/lightnode1

[INFO] generate_lightnode_scripts ...
[INFO] generate_lightnode_scripts success...
[INFO] generate_lightnode_cert ...
writing RSA key
[INFO] Generate nodes/lightnode1/conf cert successful!
[INFO] generate_lightnode_cert success...
[INFO] generate_lightnode_account ...
[INFO] generate_lightnode_account success...
[INFO] copy configurations ...
[INFO] copy configurations success...
==============================================================
[INFO] SM Model         : false
[INFO] output dir         : nodes/lightnode1
[INFO] All completed. Files in nodes/lightnode1

7.进入扩容生成的轻节点目录lightnode1，启动扩容生成的轻节点 bash start.sh

bash start.sh

lightnode start successfully pid=72370