Struct ExitVtxo

pub struct ExitVtxo { /* private fields */ }

Tracks the exit lifecycle for a single Vtxo.

An ExitVtxo maintains:

• the underlying Vtxo being exited,
• the set of related onchain transaction IDs in topographical order,
• the current state ExitState,
• and a history of prior states for debugging and auditing.

Use ExitVtxo::progress to drive the state machine forward. The method is idempotent and will only persist when a logical state transition occurs.

Implementations

impl ExitVtxo

pub fn new(vtxo: Vtxo, txids: Vec<Txid>, tip: u32) -> Self

Create a new instance for the given Vtxo.

• vtxo: the Vtxo being exited.
• txids: the ID of each transaction which needs broadcasting onchain in topographical order.
• tip: current chain tip used to initialize the starting state.

pub fn from_parts( vtxo: Vtxo, txids: Vec<Txid>, state: ExitState, history: Vec<ExitState>, ) -> Self

Reconstruct an ExitVtxo from its parts.

Useful when loading a tracked exit from storage.

pub fn id(&self) -> VtxoId

Returns the ID of the tracked Vtxo.

pub fn vtxo(&self) -> &Vtxo

Returns the underlying Vtxo.

pub fn state(&self) -> &ExitState

Returns the current state of the unilateral exit.

pub fn history(&self) -> &Vec<ExitState>

Returns the history of the exit machine in the order that states were observed.

pub fn txids(&self) -> &Vec<Txid>

Returns the set of exit-related transaction IDs, these may not be broadcast yet.

pub fn is_claimable(&self) -> bool

True if the exit is currently ExitState::Claimable and can be claimed/spent.

pub async fn progress( &mut self, chain_source: &ChainSource, tx_manager: &mut ExitTransactionManager, persister: &dyn BarkPersister, onchain: &mut dyn ExitUnilaterally, fee_rate_override: Option<FeeRate>, ) -> Result<(), ExitError>

Advances the exit state machine for this Vtxo.

The method:

• Attempts to transition the unilateral exit state machine.
• Persists only when a logical state change occurs.

Returns:

• Ok(()) when no more immediate work is required, such as when we’re waiting for a confirmation or when the exit is complete.
• Err(ExitError) when an unrecoverable issue occurs, such as requiring more onchain funds or if an exit transaction fails to broadcast; if the error includes a newer state, it will be committed before returning.

Notes:

• If fee_rate_override is None, a suitable fee rate will be calculated.

Trait Implementations

impl Clone for ExitVtxo

fn clone(&self) -> ExitVtxo

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ExitVtxo

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

Formats the value using the given formatter.