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.rsdiffbeforeafterboth--- a/pallets/collator-selection/src/benchmarking.rs
+++ b/pallets/collator-selection/src/benchmarking.rs
@@ -116,12 +116,12 @@
.map(|c| account("candidate", c, SEED))
.collect::<Vec<_>>();
assert!(
- <CandidacyBond<T>>::get() > 0u32.into(),
+ <LicenseBond<T>>::get() > 0u32.into(),
"Bond cannot be zero!"
);
for who in candidates {
- T::Currency::make_free_balance_be(&who, <CandidacyBond<T>>::get() * 2u32.into());
+ T::Currency::make_free_balance_be(&who, <LicenseBond<T>>::get() * 2u32.into());
<CollatorSelection<T>>::register_as_candidate(RawOrigin::Signed(who).into()).unwrap();
}
}
@@ -154,16 +154,16 @@
assert_last_event::<T>(Event::NewDesiredCandidates{desired_candidates: max}.into());
}
- set_candidacy_bond {
+ set_license_bond {
let bond_amount: BalanceOf<T> = T::Currency::minimum_balance() * 10u32.into();
let origin = T::UpdateOrigin::successful_origin();
}: {
assert_ok!(
- <CollatorSelection<T>>::set_candidacy_bond(origin, bond_amount.clone())
+ <CollatorSelection<T>>::set_license_bond(origin, bond_amount.clone())
);
}
verify {
- assert_last_event::<T>(Event::NewCandidacyBond{bond_amount}.into());
+ assert_last_event::<T>(Event::NewLicenseBond{bond_amount}.into());
}
// worse case is when we have all the max-candidate slots filled except one, and we fill that
@@ -171,7 +171,7 @@
register_as_candidate {
let c in 1 .. T::MaxCandidates::get();
- <CandidacyBond<T>>::put(T::Currency::minimum_balance());
+ <LicenseBond<T>>::put(T::Currency::minimum_balance());
<DesiredCandidates<T>>::put(c + 1);
register_validators::<T>(c);
@@ -195,7 +195,7 @@
// worse case is the last candidate leaving.
leave_intent {
let c in (T::MinCandidates::get() + 1) .. T::MaxCandidates::get();
- <CandidacyBond<T>>::put(T::Currency::minimum_balance());
+ <LicenseBond<T>>::put(T::Currency::minimum_balance());
<DesiredCandidates<T>>::put(c);
register_validators::<T>(c);
@@ -211,7 +211,7 @@
// worse case is paying a non-existing candidate account.
note_author {
- <CandidacyBond<T>>::put(T::Currency::minimum_balance());
+ <LicenseBond<T>>::put(T::Currency::minimum_balance());
T::Currency::make_free_balance_be(
&<CollatorSelection<T>>::account_id(),
T::Currency::minimum_balance() * 4u32.into(),
@@ -233,7 +233,7 @@
let r in 1 .. T::MaxCandidates::get();
let c in 1 .. T::MaxCandidates::get();
- <CandidacyBond<T>>::put(T::Currency::minimum_balance());
+ <LicenseBond<T>>::put(T::Currency::minimum_balance());
<DesiredCandidates<T>>::put(c);
frame_system::Pallet::<T>::set_block_number(0u32.into());
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.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/>.1617pub mod config;18pub mod construct_runtime;19pub mod dispatch;20pub mod ethereum;21pub mod instance;22pub mod maintenance;23pub mod runtime_apis;24pub mod xcm;2526#[cfg(feature = "scheduler")]27pub mod scheduler;2829pub mod sponsoring;30pub mod weights;3132#[cfg(test)]33pub mod tests;3435use sp_core::H160;36use frame_support::{37 traits::{Currency, OnUnbalanced, Imbalance},38 weights::Weight,39};40use sp_runtime::{41 generic,42 traits::{BlakeTwo256, BlockNumberProvider},43 impl_opaque_keys,44};45use sp_std::vec::Vec;4647#[cfg(feature = "std")]48use sp_version::NativeVersion;4950use crate::{51 Runtime, RuntimeCall, Balances, Treasury, Aura, Signature, AllPalletsWithSystem,52 InherentDataExt,53};54use up_common::types::{AccountId, BlockNumber};5556#[macro_export]57macro_rules! unsupported {58 () => {59 pallet_common::unsupported!($crate::Runtime)60 };61}6263/// The address format for describing accounts.64pub type Address = sp_runtime::MultiAddress<AccountId, ()>;65/// Block header type as expected by this runtime.66pub type Header = generic::Header<BlockNumber, BlakeTwo256>;67/// Block type as expected by this runtime.68pub type Block = generic::Block<Header, UncheckedExtrinsic>;69/// A Block signed with a Justification70pub type SignedBlock = generic::SignedBlock<Block>;71/// BlockId type as expected by this runtime.72pub type BlockId = generic::BlockId<Block>;7374impl_opaque_keys! {75 pub struct SessionKeys {76 pub aura: Aura,77 }78}7980/// The version information used to identify this runtime when compiled natively.81#[cfg(feature = "std")]82pub fn native_version() -> NativeVersion {83 NativeVersion {84 runtime_version: crate::VERSION,85 can_author_with: Default::default(),86 }87}8889pub type ChargeTransactionPayment = pallet_charge_transaction::ChargeTransactionPayment<Runtime>;9091pub type SignedExtra = (92 frame_system::CheckSpecVersion<Runtime>,93 frame_system::CheckTxVersion<Runtime>,94 frame_system::CheckGenesis<Runtime>,95 frame_system::CheckEra<Runtime>,96 frame_system::CheckNonce<Runtime>,97 frame_system::CheckWeight<Runtime>,98 maintenance::CheckMaintenance,99 ChargeTransactionPayment,100 //pallet_contract_helpers::ContractHelpersExtension<Runtime>,101 pallet_ethereum::FakeTransactionFinalizer<Runtime>,102);103104/// Unchecked extrinsic type as expected by this runtime.105pub type UncheckedExtrinsic =106 fp_self_contained::UncheckedExtrinsic<Address, RuntimeCall, Signature, SignedExtra>;107108/// Extrinsic type that has already been checked.109pub type CheckedExtrinsic =110 fp_self_contained::CheckedExtrinsic<AccountId, RuntimeCall, SignedExtra, H160>;111112/// Executive: handles dispatch to the various modules.113pub type Executive = frame_executive::Executive<114 Runtime,115 Block,116 frame_system::ChainContext<Runtime>,117 Runtime,118 AllPalletsWithSystem,119 AuraToCollatorSelection,120>;121122type NegativeImbalance = <Balances as Currency<AccountId>>::NegativeImbalance;123124pub struct DealWithFees;125impl OnUnbalanced<NegativeImbalance> for DealWithFees {126 fn on_unbalanceds<B>(mut fees_then_tips: impl Iterator<Item = NegativeImbalance>) {127 if let Some(fees) = fees_then_tips.next() {128 // for fees, 100% to treasury129 let mut split = fees.ration(100, 0);130 if let Some(tips) = fees_then_tips.next() {131 // for tips, if any, 100% to treasury132 tips.ration_merge_into(100, 0, &mut split);133 }134 Treasury::on_unbalanced(split.0);135 // Author::on_unbalanced(split.1);136 }137 }138}139140pub struct RelayChainBlockNumberProvider<T>(sp_std::marker::PhantomData<T>);141142impl<T: cumulus_pallet_parachain_system::Config> BlockNumberProvider143 for RelayChainBlockNumberProvider<T>144{145 type BlockNumber = BlockNumber;146147 fn current_block_number() -> Self::BlockNumber {148 cumulus_pallet_parachain_system::Pallet::<T>::validation_data()149 .map(|d| d.relay_parent_number)150 .unwrap_or_default()151 }152}153154pub(crate) struct CheckInherents;155156impl cumulus_pallet_parachain_system::CheckInherents<Block> for CheckInherents {157 fn check_inherents(158 block: &Block,159 relay_state_proof: &cumulus_pallet_parachain_system::RelayChainStateProof,160 ) -> sp_inherents::CheckInherentsResult {161 let relay_chain_slot = relay_state_proof162 .read_slot()163 .expect("Could not read the relay chain slot from the proof");164165 let inherent_data =166 cumulus_primitives_timestamp::InherentDataProvider::from_relay_chain_slot_and_duration(167 relay_chain_slot,168 sp_std::time::Duration::from_secs(6),169 )170 .create_inherent_data()171 .expect("Could not create the timestamp inherent data");172173 inherent_data.check_extrinsics(block)174 }175}176177#[derive(codec::Encode, codec::Decode)]178pub enum XCMPMessage<XAccountId, XBalance> {179 /// Transfer tokens to the given account from the Parachain account.180 TransferToken(XAccountId, XBalance),181}182183pub struct AuraToCollatorSelection;184impl frame_support::traits::OnRuntimeUpgrade for AuraToCollatorSelection {185 fn on_runtime_upgrade() -> Weight {186 #[cfg(feature = "collator-selection")]187 {188 use frame_support::{BoundedVec, storage::migration};189 use sp_runtime::{190 traits::{OpaqueKeys, Saturating},191 RuntimeAppPublic,192 };193 use pallet_session::SessionManager;194 use up_common::constants::GENESIS_CANDIDACY_BOND;195 use crate::config::pallets::collator_selection::MaxInvulnerables;196197 let mut weight = <Runtime as frame_system::Config>::DbWeight::get().reads(1);198199 let version = migration::get_storage_value::<()>(200 b"AuraToCollatorSelection",201 b"StorageVersion",202 &[],203 );204205 let should_upgrade = match version {206 None => true,207 Some(_) => false,208 };209210 if should_upgrade {211 log::info!(212 target: "runtime::aura_to_collator_selection",213 "Running migration of Aura authorities to Collator Selection invulnerables"214 );215216 let invulnerables = pallet_aura::Pallet::<Runtime>::authorities()217 .iter()218 .cloned()219 .filter_map(|authority_id| {220 weight.saturating_accrue(<Runtime as frame_system::Config>::DbWeight::get().reads_writes(1, 1));221 let vec = authority_id.clone().to_raw_vec();222 let slice = vec.as_slice();223 let array: Option<[u8; 32]> = match slice.try_into() {224 Ok(a) => Some(a),225 Err(_) => {226 log::error!("Failed to convert an Aura authority to a Collator Selection invulnerable: {:?}", authority_id);227 None228 },229 };230 array.map(|a| (AccountId::from(a), authority_id))231 })232 .collect::<Vec<_>>();233234 let bounded_invulnerables = BoundedVec::<_, MaxInvulnerables>::try_from(235 invulnerables236 .iter()237 .cloned()238 .map(|(acc, _)| acc)239 .collect::<Vec<_>>(),240 )241 .expect("Existing collators/invulnerables are more than MaxInvulnerables");242243 <pallet_collator_selection::Invulnerables<Runtime>>::put(bounded_invulnerables);244 <pallet_collator_selection::DesiredCandidates<Runtime>>::put(0);245 <pallet_collator_selection::CandidacyBond<Runtime>>::put(GENESIS_CANDIDACY_BOND);246247 let keys = invulnerables248 .into_iter()249 .map(|(acc, aura)| {250 (251 acc.clone(), // account id252 acc, // validator id253 SessionKeys { aura: aura.clone() }, // session keys254 )255 })256 .collect::<Vec<_>>();257258 for (account, val, keys) in keys.iter().cloned() {259 for id in <Runtime as pallet_session::Config>::Keys::key_ids() {260 <pallet_session::KeyOwner<Runtime>>::insert((*id, keys.get_raw(*id)), &val)261 }262 <pallet_session::NextKeys<Runtime>>::insert(&val, &keys);263 // todo exercise caution, the following is taken from genesis264 if frame_system::Pallet::<Runtime>::inc_consumers_without_limit(&account)265 .is_err()266 {267 log::warn!(268 "We have entered an error with incrementing consumers without limit during the migration"269 );270 // This will leak a provider reference, however it only happens once (at271 // genesis) so it's really not a big deal and we assume that the user wants to272 // do this since it's the only way a non-endowed account can contain a session273 // key.274 frame_system::Pallet::<Runtime>::inc_providers(&account);275 }276 }277278 let initial_validators_0 =279 <Runtime as pallet_session::Config>::SessionManager::new_session(0)280 .unwrap_or_else(|| {281 frame_support::print(282 "No initial validator provided by `SessionManager`, use \283 session config keys to generate initial validator set.",284 );285 keys.iter().map(|x| x.1.clone()).collect()286 });287 /*assert!(288 !initial_validators_0.is_empty(),289 "Empty validator set for session 0 in (pseudo) genesis block!"290 );*/291292 let initial_validators_1 =293 <Runtime as pallet_session::Config>::SessionManager::new_session(1)294 .unwrap_or_else(|| initial_validators_0.clone());295 /*assert!(296 !initial_validators_1.is_empty(),297 "Empty validator set for session 1 in (pseudo) genesis block!"298 );*/299300 let queued_keys: Vec<_> = initial_validators_1301 .iter()302 .cloned()303 .map(|v| {304 (305 v.clone(),306 <pallet_session::NextKeys<Runtime>>::get(&v)307 .expect("Validator in session 1 missing keys!"),308 )309 })310 .collect();311312 // Tell everyone about the genesis session keys -- Aura must've already initialized it313 //<Runtime as pallet_session::Config>::SessionHandler::on_genesis_session::<<Runtime as pallet_session::Config>::Keys>(&queued_keys);314315 <pallet_session::Validators<Runtime>>::put(initial_validators_0);316 <pallet_session::QueuedKeys<Runtime>>::put(queued_keys);317318 <Runtime as pallet_session::Config>::SessionManager::start_session(0);319320 log::info!(321 target: "runtime::aura_to_collator_selection",322 "Migration of Aura authorities to Collator Selection invulnerables is complete."323 );324325 migration::put_storage_value::<()>(326 b"AuraToCollatorSelection",327 b"StorageVersion",328 &[],329 (),330 );331332 weight += <Runtime as frame_system::Config>::DbWeight::get().writes(1)333 } else {334 log::info!(335 target: "runtime::aura_to_collator_selection",336 "The storage migration has already been flagged as complete. No migration needs to be done.",337 );338 }339340 weight341 }342343 #[cfg(not(feature = "collator-selection"))]344 {345 Weight::zero()346 }347 }348}