Struct bdk_chain::tx_graph::ChangeSet

pub struct ChangeSet<A = ()> {
    pub txs: BTreeSet<Arc<Transaction>>,
    pub txouts: BTreeMap<OutPoint, TxOut>,
    pub anchors: BTreeSet<(A, Txid)>,
    pub last_seen: BTreeMap<Txid, u64>,
}

The ChangeSet represents changes to a TxGraph.

Since TxGraph is monotone, the “changeset” can only contain transactions to be added and not removed.

Refer to module-level documentation for more.

Fields

txs: BTreeSet<Arc<Transaction>>

Added transactions.

txouts: BTreeMap<OutPoint, TxOut>

Added txouts.

anchors: BTreeSet<(A, Txid)>

Added anchors.

last_seen: BTreeMap<Txid, u64>

Added last-seen unix timestamps of transactions.

Implementations

impl<A> ChangeSet<A>

pub fn txouts(&self) -> impl Iterator<Item = (OutPoint, &TxOut)>

Iterates over all outpoints contained within ChangeSet.

pub fn anchor_heights(&self) -> impl Iterator<Item = u32> + '_

where A: Anchor,

Iterates over the heights of that the new transaction anchors in this changeset.

This is useful if you want to find which heights you need to fetch data about in order to confirm or exclude these anchors.

impl<A: Ord> ChangeSet<A>

pub fn map_anchors<A2: Ord, F>(self, f: F) -> ChangeSet<A2>

where F: FnMut(A) -> A2,

Transform the ChangeSet to have Anchors of another type.

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

impl<A> ChangeSet<A>

where A: Anchor + Clone + Ord + Serialize + DeserializeOwned,

pub const SCHEMA_NAME: &'static str = "bdk_txgraph"

Schema name for tx_graph::ChangeSet.

pub const TXS_TABLE_NAME: &'static str = "bdk_txs"

Name of table that stores full transactions and last_seen timestamps.

pub const TXOUTS_TABLE_NAME: &'static str = "bdk_txouts"

Name of table that stores floating txouts.

pub const ANCHORS_TABLE_NAME: &'static str = "bdk_anchors"

Name of table that stores Anchors.

pub fn init_sqlite_tables(db_tx: &Transaction<'_>) -> Result<()>

Initialize sqlite tables.

pub fn from_sqlite(db_tx: &Transaction<'_>) -> Result<Self>

Construct a TxGraph from an sqlite database.

Remember to call Self::init_sqlite_tables beforehand.

pub fn persist_to_sqlite(&self, db_tx: &Transaction<'_>) -> Result<()>

Persist changeset to the sqlite database.

Remember to call Self::init_sqlite_tables beforehand.

Trait Implementations

impl<A: Clone> Clone for ChangeSet<A>

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<A: Debug> Debug for ChangeSet<A>

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

Formats the value using the given formatter.

impl<A> Default for ChangeSet<A>

fn default() -> Self

Returns the “default value” for a type.

impl<'de, A> Deserialize<'de> for ChangeSet<A>

where A: Ord + Deserialize<'de>,

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<A, IA: Default> From<ChangeSet<A>> for ChangeSet<A, IA>

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

Converts to this type from the input type.

impl<A: Ord> Merge for ChangeSet<A>

fn merge(&mut self, other: Self)

Merge another object of the same type onto self.

fn is_empty(&self) -> bool

Returns whether the structure is considered empty.

fn take(&mut self) -> Option<Self>

Take the value, replacing it with the default value.

impl<A: PartialEq> PartialEq for ChangeSet<A>

fn eq(&self, other: &ChangeSet<A>) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<A> Serialize for ChangeSet<A>

where A: Ord + Serialize,

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl<A> StructuralPartialEq for ChangeSet<A>