Struct RoundState

pub struct RoundState { /* private fields */ }

State of the progress of a round participation

An instance of this struct is kept all the way from the intention of joining the next round, until either the round fully confirms or it fails and we are sure it won’t have any effect on our wallet.

As soon as we have signed forfeit txs for the round, we keep track of this round attempt until we see another attempt we participated in confirm or we gain confidence that the failed attempt will never confirm.

Implementations

impl RoundState

pub fn participation(&self) -> &RoundParticipation

Our participation in this round

pub fn flow(&self) -> &RoundFlowState

pub fn unconfirmed_rounds(&self) -> &[UnconfirmedRound]

pub fn ongoing_participation(&self) -> bool

Whether the interactive part of the round is still ongoing

pub async fn try_cancel(&mut self, wallet: &Wallet) -> Result<bool>

Tries to cancel the round and returns whether it was succesfully canceled or if it was already canceled or failed

pub async fn process_event( &mut self, wallet: &Wallet, event: &RoundEvent, ) -> bool

Processes the given event and returns true if some update was made to the state

pub async fn sync(&mut self, wallet: &Wallet) -> Result<RoundStatus>

Sync the round’s status and return it

When success or failure is returned, the round state can be eliminated

pub fn output_vtxos(&self) -> Option<&[Vtxo]>

Once we know the signed round funding tx, this returns the output VTXOs for this round.

pub fn locked_pending_inputs(&self) -> &[Vtxo]

Returns the input VTXOs that are locked in this round, but only if no output VTXOs were issued yet.

Trait Implementations

impl<'a> From<&'a RoundState> for SerdeRoundState<'a>

fn from(state: &'a RoundState) -> Self

Converts to this type from the input type.

impl<'a> From<SerdeRoundState<'a>> for RoundState

fn from(state: SerdeRoundState<'a>) -> Self

Converts to this type from the input type.