添加一个 Pallet · Substrate开发者中心

Substrate node template(节点模板) 提供了一个最小的可工作的运行时，你可以使用它来快速开始构建自己的自定义区块链。但是，为保持精炼，它并不包括FRAME中的大多数 Pallet 。

本教程将向你展示如何将合约 pallet 添加到运行时（runtime）中，以允许你的区块链支持Wasm智能合约，但是请注意，为了正确使用，每个pallet所需的特定配置设置会略有不同。

安装节点模板(Node Template)

如果你完成了前面的创建第一条 Substrate 区块链，你应该已经编译好了 Substrate Node Template v2.0.0-rc4 版本，如果还没有，需要先完成前面的教程。

有经验的开发人员会想跳过该教程，那你参考 readme 指引可以安装节点模板

文件结构

我们将修改 substrate-node-template 来引入合约 pallet.

用编辑器打开 substrate-node-template，我们将编辑以下两个文件：runtime/src/lib.rs和runtime/Cargo.toml`.

substrate-node-template
|
+-- runtime
|   |
|   +-- Cargo.toml    <-- 一处更改
|   |
|   +-- build.rs
|   |
|   +-- src
|       |
|       +-- lib.rs     <-- 大量修改
|
+-- pallets
|
+-- scripts
|
+-- node
|
+-- ...

导入 Pallet 包（crate）

添加合约 pallet 的第一件事是在运行时的 Cargo.toml 文件中导入 pallet-contracts 包。

如果你想查看原始引用方法，请查看其官方文档

打开 substrate-node-template/runtime/Cargo.toml 后，你会看到运行时所有的依赖列表，例如：它依赖Balances pallet:

runtime/Cargo.toml

[dependencies.balances]
default-features = false
git = 'https://github.com/paritytech/substrate.git'
package = 'pallet-balances'
tag = 'v2.0.0-rc4'
version = '2.0.0-rc4'

包特性（Crate Features）

导入pallet 包时需要注意的一件事是确保正确设置包的 features。

在上面的代码片段中，你会注意到我们设置了 default_features = false。如果你更仔细地浏览 Cargo.toml 文件，你会发现类似：

runtime/Cargo.toml

[features]
default = ['std']
std = [
    'codec/std',
    'client/std',
    'sp-std/std',
    'sp-io/std',
    'balances/std',
    'frame-support/std',
    #--snip--
]

第二行将运行时 crate 的 default 特性定义为std（译者注：表示 Rust 标准库）。你可以想象，每个 pallet crate 都有一个类似的配置，定义了 crate 的默认特性。特性的定义会决定下游依赖项应该使用的特性。例如，上面的代码片段应解读为：

Substrate 运行时默认特性是std。当运行时的 std 特性可用时，parity-scale-codec, primitives, client 和其他列出的依赖也应该使用他们的 std 特性。

在编译 Native版本（支持 Rust std ）和 Wasm版本（仅支持 no_std），feature 配置非常重要的。

译者注：可以把 no_std 简单理解为为了在嵌入式环境下运行，精简为只包含部分核心的std, 并包含了一些底层相关的代码。

我们可以打开项目文件，来查看这些特性实际上如何在运行时代码中使用：

runtime/src/lib.rs

//!  Substrate Node Template 运行时. 用 `#[no_std]` 编译, 用于 Wasm 版本.

#![cfg_attr(not(feature = "std"), no_std)]
// `construct_runtime!` 进行了大量递归，并要求我们将限制增加到256。
#![recursion_limit="256"]

// 使 WASM 二进制可用
#[cfg(feature = "std")]
include!(concat!(env!("OUT_DIR"), "/wasm_binary.rs"));

// --省略--

你可以看到，在文件的顶部，我们定义了当不使用std特性时，使用no_std。接下来几行，可以在 wasm_binary.rs 导入上方看到 #[cfg(feature = "std")]，这是一个标志，表示在启用 std 特性时仅导入WASM二进制文件。

导入合约 Pallet 包（crate)

好了, 现在我们有了 crate 特性的基本的认识，开始实际导入合约 pallet。合约 pallet 也许是 FRAME 中最复杂的pallet，因此，这为添加其他pallet时可能涉及的一些棘手问题提供了一个很好的例子。

首先，我们将通过简单地复制现有 pallet 并更改值来添加新的依赖。

因此，根据上面导入的balances ，contracts 的导入将类似于：

runtime/Cargo.toml

[dependencies.contracts]
git = 'https://github.com/paritytech/substrate.git'
default-features = false
package = 'pallet-contracts'
tag = 'v2.0.0-rc4'
version = '2.0.0-rc4'

[dependencies.contracts-primitives]
git = 'https://github.com/paritytech/substrate.git'
default-features = false
package = 'pallet-contracts-primitives'
tag = 'v2.0.0-rc4'
version = '2.0.0-rc4'

与其他 pallets 一样，合约 pallet 具有 std 特性。当运行时使用其自己的 std 特性构建时，我们应该构建其 std 特性。将以下两行添加到运行时的std 特性中。

runtime/Cargo.toml

[features]
default = ["std"]
std = [
    #--省略--
    'contracts/std',
    'contracts-primitives/std',
    #--省略--
]

如果你忘记设置特性，则在构建native二进制文件时会出现类似以下错误：

error[E0425]: cannot find function `memory_teardown` in module `sandbox`
  --> ~/.cargo/git/checkouts/substrate-7e08433d4c370a21/83a6f1a/primitives/sandbox/src/../without_std.rs:53:12
   |
53 |         sandbox::memory_teardown(self.memory_idx);
   |                  ^^^^^^^^^^^^^^^ not found in `sandbox`

error[E0425]: cannot find function `memory_new` in module `sandbox`
  --> ~/.cargo/git/checkouts/substrate-7e08433d4c370a21/83a6f1a/primitives/sandbox/src/../without_std.rs:72:18
   |
72 |         match sandbox::memory_new(initial, maximum) {
   |

...

现在是时候检查一下是否可以正确编译所有内容：

cargo check

添加合约 Pallet

现在，我们已经成功导入了合约 Pallet 包（crate），我们需要将其添加到运行时中。不同的 Pallet 将要求你 use 不同的类型。对于合约Pallet，我们将使用Schedule类型。在运行时开头处，将此行添加到其他pub use语句附近。

runtime/src/lib.rs

/*** 添加此行 ***/
/// 导入合约 Schedule 类型
pub use contracts::Schedule as ContractsSchedule;

实现合约 Trait

每个 pallet 都称为Trait 的配置 trait，必须在运行时中实现。

要弄清楚我们需要为该 pallet 具体实现什么，你可以看一下FRAME contracts::Trait 文档。

对于我们的运行时，实现将如下所示：

runtime/src/lib.rs


// 时间单位以区块数定义。 
/* --省略-- */

/*** 添加的代码块 ***/
// Contracts 货币单位.
pub const MILLICENTS: Balance = 1_000_000_000;
pub const CENTS: Balance = 1_000 * MILLICENTS;
pub const DOLLARS: Balance = 100 * CENTS;
/*** 结束添加代码块 ***/


impl timestamp::Trait for Runtime {
    /* --省略-- */
}

/*** 添加代码块 ***/
parameter_types! {
    pub const TombstoneDeposit: Balance = 16 * MILLICENTS;
    pub const RentByteFee: Balance = 4 * MILLICENTS;
    pub const RentDepositOffset: Balance = 1000 * MILLICENTS;
    pub const SurchargeReward: Balance = 150 * MILLICENTS;
}

impl contracts::Trait for Runtime {
    type Time = Timestamp;
    type Randomness = RandomnessCollectiveFlip;
    type Currency = Balances;
    type Event = Event;
    type DetermineContractAddress = contracts::SimpleAddressDeterminer<Runtime>;
    type TrieIdGenerator = contracts::TrieIdFromParentCounter<Runtime>;
    type RentPayment = ();
    type SignedClaimHandicap = contracts::DefaultSignedClaimHandicap;
    type TombstoneDeposit = TombstoneDeposit;
    type StorageSizeOffset = contracts::DefaultStorageSizeOffset;
    type RentByteFee = RentByteFee;
    type RentDepositOffset = RentDepositOffset;
    type SurchargeReward = SurchargeReward;
    type MaxDepth = contracts::DefaultMaxDepth;
    type MaxValueSize = contracts::DefaultMaxValueSize;
    type WeightPrice = transaction_payment::Module<Self>;
}
/*** 结束添加代码块 ***/

我们将使用 type DetermineContractAddress 作为实例探索一下细节，你可以从文档 DetermineContractAddress 文档查看到它需要 trait ContractAddressFor。 Contracts pallet 本身用contract::SimpleAddressDeterminator的这个trait实现了一个类型，因此我们可以使用该实现来满足我们的 contracts::Trait。在这一点上，如果有什么不明白，或是想深入理解，我真的建议你探索Contracts pallet源码。

添加合约到 `construct_runtime!` 宏

下一步，我们需要把pallet添加到 construct_runtime! 宏。为此，我们需要确定 pallet 公开的类型，以便我们可以告之运行时类型的存在。可能的类型的完整列表可以在construct_runtime！宏文档中找到。

如果我们仔细查看Contracts pallet，我们知道它具有：

存储模块: 因为它使用了 decl_storage! 宏。
事件模块: 因为它使用了 decl_event! 宏。
可调用函数: 因为它在 decl_module! 宏有可调用的函数。
配置值: 因为 decl_storage! 宏有 config() 参数。
来自 decl_module! 宏的 Module 类型。

因此，我们添加这个 pallet，就像这样：

runtime/src/lib.rs

construct_runtime!(
    pub enum Runtime where
        Block = Block,
        NodeBlock = opaque::Block,
        UncheckedExtrinsic = UncheckedExtrinsic
    {
        /* --snip-- */

        /*** 添加这行 ***/
        Contracts: contracts::{Module, Call, Config, Storage, Event<T>},
    }
);

请注意，并非所有的pallet都会公开暴露所有这些运行时类型，有些可能会公开很多！总是需要你查看pallet的源代码或文档，以确定哪些是你需要公开的类型。

到目前为止，是检查运行时是否能正确编译的另一个好时机。尽管运行时应该编译，但整个节点还不能。因此，我们将使用以下命令仅检查运行时。

cargo check -p node-template-runtime

公开合约 API

某些pallet（包括Contract pallet）公开了自定义运行时API和RPC节点。对于Contract pallet来说，这使得可以从链外读取合约状态。

在我们的链上使用是不要求启用Contract pallet上的RPC调用。但是，我们将这样做以在不进行交易的情况下调用节点的存储。

我们从Cargo.toml中添加所需的API依赖开始。

runtime/Cargo.toml

[dependencies.contracts-rpc-runtime-api]
git = 'https://github.com/paritytech/substrate.git'
default-features = false
package = 'pallet-contracts-rpc-runtime-api'
version = '0.8.0-rc4'
tag = 'v2.0.0-rc4'

runtime/Cargo.toml

[features]
default = ["std"]
std = [
    #--忽略--
    'contracts-rpc-runtime-api/std',
]

为了获取合约变量的状态，我们需要调用 getter 函数，它将返回执行状态的 ContractExecResult 包装

我们需要将返回类型添加到运行时。用其他use语句来添加。

runtime/src/lib.rs

/*** 添加这行 ***/
use contracts_rpc_runtime_api::ContractExecResult;
/* --忽略-- */

现在，我们准备实现合约运行时API。这是在impl_runtime_apis！宏中在运行时即将结束试进行发生的。

impl_runtime_apis! {
   /* --忽略-- */

   /*** 添加代码块 ***/
    impl contracts_rpc_runtime_api::ContractsApi<Block, AccountId, Balance, BlockNumber>
        for Runtime
    {
        fn call(
            origin: AccountId,
            dest: AccountId,
            value: Balance,
            gas_limit: u64,
            input_data: Vec<u8>,
        ) -> ContractExecResult {
            let exec_result =
                Contracts::bare_call(origin, dest.into(), value, gas_limit, input_data);
            match exec_result {
                Ok(v) => ContractExecResult::Success {
                    status: v.status,
                    data: v.data,
                },
                Err(_) => ContractExecResult::Error,
            }
        }

        fn get_storage(
            address: AccountId,
            key: [u8; 32],
        ) -> contracts_primitives::GetStorageResult {
            Contracts::get_storage(address, key)
        }

        fn rent_projection(
            address: AccountId,
        ) -> contracts_primitives::RentProjectionResult<BlockNumber> {
            Contracts::rent_projection(address)
        }
    }
   /*** End Added Block ***/
}

这是另一个去检查运行时是否正确编译好时机。

cargo check -p node-template-runtime

升级外部节点

至此，我们已经完成了向运行时添加pallet的工作。现在，我们将注意力转向外部节点，外部节点通常需要一些相应的更新。对于合约 pallet，我们将添加自定义RPC 和创始配置。

添加 RPC 端点

由于公开了适当的运行时API。现在，我们将RPC添加到节点的服务中，以调用该运行时API。因为我们现在在外部节点上工作，所以我们没有构建为no_std并且我们不必维护专用的std功能。

node/Cargo.toml

[dependencies]
#--snip--
jsonrpc-core = '14.0.5'

[dependencies.pallet-contracts-rpc]
git = 'https://github.com/paritytech/substrate.git'
version = '0.8.0-rc4'
tag = 'v2.0.0-rc4'

[dependencies.sc-rpc]
git = 'https://github.com/paritytech/substrate.git'
tag = 'v2.0.0-rc4'

node/src/service.rs

macro_rules! new_full_start {
    ($config:expr) => {{
        /*** 添加这行 ***/
        use jsonrpc_core::IoHandler;

Substrate 提供了一个RPC与我们的节点进行交互。但是，默认情况下，它不包含对合约Pallet的访问。要与该Pallet交互，我们必须扩展现有的RPC并添加合约Pallet及其API。

            /* --忽略-- */
                Ok(import_queue)
            })? // <- 移除分号
            /*** 添加这个代码块 ***/
            .with_rpc_extensions(|builder| -> Result<IoHandler<sc_rpc::Metadata>, _> {
                let handler = pallet_contracts_rpc::Contracts::new(builder.client().clone());
                let delegate = pallet_contracts_rpc::ContractsApi::to_delegate(handler);

                let mut io = IoHandler::default();
                io.extend_with(delegate);
                Ok(io)
            })?;
            /*** 结束添加的代码块 ***/
        (builder, import_setup, inherent_data_providers)
    }}

创始配置

不是所有的 pallet 有创始配置，但如果你的需要，你需要通过文档了解它，例如pallet_contracts::GenesisConfig 文档描述了你需要为合约pallet定义的所有字段。

创始配置通过 node/src/chain_spec.rs 控制，我们需要修改此文件以在顶部包含ContractsConfig类型和合约价格单位：

node/src/chain_spec.rs

use node_template_runtime::{ContractsConfig, ContractsSchedule};

然后在 testnet_genesis 函数中，我们需要将合约配置添加到返回的GenesisConfig对象如下：

重要：我们正在从函数参数中获取值 _enable_println 。确保删除参数定义之前的下划线。

fn testnet_genesis(initial_authorities: Vec<(AuraId, GrandpaId)>,
    root_key: AccountId,
    endowed_accounts: Vec<AccountId>,
    _enable_println: bool) -> GenesisConfig {

    GenesisConfig {
        /* --snip-- */

        /*** 添加这个代码块 ***/
        contracts: Some(ContractsConfig {
            current_schedule: ContractsSchedule {
                    enable_println,
                    ..Default::default()
            },
        }),
        /***  结束添加的代码块 ***/
    }
}

启动升级的链

现在，你可以编译并运行具有合约功能的节点了。在发布（release）模式下使用以下命令编译节点

cargo build --release

在运行链之前，我们首先需要清除链以删除旧的运行时逻辑，并为合约pallet初始化创始配置。不清除链条的情况升级也可行的，但超出了本教程的范围。

./target/release/node-template purge-chain --dev
./target/release/node-template --dev

添加其他的 FRAME pallets

在本教程中，我们专门介绍了如何导入合约pallet，但是，如教程开头所述，每个pallet都会有所不同。不用担心，你始终可以参考演示的Substrate节点运行时，该运行时几乎包括FRAME中的每个pallet。

在 Substrate 节点运行时的 Cargo.toml 文件，你将看到一个有关如何导入每个不同pallet的示例，在lib.rs文件中，你将找到如何将每个pallet添加到运行时。你基本上可以将这里所做的复制代码到你自己的运行时。

了解更多

关于在自己的程序包中编写运行时pallet的极简教程.
现在，你的节点可以运行智能合约了，请了解Substrate ink! 智能合约.
Substrate Recipes 提供了详细的教程关于编写Runtime APIs和Custom RPCs ，就像本教程中探讨的那样。
理解 Chain Spec 文件去定制化创世配置。

引用

FRAME Contracts Pallet API

安装节点模板(Node Template)

文件结构

导入 Pallet 包（crate）

包特性（Crate Features）

导入合约 Pallet 包（crate)

添加合约 Pallet

实现合约 Trait

添加合约到 construct_runtime! 宏

公开合约 API

升级外部节点

添加 RPC 端点

创始配置

启动升级的链

添加其他的 FRAME pallets

了解更多

引用

添加合约到 `construct_runtime!` 宏