/// A trait indicating a desire to listen for events from the chain
pub trait ChainListener: Sync + Send {
/// Notifies a listener that a block was connected.
- /// Note that if a new transaction/outpoint is watched during a block_connected call, the block
- /// *must* be re-scanned with the new transaction/outpoints and block_connected should be
- /// called again with the same header and (at least) the new transactions.
///
- /// Note that if non-new transaction/outpoints may be registered during a call, a second call
+ /// The txn_matched array should be set to references to transactions which matched the
+ /// relevant installed watch outpoints/txn, or the full set of transactions in the block.
+ ///
+ /// Note that if txn_matched includes only matched transactions, and a new
+ /// transaction/outpoint is watched during a block_connected call, the block *must* be
+ /// re-scanned with the new transaction/outpoints and block_connected should be called
+ /// again with the same header and (at least) the new transactions.
+ ///
+ /// Note that if non-new transaction/outpoints are be registered during a call, a second call
/// *must not* happen.
///
/// This also means those counting confirmations using block_connected callbacks should watch
pub const MIN_RELAY_FEE_SAT_PER_1000_WEIGHT: u64 = 4000;
/// Utility for tracking registered txn/outpoints and checking for matches
+#[cfg_attr(test, derive(PartialEq))]
pub struct ChainWatchedUtil {
watch_all: bool,
return last_seen != self.chain_monitor.reentered();
}
-
/// Notify listeners that a block was disconnected.
pub fn block_disconnected(&self, header: &BlockHeader, disconnected_height: u32) {
let listeners = self.listeners.lock().unwrap();
listener.block_disconnected(&header, disconnected_height);
}
}
-
}
/// Utility to capture some common parts of ChainWatchInterface implementors.
logger: Arc<Logger>,
}
+// We only expose PartialEq in test since its somewhat unclear exactly what it should do and we're
+// only comparing a subset of fields (essentially just checking that the set of things we're
+// watching is the same).
+#[cfg(test)]
+impl PartialEq for ChainWatchInterfaceUtil {
+ fn eq(&self, o: &Self) -> bool {
+ self.network == o.network &&
+ *self.watched.lock().unwrap() == *o.watched.lock().unwrap()
+ }
+}
+
/// Register listener
impl ChainWatchInterface for ChainWatchInterfaceUtil {
fn install_watch_tx(&self, txid: &Sha256dHash, script_pub_key: &Script) {
}
}
-
/// Checks if a given transaction matches the current filter.
pub fn does_match_tx(&self, tx: &Transaction) -> bool {
let watched = self.watched.lock().unwrap();