이벤트와 에러

런타임에서 이벤트와 오류를 발생시키는 방법을 설명합니다.

팔렛은 런타임에서 변경 사항이나 조건에 대한 알림을 사용자, 체인 익스플로러 또는 dApp과 같은 외부 개체에게 보내고자 할 때 이벤트를 발생시킬 수 있습니다.

커스텀 팔렛에서는 다음을 정의할 수 있습니다:

  • 발생시키고자 하는 이벤트의 유형

  • 이벤트에 포함되는 정보

  • 이벤트가 발생하는 시점

이벤트 선언하기

이벤트는 #[pallet::event] 매크로를 사용하여 생성됩니다. 예를 들어:

#[pallet::event]
#[pallet::generate_deposit(pub(super) fn deposit_event)]
pub enum Event<T: Config> {
	/// 값을 설정합니다.
	ValueSet { value: u32, who: T::AccountId },
}

그런 다음, 런타임에서 이벤트를 집계하기 위해 RuntimeEvent 타입이 필요합니다.

#[pallet::config]
	pub trait Config: frame_system::Config {
		/// 전체적인 이벤트 유형입니다.
		type RuntimeEvent: From<Event<Self>> + IsType<<Self as frame_system::Config>::RuntimeEvent>;
	}

런타임에 이벤트 노출하기

팔렛에서 정의한 모든 이벤트는 /runtime/src/lib.rs 파일에서 런타임에 노출되어야 합니다.

이벤트를 런타임에 노출하려면 다음을 수행합니다:

  1. 텍스트 편집기에서 /runtime/src/lib.rs 파일을 엽니다.

  2. 팔렛의 구성 트레이트에서 RuntimeEvent 타입을 구현합니다:

    impl template::Config for Runtime {
    	 type RuntimeEvent = RuntimeEvent;
    }
  3. construct_runtime! 매크로에 RuntimeEvent 타입을 추가합니다:

    construct_runtime!(
    	 pub enum Runtime where
     	 Block = Block,
    	   NodeBlock = opaque::Block,
    	   UncheckedExtrinsic = UncheckedExtrinsic
    	 {
        // --snip--
    	   TemplateModule: template::{Pallet, Call, Storage, Event<T>},
    	   //--add-this------------------------------------->
    		 }
    );

    이 예제에서 이벤트는 제네릭 타입이며 <T> 매개변수가 필요합니다. 이벤트가 제네릭을 사용하지 않는 경우 <T> 매개변수는 필요하지 않습니다.

이벤트 발생시키기

Substrate는 매크로를 사용하여 이벤트를 발생시키는 기본 구현을 제공합니다. 이벤트를 발생시키는 구조는 다음과 같습니다:

// 1. 이벤트 열거형을 선언할 때 `generate_deposit` 속성을 사용합니다.
#[pallet::event]
	#[pallet::generate_deposit(pub(super) fn deposit_event)] // <------ 여기 ----
	#[pallet::metadata(...)]
	pub enum Event<T: Config> {
		// --snip--
	}

// 2. 디스패처 함수 내에서 `deposit_event`를 사용합니다.
#[pallet::call]
	impl<T: Config> Pallet<T> {
		#[pallet::weight(1_000)]
		pub(super) fn set_value(
			origin: OriginFor<T>,
			value: u64,
		) -> DispatchResultWithPostInfo {
			let sender = ensure_signed(origin)?;
			// --snip--
			Self::deposit_event(RawEvent::ValueSet(value, sender));
		}
	}

이 함수는 해당 블록의 시스템 팔렛(System Pallet)의 스토리지에 이벤트를 저장합니다. 새로운 블록이 시작될 때, 시스템 팔렛은 이전 블록에서 저장된 모든 이벤트를 자동으로 제거합니다.

지원되는 타입

이벤트 수신하기

오류

각 FRAME 팔렛은 #[pallet::error] 매크로를 사용하여 커스텀 DispatchError를 정의할 수 있습니다. 예를 들어:

#[pallet::error]
pub enum Error<T> {
		/// 에러 이름은 설명적이어야 합니다.
		InvalidParameter,
		/// 에러에는 유용한 문서가 있어야 합니다.
		OutOfSpace,
	}
frame_support::ensure!(param < T::MaxVal::get(), Error::<T>::InvalidParameter);

다음 단계로 넘어가기

Last updated