Tasks: general system for recognizing and executing service work (#1343)
`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>
parent
34c991e2
Showing
- Cargo.lock 19 additions, 0 deletionsCargo.lock
- Cargo.toml 1 addition, 0 deletionsCargo.toml
- cumulus/pallets/collator-selection/src/mock.rs 2 additions, 1 deletioncumulus/pallets/collator-selection/src/mock.rs
- cumulus/parachain-template/pallets/template/src/mock.rs 2 additions, 1 deletioncumulus/parachain-template/pallets/template/src/mock.rs
- prdoc/pr_1343.prdoc 29 additions, 0 deletionsprdoc/pr_1343.prdoc
- substrate/bin/node/runtime/Cargo.toml 4 additions, 0 deletionssubstrate/bin/node/runtime/Cargo.toml
- substrate/bin/node/runtime/src/lib.rs 7 additions, 0 deletionssubstrate/bin/node/runtime/src/lib.rs
- substrate/frame/examples/Cargo.toml 3 additions, 0 deletionssubstrate/frame/examples/Cargo.toml
- substrate/frame/examples/default-config/src/lib.rs 5 additions, 0 deletionssubstrate/frame/examples/default-config/src/lib.rs
- substrate/frame/examples/kitchensink/Cargo.toml 1 addition, 0 deletionssubstrate/frame/examples/kitchensink/Cargo.toml
- substrate/frame/examples/src/lib.rs 2 additions, 0 deletionssubstrate/frame/examples/src/lib.rs
- substrate/frame/examples/tasks/Cargo.toml 52 additions, 0 deletionssubstrate/frame/examples/tasks/Cargo.toml
- substrate/frame/examples/tasks/src/benchmarking.rs 42 additions, 0 deletionssubstrate/frame/examples/tasks/src/benchmarking.rs
- substrate/frame/examples/tasks/src/lib.rs 78 additions, 0 deletionssubstrate/frame/examples/tasks/src/lib.rs
- substrate/frame/examples/tasks/src/mock.rs 43 additions, 0 deletionssubstrate/frame/examples/tasks/src/mock.rs
- substrate/frame/examples/tasks/src/tests.rs 127 additions, 0 deletionssubstrate/frame/examples/tasks/src/tests.rs
- substrate/frame/examples/tasks/src/weights.rs 84 additions, 0 deletionssubstrate/frame/examples/tasks/src/weights.rs
- substrate/frame/scheduler/src/mock.rs 3 additions, 1 deletionsubstrate/frame/scheduler/src/mock.rs
- substrate/frame/support/procedural/Cargo.toml 3 additions, 0 deletionssubstrate/frame/support/procedural/Cargo.toml
- substrate/frame/support/procedural/src/construct_runtime/expand/mod.rs 2 additions, 0 deletions...me/support/procedural/src/construct_runtime/expand/mod.rs
Please register or sign in to comment