Struct Pallet

pub struct Pallet<T, I = ()>(/* private fields */);

The Pallet struct, the main type that implements traits and standalone functions within the pallet.

Implementations

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

pub fn fund_bounty( origin: OriginFor<T>, asset_kind: Box<T::AssetKind>, value: T::Balance, curator: AccountIdLookupOf<T>, metadata: T::Hash, ) -> DispatchResult

Fund a new bounty with a proposed curator, initiating the payment from the funding source to the bounty account/location.

Dispatch Origin

Must be Config::SpendOrigin with the Success value being at least the bounty value converted to native balance using Config::BalanceConverter. The converted native amount is validated against the maximum spendable amount returned by Config::SpendOrigin.

Details

• The SpendOrigin must have sufficient permissions to fund the bounty.
• The bounty value (in asset balance) is converted to native balance for validation.
• In case of a funding failure, the bounty status must be updated with the check_status call before retrying with retry_payment call.

Parameters

• asset_kind: An indicator of the specific asset class to be funded.
• value: The total payment amount of this bounty.
• curator: Address of bounty curator.
• metadata: The hash of an on-chain stored preimage with bounty metadata.

Events

Emits Event::BountyCreated and Event::Paid if successful.

pub fn fund_child_bounty( origin: OriginFor<T>, parent_bounty_id: BountyIndex, value: T::Balance, metadata: T::Hash, curator: Option<AccountIdLookupOf<T>>, ) -> DispatchResult

Fund a new child-bounty with a proposed curator, initiating the payment from the parent bounty to the child-bounty account/location.

Dispatch Origin

Must be signed by the parent curator.

Details

• If curator is not provided, the child-bounty will default to using the parent curator, allowing the parent curator to immediately call check_status and award_bounty to payout the child-bounty.
• In case of a funding failure, the child-/bounty status must be updated with the check_status call before retrying with retry_payment call.

Parameters

• parent_bounty_id: Index of parent bounty for which child-bounty is being added.
• value: The payment amount of this child-bounty.
• metadata: The hash of an on-chain stored preimage with child-bounty metadata.
• curator: Address of child-bounty curator.

Events

Emits Event::ChildBountyCreated and Event::Paid if successful.

pub fn propose_curator( origin: OriginFor<T>, parent_bounty_id: BountyIndex, child_bounty_id: Option<BountyIndex>, curator: AccountIdLookupOf<T>, ) -> DispatchResult

Propose a new curator for a child-/bounty after the previous was unassigned.

Dispatch Origin

Must be signed by T::SpendOrigin for a bounty, or by the parent bounty curator for a child-bounty.

Details

• The child-/bounty must be in the CuratorUnassigned state.
• For a bounty, the SpendOrigin must have sufficient permissions to propose the curator.

Parameters

• parent_bounty_id: Index of bounty.
• child_bounty_id: Index of child-bounty.
• curator: Account to be proposed as the curator.

Events

Emits Event::CuratorProposed if successful.

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

Accept the curator role for a child-/bounty.

Dispatch Origin

Must be signed by the proposed curator.

Details

• The child-/bounty must be in the Funded state.
• The curator must accept the role by calling this function.
• A deposit will be reserved from the curator and refunded upon successful payout.

Parameters

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

Events

Emits Event::BountyBecameActive if successful.

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

Unassign curator from a child-/bounty.

Dispatch Origin

This function can only be called by the RejectOrigin or the child-/bounty curator.

Details

• If this function is called by the RejectOrigin, or by the parent curator in the case of a child bounty, we assume that the curator is malicious or inactive. As a result, we will slash the curator when possible.
• If the origin is the child-/bounty 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).
• If successful, the child-/bounty status is updated to CuratorUnassigned. To reactivate the bounty, a new curator must be proposed and must accept the role.

Parameters

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

Events

Emits Event::CuratorUnassigned if successful.

pub fn award_bounty( origin: OriginFor<T>, parent_bounty_id: BountyIndex, child_bounty_id: Option<BountyIndex>, beneficiary: BeneficiaryLookupOf<T, I>, ) -> DispatchResult

Awards the child-/bounty to a beneficiary account/location, initiating the payout payments to both the beneficiary and the curator.

Dispatch Origin

This function can only be called by the RejectOrigin or the child-/bounty curator.

Details

• The child-/bounty must be in the Active state.
• if awarding a parent bounty it must not have active or funded child bounties.
• Initiates payout payment from the child-/bounty to the beneficiary account/location.
• If successful the child-/bounty status is updated to PayoutAttempted.
• In case of a payout failure, the child-/bounty status must be updated with check_status call before retrying with retry_payment call.

Parameters

• parent_bounty_id: Index of parent bounty.
• child_bounty_id: Index of child-bounty.
• beneficiary: Account/location to be awarded the child-/bounty.

Events

Emits Event::BountyAwarded and Event::Paid if successful.

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

Cancel an active child-/bounty. A payment to send all the funds to the funding source is initialized.

Dispatch Origin

This function can only be called by the RejectOrigin or the parent bounty curator.

Details

• If the child-/bounty is in the Funded state, a refund payment is initiated.
• If the child-/bounty is in the Active state, a refund payment is initiated and the child-/bounty status is updated with the curator account/location.
• If the child-/bounty is in the funding or payout phase, it cannot be canceled.
• In case of a refund failure, the child-/bounty status must be updated with the check_status call before retrying with retry_payment call.

Parameters

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

Events

Emits Event::BountyCanceled and Event::Paid if successful.

pub fn check_status( origin: OriginFor<T>, parent_bounty_id: BountyIndex, child_bounty_id: Option<BountyIndex>, ) -> DispatchResultWithPostInfo

Check and update the payment status of a child-/bounty.

Dispatch Origin

Must be signed.

Details

• If the child-/bounty status is FundingAttempted, it checks if the funding payment has succeeded. If successful, the bounty status becomes Funded.
• If the child-/bounty status is RefundAttempted, it checks if the refund payment has succeeded. If successful, the child-/bounty is removed from storage.
• If the child-/bounty status is PayoutAttempted, it checks if the payout payment has succeeded. If successful, the child-/bounty is removed from storage.

Parameters

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

Events

Emits Event::BountyBecameActive if the child/bounty status transitions to Active. Emits Event::BountyRefundProcessed if the refund payment has succeed. Emits Event::BountyPayoutProcessed if the payout payment has succeed. Emits Event::PaymentFailed if the funding, refund our payment payment has failed.

pub fn retry_payment( origin: OriginFor<T>, parent_bounty_id: BountyIndex, child_bounty_id: Option<BountyIndex>, ) -> DispatchResultWithPostInfo

Retry the funding, refund or payout payments.

Dispatch Origin

Must be signed.

Details

• If the child-/bounty status is FundingAttempted, it retries the funding payment from funding source the child-/bounty account/location.
• If the child-/bounty status is RefundAttempted, it retries the refund payment from the child-/bounty account/location to the funding source.
• If the child-/bounty status is PayoutAttempted, it retries the payout payment from the child-/bounty account/location to the beneficiary account/location.

Parameters

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

Events

Emits Event::Paid if the funding, refund or payout payment has initiated.

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

pub fn do_try_state() -> Result<(), TryRuntimeError>

Ensure the correctness of the state of this pallet.

This should be valid before or after each state transition of this pallet.

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

pub fn funding_source_account( asset_kind: T::AssetKind, ) -> Result<T::Beneficiary, DispatchError>

The account/location of the funding source.

pub fn bounty_account( bounty_id: BountyIndex, asset_kind: T::AssetKind, ) -> Result<T::Beneficiary, DispatchError>

The account/location of a bounty.

pub fn child_bounty_account( parent_bounty_id: BountyIndex, child_bounty_id: BountyIndex, asset_kind: T::AssetKind, ) -> Result<T::Beneficiary, DispatchError>

The account/location of a child-bounty.

pub fn get_bounty_details( parent_bounty_id: BountyIndex, child_bounty_id: Option<BountyIndex>, ) -> Result<(T::AssetKind, T::Balance, T::Hash, BountyStatus<T::AccountId, PaymentIdOf<T, I>, T::Beneficiary>, Option<T::AccountId>), DispatchError>

Returns the asset kind, value, status and parent curator (if parent bounty active) of a child-/bounty.

The asset kind derives from the parent bounty.

pub fn update_bounty_status( parent_bounty_id: BountyIndex, child_bounty_id: Option<BountyIndex>, new_status: BountyStatus<T::AccountId, PaymentIdOf<T, I>, T::Beneficiary>, ) -> Result<(), DispatchError>

Updates the status of a child-/bounty.

Trait Implementations

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

fn before_all_runtime_migrations() -> Weight

Something that should happen before runtime migrations are executed.

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

where T: Config + Config<I>, I: 'static,

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

fn dispatch_view_function<O: Output>( id: &ViewFunctionId, input: &mut &[u8], output: &mut O, ) -> Result<(), ViewFunctionDispatchError>

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

type InCodeStorageVersion = StorageVersion

This type is generated by the pallet macro.

fn in_code_storage_version() -> Self::InCodeStorageVersion

Returns the in-code storage version as specified in the storage_version attribute, or [NoStorageVersionSet] if the attribute is missing.

fn on_chain_storage_version() -> StorageVersion

Returns the storage version of the pallet as last set in the actual on-chain storage.

fn current_storage_version() -> Self::InCodeStorageVersion

👎Deprecated: This method has been renamed to in_code_storage_version and will be removed after March 2024.

DEPRECATED: Use [Self::current_storage_version] instead.

impl<T: Config<I>, I: 'static> Hooks<<<<T as Config>::Block as HeaderProvider>::HeaderT as Header>::Number> for Pallet<T, I>

fn try_state(_n: SystemBlockNumberFor<T>) -> Result<(), TryRuntimeError>

Execute the sanity checks of this pallet, per block.

fn on_initialize(_n: BlockNumber) -> Weight

Block initialization hook. This is called at the very beginning of block execution.

fn on_finalize(_n: BlockNumber)

Block finalization hook. This is called at the very end of block execution.

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

Hook to consume a block’s idle time. This will run when the block is being finalized (before [Hooks::on_finalize]).

fn on_poll(_n: BlockNumber, _weight: &mut WeightMeter)

A hook to run logic after inherent application.

fn on_runtime_upgrade() -> Weight

Hook executed when a code change (aka. a “runtime upgrade”) is detected by the FRAME Executive pallet.

fn pre_upgrade() -> Result<Vec<u8>, DispatchError>

Execute some pre-checks prior to a runtime upgrade.

fn post_upgrade(_state: Vec<u8>) -> Result<(), DispatchError>

Execute some post-checks after a runtime upgrade.

fn offchain_worker(_n: BlockNumber)

Implementing this function on a pallet allows you to perform long-running tasks that are dispatched as separate threads, and entirely independent of the main blockchain execution.

fn integrity_test()

Check the integrity of this pallet’s configuration.

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

fn integrity_test()

See [Hooks::integrity_test].

impl<T: Config<I>, I: 'static> OffchainWorker<<<<T as Config>::Block as HeaderProvider>::HeaderT as Header>::Number> for Pallet<T, I>

fn offchain_worker(n: BlockNumberFor<T>)

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

impl<T: Config<I>, I: 'static> OnFinalize<<<<T as Config>::Block as HeaderProvider>::HeaderT as Header>::Number> for Pallet<T, I>

fn on_finalize(n: BlockNumberFor<T>)

See [Hooks::on_finalize].

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>::Block as HeaderProvider>::HeaderT as Header>::Number> for Pallet<T, I>

fn on_idle(n: BlockNumberFor<T>, remaining_weight: Weight) -> Weight

See [Hooks::on_idle].

impl<T: Config<I>, I: 'static> OnInitialize<<<<T as Config>::Block as HeaderProvider>::HeaderT as Header>::Number> for Pallet<T, I>

fn on_initialize(n: BlockNumberFor<T>) -> Weight

See [Hooks::on_initialize].

impl<T: Config<I>, I: 'static> OnPoll<<<<T as Config>::Block as HeaderProvider>::HeaderT as Header>::Number> for Pallet<T, I>

fn on_poll(n: BlockNumberFor<T>, weight: &mut WeightMeter)

Code to execute every now and then at the beginning of the block after inherent application.

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

fn on_runtime_upgrade() -> Weight

See [Hooks::on_runtime_upgrade].

fn pre_upgrade() -> Result<Vec<u8>, TryRuntimeError>

See [Hooks::pre_upgrade].

fn post_upgrade(state: Vec<u8>) -> Result<(), TryRuntimeError>

See [Hooks::post_upgrade].

fn try_on_runtime_upgrade(checks: bool) -> Result<Weight, DispatchError>

The expected and default behavior of this method is to handle executing pre_upgrade -> on_runtime_upgrade -> post_upgrade hooks for a migration.

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 name_hash() -> [u8; 16]

Two128 hash of name.

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

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

Tests for self and other values to be equal, and is used by ==.

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

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

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

fn storage_info() -> Vec<StorageInfo>

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

fn try_decode_entire_state() -> Result<usize, Vec<TryDecodeEntireStorageError>>

Decode the entire data under the given storage, returning Ok(bytes_decoded) if success.

impl<T: Config<I>, I: 'static> TryState<<<<T as Config>::Block as HeaderProvider>::HeaderT as Header>::Number> for Pallet<T, I>

fn try_state( n: BlockNumberFor<T>, _s: TryStateSelect, ) -> Result<(), TryRuntimeError>

Execute the state checks.

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

fn prefix() -> [u8; 16]

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>