difftreelog
feat(collator-selection) licenses + onboarding
in: master
8 files changed
node/cli/src/chain_spec.rsdiffbeforeafterboth--- a/node/cli/src/chain_spec.rs
+++ b/node/cli/src/chain_spec.rs
@@ -24,7 +24,7 @@
use serde_json::map::Map;
use up_common::types::opaque::*;
-use up_common::constants::{GENESIS_CANDIDACY_BOND, SESSION_LENGTH};
+use up_common::constants::{GENESIS_LICENSE_BOND, SESSION_LENGTH};
#[cfg(feature = "unique-runtime")]
pub use unique_runtime as default_runtime;
@@ -196,7 +196,7 @@
.cloned()
.map(|(acc, _)| acc)
.collect(),
- candidacy_bond: GENESIS_CANDIDACY_BOND,
+ license_bond: GENESIS_LICENSE_BOND,
kick_threshold: SESSION_LENGTH,
..Default::default()
},
pallets/collator-selection/src/benchmarking.rsdiffbeforeafterboth1// Copyright 2019-2022 Unique Network (Gibraltar) Ltd.2// This file is part of Unique Network.34// Unique Network is free software: you can redistribute it and/or modify5// it under the terms of the GNU General Public License as published by6// the Free Software Foundation, either version 3 of the License, or7// (at your option) any later version.89// Unique Network is distributed in the hope that it will be useful,10// but WITHOUT ANY WARRANTY; without even the implied warranty of11// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the12// GNU General Public License for more details.1314// You should have received a copy of the GNU General Public License15// along with Unique Network. If not, see <http://www.gnu.org/licenses/>.1617// Original license:18// Copyright (C) 2021 Parity Technologies (UK) Ltd.19// SPDX-License-Identifier: Apache-2.02021// Licensed under the Apache License, Version 2.0 (the "License");22// you may not use this file except in compliance with the License.23// You may obtain a copy of the License at24//25// http://www.apache.org/licenses/LICENSE-2.026//27// Unless required by applicable law or agreed to in writing, software28// distributed under the License is distributed on an "AS IS" BASIS,29// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.30// See the License for the specific language governing permissions and31// limitations under the License.3233//! Benchmarking setup for pallet-collator-selection3435use super::*;3637#[allow(unused)]38use crate::Pallet as CollatorSelection;39use frame_benchmarking::{account, benchmarks, impl_benchmark_test_suite, whitelisted_caller};40use frame_support::{41 assert_ok,42 codec::Decode,43 traits::{Currency, EnsureOrigin, Get},44};45use frame_system::{EventRecord, RawOrigin};46use pallet_authorship::EventHandler;47use pallet_session::{self as session, SessionManager};48use sp_std::prelude::*;4950pub type BalanceOf<T> =51 <<T as Config>::Currency as Currency<<T as frame_system::Config>::AccountId>>::Balance;5253const SEED: u32 = 0;5455// TODO: remove if this is given in substrate commit.56macro_rules! whitelist {57 ($acc:ident) => {58 frame_benchmarking::benchmarking::add_to_whitelist(59 frame_system::Account::<T>::hashed_key_for(&$acc).into(),60 );61 };62}6364fn assert_last_event<T: Config>(generic_event: <T as Config>::RuntimeEvent) {65 let events = frame_system::Pallet::<T>::events();66 let system_event: <T as frame_system::Config>::RuntimeEvent = generic_event.into();67 // compare to the last event record68 let EventRecord { event, .. } = &events[events.len() - 1];69 assert_eq!(event, &system_event);70}7172fn create_funded_user<T: Config>(73 string: &'static str,74 n: u32,75 balance_factor: u32,76) -> T::AccountId {77 let user = account(string, n, SEED);78 let balance = T::Currency::minimum_balance() * balance_factor.into();79 let _ = T::Currency::make_free_balance_be(&user, balance);80 user81}8283fn keys<T: Config + session::Config>(c: u32) -> <T as session::Config>::Keys {84 use rand::{RngCore, SeedableRng};8586 let keys = {87 let mut keys = [0u8; 128];8889 if c > 0 {90 let mut rng = rand::rngs::StdRng::seed_from_u64(c as u64);91 rng.fill_bytes(&mut keys);92 }9394 keys95 };9697 Decode::decode(&mut &keys[..]).unwrap()98}99100fn validator<T: Config + session::Config>(c: u32) -> (T::AccountId, <T as session::Config>::Keys) {101 (create_funded_user::<T>("candidate", c, 1000), keys::<T>(c))102}103104fn register_validators<T: Config + session::Config>(count: u32) -> Vec<T::AccountId> {105 let validators = (0..count).map(|c| validator::<T>(c)).collect::<Vec<_>>();106107 for (who, keys) in validators.clone() {108 <session::Pallet<T>>::set_keys(RawOrigin::Signed(who).into(), keys, Vec::new()).unwrap();109 }110111 validators.into_iter().map(|(who, _)| who).collect()112}113114fn register_candidates<T: Config>(count: u32) {115 let candidates = (0..count)116 .map(|c| account("candidate", c, SEED))117 .collect::<Vec<_>>();118 assert!(119 <CandidacyBond<T>>::get() > 0u32.into(),120 "Bond cannot be zero!"121 );122123 for who in candidates {124 T::Currency::make_free_balance_be(&who, <CandidacyBond<T>>::get() * 2u32.into());125 <CollatorSelection<T>>::register_as_candidate(RawOrigin::Signed(who).into()).unwrap();126 }127}128129benchmarks! {130 where_clause { where T: pallet_authorship::Config + session::Config }131132 set_invulnerables {133 let b in 1 .. T::MaxInvulnerables::get();134 let new_invulnerables = register_validators::<T>(b);135 let origin = T::UpdateOrigin::successful_origin();136 }: {137 assert_ok!(138 <CollatorSelection<T>>::set_invulnerables(origin, new_invulnerables.clone())139 );140 }141 verify {142 assert_last_event::<T>(Event::NewInvulnerables{invulnerables: new_invulnerables}.into());143 }144145 set_desired_candidates {146 let max: u32 = 999;147 let origin = T::UpdateOrigin::successful_origin();148 }: {149 assert_ok!(150 <CollatorSelection<T>>::set_desired_candidates(origin, max.clone())151 );152 }153 verify {154 assert_last_event::<T>(Event::NewDesiredCandidates{desired_candidates: max}.into());155 }156157 set_candidacy_bond {158 let bond_amount: BalanceOf<T> = T::Currency::minimum_balance() * 10u32.into();159 let origin = T::UpdateOrigin::successful_origin();160 }: {161 assert_ok!(162 <CollatorSelection<T>>::set_candidacy_bond(origin, bond_amount.clone())163 );164 }165 verify {166 assert_last_event::<T>(Event::NewCandidacyBond{bond_amount}.into());167 }168169 // worse case is when we have all the max-candidate slots filled except one, and we fill that170 // one.171 register_as_candidate {172 let c in 1 .. T::MaxCandidates::get();173174 <CandidacyBond<T>>::put(T::Currency::minimum_balance());175 <DesiredCandidates<T>>::put(c + 1);176177 register_validators::<T>(c);178 register_candidates::<T>(c);179180 let caller: T::AccountId = whitelisted_caller();181 let bond: BalanceOf<T> = T::Currency::minimum_balance() * 2u32.into();182 T::Currency::make_free_balance_be(&caller, bond.clone());183184 <session::Pallet<T>>::set_keys(185 RawOrigin::Signed(caller.clone()).into(),186 keys::<T>(c + 1),187 Vec::new()188 ).unwrap();189190 }: _(RawOrigin::Signed(caller.clone()))191 verify {192 assert_last_event::<T>(Event::CandidateAdded{account_id: caller, deposit: bond / 2u32.into()}.into());193 }194195 // worse case is the last candidate leaving.196 leave_intent {197 let c in (T::MinCandidates::get() + 1) .. T::MaxCandidates::get();198 <CandidacyBond<T>>::put(T::Currency::minimum_balance());199 <DesiredCandidates<T>>::put(c);200201 register_validators::<T>(c);202 register_candidates::<T>(c);203204 let leaving = <Candidates<T>>::get().last().unwrap().who.clone();205 whitelist!(leaving);206 }: _(RawOrigin::Signed(leaving.clone()))207 verify {208 // todo:collator verify these209 assert_last_event::<T>(Event::CandidateRemoved{account_id: leaving, deposit_returned: bond / 2u32.into() }.into());210 }211212 // worse case is paying a non-existing candidate account.213 note_author {214 <CandidacyBond<T>>::put(T::Currency::minimum_balance());215 T::Currency::make_free_balance_be(216 &<CollatorSelection<T>>::account_id(),217 T::Currency::minimum_balance() * 4u32.into(),218 );219 let author = account("author", 0, SEED);220 let new_block: T::BlockNumber = 10u32.into();221222 frame_system::Pallet::<T>::set_block_number(new_block);223 assert!(T::Currency::free_balance(&author) == 0u32.into());224 }: {225 <CollatorSelection<T> as EventHandler<_, _>>::note_author(author.clone())226 } verify {227 assert!(T::Currency::free_balance(&author) > 0u32.into());228 assert_eq!(frame_system::Pallet::<T>::block_number(), new_block);229 }230231 // worst case for new session.232 new_session {233 let r in 1 .. T::MaxCandidates::get();234 let c in 1 .. T::MaxCandidates::get();235236 <CandidacyBond<T>>::put(T::Currency::minimum_balance());237 <DesiredCandidates<T>>::put(c);238 frame_system::Pallet::<T>::set_block_number(0u32.into());239240 register_validators::<T>(c);241 register_candidates::<T>(c);242243 let new_block: T::BlockNumber = 1800u32.into();244 let zero_block: T::BlockNumber = 0u32.into();245 let candidates = <Candidates<T>>::get();246247 let non_removals = c.saturating_sub(r);248249 for i in 0..c {250 <LastAuthoredBlock<T>>::insert(candidates[i as usize].who.clone(), zero_block);251 }252253 if non_removals > 0 {254 for i in 0..non_removals {255 <LastAuthoredBlock<T>>::insert(candidates[i as usize].who.clone(), new_block);256 }257 } else {258 for i in 0..c {259 <LastAuthoredBlock<T>>::insert(candidates[i as usize].who.clone(), new_block);260 }261 }262263 let pre_length = <Candidates<T>>::get().len();264265 frame_system::Pallet::<T>::set_block_number(new_block);266267 assert!(<Candidates<T>>::get().len() == c as usize);268 }: {269 <CollatorSelection<T> as SessionManager<_>>::new_session(0)270 } verify {271 if c > r && non_removals >= T::MinCandidates::get() {272 assert!(<Candidates<T>>::get().len() < pre_length);273 } else if c > r && non_removals < T::MinCandidates::get() {274 assert!(<Candidates<T>>::get().len() == T::MinCandidates::get() as usize);275 } else {276 assert!(<Candidates<T>>::get().len() == pre_length);277 }278 }279}280281impl_benchmark_test_suite!(282 CollatorSelection,283 crate::mock::new_test_ext(),284 crate::mock::Test,285);pallets/collator-selection/src/lib.rsdiffbeforeafterboth--- a/pallets/collator-selection/src/lib.rs
+++ b/pallets/collator-selection/src/lib.rs
@@ -181,7 +181,7 @@
#[derive(
PartialEq, Eq, Clone, Encode, Decode, RuntimeDebug, scale_info::TypeInfo, MaxEncodedLen,
)]
- pub struct CandidateInfo<AccountId, Balance> {
+ pub struct LicenseInfo<AccountId, Balance> {
/// Account identifier.
pub who: AccountId,
/// Reserved deposit.
@@ -198,12 +198,18 @@
pub type Invulnerables<T: Config> =
StorageValue<_, BoundedVec<T::AccountId, T::MaxInvulnerables>, ValueQuery>;
+ /// The (community) collation license holders.
+ #[pallet::storage]
+ #[pallet::getter(fn licenses)]
+ pub type Licenses<T: Config> =
+ StorageMap<_, Blake2_128Concat, T::AccountId, BalanceOf<T>, ValueQuery>;
+
/// The (community, limited) collation candidates.
#[pallet::storage]
#[pallet::getter(fn candidates)]
pub type Candidates<T: Config> = StorageValue<
_,
- BoundedVec<CandidateInfo<T::AccountId, BalanceOf<T>>, T::MaxCandidates>,
+ BoundedVec<T::AccountId, T::MaxCandidates>, //LicenseInfo<T::AccountId, BalanceOf<T>>, T::MaxCandidates>, // license ID?
ValueQuery,
>;
@@ -231,13 +237,13 @@
///
/// When a collator calls `leave_intent` they immediately receive the deposit back.
#[pallet::storage]
- #[pallet::getter(fn candidacy_bond)]
- pub type CandidacyBond<T> = StorageValue<_, BalanceOf<T>, ValueQuery>;
+ #[pallet::getter(fn license_bond)]
+ pub type LicenseBond<T> = StorageValue<_, BalanceOf<T>, ValueQuery>;
#[pallet::genesis_config]
pub struct GenesisConfig<T: Config> {
pub invulnerables: Vec<T::AccountId>,
- pub candidacy_bond: BalanceOf<T>,
+ pub license_bond: BalanceOf<T>,
pub kick_threshold: T::BlockNumber,
pub desired_candidates: u32,
}
@@ -247,7 +253,7 @@
fn default() -> Self {
Self {
invulnerables: Default::default(),
- candidacy_bond: Default::default(),
+ license_bond: Default::default(),
kick_threshold: T::BlockNumber::one(),
desired_candidates: Default::default(),
}
@@ -275,7 +281,7 @@
);
<DesiredCandidates<T>>::put(&self.desired_candidates);
- <CandidacyBond<T>>::put(&self.candidacy_bond);
+ <LicenseBond<T>>::put(&self.license_bond);
<KickThreshold<T>>::put(&self.kick_threshold);
<Invulnerables<T>>::put(bounded_invulnerables);
}
@@ -287,7 +293,7 @@
NewDesiredCandidates {
desired_candidates: u32,
},
- NewCandidacyBond {
+ NewLicenseBond {
bond_amount: BalanceOf<T>,
},
NewKickThreshold {
@@ -299,13 +305,19 @@
InvulnerableRemoved {
invulnerable: T::AccountId,
},
- CandidateAdded {
+ LicenseObtained {
account_id: T::AccountId,
deposit: BalanceOf<T>,
},
+ LicenseForfeited {
+ account_id: T::AccountId,
+ deposit_returned: BalanceOf<T>,
+ },
+ CandidateAdded {
+ account_id: T::AccountId,
+ },
CandidateRemoved {
account_id: T::AccountId,
- deposit_returned: BalanceOf<T>,
},
}
@@ -320,6 +332,10 @@
Unknown,
/// Permission issue
Permission,
+ /// User already holds license to collate
+ AlreadyLicenseHolder,
+ /// User does not hold a license to collate
+ NoLicense,
/// User is already a candidate
AlreadyCandidate,
/// User is not a candidate
@@ -363,6 +379,9 @@
return Ok(().into());
}
+ // todo:collator check license holders, release moneys, promotion!
+ // force_release_license? Error::<T>::lreadyLicenseHolder?
+
<Invulnerables<T>>::try_append(new.clone())
.map_err(|_| Error::<T>::TooManyInvulnerables)?;
Self::deposit_event(Event::InvulnerableAdded { invulnerable: new });
@@ -419,20 +438,20 @@
}
/// Set the candidacy bond amount.
- #[pallet::weight(T::WeightInfo::set_candidacy_bond())]
- pub fn set_candidacy_bond(
+ #[pallet::weight(T::WeightInfo::set_license_bond())]
+ pub fn set_license_bond(
origin: OriginFor<T>,
bond: BalanceOf<T>,
) -> DispatchResultWithPostInfo {
T::UpdateOrigin::ensure_origin(origin)?;
- <CandidacyBond<T>>::put(&bond);
- Self::deposit_event(Event::NewCandidacyBond { bond_amount: bond });
+ <LicenseBond<T>>::put(&bond);
+ Self::deposit_event(Event::NewLicenseBond { bond_amount: bond });
Ok(().into())
}
/// Set the length of the kick threshold.
/// Note that if the length is not a multiple of the session period, it might get inconsistent.
- #[pallet::weight(T::WeightInfo::set_candidacy_bond())] // todo:collator weight
+ #[pallet::weight(T::WeightInfo::set_license_bond())] // todo:collator weight
pub fn set_kick_threshold(
origin: OriginFor<T>,
kick_threshold: T::BlockNumber,
@@ -446,21 +465,20 @@
Ok(().into())
}
- /// Register this account as a collator candidate. The account must (a) already have
- /// registered session keys and (b) be able to reserve the `CandidacyBond`.
+ /// Purchase a license on block collation for this account.
+ /// It does not make it a collator candidate, use `onboard` afterward. The account must
+ /// (a) already have registered session keys and (b) be able to reserve the `LicenseBond`.
///
/// This call is not available to `Invulnerable` collators.
- #[pallet::weight(T::WeightInfo::register_as_candidate(T::MaxCandidates::get()))]
- pub fn register_as_candidate(origin: OriginFor<T>) -> DispatchResultWithPostInfo {
+ #[pallet::weight(T::WeightInfo::register_as_candidate(T::MaxCandidates::get()))] // todo:collator weight
+ pub fn get_license(origin: OriginFor<T>) -> DispatchResultWithPostInfo {
+ // register_as_candidate
let who = ensure_signed(origin)?;
- // ensure we are below limit.
- let length = <Candidates<T>>::decode_len().unwrap_or_default();
- ensure!(
- (length as u32) < Self::desired_candidates(),
- Error::<T>::TooManyCandidates
- );
- // todo:collator really need it?
+ if Licenses::<T>::contains_key(&who) {
+ return Ok(().into());
+ }
+
ensure!(
!Self::invulnerables().contains(&who),
Error::<T>::AlreadyInvulnerable
@@ -473,21 +491,81 @@
Error::<T>::ValidatorNotRegistered
);
- let deposit = Self::candidacy_bond();
+ let deposit = Self::license_bond();
// First authored block is current block plus kick threshold to handle session delay
- let incoming = CandidateInfo {
+ /*let incoming = LicenseInfo {
who: who.clone(),
deposit,
- };
+ };*/
+ T::Currency::reserve(&who, deposit)?;
+ Licenses::<T>::insert(who.clone(), deposit);
+
+ /*let current_count =
+ <Licenses<T>>::try_mutate(|licenses| -> Result<usize, DispatchError> {
+ if T::OriginPrivilegeCmp::cmp_privilege(&origin, &scheduled.origin) {
+ return Err(BadOrigin.into());
+ }
+ if candidates.iter().any(|candidate| *candidate == who) {
+ Err(Error::<T>::AlreadyLicenseHolder)?
+ } else {
+ T::Currency::reserve(&who, deposit)?;
+ candidates
+ .try_push(incoming)
+ .map_err(|_| Error::<T>::TooManyCandidates)?;
+ <LastAuthoredBlock<T>>::insert(
+ who.clone(),
+ frame_system::Pallet::<T>::block_number() + Self::kick_threshold(),
+ );
+ Ok(candidates.len())
+ }
+ })?;*/
+
+ Self::deposit_event(Event::LicenseObtained {
+ account_id: who,
+ deposit,
+ });
+ Ok(().into()) // Some(T::WeightInfo::register_as_candidate(current_count as u32)).into())
+ }
+
+ /// Register this account as a candidate for collators for next sessions.
+ /// The account must already hold a license, and cannot offboard immediately during a session.
+ ///
+ /// This call is not available to `Invulnerable` collators.
+ #[pallet::weight(T::WeightInfo::register_as_candidate(T::MaxCandidates::get()))] // todo:collator weight
+ pub fn onboard(origin: OriginFor<T>) -> DispatchResultWithPostInfo {
+ // register_as_candidate
+ let who = ensure_signed(origin)?;
+
+ // ensure the user obtained the license.
+ ensure!(Licenses::<T>::contains_key(&who), Error::<T>::NoLicense);
+ // ensure we are below limit.
+ let length = <Candidates<T>>::decode_len().unwrap_or_default();
+ ensure!(
+ (length as u32) < Self::desired_candidates(),
+ Error::<T>::TooManyCandidates
+ );
+ // todo:collator really need it?
+ ensure!(
+ !Self::invulnerables().contains(&who),
+ Error::<T>::AlreadyInvulnerable
+ );
+
+ let deposit = Self::license_bond();
+ // First authored block is current block plus kick threshold to handle session delay
+ /*let incoming = LicenseInfo {
+ who: who.clone(),
+ deposit,
+ };*/
+
let current_count =
<Candidates<T>>::try_mutate(|candidates| -> Result<usize, DispatchError> {
- if candidates.iter().any(|candidate| candidate.who == who) {
+ if candidates.iter().any(|candidate| *candidate == who) {
Err(Error::<T>::AlreadyCandidate)?
} else {
T::Currency::reserve(&who, deposit)?;
candidates
- .try_push(incoming)
+ .try_push(who.clone())
.map_err(|_| Error::<T>::TooManyCandidates)?;
<LastAuthoredBlock<T>>::insert(
who.clone(),
@@ -497,31 +575,59 @@
}
})?;
- Self::deposit_event(Event::CandidateAdded {
- account_id: who,
- deposit,
- });
+ Self::deposit_event(Event::CandidateAdded { account_id: who });
Ok(Some(T::WeightInfo::register_as_candidate(current_count as u32)).into())
}
/// Deregister `origin` as a collator candidate. Note that the collator can only leave on
- /// session change. The `CandidacyBond` will be unreserved immediately.
- ///
- /// This call will fail if the total number of candidates would drop below `MinCandidates`.
+ /// session change. The license to `onboard` later at any other time will remain.
///
- /// This call is not available to `Invulnerable` collators.
- #[pallet::weight(T::WeightInfo::leave_intent(T::MaxCandidates::get()))]
- pub fn leave_intent(origin: OriginFor<T>) -> DispatchResultWithPostInfo {
+ /// This call will fail if the total number of candidates would drop below `MinCandidates`. todo:collator maybe not
+ #[pallet::weight(T::WeightInfo::leave_intent(T::MaxCandidates::get()))] // todo:collator weight
+ pub fn offboard(origin: OriginFor<T>) -> DispatchResultWithPostInfo {
+ // leave_intent
let who = ensure_signed(origin)?;
// todo:collator invulnerables and candidates should count against min candidates together
ensure!(
Self::candidates().len() as u32 > T::MinCandidates::get(),
Error::<T>::TooFewCandidates
);
- let current_count = Self::try_remove_candidate(&who, false)?;
+ let current_count = Self::try_remove_candidate(&who)?;
Ok(Some(T::WeightInfo::leave_intent(current_count as u32)).into())
}
+
+ /// Forfeit `origin`'s own license. The `LicenseBond` will be unreserved immediately.
+ ///
+ /// This call is not available to `Invulnerable` collators.
+ #[pallet::weight(T::WeightInfo::leave_intent(T::MaxCandidates::get()))] // todo:collator weight
+ pub fn release_license(origin: OriginFor<T>) -> DispatchResultWithPostInfo {
+ // leave_intent
+ let who = ensure_signed(origin)?;
+ // let current_count = Self::try_remove_candidate(&who, false)?;
+ Self::try_release_license(&who, false)?;
+
+ Ok(().into())
+ }
+
+ /// Force deregister `origin` as a collator candidate as a governing authority, and revoke its license.
+ /// Note that the collator can only leave on session change.
+ /// The `LicenseBond` will be unreserved and returned immediately.
+ ///
+ /// This call is not available to `Invulnerable` collators.
+ #[pallet::weight(T::WeightInfo::leave_intent(T::MaxCandidates::get()))] // todo:collator weight
+ pub fn force_release_license(
+ origin: OriginFor<T>,
+ who: T::AccountId,
+ ) -> DispatchResultWithPostInfo {
+ // leave_intent
+ T::UpdateOrigin::ensure_origin(origin)?;
+
+ let current_count = Self::try_remove_candidate(&who)?;
+ Self::try_release_license(&who, false)?;
+
+ Ok(Some(T::WeightInfo::leave_intent(current_count as u32)).into()) // todo:collator weight
+ }
}
impl<T: Config> Pallet<T> {
@@ -530,21 +636,29 @@
T::PotId::get().into_account_truncating()
}
- /// Removes a candidate if they exist and sends them back their deposit, optionally slashed.
- fn try_remove_candidate(
- who: &T::AccountId,
- should_slash: bool,
- ) -> Result<usize, DispatchError> {
- let mut deposit_returned = BalanceOf::<T>::default();
+ /// Removes a candidate from the collator pool for the next session if they exist.
+ fn try_remove_candidate(who: &T::AccountId) -> Result<usize, DispatchError> {
let current_count =
<Candidates<T>>::try_mutate(|candidates| -> Result<usize, DispatchError> {
let index = candidates
.iter()
- .position(|candidate| candidate.who == *who)
+ .position(|candidate| *candidate == *who)
.ok_or(Error::<T>::NotCandidate)?;
- let candidate = candidates.remove(index);
- let deposit = candidate.deposit;
+ candidates.remove(index);
+ <LastAuthoredBlock<T>>::remove(who.clone());
+ Ok(candidates.len())
+ })?;
+ Self::deposit_event(Event::CandidateRemoved {
+ account_id: who.clone(),
+ });
+ Ok(current_count)
+ }
+ /// Removes a candidate if they exist and sends them back their deposit, optionally slashed.
+ fn try_release_license(who: &T::AccountId, should_slash: bool) -> DispatchResult {
+ let mut deposit_returned = BalanceOf::<T>::default();
+ Licenses::<T>::try_mutate_exists(&who, |deposit| -> DispatchResult {
+ if let Some(deposit) = deposit.take() {
if should_slash {
let slashed = T::SlashRatio::get() * deposit;
let remaining = deposit - slashed;
@@ -554,23 +668,22 @@
deposit_returned = remaining;
T::Currency::resolve_creating(&T::TreasuryAccountId::get(), imbalance);
-
- // Self::deposit_event(Event::CandidateSlashed(who.clone()));
} else {
//T::Currency::unreserve(who, deposit);
deposit_returned = deposit;
}
T::Currency::unreserve(who, deposit_returned);
- // candidates.remove(index);
- <LastAuthoredBlock<T>>::remove(who.clone());
- Ok(candidates.len())
- })?;
- Self::deposit_event(Event::CandidateRemoved {
+ Ok(())
+ } else {
+ Err(Error::<T>::NoLicense.into())
+ }
+ })?;
+ Self::deposit_event(Event::LicenseForfeited {
account_id: who.clone(),
deposit_returned,
});
- Ok(current_count)
+ Ok(())
}
/// Assemble the current set of candidates and invulnerables into the next collator set.
@@ -587,24 +700,30 @@
/// Kicks out candidates that did not produce a block in the kick threshold
/// and **confiscates** their deposits to the treasury.
pub fn kick_stale_candidates(
- candidates: BoundedVec<CandidateInfo<T::AccountId, BalanceOf<T>>, T::MaxCandidates>,
+ candidates: BoundedVec<T::AccountId, T::MaxCandidates>, //LicenseInfo<T::AccountId, BalanceOf<T>>
) -> BoundedVec<T::AccountId, T::MaxCandidates> {
let now = frame_system::Pallet::<T>::block_number();
let kick_threshold = Self::kick_threshold();
candidates
.into_iter()
.filter_map(|c| {
- let last_block = <LastAuthoredBlock<T>>::get(c.who.clone());
+ let last_block = <LastAuthoredBlock<T>>::get(c.clone());
let since_last = now.saturating_sub(last_block);
if since_last < kick_threshold ||
Self::candidates().len() as u32 <= T::MinCandidates::get()
{
- Some(c.who)
+ Some(c)
} else {
- let outcome = Self::try_remove_candidate(&c.who, true);
+ let outcome = Self::try_remove_candidate(&c);
if let Err(why) = outcome {
log::warn!("Failed to remove candidate {:?}", why);
debug_assert!(false, "failed to remove candidate {:?}", why);
+ return None;
+ }
+ let outcome = Self::try_release_license(&c, true);
+ if let Err(why) = outcome {
+ log::warn!("Failed to release license {:?}", why);
+ debug_assert!(false, "failed to release license {:?}", why);
}
None
}
pallets/collator-selection/src/mock.rsdiffbeforeafterboth--- a/pallets/collator-selection/src/mock.rs
+++ b/pallets/collator-selection/src/mock.rs
@@ -264,7 +264,7 @@
.collect::<Vec<_>>();
let collator_selection = collator_selection::GenesisConfig::<Test> {
desired_candidates: 2,
- candidacy_bond: 10,
+ license_bond: 10,
kick_threshold: 1,
invulnerables,
};
pallets/collator-selection/src/tests.rsdiffbeforeafterboth--- a/pallets/collator-selection/src/tests.rs
+++ b/pallets/collator-selection/src/tests.rs
@@ -31,7 +31,7 @@
// limitations under the License.
use crate as collator_selection;
-use crate::{mock::*, CandidateInfo, Error};
+use crate::{mock::*, LicenseInfo, Error};
use frame_support::{
assert_noop, assert_ok,
traits::{Currency, GenesisBuild, OnInitialize},
@@ -43,7 +43,7 @@
fn basic_setup_works() {
new_test_ext().execute_with(|| {
assert_eq!(CollatorSelection::desired_candidates(), 2);
- assert_eq!(CollatorSelection::candidacy_bond(), 10);
+ assert_eq!(CollatorSelection::license_bond(), 10);
assert!(CollatorSelection::candidates().is_empty());
assert_eq!(CollatorSelection::invulnerables(), vec![1, 2]);
@@ -133,21 +133,21 @@
}
#[test]
-fn set_candidacy_bond() {
+fn set_license_bond() {
new_test_ext().execute_with(|| {
// given
- assert_eq!(CollatorSelection::candidacy_bond(), 10);
+ assert_eq!(CollatorSelection::license_bond(), 10);
// can set
- assert_ok!(CollatorSelection::set_candidacy_bond(
+ assert_ok!(CollatorSelection::set_license_bond(
RuntimeOrigin::signed(RootAccount::get()),
7
));
- assert_eq!(CollatorSelection::candidacy_bond(), 7);
+ assert_eq!(CollatorSelection::license_bond(), 7);
// rejects bad origin.
assert_noop!(
- CollatorSelection::set_candidacy_bond(RuntimeOrigin::signed(1), 8),
+ CollatorSelection::set_license_bond(RuntimeOrigin::signed(1), 8),
BadOrigin
);
});
@@ -227,7 +227,7 @@
assert_ok!(CollatorSelection::register_as_candidate(
RuntimeOrigin::signed(3)
));
- let addition = CandidateInfo {
+ let addition = LicenseInfo {
who: 3,
deposit: 10,
};
@@ -267,7 +267,7 @@
new_test_ext().execute_with(|| {
// given
assert_eq!(CollatorSelection::desired_candidates(), 2);
- assert_eq!(CollatorSelection::candidacy_bond(), 10);
+ assert_eq!(CollatorSelection::license_bond(), 10);
assert_eq!(CollatorSelection::candidates(), Vec::new());
assert_eq!(CollatorSelection::invulnerables(), vec![1, 2]);
@@ -331,7 +331,7 @@
// triggers `note_author`
Authorship::on_initialize(1);
- let collator = CandidateInfo {
+ let collator = LicenseInfo {
who: 4,
deposit: 10,
};
@@ -361,7 +361,7 @@
// triggers `note_author`
Authorship::on_initialize(1);
- let collator = CandidateInfo {
+ let collator = LicenseInfo {
who: 4,
deposit: 10,
};
@@ -432,7 +432,7 @@
assert_eq!(CollatorSelection::candidates().len(), 1);
// 3 will be kicked after 1 session delay
assert_eq!(SessionHandlerCollators::get(), vec![1, 2, 3, 4]);
- let collator = CandidateInfo {
+ let collator = LicenseInfo {
who: 4,
deposit: 10,
};
@@ -465,7 +465,7 @@
assert_eq!(CollatorSelection::candidates().len(), 1);
// 3 will be kicked after 1 session delay
assert_eq!(SessionHandlerCollators::get(), vec![1, 2, 3, 5]);
- let collator = CandidateInfo {
+ let collator = LicenseInfo {
who: 5,
deposit: 10,
};
@@ -490,7 +490,7 @@
let collator_selection = collator_selection::GenesisConfig::<Test> {
desired_candidates: 2,
- candidacy_bond: 10,
+ license_bond: 10,
kick_threshold: 1,
invulnerables,
};
pallets/collator-selection/src/weights.rsdiffbeforeafterboth--- a/pallets/collator-selection/src/weights.rs
+++ b/pallets/collator-selection/src/weights.rs
@@ -46,7 +46,7 @@
pub trait WeightInfo {
fn set_invulnerables(_b: u32) -> Weight;
fn set_desired_candidates() -> Weight;
- fn set_candidacy_bond() -> Weight;
+ fn set_license_bond() -> Weight;
fn register_as_candidate(_c: u32) -> Weight;
fn leave_intent(_c: u32) -> Weight;
fn note_author() -> Weight;
@@ -65,7 +65,7 @@
fn set_desired_candidates() -> Weight {
Weight::from_ref_time(16_363_000 as u64).saturating_add(T::DbWeight::get().writes(1 as u64))
}
- fn set_candidacy_bond() -> Weight {
+ fn set_license_bond() -> Weight {
Weight::from_ref_time(16_840_000 as u64).saturating_add(T::DbWeight::get().writes(1 as u64))
}
fn register_as_candidate(c: u32) -> Weight {
@@ -112,7 +112,7 @@
Weight::from_ref_time(16_363_000 as u64)
.saturating_add(RocksDbWeight::get().writes(1 as u64))
}
- fn set_candidacy_bond() -> Weight {
+ fn set_license_bond() -> Weight {
Weight::from_ref_time(16_840_000 as u64)
.saturating_add(RocksDbWeight::get().writes(1 as u64))
}
primitives/common/src/constants.rsdiffbeforeafterboth--- a/primitives/common/src/constants.rs
+++ b/primitives/common/src/constants.rs
@@ -45,9 +45,9 @@
/// Minimum balance required to create or keep an account open.
pub const EXISTENTIAL_DEPOSIT: u128 = 0;
/// Amount of Balance reserved for candidate registration.
-pub const GENESIS_CANDIDACY_BOND: u128 = EXISTENTIAL_DEPOSIT;
+pub const GENESIS_LICENSE_BOND: u128 = EXISTENTIAL_DEPOSIT;
/// How long a periodic session lasts in blocks.
-pub const SESSION_LENGTH: BlockNumber = HOURS;
+pub const SESSION_LENGTH: BlockNumber = MINUTES;
// Targeting 0.1 UNQ per transfer
pub const WEIGHT_TO_FEE_COEFF: u32 = /*<weight2fee>*/175_199_920/*</weight2fee>*/;
runtime/common/mod.rsdiffbeforeafterboth--- a/runtime/common/mod.rs
+++ b/runtime/common/mod.rs
@@ -191,7 +191,7 @@
RuntimeAppPublic,
};
use pallet_session::SessionManager;
- use up_common::constants::GENESIS_CANDIDACY_BOND;
+ use up_common::constants::GENESIS_LICENSE_BOND;
use crate::config::pallets::collator_selection::MaxInvulnerables;
let mut weight = <Runtime as frame_system::Config>::DbWeight::get().reads(1);
@@ -242,7 +242,7 @@
<pallet_collator_selection::Invulnerables<Runtime>>::put(bounded_invulnerables);
<pallet_collator_selection::DesiredCandidates<Runtime>>::put(0);
- <pallet_collator_selection::CandidacyBond<Runtime>>::put(GENESIS_CANDIDACY_BOND);
+ <pallet_collator_selection::LicenseBond<Runtime>>::put(GENESIS_LICENSE_BOND);
let keys = invulnerables
.into_iter()