Struct pallet_society::Module

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

The module declaration.

Methods

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

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

The first member.

pub fn rules() -> Option<T::Hash>

A hash of the rules of this society concerning membership. Can only be set once and only by the founder.

pub fn candidates(
) -> Vec<Bid<T::AccountId, <<T as Trait<I>>::Currency as Currency<<T as Trait>::AccountId>>::Balance>>

The current set of candidates; bidders that are attempting to become members.

pub fn suspended_candidate<K: EncodeLike<T::AccountId>>(
    key: K
) -> Option<(<<T as Trait<I>>::Currency as Currency<<T as Trait>::AccountId>>::Balance, BidKind<T::AccountId, <<T as Trait<I>>::Currency as Currency<<T as Trait>::AccountId>>::Balance>)>

The set of suspended candidates.

pub fn pot(
) -> <<T as Trait<I>>::Currency as Currency<<T as Trait>::AccountId>>::Balance

Amount of our account balance that is specifically for the next round's bid(s).

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

The most primary from the most recently approved members.

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

The current set of members, ordered.

pub fn suspended_member<K: EncodeLike<T::AccountId>>(key: K) -> bool

The set of suspended members.

pub fn vouching<K: EncodeLike<T::AccountId>>(key: K) -> Option<VouchingStatus>

Members currently vouching or banned from vouching again

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

The defending member currently being challenged.

pub fn max_members() -> u32

The max number of members for the society at one time.

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

Can also be called using Call.

pub fn bid(
    origin: T::Origin,
    value: <<T as Trait<I>>::Currency as Currency<<T as Trait>::AccountId>>::Balance
) -> DispatchResult

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

Payment: CandidateDeposit 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.

Key: B (len of bids), C (len of candidates), M (len of members), X (balance reserve)

• Storage Reads:
  • One storage read to check for suspended candidate. O(1)
  • One storage read to check for suspended member. O(1)
  • One storage read to retrieve all current bids. O(B)
  • One storage read to retrieve all current candidates. O(C)
  • One storage read to retrieve all members. O(M)
• Storage Writes:
  • One storage mutate to add a new bid to the vector O(B) (TODO: possible optimization w/ read)
  • Up to one storage removal if bid.len() > MAX_BID_COUNT. O(1)
• Notable Computation:
  • O(B + C + log M) search to check user is not already a part of society.
  • O(log B) search to insert the new bid sorted.
• External Module Operations:
  • One balance reserve operation. O(X)
  • Up to one balance unreserve operation if bids.len() > MAX_BID_COUNT.
• Events:
  • One event for new bid.
  • Up to one event for AutoUnbid if bid.len() > MAX_BID_COUNT.

Total Complexity: O(M + B + C + logM + logB + X)

pub fn unbid(origin: T::Origin, pos: u32) -> 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.

Parameters:

• pos: Position in the Bids vector of the bid who wants to unbid.

Key: B (len of bids), X (balance unreserve)

• One storage read and write to retrieve and update the bids. O(B)
• Either one unreserve balance action O(X) or one vouching storage removal. O(1)
• One event.

Total Complexity: O(B + X)

pub fn vouch(
    origin: T::Origin,
    who: T::AccountId,
    value: <<T as Trait<I>>::Currency as Currency<<T as Trait>::AccountId>>::Balance,
    tip: <<T as Trait<I>>::Currency as Currency<<T as Trait>::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.

Key: B (len of bids), C (len of candidates), M (len of members)

• Storage Reads:
  • One storage read to retrieve all members. O(M)
  • One storage read to check member is not already vouching. O(1)
  • One storage read to check for suspended candidate. O(1)
  • One storage read to check for suspended member. O(1)
  • One storage read to retrieve all current bids. O(B)
  • One storage read to retrieve all current candidates. O(C)
• Storage Writes:
  • One storage write to insert vouching status to the member. O(1)
  • One storage mutate to add a new bid to the vector O(B) (TODO: possible optimization w/ read)
  • Up to one storage removal if bid.len() > MAX_BID_COUNT. O(1)
• Notable Computation:
  • O(log M) search to check sender is a member.
  • O(B + C + log M) search to check user is not already a part of society.
  • O(log B) search to insert the new bid sorted.
• External Module Operations:
  • One balance reserve operation. O(X)
  • Up to one balance unreserve operation if bids.len() > MAX_BID_COUNT.
• Events:
  • One event for vouch.
  • Up to one event for AutoUnbid if bid.len() > MAX_BID_COUNT.

Total Complexity: O(M + B + C + logM + logB + X)

pub fn unvouch(origin: T::Origin, pos: u32) -> 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.

Key: B (len of bids)

• One storage read O(1) to check the signer is a vouching member.
• One storage mutate to retrieve and update the bids. O(B)
• One vouching storage removal. O(1)
• One event.

Total Complexity: O(B)

pub fn vote(
    origin: T::Origin,
    candidate: <T::Lookup as StaticLookup>::Source,
    approve: bool
) -> DispatchResult

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

Key: C (len of candidates), M (len of members)

• One storage read O(M) and O(log M) search to check user is a member.
• One account lookup.
• One storage read O(C) and O(C) search to check that user is a candidate.
• One storage write to add vote to votes. O(1)
• One event.

Total Complexity: O(M + logM + C)

pub fn defender_vote(origin: T::Origin, approve: bool) -> DispatchResult

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

• Key: M (len of members)
• One storage read O(M) and O(log M) search to check user is a member.
• One storage write to add vote to votes. O(1)
• One event.

Total Complexity: O(M + logM)

pub fn payout(origin: T::Origin) -> 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.

Key: M (len of members), P (number of payouts for a particular member)

• One storage read O(M) and O(log M) search to check signer is a member.
• One storage read O(P) to get all payouts for a member.
• One storage read O(1) to get the current block number.
• One currency transfer call. O(X)
• One storage write or removal to update the member's payouts. O(P)

Total Complexity: O(M + logM + P + X)

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

pub fn remove_member(m: &T::AccountId) -> DispatchResult

Remove a member from the members list, except the Head.

NOTE: This does not correctly clean up a member from storage. It simply removes them from the Members storage item.

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.

pub fn take_selected(
    members_len: usize,
    pot: <<T as Trait<I>>::Currency as Currency<<T as Trait>::AccountId>>::Balance
) -> Vec<Bid<T::AccountId, <<T as Trait<I>>::Currency as Currency<<T as Trait>::AccountId>>::Balance>>

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

May be empty.

Trait Implementations

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

type Call = Call<T, I>

impl<T: Clone + Trait<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: Copy + Trait<I>, I: Copy + Instance> Copy for Module<T, I>

impl<T: Trait<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: Eq + Trait<I>, I: Eq + Instance> Eq for Module<T, I>

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

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

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

fn offchain_worker(_n: BlockNumber)

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

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

fn on_finalize(_n: BlockNumber)

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

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

fn on_initialize(n: T::BlockNumber)

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

impl<T: PartialEq + Trait<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: Trait<I>, I: Instance> StructuralEq for Module<T, I>

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

impl<T: Trait<I>, I: Instance> WeighBlock<<T as Trait>::BlockNumber> for Module<T, I>

fn on_initialize(n: T::BlockNumber) -> Weight

Return the weight of the block's on_initialize hook.

fn on_finalize(BlockNumber) -> u32

Return the weight of the block's on_finalize hook.