b6d35f6faf
Updated 4763 files with dual copyright: - Parity Technologies (UK) Ltd. - Dijital Kurdistan Tech Institute
128 lines
4.5 KiB
Rust
128 lines
4.5 KiB
Rust
// This file is part of Bizinikiwi.
|
|
|
|
// Copyright (C) Parity Technologies (UK) Ltd. and Dijital Kurdistan Tech Institute
|
|
// SPDX-License-Identifier: MIT-0
|
|
|
|
// Permission is hereby granted, free of charge, to any person obtaining a copy of
|
|
// this software and associated documentation files (the "Software"), to deal in
|
|
// the Software without restriction, including without limitation the rights to
|
|
// use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies
|
|
// of the Software, and to permit persons to whom the Software is furnished to do
|
|
// so, subject to the following conditions:
|
|
|
|
// The above copyright notice and this permission notice shall be included in all
|
|
// copies or substantial portions of the Software.
|
|
|
|
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
// SOFTWARE.
|
|
|
|
//! # Split Example Pezpallet
|
|
//!
|
|
//! **This pezpallet serves as an example and is not meant to be used in production.**
|
|
//!
|
|
//! A FRAME pezpallet demonstrating the ability to split sections across multiple files.
|
|
//!
|
|
//! Note that this is purely experimental at this point.
|
|
|
|
#![cfg_attr(not(feature = "std"), no_std)]
|
|
|
|
// Re-export pezpallet items so that they can be accessed from the crate namespace.
|
|
pub use pezpallet::*;
|
|
|
|
#[cfg(test)]
|
|
mod mock;
|
|
|
|
#[cfg(test)]
|
|
mod tests;
|
|
|
|
#[cfg(feature = "runtime-benchmarks")]
|
|
mod benchmarking;
|
|
mod events;
|
|
|
|
pub mod weights;
|
|
pub use weights::*;
|
|
|
|
use pezframe_support::pezpallet_macros::*;
|
|
|
|
/// Imports a [`pezpallet_section`] defined at [`events::events`].
|
|
/// This brings the events defined in that section into the pezpallet's namespace.
|
|
#[import_section(events::events)]
|
|
#[pezframe_support::pezpallet]
|
|
pub mod pezpallet {
|
|
use super::*;
|
|
use pezframe_support::pezpallet_prelude::*;
|
|
use pezframe_system::pezpallet_prelude::*;
|
|
|
|
#[pezpallet::pezpallet]
|
|
pub struct Pezpallet<T>(_);
|
|
|
|
/// Configure the pezpallet by specifying the parameters and types on which it depends.
|
|
#[pezpallet::config]
|
|
pub trait Config: pezframe_system::Config {
|
|
/// Type representing the weight of this pezpallet
|
|
type WeightInfo: WeightInfo;
|
|
}
|
|
|
|
// The pezpallet's runtime storage items.
|
|
#[pezpallet::storage]
|
|
pub type Something<T> = StorageValue<_, u32>;
|
|
|
|
// Errors inform users that something went wrong.
|
|
#[pezpallet::error]
|
|
pub enum Error<T> {
|
|
/// Error names should be descriptive.
|
|
NoneValue,
|
|
/// Errors should have helpful documentation associated with them.
|
|
StorageOverflow,
|
|
}
|
|
|
|
// Dispatchable functions allows users to interact with the pezpallet 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.
|
|
#[pezpallet::call]
|
|
impl<T: Config> Pezpallet<T> {
|
|
/// An example dispatchable that takes a singles value as a parameter, writes the value to
|
|
/// storage and emits an event. This function must be dispatched by a signed extrinsic.
|
|
#[pezpallet::call_index(0)]
|
|
#[pezpallet::weight(T::WeightInfo::do_something())]
|
|
pub fn do_something(origin: OriginFor<T>, something: u32) -> DispatchResult {
|
|
// Check that the extrinsic was signed and get the signer.
|
|
// This function will return an error if the extrinsic is not signed.
|
|
let who = ensure_signed(origin)?;
|
|
|
|
// Update storage.
|
|
<Something<T>>::put(something);
|
|
|
|
// Emit an event.
|
|
Self::deposit_event(Event::SomethingStored { something, who });
|
|
// Return a successful DispatchResultWithPostInfo
|
|
Ok(())
|
|
}
|
|
|
|
/// An example dispatchable that may throw a custom error.
|
|
#[pezpallet::call_index(1)]
|
|
#[pezpallet::weight(T::WeightInfo::cause_error())]
|
|
pub fn cause_error(origin: OriginFor<T>) -> DispatchResult {
|
|
let _who = ensure_signed(origin)?;
|
|
|
|
// Read a value from storage.
|
|
match Something::<T>::get() {
|
|
// Return an error if the value has not been set.
|
|
None => return Err(Error::<T>::NoneValue.into()),
|
|
Some(old) => {
|
|
// Increment the value read from storage; will error in the event of overflow.
|
|
let new = old.checked_add(1).ok_or(Error::<T>::StorageOverflow)?;
|
|
// Update the value in storage with the incremented result.
|
|
<Something<T>>::put(new);
|
|
Ok(())
|
|
},
|
|
}
|
|
}
|
|
}
|
|
}
|