Struct cw_proposal_single::proposal::Proposal

pub struct Proposal {

    pub title: String,
    pub description: String,
    pub proposer: Addr,
    pub start_height: u64,
    pub min_voting_period: Option<Expiration>,
    pub expiration: Expiration,
    pub threshold: Threshold,
    pub total_power: Uint128,
    pub msgs: Vec<CosmosMsg<Empty>>,
    pub status: Status,
    pub votes: Votes,
    pub allow_revoting: bool,
    pub deposit_info: Option<CheckedDepositInfo>,
}

Fields

title: String

description: String

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.

threshold: Threshold

The threshold at which this proposal will pass.

total_power: Uint128

The total amount of voting power at the time of this proposal’s creation.

msgs: Vec<CosmosMsg<Empty>>

The messages that will be executed should this proposal pass.

status: Status

votes: Votes

allow_revoting: bool

deposit_info: Option<CheckedDepositInfo>

Information about the deposit that was sent as part of this proposal. None if no deposit.

Implementations

impl Proposal

pub fn into_response(self, block: &BlockInfo, id: u64) -> 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) -> Status

Gets the current status of the proposal.

pub fn update_status(&mut self, block: &BlockInfo)

Sets a proposals status to its current status.

pub fn is_passed(&self, block: &BlockInfo) -> 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).

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

As above for the passed check, used to check if a proposal is already rejected.

Trait Implementations

impl Clone for Proposal

fn clone(&self) -> Proposal

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Proposal

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Proposal

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl JsonSchema for Proposal

fn schema_name() -> String

The name of the generated JSON Schema.

fn json_schema(gen: &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<Proposal> for Proposal

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

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

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

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

impl Serialize for Proposal

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 Proposal