Enum pallet_referenda::pallet::Call

pub enum Call<T: Config<I>, I: 'static = ()> {
    submit {
        proposal_origin: Box<PalletsOriginOf<T>>,
        proposal: BoundedCallOf<T, I>,
        enactment_moment: DispatchTime<BlockNumberFor<T>>,
    },
    place_decision_deposit {
        index: ReferendumIndex,
    },
    refund_decision_deposit {
        index: ReferendumIndex,
    },
    cancel {
        index: ReferendumIndex,
    },
    kill {
        index: ReferendumIndex,
    },
    nudge_referendum {
        index: ReferendumIndex,
    },
    one_fewer_deciding {
        track: TrackIdOf<T, I>,
    },
    refund_submission_deposit {
        index: ReferendumIndex,
    },
    set_metadata {
        index: ReferendumIndex,
        maybe_hash: Option<T::Hash>,
    },
    // some variants omitted
}

Contains a variant per dispatchable extrinsic that this pallet has.

Variants

submit

Propose a referendum on a privileged action.

• origin: must be SubmitOrigin and the account must have SubmissionDeposit funds available.
• proposal_origin: The origin from which the proposal should be executed.
• proposal: The proposal.
• enactment_moment: The moment that the proposal should be enacted.

Emits Submitted.

Fields

proposal_origin: Box<PalletsOriginOf<T>>

proposal: BoundedCallOf<T, I>

enactment_moment: DispatchTime<BlockNumberFor<T>>

place_decision_deposit

Post the Decision Deposit for a referendum.

• origin: must be Signed and the account must have funds available for the referendum’s track’s Decision Deposit.
• index: The index of the submitted referendum whose Decision Deposit is yet to be posted.

Emits DecisionDepositPlaced.

Fields

index: ReferendumIndex

refund_decision_deposit

Refund the Decision Deposit for a closed referendum back to the depositor.

• origin: must be Signed or Root.
• index: The index of a closed referendum whose Decision Deposit has not yet been refunded.

Emits DecisionDepositRefunded.

Fields

index: ReferendumIndex

cancel

Cancel an ongoing referendum.

• origin: must be the CancelOrigin.
• index: The index of the referendum to be cancelled.

Emits Cancelled.

Fields

index: ReferendumIndex

kill

Cancel an ongoing referendum and slash the deposits.

• origin: must be the KillOrigin.
• index: The index of the referendum to be cancelled.

Emits Killed and DepositSlashed.

Fields

index: ReferendumIndex

nudge_referendum

Advance a referendum onto its next logical state. Only used internally.

• origin: must be Root.
• index: the referendum to be advanced.

Fields

index: ReferendumIndex

one_fewer_deciding

Advance a track onto its next logical state. Only used internally.

• origin: must be Root.
• track: the track to be advanced.

Action item for when there is now one fewer referendum in the deciding phase and the DecidingCount is not yet updated. This means that we should either:

• begin deciding another referendum (and leave DecidingCount alone); or
• decrement DecidingCount.

Fields

track: TrackIdOf<T, I>

refund_submission_deposit

Refund the Submission Deposit for a closed referendum back to the depositor.

• origin: must be Signed or Root.
• index: The index of a closed referendum whose Submission Deposit has not yet been refunded.

Emits SubmissionDepositRefunded.

Fields

index: ReferendumIndex

set_metadata

Set or clear metadata of a referendum.

Parameters:

• origin: Must be Signed by a creator of a referendum or by anyone to clear a metadata of a finished referendum.
• index: The index of a referendum to set or clear metadata for.
• maybe_hash: The hash of an on-chain stored preimage. None to clear a metadata.

Fields

index: ReferendumIndex

maybe_hash: Option<T::Hash>

Implementations

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

pub fn new_call_variant_submit( proposal_origin: Box<PalletsOriginOf<T>>, proposal: BoundedCallOf<T, I>, enactment_moment: DispatchTime<BlockNumberFor<T>>, ) -> Self

Create a call with the variant submit.

pub fn new_call_variant_place_decision_deposit(index: ReferendumIndex) -> Self

Create a call with the variant place_decision_deposit.

pub fn new_call_variant_refund_decision_deposit(index: ReferendumIndex) -> Self

Create a call with the variant refund_decision_deposit.

pub fn new_call_variant_cancel(index: ReferendumIndex) -> Self

Create a call with the variant cancel.

pub fn new_call_variant_kill(index: ReferendumIndex) -> Self

Create a call with the variant kill.

pub fn new_call_variant_nudge_referendum(index: ReferendumIndex) -> Self

Create a call with the variant nudge_referendum.

pub fn new_call_variant_one_fewer_deciding(track: TrackIdOf<T, I>) -> Self

Create a call with the variant one_fewer_deciding.

pub fn new_call_variant_refund_submission_deposit( index: ReferendumIndex, ) -> Self

Create a call with the variant refund_submission_deposit.

pub fn new_call_variant_set_metadata( index: ReferendumIndex, maybe_hash: Option<T::Hash>, ) -> Self

Create a call with the variant set_metadata.

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, Box<PalletsOriginOf<T>>: TypeInfo + 'static, BoundedCallOf<T, I>: TypeInfo + 'static, DispatchTime<BlockNumberFor<T>>: TypeInfo + 'static, TrackIdOf<T, I>: TypeInfo + 'static, Option<T::Hash>: 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>