Struct Proposal

pub struct Proposal {

    pub id: u64,
    pub group_policy_address: String,
    pub metadata: String,
    pub proposers: Vec<String>,
    pub submit_time: Option<Timestamp>,
    pub group_version: u64,
    pub group_policy_version: u64,
    pub status: i32,
    pub final_tally_result: Option<TallyResult>,
    pub voting_period_end: Option<Timestamp>,
    pub executor_result: i32,
    pub messages: Vec<Any>,
    pub title: String,
    pub summary: String,
}

Proposal defines a group proposal. Any member of a group can submit a proposal for a group policy to decide upon. A proposal consists of a set of sdk.Msgs that will be executed if the proposal passes as well as some optional metadata associated with the proposal.

Fields

id: u64

id is the unique id of the proposal.

group_policy_address: String

group_policy_address is the account address of group policy.

metadata: String

metadata is any arbitrary metadata attached to the proposal. the recommended format of the metadata is to be found here: https://docs.cosmos.network/v0.47/modules/group#proposal-4

proposers: Vec<String>

proposers are the account addresses of the proposers.

submit_time: Option<Timestamp>

submit_time is a timestamp specifying when a proposal was submitted.

group_version: u64

group_version tracks the version of the group at proposal submission. This field is here for informational purposes only.

group_policy_version: u64

group_policy_version tracks the version of the group policy at proposal submission. When a decision policy is changed, existing proposals from previous policy versions will become invalid with the ABORTED status. This field is here for informational purposes only.

status: i32

status represents the high level position in the life cycle of the proposal. Initial value is Submitted.

final_tally_result: Option<TallyResult>

final_tally_result contains the sums of all weighted votes for this proposal for each vote option. It is empty at submission, and only populated after tallying, at voting period end or at proposal execution, whichever happens first.

voting_period_end: Option<Timestamp>

voting_period_end is the timestamp before which voting must be done. Unless a successful MsgExec is called before (to execute a proposal whose tally is successful before the voting period ends), tallying will be done at this point, and the final_tally_resultand status fields will be accordingly updated.

executor_result: i32

executor_result is the final result of the proposal execution. Initial value is NotRun.

messages: Vec<Any>

messages is a list of sdk.Msgs that will be executed if the proposal passes.

title: String

title is the title of the proposal

Since: cosmos-sdk 0.47

summary: String

summary is a short summary of the proposal

Since: cosmos-sdk 0.47

Implementations

impl Proposal

pub fn status(&self) -> ProposalStatus

Returns the enum value of status, or the default if the field is set to an invalid enum value.

pub fn set_status(&mut self, value: ProposalStatus)

Sets status to the provided enum value.

pub fn executor_result(&self) -> ProposalExecutorResult

Returns the enum value of executor_result, or the default if the field is set to an invalid enum value.

pub fn set_executor_result(&mut self, value: ProposalExecutorResult)

Sets executor_result to the provided enum value.

Trait Implementations

impl Clone for Proposal

fn clone(&self) -> Proposal

Returns a duplicate 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 Default for Proposal

fn default() -> Self

Returns the “default value” for a type.

impl Message for Proposal

fn encoded_len(&self) -> usize

Returns the encoded length of the message without a length delimiter.

fn clear(&mut self)

Clears the message, resetting all fields to their default.

fn encode<B>(&self, buf: &mut B) -> Result<(), EncodeError>

where B: BufMut, Self: Sized,

Encodes the message to a buffer.

fn encode_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message to a newly allocated buffer.

fn encode_length_delimited<B>(&self, buf: &mut B) -> Result<(), EncodeError>

where B: BufMut, Self: Sized,

Encodes the message with a length-delimiter to a buffer.

fn encode_length_delimited_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message with a length-delimiter to a newly allocated buffer.

fn decode<B>(buf: B) -> Result<Self, DecodeError>

where B: Buf, Self: Default,

Decodes an instance of the message from a buffer.

fn decode_length_delimited<B>(buf: B) -> Result<Self, DecodeError>

where B: Buf, Self: Default,

Decodes a length-delimited instance of the message from the buffer.

fn merge<B>(&mut self, buf: B) -> Result<(), DecodeError>

where B: Buf, Self: Sized,

Decodes an instance of the message from a buffer, and merges it into self.

fn merge_length_delimited<B>(&mut self, buf: B) -> Result<(), DecodeError>

where B: Buf, Self: Sized,

Decodes a length-delimited instance of the message from buffer, and merges it into self.

impl PartialEq for Proposal

fn eq(&self, other: &Proposal) -> 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 StructuralPartialEq for Proposal