Struct pallet_conviction_voting::pallet::Pallet

pub struct Pallet<T, I = ()>(_);

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

Implementations

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

pub fn vote( origin: OriginFor<T>, poll_index: <<T as Config<I>>::Polls as Polling<TallyOf<T, I>>>::Index, vote: AccountVote<<<T as Config<I>>::Currency as Currency<<T as Config>::AccountId>>::Balance> ) -> DispatchResult

Vote in a poll. 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.

• poll_index: The index of the poll to vote for.
• vote: The vote configuration.

Weight: O(R) where R is the number of polls the voter has voted on.

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

Delegate the voting power (with some given conviction) of the sending account for a particular class of polls.

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.

• class: The class of polls to delegate. To delegate multiple classes, multiple calls to this function are required.

• 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 polls the voter delegating to has voted on. Weight is initially charged as if maximum votes, but is refunded later.

pub fn undelegate( origin: OriginFor<T>, class: <<T as Config<I>>::Polls as Polling<TallyOf<T, I>>>::Class ) -> DispatchResultWithPostInfo

Undelegate the voting power of the sending account for a particular class of polls.

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

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

• class: The class of polls to remove the delegation from.

Emits Undelegated.

Weight: O(R) where R is the number of polls the voter delegating to has voted on. Weight is initially charged as if maximum votes, but is refunded later.

pub fn unlock( origin: OriginFor<T>, class: <<T as Config<I>>::Polls as Polling<TallyOf<T, I>>>::Class, target: <<T as Config>::Lookup as StaticLookup>::Source ) -> DispatchResult

Remove the lock caused by prior voting/delegating which has expired within a particular class.

The dispatch origin of this call must be Signed.

• class: The class of polls to unlock.
• 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>, class: Option<<<T as Config<I>>::Polls as Polling<TallyOf<T, I>>>::Class>, index: <<T as Config<I>>::Polls as Polling<TallyOf<T, I>>>::Index ) -> DispatchResult

Remove a vote for a poll.

If:

• the poll was cancelled, or
• the poll is ongoing, or
• the poll 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 poll 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 poll index.

• index: The index of poll of the vote to be removed.
• class: Optional parameter, if given it indicates the class of the poll. For polls which have finished or are cancelled, this must be Some.

Weight: O(R + log R) where R is the number of polls 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, class: <<T as Config<I>>::Polls as Polling<TallyOf<T, I>>>::Class, index: <<T as Config<I>>::Polls as Polling<TallyOf<T, I>>>::Index ) -> DispatchResult

Remove a vote for a poll.

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 poll was cancelled, because the voter lost the poll 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 poll index.
• index: The index of poll of the vote to be removed.
• class: The class of the poll.

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

Trait Implementations

impl<T, I: 'static> Benchmarking for Pallet<T, I>where T: Config + Config<I>, T::MaxVotes: Debug,

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<I>, I: 'static> Callable<T> for Pallet<T, I>

type RuntimeCall = Call<T, I>

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

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

Formats the value using the given formatter.

impl<T: Config<I>, I: 'static> GetStorageVersion for Pallet<T, I>

type CurrentStorageVersion = NoStorageVersionSet

This will be filled out by the pallet macro.

fn current_storage_version() -> Self::CurrentStorageVersion

Returns the current storage version as supported by the pallet.

fn on_chain_storage_version() -> StorageVersion

Returns the on-chain storage version of the pallet as stored in the storage.

impl<T: Config<I>, I: 'static> Hooks<<<<T as Config>::Block as HeaderProvider>::HeaderT as Header>::Number> for Pallet<T, I>

fn on_initialize(_n: BlockNumber) -> Weight

Block initialization hook. This is called at the very beginning of block execution.

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

Hook executed when a code change (aka. a “runtime upgrade”) is detected by FRAME.

fn try_state(_n: BlockNumber) -> Result<(), DispatchError>

Execute the sanity checks of this pallet, per block.

fn pre_upgrade() -> Result<Vec<u8, Global>, DispatchError>

Execute some pre-checks prior to a runtime upgrade.

fn post_upgrade(_state: Vec<u8, Global>) -> 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 wasm runtime.

fn integrity_test()

Check the integrity of this pallet’s configuration.

impl<T: Config<I>, I: 'static> IntegrityTest for Pallet<T, I>

fn integrity_test()

See Hooks::integrity_test.

impl<T: Config<I>, I: 'static> OffchainWorker<<<<T as Config>::Block as HeaderProvider>::HeaderT as Header>::Number> for Pallet<T, I>

fn offchain_worker(n: BlockNumberFor<T>)

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

impl<T: Config<I>, I: 'static> OnFinalize<<<<T as Config>::Block as HeaderProvider>::HeaderT as Header>::Number> for Pallet<T, I>

fn on_finalize(n: BlockNumberFor<T>)

See Hooks::on_finalize.

impl<T: Config<I>, I: 'static> OnGenesis for Pallet<T, I>

fn on_genesis()

Something that should happen at genesis.

impl<T: Config<I>, I: 'static> OnIdle<<<<T as Config>::Block as HeaderProvider>::HeaderT as Header>::Number> for Pallet<T, I>

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

See Hooks::on_idle.

impl<T: Config<I>, I: 'static> OnInitialize<<<<T as Config>::Block as HeaderProvider>::HeaderT as Header>::Number> for Pallet<T, I>

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

See Hooks::on_initialize.

impl<T: Config<I>, I: 'static> OnRuntimeUpgrade for Pallet<T, I>

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<I>, I: 'static> PalletInfoAccess for Pallet<T, I>

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 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<I>, I: 'static> PalletsInfoAccess for Pallet<T, I>

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

fn storage_info() -> Vec<StorageInfo>

impl<T: Config<I>, I: 'static> TryState<<<<T as Config>::Block as HeaderProvider>::HeaderT as Header>::Number> for Pallet<T, I>

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

Execute the state checks.

impl<T: Config<I>, I: 'static> WhitelistedStorageKeys for Pallet<T, I>

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