Enum pallet_treasury::pallet::Call

pub enum Call<T: Config<I>, I: 'static = ()> {
    propose_spend {
        value: BalanceOf<T, I>,
        beneficiary: <<T as Config>::Lookup as StaticLookup>::Source,
    },
    reject_proposal {
        proposal_id: ProposalIndex,
    },
    approve_proposal {
        proposal_id: ProposalIndex,
    },
    spend_local {
        amount: BalanceOf<T, I>,
        beneficiary: <<T as Config>::Lookup as StaticLookup>::Source,
    },
    remove_approval {
        proposal_id: ProposalIndex,
    },
    spend {
        asset_kind: Box<T::AssetKind>,
        amount: AssetBalanceOf<T, I>,
        beneficiary: Box<<<T as Config<I>>::BeneficiaryLookup as StaticLookup>::Source>,
        valid_from: Option<BlockNumberFor<T>>,
    },
    payout {
        index: SpendIndex,
    },
    check_status {
        index: SpendIndex,
    },
    void_spend {
        index: SpendIndex,
    },
    // some variants omitted
}

Contains a variant per dispatchable extrinsic that this pallet has.

Variants

propose_spend

Fields

value: BalanceOf<T, I>

beneficiary: <<T as Config>::Lookup as StaticLookup>::Source

Put forward a suggestion for spending.

Dispatch Origin

Must be signed.

Details

A deposit proportional to the value is reserved and slashed if the proposal is rejected. It is returned once the proposal is awarded.

Complexity

• O(1)

Events

Emits Event::Proposed if successful.

reject_proposal

Fields

proposal_id: ProposalIndex

Reject a proposed spend.

Dispatch Origin

Must be Config::RejectOrigin.

Details

The original deposit will be slashed.

Complexity

• O(1)

Events

Emits Event::Rejected if successful.

approve_proposal

Fields

proposal_id: ProposalIndex

Approve a proposal.

Dispatch Origin

Must be Config::ApproveOrigin.

Details

At a later time, the proposal will be allocated to the beneficiary and the original deposit will be returned.

Complexity

• O(1).

Events

No events are emitted from this dispatch.

spend_local

Fields

amount: BalanceOf<T, I>

beneficiary: <<T as Config>::Lookup as StaticLookup>::Source

Propose and approve a spend of treasury funds.

Dispatch Origin

Must be Config::SpendOrigin with the Success value being at least amount.

Details

NOTE: For record-keeping purposes, the proposer is deemed to be equivalent to the beneficiary.

Parameters

• amount: The amount to be transferred from the treasury to the beneficiary.
• beneficiary: The destination account for the transfer.

Events

Emits Event::SpendApproved if successful.

remove_approval

Fields

proposal_id: ProposalIndex

Force a previously approved proposal to be removed from the approval queue.

Dispatch Origin

Must be Config::RejectOrigin.

Details

The original deposit will no longer be returned.

Parameters

• proposal_id: The index of a proposal

Complexity

• O(A) where A is the number of approvals

Errors

• Error::ProposalNotApproved: The proposal_id supplied was not found in the approval queue, i.e., the proposal has not been approved. This could also mean the proposal does not exist altogether, thus there is no way it would have been approved in the first place.

spend

Fields

asset_kind: Box<T::AssetKind>

amount: AssetBalanceOf<T, I>

beneficiary: Box<<<T as Config<I>>::BeneficiaryLookup as StaticLookup>::Source>

valid_from: Option<BlockNumberFor<T>>

Propose and approve a spend of treasury funds.

Dispatch Origin

Must be Config::SpendOrigin with the Success value being at least amount of asset_kind in the native asset. The amount of asset_kind is converted for assertion using the Config::BalanceConverter.

Details

Create an approved spend for transferring a specific amount of asset_kind to a designated beneficiary. The spend must be claimed using the payout dispatchable within the Config::PayoutPeriod.

Parameters

• asset_kind: An indicator of the specific asset class to be spent.
• amount: The amount to be transferred from the treasury to the beneficiary.
• beneficiary: The beneficiary of the spend.
• valid_from: The block number from which the spend can be claimed. It can refer to the past if the resulting spend has not yet expired according to the Config::PayoutPeriod. If None, the spend can be claimed immediately after approval.

Events

Emits Event::AssetSpendApproved if successful.

payout

Fields

index: SpendIndex

Claim a spend.

Dispatch Origin

Must be signed.

Details

Spends must be claimed within some temporal bounds. A spend may be claimed within one Config::PayoutPeriod from the valid_from block. In case of a payout failure, the spend status must be updated with the check_status dispatchable before retrying with the current function.

Parameters

• index: The spend index.

Events

Emits Event::Paid if successful.

check_status

Fields

index: SpendIndex

Check the status of the spend and remove it from the storage if processed.

Dispatch Origin

Must be signed.

Details

The status check is a prerequisite for retrying a failed payout. If a spend has either succeeded or expired, it is removed from the storage by this function. In such instances, transaction fees are refunded.

Parameters

• index: The spend index.

Events

Emits Event::PaymentFailed if the spend payout has failed. Emits Event::SpendProcessed if the spend payout has succeed.

void_spend

Fields

index: SpendIndex

Void previously approved spend.

Dispatch Origin

Must be Config::RejectOrigin.

Details

A spend void is only possible if the payout has not been attempted yet.

Parameters

• index: The spend index.

Events

Emits Event::AssetSpendVoided if successful.

Implementations

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

pub fn new_call_variant_propose_spend( value: BalanceOf<T, I>, beneficiary: <<T as Config>::Lookup as StaticLookup>::Source ) -> Self

Create a call with the variant propose_spend.

pub fn new_call_variant_reject_proposal(proposal_id: ProposalIndex) -> Self

Create a call with the variant reject_proposal.

pub fn new_call_variant_approve_proposal(proposal_id: ProposalIndex) -> Self

Create a call with the variant approve_proposal.

pub fn new_call_variant_spend_local( amount: BalanceOf<T, I>, beneficiary: <<T as Config>::Lookup as StaticLookup>::Source ) -> Self

Create a call with the variant spend_local.

pub fn new_call_variant_remove_approval(proposal_id: ProposalIndex) -> Self

Create a call with the variant remove_approval.

pub fn new_call_variant_spend( asset_kind: Box<T::AssetKind>, amount: AssetBalanceOf<T, I>, beneficiary: Box<<<T as Config<I>>::BeneficiaryLookup as StaticLookup>::Source>, valid_from: Option<BlockNumberFor<T>> ) -> Self

Create a call with the variant spend.

pub fn new_call_variant_payout(index: SpendIndex) -> Self

Create a call with the variant payout.

pub fn new_call_variant_check_status(index: SpendIndex) -> Self

Create a call with the variant check_status.

pub fn new_call_variant_void_spend(index: SpendIndex) -> Self

Create a call with the variant void_spend.

Trait Implementations

impl<T: Config<I>, I: 'static> CheckIfFeeless for Call<T, I>

type Origin = <T as Config>::RuntimeOrigin

The Origin type of the runtime.

fn is_feeless(&self, origin: &Self::Origin) -> bool

Checks if the dispatchable satisfies the feeless condition as defined by #[pallet::feeless_if]

impl<T: Config<I>, I: 'static> Clone for Call<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: Config<I>, I: 'static> Debug for Call<T, I>

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

Formats the value using the given formatter.

impl<T: Config<I>, I: 'static> Decode for Call<T, I>

fn decode<__CodecInputEdqy: Input>( __codec_input_edqy: &mut __CodecInputEdqy ) -> Result<Self, Error>

Attempt to deserialise the value from input.

fn decode_into<I>( input: &mut I, dst: &mut MaybeUninit<Self> ) -> Result<DecodeFinished, Error>

where I: Input,

Attempt to deserialize the value from input into a pre-allocated piece of memory.

fn skip<I>(input: &mut I) -> Result<(), Error>

where I: Input,

Attempt to skip the encoded value from input.

fn encoded_fixed_size() -> Option<usize>

Returns the fixed encoded size of the type.

impl<T: Config<I>, I: 'static> Encode for Call<T, I>

fn size_hint(&self) -> usize

If possible give a hint of expected size of the encoding.

fn encode_to<__CodecOutputEdqy: Output + ?Sized>( &self, __codec_dest_edqy: &mut __CodecOutputEdqy )

Convert self to a slice and append it to the destination.

fn encode(&self) -> Vec<u8>

Convert self to an owned vector.

fn using_encoded<R, F>(&self, f: F) -> R

where F: FnOnce(&[u8]) -> R,

Convert self to a slice and then invoke the given closure with it.

fn encoded_size(&self) -> usize

Calculates the encoded size.

impl<T: Config<I>, I: 'static> GetCallIndex for Call<T, I>

fn get_call_index(&self) -> u8

Return the index of this Call.

fn get_call_indices() -> &'static [u8]

Return all call indices in the same order as [GetCallName].

impl<T: Config<I>, I: 'static> GetCallName for Call<T, I>

fn get_call_name(&self) -> &'static str

Return the function name of the Call.

fn get_call_names() -> &'static [&'static str]

Return all function names in the same order as [GetCallIndex].

impl<T: Config<I>, I: 'static> GetDispatchInfo for Call<T, I>

fn get_dispatch_info(&self) -> DispatchInfo

Return a DispatchInfo, containing relevant information of this dispatch.

impl<T: Config<I>, I: 'static> PartialEq for Call<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, I> TypeInfo for Call<T, I>

where PhantomData<(T, I)>: TypeInfo + 'static, BalanceOf<T, I>: HasCompact, <<T as Config>::Lookup as StaticLookup>::Source: TypeInfo + 'static, Box<T::AssetKind>: TypeInfo + 'static, AssetBalanceOf<T, I>: HasCompact, Box<<<T as Config<I>>::BeneficiaryLookup as StaticLookup>::Source>: TypeInfo + 'static, Option<BlockNumberFor<T>>: TypeInfo + 'static, T: Config<I> + 'static, I: 'static,

type Identity = Call<T, I>

The type identifying for which type info is provided.

fn type_info() -> Type

Returns the static type identifier for Self.

impl<T: Config<I>, I: 'static> UnfilteredDispatchable for Call<T, I>

type RuntimeOrigin = <T as Config>::RuntimeOrigin

The origin type of the runtime, (i.e. frame_system::Config::RuntimeOrigin).

fn dispatch_bypass_filter( self, origin: Self::RuntimeOrigin ) -> DispatchResultWithPostInfo

Dispatch this call but do not check the filter in origin.

impl<T: Config<I>, I: 'static> EncodeLike for Call<T, I>

impl<T: Config<I>, I: 'static> Eq for Call<T, I>