Struct VtxoList 

pub struct VtxoList { /* private fields */ }

Implementations

impl VtxoList

pub fn new(dust: Amount, virtual_tx_outpoints: Vec<VirtualTxOutPoint>) -> Self

pub fn all(&self) -> impl Iterator<Item = &VirtualTxOutPoint>

pub fn all_unspent(&self) -> impl Iterator<Item = &VirtualTxOutPoint>

pub fn could_exit_unilaterally( &self, ) -> impl Iterator<Item = &VirtualTxOutPoint>

VTXOs that are in a state that allows for unilateral exit.

This does not mean that the VTXOs are readily spendable on-chain, just that their ancestor chain can still be published.

pub fn spendable_offchain(&self) -> impl Iterator<Item = &VirtualTxOutPoint>

VTXOs that can be spent in an offchain transaction.

pub fn pre_confirmed(&self) -> impl Iterator<Item = &VirtualTxOutPoint>

pub fn confirmed(&self) -> impl Iterator<Item = &VirtualTxOutPoint>

pub fn recoverable(&self) -> impl Iterator<Item = &VirtualTxOutPoint>

Returns the list of recoverable VTXOs

A VTXO is recoverable if it:

• has expired;
• was swept already; or
• is sub-dust.

pub fn exit_ready( &self, now: Duration, explorer_utxos: Vec<ExplorerUtxo>, vtxos: HashMap<ScriptBuf, Vtxo>, ) -> impl Iterator<Item = &VirtualTxOutPoint>

VTXOs that are already on-chain and can be spent unilaterally (the exit path is active).

pub fn spent(&self) -> impl Iterator<Item = &VirtualTxOutPoint>

Trait Implementations

impl Clone for VtxoList

fn clone(&self) -> VtxoList

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for VtxoList

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

Formats the value using the given formatter.