substrate基础(9)-实现简单的pallet

通过本文，可以初步掌握如何实现一个pallet

1. 概述

1. 一条平行链的开发，一般都是基于模板进行开发的：substrate-node-template ，当然，pallet的也是在其中进行开发
2. substrate-node-template 根目录中，主要关注3个目录：node、pallet、runtime：
   1. node：是链的一些基础功能的实现（或者说比较底层的实现，如网络、rpc，搭建链的最基础的code)，一般情况下，很少去动这个目录的内容
   2. pallet：各个pallet都是在该目录下汇总的，可以理解成是一个个的业务功能包。当然substrate本身也提供了很多现成的pallet，可以直接引用
   3. runtime：用于整合pallet中的功能，并运行
3. 本文是要了解如何在自定义的pallet中使用宏。实现如下案例功能：
   构建一个简单的存在证明（验证你手中的数字对象在链上是否存在，是否正确，归属人是否正确等）
   本文主要可以掌握：
   1. 如何将事件、错误、存储和可调用函数添加到自定义托拍。
   2. 如何将自定义托盘集成到运行时。
   3. 如何编译和启动包含自定义托盘的节点。
   4. 如何添加 React 前端组件以向用户公开自定义托盘。

2. 设计存在证明程序

要求存储有关已声明的证明以及谁提出了这些声明的信息。即POE证明
公开两个可供调用的函数：

1. create_claim()：允许用户通过上传哈希来声明文件存在
2. revoke_claim()：允许声明当前所有者撤销所有权

3. 为自定义pallet设置脚手架

1. 进入目录：

cd pallets/template/src

2. 删除文件：
   测试相关文件，目前不需要，后续若想掌握，可单独查阅资料

benchmarking.rs
mock.rs
tests.rs

3. 打开lib.rs，删除其中所有代码；然后在其中加入如下代码，这个其实就是pallet的基本格式：

// 1. Imports and Dependencies
pub use pallet::*;
#[frame_support::pallet]
pub mod pallet {
   use frame_support::pallet_prelude::*;
   use frame_system::pallet_prelude::*;

   // 2. Declaration of the Pallet type
   // This is a placeholder to implement traits and methods.
   #[pallet::pallet]
   #[pallet::generate_store(pub(super) trait Store)]
   pub struct Pallet<T>(_);

   // 3. Runtime Configuration Trait
   // All types and constants go here.
   // Use #[pallet::constant] and #[pallet::extra_constants]
   // to pass in values to metadata.
   #[pallet::config]
   pub trait Config: frame_system::Config { ... }

   // 4. Runtime Storage
   // Use to declare storage items.
   #[pallet::storage]
   #[pallet::getter(fn something)]
   pub MyStorage<T: Config> = StorageValue<_, u32>;

   // 5. Runtime Events
   // Can stringify event types to metadata.
   #[pallet::event]
   #[pallet::generate_deposit(pub(super) fn deposit_event)]
   pub enum Event<T: Config> { ... }

   // 6. Hooks
   // Define some logic that should be executed
   // regularly in some context, for e.g. on_initialize.
   #[pallet::hooks]
   impl<T: Config> Hooks<BlockNumberFor<T>> for Pallet<T> { ... }
   
   // 7. Extrinsics
   // Functions that are callable from outside the runtime.
   #[pallet::call]
   impl<T:Config> Pallet<T> { ... }
   
   }

可以看出，一个pallet大体需要实现以下内容：

1. 依赖; 
2. pallet类型声明;
3. config trait;
4. 定义要使用的链上存储;
5. 事件;
6. 钩子函数;
7. 交易调用函数;

1和2基本上是固定的写法，而对于后面的3-7部分，则是根据实际需要写或者不写。

4. 为pallet配置事件

每个pallet都有一个称为Config的特征。可以用这个属性来为pallet配置所需要的设置

1. 在pallets/template/src/lib.rs中，在#[pallet::config]之后新增内容：

/// Configure the pallet by specifying the parameters and types on which it depends.
#[pallet::config]
pub trait Config: frame_system::Config {
    /// Because this pallet emits events, it depends on the runtime's definition of an event.
    type Event: From<Event<Self>> + IsType<<Self as frame_system::Config>::Event>;
}

2. 实现事件
   要确保在如下行为时触发事件： 当新证明添加到区块链时以及当证明被撤销时
   打开pallets/template/src/lib.rs，在#[pallet::event]后编辑代码：

// Pallets use events to inform users when important changes are made.
// Event documentation should end with an array that provides descriptive names for parameters.
#[pallet::event]
#[pallet::generate_deposit(pub(super) fn deposit_event)]
pub enum Event<T: Config> {
    /// Event emitted when a claim has been created.
    ClaimCreated { who: T::AccountId, claim: T::Hash },
    /// Event emitted when a claim is revoked by the owner.
    ClaimRevoked { who: T::AccountId, claim: T::Hash },
}

错误处理，打开pallets/template/src/lib.rs，在#[pallet::error]后编辑代码：

#[pallet::error]
pub enum Error<T> {
    /// The claim already exists.
    AlreadyClaimed,
    /// The claim does not exist, so it cannot be revoked.
    NoSuchClaim,
    /// The claim is owned by another account, so caller can't revoke it.
    NotClaimOwner,
}

4. 实现存储映射
   打开pallets/template/src/lib.rs,在#[pallet::error]后编辑代码：

#[pallet::storage]
pub(super) type Claims<T: Config> = StorageMap<_, Blake2_128Concat, T::Hash, (T::AccountId, T::BlockNumber)>;

6. 实现公开的两个可调用函数(即前面提到的create_claim()和revoke_claim())
   具体功能直接看代码吧，很简单：
   打开pallets/template/src/lib.rs,在#[pallet::call]后编辑代码：

// Dispatchable functions allow users to interact with the pallet and invoke state changes.
// These functions materialize as "extrinsics", which are often compared to transactions.
// Dispatchable functions must be annotated with a weight and must return a DispatchResult.
#[pallet::call]
impl<T: Config> Pallet<T> {
    #[pallet::weight(0)]
    pub fn create_claim(origin: OriginFor<T>, claim: T::Hash) -> DispatchResult {
        // Check that the extrinsic was signed and get the signer.
        // This function will return an error if the extrinsic is not signed.
        let sender = ensure_signed(origin)?;

        // Verify that the specified claim has not already been stored.
        ensure!(!Claims::<T>::contains_key(&claim), Error::<T>::AlreadyClaimed);

        // Get the block number from the FRAME System pallet.
        let current_block = <frame_system::Pallet<T>>::block_number();

        // Store the claim with the sender and block number.
        Claims::<T>::insert(&claim, (&sender, current_block));

        // Emit an event that the claim was created.
        Self::deposit_event(Event::ClaimCreated { who: sender, claim });

        Ok(())
    }

    #[pallet::weight(0)]
    pub fn revoke_claim(origin: OriginFor<T>, claim: T::Hash) -> DispatchResult {
        // Check that the extrinsic was signed and get the signer.
        // This function will return an error if the extrinsic is not signed.
        let sender = ensure_signed(origin)?;

        // Get owner of the claim, if none return an error.
        let (owner, _) = Claims::<T>::get(&claim).ok_or(Error::<T>::NoSuchClaim)?;

        // Verify that sender of the current call is the claim owner.
        ensure!(sender == owner, Error::<T>::NotClaimOwner);

        // Remove claim from storage.
        Claims::<T>::remove(&claim);

        // Emit an event that the claim was erased.
        Self::deposit_event(Event::ClaimRevoked { who: sender, claim });
        Ok(())
    }
}

7. 项目根目录检测是否能够编译成功：

cargo check -p node-template-runtime

5. 启动节点并连接页面进行交互

5.1 编译并启动节点

回到项目根目录，编译节点：

cargo build --release

启动节点

./target/release/node-template --dev --base-path ./tmp/

5.2 前端页面

打开web polkadot-app ，将网络连接到刚刚启动的节点，然后前往：开发者-交易

文件hash上链
按如下图选择，然后添加要hash的文件，最后"提交交易"
同样类似方式，可以撤销文件的hash，这里就不演示了

6. 总结

本文编辑完毕

参考

[1] Substrate官方文档å

Donate