Rust之Substrate框架中的pallet详解

2023-05-18 17:57

短信预约 -IT技能 免费直播动态提醒

引言

Substrate 是一个区块链开发框架，它提供了一系列模块化和可扩展的组件，可以帮助开发人员快速构建自定义区块链。 Pallet 是 Substrate 区块链的基础模块，它定义了区块链的业务逻辑和状态转换规则。开发人员可以使用现有的 Pallet 来快速构建区块链，也可以开发自定义的 Pallet 来实现特定的功能。

Pallet 概述

Pallet是一个 Rust 程序包，它定义了一组特定的功能和接口。每个 Pallet 都包含了一组存储项、一组调用函数和一组事件。

一个典型的 Substrate Pallet 由以下部分组成：

配置 Trait：定义了 Pallet 的配置接口。
存储项：定义了 Pallet 的状态存储。
调用函数：定义了 Pallet 的外部调用接口。
事件：定义了 Pallet 的事件类型。

Pallet 开发

要开发 Substrate Pallet，首先需要搭建开发环境。我们需要安装 Rust 编程语言、Substrate 开发包和 Node.js 等工具。下面是一个简单的安装示例：

# 安装 Rust 编程语言
curl https://sh.rustup.rs -sSf | sh

# 安装 Substrate 开发包
curl https://getsubstrate.io -sSf | bash

# 安装 Node.js
curl -sL https://deb.nodesource.com/setup_12.x | sudo -E bash -
sudo apt-get install -y nodejs

开发一个 Substrate Pallet 的流程大致如下：

定义配置 Trait：定义 Pallet 的配置接口。
定义存储项：定义 Pallet 的状态存储。
定义调用函数：定义 Pallet 的外部调用接口。
定义事件：定义 Pallet 的事件类型。
实现业务逻辑：实现 Pallet 的业务逻辑。

定义配置 Trait：定义 Pallet 的配置接口。配置 Trait 是一个 Rust Trait，它定义了 Pallet 的配置接口。我们需要在配置 Trait 中定义一些类型和常量，以便在 Pallet 中使用。下面是一个简单的配置 Trait 示例：

pub trait Trait: system::Trait {
    type Event: From<Event<Self>> + Into<<Self as system::Trait>::Event>;
}

在这个示例中，我们定义了一个 Trait Trait，它继承自 system::Trait。我们在 Trait 中定义了一个类型 Event，它用来表示 Pallet 的事件类型。

定义存储项：定义 Pallet 的状态存储。存储项是 Pallet 的状态存储，它用来存储区块链的状态数据。我们可以使用 decl_storage! 宏来定义存储项。下面是一个简单的存储项示例：

decl_storage! {
    trait Store for Module<T: Trait> as TemplateModule {
        pub Something get(fn something): Option<u32>;
    }
}

在这个示例中，我们使用 decl_storage! 宏定义了一个存储项 Something。它是一个可选的 u32 类型，可以使用 get 函数来获取它的值。

定义调用函数：定义 Pallet 的外部调用接口。调用函数是 Pallet 的外部调用接口，它用来接收外部调用并执行相应的操作。我们可以使用 decl_module! 宏来定义调用函数。下面是一个简单的调用函数示例：

decl_module! {
    pub struct Module<T: Trait> for enum Call where origin: T::Origin {
        fn deposit_event() = default;

        pub fn do_something(origin, something: u32) -> Result {
            let who = ensure_signed(origin)?;
            <Something<T>>::put(something);
            Self::deposit_event(RawEvent::SomethingStored(something, who));
            Ok(())
        }
    }
}

在这个示例中，我们使用 decl_module! 宏定义了一个调用函数 do_something。它接收两个参数：origin 和 something。origin 表示调用方的身份；something 表示要存储的数值。在函数体内，我们首先使用 ensure_signed 函数检查调用方的身份；然后使用 <Something<T>>::put 函数将数值存储到存储项中；最后使用 Self::deposit_event 函数触发一个事件。

定义事件：定义 Pallet 的事件类型。事件是 Pallet 的一种通知机制，它用来通知外部模块 Pallet 内部状态的变化。我们可以使用 decl_event! 宏来定义事件。下面是一个简单的事件示例：

decl_event!(
    pub enum Event<T> where AccountId = <T as system::Trait>::AccountId {
        SomethingStored(u32, AccountId),
    }
);

在这个示例中，我们使用 decl_event! 宏定义了一个事件 SomethingStored。它包含两个字段：u32 和 AccountId。u32 表示存储的数值；AccountId 表示调用方的身份。

实现业务逻辑：实现 Pallet 的业务逻辑。在完成了上述步骤之后，我们就可以开始实现 Pallet 的业务逻辑了。我们需要在调用函数中编写相应的代码，以实现 Pallet 的功能。下面是一个简单的业务逻辑示例：

decl_module! {
    pub struct Module<T: Trait> for enum Call where origin: T::Origin {
        fn deposit_event() = default;

        pub fn do_something(origin, something: u32) -> Result {
            let who = ensure_signed(origin)?;
            <Something<T>>::put(something);
            Self::deposit_event(RawEvent::SomethingStored(something, who));
            Ok(())
        }
    }
}

在这个示例中，我们在调用函数 do_something 中实现了一个简单的业务逻辑：将传入的数值存储到存储项中，并触发一个事件。

Pallet 集成

集成现有 Pallet 要集成现有的 Pallet，我们需要在 Runtime 中引入对应的 Pallet 模块，并在 construct_runtime! 宏中声明它。下面是一个简单的示例：

// 引入 Balances 模块
use pallet_balances as balances;

// 在 construct_runtime! 宏中声明 Balances 模块
construct_runtime!(
    pub enum Runtime where
        Block = Block,
        NodeBlock = opaque::Block,
        UncheckedExtrinsic = UncheckedExtrinsic,
    {
        // ...
        Balances: balances::{Module, Call, Storage, Config<T>, Event<T>},
    }
);

要开发自定义的 Pallet，我们需要按照上文提到的开发流程来实现。下面是一个简单的自定义 Pallet 示例：

use support::{decl_module, decl_storage, decl_event, dispatch::Result};
use system::ensure_signed;

pub trait Trait: system::Trait {
    type Event: From<Event<Self>> + Into<<Self as system::Trait>::Event>;
}

decl_storage! {
    trait Store for Module<T: Trait> as TemplateModule {
        pub Something get(fn something): Option<u32>;
    }
}

decl_event!(
    pub enum Event<T> where AccountId = <T as system::Trait>::AccountId {
        SomethingStored(u32, AccountId),
    }
);

decl_module! {
    pub struct Module<T: Trait> for enum Call where origin: T::Origin {
        fn deposit_event() = default;

        pub fn do_something(origin, something: u32) -> Result {
            let who = ensure_signed(origin)?;
            <Something<T>>::put(something);
            Self::deposit_event(RawEvent::SomethingStored(something, who));
            Ok(())
        }
    }
}

在这个示例中，我们定义了一个自定义的 Pallet，它包含了一个存储项 Something、一个调用函数 do_something 和一个事件 SomethingStored。存储项 Something 用来存储一个数值；调用函数 do_something 用来修改存储的数值；事件 SomethingStored 用来记录修改操作。