Struct pallet_society::pallet::Pallet

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

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 bid( origin: OriginFor<T>, value: <<T as Config<I>>::Currency as Currency<<T as Config>::AccountId>>::Balance, ) -> DispatchResult

A user outside of the society can make a bid for entry.

Payment: The group’s Candidate Deposit will be reserved for making a bid. It is returned when the bid becomes a member, or if the bid calls unbid.

The dispatch origin for this call must be Signed.

Parameters:

• value: A one time payment the bid would like to receive when joining the society.

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

A bidder can remove their bid for entry into society. By doing so, they will have their candidate deposit returned or they will unvouch their voucher.

Payment: The bid deposit is unreserved if the user made a bid.

The dispatch origin for this call must be Signed and a bidder.

pub fn vouch( origin: OriginFor<T>, who: <<T as Config>::Lookup as StaticLookup>::Source, value: <<T as Config<I>>::Currency as Currency<<T as Config>::AccountId>>::Balance, tip: <<T as Config<I>>::Currency as Currency<<T as Config>::AccountId>>::Balance, ) -> DispatchResult

As a member, vouch for someone to join society by placing a bid on their behalf.

There is no deposit required to vouch for a new bid, but a member can only vouch for one bid at a time. If the bid becomes a suspended candidate and ultimately rejected by the suspension judgement origin, the member will be banned from vouching again.

As a vouching member, you can claim a tip if the candidate is accepted. This tip will be paid as a portion of the reward the member will receive for joining the society.

The dispatch origin for this call must be Signed and a member.

Parameters:

• who: The user who you would like to vouch for.
• value: The total reward to be paid between you and the candidate if they become a member in the society.
• tip: Your cut of the total value payout when the candidate is inducted into the society. Tips larger than value will be saturated upon payout.

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

As a vouching member, unvouch a bid. This only works while vouched user is only a bidder (and not a candidate).

The dispatch origin for this call must be Signed and a vouching member.

Parameters:

• pos: Position in the Bids vector of the bid who should be unvouched.

pub fn vote( origin: OriginFor<T>, candidate: <<T as Config>::Lookup as StaticLookup>::Source, approve: bool, ) -> DispatchResultWithPostInfo

As a member, vote on a candidate.

The dispatch origin for this call must be Signed and a member.

Parameters:

• candidate: The candidate that the member would like to bid on.
• approve: A boolean which says if the candidate should be approved (true) or rejected (false).

pub fn defender_vote( origin: OriginFor<T>, approve: bool, ) -> DispatchResultWithPostInfo

As a member, vote on the defender.

The dispatch origin for this call must be Signed and a member.

Parameters:

• approve: A boolean which says if the candidate should be approved (true) or rejected (false).

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

Transfer the first matured payout for the sender and remove it from the records.

NOTE: This extrinsic needs to be called multiple times to claim multiple matured payouts.

Payment: The member will receive a payment equal to their first matured payout to their free balance.

The dispatch origin for this call must be Signed and a member with payouts remaining.

pub fn waive_repay( origin: OriginFor<T>, amount: <<T as Config<I>>::Currency as Currency<<T as Config>::AccountId>>::Balance, ) -> DispatchResult

Repay the payment previously given to the member with the signed origin, remove any pending payments, and elevate them from rank 0 to rank 1.

pub fn found_society( origin: OriginFor<T>, founder: <<T as Config>::Lookup as StaticLookup>::Source, max_members: u32, max_intake: u32, max_strikes: u32, candidate_deposit: <<T as Config<I>>::Currency as Currency<<T as Config>::AccountId>>::Balance, rules: Vec<u8>, ) -> DispatchResult

Found the society.

This is done as a discrete action in order to allow for the pallet to be included into a running chain and can only be done once.

The dispatch origin for this call must be from the FounderSetOrigin.

Parameters:

• founder - The first member and head of the newly founded society.
• max_members - The initial max number of members for the society.
• max_intake - The maximum number of candidates per intake period.
• max_strikes: The maximum number of strikes a member may get before they become suspended and may only be reinstated by the founder.
• candidate_deposit: The deposit required to make a bid for membership of the group.
• rules - The rules of this society concerning membership.

Complexity: O(1)

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

Dissolve the society and remove all members.

The dispatch origin for this call must be Signed, and the signing account must be both the Founder and the Head. This implies that it may only be done when there is one member.

pub fn judge_suspended_member( origin: OriginFor<T>, who: <<T as Config>::Lookup as StaticLookup>::Source, forgive: bool, ) -> DispatchResultWithPostInfo

Allow suspension judgement origin to make judgement on a suspended member.

If a suspended member is forgiven, we simply add them back as a member, not affecting any of the existing storage items for that member.

If a suspended member is rejected, remove all associated storage items, including their payouts, and remove any vouched bids they currently have.

The dispatch origin for this call must be Signed from the Founder.

Parameters:

• who - The suspended member to be judged.
• forgive - A boolean representing whether the suspension judgement origin forgives (true) or rejects (false) a suspended member.

pub fn set_parameters( origin: OriginFor<T>, max_members: u32, max_intake: u32, max_strikes: u32, candidate_deposit: <<T as Config<I>>::Currency as Currency<<T as Config>::AccountId>>::Balance, ) -> DispatchResult

Change the maximum number of members in society and the maximum number of new candidates in a single intake period.

The dispatch origin for this call must be Signed by the Founder.

Parameters:

• max_members - The maximum number of members for the society. This must be no less than the current number of members.
• max_intake - The maximum number of candidates per intake period.
• max_strikes: The maximum number of strikes a member may get before they become suspended and may only be reinstated by the founder.
• candidate_deposit: The deposit required to make a bid for membership of the group.

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

Punish the skeptic with a strike if they did not vote on a candidate. Callable by the candidate.

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

Transform an approved candidate into a member. Callable only by the the candidate, and only after the period for voting has ended.

pub fn bestow_membership( origin: OriginFor<T>, candidate: T::AccountId, ) -> DispatchResultWithPostInfo

Transform an approved candidate into a member. Callable only by the Signed origin of the Founder, only after the period for voting has ended and only when the candidate is not clearly rejected.

pub fn kick_candidate( origin: OriginFor<T>, candidate: T::AccountId, ) -> DispatchResultWithPostInfo

Remove the candidate’s application from the society. Callable only by the Signed origin of the Founder, only after the period for voting has ended, and only when they do not have a clear approval.

Any bid deposit is lost and voucher is banned.

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

Remove the candidate’s application from the society. Callable only by the candidate.

Any bid deposit is lost and voucher is banned.

pub fn drop_candidate( origin: OriginFor<T>, candidate: T::AccountId, ) -> DispatchResultWithPostInfo

Remove a candidate’s failed application from the society. Callable by any signed origin but only at the end of the subsequent round and only for a candidate with more rejections than approvals.

The bid deposit is lost and the voucher is banned.

pub fn cleanup_candidacy( origin: OriginFor<T>, candidate: T::AccountId, max: u32, ) -> DispatchResultWithPostInfo

Remove up to max stale votes for the given candidate.

May be called by any Signed origin, but only after the candidate’s candidacy is ended.

pub fn cleanup_challenge( origin: OriginFor<T>, challenge_round: RoundIndex, max: u32, ) -> DispatchResultWithPostInfo

Remove up to max stale votes for the defender in the given challenge_round.

May be called by any Signed origin, but only after the challenge round is ended.

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

pub fn select_new_candidates( round: RoundIndex, member_count: u32, pot: <<T as Config<I>>::Currency as Currency<<T as Config>::AccountId>>::Balance, ) -> u32

Remove a selection of bidding accounts such that the total bids is no greater than Pot and the number of bids would not surpass MaxMembers if all were accepted. At most one bid may be zero.

Candidates are inserted from each bidder.

The number of candidates inserted are returned.

pub fn remove_member(m: &T::AccountId) -> Result<MemberRecord, DispatchError>

Remove a member from the members list and return the candidacy.

If the member was vouching, then this will be reset. Any bidders that the member was vouching for will be cancelled unless they are already selected as candidates (in which case they will be able to stand).

If the member has existing payouts, they will be retained in the resultant MemberRecord and the funds will remain reserved.

The Head and the Founder may never be removed.

pub fn account_id() -> T::AccountId

The account ID of the treasury pot.

This actually does computation. If you need to keep using it, then make sure you cache the value and only call this once.

pub fn payouts() -> T::AccountId

The account ID of the payouts pot. This is where payouts are made from.

This actually does computation. If you need to keep using it, then make sure you cache the value and only call this once.

Trait Implementations

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

fn before_all_runtime_migrations() -> Weight

Something that should happen before runtime migrations are executed.

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

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

fn on_initialize(n: BlockNumberFor<T>) -> 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_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<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> OnPoll<<<<T as Config>::Block as HeaderProvider>::HeaderT as Header>::Number> for Pallet<T, I>

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<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> OnUnbalanced<<<T as Config<I>>::Currency as Currency<<T as Config>::AccountId>>::NegativeImbalance> for Pallet<T, I>

fn on_nonzero_unbalanced( amount: <<T as Config<I>>::Currency as Currency<<T as Config>::AccountId>>::NegativeImbalance, )

Actually handle a non-zero imbalance. You probably want to implement this rather than on_unbalanced.

fn on_unbalanceds(amounts: impl Iterator<Item = Imbalance>)

where Imbalance: TryMerge,

Handler for some imbalances. The different imbalances might have different origins or meanings, dependent on the context. Will default to simply calling on_unbalanced for all of them. Infallible.

fn on_unbalanced(amount: Imbalance)

Handler for some imbalance. Infallible.

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

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