pallet-bounties | Sub-bounties Extn

bin/node/runtime/src/lib.rs

@@ -664,6 +664,7 @@ parameter_types! {
 	pub const MaximumReasonLength: u32 = 16384;
 	pub const BountyCuratorDeposit: Permill = Permill::from_percent(50);
 	pub const BountyValueMinimum: Balance = 5 * DOLLARS;
+	pub const MaxActiveSubBountyCount: u32 = 10;
 }
 
 impl pallet_treasury::Config for Runtime {
@@ -699,6 +700,7 @@ impl pallet_bounties::Config for Runtime {
 	type BountyValueMinimum = BountyValueMinimum;
 	type DataDepositPerByte = DataDepositPerByte;
 	type MaximumReasonLength = MaximumReasonLength;
+	type MaxActiveSubBountyCount = MaxActiveSubBountyCount;
 	type WeightInfo = pallet_bounties::weights::SubstrateWeight<Runtime>;
 }
 

frame/bounties/README.md

@@ -21,9 +21,12 @@ payout is pending, resulting in the slash of the curator's deposit.
 
 - **Bounty spending proposal:** A proposal to reward a predefined body of work upon completion by
   the Treasury.
+- **SubBounty:** A large chunk of bounty proposal can be subdivided into small chunks as
+  independent subbounties, for parallel execution, minimise the workload on council governance
+  & tracking spended funds.
 - **Proposer:** An account proposing a bounty spending.
-- **Curator:** An account managing the bounty and assigning a payout address receiving the reward
-  for the completion of work.
+- **Curator or Master Curator or Sub Curator:** An account managing the bounty or subbounty
+  and assigning a payout address receiving the reward for the completion of work.
 - **Deposit:** The amount held on deposit for placing a bounty proposal plus the amount held on
   deposit per byte within the bounty description.
 - **Curator deposit:** The payment from a candidate willing to curate an approved bounty. The
@@ -50,3 +53,13 @@ Bounty protocol:
 - `claim_bounty` - Claim a specific bounty amount from the Payout Address.
 - `unassign_curator` - Unassign an accepted curator from a specific earmark.
 - `close_bounty` - Cancel the earmark for a specific treasury amount and close the bounty.
+- `add_subbounty` - Master curator may break or deligate the execution of bounty,
+   by adding new subbounty, with amount which can be deducted from parent bounty.
+- `propose_subcurator` - Master curator may assign an account to a subbouty
+   as candidate subcurator.
+- `accept_subcurator` - Accept a subbounty assignment from the Master curator,
+   setting a subcurator deposit.
+- `unassign_subcurator` - Unassign an accepted subcurator from a specific earmark.
+- `award_subbounty` - Close and specify the subbouty payout benefiiary address.
+- `claim_subbounty` - Claim a payout amount & subcurator fee for specific subbounty.
+- `close_subbounty` - Cancel the earmark for a specific treasury amount and close the bounty.

frame/bounties/src/benchmarking.rs

@@ -91,6 +91,118 @@ fn assert_last_event<T: Config>(generic_event: <T as Config>::Event) {
 	assert_eq!(event, &system_event);
 }
 
+#[derive(Clone)]
+struct BenchmarkSubBountyConfig<T: Config> {
+	/// Bounty ID.
+	bounty_id: BountyIndex,
+	/// SubBounty ID.
+	subbounty_id: BountyIndex,
+	/// The account proposing it.
+	caller: T::AccountId,
+	/// The master curator account.
+	curator: T::AccountId,
+	/// The subcurator account.
+	subcurator: 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 subbounty is rewarded.
+	subbounty_value: BalanceOf<T>,
+	/// The subcurator fee. Included in value.
+	subbounty_fee: BalanceOf<T>,
+	/// Bounty description.
+	reason: Vec<u8>,
+}
+
+fn setup_subbounty<T: Config>(u: u32, d: u32) -> BenchmarkSubBountyConfig::<T> {
+	let (caller, curator, fee, value, reason) = setup_bounty::<T>(u, d);
+	let subcurator = account("subcurator", u, SEED);
+	let _ = T::Currency::make_free_balance_be(&subcurator, fee / 2u32.into());
+	let subbounty_value = (value - fee) / 4u32.into();
+	let subbounty_fee = subbounty_value / 2u32.into();
+
+	BenchmarkSubBountyConfig::<T> {
+		bounty_id: 0,
+		subbounty_id: 0,
+		caller: caller,
+		curator: curator,
+		subcurator: subcurator,
+		value: value,
+		fee: fee,
+		subbounty_value: subbounty_value,
+		subbounty_fee: subbounty_fee,
+		reason: reason,
+	}
+}
+
+fn create_subbounty_bounty<T: Config>(u: u32, d: u32) -> Result<
+	BenchmarkSubBountyConfig::<T>,
+	&'static str
+> {
+	let mut bm_setup = setup_subbounty::<T>(u, d);
+	let curator_lookup = T::Lookup::unlookup(bm_setup.curator.clone());
+	Bounties::<T>::propose_bounty(
+		RawOrigin::Signed(bm_setup.caller.clone()).into(),
+		bm_setup.value,
+		bm_setup.reason.clone()
+	)?;
+	bm_setup.bounty_id = BountyCount::get() - 1;
+	Bounties::<T>::approve_bounty(
+		RawOrigin::Root.into(),
+		bm_setup.bounty_id,
+	)?;
+	Treasury::<T>::on_initialize(T::BlockNumber::zero());
+	Bounties::<T>::propose_curator(
+		RawOrigin::Root.into(),
+		bm_setup.bounty_id,
+		curator_lookup.clone(),
+		bm_setup.fee,
+	)?;
+	Bounties::<T>::accept_curator(
+		RawOrigin::Signed(bm_setup.curator.clone()).into(),
+		bm_setup.bounty_id,
+	)?;
+
+	Ok(bm_setup)
+}
+
+fn create_subbounty<T: Config>(u: u32, d: u32) -> Result<
+	BenchmarkSubBountyConfig::<T>,
+	&'static str
+> {
+	let mut bm_setup = create_subbounty_bounty::<T>(u, d)?;
+
+	let subcurator_lookup = T::Lookup::unlookup(
+		bm_setup.subcurator.clone()
+	);
+
+	Bounties::<T>::add_subbounty(
+		RawOrigin::Signed(bm_setup.curator.clone()).into(),
+		bm_setup.bounty_id,
+		bm_setup.subbounty_value,
+		bm_setup.reason.clone(),
+	)?;
+
+	bm_setup.subbounty_id = BountyCount::get() - 1;
+
+	Bounties::<T>::propose_subcurator(
+		RawOrigin::Signed(bm_setup.curator.clone()).into(),
+		bm_setup.bounty_id,
+		bm_setup.subbounty_id,
+		subcurator_lookup.clone(),
+		bm_setup.subbounty_fee,
+	)?;
+
+	Bounties::<T>::accept_subcurator(
+		RawOrigin::Signed(bm_setup.subcurator.clone()).into(),
+		bm_setup.bounty_id,
+		bm_setup.subbounty_id,
+	)?;
+
+	Ok(bm_setup)
+}
+
 const MAX_BYTES: u32 = 16384;
 
 benchmarks! {
@@ -218,6 +330,114 @@ benchmarks! {
 		ensure!(missed_any == false, "Missed some");
 		assert_last_event::<T>(RawEvent::BountyBecameActive(b - 1).into())
 	}
+
+	add_subbounty {
+		let d in 0 .. MAX_BYTES;
+		setup_pot_account::<T>();
+
+		let bm_setup = create_subbounty_bounty::<T>(0, d)?;
+
+	}: _(RawOrigin::Signed(bm_setup.curator), bm_setup.bounty_id, bm_setup.subbounty_value, bm_setup.reason)
+
+	propose_subcurator {
+		setup_pot_account::<T>();
+
+		let mut bm_setup = create_subbounty_bounty::<T>(0, MAX_BYTES)?;
+
+		let subcurator_lookup = T::Lookup::unlookup(bm_setup.subcurator.clone());
+		Bounties::<T>::add_subbounty(
+			RawOrigin::Signed(bm_setup.curator.clone()).into(),
+			bm_setup.bounty_id,
+			bm_setup.subbounty_value,
+			bm_setup.reason.clone(),
+		)?;
+		bm_setup.subbounty_id = BountyCount::get() - 1;
+	}: _(RawOrigin::Signed(bm_setup.curator), bm_setup.bounty_id, bm_setup.subbounty_id, subcurator_lookup, bm_setup.subbounty_fee)
+
+	unassign_subcurator {
+		setup_pot_account::<T>();
+
+		let bm_setup = create_subbounty::<T>(0, MAX_BYTES)?;
+		Bounties::<T>::on_initialize(T::BlockNumber::zero());
+		frame_system::Module::<T>::set_block_number(T::BountyUpdatePeriod::get() + 1u32.into());
+		let caller = whitelisted_caller();
+	}: _(RawOrigin::Signed(caller), bm_setup.bounty_id, bm_setup.subbounty_id)
+
+	accept_subcurator {
+		setup_pot_account::<T>();
+
+		let mut bm_setup = create_subbounty_bounty::<T>(0, MAX_BYTES)?;
+
+		let subcurator_lookup = T::Lookup::unlookup(bm_setup.subcurator.clone());
+
+		Bounties::<T>::add_subbounty(
+			RawOrigin::Signed(bm_setup.curator.clone()).into(),
+			bm_setup.bounty_id,
+			bm_setup.subbounty_value,
+			bm_setup.reason.clone(),
+		)?;
+
+		bm_setup.subbounty_id = BountyCount::get() - 1;
+
+		Bounties::<T>::propose_subcurator(
+			RawOrigin::Signed(bm_setup.curator.clone()).into(),
+			bm_setup.bounty_id,
+			bm_setup.subbounty_id,
+			subcurator_lookup,
+			bm_setup.subbounty_fee,
+		)?;
+	}: _(RawOrigin::Signed(bm_setup.subcurator), bm_setup.bounty_id, bm_setup.subbounty_id)
+
+	award_subbounty {
+		setup_pot_account::<T>();
+		let bm_setup = create_subbounty::<T>(0, MAX_BYTES)?;
+		let beneficiary = T::Lookup::unlookup(account("beneficiary", 0, SEED));
+	}: _(RawOrigin::Signed(bm_setup.subcurator), bm_setup.bounty_id, bm_setup.subbounty_id, beneficiary)
+
+	claim_subbounty {
+		setup_pot_account::<T>();
+
+		let bm_setup = create_subbounty::<T>(0, MAX_BYTES)?;
+
+		let beneficiary_account: T::AccountId = account("beneficiary", 0, SEED);
+		let beneficiary = T::Lookup::unlookup(beneficiary_account.clone());
+
+		Bounties::<T>::award_subbounty(
+			RawOrigin::Signed(bm_setup.subcurator.clone()).into(),
+			bm_setup.bounty_id,
+			bm_setup.subbounty_id,
+			beneficiary,
+		)?;
+
+		frame_system::Module::<T>::set_block_number(T::BountyDepositPayoutDelay::get());
+		ensure!(
+			T::Currency::free_balance(&beneficiary_account).is_zero(),
+			"Beneficiary already has balance"
+		);
+	}: _(RawOrigin::Signed(bm_setup.curator), bm_setup.bounty_id, bm_setup.subbounty_id)
+	verify {
+		ensure!(
+			!T::Currency::free_balance(&beneficiary_account).is_zero(),
+			"Beneficiary didn't get paid"
+		);
+	}
+
+	close_subbounty {
+		setup_pot_account::<T>();
+
+		let bm_setup = create_subbounty::<T>(0, MAX_BYTES)?;
+
+		Bounties::<T>::on_initialize(T::BlockNumber::zero());
+
+	}: _(RawOrigin::Root, bm_setup.bounty_id, bm_setup.subbounty_id)
+	verify {
+		assert_last_event::<T>(
+			RawEvent::SubBountyCanceled(
+				bm_setup.bounty_id,
+				bm_setup.subbounty_id,
+			).into()
+		)
+	}
 }
 
 #[cfg(test)]
@@ -240,6 +460,13 @@ mod tests {
 			assert_ok!(test_benchmark_close_bounty_active::<Test>());
 			assert_ok!(test_benchmark_extend_bounty_expiry::<Test>());
 			assert_ok!(test_benchmark_spend_funds::<Test>());
+			assert_ok!(test_benchmark_add_subbounty::<Test>());
+			assert_ok!(test_benchmark_propose_subcurator::<Test>());
+			assert_ok!(test_benchmark_accept_subcurator::<Test>());
+			assert_ok!(test_benchmark_unassign_subcurator::<Test>());
+			assert_ok!(test_benchmark_award_subbounty::<Test>());
+			assert_ok!(test_benchmark_claim_subbounty::<Test>());
+			assert_ok!(test_benchmark_close_subbounty::<Test>());
 		});
 	}
 }