Struct pallet_society::Module[−][src]

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

The module declaration.

Implementations

The first member.

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

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

The set of suspended candidates.

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

The most primary from the most recently approved members.

The current set of members, ordered.

The set of suspended members.

Members currently vouching or banned from vouching again

The defending member currently being challenged.

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

Can also be called using Call.

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)

NOTE: Calling this function will bypass origin filters.

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)

NOTE: Calling this function will bypass origin filters.

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)

NOTE: Calling this function will bypass origin filters.

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)

NOTE: Calling this function will bypass origin filters.

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)

NOTE: Calling this function will bypass origin filters.

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)

NOTE: Calling this function will bypass origin filters.

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)

NOTE: Calling this function will bypass origin filters.

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.

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.

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.

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

Returns a copy of the value. Read more

Performs copy-assignment from source. Read more

Formats the value using the given formatter. Read more

Returns the current storage version as supported by the pallet.

Returns the on-chain storage version of the pallet as stored in the storage.

Run integrity test. Read more

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

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

Something that should happen at genesis.

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. Read more

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

Perform a module upgrade. Read more

Execute some pre-checks prior to a runtime upgrade. Read more

Execute some post-checks after a runtime upgrade. Read more

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

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. Read more

Handler for some imbalance. Infallible.

Index of the pallet as configured in the runtime.

Name of the pallet as configured in the runtime.

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

This method tests for !=.

Auto Trait Implementations

Blanket Implementations

Gets the TypeId of self. Read more

Immutably borrows from an owned value. Read more

Mutably borrows from an owned value. Read more

Convert from a value of T into an equivalent instance of Option<Self>. Read more

Consume self to return Some equivalent value of Option<T>. Read more

Convert Box<dyn Trait> (where Trait: Downcast) to Box<dyn Any>. Box<dyn Any> can then be further downcast into Box<ConcreteType> where ConcreteType implements Trait. Read more

Convert Rc<Trait> (where Trait: Downcast) to Rc<Any>. Rc<Any> can then be further downcast into Rc<ConcreteType> where ConcreteType implements Trait. Read more

Convert &Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &Any’s vtable from &Trait’s. Read more

Convert &mut Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &mut Any’s vtable from &mut Trait’s. Read more

Convert Arc<Trait> (where Trait: Downcast) to Arc<Any>. Arc<Any> can then be further downcast into Arc<ConcreteType> where ConcreteType implements Trait. Read more

[src]
pub fn __clone_box(&self, Private) -> *mut ()

Performs the conversion.

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more

Instruments this type with the current Span, returning an Instrumented wrapper. Read more

Performs the conversion.

Cast reference.

Cast reference.

Cast mutable reference.

Cast mutable reference.

Get a reference to the inner from the outer.

Get a mutable reference to the inner from the outer.

Generate a storage key unique to this runtime upgrade. Read more

Get temporary storage data written by Self::set_temp_storage. Read more

Write some temporary data to a specific storage that can be read (potentially in post-upgrade hook) via Self::get_temp_storage. Read more

Should always be Self

Convert from a value of T into an equivalent instance of Self. Read more

Consume self to return an equivalent value of T. Read more

The resulting type after obtaining ownership.

Creates owned data from borrowed data, usually by cloning. Read more

🔬 This is a nightly-only experimental API. (toowned_clone_into)

recently added

Uses borrowed data to replace owned data, usually by cloning. Read more

The type returned in the event of a conversion error.

Performs the conversion.

The type returned in the event of a conversion error.

Performs the conversion.

The counterpart to unchecked_from.

Consume self to return an equivalent value of T.