Struct MultipleChoiceProposal

pub struct MultipleChoiceProposal {

    pub title: String,
    pub description: String,
    pub proposer: Addr,
    pub start_height: u64,
    pub min_voting_period: Option<Expiration>,
    pub expiration: Expiration,
    pub choices: Vec<CheckedMultipleChoiceOption>,
    pub status: Status,
    pub voting_strategy: VotingStrategy,
    pub total_power: Uint128,
    pub votes: MultipleChoiceVotes,
    pub allow_revoting: bool,
    pub veto: Option<VetoConfig>,
}

Fields

title: String

The title of the proposal

description: String

The main body of the proposal text

proposer: Addr

The address that created this proposal.

start_height: u64

The block height at which this proposal was created. Voting power queries should query for voting power at this block height.

min_voting_period: Option<Expiration>

The minimum amount of time this proposal must remain open for voting. The proposal may not pass unless this is expired or None.

expiration: Expiration

The the time at which this proposal will expire and close for additional votes.

choices: Vec<CheckedMultipleChoiceOption>

The options to be chosen from in the vote.

status: Status

The proposal status

voting_strategy: VotingStrategy

Voting settings (threshold, quorum, etc.)

total_power: Uint128

The total power when the proposal started (used to calculate percentages)

votes: MultipleChoiceVotes

The vote tally.

allow_revoting: bool

Whether DAO members are allowed to change their votes. When disabled, proposals can be executed as soon as they pass. When enabled, proposals can only be executed after the voting perid has ended and the proposal passed.

veto: Option<VetoConfig>

Optional veto configuration. If set to None, veto option is disabled. Otherwise contains the configuration for veto flow.

Implementations

impl MultipleChoiceProposal

pub fn into_response( self, block: &BlockInfo, id: u64, ) -> StdResult<ProposalResponse>

Consumes the proposal and returns a version which may be used in a query response. The difference being that proposal statuses are only updated on vote, execute, and close events. It is possible though that since a vote has occured the proposal expiring has changed its status. This method recomputes the status so that queries get accurate information.

pub fn current_status(&self, block: &BlockInfo) -> StdResult<Status>

Gets the current status of the proposal.

pub fn update_status(&mut self, block: &BlockInfo) -> StdResult<()>

Sets a proposals status to its current status.

pub fn is_passed(&self, block: &BlockInfo) -> StdResult<bool>

Returns true iff this proposal is sure to pass (even before expiration if no future sequence of possible votes can cause it to fail). Passing in the case of multiple choice proposals means that quorum has been met, one of the options that is not “None of the above” has won the most votes, and there is no tie.

pub fn is_rejected(&self, block: &BlockInfo) -> StdResult<bool>

pub fn calculate_vote_result(&self) -> StdResult<VoteResult>

Find the option with the highest vote weight, and note if there is a tie.

Trait Implementations

impl Clone for MultipleChoiceProposal

fn clone(&self) -> MultipleChoiceProposal

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for MultipleChoiceProposal

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for MultipleChoiceProposal

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl JsonSchema for MultipleChoiceProposal

fn schema_name() -> String

The name of the generated JSON Schema.

fn schema_id() -> Cow<'static, str>

Returns a string that uniquely identifies the schema produced by this type.

fn json_schema(generator: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type.

fn is_referenceable() -> bool

Whether JSON Schemas generated for this type should be re-used where possible using the $ref keyword.

impl PartialEq for MultipleChoiceProposal

fn eq(&self, other: &MultipleChoiceProposal) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for MultipleChoiceProposal

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for MultipleChoiceProposal