Struct pallet_child_bounties::pallet::Pallet

pub struct Pallet<T>(_);

The pallet implementing the on-chain logic.

Implementations

impl<T: Config> Pallet<T>

pub fn add_child_bounty(
    origin: OriginFor<T>,
    parent_bounty_id: BountyIndex,
    value: BalanceOf<T>,
    description: Vec<u8>
) -> DispatchResult

Add a new child-bounty.

The dispatch origin for this call must be the curator of parent bounty and the parent bounty must be in “active” state.

Child-bounty gets added successfully & fund gets transferred from parent bounty to child-bounty account, if parent bounty has enough funds, else the call fails.

Upper bound to maximum number of active child bounties that can be added are managed via runtime trait config Config::MaxActiveChildBountyCount.

If the call is success, the status of child-bounty is updated to “Added”.

• parent_bounty_id: Index of parent bounty for which child-bounty is being added.
• value: Value for executing the proposal.
• description: Text description for the child-bounty.

pub fn propose_curator(
    origin: OriginFor<T>,
    parent_bounty_id: BountyIndex,
    child_bounty_id: BountyIndex,
    curator: <<T as Config>::Lookup as StaticLookup>::Source,
    fee: BalanceOf<T>
) -> DispatchResult

Propose curator for funded child-bounty.

The dispatch origin for this call must be curator of parent bounty.

Parent bounty must be in active state, for this child-bounty call to work.

Child-bounty must be in “Added” state, for processing the call. And state of child-bounty is moved to “CuratorProposed” on successful call completion.

• parent_bounty_id: Index of parent bounty.
• child_bounty_id: Index of child bounty.
• curator: Address of child-bounty curator.
• fee: payment fee to child-bounty curator for execution.

pub fn accept_curator(
    origin: OriginFor<T>,
    parent_bounty_id: BountyIndex,
    child_bounty_id: BountyIndex
) -> DispatchResult

Accept the curator role for the child-bounty.

The dispatch origin for this call must be the curator of this child-bounty.

A deposit will be reserved from the curator and refund upon successful payout or cancellation.

Fee for curator is deducted from curator fee of parent bounty.

Parent bounty must be in active state, for this child-bounty call to work.

Child-bounty must be in “CuratorProposed” state, for processing the call. And state of child-bounty is moved to “Active” on successful call completion.

• parent_bounty_id: Index of parent bounty.
• child_bounty_id: Index of child bounty.

pub fn unassign_curator(
    origin: OriginFor<T>,
    parent_bounty_id: BountyIndex,
    child_bounty_id: BountyIndex
) -> DispatchResult

Unassign curator from a child-bounty.

The dispatch origin for this call can be either RejectOrigin, or the curator of the parent bounty, or any signed origin.

For the origin other than T::RejectOrigin and the child-bounty curator, parent bounty must be in active state, for this call to work. We allow child-bounty curator and T::RejectOrigin to execute this call irrespective of the parent bounty state.

If this function is called by the RejectOrigin or the parent bounty curator, we assume that the child-bounty curator is malicious or inactive. As a result, child-bounty curator deposit is slashed.

If the origin is the child-bounty curator, we take this as a sign that they are unable to do their job, and are willingly giving up. We could slash the deposit, but for now we allow them to unreserve their deposit and exit without issue. (We may want to change this if it is abused.)

Finally, the origin can be anyone iff the child-bounty curator is “inactive”. Expiry update due of parent bounty is used to estimate inactive state of child-bounty curator.

This allows anyone in the community to call out that a child-bounty curator is not doing their due diligence, and we should pick a new one. In this case the child-bounty curator deposit is slashed.

State of child-bounty is moved to Added state on successful call completion.

• parent_bounty_id: Index of parent bounty.
• child_bounty_id: Index of child bounty.

pub fn award_child_bounty(
    origin: OriginFor<T>,
    parent_bounty_id: BountyIndex,
    child_bounty_id: BountyIndex,
    beneficiary: <<T as Config>::Lookup as StaticLookup>::Source
) -> DispatchResult

Award child-bounty to a beneficiary.

The beneficiary will be able to claim the funds after a delay.

The dispatch origin for this call must be the parent curator or curator of this child-bounty.

Parent bounty must be in active state, for this child-bounty call to work.

Child-bounty must be in active state, for processing the call. And state of child-bounty is moved to “PendingPayout” on successful call completion.

• parent_bounty_id: Index of parent bounty.
• child_bounty_id: Index of child bounty.
• beneficiary: Beneficiary account.

pub fn claim_child_bounty(
    origin: OriginFor<T>,
    parent_bounty_id: BountyIndex,
    child_bounty_id: BountyIndex
) -> DispatchResult

Claim the payout from an awarded child-bounty after payout delay.

The dispatch origin for this call may be any signed origin.

Call works independent of parent bounty state, No need for parent bounty to be in active state.

The Beneficiary is paid out with agreed bounty value. Curator fee is paid & curator deposit is unreserved.

Child-bounty must be in “PendingPayout” state, for processing the call. And instance of child-bounty is removed from the state on successful call completion.

• parent_bounty_id: Index of parent bounty.
• child_bounty_id: Index of child bounty.

pub fn close_child_bounty(
    origin: OriginFor<T>,
    parent_bounty_id: BountyIndex,
    child_bounty_id: BountyIndex
) -> DispatchResult

Cancel a proposed or active child-bounty. Child-bounty account funds are transferred to parent bounty account. The child-bounty curator deposit may be unreserved if possible.

The dispatch origin for this call must be either parent curator or T::RejectOrigin.

If the state of child-bounty is Active, curator deposit is unreserved.

If the state of child-bounty is PendingPayout, call fails & returns PendingPayout error.

For the origin other than T::RejectOrigin, parent bounty must be in active state, for this child-bounty call to work. For origin T::RejectOrigin execution is forced.

Instance of child-bounty is removed from the state on successful call completion.

• parent_bounty_id: Index of parent bounty.
• child_bounty_id: Index of child bounty.

impl<T: Config> Pallet<T>

pub fn child_bounty_count() -> BountyIndex

Number of total child bounties.

impl<T: Config> Pallet<T>

pub fn parent_child_bounties<KArg>(k: KArg) -> u32where
    KArg: EncodeLike<BountyIndex>,

Number of child bounties per parent bounty. Map of parent bounty index to number of child bounties.

impl<T: Config> Pallet<T>

pub fn child_bounties<KArg1, KArg2>(
    k1: KArg1,
    k2: KArg2
) -> Option<ChildBounty<T::AccountId, BalanceOf<T>, T::BlockNumber>>where
    KArg1: EncodeLike<BountyIndex>,
    KArg2: EncodeLike<BountyIndex>,

Child bounties that have been added.

impl<T: Config> Pallet<T>

pub fn child_bounty_descriptions<KArg>(
    k: KArg
) -> Option<BoundedVec<u8, T::MaximumReasonLength>>where
    KArg: EncodeLike<BountyIndex>,

The description of each child-bounty.

impl<T: Config> Pallet<T>

pub fn children_curator_fees<KArg>(k: KArg) -> BalanceOf<T>where
    KArg: EncodeLike<BountyIndex>,

The cumulative child-bounty curator fee for each parent bounty.

impl<T: Config> Pallet<T>

pub fn child_bounty_account_id(id: BountyIndex) -> T::AccountId

The account ID of a child-bounty account.

Trait Implementations

impl<T> Benchmarking for Pallet<T>where
    T: Config + Config,

fn benchmarks(extra: bool) -> Vec<BenchmarkMetadata>

Get the benchmarks available for this pallet. Generally there is one benchmark per extrinsic, so these are sometimes just called “extrinsics”.

fn run_benchmark(
    extrinsic: &[u8],
    c: &[(BenchmarkParameter, u32)],
    whitelist: &[TrackedStorageKey],
    verify: bool,
    internal_repeats: u32
) -> Result<Vec<BenchmarkResult>, BenchmarkError>

Run the benchmarks for this pallet.

impl<T: Config> Callable<T> for Pallet<T>

type Call = Call<T>

impl<T: Config> ChildBountyManager<<<T as Config<()>>::Currency as Currency<<T as Config>::AccountId>>::Balance> for Pallet<T>

fn child_bounties_count(bounty_id: BountyIndex) -> BountyIndex

Get the active child bounties for a parent bounty.

fn children_curator_fees(bounty_id: BountyIndex) -> BalanceOf<T>

Get total curator fees of children-bounty curators.

impl<T> Clone for Pallet<T>

fn clone(&self) -> Self

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<T> Debug for Pallet<T>

fn fmt(&self, fmt: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<T: Config> GetStorageVersion for Pallet<T>

fn current_storage_version() -> StorageVersion

Returns the current storage version as supported by the pallet.

fn on_chain_storage_version() -> StorageVersion

Returns the on-chain storage version of the pallet as stored in the storage.

impl<T: Config> Hooks<<T as Config>::BlockNumber> for Pallet<T>

fn on_finalize(_n: BlockNumber)

The block is being finalized. Implement to have something happen.

fn on_idle(_n: BlockNumber, _remaining_weight: Weight) -> Weight

This will be run when the block is being finalized (before on_finalize). Implement to have something happen using the remaining weight. Will not fire if the remaining weight is 0. Return the weight used, the hook will subtract it from current weight used and pass the result to the next on_idle hook if it exists.

fn on_initialize(_n: BlockNumber) -> Weight

The block is being initialized. Implement to have something happen.

fn on_runtime_upgrade() -> Weight

Perform a module upgrade.

fn try_state(_n: BlockNumber) -> Result<(), &'static str>

Execute the sanity checks of this pallet, per block.

fn pre_upgrade() -> Result<(), &'static str>

Execute some pre-checks prior to a runtime upgrade.

fn post_upgrade() -> Result<(), &'static str>

Execute some post-checks after a runtime upgrade.

fn offchain_worker(_n: BlockNumber)

Implementing this function on a module allows you to perform long-running tasks that make (by default) validators generate transactions that feed results of those long-running computations back on chain.

fn integrity_test()

Run integrity test.

impl<T: Config> IntegrityTest for Pallet<T>

fn integrity_test()

Run integrity test.

impl<T: Config> OffchainWorker<<T as Config>::BlockNumber> for Pallet<T>

fn offchain_worker(n: <T as Config>::BlockNumber)

This function is being called after every block import (when fully synced).

impl<T: Config> OnFinalize<<T as Config>::BlockNumber> for Pallet<T>

fn on_finalize(n: <T as Config>::BlockNumber)

The block is being finalized. Implement to have something happen.

impl<T: Config> OnGenesis for Pallet<T>

fn on_genesis()

Something that should happen at genesis.

impl<T: Config> OnIdle<<T as Config>::BlockNumber> for Pallet<T>

fn on_idle(n: <T as Config>::BlockNumber, remaining_weight: Weight) -> Weight

The block is being finalized. Implement to have something happen in case there is leftover weight. Check the passed remaining_weight to make sure it is high enough to allow for your pallet’s extra computation.

impl<T: Config> OnInitialize<<T as Config>::BlockNumber> for Pallet<T>

fn on_initialize(n: <T as Config>::BlockNumber) -> Weight

The block is being initialized. Implement to have something happen.

impl<T: Config> OnRuntimeUpgrade for Pallet<T>

fn on_runtime_upgrade() -> Weight

Perform a module upgrade.

fn pre_upgrade() -> Result<(), &'static str>

Execute some pre-checks prior to a runtime upgrade.

fn post_upgrade() -> Result<(), &'static str>

Execute some post-checks after a runtime upgrade.

impl<T: Config> PalletInfoAccess for Pallet<T>

fn index() -> usize

Index of the pallet as configured in the runtime.

fn name() -> &'static str

Name of the pallet as configured in the runtime.

fn module_name() -> &'static str

Name of the Rust module containing the pallet.

fn crate_version() -> CrateVersion

Version of the crate containing the pallet.

impl<T: Config> PalletsInfoAccess for Pallet<T>

fn count() -> usize

The number of pallets’ information that this type represents.

fn infos() -> Vec<PalletInfoData>

All of the pallets’ information that this type represents.

impl<T> PartialEq<Pallet<T>> for Pallet<T>

fn eq(&self, other: &Self) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<T: Config> StorageInfoTrait for Pallet<T>

fn storage_info() -> Vec<StorageInfo>

impl<T> Eq for Pallet<T>