使用Docker搭建以太坊私有链并部署合约

阅读完本文,你将可以在一台物理机上搭建起一个完整的以太坊私链,并且部署自己的合约。用以开发、调试、学习以太坊。

本文涉及的知识和技术有:

  • Docker:一种时下流行的容器
  • geth:以太坊客户端的go实现
  • truffle:以太坊合约

Docker环境搭建

关于如何搭建Docker环境,可以参考我之前的一篇文章。以下的内容都是基于该文搭建的环境。如果你已经有了可以运行的Docker环境,可以忽略。

文章地址:https://www.jianshu.com/p/7ca57e4f66c5

主机配置

此处需要补充一点的是,如果您使用的是虚拟机、云主机或者老破小机器,需要确保分配给主机的内存至少2GB或以上。因为以太坊为了抵御比特大陆这样的ASIC矿机对算力的垄断,采用了和比特币完全不同的PoW算法——ethash。该算法的特点是算力不敏感,内存敏感。该算法目前需要在内存创建大约1GB的DAG用来做PoW运算,且DAG会随着区块的增加呈阶梯状增长,因此建议至少给挖矿节点的宿主机器分配至少2GB的内存,且保留扩大内存容量的灵活性。

获取geth镜像

docker hub上有现成的geth镜像。直接获取。

docker pull ethereum/client-go:v1.8.12

试运行一下

docker run -it --rm -v /workspace:/workspace --entrypoint /bin/sh ethereum/client-go:v1.8.12

此处修改镜像默认的entrypoint是为了不让节点自动运行。我们稍后会对节点进行自定义配置使其成为私有链节点。
-v将本地的/workspace目录挂载成容器的/workspace目录,用来在容器和宿主机器之间共享文件

创建Docker网络

旧版本的docker容器相互之间是依靠link建立关系。
新版本docker推荐创建自有网路,再将需要互联的容器配置到相同的网络中。
于是,我们创建一个名为“ethnet“的网络。该网络配置如下:

  • 子网172.18.0.0/16
    • IP段172.18.0.0
    • 掩码255.255.0.0
    • IP范围172.18.0.1~172.18.255.254
    • IP广播172.18.255.255
docker network create -d bridge --subnet=172.18.0.0/16 ethnet
docker network ls

配置以太坊网络

运行如下命令进入一个容器:

docker run -it --rm --network ethnet --ip 172.18.0.50 -v /workspace:/workspace --entrypoint /bin/sh ethereum/client-go:v1.8.12

--network ethnet参数指定了该容器加入刚才创建的ethnet网络
--ip 172.18.0.5指定了一个固定IP给该容器。

创建账户

首先,在容器内的/workspace目录创建如下目录结构和文件:

dapp\
dapp\miner\
dapp\data\
dapp\genesis.json

然后运行如下命令创建账户:

cd /workspace/dapp/miner
geth -datadir ./data account new

输入两次password,获得地址。将地址记录下来,后面要用到。

重复如上步骤可以创建多个账户。

创建创世区块

编辑刚才创建的文件dapp\data\genesis.json

{
  "config": {
    "chainId": 88,
    "homesteadBlock": 0,
    "eip155Block": 0,
    "eip158Block": 0
  },
  "alloc"      : {
    "0x4c283287839fd441b8c8d18771321bc06a81edae": {"balance": "100000000000000000000"},
    "0x8dadb9ec6a82413c389e677baa9e7b589fe92b68": {"balance": "1000000000000000000"},
    "0x39c70ad710e07953dea150b1a5f1d0534bf0f135": {"balance": "1000000000000000000"},
    "0xb9592b51d40d66bc583f8ed2755861372fb4afb0": {"balance": "1000000000000000000"}
  },
  "coinbase"   : "0x0000000000000000000000000000000000000000",
  "difficulty" : "0x400",
  "extraData"  : "",
  "gasLimit"   : "0x2fefd8",
  "nonce"      : "0x0000000000000000",
  "mixhash"    :
  "0x0000000000000000000000000000000000000000000000000000000000000000",
  "parentHash" :
  "0x0000000000000000000000000000000000000000000000000000000000000000",
  "timestamp"  : "0x00"
}
  • genesis.json是用来创建创世区块的配置文件
  • 加入同一私链的节点必须使用同一配置文件
  • chainid是私链网络的标识,可以是任意数字。
  • 即使chainid相同,如果genesis.json配置不一样,也将是两个不兼容的网络
  • alloc下面列举了4个账户地址,分别是上一步骤创建并记录下来的地址。
  • balance是创世区块为每个账户分配的初始以太币。这里看似分配了很多,其实单位是wei。1eth=10^18wei。也就是除了第一个账户给了100eth外,其它几个账户分别只拥有1eth。这里给第一个账户多分点,是因为我们之后需要用它来部署合约。

完成以太坊网络配置

此时可以退出刚才的容器。由于我们运行容器是加了--rm参数,刚才的容器会被删除,但宿主机的/workspace下的文件会被保存下来。

挖矿

上述步骤只是配置好了一个以太坊私有网络,并没有真正创建网络。我们知道,以太坊网络是一个分布式的网络,有了矿工,才有的网络。于是,我们首先得有一个矿工。

创建“主”矿工节点

我们接下来打算创建的矿工节点,成为“主”矿工,因为它需要拥有如下特性:

  • 它是一个容器,并且是持久的容器
  • 它会自动读取genesis.json文件,并初始化以太坊网络
  • 它能够连接其它节点(容器)
  • 它能够接受各种rpc调用,并能够部署合约
  • 它已经配置好挖矿账户,可以一键挖矿

于是,我们按照这个要求,开始一步步创建矿工节点。

创建entrypoint脚本

创建一个文件:/workspace/dapp/init.sh
文件内容如下:

#!/bin/sh
geth -datadir ~/data/ init /workspace/traceability/genesis.json

if [  $# -lt 1 ]; then 
  exec "/bin/sh"
else
  exec /bin/sh -c "$@"
fi

该脚本的功能是让以太坊节点(容器)自动初始化以太坊网络,并且接受一个自动运行脚本作为输入。

创建自动运行脚本

创建一个文件:/workspace/dapp/mine.sh
内容如下:

#!/bin/sh
cp -r /workspace/dapp/miner/data/keystore/* ~/data/keystore/
geth -datadir ~/data/ --networkid 88 --rpc --rpcaddr "172.18.0.50" --rpcapi admin,eth,miner,web3,personal,net,txpool --unlock "0x4c283287839fd441b8c8d18771321bc06a81edae" --etherbase "0x4c283287839fd441b8c8d18771321bc06a81edae" console
  • 第一行命令是将刚才生成的账户私钥文件拷贝到容器的home目录下。因为/workspace是宿主目录挂载的,并不是linux文件系统,直接将datadir指定到该目录会导致geth报错。
  • 第二行命令是启动以太坊节点的命令。
    • --networkid 88指定了networkid,这个必须与genesis.json内设置保持一致
    • --rpc --rpcaddr "172.18.0.50" --rpcapi .... 这些参数表示该节点接受rpc,并且指定了rpc的协议
    • --unlock "0x..." 加入该参数会需要用户输入账户密码。密码校验后会解锁该账户。账户解锁后,该节点就能使用此账户的私钥进行签名加密等动作,用以进行交易、发布合约等。
    • --etherbase 参数指定了挖矿收益账户

创建容器

docker run -it --name=miner --network ethnet --ip 172.18.0.50 --hostname node -v /workspace:/workspace --entrypoint /workspace/dapp/init.sh ethereum/client-go:v1.8.12 /workspace/dapp/mine.sh

该命令会创建一个持久化的容器。容器的entrypoint和自动运行脚本指定为我们刚创建的那两个脚本。

创建“从”矿工节点

只有一个节点的网络,怎么看都不像“分布式”网络。所以我们需要创建更多的节点来形成一个“分布式网络”。我们称这些节点叫做“从”矿工。
这类矿工不需要交易,不需要发布合约,因此不需要unlock账户,也不需要接受rpc。它们只知道埋头挖矿。

创建自动运行脚本

“从”矿工节点和“主”矿工节点共享entrypoint,以保证它们创建出完全相同的网络。
只有自动运行脚本不太一样,/workspace/dapp/node.sh:

#!/bin/sh
cp -r /workspace/dapp/miner/data/keystore/* ~/data/keystore/
geth -datadir ~/data/ --networkid 88 console

创建容器

docker run -it --name=node1 --network ethnet --ip 172.18.0.51 --hostname node1 -v /workspace:/workspace --entrypoint /workspace/dapp/init.sh ethereum/client-go:v1.8.12 /workspace/dapp/node.sh

操作节点

以上创建出了多个以太坊节点,运行在同一网络下。每个节点都可以执行如下操作。供参考。

节点发现

查看节点信息

geth -datadir ~/data/ --networkid 88 console
>admin.nodeInfo.enode

配置静态节点文件

~/data/geth/static-nodes.json

[
    "enode://<node public key>@<node IP address>:<node port>",
    ...
]

查看连接上的节点

geth -datadir ~/data/ --networkid 88 console
>admin.peers

动态添加节点

>admin.addPeer("enode://<node public key>@<node IP address>:<node port>")

挖矿

启动miner容器

>miner.start(1)
  • 参数1指定了挖矿的线程数。
  • 首次启动节点会消耗大约20~30分钟产生DAG
  • 某开始挖矿后,其它节点将会收到新区块并打印

部署合约

创建truffle镜像

由于没有找到好用的truffle镜像,我自己创建了一个。Dockerfile内容如下:

FROM alpine:3.8
MAINTAINER Cary Tan tx-cary@163.com
ENV PS1='[truffle@docker $PWD]\$ '
RUN echo "http://mirrors.tuna.tsinghua.edu.cn/alpine/v3.8/main" > /etc/apk/repositories \
      && echo "http://mirrors.tuna.tsinghua.edu.cn/alpine/v3.8/community" >> /etc/apk/repositories \
      && apk update \
      && apk add npm \
      && mkdir -p /workspace \
      && npm config set registry https://registry.npm.taobao.org \
      && npm install -g truffle
WORKDIR /workspace
CMD /bin/sh

该镜像我已经上传到dockerhub了,您也可以直接下载使用:

docker pull txcary/truffle:180806

启动truffle容器

docker run -it --rm -v /workspace:/workspace --network ethnet txcary/truffle:180806

测试节点RPC

curl 172.18.0.50:8545 -X POST --data '{"id":1,"jsonrpc":"2.0","method":"eth_accounts", "params":[]}' -H "Content-Type: application/json"

curl 172.18.0.50:8545 -X POST --data '{"id":1,"jsonrpc":"2.0","method":"eth_getBalance", "params":["0x4c2832
87839fd441b8c8d18771321bc06a81edae","latest"]}' -H "Content-Type: application/json"
  • 第一条命令获取节点上的账户
  • 第二条命令获取账户余额
  • 如果这两条命令成功了,说明以太坊私有网络搭建成功,并且节点rpc调用成功

新建truffle工程

truffle init

修改truffle.js

module.exports = {
        networks: {
            development: {
                host: "172.18.0.50",
                port: 8545,
                network_id: 88,
                gas: 2900000,
                gasPrice: 10000000000
            }
        }
};
  • gas使用默认值会导致超限错误,研究半天不知道为什么。要是搞明白的可以给我留言,谢谢!
  • gasPrice为默认值

编写合约Yourname.sol

  • 合约名称必须和文件名一致,不然会部署失败
    如果你还没有自己的合约,可以上truffle官网下载一个做练习。
    我也做了一个供应链追踪的合约放在github上:https://github.com/txcary/traceability。该合约通过remix调试并成功部署在我的私链上,供参考。

新建部署脚本

2_deploy_contracts.js

var Yourname = artifacts.require("./Yourname.sol");

module.exports = function(deployer) {
  deployer.deploy(Yourname);
};

编译合约

truffle compile

部署合约

truffle migrate --network development --verbose-rpc

推荐阅读更多精彩内容