Struct serai_processor::Plan

pub struct Plan<N: Network> {
    pub key: <N::Curve as Ciphersuite>::G,
    pub inputs: Vec<N::Output>,
    pub payments: Vec<Payment<N>>,
    pub change: Option<N::Address>,
    pub scheduler_addendum: <N::Scheduler as Scheduler<N>>::Addendum,
}

Fields

key: <N::Curve as Ciphersuite>::G

inputs: Vec<N::Output>

payments: Vec<Payment<N>>

The payments this Plan is intended to create.

This should only contain payments leaving Serai. While it is acceptable for users to enter Serai’s address(es) as the payment address, as that’ll be handled by anything which expects certain properties, Serai as a system MUST NOT use payments for internal transfers. Doing so will cause a reduction in their value by the TX fee/operating costs, creating an incomplete transfer.

change: Option<N::Address>

The change this Plan should use.

This MUST contain a Serai address. Operating costs may be deducted from the payments in this Plan on the premise that the change address is Serai’s, and accordingly, Serai will recoup the operating costs.

scheduler_addendum: <N::Scheduler as Scheduler<N>>::Addendum

The scheduler’s additional data.

Implementations

impl<N: Network> Plan<N>

pub fn transcript(&self) -> RecommendedTranscript

pub fn id(&self) -> [u8; 32]

pub fn write<W: Write>(&self, writer: &mut W) -> Result<()>

pub fn read<R: Read>(reader: &mut R) -> Result<Self>

Trait Implementations

impl<N: Clone + Network> Clone for Plan<N>

where N::Curve: Clone, N::Output: Clone, N::Address: Clone, N::Scheduler: Clone,

fn clone(&self) -> Plan<N>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<N: Network> Debug for Plan<N>

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

Formats the value using the given formatter.

impl<N: PartialEq + Network> PartialEq for Plan<N>

where N::Curve: PartialEq, N::Output: PartialEq, N::Address: PartialEq, N::Scheduler: PartialEq,

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