mirror of
https://github.com/pezkuwichain/pezkuwi-subxt.git
synced 2026-04-27 04:37:57 +00:00
Sam Johnson
ac3f14d23b
`polkadot-sdk` version of original tasks PR located here: https://github.com/paritytech/substrate/pull/14329 Fixes #206 ## Status - [x] Generic `Task` trait - [x] `RuntimeTask` aggregated enum, compatible with `construct_runtime!` - [x] Casting between `Task` and `RuntimeTask` without needing `dyn` or `Box` - [x] Tasks Example pallet - [x] Runtime tests for Tasks example pallet - [x] Parsing for task-related macros - [x] Retrofit parsing to make macros optional - [x] Expansion for task-related macros - [x] Adds support for args in tasks - [x] Retrofit tasks example pallet to use macros instead of manual syntax - [x] Weights - [x] Cleanup - [x] UI tests - [x] Docs ## Target Syntax Adapted from https://github.com/paritytech/polkadot-sdk/issues/206#issue-1865172283 ```rust // NOTE: this enum is optional and is auto-generated by the other macros if not present #[pallet::task] pub enum Task<T: Config> { AddNumberIntoTotal { i: u32, } } /// Some running total. #[pallet::storage] pub(super) type Total<T: Config<I>, I: 'static = ()> = StorageValue<_, (u32, u32), ValueQuery>; /// Numbers to be added into the total. #[pallet::storage] pub(super) type Numbers<T: Config<I>, I: 'static = ()> = StorageMap<_, Twox64Concat, u32, u32, OptionQuery>; #[pallet::tasks_experimental] impl<T: Config<I>, I: 'static> Pallet<T, I> { /// Add a pair of numbers into the totals and remove them. #[pallet::task_list(Numbers::<T, I>::iter_keys())] #[pallet::task_condition(|i| Numbers::<T, I>::contains_key(i))] #[pallet::task_index(0)] pub fn add_number_into_total(i: u32) -> DispatchResult { let v = Numbers::<T, I>::take(i).ok_or(Error::<T, I>::NotFound)?; Total::<T, I>::mutate(|(total_keys, total_values)| { *total_keys += i; *total_values += v; }); Ok(()) } } ``` --------- Co-authored-by: Nikhil Gupta <17176722+gupnik@users.noreply.github.com> Co-authored-by: kianenigma <kian@parity.io> Co-authored-by: Nikhil Gupta <> Co-authored-by: Gavin Wood <gavin@parity.io> Co-authored-by: Oliver Tale-Yazdi <oliver.tale-yazdi@parity.io> Co-authored-by: gupnik <nikhilgupta.iitk@gmail.com>
49 lines
2.0 KiB
Rust
49 lines
2.0 KiB
Rust
// This file is part of Substrate.
|
|
|
|
// Copyright (C) Parity Technologies (UK) Ltd.
|
|
// SPDX-License-Identifier: Apache-2.0
|
|
|
|
// Licensed under the Apache License, Version 2.0 (the "License");
|
|
// you may not use this file except in compliance with the License.
|
|
// You may obtain a copy of the License at
|
|
//
|
|
// http://www.apache.org/licenses/LICENSE-2.0
|
|
//
|
|
// Unless required by applicable law or agreed to in writing, software
|
|
// distributed under the License is distributed on an "AS IS" BASIS,
|
|
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
// See the License for the specific language governing permissions and
|
|
// limitations under the License.
|
|
|
|
//! # FRAME Pallet Examples
|
|
//!
|
|
//! This crate contains a collection of simple examples of FRAME pallets, demonstrating useful
|
|
//! features in action. It is not intended to be used in production.
|
|
//!
|
|
//! ## Pallets
|
|
//!
|
|
//! - [`pallet_example_basic`]: This pallet demonstrates concepts, APIs and structures common to
|
|
//! most FRAME runtimes.
|
|
//!
|
|
//! - [`pallet_example_offchain_worker`]: This pallet demonstrates concepts, APIs and structures
|
|
//! common to most offchain workers.
|
|
//!
|
|
//! - [`pallet_default_config_example`]: This pallet demonstrates different ways to implement the
|
|
//! `Config` trait of pallets.
|
|
//!
|
|
//! - [`pallet_dev_mode`]: This pallet demonstrates the ease of requirements for a pallet in "dev
|
|
//! mode".
|
|
//!
|
|
//! - [`pallet_example_kitchensink`]: This pallet demonstrates a catalog of all FRAME macros in use
|
|
//! and their various syntax options.
|
|
//!
|
|
//! - [`pallet_example_split`]: A simple example of a FRAME pallet demonstrating the ability to
|
|
//! split sections across multiple files.
|
|
//!
|
|
//! - [`pallet_example_frame_crate`]: Example pallet showcasing how one can be
|
|
//! built using only the `frame` umbrella crate.
|
|
//!
|
|
//! - [`pallet_example_tasks`]: This pallet demonstrates the use of `Tasks` to execute service work.
|
|
//!
|
|
//! **Tip**: Use `cargo doc --package <pallet-name> --open` to view each pallet's documentation.
|