Substrate 开发系列 - 环境搭建

Tiny熊
更新于 2020-05-31 21:50
阅读 8803

学习Substrate 开发的第一步就是环境搭建，本文的目标是把Substrate编译出来，用 substrate 启动一个区块链开发网络。

## 背景

先简单介绍一下[Polkadot](https://learnblockchain.cn/categories/Polkadot) 与[Substrate](https://learnblockchain.cn/tags/Substrate) 。

Polkadot 目标是成为一个连接各区块链的区块链（网络），Substrate 是 Polkadot 生态中重要的一环， 他是一套工具与框架的集合，让我们以模块化的方式来构建自己的区块链。Polkadot本身也是基于 Subsstrate 创建的。

学习Substrate 开发的第一步就是环境搭建，本文的目标是把`Substrate`编译出来，用 substrate 启动一个区块链开发网络。

## 安装依赖项

Substrate  本身是由 Rust 开发， 也依赖很多其他的模块，`Substrate`编译需要先安装依赖。

### 方式 1：用官方脚本自动安装

Substrate 官方提供了一个安装脚本，只需要使用下面一个命令就可以安装好编译`Substrate`所需要的全部依赖。

```bash
curl https://getsubstrate.io -sSf | bash -s -- --fast
```

有兴趣的同学可以打开： https://getsubstrate.io 查看脚本详情。

脚本安装依赖包括如： openssl（密码学库）、cmake（编译工具）、 llvm（编译器框架）、Rust。

使用脚本很简单，不过国内网络网络环境，下载依赖包可能非常慢，甚至无法下载，那么就只能使用下面的方式 2 了。

### 方式 2：手动安装

**Brew 安装库**

我的环境是 Mac（其他平台[可参考](https://www.substrate.io/kb/getting-started)）， Mac 下安装软件包很多使用 [brew](https://brew.sh/)  ，大家的电脑上应该都已经安装了，如果没可以可以参考这个[链接](https://zhuanlan.zhihu.com/p/59805070)安装。

brew 的下载源在国内下载是龟速，我们可以配置使用清华大学镜像站的源，配置方式是修改环境变量HOMEBREW_BOTTLE_DOMAIN，例如下方式写入到 .bash_profile

```bash
echo 'export HOMEBREW_BOTTLE_DOMAIN=https://mirrors.tuna.tsinghua.edu.cn/homebrew-bottles' >> ~/.bash_profile
source ~/.bash_profile
```

现在用brew 安装openssl cmake llvm：

```bash
brew install openssl cmake llvm
 ```

**Rust 安装**

[Rustup](https://rustup.rs/) 是 Rust 官方的跨平台 **Rust 安装工具**， cargo 是Rust 的包管理工具。

我们需要用 rustup 安装 Rust， cargo 本身在安装 Rust 的时候就会自带安装，之后用 cargo 去安装 Rust 软件包（库）。

> rustup 和 cargo 就像 nvm 和 npm 的区别。

使用 rustup 安装 rust 时，同样可以启用清华源，执行：

```bash
$ echo 'export RUSTUP_DIST_SERVER=https://mirrors.tuna.tsinghua.edu.cn/rustup' >> ~/.bash_profile
```

使用 rustup 安装 Rust 语言环境：

```
curl https://sh.rustup.rs -sSf | sh 
rustup default stable
```

Rust 提供了三个版本渠道：nightly，beta，stable， 默认启用stable（稳定版）。

**Wasm 编译**

Substrate 使用 Wasm 作为智能合约的运行环境，同时也使用wasm 进行网络节点的升级， wasm 是一个虚拟机环境。最初是想为浏览器提供一个高性能的执行环境，不过现在也可以使用非浏览器环境。

wasm目前仅在 nightly 版本上支持，因此需要配置一下：

wasm 目前仅在 `nightly` 上支持，

Substrate uses WebAssembly (Wasm), and you will need to configure your Rust compiler to use `nightly` to support this build target.

```bash
rustup update nightly
rustup target add wasm32-unknown-unknown --toolchain nightly
```

**配置 cargo 源**

在后面编译substrate， 需要安装大量的 Rust 依赖包，同样为了避免龟速访问的问题，配置一下cargo 源为清华大学镜像源：

编辑 `~/.cargo/config` 文件，添加以下内容：

```toml
[source.crates-io]
replace-with = 'tuna'

[source.tuna]
registry = "https://mirrors.tuna.tsinghua.edu.cn/git/crates.io-index.git"
```

## 编译 substrate

**下载substrate代码**

先 git clone substrate 的代码：

```bash
git clone https://github.com/paritytech/substrate.git
```

github.com 在国内也是龟速，因此我在 gitee.com  fork 了一份，大家可以用以下命令 clone 代码：

```bash
git clone https://gitee.com/lbc-team/substrate.git
```

**编译 substrate**

```bash
cd substrate
cargo build --release
```

大约半小时，可以去喝个茶, 出现以下提示就成功了；

```
Finished release [optimized] target(s) in 29m 46s
```

编译完之后，在 `/target/release/`会生成 **substrate** 可执行文件。

## 运行 substrate 节点网络

现在可以使用 **substrate** 来启动网络了，**substrate**用很多个命令（参数），可使用` ./target/release/substrate --help`查看用法。

这里使用 `--dev` 以开发者模式运行节点网络：

```bash
./target/release/substrate --dev
```

substrate 启动后，会输出如：当前的客户端版本，节点名，数据库目录，节点身份 ID等等：

```
2020-05-31 19:34:44 Running in --dev mode, RPC CORS has been disabled.
2020-05-31 19:34:44 Substrate Node
2020-05-31 19:34:44 ✌️  version 2.0.0-rc2-12b6c5dbe-x86_64-macos
2020-05-31 19:34:44 ❤️  by Parity Technologies <admin@parity.io>, 2017-2020
2020-05-31 19:34:44 📋 Chain specification: Development
2020-05-31 19:34:44 🏷  Node name: homely-volcano-9283
2020-05-31 19:34:44 👤 Role: AUTHORITY
2020-05-31 19:34:44 💾 Database: RocksDb at /Users/emmett/Library/Application Support/substrate/chains/dev/db
2020-05-31 19:34:44 ⛓  Native runtime: node-251 (substrate-node-1.tx1.au10)
2020-05-31 19:34:44 📦 Highest known block at #173
2020-05-31 19:34:44 Using default protocol ID "sup" because none is configured in the chain specs
2020-05-31 19:34:44 🏷  Local node identity is: 12D3KooWEE4Gd4isn28sPsXQ3YBSPUqfpxmfVvKHzBxjWhEQPxV9 (legacy representation: QmVDyLimoKQjaGttsnvSdjLeJUkdxReUL6eDrF4LB7BL1h)
2020-05-31 19:34:44 〽️ Prometheus server started at 127.0.0.1:9615
2020-05-31 19:34:44 👶 Starting BABE Authorship worker
2020-05-31 19:34:45 🙌 Starting consensus session on top of parent 0x8c3fffd67f59db85fd468dc5a4386ccaf58dc2841ab0370f8d94b6f5413a511f
```

我们可以通过 https://polkadot.js.org/apps/ 查看当前节点的运行状态（也可以进行简单的交互）， 打开 https://polkadot.js.org/apps/ 可以看到如下界面：

![image-20200531190026378](https://img.learnblockchain.cn/pics/20200531190028.png)

默认时浏览器是连接当前的Polkadot CC1 候选主网，不过我们可以让他连接到本地节点，点设置->选择节点及配置地址前缀, 方法如下：

![image-20200531190952656](https://img.learnblockchain.cn/pics/20200531190953.png)

节点依然下拉框拉到最下面，选择 **Local Node(Own, 127.0.0.1:9944)** , 地址前缀选：Substrate(generic) 如下图：

![image-20200531190733437](https://img.learnblockchain.cn/pics/20200531190735.png)

配置好，别忘了点保存哦，连接好，就可以看到本地网络的块高了，如下图：

![image-20200531191401844](https://img.learnblockchain.cn/pics/20200531191408.png)

我们还可以测试一下转账功能：

![image-20200531191635569](https://img.learnblockchain.cn/pics/20200531191636.png)

## 运行多节点

在本地启动一个多节点连接的网络也是可以的，可以先以alice的名义启动一个验证人节点：

```bash
./target/release/substrate --alice --chain local
```

` --chain local` 表示是一个本地的**网络**模式，之前我们是开发者模式，这个时候不会出块， 需要等待另一个节点加入才能出块。

再（在另一个终端）启动另一个节点， 注意这里需要用 `-d` 来定义一个数据目录：

```
./target/release/substrate --bob  --chain local  -d ./bob
```

现在可以看到浏览器可以开始出块了。

好了， 已经踏入了Substrate开发的第一步。

背景

先简单介绍一下Polkadot 与Substrate 。

Polkadot 目标是成为一个连接各区块链的区块链（网络），Substrate 是 Polkadot 生态中重要的一环，他是一套工具与框架的集合，让我们以模块化的方式来构建自己的区块链。Polkadot本身也是基于 Subsstrate 创建的。

学习Substrate 开发的第一步就是环境搭建，本文的目标是把Substrate编译出来，用 substrate 启动一个区块链开发网络。

安装依赖项

Substrate 本身是由 Rust 开发，也依赖很多其他的模块，Substrate编译需要先安装依赖。

方式 1：用官方脚本自动安装

Substrate 官方提供了一个安装脚本，只需要使用下面一个命令就可以安装好编译Substrate所需要的全部依赖。

curl https://getsubstrate.io -sSf | bash -s -- --fast

有兴趣的同学可以打开： https://getsubstrate.io 查看脚本详情。

脚本安装依赖包括如： openssl（密码学库）、cmake（编译工具）、 llvm（编译器框架）、Rust。

使用脚本很简单，不过国内网络网络环境，下载依赖包可能非常慢，甚至无法下载，那么就只能使用下面的方式 2 了。

方式 2：手动安装

Brew 安装库

我的环境是 Mac（其他平台可参考）， Mac 下安装软件包很多使用 brew ，大家的电脑上应该都已经安装了，如果没可以可以参考这个链接安装。

brew 的下载源在国内下载是龟速，我们可以配置使用清华大学镜像站的源，配置方式是修改环境变量HOMEBREW_BOTTLE_DOMAIN，例如下方式写入到 .bash_profile

echo 'export HOMEBREW_BOTTLE_DOMAIN=https://mirrors.tuna.tsinghua.edu.cn/homebrew-bottles' >> ~/.bash_profile
source ~/.bash_profile

现在用brew 安装openssl cmake llvm：

brew install openssl cmake llvm

Rust 安装

Rustup 是 Rust 官方的跨平台 Rust 安装工具， cargo 是Rust 的包管理工具。

我们需要用 rustup 安装 Rust， cargo 本身在安装 Rust 的时候就会自带安装，之后用 cargo 去安装 Rust 软件包（库）。

rustup 和 cargo 就像 nvm 和 npm 的区别。

使用 rustup 安装 rust 时，同样可以启用清华源，执行：

$ echo 'export RUSTUP_DIST_SERVER=https://mirrors.tuna.tsinghua.edu.cn/rustup' >> ~/.bash_profile

使用 rustup 安装 Rust 语言环境：

curl https://sh.rustup.rs -sSf | sh 
rustup default stable

Rust 提供了三个版本渠道：nightly，beta，stable，默认启用stable（稳定版）。

Wasm 编译

wasm目前仅在 nightly 版本上支持，因此需要配置一下：

wasm 目前仅在 nightly 上支持，

Substrate uses WebAssembly (Wasm), and you will need to configure your Rust compiler to use nightly to support this build target.

rustup update nightly
rustup target add wasm32-unknown-unknown --toolchain nightly

配置 cargo 源

在后面编译substrate，需要安装大量的 Rust 依赖包，同样为了避免龟速访问的问题，配置一下cargo 源为清华大学镜像源：

编辑 ~/.cargo/config 文件，添加以下内容：

[source.crates-io]
replace-with = 'tuna'

[source.tuna]
registry = "https://mirrors.tuna.tsinghua.edu.cn/git/crates.io-index.git"

编译 substrate

下载substrate代码

先 git clone substrate 的代码：

git clone https://github.com/paritytech/substrate.git

github.com 在国内也是龟速，因此我在 gitee.com fork 了一份，大家可以用以下命令 clone 代码：

git clone https://gitee.com/lbc-team/substrate.git

编译 substrate

cd substrate
cargo build --release

大约半小时，可以去喝个茶, 出现以下提示就成功了；

Finished release [optimized] target(s) in 29m 46s

编译完之后，在 /target/release/会生成 substrate 可执行文件。

运行 substrate 节点网络

现在可以使用 substrate 来启动网络了，substrate用很多个命令（参数），可使用./target/release/substrate --help查看用法。

这里使用 --dev 以开发者模式运行节点网络：

./target/release/substrate --dev

substrate 启动后，会输出如：当前的客户端版本，节点名，数据库目录，节点身份 ID等等：

2020-05-31 19:34:44 Running in --dev mode, RPC CORS has been disabled.
2020-05-31 19:34:44 Substrate Node
2020-05-31 19:34:44 ✌️  version 2.0.0-rc2-12b6c5dbe-x86_64-macos
2020-05-31 19:34:44 ❤️  by Parity Technologies &lt;admin@parity.io>, 2017-2020
2020-05-31 19:34:44 📋 Chain specification: Development
2020-05-31 19:34:44 🏷  Node name: homely-volcano-9283
2020-05-31 19:34:44 👤 Role: AUTHORITY
2020-05-31 19:34:44 💾 Database: RocksDb at /Users/emmett/Library/Application Support/substrate/chains/dev/db
2020-05-31 19:34:44 ⛓  Native runtime: node-251 (substrate-node-1.tx1.au10)
2020-05-31 19:34:44 📦 Highest known block at #173
2020-05-31 19:34:44 Using default protocol ID "sup" because none is configured in the chain specs
2020-05-31 19:34:44 🏷  Local node identity is: 12D3KooWEE4Gd4isn28sPsXQ3YBSPUqfpxmfVvKHzBxjWhEQPxV9 (legacy representation: QmVDyLimoKQjaGttsnvSdjLeJUkdxReUL6eDrF4LB7BL1h)
2020-05-31 19:34:44 〽️ Prometheus server started at 127.0.0.1:9615
2020-05-31 19:34:44 👶 Starting BABE Authorship worker
2020-05-31 19:34:45 🙌 Starting consensus session on top of parent 0x8c3fffd67f59db85fd468dc5a4386ccaf58dc2841ab0370f8d94b6f5413a511f

我们可以通过 https://polkadot.js.org/apps/ 查看当前节点的运行状态（也可以进行简单的交互），打开 https://polkadot.js.org/apps/ 可以看到如下界面：

默认时浏览器是连接当前的Polkadot CC1 候选主网，不过我们可以让他连接到本地节点，点设置->选择节点及配置地址前缀, 方法如下：

节点依然下拉框拉到最下面，选择 Local Node(Own, 127.0.0.1:9944) , 地址前缀选：Substrate(generic) 如下图：

配置好，别忘了点保存哦，连接好，就可以看到本地网络的块高了，如下图：

我们还可以测试一下转账功能：

运行多节点

在本地启动一个多节点连接的网络也是可以的，可以先以alice的名义启动一个验证人节点：

./target/release/substrate --alice --chain local

--chain local 表示是一个本地的网络模式，之前我们是开发者模式，这个时候不会出块，需要等待另一个节点加入才能出块。

再（在另一个终端）启动另一个节点，注意这里需要用 -d 来定义一个数据目录：

./target/release/substrate --bob  --chain local  -d ./bob

现在可以看到浏览器可以开始出块了。

好了，已经踏入了Substrate开发的第一步。

学分: 162
分类: Polkadot
标签: Substrate 环境搭建

本文参与登链社区写作激励计划，好文好收益，欢迎正在阅读的你也加入。