Struct Proposal 

pub struct Proposal {
    pub proto_version: u32,
    pub fee_rule: i32,
    pub min_target_height: u32,
    pub steps: Vec<ProposalStep>,
    pub confirmations_policy: Option<ConfirmationsPolicy>,
    pub proposed_version: Option<u32>,
}

A data structure that describes a series of transactions to be created.

Fields

proto_version: u32

The version of this serialization format.

fee_rule: i32

The fee rule used in constructing this proposal

min_target_height: u32

The target height for which the proposal was constructed

The chain must contain at least this many blocks in order for the proposal to be executed.

steps: Vec<ProposalStep>

The series of transactions to be created.

confirmations_policy: Option<ConfirmationsPolicy>

The confirmations policy under which the proposal was constructed. It is used to resolve the anchor for any step that spends no shielded notes (such a step defers the choice of anchor). Proposals serialized by older versions omit this field; they are interpreted using the default confirmations policy.

proposed_version: Option<u32>

The transaction version header explicitly requested when the proposal was constructed. Proposals serialized by older versions, or constructed without an explicit version request, omit this field; they are built at the version implied by the target height.

Implementations

impl Proposal

pub fn fee_rule(&self) -> FeeRule

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

pub fn set_fee_rule(&mut self, value: FeeRule)

Sets fee_rule to the provided enum value.

pub fn proposed_version(&self) -> u32

Returns the value of proposed_version, or the default value if proposed_version is unset.

impl Proposal

pub fn from_standard_proposal<NoteRef>( value: &Proposal<StandardFeeRule, NoteRef>, ) -> Self

Serializes a Proposal based upon a supported StandardFeeRule to its protobuf representation.

pub fn try_into_standard_proposal<ParamsT, DbT, DbError>( &self, params: &ParamsT, wallet_db: &DbT, ) -> Result<Proposal<StandardFeeRule, DbT::NoteRef>, ProposalDecodingError<DbError>>

where ParamsT: Parameters, DbT: InputSource<Error = DbError>,

Attempts to parse a Proposal based upon a supported StandardFeeRule from its protobuf representation.

Trait Implementations

impl Clone for Proposal

fn clone(&self) -> Self

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(&self, buf: &mut impl BufMut) -> Result<(), EncodeError>

where 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( &self, buf: &mut impl BufMut, ) -> Result<(), EncodeError>

where 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(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

Decodes an instance of the message from a buffer.

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

where Self: Default,

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

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

where Self: Sized,

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

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

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for Proposal