Struct SessionOutcome

pub struct SessionOutcome {
    pub items: Vec<AcceptedItem>,
}

Items ordered in a single session that have been accepted by Fedimint consensus.

A running Federation produces a SessionOutcome every couple of minutes. Therefore, just like in Bitcoin, a SessionOutcome might be empty if no items are ordered in that time or all ordered items are discarded by Fedimint Consensus.

When session is closed it is signed over by the peers and produces a SignedSessionOutcome.

Fields

items: Vec<AcceptedItem>

Implementations

impl SessionOutcome

pub fn header(&self, index: u64) -> [u8; 40]

A blocks header consists of 40 bytes formed by its index in big endian bytes concatenated with the merkle root build from the consensus hashes of its AcceptedItems or 32 zero bytes if the block is empty. The use of a merkle tree allows for efficient inclusion proofs of accepted consensus items for clients.

Trait Implementations

impl Clone for SessionOutcome

fn clone(&self) -> SessionOutcome

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for SessionOutcome

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

Formats the value using the given formatter.

impl Decodable for SessionOutcome

fn consensus_decode_from_finite_reader<D: Read>( d: &mut D, modules: &ModuleDecoderRegistry, ) -> Result<Self, DecodeError>

Decode Self from a size-limited reader.

fn consensus_decode<R: Read>( r: &mut R, modules: &ModuleDecoderRegistry, ) -> Result<Self, DecodeError>

Decode an object with a well-defined format.

fn consensus_decode_hex( hex: &str, modules: &ModuleDecoderRegistry, ) -> Result<Self, DecodeError>

Decode an object from hex

fn consensus_decode_vec( bytes: Vec<u8>, modules: &ModuleDecoderRegistry, ) -> Result<Self, DecodeError>

impl Encodable for SessionOutcome

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

Encode an object with a well-defined format. Returns the number of bytes written on success.

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

Self::consensus_encode to newly allocated Vec<u8>

fn consensus_encode_to_hex(&self) -> String

Encode and convert to hex string representation

fn consensus_encode_to_len(&self) -> usize

Encode without storing the encoding, return the size

fn consensus_hash<H>(&self) -> H

where H: Hash, H::Engine: Write,

Generate a SHA256 hash of the consensus encoding using the default hash engine for H.

impl PartialEq for SessionOutcome

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

impl StructuralPartialEq for SessionOutcome