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, tip: u32) -> Self

Create a new instance for the given VtxoId with an initial state of ExitState::Start. The unilateral exit can’t progress until ExitVtxo::initialize is called.

Parameters

• vtxo_id: the VtxoId being exited.
• tip: current chain tip used to initialize the starting state.

pub fn from_entry(entry: StoredExit, vtxo: &Vtxo) -> Self

Reconstruct an ExitVtxo from its parts. This leaves the instance in an uninitialized state. Useful when loading a tracked exit from storage.

Parameters

• entry: The persisted data to reconstruct this instance from.
• vtxo: The Vtxo that this exit is tracking.

pub fn id(&self) -> VtxoId

Returns the ID of the tracked Vtxo.

pub fn amount(&self) -> Amount

Returns the amount being exited.

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) -> Option<&Vec<Txid>>

Returns the set of exit-related transaction IDs, these may not be broadcast yet. If the instance is not yet initialized, None will be returned.

pub fn is_claimable(&self) -> bool

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

pub fn is_initialized(&self) -> bool

True if ExitVtxo::initialize has been called and the exit is ready to progress.

pub async fn initialize( &mut self, tx_manager: &mut ExitTransactionManager, persister: &dyn BarkPersister, onchain: &dyn ExitUnilaterally, ) -> Result<(), ExitError>

Prepares an ExitVtxo for progression by querying the list of transactions required to process the unilateral exit and adds them to the exit transaction manager.

pub async fn progress( &mut self, wallet: &Wallet, tx_manager: &mut ExitTransactionManager, onchain: &mut dyn ExitUnilaterally, fee_rate_override: Option<FeeRate>, continue_until_finished: bool, ) -> 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.

pub async fn get_vtxo( &self, persister: &dyn BarkPersister, ) -> Result<WalletVtxo, ExitError>

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.