Enum ProposalPayload

pub enum ProposalPayload {
    Signaling {
        commit: Option<String>,
    },
    Emergency {
        halt_chain: bool,
    },
    ParameterChange(ParameterChange),
    CommunityPoolSpend {
        transaction_plan: Vec<u8>,
    },
    UpgradePlan {
        height: u64,
    },
    FreezeIbcClient {
        client_id: String,
    },
    UnfreezeIbcClient {
        client_id: String,
    },
}

The machine-interpretable body of a proposal.

Variants

Signaling

A signaling proposal is merely for coordination; it does not enact anything automatically by itself.

Fields

commit: Option<String>

An optional commit hash for code that this proposal refers to.

Emergency

An emergency proposal is immediately passed when 1/3 of all validators approve it, without waiting for the voting period to conclude.

Fields

halt_chain: bool

If halt_chain == true, then the chain will immediately halt when the proposal is passed.

ParameterChange(ParameterChange)

A parameter change proposal describes a change to the app parameters, which should take effect when the proposal is passed.

CommunityPoolSpend

A Community Pool spend proposal describes proposed transaction(s) to be executed or cancelled at specific heights, with the spend authority of the Community Pool.

Fields

transaction_plan: Vec<u8>

The transaction plan to be executed at the time the proposal is passed.

This must be a transaction plan which can be executed by the Community Pool, which means it can’t require any witness data or authorization signatures, but it may use the CommunityPoolSpend action.

UpgradePlan

An upgrade plan proposal describes a planned upgrade to the chain. If ratified, the chain will halt at the specified height, trigger an epoch transition, and halt the chain.

Fields

height: u64

FreezeIbcClient

A proposal to freeze a specific IBC client.

Fields

client_id: String

The identifier of the client to freeze.

UnfreezeIbcClient

A proposal to unfreeze a specific IBC client.

Fields

client_id: String

The identifier of the client to unfreeze.

Implementations

impl ProposalPayload

pub fn is_signaling(&self) -> bool

pub fn is_emergency(&self) -> bool

pub fn is_ibc_freeze(&self) -> bool

pub fn is_parameter_change(&self) -> bool

pub fn is_community_pool_spend(&self) -> bool

Trait Implementations

impl Clone for ProposalPayload

fn clone(&self) -> ProposalPayload

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ProposalPayload

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

Formats the value using the given formatter.

impl From<ProposalPayload> for ProposalPayloadToml

fn from(payload: ProposalPayload) -> Self

Converts to this type from the input type.

impl PartialEq for ProposalPayload

fn eq(&self, other: &ProposalPayload) -> 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 TryFrom<ProposalPayloadToml> for ProposalPayload

type Error = Error

The type returned in the event of a conversion error.

fn try_from(toml: ProposalPayloadToml) -> Result<Self, Self::Error>

Performs the conversion.

impl Eq for ProposalPayload

impl StructuralPartialEq for ProposalPayload