X-Git-Url: http://git.bitcoin.ninja/index.cgi?a=blobdiff_plain;f=src%2Fchain%2Fchaininterface.rs;h=7e9e9aeff05b902923703846337cc5c9b9666edd;hb=b17211ffe42d029280fc45df42dd1d6152eadd13;hp=ef8f9bf15525cba26685cb2da7823cf4ccd58982;hpb=6185a2819090bd077954244c5e2adaab5efcaa1a;p=rust-lightning

diff --git a/src/chain/chaininterface.rs b/src/chain/chaininterface.rs
index ef8f9bf1..7e9e9aef 100644
--- a/src/chain/chaininterface.rs
+++ b/src/chain/chaininterface.rs
@@ -1,30 +1,36 @@
-use bitcoin::blockdata::block::BlockHeader;
+use bitcoin::blockdata::block::{Block, BlockHeader};
 use bitcoin::blockdata::transaction::Transaction;
 use bitcoin::blockdata::script::Script;
 use bitcoin::util::hash::Sha256dHash;
-
-use std::sync::{Weak,Mutex};
+use std::sync::{Mutex,Weak,MutexGuard};
+use std::sync::atomic::{AtomicUsize, Ordering};
 
 /// An interface to request notification of certain scripts as they appear the
 /// chain.
+/// Note that all of the functions implemented here *must* be reentrant-safe (obviously - they're
+/// called from inside the library in response to ChainListener events, P2P events, or timer
+/// events).
 pub trait ChainWatchInterface: Sync + Send {
 	/// Provides a scriptPubKey which much be watched for.
-	fn install_watch_script(&self, script_pub_key: Script);
+	fn install_watch_script(&self, script_pub_key: &Script);
 
 	/// Provides an outpoint which must be watched for, providing any transactions which spend the
 	/// given outpoint.
-	fn install_watch_outpoint(&self, outpoint: (Sha256dHash, u32));
+	fn install_watch_outpoint(&self, outpoint: (Sha256dHash, u32), out_script: &Script);
 
 	/// Indicates that a listener needs to see all transactions.
 	fn watch_all_txn(&self);
 
-	/// Sends a transaction out to (hopefully) be mined
-	fn broadcast_transaction(&self, tx: &Transaction);
-
 	fn register_listener(&self, listener: Weak<ChainListener>);
 	//TODO: unregister
 }
 
+/// An interface to send a transaction to the Bitcoin network.
+pub trait BroadcasterInterface: Sync + Send {
+	/// Sends a transaction out to (hopefully) be mined.
+	fn broadcast_transaction(&self, tx: &Transaction);
+}
+
 /// 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.
@@ -45,8 +51,18 @@ pub enum ConfirmationTarget {
 	HighPriority,
 }
 
+/// A trait which should be implemented to provide feerate information on a number of time
+/// horizons.
+/// Note that all of the functions implemented here *must* be reentrant-safe (obviously - they're
+/// called from inside the library in response to ChainListener events, P2P events, or timer
+/// events).
 pub trait FeeEstimator: Sync + Send {
-	fn get_est_sat_per_vbyte(&self, ConfirmationTarget) -> u64;
+	/// Gets estimated satoshis of fee required per 1000 Weight-Units. This translates to:
+	///  * satoshis-per-byte * 250
+	///  * ceil(satoshis-per-kbyte / 4)
+	/// Must be no smaller than 253 (ie 1 satoshi-per-byte rounded up to ensure later round-downs
+	/// don't put us below 1 satoshi-per-byte).
+	fn get_est_sat_per_1000_weight(&self, confirmation_target: ConfirmationTarget) -> u64;
 }
 
 /// Utility to capture some common parts of ChainWatchInterface implementors.
@@ -54,59 +70,101 @@ pub trait FeeEstimator: Sync + Send {
 pub struct ChainWatchInterfaceUtil {
 	watched: Mutex<(Vec<Script>, Vec<(Sha256dHash, u32)>, bool)>, //TODO: Something clever to optimize this
 	listeners: Mutex<Vec<Weak<ChainListener>>>,
+	reentered: AtomicUsize
 }
 
-impl ChainWatchInterfaceUtil {
-	pub fn new() -> ChainWatchInterfaceUtil {
-		ChainWatchInterfaceUtil {
-			watched: Mutex::new((Vec::new(), Vec::new(), false)),
-			listeners: Mutex::new(Vec::new()),
-		}
-	}
-
-	pub fn install_watch_script(&self, spk: Script) {
+/// Register listener
+impl ChainWatchInterface for ChainWatchInterfaceUtil {
+	fn install_watch_script(&self, script_pub_key: &Script) {
 		let mut watched = self.watched.lock().unwrap();
-		watched.0.push(Script::from(spk));
+		watched.0.push(script_pub_key.clone());
+		self.reentered.fetch_add(1, Ordering::Relaxed);
 	}
 
-	pub fn install_watch_outpoint(&self, outpoint: (Sha256dHash, u32)) {
+	fn install_watch_outpoint(&self, outpoint: (Sha256dHash, u32), _out_script: &Script) {
 		let mut watched = self.watched.lock().unwrap();
 		watched.1.push(outpoint);
+		self.reentered.fetch_add(1, Ordering::Relaxed);
 	}
 
-	pub fn watch_all_txn(&self) { //TODO: refcnt this?
+	fn watch_all_txn(&self) {
 		let mut watched = self.watched.lock().unwrap();
 		watched.2 = true;
+		self.reentered.fetch_add(1, Ordering::Relaxed);
 	}
 
-	pub fn register_listener(&self, listener: Weak<ChainListener>) {
+	fn register_listener(&self, listener: Weak<ChainListener>) {
 		let mut vec = self.listeners.lock().unwrap();
 		vec.push(listener);
 	}
+}
 
-	pub fn do_call_block_connected(&self, header: &BlockHeader, height: u32, txn_matched: &[&Transaction], indexes_of_txn_matched: &[u32]) {
+impl ChainWatchInterfaceUtil {
+	pub fn new() -> ChainWatchInterfaceUtil {
+		ChainWatchInterfaceUtil {
+			watched: Mutex::new((Vec::new(), Vec::new(), false)),
+			listeners: Mutex::new(Vec::new()),
+			reentered: AtomicUsize::new(1)
+		}
+	}
+
+	/// Notify listeners that a block was connected given a full, unfiltered block.
+	/// Handles re-scanning the block and calling block_connected again if listeners register new
+	/// watch data during the callbacks for you (see ChainListener::block_connected for more info).
+	pub fn block_connected_with_filtering(&self, block: &Block, height: u32) {
+		let mut reentered = true;
+		while reentered {
+			let mut matched = Vec::new();
+			let mut matched_index = Vec::new();
+			{
+				let watched = self.watched.lock().unwrap();
+				for (index, transaction) in block.txdata.iter().enumerate() {
+					if self.does_match_tx_unguarded(transaction, &watched) {
+						matched.push(transaction);
+						matched_index.push(index as u32);
+					}
+				}
+			}
+			reentered = self.block_connected_checked(&block.header, height, matched.as_slice(), matched_index.as_slice());
+		}
+	}
+
+	/// Notify listeners that a block was disconnected.
+	pub fn block_disconnected(&self, header: &BlockHeader) {
 		let listeners = self.listeners.lock().unwrap().clone();
 		for listener in listeners.iter() {
 			match listener.upgrade() {
-				Some(arc) => arc.block_connected(header, height, txn_matched, indexes_of_txn_matched),
+				Some(arc) => arc.block_disconnected(header),
 				None => ()
 			}
 		}
 	}
 
-	pub fn do_call_block_disconnected(&self, header: &BlockHeader) {
+	/// Notify listeners that a block was connected, given pre-filtered list of transactions in the
+	/// block which matched the filter (probably using does_match_tx).
+	/// Returns true if notified listeners registered additional watch data (implying that the
+	/// block must be re-scanned and this function called again prior to further block_connected
+	/// calls, see ChainListener::block_connected for more info).
+	pub fn block_connected_checked(&self, header: &BlockHeader, height: u32, txn_matched: &[&Transaction], indexes_of_txn_matched: &[u32]) -> bool {
+		let last_seen = self.reentered.load(Ordering::Relaxed);
+
 		let listeners = self.listeners.lock().unwrap().clone();
 		for listener in listeners.iter() {
 			match listener.upgrade() {
-				Some(arc) => arc.block_disconnected(header),
+				Some(arc) => arc.block_connected(header, height, txn_matched, indexes_of_txn_matched),
 				None => ()
 			}
 		}
+		return last_seen != self.reentered.load(Ordering::Relaxed);
 	}
 
-	/// Checks if a given transaction matches the current filter
+	/// Checks if a given transaction matches the current filter.
 	pub fn does_match_tx(&self, tx: &Transaction) -> bool {
 		let watched = self.watched.lock().unwrap();
+		self.does_match_tx_unguarded (tx, &watched)
+	}
+
+	fn does_match_tx_unguarded(&self, tx: &Transaction, watched: &MutexGuard<(Vec<Script>, Vec<(Sha256dHash, u32)>, bool)>) -> bool {
 		if watched.2 {
 			return true;
 		}