FISCO BCOS 入门第一步,搭建 FISCO BCOS 环境。本章节通过 build_chain.sh 的方式讲解搭建一条 FISCO BCOS 联盟链的过程中涉及的各个方面,也可以参考 官方教程 进行详细了解。本教程已 fisco-bcos v2.7.2 版本为例,如果后续有新的版本更新,可以到 git 官网上,手工下载 fisco-bcos v2.7.2 版本的二进制进行验证。如无特别说明,一下操作均以 macos 为例。
1. 安装依赖
## macos 环境安装依赖
brew install openssl curl
## ubuntu 环境安装依赖
sudo apt install -y openssl curl
## centos 环境安装依赖
sudo yum install -y openssl openssl-devel
2. 创建操作目录, 下载安装脚本
## 创建操作目录
cd ~ && mkdir -p fisco && cd fisco
## 下载脚本
curl -#LO https://github.com/FISCO-BCOS/FISCO-BCOS/releases/download/v2.7.2/build_chain.sh && chmod u+x build_chain.sh
PS: 如果因为网络问题导致长时间无法下载build_chain.sh脚本,请尝试 curl -#LO https://gitee.com/FISCO-BCOS/FISCO-BCOS/raw/master/tools/build_chain.sh && chmod u+x build_chain.sh
3. 搭建联盟链
这里将讲解搭建过程中涉及到的几个重要的各种参数。为了保证演示结果与本教程的一致性,可以先查看 3.4 章节部分
3.1 查看 build_chain.sh 参数
执行 ./build_chain.sh -help ,即可看到 build_chain.sh 所支持的参数。如图所示,有很多参数可以选择,下面将介绍常用的几个参数。
3.2 使用 -l 和 -p 生成单机联盟链
执行如下命令,可以看到,build_chain.sh 脚本自动去拉取最新的 fisco-bcos 二进制 (这里为 2.7.2 的 fisco-bcos 版本),并生成链节点。初次安装的时候,我们选择让 build_chain.sh 自动拉取,但因为网络问题,去 github 拉取时,可能会很慢。所以后面将介绍使用已存在的二进制进行节点的生成
bash build_chain.sh -l 127.0.0.1:4 -p 30300,20200,8545
执行成功后,我们将看到当前目录下生成了一个 nodes 目录。nodes 目录下存在两个目录,分别是 127.0.0.1 和 cert ,我们进入 127.0.0.1 目录 ( cert 目录的作用会在后续章节进行讲解 ),执行执行 ./start_all.sh , 看到输出 “start successfully” 表示节点启动成功。至此,一切顺利的话,我们的链就创建并启动成功了。
下面我们看下我们输入的参数 -l 127.0.0.1:4 -p 30300,20200,8545 到哪里去了,哪里可以找到这两个配置。大家有没有注意到,nodes 下面中的 127.0.0.1 这个目录,这个目录其实就是 -l 中所指定的 127.0.0.1, 那么这个参数是否可以换成其他的值呢 ?换成其他值后有什么影响呢。让我们做下实验就知道。首先,停止刚才启动的进程。
进入到 nodes/127.0.0.1 目录,执行 ./stop_all.sh ,看到 "stop nodeX success" 的输出表示,执行成功,节点停止成功,这里 "X" 对应 0,1,2,3 。然后在 fisco 目录下,执行 mv nodes nodes_backup 。因为后面我们要做下对比,所以先对旧的 nodes 目录进行备份。
之后,再执行如下命令,生成新的链,执行成功后,我们可以看到重新生成了一个 nodes 目录,并且 nodes 目录下存在 "127.0.0.1" 和 "cert" 这两个目录。注意到了没,第一点: nodes 下面的目录名跟着参数的变化,当然还有第二个不同点,让我们继续观察
bash build_chain.sh -l 127.0.0.2:4 -p 30300,20200,8545
开两个窗口,分别进入 "fisco/nodes/127.0.0.2/node0" 和 "fisco/nodes_backup/127.0.0.1/node0" 目录,并且编辑 config.ini 文件,我们可以观察到 p2p 下面每个 node 对应的 ip 是不一样的。那这个 p2p 中的这些 node 有什么用呢,可以参考我的另一篇文章 "FISCO BCOS 实战教程(三)config.ini 配置详解" 中的说明。这里大家只需要进行了解即可,不影响下面的阅读。
这里 -l 参数后面只带了一个 ip, 根据 build_chain.sh 的参数说明,其他可以输入很多的 Ip,后面进行多机节点部署的时候会进行演示。下面继续讲解下 -p 参数的影响。查看 fisco/nodes/127.0.0.2/node0/config.ini 文件,可以注意到,其中的 "listen_port", "channel_listen_port", "jsonrpc_listen_port" 就是依次输入的参数值,那这几个参数有什么影响呢,可以参考我的另一篇文章 "FISCO BCOS 实战教程(三)config.ini 配置详解",这里大家只需要了解 -p 参数的影响即可。如果我们继续观察 127.0.0.2 目录下 node1/config.ini , node2/config.ini , node3/config.ini ,可以看到"listen_port", "channel_listen_port", "jsonrpc_listen_port" 是依次增加的。那么这里就会有个问题,如果 node0 中的 listen_port 和 node1 中的 channel_listen_port 相同,会有什么问题呢,在我的另一篇文章 "FISCO BCOS 实战教程(三)config.ini 配置详解" 中会进行详细的介绍。
3.2 -e 使用存在的 fisco 二进制生成单机联盟链
上面所说的,如果测试的话,需要经常把链删除并重建,每次去 github 拉取,网络好的话不会有问题,网络慢的话就要等很久。所以这我们可以使用已经存在的二进制进行链的搭建。在 fisco 目录下创建一个新的目录,名为 bin, 然后把 nodes/127.0.0.2/fisco-bcos 这个二进制放到 bin 目录中,然后删除 fisco 目录下的 nodes ( 如果没有删除的话,执行 build_chain.sh 会提示 nodes 目录已存在) 。之后目录结构如下
执行如下命令,使用已存在的 fisco-bcos 二进制生成链节点。执行成功,我们可以注意到,输出的信息中没有 Downloading 字样,表明 build_chain.sh 没有去 github 拉取 fisco-bcos 二进制。
bash build_chain.sh -l 127.0.0.2:4 -p 30300,20200,8545 -e bin/fisco-bcos
3.3 使用 -g 生成国密节点
首先,删除 fisco/nodes 目录,然后执行如下命令。
bash build_chain.sh -l 127.0.0.2:4 -p 30300,20200,8545 -e bin/fisco-bcos -g
链生成成功,查看 nodes/127.0.0.2/node0/config.ini 文件,可以观察到 sm_crypto 这个参数为 true, 表示当前节点为国密节点。具体 sm_crypto 参数的作用及意义可以参考 我的另一篇文章 "FISCO BCOS 实战教程(三)config.ini 配置详解" ,这里只需了解即可。
3.4 使用 -v 参数指定版本
因为兼容性的考虑,fisco-bcos 二进制高版本兼容低版本的配置。这里,我们使用 fisco-bcos v2.7.2 的二进制,配置兼容版本为 v2.5.0
bash build_chain.sh -l 127.0.0.2:4 -p 30300,20200,8545 -v v2.5.0 -e bin/fisco-bcos
执行成功,进入 nodes/127.0.0.2/node0 目录,查看 config.ini 文件,可以看到 supported_version 字段值为 2.5.0。 在 fisco/nodes/127.0.0.2 目录下,执行 ./fisco-bcos -v , 可以看到输出的二进制版本为 v2.7.2。那么这里的 supported_version 具体有什么用呢,参看我的另一篇文章 "FISCO BCOS 实战教程(三)config.ini 配置详解" 里面有详细讲解
3.5 使用 -f 参数指定 ip list 文件, 生成多机节点
当需要生成多个主机的节点时,使用命令行方式难免显得复杂,使用文件指定 ip list 的方式,会显得精简很多。首先删除 fisco 目录下的 nodes 文件夹。之后创建文件 iptable,内容如下。其中 “agency1 1,2" 这个值的具体作用,新手朋友可以暂时不用关注,在我后续的 console 使用文章中会有讲解。
# iptable 文件内容
127.0.0.2:4 agency1 1,2 30300,20200,8545
127.0.0.3:4 agency1 1,2 30300,20200,8545
之后执行如下命令生成节点。
bash build_chain.sh -f iptable -e bin/fisco-bcos
进入到 nodes 目录,即可看到生成两个节点文件夹 127.0.0.2, 127.0.0.3
3.6 使用 -d 生成 docker 节点
首先删除 fisco 目录下的 nodes 目录,然后执行如下命令 ( 因 macos 暂不支持 docker 部署,所以这里使用 centos 进行演示 )
bash build_chain.sh -l 127.0.0.2:4 -p 30300,20200,8545 -d
执行成功,节点生成成功。对比 nodes_backup/127.0.0.1/node0/start.sh 和 nodes/127.0.0.2/node0/start.sh 文件,文件可以发现脚本的启动方式一个为 docker ,一个为非 docker。具体可参考 FISCO 官网
4. 总结
build_chain.sh 参数很多,这里不进行一一列举,大家可以自行进行验证实验。具体可以执行 build_chain.sh -help 查看具体参数说明