Struct pallet_democracy::pallet::Pallet

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

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

Implementations

impl<T: Config> Pallet<T>

pub fn propose( origin: OriginFor<T>, proposal: BoundedCallOf<T>, value: <<T as Config>::Currency as Currency<<T as Config>::AccountId>>::Balance, ) -> DispatchResult

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.

pub fn second(origin: OriginFor<T>, proposal: PropIndex) -> DispatchResult

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.

pub fn vote( origin: OriginFor<T>, ref_index: ReferendumIndex, vote: AccountVote<<<T as Config>::Currency as Currency<<T as Config>::AccountId>>::Balance>, ) -> DispatchResult

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.

pub fn emergency_cancel( origin: OriginFor<T>, ref_index: ReferendumIndex, ) -> DispatchResult

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

pub fn external_propose( origin: OriginFor<T>, proposal: BoundedCallOf<T>, ) -> DispatchResult

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.

pub fn external_propose_majority( origin: OriginFor<T>, proposal: BoundedCallOf<T>, ) -> DispatchResult

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)

pub fn external_propose_default( origin: OriginFor<T>, proposal: BoundedCallOf<T>, ) -> DispatchResult

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)

pub fn fast_track( origin: OriginFor<T>, proposal_hash: T::Hash, voting_period: BlockNumberFor<T>, delay: BlockNumberFor<T>, ) -> DispatchResult

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)

pub fn veto_external( origin: OriginFor<T>, proposal_hash: T::Hash, ) -> DispatchResult

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

pub fn cancel_referendum( origin: OriginFor<T>, ref_index: ReferendumIndex, ) -> DispatchResult

Remove a referendum.

The dispatch origin of this call must be Root.

• ref_index: The index of the referendum to cancel.

Weight: O(1).

pub fn delegate( origin: OriginFor<T>, to: <<T as Config>::Lookup as StaticLookup>::Source, conviction: Conviction, balance: <<T as Config>::Currency as Currency<<T as Config>::AccountId>>::Balance, ) -> DispatchResultWithPostInfo

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.

pub fn undelegate(origin: OriginFor<T>) -> DispatchResultWithPostInfo

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.

pub fn clear_public_proposals(origin: OriginFor<T>) -> DispatchResult

Clears all public proposals.

The dispatch origin of this call must be Root.

Weight: O(1).

pub fn unlock( origin: OriginFor<T>, target: <<T as Config>::Lookup as StaticLookup>::Source, ) -> DispatchResult

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.

pub fn remove_vote( origin: OriginFor<T>, index: ReferendumIndex, ) -> DispatchResult

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.

pub fn remove_other_vote( origin: OriginFor<T>, target: <<T as Config>::Lookup as StaticLookup>::Source, index: ReferendumIndex, ) -> DispatchResult

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.

pub fn blacklist( origin: OriginFor<T>, proposal_hash: T::Hash, maybe_ref_index: Option<ReferendumIndex>, ) -> DispatchResult

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

pub fn cancel_proposal( origin: OriginFor<T>, prop_index: PropIndex, ) -> DispatchResult

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()

pub fn set_metadata( origin: OriginFor<T>, owner: MetadataOwner, maybe_hash: Option<T::Hash>, ) -> DispatchResult

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.

impl<T: Config> Pallet<T>

pub fn backing_for( proposal: PropIndex, ) -> Option<<<T as Config>::Currency as Currency<<T as Config>::AccountId>>::Balance>

Get the amount locked in support of proposal; None if proposal isn’t a valid proposal index.

pub fn maturing_referenda_at( n: BlockNumberFor<T>, ) -> Vec<(ReferendumIndex, ReferendumStatus<BlockNumberFor<T>, BoundedCallOf<T>, <<T as Config>::Currency as Currency<<T as Config>::AccountId>>::Balance>)>

Get all referenda ready for tally at block n.

pub fn internal_start_referendum( proposal: BoundedCallOf<T>, threshold: VoteThreshold, delay: BlockNumberFor<T>, ) -> ReferendumIndex

Start a referendum.

pub fn internal_cancel_referendum(ref_index: ReferendumIndex)

Remove a referendum.

Trait Implementations

impl<T: Config> BeforeAllRuntimeMigrations for Pallet<T>

fn before_all_runtime_migrations() -> Weight

Something that should happen before runtime migrations are executed.

impl<T> Benchmarking for Pallet<T>

where T: Config + Config,

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> Callable<T> for Pallet<T>

type RuntimeCall = Call<T>

impl<T> Clone for Pallet<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> Debug for Pallet<T>

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

Formats the value using the given formatter.

impl<T: Config> GetStorageVersion for Pallet<T>

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

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

Weight: see begin_block

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 try_state(_n: BlockNumber) -> Result<(), DispatchError>

Execute the sanity checks of this pallet, per block.

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> IntegrityTest for Pallet<T>

fn integrity_test()

See [Hooks::integrity_test].

impl<T: Config> OffchainWorker<<<<T as Config>::Block as HeaderProvider>::HeaderT as Header>::Number> for Pallet<T>

fn offchain_worker(n: BlockNumberFor<T>)

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

impl<T: Config> OnFinalize<<<<T as Config>::Block as HeaderProvider>::HeaderT as Header>::Number> for Pallet<T>

fn on_finalize(n: BlockNumberFor<T>)

See [Hooks::on_finalize].

impl<T: Config> OnGenesis for Pallet<T>

fn on_genesis()

Something that should happen at genesis.

impl<T: Config> OnIdle<<<<T as Config>::Block as HeaderProvider>::HeaderT as Header>::Number> for Pallet<T>

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

See [Hooks::on_idle].

impl<T: Config> OnInitialize<<<<T as Config>::Block as HeaderProvider>::HeaderT as Header>::Number> for Pallet<T>

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

See [Hooks::on_initialize].

impl<T: Config> OnPoll<<<<T as Config>::Block as HeaderProvider>::HeaderT as Header>::Number> for Pallet<T>

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> OnRuntimeUpgrade for Pallet<T>

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> PalletInfoAccess for Pallet<T>

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> PalletsInfoAccess for Pallet<T>

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> PartialEq for Pallet<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: Config> StorageInfoTrait for Pallet<T>

fn storage_info() -> Vec<StorageInfo>

impl<T: Config> TryDecodeEntireStorage for Pallet<T>

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

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

Execute the state checks.

impl<T: Config> WhitelistedStorageKeys for Pallet<T>

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> Eq for Pallet<T>