二、入门Substrate之Substrate-node-template模板中的pallet-template进行源码分析

其实作为Substrate的开发者们，已经为使用框架者提供了类似八股文一样的宏来简化开发，目前你只需要记住这个配置是干什么用的就够了，如果想要自定义pallet，建议直接把模板中的lib.rs直接复制过去，进行修改即可，后续想要深入了解，可以去看substrate的源码。本文将会分析了pallet-template的文件结构，常用配置的作用，并仿照模板自定义一个交易函数、存储类型、事件、错误。

1.文件结构

首先我们打开Substrate-node-template文件夹看看目录结构

我们找到根目录下的pallets->template

• lib.rs：自定义pallet的主文件，大部分逻辑都在这里
• mock.rs：为测试文件提供一些配置
• test.rs：测试文件
• benchmarking.rs：此文件用于生成发交易使用的weight，在后面的文章中会专门介绍，暂不讨论

2.源码分析

下面我们将lib.rs文件内容复制过来,一行一行进行解释分析

//这个 crate 不应使用 rust 的标准库
#![cfg_attr(not(feature = "std"), no_std)]

pub use pallet::*;

//引入mock
#[cfg(test)]
mod mock;

//引入tests
#[cfg(test)]
mod tests;

//引入benchmarking
#[cfg(feature = "runtime-benchmarks")]
mod benchmarking;

//以下是构建自定义pallet的主体部分
#[frame_support::pallet]
pub mod pallet {
  //使用依赖
  //frame_support主要提供DispatchResult，其实就是一个Rusult,正确执行返回一个Ok(())即可
  //frame_support还定义了一些常用的存储结构，trait
	use frame_support::{dispatch::DispatchResult, pallet_prelude::*};
  //引入frame_system中的一些常用的宏，例如* ensure_signed、ensure_none、ensure_root
	use frame_system::pallet_prelude::*;

	// 通过指定托盘所依赖的参数和类型来配置托
	#[pallet::config]
	pub trait Config: frame_system::Config {
		//如果你想在托盘中使用事件，那么就添加该行
		type Event: From<Event<Self>> + IsType<<Self as frame_system::Config>::Event>;
	}

  //必须存在的配置，copy过来即可
	#[pallet::pallet]
	#[pallet::generate_store(pub(super) trait Store)]
	pub struct Pallet<T>(_);

	// 定义一个叫Something存储类型为StorageValue，里面存放u32类型，提供名字叫something的getter函数，用于获取Something中的值
	#[pallet::storage]
	#[pallet::getter(fn something)]
	pub type Something<T> = StorageValue<_, u32>;

  //定义事件 发出事件方法为deposit_event
	#[pallet::event]
	#[pallet::metadata(T::AccountId = "AccountId")]
	#[pallet::generate_deposit(pub(super) fn deposit_event)]
	pub enum Event<T: Config> {
    //事件名
		SomethingStored(u32, T::AccountId),
	}

	// 定义错误，直接起名就可以
	#[pallet::error]
	pub enum Error<T> {
		NoneValue,
		StorageOverflow,
	}

	// 定义交易逻辑
	#[pallet::call]
	impl<T: Config> Pallet<T> {
    //使用交易所需的weight，可以使用benchmarking生成，所以没生成之前weight随便填，例如改成#[pallet::weight(10_000)]
		#[pallet::weight(10_000 + T::DbWeight::get().writes(1))]
    //origin: OriginFor<T>是交易的调用者
		pub fn do_something(origin: OriginFor<T>, something: u32) -> DispatchResult {
      //确保他是一个正常的用户，并返回交易调用者
			let who = ensure_signed(origin)?;

			//StorageValue类型的方法，存入一个数据
			<Something<T>>::put(something);

			//发出事件
			Self::deposit_event(Event::SomethingStored(something, who));
			//成功调用
			Ok(())
		}

		//使用交易所需的weight，可以使用benchmarking生成，所以没生成之前weight随便填，例如改成#[pallet::weight(10_000)]
    //这里我把源码改成了#[pallet::weight(10_000)]
		#[pallet::weight(10_000)]
		pub fn cause_error(origin: OriginFor<T>) -> DispatchResult {
      //确保他是一个正常的用户，并返回交易调用者
			let _who = ensure_signed(origin)?;

			//StorageValue类型的方法，读取数据
			match <Something<T>>::get() {
				// 拿到数据为空那么就抛出一个错误
				None => Err(Error::<T>::NoneValue)?,
        //如果拿到数据
				Some(old) => {
					// 那么就+1，如果超出u32的最大值，那么就抛出溢出错误
					let new = old.checked_add(1).ok_or(Error::<T>::StorageOverflow)?;
					//将+1后的新值，重新存入Something中
					<Something<T>>::put(new);
          //成功调用
					Ok(())
				},
			}
		}
	}
}

3.实践环节

下面我们仿照源码自定义

• hello_substrate函数，
• GreaterThan100错误
• HelloStored(u32, T::AccountId)事件
• Hello的StorageValue类型

主要功能：存入一个小于100的值，超出则抛出GreaterThan100错误，存入Hello成功则发出HelloStored(u8, T::AccountId)事件

1).编写代码

#![cfg_attr(not(feature = "std"), no_std)]

pub use pallet::*;

#[cfg(test)]
mod mock;

#[cfg(test)]
mod tests;

#[cfg(feature = "runtime-benchmarks")]
mod benchmarking;

#[frame_support::pallet]
pub mod pallet {
	use frame_support::{dispatch::DispatchResult, pallet_prelude::*};
	use frame_system::pallet_prelude::*;

	#[pallet::config]
	pub trait Config: frame_system::Config {
		type Event: From<Event<Self>> + IsType<<Self as frame_system::Config>::Event>;
	}

	#[pallet::pallet]
	#[pallet::generate_store(pub(super) trait Store)]
	pub struct Pallet<T>(_);

	#[pallet::storage]
	#[pallet::getter(fn something)]
	pub type Something<T> = StorageValue<_, u32>;

  //定义一个类型为StorageValue的hello
	#[pallet::storage]
	#[pallet::getter(fn hello)]
	pub type Hello<T> = StorageValue<_, u8>;

	#[pallet::event]
	#[pallet::metadata(T::AccountId = "AccountId")]
	#[pallet::generate_deposit(pub(super) fn deposit_event)]
	pub enum Event<T: Config> {
		SomethingStored(u32, T::AccountId),
    //HelloStored事件
		HelloStored(u8, T::AccountId),
	}
	#[pallet::error]
	pub enum Error<T> {
		NoneValue,
		StorageOverflow,
    //大于100错误
		GreaterThan100,
	}

	#[pallet::call]
	impl<T: Config> Pallet<T> {
		#[pallet::weight(10_000 + T::DbWeight::get().writes(1))]
		pub fn do_something(origin: OriginFor<T>, something: u32) -> DispatchResult {
			let who = ensure_signed(origin)?;
			<Something<T>>::put(something);
			Self::deposit_event(Event::SomethingStored(something, who));
			Ok(())
		}
		#[pallet::weight(10_000 + T::DbWeight::get().reads_writes(1,1))]
		pub fn cause_error(origin: OriginFor<T>) -> DispatchResult {
			let _who = ensure_signed(origin)?;

			match <Something<T>>::get() {
				None => Err(Error::<T>::NoneValue)?,
				Some(old) => {
					let new = old.checked_add(1).ok_or(Error::<T>::StorageOverflow)?;
					<Something<T>>::put(new);
					Ok(())
				},
			}
		}
    //定义hello_substrats
		#[pallet::weight(10_000)]
		pub fn hello_substrate(origin: OriginFor<T>,num: u8) -> DispatchResult {
			let _who = ensure_signed(origin)?;
			//确保值小于100
			ensure!(num<100,Error::<T>::GreaterThan100);
      //存入数据
			<Hello<T>>::put(num);
      //发出事件
			Self::deposit_event(Event::HelloStored(num, _who));
			Ok(())
		}
	}
}

2).重新编译

cargo build --release   

3).运行节点

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

4).使用Polkdot浏览器进行交互

此时我们查看交易就发现多了一个helloSubstrate

因为我们设置的必须小于100，这时我们存入一个100，就会抛出错误

我们存入一个99，交易成功，并发出一个HelloStored事件

总结：

本文分析了pallet-template的文件结构，常用配置的作用，并仿照模板自定义一个交易函数、存储类型、事件、错误。

下一篇文章将会介绍Substrate中的常见数据类型以及如何正确使用