Struct pallet_collective::Module

pub struct Module<T: Config<I>, I: Instance = DefaultInstance>(_);

Implementations

impl<T: Config<I> + 'static, I: Instance> Module<T, I>

pub fn proposals() -> BoundedVec<T::Hash, T::MaxProposals>

The hashes of the active proposals.

pub fn proposal_of<K: EncodeLike<T::Hash>>(
    key: K
) -> Option<<T as Config<I>>::Proposal>

Actual proposal for a given hash, if it’s current.

pub fn voting<K: EncodeLike<T::Hash>>(
    key: K
) -> Option<Votes<T::AccountId, T::BlockNumber>>

Votes on a given proposal, if it is ongoing.

pub fn proposal_count() -> u32

Proposals so far.

pub fn members() -> Vec<T::AccountId>

The current members of the collective. This is stored sorted (just by value).

pub fn prime() -> Option<T::AccountId>

The prime member that helps determine the default vote behavior in case of absentations.

impl<T: Config<I>, I: Instance> Module<T, I>

pub fn is_member(who: &T::AccountId) -> bool

Check whether who is a member of the collective.

Trait Implementations

impl<T: Config<I>, I: Instance> Callable<T> for Module<T, I>

type Call = Call<T, I>

impl<T: Config<I>, I: Instance> ChangeMembers<<T as Config>::AccountId> for Module<T, I>

fn change_members_sorted(
    _incoming: &[T::AccountId],
    outgoing: &[T::AccountId],
    new: &[T::AccountId]
)

Update the members of the collective. Votes are updated and the prime is reset.

NOTE: Does not enforce the expected MaxMembers limit on the amount of members, but the weight estimations rely on it to estimate dispatchable weight.

Weight

• O(MP + N)
  • where M old-members-count (governance-bounded)
  • where N new-members-count (governance-bounded)
  • where P proposals-count
• DB:
  • 1 storage read (codec O(P)) for reading the proposals
  • P storage mutations for updating the votes (codec O(M))
  • 1 storage write (codec O(N)) for storing the new members
  • 1 storage write (codec O(1)) for deleting the old prime

fn set_prime(prime: Option<T::AccountId>)

Set the prime member.

fn get_prime() -> Option<T::AccountId>

Get the current prime.

fn change_members(
    incoming: &[AccountId],
    outgoing: &[AccountId],
    new: Vec<AccountId, Global>
)

A number of members incoming just joined the set and replaced some outgoing ones. The new set is given by new, and need not be sorted.

fn set_members_sorted(new_members: &[AccountId], old_members: &[AccountId])

Set the new members; they must already be sorted. This will compute the diff and use it to call change_members_sorted.

fn compute_members_diff_sorted(
    new_members: &[AccountId],
    old_members: &[AccountId]
) -> (Vec<AccountId, Global>, Vec<AccountId, Global>)

Compute diff between new and old members; they must already be sorted.

impl<T: Clone + Config<I>, I: Clone + Instance> Clone for Module<T, I>

fn clone(&self) -> Module<T, I>

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<T: Config<I>, I: Instance> Debug for Module<T, I> where
    T: Debug,
    I: Debug, 

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

Formats the value using the given formatter.

impl<T: Config<I>, I: Instance> GetStorageVersion for Module<T, I>

fn current_storage_version() -> StorageVersion

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: Instance> InitializeMembers<<T as Config>::AccountId> for Module<T, I>

fn initialize_members(members: &[T::AccountId])

Initialize the members to the given members.

impl<T: Config<I>, I: Instance> IntegrityTest for Module<T, I>

fn integrity_test()

Run integrity test.

impl<T: Config<I>, I: Instance> ModuleErrorMetadata for Module<T, I>

fn metadata() -> &'static [ErrorMetadata]

impl<T: Config + Config<I>, I: Instance> OffchainWorker<<T as Config>::BlockNumber> for Module<T, I>

fn offchain_worker(_n: BlockNumber)

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

impl<T: Config + Config<I>, I: Instance> OnFinalize<<T as Config>::BlockNumber> for Module<T, I>

fn on_finalize(_n: BlockNumber)

The block is being finalized. Implement to have something happen.

impl<T: Config<I>, I: Instance> OnGenesis for Module<T, I>

fn on_genesis()

Something that should happen at genesis.

impl<T: Config + Config<I>, I: Instance> OnIdle<<T as Config>::BlockNumber> for Module<T, I>

fn on_idle(_n: BlockNumber, _remaining_weight: u64) -> u64

The block is being finalized. Implement to have something happen in case there is leftover weight. Check the passed remaining_weight to make sure it is high enough to allow for your pallet’s extra computation.

impl<T: Config + Config<I>, I: Instance> OnInitialize<<T as Config>::BlockNumber> for Module<T, I>

fn on_initialize(_n: BlockNumber) -> u64

The block is being initialized. Implement to have something happen.

impl<T: Config<I>, I: Instance> OnRuntimeUpgrade for Module<T, I>

fn on_runtime_upgrade() -> Weight

Perform a module upgrade.

fn pre_upgrade() -> Result<(), &'static str>

Execute some pre-checks prior to a runtime upgrade.

fn post_upgrade() -> Result<(), &'static str>

Execute some post-checks after a runtime upgrade.

impl<T: Config<I>, I: Instance> PalletInfoAccess for Module<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.

impl<T: PartialEq + Config<I>, I: PartialEq + Instance> PartialEq<Module<T, I>> for Module<T, I>

fn eq(&self, other: &Module<T, I>) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Module<T, I>) -> bool

This method tests for !=.

impl<T: Config<I> + 'static, I: Instance> StorageInfoTrait for Module<T, I>

fn storage_info() -> Vec<StorageInfo>

impl<T: Copy + Config<I>, I: Copy + Instance> Copy for Module<T, I>

impl<T: Eq + Config<I>, I: Eq + Instance> Eq for Module<T, I>

impl<T: Config<I>, I: Instance> StructuralEq for Module<T, I>

impl<T: Config<I>, I: Instance> StructuralPartialEq for Module<T, I>