Logic for the (Core) Fellowship

Cargo.toml

@@ -94,6 +94,7 @@ members = [
 	"frame/contracts/proc-macro",
 	"frame/contracts/primitives",
 	"frame/conviction-voting",
+	"frame/core-fellowship",
 	"frame/democracy",
 	"frame/fast-unstake",
 	"frame/try-runtime",

frame/core-fellowship/Cargo.toml

@@ -0,0 +1,53 @@
+[package]
+name = "pallet-core-fellowship"
+version = "4.0.0-dev"
+authors = ["Parity Technologies <[email protected]>"]
+edition = "2021"
+license = "Apache-2.0"
+homepage = "https://substrate.io"
+repository = "https://github.com/paritytech/substrate/"
+description = "Paymaster"
+readme = "README.md"
+
+[package.metadata.docs.rs]
+targets = ["x86_64-unknown-linux-gnu"]
+
+[dependencies]
+codec = { package = "parity-scale-codec", version = "3.0.0", default-features = false, features = ["derive"] }
+log = { version = "0.4.16", default-features = false }
+scale-info = { version = "2.0.1", default-features = false, features = ["derive"] }
+frame-benchmarking = { version = "4.0.0-dev", default-features = false, optional = true, path = "../benchmarking" }
+frame-support = { version = "4.0.0-dev", default-features = false, path = "../support" }
+frame-system = { version = "4.0.0-dev", default-features = false, path = "../system" }
+sp-arithmetic = { version = "6.0.0", default-features = false, path = "../../primitives/arithmetic" }
+sp-core = { version = "7.0.0", default-features = false, path = "../../primitives/core" }
+sp-io = { version = "7.0.0", default-features = false, path = "../../primitives/io" }
+sp-runtime = { version = "7.0.0", default-features = false, path = "../../primitives/runtime" }
+sp-std = { version = "5.0.0", default-features = false, path = "../../primitives/std" }
+
+[dev-dependencies]
+pallet-ranked-collective = { version = "4.0.0-dev", default-features = false, path = "../ranked-collective" }
+pallet-salary = { version = "4.0.0-dev", default-features = false, path = "../salary" }
+
+[features]
+default = ["std"]
+std = [
+	"codec/std",
+	"frame-benchmarking?/std",
+	"frame-support/std",
+	"frame-system/std",
+	"log/std",
+	"scale-info/std",
+	"sp-arithmetic/std",
+	"sp-core/std",
+	"sp-io/std",
+	"sp-runtime/std",
+	"sp-std/std",
+]
+runtime-benchmarks = [
+	"frame-benchmarking/runtime-benchmarks",
+	"frame-support/runtime-benchmarks",
+	"frame-system/runtime-benchmarks",
+	"sp-runtime/runtime-benchmarks",
+]
+try-runtime = ["frame-support/try-runtime"]

frame/core-fellowship/README.md

@@ -0,0 +1,3 @@
+# Core Fellowship
+
+Logic specific to the core Polkadot Fellowship.

frame/core-fellowship/src/benchmarking.rs

@@ -0,0 +1,200 @@
+// This file is part of Substrate.
+
+// Copyright (C) 2020-2022 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.
+
+//! Salary pallet benchmarking.
+
+#![cfg(feature = "runtime-benchmarks")]
+
+use super::*;
+use crate::Pallet as Salary;
+
+use frame_benchmarking::v2::*;
+use frame_system::{Pallet as System, RawOrigin};
+use sp_core::Get;
+
+const SEED: u32 = 0;
+
+fn ensure_member_with_salary<T: Config<I>, I: 'static>(who: &T::AccountId) {
+	// induct if not a member.
+	if T::Members::rank_of(who).is_none() {
+		T::Members::induct(who).unwrap();
+	}
+	// promote until they have a salary.
+	for _ in 0..255 {
+		let r = T::Members::rank_of(who).expect("prior guard ensures `who` is a member; qed");
+		if !T::Salary::get_salary(r, &who).is_zero() {
+			break
+		}
+		T::Members::promote(who).unwrap();
+	}
+}
+
+/*
+// move to benchmark code. No need for it here.
+impl<
+	Balance: BalanceTrait,
+	BlockNumber: AtLeast32BitUnsigned + Copy,
+> Default for ParamsType<Balance, BlockNumber> {
+	fn default() -> Self {
+		Self {
+			active_salary: [100u32.into(); 9],
+			passive_salary: [10u32.into(); 9],
+			demotion_period: [100u32.into(); 9],
+			min_promotion_period: [100u32.into(); 9],
+		}
+	}
+}
+*/
+
+#[instance_benchmarks]
+mod benchmarks {
+	use super::*;
+
+	#[benchmark]
+	fn init() {
+		let caller: T::AccountId = whitelisted_caller();
+
+		#[extrinsic_call]
+		_(RawOrigin::Signed(caller.clone()));
+
+		assert!(Salary::<T, I>::status().is_some());
+	}
+
+	#[benchmark]
+	fn bump() {
+		let caller: T::AccountId = whitelisted_caller();
+		Salary::<T, I>::init(RawOrigin::Signed(caller.clone()).into()).unwrap();
+		System::<T>::set_block_number(System::<T>::block_number() + Salary::<T, I>::cycle_period());
+
+		#[extrinsic_call]
+		_(RawOrigin::Signed(caller.clone()));
+
+		assert_eq!(Salary::<T, I>::status().unwrap().cycle_index, 1u32.into());
+	}
+
+	#[benchmark]
+	fn induct() {
+		let caller = whitelisted_caller();
+		ensure_member_with_salary::<T, I>(&caller);
+		Salary::<T, I>::init(RawOrigin::Signed(caller.clone()).into()).unwrap();
+
+		#[extrinsic_call]
+		_(RawOrigin::Signed(caller.clone()));
+
+		assert!(Salary::<T, I>::last_active(&caller).is_ok());
+	}
+
+	#[benchmark]
+	fn register() {
+		let caller = whitelisted_caller();
+		ensure_member_with_salary::<T, I>(&caller);
+		Salary::<T, I>::init(RawOrigin::Signed(caller.clone()).into()).unwrap();
+		Salary::<T, I>::induct(RawOrigin::Signed(caller.clone()).into()).unwrap();
+		System::<T>::set_block_number(System::<T>::block_number() + Salary::<T, I>::cycle_period());
+		Salary::<T, I>::bump(RawOrigin::Signed(caller.clone()).into()).unwrap();
+
+		#[extrinsic_call]
+		_(RawOrigin::Signed(caller.clone()));
+
+		assert_eq!(Salary::<T, I>::last_active(&caller).unwrap(), 1u32.into());
+	}
+
+	#[benchmark]
+	fn payout() {
+		let caller = whitelisted_caller();
+		ensure_member_with_salary::<T, I>(&caller);
+		Salary::<T, I>::init(RawOrigin::Signed(caller.clone()).into()).unwrap();
+		Salary::<T, I>::induct(RawOrigin::Signed(caller.clone()).into()).unwrap();
+		System::<T>::set_block_number(System::<T>::block_number() + Salary::<T, I>::cycle_period());
+		Salary::<T, I>::bump(RawOrigin::Signed(caller.clone()).into()).unwrap();
+		System::<T>::set_block_number(System::<T>::block_number() + T::RegistrationPeriod::get());
+
+		let salary = T::Salary::get_salary(T::Members::rank_of(&caller).unwrap(), &caller);
+		T::Paymaster::ensure_successful(&caller, salary);
+
+		#[extrinsic_call]
+		_(RawOrigin::Signed(caller.clone()));
+
+		match Claimant::<T, I>::get(&caller) {
+			Some(ClaimantStatus { last_active, status: Attempted { id, .. } }) => {
+				assert_eq!(last_active, 1u32.into());
+				assert_ne!(T::Paymaster::check_payment(id), PaymentStatus::Failure);
+			},
+			_ => panic!("No claim made"),
+		}
+		assert!(Salary::<T, I>::payout(RawOrigin::Signed(caller.clone()).into()).is_err());
+	}
+
+	#[benchmark]
+	fn payout_other() {
+		let caller = whitelisted_caller();
+		ensure_member_with_salary::<T, I>(&caller);
+		Salary::<T, I>::init(RawOrigin::Signed(caller.clone()).into()).unwrap();
+		Salary::<T, I>::induct(RawOrigin::Signed(caller.clone()).into()).unwrap();
+		System::<T>::set_block_number(System::<T>::block_number() + Salary::<T, I>::cycle_period());
+		Salary::<T, I>::bump(RawOrigin::Signed(caller.clone()).into()).unwrap();
+		System::<T>::set_block_number(System::<T>::block_number() + T::RegistrationPeriod::get());
+
+		let salary = T::Salary::get_salary(T::Members::rank_of(&caller).unwrap(), &caller);
+		let recipient: T::AccountId = account("recipient", 0, SEED);
+		T::Paymaster::ensure_successful(&recipient, salary);
+
+		#[extrinsic_call]
+		_(RawOrigin::Signed(caller.clone()), recipient.clone());
+
+		match Claimant::<T, I>::get(&caller) {
+			Some(ClaimantStatus { last_active, status: Attempted { id, .. } }) => {
+				assert_eq!(last_active, 1u32.into());
+				assert_ne!(T::Paymaster::check_payment(id), PaymentStatus::Failure);
+			},
+			_ => panic!("No claim made"),
+		}
+		assert!(Salary::<T, I>::payout(RawOrigin::Signed(caller.clone()).into()).is_err());
+	}
+
+	#[benchmark]
+	fn check_payment() {
+		let caller = whitelisted_caller();
+		ensure_member_with_salary::<T, I>(&caller);
+		Salary::<T, I>::init(RawOrigin::Signed(caller.clone()).into()).unwrap();
+		Salary::<T, I>::induct(RawOrigin::Signed(caller.clone()).into()).unwrap();
+		System::<T>::set_block_number(System::<T>::block_number() + Salary::<T, I>::cycle_period());
+		Salary::<T, I>::bump(RawOrigin::Signed(caller.clone()).into()).unwrap();
+		System::<T>::set_block_number(System::<T>::block_number() + T::RegistrationPeriod::get());
+
+		let salary = T::Salary::get_salary(T::Members::rank_of(&caller).unwrap(), &caller);
+		let recipient: T::AccountId = account("recipient", 0, SEED);
+		T::Paymaster::ensure_successful(&recipient, salary);
+		Salary::<T, I>::payout(RawOrigin::Signed(caller.clone()).into()).unwrap();
+		let id = match Claimant::<T, I>::get(&caller).unwrap().status {
+			Attempted { id, .. } => id,
+			_ => panic!("No claim made"),
+		};
+		T::Paymaster::ensure_concluded(id);
+
+		#[extrinsic_call]
+		_(RawOrigin::Signed(caller.clone()));
+
+		assert!(!matches!(Claimant::<T, I>::get(&caller).unwrap().status, Attempted { .. }));
+	}
+
+	impl_benchmark_test_suite! {
+		Salary,
+		crate::tests::new_test_ext(),
+		crate::tests::Test,
+	}
+}