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 {
        amount: BalanceOf<T, I>,
        beneficiary: <<T as Config>::Lookup as StaticLookup>::Source,
    },
    remove_approval {
        proposal_id: ProposalIndex,
    },
    // some variants omitted
}

Contains one variant per dispatchable that can be called by an extrinsic.

Variants

propose_spend

Fields

value: BalanceOf<T, I>

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

Put forward a suggestion for spending. 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)

reject_proposal

Fields

proposal_id: ProposalIndex

Reject a proposed spend. The original deposit will be slashed.

May only be called from T::RejectOrigin.

Complexity

• O(1)

approve_proposal

Fields

proposal_id: ProposalIndex

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

May only be called from T::ApproveOrigin.

Complexity

• O(1).

spend

Fields

amount: BalanceOf<T, I>

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

Propose and approve a spend of treasury funds.

• origin: Must be SpendOrigin with the Success value being at least amount.
• amount: The amount to be transferred from the treasury to the beneficiary.
• beneficiary: The destination account for the transfer.

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

remove_approval

Fields

proposal_id: ProposalIndex

Force a previously approved proposal to be removed from the approval queue. The original deposit will no longer be returned.

May only be called from T::RejectOrigin.

• proposal_id: The index of a proposal

Complexity

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

Errors:

• 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.

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(
    amount: BalanceOf<T, I>,
    beneficiary: <<T as Config>::Lookup as StaticLookup>::Source
) -> Self

Create a call with the variant spend.

pub fn new_call_variant_remove_approval(proposal_id: ProposalIndex) -> Self

Create a call with the variant remove_approval.

Trait Implementations

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, Global>

Convert self to an owned vector.

fn using_encoded<R, F>(&self, f: F) -> Rwhere
    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> 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.

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

fn get_dispatch_info(&self) -> DispatchInfo

👎Deprecated: Trait has moved to frame_support::dispatch

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

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