Struct TxUpdate

#[non_exhaustive]
pub struct TxUpdate<A = ()> {
    pub txs: Vec<Arc<Transaction>>,
    pub txouts: BTreeMap<OutPoint, TxOut>,
    pub anchors: BTreeSet<(A, Txid)>,
    pub seen_ats: HashSet<(Txid, u64)>,
    pub evicted_ats: HashSet<(Txid, u64)>,
}

Data object used to communicate updates about relevant transactions from some chain data source to the core model (usually a bdk_chain::TxGraph).

use bdk_core::TxUpdate;
let mut tx_update = TxUpdate::default();
tx_update.txs.push(tx);
tx_update.anchors.insert((anchor, txid));

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

txs: Vec<Arc<Transaction>>

Full transactions. These are transactions that were determined to be relevant to the wallet given the request.

txouts: BTreeMap<OutPoint, TxOut>

Floating txouts. These are TxOuts that exist but the whole transaction wasn’t included in txs since only knowing about the output is important. These are often used to help determine the fee of a wallet transaction.

anchors: BTreeSet<(A, Txid)>

Transaction anchors. Anchors tells us a position in the chain where a transaction was confirmed.

seen_ats: HashSet<(Txid, u64)>

When transactions were seen in the mempool.

An unconfirmed transaction can only be canonical with a seen_at value. It is the responsibility of the chain-source to include the seen_at values for unconfirmed (unanchored) transactions.

FullScanRequest::start_time or SyncRequest::start_time can be used to provide the seen_at value.

evicted_ats: HashSet<(Txid, u64)>

When transactions were discovered to be missing (evicted) from the mempool.

SyncRequest::start_time can be used to provide the evicted_at value.

Implementations

impl<A> TxUpdate<A>

pub fn is_empty(&self) -> bool

Returns true if the TxUpdate contains no elements in any of its fields.

impl<A> TxUpdate<A>

where A: Ord,

pub fn map_anchors<A2, F>(self, map: F) -> TxUpdate<A2>

where A2: Ord, F: FnMut(A) -> A2,

Transforms the TxUpdate to have anchors (A) of another type (A2).

This takes in a closure with signature FnMut(A) -> A2 which is called for each anchor to transform it.

pub fn extend(&mut self, other: TxUpdate<A>)

Extend this update with other.

Trait Implementations

impl<A> Clone for TxUpdate<A>

where A: Clone,

fn clone(&self) -> TxUpdate<A>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<A> Debug for TxUpdate<A>

where A: Debug,

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

Formats the value using the given formatter.

impl<A> Default for TxUpdate<A>

fn default() -> TxUpdate<A>

Returns the “default value” for a type.

impl<A: Ord> From<TxGraph<A>> for TxUpdate<A>

fn from(graph: TxGraph<A>) -> Self

Converts to this type from the input type.

impl<A: Anchor> From<TxUpdate<A>> for TxGraph<A>

fn from(update: TxUpdate<A>) -> Self

Converts to this type from the input type.