Struct pallet_ranked_collective::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 add_member( origin: OriginFor<T>, who: <<T as Config>::Lookup as StaticLookup>::Source ) -> DispatchResult

Introduce a new member.

• origin: Must be the AdminOrigin.
• who: Account of non-member which will become a member.
• rank: The rank to give the new member.

Weight: O(1)

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

Increment the rank of an existing member by one.

• origin: Must be the AdminOrigin.
• who: Account of existing member.

Weight: O(1)

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

Decrement the rank of an existing member by one. If the member is already at rank zero, then they are removed entirely.

• origin: Must be the AdminOrigin.
• who: Account of existing member of rank greater than zero.

Weight: O(1), less if the member’s index is highest in its rank.

pub fn remove_member( origin: OriginFor<T>, who: <<T as Config>::Lookup as StaticLookup>::Source, min_rank: Rank ) -> DispatchResultWithPostInfo

Remove the member entirely.

• origin: Must be the AdminOrigin.
• who: Account of existing member of rank greater than zero.
• min_rank: The rank of the member or greater.

Weight: O(min_rank).

pub fn vote( origin: OriginFor<T>, poll: PollIndexOf<T, I>, aye: bool ) -> DispatchResultWithPostInfo

Add an aye or nay vote for the sender to the given proposal.

• origin: Must be Signed by a member account.
• poll: Index of a poll which is ongoing.
• aye: true if the vote is to approve the proposal, false otherwise.

Transaction fees are be waived if the member is voting on any particular proposal for the first time and the call is successful. Subsequent vote changes will charge a fee.

Weight: O(1), less if there was no previous vote on the poll by the member.

pub fn cleanup_poll( origin: OriginFor<T>, poll_index: PollIndexOf<T, I>, max: u32 ) -> DispatchResultWithPostInfo

Remove votes from the given poll. It must have ended.

• origin: Must be Signed by any account.
• poll_index: Index of a poll which is completed and for which votes continue to exist.
• max: Maximum number of vote items from remove in this call.

Transaction fees are waived if the operation is successful.

Weight O(max) (less if there are fewer items to remove than max).

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

pub fn do_add_member(who: T::AccountId) -> DispatchResult

Adds a member into the ranked collective at level 0.

No origin checks are executed.

pub fn do_promote_member( who: T::AccountId, maybe_max_rank: Option<Rank> ) -> DispatchResult

Promotes a member in the ranked collective into the next higher rank.

A maybe_max_rank may be provided to check that the member does not get promoted beyond a certain rank. Is None is provided, then the rank will be incremented without checks.

pub fn do_add_member_to_rank(who: T::AccountId, rank: Rank) -> DispatchResult

Add a member to the rank collective, and continue to promote them until a certain rank is reached.

pub fn as_rank( o: &<T::RuntimeOrigin as OriginTrait>::PalletsOrigin ) -> Option<u16>

Determine the rank of the account behind the Signed origin o, None if the account is unknown to this collective or o is not Signed.

Trait Implementations

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

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

type Class = <<T as Config<I>>::Polls as Polling<Tally<T, I, Pallet<T, I>>>>::Class

Poll class type.

fn get_max_voters(c: Self::Class) -> MemberIndex

Return the maximum number of voters for the poll class c.

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

type AccountId = <T as Config>::AccountId

type Rank = u16

fn min_rank() -> Self::Rank

The lowest rank possible in this membership organisation.

fn rank_of(who: &Self::AccountId) -> Option<Self::Rank>

Return the rank of the given ID, or None if they are not a member.

fn induct(who: &Self::AccountId) -> DispatchResult

Add a member to the group at the min_rank().

fn promote(who: &Self::AccountId) -> DispatchResult

Promote a member to the next higher rank.

fn demote(who: &Self::AccountId) -> DispatchResult

Demote a member to the next lower rank; demoting beyond the min_rank removes the member entirely.

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>