Add child-bounties pallet. (#10309)

* Extract child-bounties as a separate pallet. * Initial tests added. * More tests. * Tests complete. Fixed curator fee issue. * Fixed comments. * Added benchmarks for child-bounties pallet. * Added weights. * Fixed formatting. * Fixed comments. * Re-run benchmarks for bounties pallet. * Make cargo fmt happy again * add max encoded len * use event structs * fmt * fix compile * Addressed review comments. * Use config type instead of const in benchmarking. * Addressed more review comments. * Use ensure_can_withdraw instead of just checking min balance. * fmt. * Introduce ChildBountyCuratorDepositBase to avoid zero curator deposits for child bounties. * Fix unassign curator logic for child-bounties. * Added more tests for unassign curator. * Reduce bounty description max length in node runtime. * Updated weights for child bounties pallet. * reduce indentation of unassign_curator * more indentation reduction * deduplicate slashing arms * reintroduce ensure check * add assertion to check that bad unassign origin fails * formatting * Updated comments. Co-authored-by: Ricardo Rius <ricardo@parity.io> Co-authored-by: Shawn Tabrizi <shawntabrizi@gmail.com> Co-authored-by: Alexander Popiak <alexander.popiak@parity.io>
2026-05-30 07:01:03 +00:00 · 2021-12-07 23:40:47 +01:00
parent fe6189d370
commit 752e050cf4
13 changed files with 2896 additions and 78 deletions
@@ -0,0 +1,308 @@
+// This file is part of Substrate.
+
+// Copyright (C) 2021 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.
+
+//! Child-bounties pallet benchmarking.
+
+#![cfg(feature = "runtime-benchmarks")]
+
+use super::*;
+
+use frame_benchmarking::{account, benchmarks, whitelisted_caller};
+use frame_system::RawOrigin;
+
+use crate::Pallet as ChildBounties;
+use pallet_bounties::Pallet as Bounties;
+use pallet_treasury::Pallet as Treasury;
+
+const SEED: u32 = 0;
+
+#[derive(Clone)]
+struct BenchmarkChildBounty<T: Config> {
+	/// Bounty ID.
+	bounty_id: BountyIndex,
+	/// ChildBounty ID.
+	child_bounty_id: BountyIndex,
+	/// The account proposing it.
+	caller: T::AccountId,
+	/// The master curator account.
+	curator: T::AccountId,
+	/// The child-bounty curator account.
+	child_curator: T::AccountId,
+	/// The (total) amount that should be paid if the bounty is rewarded.
+	value: BalanceOf<T>,
+	/// The curator fee. included in value.
+	fee: BalanceOf<T>,
+	/// The (total) amount that should be paid if the child-bounty is rewarded.
+	child_bounty_value: BalanceOf<T>,
+	/// The child-bounty curator fee. included in value.
+	child_bounty_fee: BalanceOf<T>,
+	/// Bounty description.
+	reason: Vec<u8>,
+}
+
+fn setup_bounty<T: Config>(
+	user: u32,
+	description: u32,
+) -> (T::AccountId, T::AccountId, BalanceOf<T>, BalanceOf<T>, Vec<u8>) {
+	let caller = account("caller", user, SEED);
+	let value: BalanceOf<T> = T::BountyValueMinimum::get().saturating_mul(100u32.into());
+	let fee = value / 2u32.into();
+	let deposit = T::BountyDepositBase::get() +
+		T::DataDepositPerByte::get() * T::MaximumReasonLength::get().into();
+	let _ = T::Currency::make_free_balance_be(&caller, deposit);
+	let curator = account("curator", user, SEED);
+	let _ = T::Currency::make_free_balance_be(&curator, fee / 2u32.into());
+	let reason = vec![0; description as usize];
+	(caller, curator, fee, value, reason)
+}
+
+fn setup_child_bounty<T: Config>(user: u32, description: u32) -> BenchmarkChildBounty<T> {
+	let (caller, curator, fee, value, reason) = setup_bounty::<T>(user, description);
+	let child_curator = account("child-curator", user, SEED);
+	let _ = T::Currency::make_free_balance_be(&child_curator, fee / 2u32.into());
+	let child_bounty_value = (value - fee) / 4u32.into();
+	let child_bounty_fee = child_bounty_value / 2u32.into();
+
+	BenchmarkChildBounty::<T> {
+		bounty_id: 0,
+		child_bounty_id: 0,
+		caller,
+		curator,
+		child_curator,
+		value,
+		fee,
+		child_bounty_value,
+		child_bounty_fee,
+		reason,
+	}
+}
+
+fn activate_bounty<T: Config>(
+	user: u32,
+	description: u32,
+) -> Result<BenchmarkChildBounty<T>, &'static str> {
+	let mut child_bounty_setup = setup_child_bounty::<T>(user, description);
+	let curator_lookup = T::Lookup::unlookup(child_bounty_setup.curator.clone());
+	Bounties::<T>::propose_bounty(
+		RawOrigin::Signed(child_bounty_setup.caller.clone()).into(),
+		child_bounty_setup.value,
+		child_bounty_setup.reason.clone(),
+	)?;
+
+	child_bounty_setup.bounty_id = Bounties::<T>::bounty_count() - 1;
+
+	Bounties::<T>::approve_bounty(RawOrigin::Root.into(), child_bounty_setup.bounty_id)?;
+	Treasury::<T>::on_initialize(T::BlockNumber::zero());
+	Bounties::<T>::propose_curator(
+		RawOrigin::Root.into(),
+		child_bounty_setup.bounty_id,
+		curator_lookup.clone(),
+		child_bounty_setup.fee,
+	)?;
+	Bounties::<T>::accept_curator(
+		RawOrigin::Signed(child_bounty_setup.curator.clone()).into(),
+		child_bounty_setup.bounty_id,
+	)?;
+
+	Ok(child_bounty_setup)
+}
+
+fn activate_child_bounty<T: Config>(
+	user: u32,
+	description: u32,
+) -> Result<BenchmarkChildBounty<T>, &'static str> {
+	let mut bounty_setup = activate_bounty::<T>(user, description)?;
+	let child_curator_lookup = T::Lookup::unlookup(bounty_setup.child_curator.clone());
+
+	ChildBounties::<T>::add_child_bounty(
+		RawOrigin::Signed(bounty_setup.curator.clone()).into(),
+		bounty_setup.bounty_id,
+		bounty_setup.child_bounty_value,
+		bounty_setup.reason.clone(),
+	)?;
+
+	bounty_setup.child_bounty_id = ChildBountyCount::<T>::get() - 1;
+
+	ChildBounties::<T>::propose_curator(
+		RawOrigin::Signed(bounty_setup.curator.clone()).into(),
+		bounty_setup.bounty_id,
+		bounty_setup.child_bounty_id,
+		child_curator_lookup.clone(),
+		bounty_setup.child_bounty_fee,
+	)?;
+
+	ChildBounties::<T>::accept_curator(
+		RawOrigin::Signed(bounty_setup.child_curator.clone()).into(),
+		bounty_setup.bounty_id,
+		bounty_setup.child_bounty_id,
+	)?;
+
+	Ok(bounty_setup)
+}
+
+fn setup_pot_account<T: Config>() {
+	let pot_account = Bounties::<T>::account_id();
+	let value = T::Currency::minimum_balance().saturating_mul(1_000_000_000u32.into());
+	let _ = T::Currency::make_free_balance_be(&pot_account, value);
+}
+
+fn assert_last_event<T: Config>(generic_event: <T as Config>::Event) {
+	frame_system::Pallet::<T>::assert_last_event(generic_event.into());
+}
+
+benchmarks! {
+	add_child_bounty {
+		let d in 0 .. T::MaximumReasonLength::get();
+		setup_pot_account::<T>();
+		let bounty_setup = activate_bounty::<T>(0, d)?;
+	}: _(RawOrigin::Signed(bounty_setup.curator), bounty_setup.bounty_id,
+			bounty_setup.child_bounty_value, bounty_setup.reason.clone())
+	verify {
+		assert_last_event::<T>(Event::Added {
+			index: bounty_setup.bounty_id,
+			child_index: bounty_setup.child_bounty_id,
+		}.into())
+	}
+
+	propose_curator {
+		setup_pot_account::<T>();
+		let bounty_setup = activate_bounty::<T>(0, T::MaximumReasonLength::get())?;
+		let child_curator_lookup = T::Lookup::unlookup(bounty_setup.child_curator.clone());
+
+		ChildBounties::<T>::add_child_bounty(
+			RawOrigin::Signed(bounty_setup.curator.clone()).into(),
+			bounty_setup.bounty_id,
+			bounty_setup.child_bounty_value,
+			bounty_setup.reason.clone(),
+		)?;
+		let child_bounty_id = ChildBountyCount::<T>::get() - 1;
+
+	}: _(RawOrigin::Signed(bounty_setup.curator), bounty_setup.bounty_id,
+			child_bounty_id, child_curator_lookup, bounty_setup.child_bounty_fee)
+
+	accept_curator {
+		setup_pot_account::<T>();
+		let mut bounty_setup = activate_bounty::<T>(0, T::MaximumReasonLength::get())?;
+		let child_curator_lookup = T::Lookup::unlookup(bounty_setup.child_curator.clone());
+
+		ChildBounties::<T>::add_child_bounty(
+			RawOrigin::Signed(bounty_setup.curator.clone()).into(),
+			bounty_setup.bounty_id,
+			bounty_setup.child_bounty_value,
+			bounty_setup.reason.clone(),
+		)?;
+		bounty_setup.child_bounty_id = ChildBountyCount::<T>::get() - 1;
+
+		ChildBounties::<T>::propose_curator(
+			RawOrigin::Signed(bounty_setup.curator.clone()).into(),
+			bounty_setup.bounty_id,
+			bounty_setup.child_bounty_id,
+			child_curator_lookup.clone(),
+			bounty_setup.child_bounty_fee,
+		)?;
+	}: _(RawOrigin::Signed(bounty_setup.child_curator), bounty_setup.bounty_id,
+			bounty_setup.child_bounty_id)
+
+	// Worst case when curator is inactive and any sender un-assigns the curator.
+	unassign_curator {
+		setup_pot_account::<T>();
+		let bounty_setup = activate_child_bounty::<T>(0, T::MaximumReasonLength::get())?;
+		Bounties::<T>::on_initialize(T::BlockNumber::zero());
+		frame_system::Pallet::<T>::set_block_number(T::BountyUpdatePeriod::get() + 1u32.into());
+		let caller = whitelisted_caller();
+	}: _(RawOrigin::Signed(caller), bounty_setup.bounty_id,
+			bounty_setup.child_bounty_id)
+
+	award_child_bounty {
+		setup_pot_account::<T>();
+		let bounty_setup = activate_child_bounty::<T>(0, T::MaximumReasonLength::get())?;
+		let beneficiary_account: T::AccountId = account("beneficiary", 0, SEED);
+		let beneficiary = T::Lookup::unlookup(beneficiary_account.clone());
+	}: _(RawOrigin::Signed(bounty_setup.child_curator), bounty_setup.bounty_id,
+			bounty_setup.child_bounty_id, beneficiary)
+	verify {
+		assert_last_event::<T>(Event::Awarded {
+			index: bounty_setup.bounty_id,
+			child_index: bounty_setup.child_bounty_id,
+			beneficiary: beneficiary_account
+		}.into())
+	}
+
+	claim_child_bounty {
+		setup_pot_account::<T>();
+		let bounty_setup = activate_child_bounty::<T>(0, T::MaximumReasonLength::get())?;
+		let beneficiary_account: T::AccountId = account("beneficiary", 0, SEED);
+		let beneficiary = T::Lookup::unlookup(beneficiary_account.clone());
+
+		ChildBounties::<T>::award_child_bounty(
+			RawOrigin::Signed(bounty_setup.child_curator.clone()).into(),
+			bounty_setup.bounty_id,
+			bounty_setup.child_bounty_id,
+			beneficiary
+		)?;
+
+		let beneficiary_account: T::AccountId = account("beneficiary", 0, SEED);
+		let beneficiary = T::Lookup::unlookup(beneficiary_account.clone());
+
+		frame_system::Pallet::<T>::set_block_number(T::BountyDepositPayoutDelay::get());
+		ensure!(T::Currency::free_balance(&beneficiary_account).is_zero(),
+			"Beneficiary already has balance.");
+
+	}: _(RawOrigin::Signed(bounty_setup.curator), bounty_setup.bounty_id,
+			bounty_setup.child_bounty_id)
+	verify {
+		ensure!(!T::Currency::free_balance(&beneficiary_account).is_zero(),
+			"Beneficiary didn't get paid.");
+	}
+
+	// Best case scenario.
+	close_child_bounty_added {
+		setup_pot_account::<T>();
+		let mut bounty_setup = activate_bounty::<T>(0, T::MaximumReasonLength::get())?;
+
+		ChildBounties::<T>::add_child_bounty(
+			RawOrigin::Signed(bounty_setup.curator.clone()).into(),
+			bounty_setup.bounty_id,
+			bounty_setup.child_bounty_value,
+			bounty_setup.reason.clone(),
+		)?;
+		bounty_setup.child_bounty_id = ChildBountyCount::<T>::get() - 1;
+
+	}: close_child_bounty(RawOrigin::Root, bounty_setup.bounty_id,
+		bounty_setup.child_bounty_id)
+	verify {
+		assert_last_event::<T>(Event::Canceled {
+			index: bounty_setup.bounty_id,
+			child_index: bounty_setup.child_bounty_id
+		}.into())
+	}
+
+	// Worst case scenario.
+	close_child_bounty_active {
+		setup_pot_account::<T>();
+		let bounty_setup = activate_child_bounty::<T>(0, T::MaximumReasonLength::get())?;
+		Bounties::<T>::on_initialize(T::BlockNumber::zero());
+	}: close_child_bounty(RawOrigin::Root, bounty_setup.bounty_id, bounty_setup.child_bounty_id)
+	verify {
+		assert_last_event::<T>(Event::Canceled {
+			index: bounty_setup.bounty_id,
+			child_index: bounty_setup.child_bounty_id,
+		}.into())
+	}
+
+	impl_benchmark_test_suite!(ChildBounties, crate::tests::new_test_ext(), crate::tests::Test)
+}