Struct pallet_core_fellowship::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 bump( origin: OriginFor<T>, who: T::AccountId ) -> DispatchResultWithPostInfo

Bump the state of a member.

This will demote a member whose last_proof is now beyond their rank’s demotion_period.

• origin: A Signed origin of an account.
• who: A member account whose state is to be updated.

pub fn set_params( origin: OriginFor<T>, params: Box<ParamsOf<T, I>> ) -> DispatchResult

Set the parameters.

• origin: An origin complying with ParamsOrigin or root.
• params: The new parameters for the pallet.

pub fn set_active(origin: OriginFor<T>, is_active: bool) -> DispatchResult

Set whether a member is active or not.

• origin: A Signed origin of a member’s account.
• is_active: true iff the member is active.

pub fn approve( origin: OriginFor<T>, who: T::AccountId, at_rank: RankOf<T, I> ) -> DispatchResult

Approve a member to continue at their rank.

This resets last_proof to the current block, thereby delaying any automatic demotion.

If who is not already tracked by this pallet, then it will become tracked. last_promotion will be set to zero.

• origin: An origin which satisfies ApproveOrigin or root.
• who: A member (i.e. of non-zero rank).
• at_rank: The rank of member.

pub fn induct(origin: OriginFor<T>, who: T::AccountId) -> DispatchResult

Introduce a new and unranked candidate (rank zero).

• origin: An origin which satisfies InductOrigin or root.
• who: The account ID of the candidate to be inducted and become a member.

pub fn promote( origin: OriginFor<T>, who: T::AccountId, to_rank: RankOf<T, I> ) -> DispatchResult

Increment the rank of a ranked and tracked account.

• origin: An origin which satisfies PromoteOrigin with a Success result of to_rank or more or root.
• who: The account ID of the member to be promoted to to_rank.
• to_rank: One more than the current rank of who.

pub fn offboard( origin: OriginFor<T>, who: T::AccountId ) -> DispatchResultWithPostInfo

Stop tracking a prior member who is now not a ranked member of the collective.

• origin: A Signed origin of an account.
• who: The ID of an account which was tracked in this pallet but which is now not a ranked member of the collective.

pub fn submit_evidence( origin: OriginFor<T>, wish: Wish, evidence: Evidence<T, I> ) -> DispatchResultWithPostInfo

Provide evidence that a rank is deserved.

This is free as long as no evidence for the forthcoming judgement is already submitted. Evidence is cleared after an outcome (either demotion, promotion of approval).

• origin: A Signed origin of an inducted and ranked account.
• wish: The stated desire of the member.
• evidence: A dump of evidence to be considered. This should generally be either a Markdown-encoded document or a series of 32-byte hashes which can be found on a decentralised content-based-indexing system such as IPFS.

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

Introduce an already-ranked individual of the collective into this pallet. The rank may still be zero.

This resets last_proof to the current block and last_promotion will be set to zero, thereby delaying any automatic demotion but allowing immediate promotion.

• origin: A signed origin of a ranked, but not tracked, account.

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> GetSalary<<<T as Config<I>>::Members as RankedMembers>::Rank, <T as Config>::AccountId, <T as Config<I>>::Balance> for Pallet<T, I>

fn get_salary(rank: RankOf<T, I>, who: &T::AccountId) -> T::Balance

Retrieve the salary for a given rank. The account ID is also supplied in case this changes things.

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>