Enum pallet_democracy::pallet::Call

pub enum Call<T: Config> {
    propose {
        proposal: BoundedCallOf<T>,
        value: <<T as Config>::Currency as Currency<<T as Config>::AccountId>>::Balance,
    },
    second {
        proposal: PropIndex,
    },
    vote {
        ref_index: ReferendumIndex,
        vote: AccountVote<<<T as Config>::Currency as Currency<<T as Config>::AccountId>>::Balance>,
    },
    emergency_cancel {
        ref_index: ReferendumIndex,
    },
    external_propose {
        proposal: BoundedCallOf<T>,
    },
    external_propose_majority {
        proposal: BoundedCallOf<T>,
    },
    external_propose_default {
        proposal: BoundedCallOf<T>,
    },
    fast_track {
        proposal_hash: T::Hash,
        voting_period: BlockNumberFor<T>,
        delay: BlockNumberFor<T>,
    },
    veto_external {
        proposal_hash: T::Hash,
    },
    cancel_referendum {
        ref_index: ReferendumIndex,
    },
    delegate {
        to: <<T as Config>::Lookup as StaticLookup>::Source,
        conviction: Conviction,
        balance: <<T as Config>::Currency as Currency<<T as Config>::AccountId>>::Balance,
    },
    undelegate {},
    clear_public_proposals {},
    unlock {
        target: <<T as Config>::Lookup as StaticLookup>::Source,
    },
    remove_vote {
        index: ReferendumIndex,
    },
    remove_other_vote {
        target: <<T as Config>::Lookup as StaticLookup>::Source,
        index: ReferendumIndex,
    },
    blacklist {
        proposal_hash: T::Hash,
        maybe_ref_index: Option<ReferendumIndex>,
    },
    cancel_proposal {
        prop_index: PropIndex,
    },
    set_metadata {
        owner: MetadataOwner,
        maybe_hash: Option<T::Hash>,
    },
    // some variants omitted
}

Contains a variant per dispatchable extrinsic that this pallet has.

Variants

propose

Propose a sensitive action to be taken.

The dispatch origin of this call must be Signed and the sender must have funds to cover the deposit.

• proposal_hash: The hash of the proposal preimage.
• value: The amount of deposit (must be at least MinimumDeposit).

Emits Proposed.

Fields

proposal: BoundedCallOf<T>

value: <<T as Config>::Currency as Currency<<T as Config>::AccountId>>::Balance

second

Signals agreement with a particular proposal.

The dispatch origin of this call must be Signed and the sender must have funds to cover the deposit, equal to the original deposit.

• proposal: The index of the proposal to second.

Fields

proposal: PropIndex

vote

Vote in a referendum. If vote.is_aye(), the vote is to enact the proposal; otherwise it is a vote to keep the status quo.

The dispatch origin of this call must be Signed.

• ref_index: The index of the referendum to vote for.
• vote: The vote configuration.

Fields

ref_index: ReferendumIndex

vote: AccountVote<<<T as Config>::Currency as Currency<<T as Config>::AccountId>>::Balance>

emergency_cancel

Schedule an emergency cancellation of a referendum. Cannot happen twice to the same referendum.

The dispatch origin of this call must be CancellationOrigin.

-ref_index: The index of the referendum to cancel.

Weight: O(1).

Fields

ref_index: ReferendumIndex

external_propose

Schedule a referendum to be tabled once it is legal to schedule an external referendum.

The dispatch origin of this call must be ExternalOrigin.

• proposal_hash: The preimage hash of the proposal.

Fields

proposal: BoundedCallOf<T>

external_propose_majority

Schedule a majority-carries referendum to be tabled next once it is legal to schedule an external referendum.

The dispatch of this call must be ExternalMajorityOrigin.

• proposal_hash: The preimage hash of the proposal.

Unlike external_propose, blacklisting has no effect on this and it may replace a pre-scheduled external_propose call.

Weight: O(1)

Fields

proposal: BoundedCallOf<T>

external_propose_default

Schedule a negative-turnout-bias referendum to be tabled next once it is legal to schedule an external referendum.

The dispatch of this call must be ExternalDefaultOrigin.

• proposal_hash: The preimage hash of the proposal.

Unlike external_propose, blacklisting has no effect on this and it may replace a pre-scheduled external_propose call.

Weight: O(1)

Fields

proposal: BoundedCallOf<T>

fast_track

Schedule the currently externally-proposed majority-carries referendum to be tabled immediately. If there is no externally-proposed referendum currently, or if there is one but it is not a majority-carries referendum then it fails.

The dispatch of this call must be FastTrackOrigin.

• proposal_hash: The hash of the current external proposal.
• voting_period: The period that is allowed for voting on this proposal. Increased to Must be always greater than zero. For FastTrackOrigin must be equal or greater than FastTrackVotingPeriod.
• delay: The number of block after voting has ended in approval and this should be enacted. This doesn’t have a minimum amount.

Emits Started.

Weight: O(1)

Fields

proposal_hash: T::Hash

voting_period: BlockNumberFor<T>

delay: BlockNumberFor<T>

veto_external

Veto and blacklist the external proposal hash.

The dispatch origin of this call must be VetoOrigin.

• proposal_hash: The preimage hash of the proposal to veto and blacklist.

Emits Vetoed.

Weight: O(V + log(V)) where V is number of existing vetoers

Fields

proposal_hash: T::Hash

cancel_referendum

Remove a referendum.

The dispatch origin of this call must be Root.

• ref_index: The index of the referendum to cancel.

Weight: O(1).

Fields

ref_index: ReferendumIndex

delegate

Delegate the voting power (with some given conviction) of the sending account.

The balance delegated is locked for as long as it’s delegated, and thereafter for the time appropriate for the conviction’s lock period.

The dispatch origin of this call must be Signed, and the signing account must either:

• be delegating already; or

• have no voting activity (if there is, then it will need to be removed/consolidated through reap_vote or unvote).

• to: The account whose voting the target account’s voting power will follow.

• conviction: The conviction that will be attached to the delegated votes. When the account is undelegated, the funds will be locked for the corresponding period.

• balance: The amount of the account’s balance to be used in delegating. This must not be more than the account’s current balance.

Emits Delegated.

Weight: O(R) where R is the number of referendums the voter delegating to has voted on. Weight is charged as if maximum votes.

Fields

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

conviction: Conviction

balance: <<T as Config>::Currency as Currency<<T as Config>::AccountId>>::Balance

undelegate

Undelegate the voting power of the sending account.

Tokens may be unlocked following once an amount of time consistent with the lock period of the conviction with which the delegation was issued.

The dispatch origin of this call must be Signed and the signing account must be currently delegating.

Emits Undelegated.

Weight: O(R) where R is the number of referendums the voter delegating to has voted on. Weight is charged as if maximum votes.

clear_public_proposals

Clears all public proposals.

The dispatch origin of this call must be Root.

Weight: O(1).

unlock

Unlock tokens that have an expired lock.

The dispatch origin of this call must be Signed.

• target: The account to remove the lock on.

Weight: O(R) with R number of vote of target.

Fields

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

remove_vote

Remove a vote for a referendum.

If:

• the referendum was cancelled, or
• the referendum is ongoing, or
• the referendum has ended such that
  • the vote of the account was in opposition to the result; or
  • there was no conviction to the account’s vote; or
  • the account made a split vote …then the vote is removed cleanly and a following call to unlock may result in more funds being available.

If, however, the referendum has ended and:

• it finished corresponding to the vote of the account, and
• the account made a standard vote with conviction, and
• the lock period of the conviction is not over …then the lock will be aggregated into the overall account’s lock, which may involve overlocking (where the two locks are combined into a single lock that is the maximum of both the amount locked and the time is it locked for).

The dispatch origin of this call must be Signed, and the signer must have a vote registered for referendum index.

• index: The index of referendum of the vote to be removed.

Weight: O(R + log R) where R is the number of referenda that target has voted on. Weight is calculated for the maximum number of vote.

Fields

index: ReferendumIndex

remove_other_vote

Remove a vote for a referendum.

If the target is equal to the signer, then this function is exactly equivalent to remove_vote. If not equal to the signer, then the vote must have expired, either because the referendum was cancelled, because the voter lost the referendum or because the conviction period is over.

The dispatch origin of this call must be Signed.

• target: The account of the vote to be removed; this account must have voted for referendum index.
• index: The index of referendum of the vote to be removed.

Weight: O(R + log R) where R is the number of referenda that target has voted on. Weight is calculated for the maximum number of vote.

Fields

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

index: ReferendumIndex

blacklist

Permanently place a proposal into the blacklist. This prevents it from ever being proposed again.

If called on a queued public or external proposal, then this will result in it being removed. If the ref_index supplied is an active referendum with the proposal hash, then it will be cancelled.

The dispatch origin of this call must be BlacklistOrigin.

• proposal_hash: The proposal hash to blacklist permanently.
• ref_index: An ongoing referendum whose hash is proposal_hash, which will be cancelled.

Weight: O(p) (though as this is an high-privilege dispatch, we assume it has a reasonable value).

Fields

proposal_hash: T::Hash

maybe_ref_index: Option<ReferendumIndex>

cancel_proposal

Remove a proposal.

The dispatch origin of this call must be CancelProposalOrigin.

• prop_index: The index of the proposal to cancel.

Weight: O(p) where p = PublicProps::<T>::decode_len()

Fields

prop_index: PropIndex

set_metadata

Set or clear a metadata of a proposal or a referendum.

Parameters:

• origin: Must correspond to the MetadataOwner.
  • ExternalOrigin for an external proposal with the SuperMajorityApprove threshold.
  • ExternalDefaultOrigin for an external proposal with the SuperMajorityAgainst threshold.
  • ExternalMajorityOrigin for an external proposal with the SimpleMajority threshold.
  • Signed by a creator for a public proposal.
  • Signed to clear a metadata for a finished referendum.
  • Root to set a metadata for an ongoing referendum.
• owner: an identifier of a metadata owner.
• maybe_hash: The hash of an on-chain stored preimage. None to clear a metadata.

Fields

owner: MetadataOwner

maybe_hash: Option<T::Hash>

Implementations

impl<T: Config> Call<T>

pub fn new_call_variant_propose( proposal: BoundedCallOf<T>, value: <<T as Config>::Currency as Currency<<T as Config>::AccountId>>::Balance, ) -> Self

Create a call with the variant propose.

pub fn new_call_variant_second(proposal: PropIndex) -> Self

Create a call with the variant second.

pub fn new_call_variant_vote( ref_index: ReferendumIndex, vote: AccountVote<<<T as Config>::Currency as Currency<<T as Config>::AccountId>>::Balance>, ) -> Self

Create a call with the variant vote.

pub fn new_call_variant_emergency_cancel(ref_index: ReferendumIndex) -> Self

Create a call with the variant emergency_cancel.

pub fn new_call_variant_external_propose(proposal: BoundedCallOf<T>) -> Self

Create a call with the variant external_propose.

pub fn new_call_variant_external_propose_majority( proposal: BoundedCallOf<T>, ) -> Self

Create a call with the variant external_propose_majority.

pub fn new_call_variant_external_propose_default( proposal: BoundedCallOf<T>, ) -> Self

Create a call with the variant external_propose_default.

pub fn new_call_variant_fast_track( proposal_hash: T::Hash, voting_period: BlockNumberFor<T>, delay: BlockNumberFor<T>, ) -> Self

Create a call with the variant fast_track.

pub fn new_call_variant_veto_external(proposal_hash: T::Hash) -> Self

Create a call with the variant veto_external.

pub fn new_call_variant_cancel_referendum(ref_index: ReferendumIndex) -> Self

Create a call with the variant cancel_referendum.

pub fn new_call_variant_delegate( to: <<T as Config>::Lookup as StaticLookup>::Source, conviction: Conviction, balance: <<T as Config>::Currency as Currency<<T as Config>::AccountId>>::Balance, ) -> Self

Create a call with the variant delegate.

pub fn new_call_variant_undelegate() -> Self

Create a call with the variant undelegate.

pub fn new_call_variant_clear_public_proposals() -> Self

Create a call with the variant clear_public_proposals.

pub fn new_call_variant_unlock( target: <<T as Config>::Lookup as StaticLookup>::Source, ) -> Self

Create a call with the variant unlock.

pub fn new_call_variant_remove_vote(index: ReferendumIndex) -> Self

Create a call with the variant remove_vote.

pub fn new_call_variant_remove_other_vote( target: <<T as Config>::Lookup as StaticLookup>::Source, index: ReferendumIndex, ) -> Self

Create a call with the variant remove_other_vote.

pub fn new_call_variant_blacklist( proposal_hash: T::Hash, maybe_ref_index: Option<ReferendumIndex>, ) -> Self

Create a call with the variant blacklist.

pub fn new_call_variant_cancel_proposal(prop_index: PropIndex) -> Self

Create a call with the variant cancel_proposal.

pub fn new_call_variant_set_metadata( owner: MetadataOwner, maybe_hash: Option<T::Hash>, ) -> Self

Create a call with the variant set_metadata.

Trait Implementations

impl<T: Config> CheckIfFeeless for Call<T>

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> Clone for Call<T>

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> Debug for Call<T>

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

Formats the value using the given formatter.

impl<T: Config> Decode for Call<T>

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> Encode for Call<T>

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> GetCallIndex for Call<T>

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> GetCallName for Call<T>

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

fn get_dispatch_info(&self) -> DispatchInfo

Return a DispatchInfo, containing relevant information of this dispatch.

impl<T: Config> PartialEq for Call<T>

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> TypeInfo for Call<T>

where PhantomData<(T,)>: TypeInfo + 'static, BoundedCallOf<T>: TypeInfo + 'static, <<T as Config>::Currency as Currency<<T as Config>::AccountId>>::Balance: HasCompact + TypeInfo + 'static, AccountVote<<<T as Config>::Currency as Currency<<T as Config>::AccountId>>::Balance>: TypeInfo + 'static, T::Hash: TypeInfo + 'static, BlockNumberFor<T>: TypeInfo + 'static, <<T as Config>::Lookup as StaticLookup>::Source: TypeInfo + 'static, Option<T::Hash>: TypeInfo + 'static, T: Config + 'static,

type Identity = Call<T>

The type identifying for which type info is provided.

fn type_info() -> Type

Returns the static type identifier for Self.

impl<T: Config> UnfilteredDispatchable for Call<T>

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> EncodeLike for Call<T>

impl<T: Config> Eq for Call<T>