pallet-bounties | Sub-bounties Extn | Design Discussion Notes

[shamb0]

pallet-bounties | Sub-bounties Extn | Design Discussion Notes

Overview

API & Types

• Trait
  • type MaxSubBountyCount: u32
• Types
  • struct SubBounty [New Struct]
    • proposer: AccountId,
    • value: Balance,
    • curator: AccountId,
    • fee: Balance,
    • curator_deposit: Balance,
    • bond: Balance,
    • status: BountyStatus,
  • struct Bounty [Existing Struct Extn]
    • proposer: AccountId,
    • value: Balance,
    • fee: Balance,
    • curator_deposit: Balance,
    • bond: Balance,
    • status: BountyStatus,
    • subbountycount: BountyIndex,
    • activesubbounty: Vec,
• Error Code [Extn to Existing codes]
  • InsufficientBountyBalance,
  • SubBountyActive,
  • SubBountyMaxReached,
• Event [Extn to Existing events]
  • SubBountyApproved(BountyIndex, BountyIndex),
  • SubBountyAwarded(BountyIndex, BountyIndex, AccountId),
  • SubBountyClaimed(BountyIndex, BountyIndex, Balance, AccountId),
  • SubBountyRejected(BountyIndex, BountyIndex, Balance),
  • SubBountyCanceled(BountyIndex, BountyIndex),
  • SubBountyBecameActive(BountyIndex, BountyIndex),
  • SubBountyExtended(BountyIndex, BountyIndex),
• Storage [Extn to Existing DB fields]
  • SubBounties: double_map(bounty_id,subbounty_id) => Option,
  • SubBountyDescriptions: double_map(bounty_id,subbounty_id) => Option<Vec>,
  • SubBountyApprovals: Vec<(bounty_id,subbounty_id)>,
• Modules [Extn to Existing Extrincis]
  • add_subbounty(origin, bounty_id: BountyIndex, value: BalanceOf, description: Vec);
  • propose_subcurator(origin, bounty_id: BountyIndex, subbounty_id: BountyIndex, subcurator: <T::Lookup as StaticLookup>::Source, fee: BalanceOf);
  • accept_subcurator(origin, bounty_id: BountyIndex, subbounty_id: BountyIndex);
  • unassign_subcurator(origin, bounty_id: BountyIndex, subbounty_id: BountyIndex);
  • award_subbounty(origin, bounty_id: BountyIndex, subbounty_id: BountyIndex, beneficiary: <T::Lookup as StaticLookup>::Source);
  • claim_subbounty(origin, bounty_id: BountyIndex, subbounty_id: BountyIndex);
  • close_subbounty(origin, bounty_id: BountyIndex, subbounty_id: BountyIndex);
  • extend_subbounty_expiry(origin, bounty_id: BountyIndex, subbounty_id: BountyIndex, remark: Vec);

---

Quick Proto version

Plz find proto version of the implementation | #7965

• Proposed data types and api signatures may not be in right shape, may require review & cleanup.

• Grey part, where may need additional clarity, are marked with below tag. & current logic implemented based on blind assumption.

// TODO :: Have to recheck

---

DB

---

State

---

Reference discussion threads

• Treasury-pallet Bounty Extension · Issue #5713 · paritytech/substrate

• Post #86 | Reopening the discussion on Bounties and Treasury spending issues! Open questions

• Post #237 | A Final Check on Bounties' Development

• Post #151 | On Bounties Spending parameters - A Summary

[xlc]

• Types
  • struct SubBounty
    • proposer: AccountId,
      * Why do we need this?
    • value: Balance,
      • Why do we need this? This is required for bounty for the funding phase.
        * But there isn't any funding phase for sub-bounty and you can always query the sub-bounty account holding for the value
    • curator: AccountId,
    • fee: Balance,
    • curator_deposit: Balance,
    • bond: Balance,
      * No need to have this.
      * This is required for bounty because anyone can propose bounty and save data into BountyDescription.
      * But only approved curator can create sub-bounty which already have a slashable deposit so I don't think we will need BountyDescription deposit for sub-bounty
    • status: BountyStatus,
      * Should have enum SubBountyStatus
  • struct Bounty
    • proposer: AccountId,
    • value: Balance,
    • fee: Balance,
    • curator_deposit: Balance,
    • bond: Balance,
    • status: BountyStatus,
    • subbountycount: BountyIndex,
      * Do we need this? We can use BountyCount to generate sub-bounty id as well
    • activesubbounty: Vec,
      * Do we need this? It is possible to iterate SubBounties by bounty_id to fetch all sub-bounties for a particular bounty
• Storage [Extn to Existing DB fields]
  • SubBounties: double_map(bounty_id,subbounty_id) => Option<SubBounty>,
  • SubBountyDescriptions: double_map(bounty_id,subbounty_id) => Option,
    * No need to have this. Just reuse BountyDescriptions
  • SubBountyApprovals: Vec<(bounty_id,subbounty_id)>,
    * There is no approval / funding phase for subbounties so no need to have this
• Modules [Extn to Existing Extrincis]
  • add_subbounty(origin, bounty_id: BountyIndex, value: BalanceOf, description: Vec);
  • propose_subcurator(origin, bounty_id: BountyIndex, subbounty_id: BountyIndex, subcurator: <T::Lookup as StaticLookup>::Source, fee: BalanceOf);
  • accept_subcurator(origin, bounty_id: BountyIndex, subbounty_id: BountyIndex);
  • unassign_subcurator(origin, bounty_id: BountyIndex, subbounty_id: BountyIndex);
  • award_subbounty(origin, bounty_id: BountyIndex, subbounty_id: BountyIndex, beneficiary: <T::Lookup as StaticLookup>::Source);
  • claim_subbounty(origin, bounty_id: BountyIndex, subbounty_id: BountyIndex);
  • close_subbounty(origin, bounty_id: BountyIndex, subbounty_id: BountyIndex);
  • extend_subbounty_expiry(origin, bounty_id: BountyIndex, subbounty_id: BountyIndex, remark: Vec);
    * No need to have this as the expiry for sub-bounties are shared with the parent

To prevent abuse of BountyDescriptions by create large amount of sub-bounties with large BountyDescriptions for free, we should have a MaxSubBountyCount. We can have a activeSubBountyCount in struct Bounty to enforce that.

[shamb0]

Thanks Bryan, Good one. May be I shall make MaxSubBountyCount part of trait config.

[smisty]

[shamb0]

What are you people doing to me
…

Hi @smisty, its discussion thread, capturing some design input for pallet-bounties extn.
Not sure how it disturbed you. Could be accident, plz kindly ignore ...