Skip to content
Snippets Groups Projects
Commit 714a0872 authored by Shaun Wang's avatar Shaun Wang Committed by GitHub
Browse files

Migrate pallet-scored-pool to pallet attribute macro (#8825) 

* Migrate pallet-scored-pool to pallet attribute macro.

* Remove dummy event.

* Apply review suggestions.
parent 996107ee
Branches gh-readonly-queue/master/pr-4560-ef144b1a88c6478e5d6dac945ffe12053f05d96a
No related merge requests found
Hide whitespace changes
Inline Side-by-side
substrate/frame/scored-pool/src/lib.rs
+ 168
− 135
View file @ 714a0872
......@@ -15,9 +15,9 @@
// See the License for the specific language governing permissions and
// limitations under the License.
//! # Scored Pool Module
//! # Scored Pool Pallet
//!
//! The module maintains a scored membership pool. Each entity in the
//! The pallet maintains a scored membership pool. Each entity in the
//! pool can be attributed a `Score`. From this pool a set `Members`
//! is constructed. This set contains the `MemberCount` highest
//! scoring entities. Unscored entities are never part of `Members`.
......@@ -39,7 +39,7 @@
//!
//! - [`Config`]
//! - [`Call`]
//! - [`Module`]
//! - [`Pallet`]
//!
//! ## Interface
//!
......@@ -66,7 +66,7 @@
//! pub fn candidate(origin) -> dispatch::DispatchResult {
//! let who = ensure_signed(origin)?;
//!
//! let _ = <scored_pool::Module<T>>::submit_candidacy(
//! let _ = <scored_pool::Pallet<T>>::submit_candidacy(
//! T::Origin::from(Some(who.clone()).into())
//! );
//! Ok(())
......@@ -79,7 +79,7 @@
//!
//! ## Dependencies
//!
//! This module depends on the [System module](../frame_system/index.html).
//! This pallet depends on the [System pallet](../frame_system/index.html).
// Ensure we're `no_std` when compiling for Wasm.
#![cfg_attr(not(feature = "std"), no_std)]
......@@ -96,12 +96,11 @@ use sp_std::{
prelude::*,
};
use frame_support::{
decl_module, decl_storage, decl_event, ensure, decl_error,
traits::{EnsureOrigin, ChangeMembers, InitializeMembers, Currency, Get, ReservableCurrency},
weights::Weight,
ensure,
traits::{ChangeMembers, InitializeMembers, Currency, Get, ReservableCurrency},
};
use frame_system::{ensure_root, ensure_signed};
use sp_runtime::traits::{AtLeast32Bit, MaybeSerializeDeserialize, Zero, StaticLookup};
use sp_runtime::traits::{AtLeast32Bit, Zero, StaticLookup};
pub use pallet::*;
type BalanceOf<T, I> = <<T as Config<I>>::Currency as Currency<<T as frame_system::Config>::AccountId>>::Balance;
type PoolT<T, I> = Vec<(<T as frame_system::Config>::AccountId, Option<<T as Config<I>>::Score>)>;
......@@ -116,96 +115,60 @@ enum ChangeReceiver {
MembershipChanged,
}
pub trait Config<I=DefaultInstance>: frame_system::Config {
/// The currency used for deposits.
type Currency: Currency<Self::AccountId> + ReservableCurrency<Self::AccountId>;
/// The score attributed to a member or candidate.
type Score:
AtLeast32Bit + Clone + Copy + Default + FullCodec + MaybeSerializeDeserialize + Debug;
/// The overarching event type.
type Event: From<Event<Self, I>> + Into<<Self as frame_system::Config>::Event>;
// The deposit which is reserved from candidates if they want to
// start a candidacy. The deposit gets returned when the candidacy is
// withdrawn or when the candidate is kicked.
type CandidateDeposit: Get<BalanceOf<Self, I>>;
/// Every `Period` blocks the `Members` are filled with the highest scoring
/// members in the `Pool`.
type Period: Get<Self::BlockNumber>;
/// The receiver of the signal for when the membership has been initialized.
/// This happens pre-genesis and will usually be the same as `MembershipChanged`.
/// If you need to do something different on initialization, then you can change
/// this accordingly.
type MembershipInitialized: InitializeMembers<Self::AccountId>;
/// The receiver of the signal for when the members have changed.
type MembershipChanged: ChangeMembers<Self::AccountId>;
/// Allows a configurable origin type to set a score to a candidate in the pool.
type ScoreOrigin: EnsureOrigin<Self::Origin>;
/// Required origin for removing a member (though can always be Root).
/// Configurable origin which enables removing an entity. If the entity
/// is part of the `Members` it is immediately replaced by the next
/// highest scoring candidate, if available.
type KickOrigin: EnsureOrigin<Self::Origin>;
}
decl_storage! {
trait Store for Module<T: Config<I>, I: Instance=DefaultInstance> as ScoredPool {
/// The current pool of candidates, stored as an ordered Vec
/// (ordered descending by score, `None` last, highest first).
Pool get(fn pool) config(): PoolT<T, I>;
/// A Map of the candidates. The information in this Map is redundant
/// to the information in the `Pool`. But the Map enables us to easily
/// check if a candidate is already in the pool, without having to
/// iterate over the entire pool (the `Pool` is not sorted by
/// `T::AccountId`, but by `T::Score` instead).
CandidateExists get(fn candidate_exists): map hasher(twox_64_concat) T::AccountId => bool;
/// The current membership, stored as an ordered Vec.
Members get(fn members): Vec<T::AccountId>;
/// Size of the `Members` set.
MemberCount get(fn member_count) config(): u32;
}
add_extra_genesis {
config(members): Vec<T::AccountId>;
config(phantom): sp_std::marker::PhantomData<I>;
build(|config| {
let mut pool = config.pool.clone();
// reserve balance for each candidate in the pool.
// panicking here is ok, since this just happens one time, pre-genesis.
pool
.iter()
.for_each(|(who, _)| {
T::Currency::reserve(&who, T::CandidateDeposit::get())
.expect("balance too low to create candidacy");
<CandidateExists<T, I>>::insert(who, true);
});
// Sorts the `Pool` by score in a descending order. Entities which
// have a score of `None` are sorted to the beginning of the vec.
pool.sort_by_key(|(_, maybe_score)|
Reverse(maybe_score.unwrap_or_default())
);
<Pool<T, I>>::put(&pool);
<Module<T, I>>::refresh_members(pool, ChangeReceiver::MembershipInitialized);
})
#[frame_support::pallet]
pub mod pallet {
use frame_support::{pallet_prelude::*, traits::EnsureOrigin, weights::Weight};
use frame_system::{ensure_root, ensure_signed, pallet_prelude::*};
use sp_runtime::traits::MaybeSerializeDeserialize;
use super::*;
#[pallet::pallet]
#[pallet::generate_store(pub(super) trait Store)]
pub struct Pallet<T, I = ()>(_);
#[pallet::config]
pub trait Config<I: 'static = ()>: frame_system::Config {
/// The currency used for deposits.
type Currency: Currency<Self::AccountId> + ReservableCurrency<Self::AccountId>;
/// The score attributed to a member or candidate.
type Score:
AtLeast32Bit + Clone + Copy + Default + FullCodec + MaybeSerializeDeserialize + Debug;
/// The overarching event type.
type Event: From<Event<Self, I>> + IsType<<Self as frame_system::Config>::Event>;
// The deposit which is reserved from candidates if they want to
// start a candidacy. The deposit gets returned when the candidacy is
// withdrawn or when the candidate is kicked.
type CandidateDeposit: Get<BalanceOf<Self, I>>;
/// Every `Period` blocks the `Members` are filled with the highest scoring
/// members in the `Pool`.
type Period: Get<Self::BlockNumber>;
/// The receiver of the signal for when the membership has been initialized.
/// This happens pre-genesis and will usually be the same as `MembershipChanged`.
/// If you need to do something different on initialization, then you can change
/// this accordingly.
type MembershipInitialized: InitializeMembers<Self::AccountId>;
/// The receiver of the signal for when the members have changed.
type MembershipChanged: ChangeMembers<Self::AccountId>;
/// Allows a configurable origin type to set a score to a candidate in the pool.
type ScoreOrigin: EnsureOrigin<Self::Origin>;
/// Required origin for removing a member (though can always be Root).
/// Configurable origin which enables removing an entity. If the entity
/// is part of the `Members` it is immediately replaced by the next
/// highest scoring candidate, if available.
type KickOrigin: EnsureOrigin<Self::Origin>;
}
}
decl_event!(
pub enum Event<T, I=DefaultInstance> where
<T as frame_system::Config>::AccountId,
{
#[pallet::event]
#[pallet::generate_deposit(pub(super) fn deposit_event)]
pub enum Event<T: Config<I>, I: 'static = ()> {
/// The given member was removed. See the transaction for who.
MemberRemoved,
/// An entity has issued a candidacy. See the transaction for who.
......@@ -218,14 +181,11 @@ decl_event!(
/// A score was attributed to the candidate.
/// See the transaction for who.
CandidateScored,
/// Phantom member, never used.
Dummy(sp_std::marker::PhantomData<(AccountId, I)>),
}
);
decl_error! {
/// Error for the scored-pool module.
pub enum Error for Module<T: Config<I>, I: Instance> {
/// Error for the scored-pool pallet.
#[pallet::error]
pub enum Error<T, I = ()> {
/// Already a member.
AlreadyInPool,
/// Index out of bounds.
......@@ -233,27 +193,95 @@ decl_error! {
/// Index does not match requested account.
WrongAccountIndex,
}
}
decl_module! {
pub struct Module<T: Config<I>, I: Instance=DefaultInstance>
for enum Call
where origin: T::Origin
{
type Error = Error<T, I>;
/// The current pool of candidates, stored as an ordered Vec
/// (ordered descending by score, `None` last, highest first).
#[pallet::storage]
#[pallet::getter(fn pool)]
pub(crate) type Pool<T: Config<I>, I: 'static = ()> = StorageValue<_, PoolT<T, I>, ValueQuery>;
/// A Map of the candidates. The information in this Map is redundant
/// to the information in the `Pool`. But the Map enables us to easily
/// check if a candidate is already in the pool, without having to
/// iterate over the entire pool (the `Pool` is not sorted by
/// `T::AccountId`, but by `T::Score` instead).
#[pallet::storage]
#[pallet::getter(fn candidate_exists)]
pub(crate) type CandidateExists<T: Config<I>, I: 'static = ()> = StorageMap<
_,
Twox64Concat, T::AccountId,
bool,
ValueQuery,
>;
/// The current membership, stored as an ordered Vec.
#[pallet::storage]
#[pallet::getter(fn members)]
pub(crate) type Members<T: Config<I>, I: 'static = ()> = StorageValue<_, Vec<T::AccountId>, ValueQuery>;
/// Size of the `Members` set.
#[pallet::storage]
#[pallet::getter(fn member_count)]
pub(crate) type MemberCount<T, I=()> = StorageValue<_, u32, ValueQuery>;
#[pallet::genesis_config]
pub struct GenesisConfig<T: Config<I>, I: 'static = ()> {
pub pool: PoolT<T, I>,
pub member_count: u32,
}
#[cfg(feature = "std")]
impl<T: Config<I>, I: 'static> Default for GenesisConfig<T, I> {
fn default() -> Self {
Self {
pool: Default::default(),
member_count: Default::default(),
}
}
}
#[pallet::genesis_build]
impl<T: Config<I>, I: 'static> GenesisBuild<T, I> for GenesisConfig<T, I> {
fn build(&self) {
let mut pool = self.pool.clone();
// reserve balance for each candidate in the pool.
// panicking here is ok, since this just happens one time, pre-genesis.
pool
.iter()
.for_each(|(who, _)| {
T::Currency::reserve(&who, T::CandidateDeposit::get())
.expect("balance too low to create candidacy");
<CandidateExists<T, I>>::insert(who, true);
});
// Sorts the `Pool` by score in a descending order. Entities which
// have a score of `None` are sorted to the beginning of the vec.
pool.sort_by_key(|(_, maybe_score)|
Reverse(maybe_score.unwrap_or_default())
);
fn deposit_event() = default;
<MemberCount<T, I>>::put(self.member_count);
<Pool<T, I>>::put(&pool);
<Pallet<T, I>>::refresh_members(pool, ChangeReceiver::MembershipInitialized);
}
}
#[pallet::hooks]
impl<T: Config<I>, I: 'static> Hooks<BlockNumberFor<T>> for Pallet<T, I> {
/// Every `Period` blocks the `Members` set is refreshed from the
/// highest scoring members in the pool.
fn on_initialize(n: T::BlockNumber) -> Weight {
if n % T::Period::get() == Zero::zero() {
let pool = <Pool<T, I>>::get();
<Module<T, I>>::refresh_members(pool, ChangeReceiver::MembershipChanged);
<Pallet<T, I>>::refresh_members(pool, ChangeReceiver::MembershipChanged);
}
0
}
}
#[pallet::call]
impl<T: Config<I>, I: 'static> Pallet<T, I> {
/// Add `origin` to the pool of candidates.
///
/// This results in `CandidateDeposit` being reserved from
......@@ -265,8 +293,8 @@ decl_module! {
///
/// The `index` parameter of this function must be set to
/// the index of the transactor in the `Pool`.
#[weight = 0]
pub fn submit_candidacy(origin) {
#[pallet::weight(0)]
pub fn submit_candidacy(origin: OriginFor<T>) -> DispatchResult {
let who = ensure_signed(origin)?;
ensure!(!<CandidateExists<T, I>>::contains_key(&who), Error::<T, I>::AlreadyInPool);
......@@ -279,7 +307,8 @@ decl_module! {
<CandidateExists<T, I>>::insert(&who, true);
Self::deposit_event(RawEvent::CandidateAdded);
Self::deposit_event(Event::<T, I>::CandidateAdded);
Ok(())
}
/// An entity withdraws candidacy and gets its deposit back.
......@@ -292,18 +321,19 @@ decl_module! {
///
/// The `index` parameter of this function must be set to
/// the index of the transactor in the `Pool`.
#[weight = 0]
#[pallet::weight(0)]
pub fn withdraw_candidacy(
origin,
origin: OriginFor<T>,
index: u32
) {
) -> DispatchResult {
let who = ensure_signed(origin)?;
let pool = <Pool<T, I>>::get();
Self::ensure_index(&pool, &who, index)?;
Self::remove_member(pool, who, index)?;
Self::deposit_event(RawEvent::CandidateWithdrew);
Self::deposit_event(Event::<T, I>::CandidateWithdrew);
Ok(())
}
/// Kick a member `who` from the set.
......@@ -312,12 +342,12 @@ decl_module! {
///
/// The `index` parameter of this function must be set to
/// the index of `dest` in the `Pool`.
#[weight = 0]
#[pallet::weight(0)]
pub fn kick(
origin,
origin: OriginFor<T>,
dest: <T::Lookup as StaticLookup>::Source,
index: u32
) {
) -> DispatchResult {
T::KickOrigin::ensure_origin(origin)?;
let who = T::Lookup::lookup(dest)?;
......@@ -326,7 +356,8 @@ decl_module! {
Self::ensure_index(&pool, &who, index)?;
Self::remove_member(pool, who, index)?;
Self::deposit_event(RawEvent::CandidateKicked);
Self::deposit_event(Event::<T, I>::CandidateKicked);
Ok(())
}
/// Score a member `who` with `score`.
......@@ -335,13 +366,13 @@ decl_module! {
///
/// The `index` parameter of this function must be set to
/// the index of the `dest` in the `Pool`.
#[weight = 0]
#[pallet::weight(0)]
pub fn score(
origin,
origin: OriginFor<T>,
dest: <T::Lookup as StaticLookup>::Source,
index: u32,
score: T::Score
) {
) -> DispatchResult {
T::ScoreOrigin::ensure_origin(origin)?;
let who = T::Lookup::lookup(dest)?;
......@@ -365,7 +396,8 @@ decl_module! {
pool.insert(location, item);
<Pool<T, I>>::put(&pool);
Self::deposit_event(RawEvent::CandidateScored);
Self::deposit_event(Event::<T, I>::CandidateScored);
Ok(())
}
/// Dispatchable call to change `MemberCount`.
......@@ -374,15 +406,16 @@ decl_module! {
/// (this happens each `Period`).
///
/// May only be called from root.
#[weight = 0]
pub fn change_member_count(origin, count: u32) {
#[pallet::weight(0)]
pub fn change_member_count(origin: OriginFor<T>, count: u32) -> DispatchResult {
ensure_root(origin)?;
<MemberCount<I>>::put(&count);
MemberCount::<T, I>::put(&count);
Ok(())
}
}
}
impl<T: Config<I>, I: Instance> Module<T, I> {
impl<T: Config<I>, I: 'static> Pallet<T, I> {
/// Fetches the `MemberCount` highest scoring members from
/// `Pool` and puts them into `Members`.
......@@ -393,7 +426,7 @@ impl<T: Config<I>, I: Instance> Module<T, I> {
pool: PoolT<T, I>,
notify: ChangeReceiver
) {
let count = <MemberCount<I>>::get();
let count = MemberCount::<T, I>::get();
let mut new_members: Vec<T::AccountId> = pool
.into_iter()
......@@ -426,7 +459,7 @@ impl<T: Config<I>, I: Instance> Module<T, I> {
remove: T::AccountId,
index: u32
) -> Result<(), Error<T, I>> {
// all callers of this function in this module also check
// all callers of this function in this pallet also check
// the index for validity before calling this function.
// nevertheless we check again here, to assert that there was
// no mistake when invoking this sensible function.
......@@ -445,7 +478,7 @@ impl<T: Config<I>, I: Instance> Module<T, I> {
T::Currency::unreserve(&remove, T::CandidateDeposit::get());
Self::deposit_event(RawEvent::MemberRemoved);
Self::deposit_event(Event::<T, I>::MemberRemoved);
Ok(())
}
......
substrate/frame/scored-pool/src/mock.rs
+ 3
− 3
View file @ 714a0872
......@@ -21,7 +21,7 @@ use super::*;
use crate as pallet_scored_pool;
use std::cell::RefCell;
use frame_support::{parameter_types, ord_parameter_types};
use frame_support::{parameter_types, ord_parameter_types, traits::GenesisBuild};
use sp_core::H256;
use sp_runtime::{
traits::{BlakeTwo256, IdentityLookup}, testing::Header,
......@@ -160,7 +160,7 @@ pub fn new_test_ext() -> sp_io::TestExternalities {
/// Fetch an entity from the pool, if existent.
pub fn fetch_from_pool(who: u64) -> Option<(u64, Option<u64>)> {
<Module<Test>>::pool()
<Pallet<Test>>::pool()
.into_iter()
.find(|item| item.0 == who)
}
......@@ -168,7 +168,7 @@ pub fn fetch_from_pool(who: u64) -> Option<(u64, Option<u64>)> {
/// Find an entity in the pool.
/// Returns its position in the `Pool` vec, if existent.
pub fn find_in_pool(who: u64) -> Option<usize> {
<Module<Test>>::pool()
<Pallet<Test>>::pool()
.into_iter()
.position(|item| item.0 == who)
}
substrate/frame/scored-pool/src/tests.rs
+ 2
− 2
View file @ 714a0872
......@@ -15,7 +15,7 @@
// See the License for the specific language governing permissions and
// limitations under the License.
//! Tests for the module.
//! Tests for the pallet.
use super::*;
use mock::*;
......@@ -23,7 +23,7 @@ use mock::*;
use frame_support::{assert_ok, assert_noop, traits::OnInitialize};
use sp_runtime::traits::BadOrigin;
type ScoredPool = Module<Test>;
type ScoredPool = Pallet<Test>;
type System = frame_system::Pallet<Test>;
type Balances = pallet_balances::Pallet<Test>;
......
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment