Trait frame_support::traits::VoteTally

pub trait VoteTally<Votes, Class> {
    // Required methods
    fn new(_: Class) -> Self;
    fn ayes(&self, class: Class) -> Votes;
    fn support(&self, class: Class) -> Perbill;
    fn approval(&self, class: Class) -> Perbill;
    fn unanimity(class: Class) -> Self;
    fn rejection(class: Class) -> Self;
    fn from_requirements(
        support: Perbill,
        approval: Perbill,
        class: Class,
    ) -> Self;
    fn setup(class: Class, granularity: Perbill);
}

Required Methods

fn new(_: Class) -> Self

Initializes a new tally.

fn ayes(&self, class: Class) -> Votes

Returns the number of positive votes for the tally.

fn support(&self, class: Class) -> Perbill

Returns the approval ratio (positive to total votes) for the tally, without multipliers (e.g. conviction, ranks, etc.).

fn approval(&self, class: Class) -> Perbill

Returns the approval ratio (positive to total votes) for the tally.

fn unanimity(class: Class) -> Self

Returns an instance of the tally representing a unanimous approval, for benchmarking purposes.

fn rejection(class: Class) -> Self

Returns an instance of the tally representing a rejecting state, for benchmarking purposes.

fn from_requirements(support: Perbill, approval: Perbill, class: Class) -> Self

Returns an instance of the tally given some approval and support, for benchmarking purposes.

fn setup(class: Class, granularity: Perbill)

A function that should be called before any use of the runtime-benchmarks gated functions of the VoteTally trait.

Should be used to set up any needed state in a Pallet which implements VoteTally so that benchmarks that execute will complete successfully. class can be used to set up a particular class of voters, and granularity is used to determine the weight of one vote relative to total unanimity.

For example, in the case where there are a number of unique voters, and each voter has equal voting weight, a granularity of Perbill::from_rational(1, 1000) should create 1_000 users.

Object Safety

This trait is not object safe.

Implementors