Struct spl_governance::state::proposal::Proposal

#[repr(C)]
pub struct Proposal {

    pub account_type: GovernanceAccountType,
    pub governance: Pubkey,
    pub governing_token_mint: Pubkey,
    pub state: ProposalState,
    pub token_owner_record: Pubkey,
    pub signatories_count: u8,
    pub signatories_signed_off_count: u8,
    pub yes_votes_count: u64,
    pub no_votes_count: u64,
    pub instructions_executed_count: u16,
    pub instructions_count: u16,
    pub instructions_next_index: u16,
    pub draft_at: UnixTimestamp,
    pub signing_off_at: Option<UnixTimestamp>,
    pub voting_at: Option<UnixTimestamp>,
    pub voting_at_slot: Option<Slot>,
    pub voting_completed_at: Option<UnixTimestamp>,
    pub executing_at: Option<UnixTimestamp>,
    pub closed_at: Option<UnixTimestamp>,
    pub execution_flags: InstructionExecutionFlags,
    pub name: String,
    pub description_link: String,
}

Governance Proposal

Fields

account_type: GovernanceAccountType

Governance account type

governance: Pubkey

Governance account the Proposal belongs to

governing_token_mint: Pubkey

Indicates which Governing Token is used to vote on the Proposal Whether the general Community token owners or the Council tokens owners vote on this Proposal

state: ProposalState

Current proposal state

token_owner_record: Pubkey

The TokenOwnerRecord representing the user who created and owns this Proposal

signatories_count: u8

The number of signatories assigned to the Proposal

signatories_signed_off_count: u8

The number of signatories who already signed

yes_votes_count: u64

The number of Yes votes

no_votes_count: u64

The number of No votes

instructions_executed_count: u16

The number of the instructions already executed

instructions_count: u16

The number of instructions included in the proposal

instructions_next_index: u16

The index of the the next instruction to be added

draft_at: UnixTimestamp

When the Proposal was created and entered Draft state

signing_off_at: Option<UnixTimestamp>

When Signatories started signing off the Proposal

voting_at: Option<UnixTimestamp>

When the Proposal began voting as UnixTimestamp

voting_at_slot: Option<Slot>

When the Proposal began voting as Slot Note: The slot is not currently used but the exact slot is going to be required to support snapshot based vote weights

voting_completed_at: Option<UnixTimestamp>

When the Proposal ended voting and entered either Succeeded or Defeated

executing_at: Option<UnixTimestamp>

When the Proposal entered Executing state

closed_at: Option<UnixTimestamp>

When the Proposal entered final state Completed or Cancelled and was closed

execution_flags: InstructionExecutionFlags

Instruction execution flag for ordered and transactional instructions Note: This field is not used in the current version

name: String

Proposal name

description_link: String

Link to proposal’s description

Implementations

impl Proposal

pub fn assert_can_edit_signatories(&self) -> Result<(), ProgramError>

Checks if Signatories can be edited (added or removed) for the Proposal in the given state

pub fn assert_can_sign_off(&self) -> Result<(), ProgramError>

Checks if Proposal can be singed off

pub fn assert_can_cast_vote(
    &self,
    config: &GovernanceConfig,
    current_unix_timestamp: UnixTimestamp
) -> Result<(), ProgramError>

Checks if Proposal can be voted on

pub fn assert_can_finalize_vote(
    &self,
    config: &GovernanceConfig,
    current_unix_timestamp: UnixTimestamp
) -> Result<(), ProgramError>

Checks if Proposal can be finalized

pub fn finalize_vote(
    &mut self,
    governing_token_supply: u64,
    config: &GovernanceConfig,
    current_unix_timestamp: UnixTimestamp
) -> Result<(), ProgramError>

Finalizes vote by moving it to final state Succeeded or Defeated if max_voting_time has passed If Proposal is still within max_voting_time period then error is returned

pub fn try_tip_vote(
    &mut self,
    governing_token_supply: u64,
    config: &GovernanceConfig,
    current_unix_timestamp: UnixTimestamp
)

Checks if vote can be tipped and automatically transitioned to Succeeded or Defeated state If the conditions are met the state is updated accordingly

pub fn try_get_tipped_vote_state(
    &self,
    governing_token_supply: u64,
    config: &GovernanceConfig
) -> Option<ProposalState>

Checks if vote can be tipped and automatically transitioned to Succeeded or Defeated state If yes then Some(ProposalState) is returned and None otherwise

pub fn assert_can_cancel(&self) -> Result<(), ProgramError>

Checks if Proposal can be canceled in the given state

pub fn assert_can_edit_instructions(&self) -> Result<(), ProgramError>

Checks if Instructions can be edited (inserted or removed) for the Proposal in the given state

pub fn assert_can_execute_instruction(
    &self,
    proposal_instruction_data: &ProposalInstruction,
    current_unix_timestamp: UnixTimestamp
) -> Result<(), ProgramError>

Checks if Instructions can be executed for the Proposal in the given state

Trait Implementations

impl AccountMaxSize for Proposal

fn get_max_size(&self) -> Option<usize>

Returns max account size or None if max size is not known and actual instance size should be used

impl BorshDeserialize for Proposal where
    GovernanceAccountType: BorshDeserialize,
    Pubkey: BorshDeserialize,
    Pubkey: BorshDeserialize,
    ProposalState: BorshDeserialize,
    Pubkey: BorshDeserialize,
    u8: BorshDeserialize,
    u8: BorshDeserialize,
    u64: BorshDeserialize,
    u64: BorshDeserialize,
    u16: BorshDeserialize,
    u16: BorshDeserialize,
    u16: BorshDeserialize,
    UnixTimestamp: BorshDeserialize,
    Option<UnixTimestamp>: BorshDeserialize,
    Option<UnixTimestamp>: BorshDeserialize,
    Option<Slot>: BorshDeserialize,
    Option<UnixTimestamp>: BorshDeserialize,
    Option<UnixTimestamp>: BorshDeserialize,
    Option<UnixTimestamp>: BorshDeserialize,
    InstructionExecutionFlags: BorshDeserialize,
    String: BorshDeserialize,
    String: BorshDeserialize, 

fn deserialize(buf: &mut &[u8]) -> Result<Self, Error>

Deserializes this instance from a given slice of bytes. Updates the buffer to point at the remaining bytes.

fn try_from_slice(v: &[u8]) -> Result<Self, Error>

Deserialize this instance from a slice of bytes.

unsafe fn is_u8() -> bool

Whether Self is u8. NOTE: Vec<u8> is the most common use-case for serialization and deserialization, it’s worth handling it as a special case to improve performance. It’s a workaround for specific Vec<u8> implementation versus generic Vec<T> implementation. See https://github.com/rust-lang/rfcs/pull/1210 for details.

impl BorshSchema for Proposal where
    GovernanceAccountType: BorshSchema,
    Pubkey: BorshSchema,
    Pubkey: BorshSchema,
    ProposalState: BorshSchema,
    Pubkey: BorshSchema,
    u8: BorshSchema,
    u8: BorshSchema,
    u64: BorshSchema,
    u64: BorshSchema,
    u16: BorshSchema,
    u16: BorshSchema,
    u16: BorshSchema,
    UnixTimestamp: BorshSchema,
    Option<UnixTimestamp>: BorshSchema,
    Option<UnixTimestamp>: BorshSchema,
    Option<Slot>: BorshSchema,
    Option<UnixTimestamp>: BorshSchema,
    Option<UnixTimestamp>: BorshSchema,
    Option<UnixTimestamp>: BorshSchema,
    InstructionExecutionFlags: BorshSchema,
    String: BorshSchema,
    String: BorshSchema, 

fn declaration() -> Declaration

Get the name of the type without brackets.

fn add_definitions_recursively(
    definitions: &mut HashMap<Declaration, Definition>
)

Recursively, using DFS, add type definitions required for this type. For primitive types this is an empty map. Type definition explains how to serialize/deserialize a type.

fn add_definition(
    declaration: String,
    definition: Definition,
    definitions: &mut HashMap<String, Definition, RandomState>
)

Helper method to add a single type definition to the map.

fn schema_container() -> BorshSchemaContainer

impl BorshSerialize for Proposal where
    GovernanceAccountType: BorshSerialize,
    Pubkey: BorshSerialize,
    Pubkey: BorshSerialize,
    ProposalState: BorshSerialize,
    Pubkey: BorshSerialize,
    u8: BorshSerialize,
    u8: BorshSerialize,
    u64: BorshSerialize,
    u64: BorshSerialize,
    u16: BorshSerialize,
    u16: BorshSerialize,
    u16: BorshSerialize,
    UnixTimestamp: BorshSerialize,
    Option<UnixTimestamp>: BorshSerialize,
    Option<UnixTimestamp>: BorshSerialize,
    Option<Slot>: BorshSerialize,
    Option<UnixTimestamp>: BorshSerialize,
    Option<UnixTimestamp>: BorshSerialize,
    Option<UnixTimestamp>: BorshSerialize,
    InstructionExecutionFlags: BorshSerialize,
    String: BorshSerialize,
    String: BorshSerialize, 

fn serialize<W: Write>(&self, writer: &mut W) -> Result<(), Error>

fn try_to_vec(&self) -> Result<Vec<u8, Global>, Error>

Serialize this instance into a vector of bytes.

unsafe fn is_u8() -> bool

Whether Self is u8. NOTE: Vec<u8> is the most common use-case for serialization and deserialization, it’s worth handling it as a special case to improve performance. It’s a workaround for specific Vec<u8> implementation versus generic Vec<T> implementation. See https://github.com/rust-lang/rfcs/pull/1210 for details.

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 IsInitialized for Proposal

fn is_initialized(&self) -> bool

Is initialized

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: &Proposal) -> bool

This method tests for !=.

impl StructuralPartialEq for Proposal