区块链:搭建简单Fabric网络并调用智能合约
使用docker服务搭建Hyperledger/fabric网络的详细教程,实现构建多节点的简单联盟链,并编写、调用智能合约实现投票业务。
目录
背景知识
Hyperledger Fabric
基本组件
交易(Transaction)
智能合约
实验目的
实验环境
基础依赖
安装Golang
安装docker
安装基础依赖包
以⾮root⽤户的身份运⾏Docker
安装docker-compose
搭建fabric环境
搭建测试网络(可选)
chaincode 编写
代码下载
代码投票
命令行投票
链码部署 (deployCC)
环境变量设置
调用交易(invoke)
查询投票(query)
背景知识
区块链是一种分布式账本技术,通过密码学方法将数据区块按时间顺序连接形成链式结构。它具有去中心化、不可篡改、可追溯等特点。
-
公有链:完全开放,任何人可参与(如比特币、以太坊)
-
联盟链:需授权访问,由多个组织共同维护(如Hyperledger Fabric)
-
私有链:单一组织完全控制
Hyperledger Fabric
Hyperledger Fabric是Linux下的开源企业级区块链平台,专为商业应用设计,为联盟链。将Blockchain的数据维护和共识服务进行分离,Orderer节点提供共识服务,实现多通道(channel)的结构。
特点:多chain和多channel;所谓的chain(链)实际上是包含Peer节点、账本、ordering通道的逻辑结构,它将参与者与数据(包含chaincode在)进行隔离,一个peer节点也可以参与到多个chain中(通过接入多个channel)。
基本组件
组件 | 作用 |
---|---|
Peer节点 | 维护账本,执行链码 |
Ordering节点 | 排序交易,生成区块 |
CA(认证中心) | 颁发数字证书,身份认证 |
Channel(通道) | 数据隔离机制,ordering提供给peer的虚拟链路,保密性 |
交易(Transaction)
-
应用程序通过SDK发送请求道Peer节点(一个或多个)
-
peer节点分别执行交易(通过chaincode),但是并不将执行结果提交到本地的账本中(可以认为是模拟执行,交易处于挂起状态),参与背书的peer将执行结果返回给应用程序(其中包括自身对背书结果的签名)
-
应用程序收集背书结果并将结果提交给Ordering服务节点
-
Ordering服务节点执行共识过程并生成block,通过消息通道发布给Peer节点,由peer节点各自验证交易并提交到本地的账本(ledger)中,包括状态(state)的变化,本地的账本称为PeerLedger
智能合约
即Fabric中的Chaincode,编写Chaincode程序实际上就是要编写一个类,并且这个类要实现fabric预先定义的一个接口,在Fabric中,Chaincode的运行是生成Transaction的唯一来源,也因此Chaincode是外界与Fabric区块链交互的唯一渠道。
实验目的
在fabric1.4的架构下,使用docker的容器服务搭建一个具有5个节点的简单联盟链,了解基本的共识,出块,部署、调用智能合约(chaincode)的功能。本实验共有两个任务:
- 搭建一个fabric1.4的基础区块链网络
- 在fabric的架构下如何去编写、调用智能合约(chaincode),根据简单的业务需求(投票)来设计、实现chaincode。
实验环境
- Ubuntu20.04(版本非必须)的VMware虚拟机
- curl
- Docker 18.09.6-ce和 Docker Compose 1.24.0,支持更高版本
- Go programming language go1.12.5 (fabric1.4要求go版本为1.11.x或更高,Fabric1.0要求1.7.x或更高),在系统变量中设置相应的$GOPATH和$GOROOT变量
- Fabric 1.4的可执行文件
基础依赖
# 安装curl
sudo apt install curl
# 为了curl能够⽀持https协议,安装openssl
sudo apt install openssl libssl-dev
# 安装git
sudo apt install git
# 安装cmake
sudo apt install cmake
# 安装jq
sudo apt install jq
# 安装libtool
sudo apt install libtool libltdl-dev
检查安装是否成功:
安装Golang
后续区块链智能合约用golang编写;
直接下载地址:https://golang.google.cn/dl/
# 下载官⽹的linux x86-64 Archive
wget https://golang.google.cn/dl/go1.19.3.linux-amd64.tar.gz --no-check certificate
# 解压
sudo tar -xzf go1.19.3.linux-amd64.tar.gz -C /usr/local
# 主⽬录下建⽴goDir⽂件夹,做为GOPATH路径
mkdir ~/goDir
下载后改配置文件添加路径,这里将seed改为自己用户名即可,编辑.zshrc:
# 在zsh配置⽂件中添加系统PATH
vim ~/.zshrc
export GOPATH=/home/seed/goDir
export GOROOT=/usr/local/go
export PATH=$PATH:$GOPATH/bin
export PATH=$PATH:$GOROOT/bin
# 刷新配置⽂件
source ~/.zshrc
让root也能执⾏go命令,改.zshrc或者 /root/.bashrc:
# 让root也能执⾏go命令(如果root没有安装zsh,则修改 /root/.bashrc)
sudo su
vim ~/.zshrc
export GOPATH=/home/seed/goDir
export GOROOT=/usr/local/go
export PATH=$PATH:$GOPATH/bin
export PATH=$PATH:$GOROOT/bin
检查:
安装docker
安装基础依赖包
apt-transport-https允许 apt 包管理器通过 HTTPS 协议与软件源通信;
ca-certificates提供权威机构颁发的根证书,防止中间人攻击;
gnupg-agent用于管理和缓存 GPG(GNU Privacy Guard)密钥(对软件包进行数字签名和验证):
sudo apt install apt-transport-https ca-certificates curl gnupg-agent software-properties-common
从 Docker 官网下载其公钥,验证软件包的签名,并将其添加到系统的可信密钥列表中:
curl -fsSL https://download.docker.com/linux/ubuntu/gpg | sudo apt-key add -
添加 Docker 的官方 APT 软件源,add-apt-repository将一个新的软件源添加到系统中,deb 表示这是一个二进制软件包的仓库地址:
sudo add-apt-repository "deb [arch=amd64] https://download.docker.com/linux/ubuntu $(lsb_release -cs) stable"
若拉取镜像失败则换源,阿里云上很多,多加一些,多试几次:
更新本地软件包缓存,安装 Docker 引擎等组件:
sudo apt update
sudo apt install docker-ce docker-ce-cli containerd.io
以⾮root⽤户的身份运⾏Docker
# 如果出现Cannot connect to the Docker daemon. Is the docker daemon running on this host?
# 解决办法1
sudo chown seed:docker /var/run/docker.sock
# seed改成⾃⼰的⽤户名# 解决办法2
# 创建⼀个名为docker的组
sudo groupadd docker
# 将你的⽤户添加到docker组
sudo usermod –aG docker $USER
# 重启
检查是否安装成功,看docker版本:
安装docker-compose
运行下列环境安装docker-compose,如下载失败,可前往http://get.daocloud.io/#install-compose
sudo curl -L "https://github.com/docker/compose/releases/download/1.25.5/docker-compose-$(uname -s)-$(uname -m)" -o /usr/local/bin/docker-compose#给相应的二进制文件可执行权限:
sudo chmod +x /usr/local/bin/docker-compose#之后在命令行输入
docker-compose version
检查版本:
重新启动并检查状态是active:
搭建fabric环境
从 GitHub 上克隆 Hyperledger Fabric 的官方样本仓库;
./install-fabric.sh docker再次执行安装脚本,并指定b(binary) 作为参数,这个操作会下载与所拉取镜像版本匹配的 Fabric 二进制工具文件到当前目录的bin文件夹下;
mkdir ~/blockchain
cd blockchain
# github克隆fabric-samples
git clone https://github.com/hyperledger/fabric-samples
cd fabric-samples
# 下载安装脚本并构建docker
wget https://raw.githubusercontent.com/hyperledger/fabric/main/scripts/install-fabric.sh --no-check-certificate
chmod +x install-fabric.sh
./install-fabric.sh docker
./install-fabric.sh b
并运行其中连通性测试脚本:
# 启动网络
cd test-network
./network.sh up#或者同时创建通道、指定状态数据库
./test-network/network.sh up createChannel -ca -c mychannel -s couchdb# 查看是否创建成功
docker ps# 关闭docker
./network.sh down
返回如下算成功:
可选:若返回的版本信息不匹配,即出现如下行,fabric-samples/bin默认下载旧的 v2.5.4 版本二进制文件,install-fabric.sh使用新的 v3.0.0 版本的 Docker 镜像,版本不匹配也能联通,但后续可能有问题,可以升级本地二进制文件以匹配 Docker 镜像 (v3.0.0)
LOCAL_VERSION=v2.5.4
DOCKER_IMAGE_VERSION=v3.0.0
Local fabric binaries and docker images are out of sync. This may cause problems.
# 确保你在 fabric-samples 目录下
cd ~/blockchain/fabric-samples# 使用安装脚本,指定版本,重新下载二进制文件
# 这将覆盖 bin 目录下的旧版工具
./install-fabric.sh --fabric-version 3.0.0 binary# 清理之前的网络(如果正在运行)
./test-network/network.sh down#重新运行你的命令
./test-network/network.sh up createChannel -ca -c mychannel -s couchdb
搭建测试网络(可选)
参考链接: https://hyperledger-fabric.readthedocs.io/en/release-1.4/build_network.html
现在已经克隆 Hyperledger Fabric 的官方样本仓库,在执行前面的脚本后,会发现目录下多了fabric-samples,包含了链码示例、应用程序示例、以及部署脚本,现在将使用first-network这个例子。
cd $GOPATH/src/github.com/hyperledger/fabric/scripts/fabric-samples/first-network
官方提供一个完全注释的脚本byfn.sh,利用这些Docker镜像可以快速引导一个由4个代表2个不同组织的peer节点以及一个排序服务节点的Hyperledger fabric网络。它还将启动一个容器来运行一个将peer节点加入channel、部署实例化链码服务以及驱动已经部署的链码执行交易的脚本。
sudo ./byfn.sh
chaincode 编写
使用Go语言编写一个用于投票的chaincode,并完成其功能性测试(如投票,统计,查询等)。可以选择多种测试手段,如编写chaincode的测试代码,或者是在dev模式下,使用命令行测试。
golang教程:Go 语言之旅
代码下载
可以从github下载课程相关代码,完整代码见仓库:https://github.com/yy158775/blockchain-exp
cd ~/blockchain
git clone https://github.com/yy158775/blockchain-exp
cd blockchain-exp/vote-smartcontract
go mod tidy
# 修改main.go
cd ~/blockchain/blockchain-exp/vote-app
gedit main.go
# 将其中的cryptoPath改为如下路径(之前的⽂件夹相对位置需要与 实验环境搭建 部分所写⼀致)
# cryptoPath = "../../fabric-samples/test-network/organizations/peerOrganizations/org1.example.com"
# certPath = cryptoPath +"/users/User1@org1.example.com/msp/signcerts/User1@org1.example.com-cert.pem"
# 下载依赖
go mod tidy
# 开启network
cd ~/blockchain/fabric-samples/test-network
./network.sh down
./network.sh up
# 创建channel
./network.sh createChannel
# 运⾏
./network.sh deployCC -ccn basic -ccp ../../blockchain-exp/votesmartcontract -ccl go
代码投票
修改main.go的cryptoPath和chaincodeName,通过应用程序调用智能合约:
# 运⾏客户端
cd ~/blockchain/blockchain-exp/vote-app
go mod tidy
go run main.go
根据菜单就能直接投票了:
命令行投票
链码部署 (deployCC)
-ccn: 指定Chaincode名为vote
-ccp指定Chaincode源代码的路径
./network.sh deployCC -ccl go -ccp ./HUST-blockchain-exp/vote-smartcontract/ -ccn vote
环境变量设置
在执行链码调用invoke/query命令前,必须设置这些环境变量,以指定要操作哪个 Peer 节点和使用哪个身份。
# 设置核心配置路径(假设当前在 test-network 目录)
export FABRIC_CFG_PATH=$PWD/../config/# 启用 TLS 通信
export CORE_PEER_TLS_ENABLED=true# 设置要操作的组织 MSP ID
export CORE_PEER_LOCALMSPID="Org1MSP"# 设置该组织的 TLS 根证书路径(用于验证通信)
export CORE_PEER_TLS_ROOTCERT_FILE=$PWD/organizations/peerOrganizations/org1.example.com/peers/peer0.org1.example.com/tls/ca.crt# 设置管理员用户的 MSP 路径(身份文件)
export CORE_PEER_MSPCONFIGPATH=$PWD/organizations/peerOrganizations/org1.example.com/users/Admin@org1.example.com/msp# 设置要连接的 Peer 节点地址
export CORE_PEER_ADDRESS=localhost:7051
切换到 Org2 时,需要重新设置以下变量:
export CORE_PEER_LOCALMSPID="Org2MSP"
export CORE_PEER_TLS_ROOTCERT_FILE=$PWD/organizations/peerOrganizations/org2.example.com/peers/peer0.org2.example.com/tls/ca.crt
export CORE_PEER_MSPCONFIGPATH=$PWD/organizations/peerOrganizations/org2.example.com/users/Admin@org2.example.com/msp
export CORE_PEER_ADDRESS=localhost:9051
调用交易(invoke)
调用链码的VoteUser 函数,这是一个会修改账本状态的交易(Transaction)。
peer chaincode invoke \-o localhost:7050 \ # Orderer 地址--ordererTLSHostnameOverride orderer.example.com \--tls \--cafile "$PWD/organizations/ordererOrganizations/example.com/orderers/orderer.example.com/msp/tlscacerts/tlsca.example.com-cert.pem" \ # Orderer TLS CA-C mychannel \ # 通道名称-n vote \ # 链码名称--peerAddresses localhost:7051 \ # 需要背书的 Peer 地址 (Org1)--tlsRootCertFiles "$PWD/organizations/peerOrganizations/org1.example.com/peers/peer0.org1.example.com/tls/ca.crt" \--peerAddresses localhost:9051 \ # 需要背书的 Peer 地址 (Org2)--tlsRootCertFiles "$PWD/organizations/peerOrganizations/org2.example.com/peers/peer0.org2.example.com/tls/ca.crt" \-c '{"function":"VoteUser","Args":["username"]}' # 调用方法和参数
查询投票(query)
查询单个用户票数:Chaincode的 GetUserVote函数,这是一个仅查询账本状态而不产生交易的查询(Query):
peer chaincode query -C mychannel -n vote -c '{"Args":["GetUserVote", "usernane1"]}'
("id":2, "usernane":"usernane","votes":1)
查询所有投票:Chaincode的GetAllVotes函数:
peer chaincode query -C mychannel -n vote -c '{"Args":["GetAllVotes"]}'
[{"id":0,"username":"Alice","votes":2},{"id":1,"username":"Mike","votes":1},{"id":2,"username":"usernane1","votes":1}]
恭喜成功!下一篇挖矿!