Struct pallet_bounties::pallet::Pallet

pub struct Pallet<T, I = ()>(_);

The pallet implementing the on-chain logic.

Implementations

impl<T: Config<I>, I: 'static> Pallet<T, I>

pub fn propose_bounty(
    origin: OriginFor<T>,
    value: BalanceOf<T, I>,
    description: Vec<u8>
) -> DispatchResult

Propose a new bounty.

The dispatch origin for this call must be Signed.

Payment: TipReportDepositBase will be reserved from the origin account, as well as DataDepositPerByte for each byte in reason. It will be unreserved upon approval, or slashed when rejected.

• curator: The curator account whom will manage this bounty.
• fee: The curator fee.
• value: The total payment amount of this bounty, curator fee included.
• description: The description of this bounty.

pub fn approve_bounty(
    origin: OriginFor<T>,
    bounty_id: BountyIndex
) -> DispatchResult

Approve a bounty proposal. At a later time, the bounty will be funded and become active and the original deposit will be returned.

May only be called from T::SpendOrigin.

Complexity

• O(1).

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

Assign a curator to a funded bounty.

May only be called from T::SpendOrigin.

Complexity

• O(1).

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

Unassign curator from a bounty.

This function can only be called by the RejectOrigin a signed origin.

If this function is called by the RejectOrigin, we assume that the curator is malicious or inactive. As a result, we will slash the curator when possible.

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

Finally, the origin can be anyone if and only if the curator is “inactive”. This allows anyone in the community to call out that a curator is not doing their due diligence, and we should pick a new curator. In this case the curator should also be slashed.

Complexity

• O(1).

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

Accept the curator role for a bounty. A deposit will be reserved from curator and refund upon successful payout.

May only be called from the curator.

Complexity

• O(1).

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

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

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

• bounty_id: Bounty ID to award.
• beneficiary: The beneficiary account whom will receive the payout.

Complexity

• O(1).

pub fn claim_bounty(
    origin: OriginFor<T>,
    bounty_id: BountyIndex
) -> DispatchResult

Claim the payout from an awarded bounty after payout delay.

The dispatch origin for this call must be the beneficiary of this bounty.

• bounty_id: Bounty ID to claim.

Complexity

• O(1).

pub fn close_bounty(
    origin: OriginFor<T>,
    bounty_id: BountyIndex
) -> DispatchResultWithPostInfo

Cancel a proposed or active bounty. All the funds will be sent to treasury and the curator deposit will be unreserved if possible.

Only T::RejectOrigin is able to cancel a bounty.

• bounty_id: Bounty ID to cancel.

Complexity

• O(1).

pub fn extend_bounty_expiry(
    origin: OriginFor<T>,
    bounty_id: BountyIndex,
    _remark: Vec<u8>
) -> DispatchResult

Extend the expiry time of an active bounty.

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

• bounty_id: Bounty ID to extend.
• remark: additional information.

Complexity

• O(1).

impl<T: Config<I>, I: 'static> Pallet<T, I>

pub fn bounty_count() -> BountyIndex

Number of bounty proposals that have been made.

impl<T: Config<I>, I: 'static> Pallet<T, I>

pub fn bounties<KArg>(
    k: KArg
) -> Option<Bounty<T::AccountId, BalanceOf<T, I>, T::BlockNumber>>where
    KArg: EncodeLike<BountyIndex>,

Bounties that have been made.

impl<T: Config<I>, I: 'static> Pallet<T, I>

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

The description of each bounty.

impl<T: Config<I>, I: 'static> Pallet<T, I>

pub fn bounty_approvals() -> BoundedVec<BountyIndex, T::MaxApprovals>

Bounty indices that have been approved but not yet funded.

impl<T: Config<I>, I: 'static> Pallet<T, I>

pub fn calculate_curator_deposit(fee: &BalanceOf<T, I>) -> BalanceOf<T, I>

pub fn account_id() -> T::AccountId

The account ID of the treasury pot.

This actually does computation. If you need to keep using it, then make sure you cache the value and only call this once.

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

The account ID of a bounty account

Trait Implementations

impl<T: Config<I>, I: 'static> Callable<T> for Pallet<T, I>

type RuntimeCall = Call<T, I>

impl<T, I> Clone for Pallet<T, I>

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T, I> Debug for Pallet<T, I>

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

Formats the value using the given formatter.

impl<T: Config<I>, I: 'static> GetStorageVersion for Pallet<T, I>

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<I>, I: 'static> Hooks<<T as Config>::BlockNumber> for Pallet<T, I>

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 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<I>, I: 'static> IntegrityTest for Pallet<T, I>

fn integrity_test()

Run integrity test.

impl<T: Config<I>, I: 'static> OffchainWorker<<T as Config>::BlockNumber> for Pallet<T, I>

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

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

impl<T: Config<I>, I: 'static> OnFinalize<<T as Config>::BlockNumber> for Pallet<T, I>

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

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

impl<T: Config<I>, I: 'static> OnGenesis for Pallet<T, I>

fn on_genesis()

Something that should happen at genesis.

impl<T: Config<I>, I: 'static> OnIdle<<T as Config>::BlockNumber> for Pallet<T, I>

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<I>, I: 'static> OnInitialize<<T as Config>::BlockNumber> for Pallet<T, I>

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

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

impl<T: Config<I>, I: 'static> OnRuntimeUpgrade for Pallet<T, I>

fn on_runtime_upgrade() -> Weight

Perform a module upgrade.

impl<T: Config<I>, I: 'static> PalletInfoAccess for Pallet<T, I>

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<I>, I: 'static> PalletsInfoAccess for Pallet<T, I>

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, I> PartialEq<Pallet<T, I>> for Pallet<T, I>

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<I>, I: 'static> SpendFunds<T, I> for Pallet<T, I>

fn spend_funds(
    budget_remaining: &mut BalanceOf<T, I>,
    imbalance: &mut PositiveImbalanceOf<T, I>,
    total_weight: &mut Weight,
    missed_any: &mut bool
)

impl<T: Config<I>, I: 'static> StorageInfoTrait for Pallet<T, I>

fn storage_info() -> Vec<StorageInfo>

impl<T: Config<I>, I: 'static> WhitelistedStorageKeys for Pallet<T, I>

fn whitelisted_storage_keys() -> Vec<TrackedStorageKey>

Returns a Vec<TrackedStorageKey> indicating the storage keys that should be whitelisted during benchmarking. This means that those keys will be excluded from the benchmarking performance calculation.

impl<T, I> Eq for Pallet<T, I>