mirror of
https://github.com/pezkuwichain/pezkuwi-subxt.git
synced 2026-05-30 07:01:03 +00:00
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>
This commit is contained in:
Gautam Dhameja
@@ -123,6 +123,15 @@ pub struct Bounty<AccountId, Balance, BlockNumber> {
|
||||
status: BountyStatus<AccountId, BlockNumber>,
|
||||
}
|
||||
|
||||
impl<AccountId: PartialEq + Clone + Ord + Default, Balance, BlockNumber: Clone>
|
||||
Bounty<AccountId, Balance, BlockNumber>
|
||||
{
|
||||
/// Getter for bounty status, to be used for child bounties.
|
||||
pub fn get_status(&self) -> BountyStatus<AccountId, BlockNumber> {
|
||||
self.status.clone()
|
||||
}
|
||||
}
|
||||
|
||||
/// The status of a bounty proposal.
|
||||
#[derive(Encode, Decode, Clone, PartialEq, Eq, RuntimeDebug, TypeInfo)]
|
||||
pub enum BountyStatus<AccountId, BlockNumber> {
|
||||
@@ -156,6 +165,15 @@ pub enum BountyStatus<AccountId, BlockNumber> {
|
||||
},
|
||||
}
|
||||
|
||||
/// The child-bounty manager.
|
||||
pub trait ChildBountyManager<Balance> {
|
||||
/// Get the active child-bounties for a parent bounty.
|
||||
fn child_bounties_count(bounty_id: BountyIndex) -> BountyIndex;
|
||||
|
||||
/// Get total curator fees of children-bounty curators.
|
||||
fn children_curator_fees(bounty_id: BountyIndex) -> Balance;
|
||||
}
|
||||
|
||||
#[frame_support::pallet]
|
||||
pub mod pallet {
|
||||
use super::*;
|
||||
@@ -202,6 +220,9 @@ pub mod pallet {
|
||||
|
||||
/// Weight information for extrinsics in this pallet.
|
||||
type WeightInfo: WeightInfo;
|
||||
|
||||
/// The child-bounty manager.
|
||||
type ChildBountyManager: ChildBountyManager<BalanceOf<Self>>;
|
||||
}
|
||||
|
||||
#[pallet::error]
|
||||
@@ -225,6 +246,8 @@ pub mod pallet {
|
||||
PendingPayout,
|
||||
/// The bounties cannot be claimed/closed because it's still in the countdown period.
|
||||
Premature,
|
||||
/// The bounty cannot be closed because it has active child-bounties.
|
||||
HasActiveChildBounty,
|
||||
}
|
||||
|
||||
#[pallet::event]
|
||||
@@ -512,6 +535,13 @@ pub mod pallet {
|
||||
|
||||
Bounties::<T>::try_mutate_exists(bounty_id, |maybe_bounty| -> DispatchResult {
|
||||
let mut bounty = maybe_bounty.as_mut().ok_or(Error::<T>::InvalidIndex)?;
|
||||
|
||||
// Ensure no active child-bounties before processing the call.
|
||||
ensure!(
|
||||
T::ChildBountyManager::child_bounties_count(bounty_id) == 0,
|
||||
Error::<T>::HasActiveChildBounty
|
||||
);
|
||||
|
||||
match &bounty.status {
|
||||
BountyStatus::Active { curator, .. } => {
|
||||
ensure!(signer == *curator, Error::<T>::RequireCurator);
|
||||
@@ -563,7 +593,15 @@ pub mod pallet {
|
||||
let payout = balance.saturating_sub(fee);
|
||||
let err_amount = T::Currency::unreserve(&curator, bounty.curator_deposit);
|
||||
debug_assert!(err_amount.is_zero());
|
||||
let res = T::Currency::transfer(&bounty_account, &curator, fee, AllowDeath); // should not fail
|
||||
|
||||
// Get total child-bounties curator fees, and subtract it from master curator
|
||||
// fee.
|
||||
let children_fee = T::ChildBountyManager::children_curator_fees(bounty_id);
|
||||
debug_assert!(children_fee <= fee);
|
||||
|
||||
let final_fee = fee.saturating_sub(children_fee);
|
||||
let res =
|
||||
T::Currency::transfer(&bounty_account, &curator, final_fee, AllowDeath); // should not fail
|
||||
debug_assert!(res.is_ok());
|
||||
let res =
|
||||
T::Currency::transfer(&bounty_account, &beneficiary, payout, AllowDeath); // should not fail
|
||||
@@ -609,6 +647,12 @@ pub mod pallet {
|
||||
|maybe_bounty| -> DispatchResultWithPostInfo {
|
||||
let bounty = maybe_bounty.as_ref().ok_or(Error::<T>::InvalidIndex)?;
|
||||
|
||||
// Ensure no active child-bounties before processing the call.
|
||||
ensure!(
|
||||
T::ChildBountyManager::child_bounties_count(bounty_id) == 0,
|
||||
Error::<T>::HasActiveChildBounty
|
||||
);
|
||||
|
||||
match &bounty.status {
|
||||
BountyStatus::Proposed => {
|
||||
// The reject origin would like to cancel a proposed bounty.
|
||||
@@ -813,3 +857,14 @@ impl<T: Config> pallet_treasury::SpendFunds<T> for Pallet<T> {
|
||||
*total_weight += <T as Config>::WeightInfo::spend_funds(bounties_len);
|
||||
}
|
||||
}
|
||||
|
||||
// Default impl for when ChildBounties is not being used in the runtime.
|
||||
impl<Balance: Zero> ChildBountyManager<Balance> for () {
|
||||
fn child_bounties_count(_bounty_id: BountyIndex) -> BountyIndex {
|
||||
Default::default()
|
||||
}
|
||||
|
||||
fn children_curator_fees(_bounty_id: BountyIndex) -> Balance {
|
||||
Zero::zero()
|
||||
}
|
||||
}
|
||||
|
||||
@@ -146,6 +146,7 @@ impl Config for Test {
|
||||
type DataDepositPerByte = DataDepositPerByte;
|
||||
type MaximumReasonLength = MaximumReasonLength;
|
||||
type WeightInfo = ();
|
||||
type ChildBountyManager = ();
|
||||
}
|
||||
|
||||
type TreasuryError = pallet_treasury::Error<Test>;
|
||||
|
||||
@@ -18,24 +18,24 @@
|
||||
//! Autogenerated weights for pallet_bounties
|
||||
//!
|
||||
//! THIS FILE WAS AUTO-GENERATED USING THE SUBSTRATE BENCHMARK CLI VERSION 4.0.0-dev
|
||||
//! DATE: 2021-08-07, STEPS: `50`, REPEAT: 20, LOW RANGE: `[]`, HIGH RANGE: `[]`
|
||||
//! DATE: 2021-11-19, STEPS: `50`, REPEAT: 20, LOW RANGE: `[]`, HIGH RANGE: `[]`
|
||||
//! EXECUTION: Some(Wasm), WASM-EXECUTION: Compiled, CHAIN: Some("dev"), DB CACHE: 128
|
||||
|
||||
// Executed Command:
|
||||
// target/release/substrate
|
||||
// ./target/release/substrate
|
||||
// benchmark
|
||||
// --chain=dev
|
||||
// --steps=50
|
||||
// --repeat=20
|
||||
// --pallet=pallet_bounties
|
||||
// --pallet
|
||||
// pallet_bounties
|
||||
// --extrinsic=*
|
||||
// --execution=wasm
|
||||
// --wasm-execution=compiled
|
||||
// --heap-pages=4096
|
||||
// --output=./frame/bounties/src/weights.rs
|
||||
// --output=./frame/bounties/src/
|
||||
// --template=./.maintain/frame-weight-template.hbs
|
||||
|
||||
|
||||
#![cfg_attr(rustfmt, rustfmt_skip)]
|
||||
#![allow(unused_parens)]
|
||||
#![allow(unused_imports)]
|
||||
@@ -61,87 +61,91 @@ pub trait WeightInfo {
|
||||
/// Weights for pallet_bounties using the Substrate node and recommended hardware.
|
||||
pub struct SubstrateWeight<T>(PhantomData<T>);
|
||||
impl<T: frame_system::Config> WeightInfo for SubstrateWeight<T> {
|
||||
// Storage: Treasury BountyCount (r:1 w:1)
|
||||
// Storage: Bounties BountyCount (r:1 w:1)
|
||||
// Storage: System Account (r:1 w:1)
|
||||
// Storage: Treasury BountyDescriptions (r:0 w:1)
|
||||
// Storage: Treasury Bounties (r:0 w:1)
|
||||
// Storage: Bounties BountyDescriptions (r:0 w:1)
|
||||
// Storage: Bounties Bounties (r:0 w:1)
|
||||
fn propose_bounty(d: u32, ) -> Weight {
|
||||
(44_482_000 as Weight)
|
||||
(58_161_000 as Weight)
|
||||
// Standard Error: 0
|
||||
.saturating_add((1_000 as Weight).saturating_mul(d as Weight))
|
||||
.saturating_add(T::DbWeight::get().reads(2 as Weight))
|
||||
.saturating_add(T::DbWeight::get().writes(4 as Weight))
|
||||
}
|
||||
// Storage: Treasury Bounties (r:1 w:1)
|
||||
// Storage: Treasury BountyApprovals (r:1 w:1)
|
||||
// Storage: Bounties Bounties (r:1 w:1)
|
||||
// Storage: Bounties BountyApprovals (r:1 w:1)
|
||||
fn approve_bounty() -> Weight {
|
||||
(11_955_000 as Weight)
|
||||
(20_000_000 as Weight)
|
||||
.saturating_add(T::DbWeight::get().reads(2 as Weight))
|
||||
.saturating_add(T::DbWeight::get().writes(2 as Weight))
|
||||
}
|
||||
// Storage: Treasury Bounties (r:1 w:1)
|
||||
// Storage: Bounties Bounties (r:1 w:1)
|
||||
fn propose_curator() -> Weight {
|
||||
(9_771_000 as Weight)
|
||||
(14_000_000 as Weight)
|
||||
.saturating_add(T::DbWeight::get().reads(1 as Weight))
|
||||
.saturating_add(T::DbWeight::get().writes(1 as Weight))
|
||||
}
|
||||
// Storage: Treasury Bounties (r:1 w:1)
|
||||
// Storage: Bounties Bounties (r:1 w:1)
|
||||
// Storage: System Account (r:1 w:1)
|
||||
fn unassign_curator() -> Weight {
|
||||
(40_683_000 as Weight)
|
||||
(62_000_000 as Weight)
|
||||
.saturating_add(T::DbWeight::get().reads(2 as Weight))
|
||||
.saturating_add(T::DbWeight::get().writes(2 as Weight))
|
||||
}
|
||||
// Storage: Treasury Bounties (r:1 w:1)
|
||||
// Storage: Bounties Bounties (r:1 w:1)
|
||||
// Storage: System Account (r:1 w:1)
|
||||
fn accept_curator() -> Weight {
|
||||
(36_390_000 as Weight)
|
||||
(55_000_000 as Weight)
|
||||
.saturating_add(T::DbWeight::get().reads(2 as Weight))
|
||||
.saturating_add(T::DbWeight::get().writes(2 as Weight))
|
||||
}
|
||||
// Storage: Treasury Bounties (r:1 w:1)
|
||||
// Storage: Bounties Bounties (r:1 w:1)
|
||||
// Storage: ChildBounties ParentChildBounties (r:1 w:0)
|
||||
fn award_bounty() -> Weight {
|
||||
(25_187_000 as Weight)
|
||||
.saturating_add(T::DbWeight::get().reads(1 as Weight))
|
||||
(46_000_000 as Weight)
|
||||
.saturating_add(T::DbWeight::get().reads(2 as Weight))
|
||||
.saturating_add(T::DbWeight::get().writes(1 as Weight))
|
||||
}
|
||||
// Storage: Treasury Bounties (r:1 w:1)
|
||||
// Storage: Bounties Bounties (r:1 w:1)
|
||||
// Storage: System Account (r:3 w:3)
|
||||
// Storage: Treasury BountyDescriptions (r:0 w:1)
|
||||
// Storage: ChildBounties ChildrenCuratorFees (r:1 w:1)
|
||||
// Storage: Bounties BountyDescriptions (r:0 w:1)
|
||||
fn claim_bounty() -> Weight {
|
||||
(124_785_000 as Weight)
|
||||
.saturating_add(T::DbWeight::get().reads(4 as Weight))
|
||||
.saturating_add(T::DbWeight::get().writes(5 as Weight))
|
||||
(185_000_000 as Weight)
|
||||
.saturating_add(T::DbWeight::get().reads(5 as Weight))
|
||||
.saturating_add(T::DbWeight::get().writes(6 as Weight))
|
||||
}
|
||||
// Storage: Treasury Bounties (r:1 w:1)
|
||||
// Storage: Bounties Bounties (r:1 w:1)
|
||||
// Storage: ChildBounties ParentChildBounties (r:1 w:0)
|
||||
// Storage: System Account (r:1 w:1)
|
||||
// Storage: Treasury BountyDescriptions (r:0 w:1)
|
||||
// Storage: Bounties BountyDescriptions (r:0 w:1)
|
||||
fn close_bounty_proposed() -> Weight {
|
||||
(39_483_000 as Weight)
|
||||
.saturating_add(T::DbWeight::get().reads(2 as Weight))
|
||||
(82_000_000 as Weight)
|
||||
.saturating_add(T::DbWeight::get().reads(3 as Weight))
|
||||
.saturating_add(T::DbWeight::get().writes(3 as Weight))
|
||||
}
|
||||
// Storage: Treasury Bounties (r:1 w:1)
|
||||
// Storage: Bounties Bounties (r:1 w:1)
|
||||
// Storage: ChildBounties ParentChildBounties (r:1 w:0)
|
||||
// Storage: System Account (r:2 w:2)
|
||||
// Storage: Treasury BountyDescriptions (r:0 w:1)
|
||||
// Storage: Bounties BountyDescriptions (r:0 w:1)
|
||||
fn close_bounty_active() -> Weight {
|
||||
(83_453_000 as Weight)
|
||||
.saturating_add(T::DbWeight::get().reads(3 as Weight))
|
||||
(137_000_000 as Weight)
|
||||
.saturating_add(T::DbWeight::get().reads(4 as Weight))
|
||||
.saturating_add(T::DbWeight::get().writes(4 as Weight))
|
||||
}
|
||||
// Storage: Treasury Bounties (r:1 w:1)
|
||||
// Storage: Bounties Bounties (r:1 w:1)
|
||||
fn extend_bounty_expiry() -> Weight {
|
||||
(24_151_000 as Weight)
|
||||
(33_000_000 as Weight)
|
||||
.saturating_add(T::DbWeight::get().reads(1 as Weight))
|
||||
.saturating_add(T::DbWeight::get().writes(1 as Weight))
|
||||
}
|
||||
// Storage: Treasury BountyApprovals (r:1 w:1)
|
||||
// Storage: Treasury Bounties (r:1 w:1)
|
||||
// Storage: Bounties BountyApprovals (r:1 w:1)
|
||||
// Storage: Bounties Bounties (r:1 w:1)
|
||||
// Storage: System Account (r:2 w:2)
|
||||
fn spend_funds(b: u32, ) -> Weight {
|
||||
(0 as Weight)
|
||||
// Standard Error: 16_000
|
||||
.saturating_add((58_004_000 as Weight).saturating_mul(b as Weight))
|
||||
// Standard Error: 191_000
|
||||
.saturating_add((81_116_000 as Weight).saturating_mul(b as Weight))
|
||||
.saturating_add(T::DbWeight::get().reads(1 as Weight))
|
||||
.saturating_add(T::DbWeight::get().reads((3 as Weight).saturating_mul(b as Weight)))
|
||||
.saturating_add(T::DbWeight::get().writes(1 as Weight))
|
||||
@@ -151,87 +155,91 @@ impl<T: frame_system::Config> WeightInfo for SubstrateWeight<T> {
|
||||
|
||||
// For backwards compatibility and tests
|
||||
impl WeightInfo for () {
|
||||
// Storage: Treasury BountyCount (r:1 w:1)
|
||||
// Storage: Bounties BountyCount (r:1 w:1)
|
||||
// Storage: System Account (r:1 w:1)
|
||||
// Storage: Treasury BountyDescriptions (r:0 w:1)
|
||||
// Storage: Treasury Bounties (r:0 w:1)
|
||||
// Storage: Bounties BountyDescriptions (r:0 w:1)
|
||||
// Storage: Bounties Bounties (r:0 w:1)
|
||||
fn propose_bounty(d: u32, ) -> Weight {
|
||||
(44_482_000 as Weight)
|
||||
(58_161_000 as Weight)
|
||||
// Standard Error: 0
|
||||
.saturating_add((1_000 as Weight).saturating_mul(d as Weight))
|
||||
.saturating_add(RocksDbWeight::get().reads(2 as Weight))
|
||||
.saturating_add(RocksDbWeight::get().writes(4 as Weight))
|
||||
}
|
||||
// Storage: Treasury Bounties (r:1 w:1)
|
||||
// Storage: Treasury BountyApprovals (r:1 w:1)
|
||||
// Storage: Bounties Bounties (r:1 w:1)
|
||||
// Storage: Bounties BountyApprovals (r:1 w:1)
|
||||
fn approve_bounty() -> Weight {
|
||||
(11_955_000 as Weight)
|
||||
(20_000_000 as Weight)
|
||||
.saturating_add(RocksDbWeight::get().reads(2 as Weight))
|
||||
.saturating_add(RocksDbWeight::get().writes(2 as Weight))
|
||||
}
|
||||
// Storage: Treasury Bounties (r:1 w:1)
|
||||
// Storage: Bounties Bounties (r:1 w:1)
|
||||
fn propose_curator() -> Weight {
|
||||
(9_771_000 as Weight)
|
||||
(14_000_000 as Weight)
|
||||
.saturating_add(RocksDbWeight::get().reads(1 as Weight))
|
||||
.saturating_add(RocksDbWeight::get().writes(1 as Weight))
|
||||
}
|
||||
// Storage: Treasury Bounties (r:1 w:1)
|
||||
// Storage: Bounties Bounties (r:1 w:1)
|
||||
// Storage: System Account (r:1 w:1)
|
||||
fn unassign_curator() -> Weight {
|
||||
(40_683_000 as Weight)
|
||||
(62_000_000 as Weight)
|
||||
.saturating_add(RocksDbWeight::get().reads(2 as Weight))
|
||||
.saturating_add(RocksDbWeight::get().writes(2 as Weight))
|
||||
}
|
||||
// Storage: Treasury Bounties (r:1 w:1)
|
||||
// Storage: Bounties Bounties (r:1 w:1)
|
||||
// Storage: System Account (r:1 w:1)
|
||||
fn accept_curator() -> Weight {
|
||||
(36_390_000 as Weight)
|
||||
(55_000_000 as Weight)
|
||||
.saturating_add(RocksDbWeight::get().reads(2 as Weight))
|
||||
.saturating_add(RocksDbWeight::get().writes(2 as Weight))
|
||||
}
|
||||
// Storage: Treasury Bounties (r:1 w:1)
|
||||
// Storage: Bounties Bounties (r:1 w:1)
|
||||
// Storage: ChildBounties ParentChildBounties (r:1 w:0)
|
||||
fn award_bounty() -> Weight {
|
||||
(25_187_000 as Weight)
|
||||
.saturating_add(RocksDbWeight::get().reads(1 as Weight))
|
||||
(46_000_000 as Weight)
|
||||
.saturating_add(RocksDbWeight::get().reads(2 as Weight))
|
||||
.saturating_add(RocksDbWeight::get().writes(1 as Weight))
|
||||
}
|
||||
// Storage: Treasury Bounties (r:1 w:1)
|
||||
// Storage: Bounties Bounties (r:1 w:1)
|
||||
// Storage: System Account (r:3 w:3)
|
||||
// Storage: Treasury BountyDescriptions (r:0 w:1)
|
||||
// Storage: ChildBounties ChildrenCuratorFees (r:1 w:1)
|
||||
// Storage: Bounties BountyDescriptions (r:0 w:1)
|
||||
fn claim_bounty() -> Weight {
|
||||
(124_785_000 as Weight)
|
||||
.saturating_add(RocksDbWeight::get().reads(4 as Weight))
|
||||
.saturating_add(RocksDbWeight::get().writes(5 as Weight))
|
||||
(185_000_000 as Weight)
|
||||
.saturating_add(RocksDbWeight::get().reads(5 as Weight))
|
||||
.saturating_add(RocksDbWeight::get().writes(6 as Weight))
|
||||
}
|
||||
// Storage: Treasury Bounties (r:1 w:1)
|
||||
// Storage: Bounties Bounties (r:1 w:1)
|
||||
// Storage: ChildBounties ParentChildBounties (r:1 w:0)
|
||||
// Storage: System Account (r:1 w:1)
|
||||
// Storage: Treasury BountyDescriptions (r:0 w:1)
|
||||
// Storage: Bounties BountyDescriptions (r:0 w:1)
|
||||
fn close_bounty_proposed() -> Weight {
|
||||
(39_483_000 as Weight)
|
||||
.saturating_add(RocksDbWeight::get().reads(2 as Weight))
|
||||
(82_000_000 as Weight)
|
||||
.saturating_add(RocksDbWeight::get().reads(3 as Weight))
|
||||
.saturating_add(RocksDbWeight::get().writes(3 as Weight))
|
||||
}
|
||||
// Storage: Treasury Bounties (r:1 w:1)
|
||||
// Storage: Bounties Bounties (r:1 w:1)
|
||||
// Storage: ChildBounties ParentChildBounties (r:1 w:0)
|
||||
// Storage: System Account (r:2 w:2)
|
||||
// Storage: Treasury BountyDescriptions (r:0 w:1)
|
||||
// Storage: Bounties BountyDescriptions (r:0 w:1)
|
||||
fn close_bounty_active() -> Weight {
|
||||
(83_453_000 as Weight)
|
||||
.saturating_add(RocksDbWeight::get().reads(3 as Weight))
|
||||
(137_000_000 as Weight)
|
||||
.saturating_add(RocksDbWeight::get().reads(4 as Weight))
|
||||
.saturating_add(RocksDbWeight::get().writes(4 as Weight))
|
||||
}
|
||||
// Storage: Treasury Bounties (r:1 w:1)
|
||||
// Storage: Bounties Bounties (r:1 w:1)
|
||||
fn extend_bounty_expiry() -> Weight {
|
||||
(24_151_000 as Weight)
|
||||
(33_000_000 as Weight)
|
||||
.saturating_add(RocksDbWeight::get().reads(1 as Weight))
|
||||
.saturating_add(RocksDbWeight::get().writes(1 as Weight))
|
||||
}
|
||||
// Storage: Treasury BountyApprovals (r:1 w:1)
|
||||
// Storage: Treasury Bounties (r:1 w:1)
|
||||
// Storage: Bounties BountyApprovals (r:1 w:1)
|
||||
// Storage: Bounties Bounties (r:1 w:1)
|
||||
// Storage: System Account (r:2 w:2)
|
||||
fn spend_funds(b: u32, ) -> Weight {
|
||||
(0 as Weight)
|
||||
// Standard Error: 16_000
|
||||
.saturating_add((58_004_000 as Weight).saturating_mul(b as Weight))
|
||||
// Standard Error: 191_000
|
||||
.saturating_add((81_116_000 as Weight).saturating_mul(b as Weight))
|
||||
.saturating_add(RocksDbWeight::get().reads(1 as Weight))
|
||||
.saturating_add(RocksDbWeight::get().reads((3 as Weight).saturating_mul(b as Weight)))
|
||||
.saturating_add(RocksDbWeight::get().writes(1 as Weight))
|
||||
|
||||
Reference in New Issue
Block a user