Struct dao::voting::voting_engine::VotingEngine

pub struct VotingEngine { /* private fields */ }

Governance voting is a struct that voting_contracts can use to implement voting.

It consists of two phases:

1. Informal voting
2. Formal voting

Whether formal voting starts depends on informal voting results.

When formal voting passes, an action can be performed - a contract can be called with voted arguments.

Governance voting uses:

1. Reputation Token to handle reputation staking.
2. Variable Repo for reading voting configuration.

For example implementation see AdminContract.

Implementations

impl VotingEngine

pub fn create_voting( &mut self, creator: Address, stake: Balance, configuration: Configuration ) -> (VotingCreatedInfo, VotingStateMachine)

Creates new informal Voting.

contract_to_call, entry_point and runtime_args parameters define an action that will be performed when formal voting passes.

It collects configuration from Variable Repo and persists it, so they won’t change during the voting process.

Interacts with Dao Ids Contract to generate voting id.

Depending on the configuration may cast the first vote.

Errors

• Error::NotEnoughReputation when the creator does not have enough reputation to create a voting.
• Error::NotOnboarded if the configuration requires the creator to be a VA but is not.

pub fn finish_voting( &mut self, voting_id: VotingId, voting_type: VotingType ) -> VotingSummary

Finishes voting.

Depending on type of voting, different actions are performed.

For informal voting a new formal voting can be created. Reputation staked for this voting is returned to the voters, except for the creator. When voting passes, it is used as a stake for a new voting, otherwise it is burned.

For formal voting an action will be performed if the result is in favor. Reputation is redistributed to the winning voters. When no quorum is reached, the reputation is returned, except for the creator - its reputation is then burned.

Events

• VotingEnded
• BallotCast

Errors

• FinishingCompletedVotingNotAllowed if trying to complete already finished voting.
• FormalVotingTimeNotReached if formal voting time did not pass.
• InformalVotingTimeNotReached if informal voting time did not pass.
• ArithmeticOverflow in an unlikely event of a overflow when calculating reputation to redistribute.

pub fn cancel_finished_voting(&mut self, voting_id: VotingId)

Cancels finished voting if CancelFinishedVotingTimeout has passed.

pub fn finish_voting_without_token_redistribution( &mut self, voting_id: VotingId, configuration: &mut Configuration ) -> VotingSummary

Marks voting finished but do nothing with the staked reputation.

Errors

• Error::VotingDoesNotExist - voting with the given id does not exists.
• Error::FinishingCompletedVotingNotAllowed - voting is finished already.

pub fn vote( &mut self, voter: Address, voting_id: VotingId, voting_type: VotingType, choice: Choice, stake: Balance )

Writes a vote in the storage.

Events

• BallotCast

Errors

• VoteOnCompletedVotingNotAllowed if voting is completed.
• CannotVoteTwice if the voter already voted.

pub fn cast_ballot( &mut self, voter: Address, choice: Choice, stake: Balance, unbound: bool, voting: &mut VotingStateMachine, configuration: &Configuration )

Records voter’s vote.

Writes into the storage the vote details and stakes reputation (for a bound ballot).

Calls Reputation Token Contract to stake reputation.

Events

• BallotCast event.

pub fn all_voters( &self, voting_id: VotingId, voting_type: VotingType ) -> Vec<Address>

Gets a vector of all voters’ addresses.

pub fn get_ballot( &self, voting_id: VotingId, voting_type: VotingType, address: Address ) -> Option<Ballot>

Returns the Voter’s Ballot.

pub fn get_ballot_at( &self, voting_id: VotingId, voting_type: VotingType, i: u32 ) -> Ballot

Returns the nth Ballot of voting with a given id.

pub fn get_voter( &self, voting_id: VotingId, voting_type: VotingType, at: u32 ) -> Option<Address>

Returns the address of the nth voter who voted on Voting with a given id.

pub fn get_voting(&self, voting_id: VotingId) -> Option<VotingStateMachine>

Returns the Voting for a given id.

pub fn get_voting_or_revert(&self, voting_id: VotingId) -> VotingStateMachine

Gets voting with a given id or stops contract execution.

Errors

• Error::VotingDoesNotExist if the given id does not exist.

pub fn get_configuration_or_revert(&self, voting_id: VotingId) -> Configuration

Gets configuration with a given voting_id or stops contract execution.

Error

• Error::ConfigurationNotFound if the given id does not exist.

pub fn set_voting(&mut self, voting: VotingStateMachine)

Updates voting storage.

pub fn unstake_all_reputation( &mut self, voting_id: VotingId, voting_type: VotingType ) -> BTreeMap<Address, Balance>

Iterates over all the ballots and unstakes reputation. Returns a map of address to it’s stake.

Calls Reputation Token Contract to perform unstake operation.

pub fn voters( &self, voting_id: VotingId, voting_type: VotingType ) -> List<Address>

Get the governance voting’s voters list.

pub fn voters_count(&self, voting_id: VotingId, voting_type: VotingType) -> u32

Gets the total number of users participated in voting.

pub fn voting_exists( &self, voting_id: VotingId, voting_type: VotingType ) -> bool

Checks if voting with the given id and type exists.

pub fn slash_voter(&mut self, voter: Address) -> SlashedVotings

Erases a voter from all active votings.

If the voter is also the creator, voting is canceled. Otherwise, only his vote is invalidated.

Returns a tuple of vectors listing canceled and affected votings.j

Trait Implementations

impl Clone for VotingEngine

fn clone(&self) -> VotingEngine

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl DynamicInstance for VotingEngine

fn instance(namespace: &[u8]) -> Self

impl HasEvents for VotingEngine

fn events() -> Vec<Event>

impl Node for VotingEngine

const IS_LEAF: bool = false

const COUNT: u32 = 9u32

fn __keys() -> Vec<String>

impl OdraItem for VotingEngine

fn is_module() -> bool

fn events() -> Vec<Event>

impl StaticInstance for VotingEngine

fn instance<'a>(keys: &'a [&'a str]) -> (Self, &'a [&'a str])

Consumes keys required to create an instance, returns the instance with the remaining keys.