Struct VtxoFilter

pub struct VtxoFilter<'a> {
    pub expires_before: Option<BlockHeight>,
    pub counterparty: bool,
    pub exclude: HashSet<VtxoId>,
    pub include: HashSet<VtxoId>,
    /* private fields */
}

Filter vtxos based on criteria.

Builder pattern is used.

Matching semantics:

• Explicit include and exclude lists have the highest priority.
• Remaining criteria (expiry, counterparty risk) are combined with OR: if any matches, the VTXO is kept.

Fields

expires_before: Option<BlockHeight>

Include vtxos that expire before the given height.

counterparty: bool

If true, include vtxos that have counterparty risk.

exclude: HashSet<VtxoId>

Exclude certain vtxos.

include: HashSet<VtxoId>

Force include certain vtxos.

Implementations

impl<'a> VtxoFilter<'a>

pub fn new(wallet: &'a Wallet) -> VtxoFilter<'a>

Create a new VtxoFilter bound to a wallet context.

The wallet is used to evaluate properties such as counterparty risk. By default, the filter matches nothing until criteria are added.

Examples

use bark::vtxo::selection::{VtxoFilter, FilterVtxos};
use bitcoin_ext::BlockHeight;

let tip: BlockHeight = 1_000;
let filter = VtxoFilter::new(wallet)
    .expires_before(tip + 144) // expiring within ~1 day
    .counterparty();           // or with counterparty risk
let filtered = wallet.spendable_vtxos_with(&filter)?;

pub fn expires_before(self, expires_before: BlockHeight) -> Self

Include vtxos that expire before the given height.

Examples

use bark::vtxo::selection::{VtxoFilter, FilterVtxos};
use bitcoin_ext::BlockHeight;

let h: BlockHeight = 10_000;
let filter = VtxoFilter::new(wallet)
    .expires_before(h);
let filtered = wallet.spendable_vtxos_with(&filter)?;

pub fn counterparty(self) -> Self

Include vtxos that have counterparty risk.

An arkoor vtxo is considered to have some counterparty risk if it’s (directly or not) based on round VTXOs that aren’t owned by the wallet.

pub fn exclude(self, exclude: VtxoId) -> Self

Exclude the given vtxo.

pub fn exclude_many(self, exclude: impl IntoIterator<Item = VtxoId>) -> Self

Exclude the given vtxos.

pub fn include(self, include: VtxoId) -> Self

Include the given vtxo.

pub fn include_many(self, include: impl IntoIterator<Item = VtxoId>) -> Self

Include the given vtxos.

Trait Implementations

impl FilterVtxos for VtxoFilter<'_>

fn matches(&self, vtxo: &WalletVtxo) -> Result<bool>

Check whether the VTXO mathes this filter

fn filter_vtxos<V: Borrow<WalletVtxo>>(&self, vtxos: &mut Vec<V>) -> Result<()>

Eliminate from the vector all non-matching VTXOs