开源

substrate：可构建区块链应用程序的模块化开发框架

来源：元经纪阅读:1278

网站管理员
发布于 2023-05-19 08:43

概述

Substrate是一个用于构建区块链应用程序的模块化开发框架。它被设计为一个可扩展、灵活和易于开发的平台，使开发人员能够快速构建自定义的去中心化应用程序。 Substrate提供了一个基本的区块链结构，包括共识机制、网络协议和存储设计，同时允许开发人员根据自己的需求自由地添加自定义模块。该框架使用Rust语言编写，并由Parity Technologies维护。Substrate最初是为构建Polkadot区块链而设计的，但现在可以单独使用，也支持构建其他区块链项目。

安装

在开始开发基于 Substrate 的区块链之前，您需要使用所需的编译器和工具准备开发环境。因为 Substrate——以及大多数使用 Substrate 的开发人员工具——都是用Rust编程语言编写的，所以准备计算机的第一步是安装 Rust。安装 Rust 的步骤取决于您用于 Substrate 开发的计算机的操作系统。有关安装说明，请参阅适用于您的操作系统的相应主题。

如果您已经安装了 Rust，则可以跳过安装说明。有关安装和升级 Rust 编译器和工具链或解决安装问题的其他信息，请参阅以下主题：

教程

[hidecontent type="logged" desc="隐藏内容：登录后可查看"]

Rust 工具链

Rust 是一种现代的、类型健全的、高性能的编程语言，它为构建复杂的系统提供了丰富的功能集。该语言还有一个活跃的开发者社区和一个不断发展的共享库生态系统，称为crates。

学习生锈

Rust 是用于构建基于 Substrate 的区块链的核心语言，因此如果你打算进行 Substrate 开发，你需要熟悉 Rust 编程语言、编译器和工具链管理。如果您刚刚开始使用 Rust，您应该将Rust 编程语言加入书签并参考Rust 网站上的其他Learn Rust资源来指导您。但是，在准备开发环境时需要注意几个要点。

关于 Rust 工具链

Rust工具链中的核心工具是rustc编译器、cargo构建和包管理器以及rustup工具链管理器。在任何给定的时间点，都可以使用多个版本的 Rust。例如，有稳定版、测试版和夜间版的发布渠道。您可以使用该rustup程序来管理环境中可用的构建以及用于不同 Rust 构建的工具链程序的版本。编译rustc器使您能够为不同的体系结构构建二进制文件，称为目标。目标由一个字符串标识，该字符串指定编译器应生成的输出类型。此功能很重要，因为 Substrate 被编译为原生 Rust 二进制文件和 WebAssembly 目标。 WebAssembly 是一种可移植的二进制格式，可以在任何现代计算机硬件上以及通过任何访问互联网的浏览器执行。WebAssembly (Wasm) 目标使 Substrate 能够生成可移植的区块链运行时。有关如何使用这些二进制文件的更多信息，请参阅构建过程。

Linux开发环境

Rust 支持大多数 Linux 发行版。根据您使用的操作系统的特定发行版和版本，您可能需要向您的环境添加一些软件依赖项。通常，您的开发环境应该包括一个链接器或 C 兼容编译器，例如clang一个合适的集成开发环境 (IDE)。

在你开始之前

查看操作系统的文档以了解有关已安装的软件包以及如何下载和安装您可能需要的任何其他软件包的信息。例如，如果您使用 Ubuntu，则可以使用 Ubuntu 高级打包工具 ( apt) 来安装build-essential包：

sudo apt install build-essential

在安装 Rust 之前，您至少需要以下软件包：

clang curl git make

因为区块链需要标准的密码学来支持公钥/私钥对的生成和交易签名的验证，所以你还必须有一个提供密码学的包，libssl-dev比如openssl-devel.

安装所需的包和 Rust

在 Linux 上安装 Rust 工具链：

登录到您的计算机并打开终端 shell。
通过为您的 Linux 发行版运行适当的包管理命令来检查您在本地计算机上安装的包。
通过为您的 Linux 发行版运行适当的包管理命令，将您缺少的任何包依赖项添加到本地开发环境。例如，在 Ubuntu Desktop 或 Ubuntu Server 上，您可以运行类似于以下的命令：
```
sudo apt install --assume-yes git clang curl libssl-dev protobuf-compiler
```
单击选项卡标题可查看其他 Linux 操作系统的示例：
```
sudo apt install --assume-yes git clang curl libssl-dev llvm libudev-dev make protobuf-compiler
```
请记住，不同的发行版可能会以不同的方式使用不同的包管理器和捆绑包。例如，根据您的安装选择，Ubuntu Desktop 和 Ubuntu Server 可能有不同的包和不同的要求。但是，命令行示例中列出的包适用于许多常见的 Linux 发行版，包括 Debian、Linux Mint、MX Linux 和 Elementary OS。
下载rustup安装程序并通过运行以下命令使用它来安装 Rust：
```
curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh
```
按照显示的提示进行默认安装。
通过运行以下命令更新您当前的 shell 以包含 Cargo：
```
source $HOME/.cargo/env
```
通过运行以下命令验证您的安装：
```
rustc --version
```
通过运行以下命令将 Rust 工具链配置为默认为最新的稳定版本：
```
rustup default stable
rustup update
```
通过运行以下命令将发布和 WebAssembly (wasm) 目标添加到您的开发环境nightly：nightly
```
rustup update nightly
rustup target add wasm32-unknown-unknown --toolchain nightly
```

通过运行以下命令验证开发环境的配置：

rustup show
rustup +nightly show

该命令显示类似于以下内容的输出：

# rustup show

active toolchain
----------------

stable-x86_64-unknown-linux-gnu (default)
rustc 1.62.1 (e092d0b6b 2022-07-16)

# rustup +nightly show

active toolchain
----------------

nightly-x86_64-unknown-linux-gnu (overridden by +toolchain on the command line)
rustc 1.65.0-nightly (34a6cae28 2022-08-09)

编译 Substrate 节点

现在您已经安装了 Rust 并为 Substrate 开发配置了 Rust 工具链，您可以通过克隆 Substrate节点模板文件和编译 Substrate 节点来完成开发环境的设置。节点模板提供了一个工作环境，其中包含构建区块链所需的所有最常见功能，无需任何无关模块或工具。为了确保节点模板为您提供相对稳定的工作环境来进行试验，推荐的最佳实践是从 Substrate Developer Hub 存储库而不是核心 Substrate 存储库克隆 Substrate 节点模板。编译 Substrate 节点模板：

通过运行以下命令克隆节点模板存储库：
```
git clone https://github.com/substrate-developer-hub/substrate-node-template
```
在大多数情况下，您可以克隆main分支以获取最新代码。--branch但是，如果你想使用与特定 Polkadot 版本兼容的 Substrate 分支，你可以使用命令行选项。点击Tags查看与特定 Polkadot 版本兼容的分支列表。
通过运行以下命令更改到节点模板目录的根目录：
```
cd substrate-node-template
```
如果您想保存您的更改并使该分支易于识别，您可以通过运行类似于以下的命令来创建一个新分支：
```
git switch -c my-wip-branch
```
通过运行以下命令编译节点模板：
```
cargo build --release
```
由于所需的包数量，编译节点可能需要几分钟时间。

构建成功完成后，您的本地计算机就可以进行 Substrate 开发活动了。

macOS 开发环境

您可以在配备 Intel 或 Apple M1 处理器的 Apple macOS 计算机上安装 Rust 并设置 Substrate 开发环境。

在你开始之前

在 macOS 上安装 Rust 和设置开发环境之前，请确认您的计算机满足以下基本要求：

操作系统版本为 10.7 Lion 或更高版本。
处理器速度至少为 2Ghz，推荐 3Ghz。
内存至少 8 GB RAM，推荐 16 GB。
存储 10 GB 可用空间。
宽带互联网连接。

支持苹果 M1

Protobuf 必须在构建过程开始之前安装。要安装它，请运行以下命令： brew install protobuf

安装自制软件

在大多数情况下，您应该使用 Homebrew 在 macOS 计算机上安装和管理包。如果您的本地计算机上尚未安装 Homebrew，则应在继续之前下载并安装它。要安装自制软件：

打开终端应用程序。

通过运行以下命令下载并安装 Homebrew：

/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install.sh)"

通过运行以下命令验证 Homebrew 是否已成功安装：

brew --version

该命令显示类似于以下内容的输出：

Homebrew 3.3.1
Homebrew/homebrew-core (git revision c6c488fbc0f; last commit 2021-10-30)
Homebrew/homebrew-cask (git revision 66bab33b26; last commit 2021-10-30)

安装

因为区块链需要标准的密码学来支持公钥/私钥对的生成和交易签名的验证，所以你还必须有一个提供密码学的包，比如openssl. 在 macOS 上安装opensslRust 工具链：

打开终端应用程序。
通过运行以下命令确保您拥有更新版本的 Homebrew：
```
brew update
```
openssl通过运行以下命令安装包：
```
brew install openssl
```
下载rustup安装程序并通过运行以下命令使用它来安装 Rust：
```
curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh
```
按照显示的提示进行默认安装。
通过运行以下命令更新您当前的 shell 以包含 Cargo：
```
source ~/.cargo/env
```
通过运行以下命令验证您的安装：
```
rustc --version
```
通过运行以下命令将 Rust 工具链配置为默认为最新的稳定版本：
```
rustup default stable
rustup update
```
通过运行以下命令将发布和 WebAssembly (wasm) 目标添加到您的开发环境nightly：nightly
```
rustup update nightly
rustup target add wasm32-unknown-unknown --toolchain nightly
```

通过运行以下命令验证开发环境的配置：

rustup show
rustup +nightly show

该命令显示类似于以下内容的输出：

# rustup show

active toolchain
----------------

stable-x86_64-apple-darwin (default)
rustc 1.61.0 (fe5b13d68 2022-05-18)

# rustup +nightly show

active toolchain
----------------

nightly-x86_64-apple-darwin (overridden by +toolchain on the command line)
rustc 1.63.0-nightly (e71440575 2022-06-02)

cmake使用以下命令安装：

brew install cmake

编译 Substrate 节点

通过运行以下命令克隆节点模板存储库：
```
git clone https://github.com/substrate-developer-hub/substrate-node-template
```
在大多数情况下，您可以克隆main分支以获取最新代码。--branch但是，如果你想使用与特定 Polkadot 版本兼容的 Substrate 分支，你可以使用命令行选项。点击Tags查看与特定 Polkadot 版本兼容的分支列表。
通过运行以下命令更改到节点模板目录的根目录：
```
cd substrate-node-template
```
如果您想保存您的更改并使该分支易于识别，您可以通过运行类似于以下的命令来创建一个新分支：
```
git switch -c my-wip-branch
```
通过运行以下命令编译节点模板：
```
cargo build --release
```
由于所需的包数量，编译节点可能需要几分钟时间。

构建成功完成后，您的本地计算机就可以进行 Substrate 开发活动了。

Windows 开发环境

通常，基于 UNIX 的操作系统（如 macOS 或 Linux）为构建基于 Substrate 的区块链提供了更好的开发环境。Substrate教程和操作指南中的所有代码示例和命令行说明都说明了如何在终端中使用 UNIX 兼容命令与 Substrate 进行交互。但是，如果您的本地计算机使用 Microsoft Windows 而不是基于 UNIX 的操作系统，您可以为其配置额外的软件，使其成为构建基于 Substrate 的区块链的合适开发环境。要在运行 Microsoft Windows 的计算机上准备开发环境，您可以使用 Windows Subsystem for Linux (WSL) 来模拟 UNIX 操作环境。

在你开始之前

在 Microsoft Windows 上安装之前，请验证以下基本要求：

您有一台运行受支持版本的 Microsoft Windows 操作系统的计算机。
您必须运行 Microsoft Windows 10 版本 2004 或更高版本，或者 Microsoft Windows 11 才能在装有 Windows 桌面操作系统的计算机上安装适用于 Linux 的 Windows 子系统。
您必须运行 Microsoft Windows Server 2019 或更高版本，才能在装有 Windows 服务器操作系统的计算机上安装适用于 Linux 的 Windows 子系统。
您有良好的互联网连接并可以访问本地计算机上的 shell 终端。

为 Linux 设置 Windows 子系统

适用于 Linux 的 Windows 子系统 (WSL) 使您能够在使用 Windows 操作系统的计算机上模拟 Linux 环境。这种 Substrate 开发方法的主要优点是您可以使用 Substrate 文档中描述的所有代码和命令行示例。例如，您可以运行未修改的常用命令（例如ls和）ps。通过使用适用于 Linux 的 Windows 子系统，您可以避免配置虚拟机映像或双引导操作系统。要使用适用于 Linux 的 Windows 子系统准备开发环境：

检查您的 Windows 版本和内部版本号，看看是否默认启用了适用于 Linux 的 Windows 子系统。如果您有 Microsoft Windows 10 版本 2004（内部版本 19041 及更高版本）或 Microsoft Windows 11，则默认情况下适用于 Linux 的 Windows 子系统可用，您可以继续下一步。如果您安装了旧版本的 Microsoft Windows，请参阅旧版本的 WSL 手动安装步骤。如果您在较旧版本的 Microsoft Windows 上安装，并且您的计算机装有 Windows 10 版本 1903 或更高版本，则可以下载并安装 WLS 2。
从开始菜单中选择 Windows PowerShell 或命令提示符，右键单击，然后以管理员身份运行。
在 PowerShell 或命令提示符终端中，运行以下命令：
```
wsl --install
```
此命令启用作为 Windows 操作系统一部分的所需 WSL 2 组件，下载最新的 Linux 内核，并默认安装 Ubuntu Linux 发行版。如果您想查看其他可用的 Linux 发行版，请运行以下命令：
```
wsl --list --online
```
下载分发后，关闭终端。
单击“开始”菜单，选择“关机或注销”，然后单击“重新启动”以重新启动计算机。需要重新启动计算机才能开始安装 Linux 发行版。重新启动后可能需要几分钟才能完成安装。有关将 WSL 设置为开发环境的更多信息，请参阅设置 WSL 开发环境。

安装所需的包和 Rust

在 WSL 上安装 Rust 工具链：

单击开始菜单，然后选择Ubuntu。
键入 UNIX 用户名以创建用户帐户。
为您的 UNIX 用户输入密码，然后重新输入密码以确认。
apt通过运行以下命令，使用 Ubuntu 高级打包工具 () 下载 Ubuntu 发行版的最新更新：
```
sudo apt update
```

通过运行以下命令为 Ubuntu 发行版添加所需的包：

sudo apt install --assume-yes git clang curl libssl-dev llvm libudev-dev make protobuf-compiler

下载rustup安装程序并使用它通过运行以下命令为 Ubuntu 发行版安装 Rust：
```
curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh
```
按照显示的提示进行默认安装。
通过运行以下命令更新您当前的 shell 以包含 Cargo：
```
source ~/.cargo/env
```
通过运行以下命令验证您的安装：
```
rustc --version
```
通过运行以下命令，将 Rust 工具链配置为使用最新的稳定版本作为默认工具链：
```
rustup default stable
rustup update
```
通过运行以下命令将nightly工具链的版本和nightlyWebAssembly ( ) 目标添加到您的开发环境：wasm
```
rustup update nightly
rustup target add wasm32-unknown-unknown --toolchain nightly
```

通过运行以下命令验证开发环境的配置：

rustup show
rustup +nightly show

该命令显示类似于以下内容的输出：

# rustup show

active toolchain
----------------

stable-x86_64-unknown-linux-gnu (default)
rustc 1.61.0 (fe5b13d68 2022-05-18)

# rustup +nightly show

active toolchain
----------------

nightly-x86_64-unknown-linux-gnu (overridden by +toolchain on the command line)
rustc 1.63.0-nightly (e71440575 2022-06-02)

编译 Substrate 节点

通过运行以下命令克隆节点模板存储库：
```
git clone https://github.com/substrate-developer-hub/substrate-node-template
```
在大多数情况下，您可以克隆main分支以获取最新代码。--branch但是，如果你想使用与特定 Polkadot 版本兼容的 Substrate 分支，你可以使用命令行选项。点击Tags查看与特定 Polkadot 版本兼容的分支列表。
通过运行以下命令更改到节点模板目录的根目录：
```
cd substrate-node-template
```
如果您想保存您的更改并使该分支易于识别，您可以通过运行类似于以下的命令来创建一个新分支：
```
git switch -c my-wip-branch
```
通过运行以下命令编译节点模板：
```
cargo build --release
```
由于所需的包数量，编译节点可能需要几分钟时间。

构建成功完成后，您的本地计算机就可以进行 Substrate 开发活动了。

开发者工具

因为您将在 Rust 中编写代码，请确保您的开发环境具有适当的扩展和插件以使用 Rust。当您开始使用 Substrate 节点模板时，您会发现它包含一组专为运行时开发设计的核心功能和工具。但是，您还可以安装许多其他专用工具来补充和扩展您的开发环境或处理特定任务。在开始开发基于 Substrate 的区块链时，您可能会发现一些有用的工具包括：

Polkadot-JS APIPolkadot-JS API 提供了一个方法库，使您能够使用 JavaScript 查询任何基于 Substrate 的链并与之交互。您可以将该@polkadot/api包添加到任何 JavaScript 或 TypeScript 工作环境中。API 公开的大多数接口都是通过连接到正在运行的节点动态生成的。因为节点的配置决定了公开哪些接口，所以您可以使用 API 来处理实现不同功能的自定义链。要使用 API，您必须确定要连接的链的 URL。连接到链的节点后，API 会收集有关链状态及其功能的信息，然后根据收集到的有关该特定链的信息使用方法填充 API。
前端模板 Substrate 前端模板提供了一个预定义的前端应用程序，您可以使用它以最少的配置连接到 Substrate 节点后端。该模板使您能够开始试验 Substrate 节点的基本功能，而无需构建自己的自定义用户界面。该模板是使用 Create React App 入门项目和 Polkadot-JS API 构建的。
提交交易命令行界面这subxt-cli是一个命令行程序，您可以使用它通过连接到正在运行的节点来下载基于 Substrate 的链的完整配置信息（元数据）。与 Polkadot-JS API 类似，您可以随subxt-cli程序下载的元数据公开了有关 Substrate 链的信息，使您能够与该链进行交互。您还可以使用该subxt-cli程序以人类可读的格式公开有关链的信息。
边车 @substrate/api-sidecar 包是一种 RESTful 服务，您可以使用它连接到使用FRAME开发人员框架构建的 Substrate 节点并与之交互。有关服务支持的端点的信息，请参阅Substrate API Sidecar。

您可能还想探索Awesome Substrate中列出的资源和社区项目。有关一些最常用工具的概述，请参阅命令行工具。

排查 Rust 问题

如果编译Substrate 节点模板失败，问题很可能是您的开发环境中 Rust 的配置方式导致的。本节建议您如何诊断和修复配置问题。

检查您当前的配置

要查看有关您当前使用的 Rust 工具链的信息，请运行以下命令：

rustup show

此命令显示类似于以下 Ubuntu 示例的输出：

Default host: x86_64-unknown-linux-gnu
rustup home:  /home/user/.rustup

installed toolchains
--------------------

stable-x86_64-unknown-linux-gnu (default)
nightly-2020-10-06-x86_64-unknown-linux-gnu
nightly-x86_64-unknown-linux-gnu

installed targets for active toolchain
--------------------------------------

wasm32-unknown-unknown
x86_64-unknown-linux-gnu

active toolchain
----------------

stable-x86_64-unknown-linux-gnu (default)
rustc 1.50.0 (cb75ad5db 2021-02-10)

在此示例中，默认工具链来自stable在 x86 64 架构上运行的 Linux 的发布通道。示例输出还表明已安装 nightly-x86 64-unknown-linux-gnu 工具链，并且安装了两个目标：

x86_64-unknown-linux-gnuLinux 的原生 Rust 目标。
wasm32-unknown-unknownWebAssembly 目标。

此环境也nightly-2020-10-06-x86_64-unknown-linux-gnu安装了工具链，但仅当明确指定为命令行选项时才使用此工具链。有关将特定工具链指定为命令行选项的示例，请参阅指定夜间版本。

使用 WebAssembly 的夜间发布频道

Substrate 使用WebAssembly (Wasm) 来生成可移植的区块链运行时。您必须将 Rust 编译器配置为使用nightly构建，以允许您将 Substrate 运行时代码编译为 Wasm 目标。

更新工具链

通常，您应该始终使用最新版本的 Ruststable和nightly构建，因为 Substrate 中的更改通常取决于 Rustnightly编译器构建中的上游更改。为确保您的 Rust 编译器始终是最新的，您应该运行以下命令：

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

运行rustup update更新nightly和stable工具链以使用最新版本。如果在更新工具链后无法编译 WebAssembly 目标nightly，则可以回滚到工具链的早期版本并将该版本指定为命令行选项。有关获取早期版本的nightly工具链和指定要用作命令行选项的版本的更多信息，请降级工具链。

使用特定的夜间工具链

如果你想保证你的构建在你更新 Rust 和其他依赖项时在你的计算机上工作，你应该使用一个特定的 Rustnightly工具链，你知道它与你正在使用的 Substrate 版本兼容。您如何识别和传达nightly用于项目的特定工具链版本可能会有所不同。例如，Polkadot 在其发行说明中发布了此信息。确定nightly要使用的特定工具链版本后，您可以通过运行类似于以下的命令将其安装在您的开发环境中：

rustup install nightly-<yyyy-MM-dd>

例如：

rustup install nightly-2022-02-16

安装特定版本的夜间工具链后，通过运行类似于以下的命令配置 WebAssembly 目标以使用它：

rustup target add wasm32-unknown-unknown --toolchain nightly-<yyyy-MM-dd>

例如：

rustup target add wasm32-unknown-unknown --toolchain nightly-2022-02-16

在环境变量中指定工具链

您可以设置环境变量来指定用于编译 WebAssembly 的工具链WASM_BUILD_TOOLCHAIN版本。例如：nightly

WASM_BUILD_TOOLCHAIN=nightly-<yyyy-MM-dd> cargo build --release

此命令使用指定的夜间工具链构建运行时。项目的其余部分使用默认工具链编译，即stable您安装的最新版本的工具链。

降级夜间工具链

如果您的计算机配置为使用最新的 Rustnightly工具链，并且您想降级到特定的夜间版本，则必须先卸载最新的nightly工具链。例如，您可以删除最新的工具链，然后通过运行类似于以下的命令来nightly使用特定版本的工具链：nightly

rustup uninstall nightly
rustup install nightly-<yyyy-MM-dd>
rustup target add wasm32-unknown-unknown --toolchain nightly-<yyyy-MM-dd>

确保 PATH 设置正确

如果在安装 Rust 之后命令似乎不起作用，显示诸如之类的错误command not found: rustup，请确保您的 PATH 配置正确。目前，rustup安装程序默认安装到 bash 配置文件（在 mac 上）。如果您使用的是另一个 shell，请确保将此行添加到您的配置文件中（例如.zshrc）：

source "$HOME/.cargo/env"

为 M1 macOS 用户安装 cmake 或 protobuf

目前，在使用预装在带有 M1 芯片的 macOS 计算机上的软件包时，编译 Substrate 节点存在问题。

error: failed to run custom build command for prost-build v0.10.4

如果您看到此错误，有两种解决方案。

cmake通过运行以下命令进行安装：

brew install cmake

protoc通过运行以下命令集安装正确的预编译：

git clone https://github.com/protocolbuffers/protobuf.git
cd protobuf

brew install autoconf
brew install automake
brew install Libtool

autoreconf -i
./autogen.sh
./configure
make
make check
sudo make install

export PATH=/opt/usr/local/bin:$PATH

详细教程

前往docs.substrate.io并按照安装说明进行操作。然后试用其中一个教程。参考Docker 说明快速运行 Substrate、Substrate Node Template、Subkey，或构建链规范。

[/hidecontent]

免责声明：本文为用户发表，不代表网站立场，仅供参考，不构成引导等用途。开源

首页

分类

定制方案

消息

我的