Rust之Substrate框架中的pallet詳解

更新時間：2023年05月04日 09:17:03 作者：Pomelo_劉金

Pallet是Substrate區(qū)塊鏈的基礎模塊，它定義了區(qū)塊鏈的業(yè)務邏輯和狀態(tài)轉換規(guī)則。開發(fā)人員可以使用現(xiàn)有的Pallet來快速構建區(qū)塊鏈，也可以開發(fā)自定義的Pallet來實現(xiàn)特定的功能，感興趣的小伙伴可以參考閱讀下

引言

Substrate 是一個區(qū)塊鏈開發(fā)框架，它提供了一系列模塊化和可擴展的組件，可以幫助開發(fā)人員快速構建自定義區(qū)塊鏈。 Pallet 是 Substrate 區(qū)塊鏈的基礎模塊，它定義了區(qū)塊鏈的業(yè)務邏輯和狀態(tài)轉換規(guī)則。開發(fā)人員可以使用現(xiàn)有的 Pallet 來快速構建區(qū)塊鏈，也可以開發(fā)自定義的 Pallet 來實現(xiàn)特定的功能。

Pallet 概述

Pallet是一個 Rust 程序包，它定義了一組特定的功能和接口。每個 Pallet 都包含了一組存儲項、一組調用函數(shù)和一組事件。

一個典型的 Substrate Pallet 由以下部分組成：

配置 Trait：定義了 Pallet 的配置接口。
存儲項：定義了 Pallet 的狀態(tài)存儲。
調用函數(shù)：定義了 Pallet 的外部調用接口。
事件：定義了 Pallet 的事件類型。

Pallet 開發(fā)

要開發(fā) Substrate Pallet，首先需要搭建開發(fā)環(huán)境。我們需要安裝 Rust 編程語言、Substrate 開發(fā)包和 Node.js 等工具。下面是一個簡單的安裝示例：

# 安裝 Rust 編程語言
curl https://sh.rustup.rs -sSf | sh

# 安裝 Substrate 開發(fā)包
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

開發(fā)一個 Substrate Pallet 的流程大致如下：

定義配置 Trait：定義 Pallet 的配置接口。
定義存儲項：定義 Pallet 的狀態(tài)存儲。
定義調用函數(shù)：定義 Pallet 的外部調用接口。
定義事件：定義 Pallet 的事件類型。
實現(xiàn)業(yè)務邏輯：實現(xiàn) Pallet 的業(yè)務邏輯。

定義配置 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 的狀態(tài)存儲。存儲項是 Pallet 的狀態(tài)存儲，它用來存儲區(qū)塊鏈的狀態(tài)數(shù)據(jù)。我們可以使用 decl_storage! 宏來定義存儲項。下面是一個簡單的存儲項示例：

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

在這個示例中，我們使用 decl_storage! 宏定義了一個存儲項 Something。它是一個可選的 u32 類型，可以使用 get 函數(shù)來獲取它的值。

定義調用函數(shù)：定義 Pallet 的外部調用接口。調用函數(shù)是 Pallet 的外部調用接口，它用來接收外部調用并執(zhí)行相應的操作。我們可以使用 decl_module! 宏來定義調用函數(shù)。下面是一個簡單的調用函數(shù)示例：

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! 宏定義了一個調用函數(shù) do_something。它接收兩個參數(shù)：origin 和 something。origin 表示調用方的身份；something 表示要存儲的數(shù)值。在函數(shù)體內，我們首先使用 ensure_signed 函數(shù)檢查調用方的身份；然后使用 <Something<T>>::put 函數(shù)將數(shù)值存儲到存儲項中；最后使用 Self::deposit_event 函數(shù)觸發(fā)一個事件。

定義事件：定義 Pallet 的事件類型。事件是 Pallet 的一種通知機制，它用來通知外部模塊 Pallet 內部狀態(tài)的變化。我們可以使用 decl_event! 宏來定義事件。下面是一個簡單的事件示例：

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

在這個示例中，我們使用 decl_event! 宏定義了一個事件 SomethingStored。它包含兩個字段：u32 和 AccountId。u32 表示存儲的數(shù)值；AccountId 表示調用方的身份。

實現(xiàn)業(yè)務邏輯：實現(xiàn) Pallet 的業(yè)務邏輯。在完成了上述步驟之后，我們就可以開始實現(xiàn) Pallet 的業(yè)務邏輯了。我們需要在調用函數(shù)中編寫相應的代碼，以實現(xiàn) Pallet 的功能。下面是一個簡單的業(yè)務邏輯示例：

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(())
        }
    }
}

在這個示例中，我們在調用函數(shù) do_something 中實現(xiàn)了一個簡單的業(yè)務邏輯：將傳入的數(shù)值存儲到存儲項中，并觸發(fā)一個事件。

Pallet 集成

集成現(xiàn)有 Pallet 要集成現(xiàn)有的 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>},
    }
);

要開發(fā)自定義的 Pallet，我們需要按照上文提到的開發(fā)流程來實現(xiàn)。下面是一個簡單的自定義 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、一個調用函數(shù) do_something 和一個事件 SomethingStored。存儲項 Something 用來存儲一個數(shù)值；調用函數(shù) do_something 用來修改存儲的數(shù)值；事件 SomethingStored 用來記錄修改操作。