Implement chain::Confirm for relevant structs

Author: jkczyz

fuzz/src/chanmon_consistency.rs

@@ -30,6 +30,7 @@ use bitcoin::hashes::sha256::Hash as Sha256;
 use bitcoin::hash_types::{BlockHash, WPubkeyHash};
 
 use lightning::chain;
+use lightning::chain::Confirm;
 use lightning::chain::chainmonitor;
 use lightning::chain::channelmonitor;
 use lightning::chain::channelmonitor::{ChannelMonitor, ChannelMonitorUpdateErr, MonitorEvent};
@@ -428,11 +429,11 @@ pub fn do_test<Out: test_logger::Output>(data: &[u8], out: Out) {
 			let chain_hash = genesis_block(Network::Bitcoin).block_hash();
 			let mut header = BlockHeader { version: 0x20000000, prev_blockhash: chain_hash, merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
 			let txdata: Vec<_> = channel_txn.iter().enumerate().map(|(i, tx)| (i + 1, tx)).collect();
-			$node.transactions_confirmed(&header, 1, &txdata);
+			$node.transactions_confirmed(&header, &txdata, 1);
 			for _ in 2..100 {
 				header = BlockHeader { version: 0x20000000, prev_blockhash: header.block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
 			}
-			$node.update_best_block(&header, 99);
+			$node.best_block_updated(&header, 99);
 		} }
 	}
 

fuzz/src/full_stack.rs

@@ -27,7 +27,7 @@ use bitcoin::hashes::sha256::Hash as Sha256;
 use bitcoin::hash_types::{Txid, BlockHash, WPubkeyHash};
 
 use lightning::chain;
-use lightning::chain::Listen;
+use lightning::chain::{Confirm, Listen};
 use lightning::chain::chaininterface::{BroadcasterInterface, ConfirmationTarget, FeeEstimator};
 use lightning::chain::chainmonitor;
 use lightning::chain::transaction::OutPoint;
@@ -207,8 +207,8 @@ impl<'a> MoneyLossDetector<'a> {
 		self.blocks_connected += 1;
 		let header = BlockHeader { version: 0x20000000, prev_blockhash: self.header_hashes[self.height].0, merkle_root: Default::default(), time: self.blocks_connected, bits: 42, nonce: 42 };
 		self.height += 1;
-		self.manager.transactions_confirmed(&header, self.height as u32, &txdata);
-		self.manager.update_best_block(&header, self.height as u32);
+		self.manager.transactions_confirmed(&header, &txdata, self.height as u32);
+		self.manager.best_block_updated(&header, self.height as u32);
 		(*self.monitor).block_connected(&header, &txdata, self.height as u32);
 		if self.header_hashes.len() > self.height {
 			self.header_hashes[self.height] = (header.block_hash(), self.blocks_connected);

lightning/src/chain/chainmonitor.rs

@@ -94,11 +94,11 @@ where C::Target: chain::Filter,
 	/// [`ChannelMonitor::transactions_confirmed`].
 	///
 	/// Used instead of [`block_connected`] by clients that are notified of transactions rather than
-	/// blocks. May be called before or after [`update_best_block`] for transactions in the
-	/// corresponding block. See [`update_best_block`] for further calling expectations.
+	/// blocks. May be called before or after [`best_block_updated`] for transactions in the
+	/// corresponding block. See [`best_block_updated`] for further calling expectations.
 	///
 	/// [`block_connected`]: Self::block_connected
-	/// [`update_best_block`]: Self::update_best_block
+	/// [`best_block_updated`]: Self::best_block_updated
 	pub fn transactions_confirmed(&self, header: &BlockHeader, txdata: &TransactionData, height: u32) {
 		self.process_chain_data(header, txdata, |monitor, txdata| {
 			monitor.transactions_confirmed(
@@ -108,7 +108,7 @@ where C::Target: chain::Filter,
 
 	/// Dispatches to per-channel monitors, which are responsible for updating their on-chain view
 	/// of a channel and reacting accordingly based on the new chain tip. For details, see
-	/// [`ChannelMonitor::update_best_block`].
+	/// [`ChannelMonitor::best_block_updated`].
 	///
 	/// Used instead of [`block_connected`] by clients that are notified of transactions rather than
 	/// blocks. May be called before or after [`transactions_confirmed`] for the corresponding
@@ -122,12 +122,12 @@ where C::Target: chain::Filter,
 	/// [`block_connected`]: Self::block_connected
 	/// [`transactions_confirmed`]: Self::transactions_confirmed
 	/// [`transaction_unconfirmed`]: Self::transaction_unconfirmed
-	pub fn update_best_block(&self, header: &BlockHeader, height: u32) {
+	pub fn best_block_updated(&self, header: &BlockHeader, height: u32) {
 		self.process_chain_data(header, &[], |monitor, txdata| {
 			// While in practice there shouldn't be any recursive calls when given empty txdata,
 			// it's still possible if a chain::Filter implementation returns a transaction.
 			debug_assert!(txdata.is_empty());
-			monitor.update_best_block(
+			monitor.best_block_updated(
 				header, height, &*self.broadcaster, &*self.fee_estimator, &*self.logger)
 		});
 	}
@@ -187,11 +187,11 @@ where C::Target: chain::Filter,
 	/// [`ChannelMonitor::transaction_unconfirmed`] for details.
 	///
 	/// Used instead of [`block_disconnected`] by clients that are notified of transactions rather
-	/// than blocks. May be called before or after [`update_best_block`] for transactions in the
-	/// corresponding block. See [`update_best_block`] for further calling expectations. 
+	/// than blocks. May be called before or after [`best_block_updated`] for transactions in the
+	/// corresponding block. See [`best_block_updated`] for further calling expectations.
 	///
 	/// [`block_disconnected`]: Self::block_disconnected
-	/// [`update_best_block`]: Self::update_best_block
+	/// [`best_block_updated`]: Self::best_block_updated
 	pub fn transaction_unconfirmed(&self, txid: &Txid) {
 		let monitors = self.monitors.read().unwrap();
 		for monitor in monitors.values() {

lightning/src/chain/channelmonitor.rs

@@ -1311,11 +1311,9 @@ impl<Signer: Sign> ChannelMonitor<Signer> {
 	/// outputs to watch. See [`block_connected`] for details.
 	///
 	/// Used instead of [`block_connected`] by clients that are notified of transactions rather than
-	/// blocks. May be called before or after [`update_best_block`] for transactions in the
-	/// corresponding block. See [`update_best_block`] for further calling expectations. 
+	/// blocks. See [`chain::Confirm`] for calling expectations.
 	///
 	/// [`block_connected`]: Self::block_connected
-	/// [`update_best_block`]: Self::update_best_block
 	pub fn transactions_confirmed<B: Deref, F: Deref, L: Deref>(
 		&self,
 		header: &BlockHeader,
@@ -1337,11 +1335,9 @@ impl<Signer: Sign> ChannelMonitor<Signer> {
 	/// Processes a transaction that was reorganized out of the chain.
 	///
 	/// Used instead of [`block_disconnected`] by clients that are notified of transactions rather
-	/// than blocks. May be called before or after [`update_best_block`] for transactions in the
-	/// corresponding block. See [`update_best_block`] for further calling expectations.
+	/// than blocks. See [`chain::Confirm`] for calling expectations.
 	///
 	/// [`block_disconnected`]: Self::block_disconnected
-	/// [`update_best_block`]: Self::update_best_block
 	pub fn transaction_unconfirmed<B: Deref, F: Deref, L: Deref>(
 		&self,
 		txid: &Txid,
@@ -1361,18 +1357,10 @@ impl<Signer: Sign> ChannelMonitor<Signer> {
 	/// [`block_connected`] for details.
 	///
 	/// Used instead of [`block_connected`] by clients that are notified of transactions rather than
-	/// blocks. May be called before or after [`transactions_confirmed`] for the corresponding
-	/// block.
-	///
-	/// Must be called after new blocks become available for the most recent block. Intermediary
-	/// blocks, however, may be safely skipped. In the event of a chain re-organization, this only
-	/// needs to be called for the most recent block assuming `transaction_unconfirmed` is called
-	/// for any affected transactions.
+	/// blocks. See [`chain::Confirm`] for calling expectations.
 	///
 	/// [`block_connected`]: Self::block_connected
-	/// [`transactions_confirmed`]: Self::transactions_confirmed
-	/// [`transaction_unconfirmed`]: Self::transaction_unconfirmed
-	pub fn update_best_block<B: Deref, F: Deref, L: Deref>(
+	pub fn best_block_updated<B: Deref, F: Deref, L: Deref>(
 		&self,
 		header: &BlockHeader,
 		height: u32,
@@ -1385,7 +1373,7 @@ impl<Signer: Sign> ChannelMonitor<Signer> {
 		F::Target: FeeEstimator,
 		L::Target: Logger,
 	{
-		self.inner.lock().unwrap().update_best_block(
+		self.inner.lock().unwrap().best_block_updated(
 			header, height, broadcaster, fee_estimator, logger)
 	}
 
@@ -2109,7 +2097,7 @@ impl<Signer: Sign> ChannelMonitorImpl<Signer> {
 		self.transactions_confirmed(header, txdata, height, broadcaster, fee_estimator, logger)
 	}
 
-	fn update_best_block<B: Deref, F: Deref, L: Deref>(
+	fn best_block_updated<B: Deref, F: Deref, L: Deref>(
 		&mut self,
 		header: &BlockHeader,
 		height: u32,
@@ -2727,6 +2715,29 @@ where
 	}
 }
 
+impl<Signer: Sign, T: Deref, F: Deref, L: Deref> chain::Confirm for (ChannelMonitor<Signer>, T, F, L)
+where
+	T::Target: BroadcasterInterface,
+	F::Target: FeeEstimator,
+	L::Target: Logger,
+{
+	fn transactions_confirmed(&self, header: &BlockHeader, txdata: &TransactionData, height: u32) {
+		self.0.transactions_confirmed(header, txdata, height, &*self.1, &*self.2, &*self.3);
+	}
+
+	fn transaction_unconfirmed(&self, txid: &Txid) {
+		self.0.transaction_unconfirmed(txid, &*self.1, &*self.2, &*self.3);
+	}
+
+	fn best_block_updated(&self, header: &BlockHeader, height: u32) {
+		self.0.best_block_updated(header, height, &*self.1, &*self.2, &*self.3);
+	}
+
+	fn get_relevant_txids(&self) -> Vec<Txid> {
+		self.0.get_relevant_txids()
+	}
+}
+
 const MAX_ALLOC_SIZE: usize = 64*1024;
 
 impl<'a, Signer: Sign, K: KeysInterface<Signer = Signer>> ReadableArgs<&'a K>

lightning/src/ln/channel.rs

@@ -3600,7 +3600,7 @@ impl<Signer: Sign> Channel<Signer> {
 						}
 					}
 					// If we allow 1-conf funding, we may need to check for funding_locked here and
-					// send it immediately instead of waiting for an update_best_block call (which
+					// send it immediately instead of waiting for a best_block_updated call (which
 					// may have already happened for this block).
 					if let Some(funding_locked) = self.check_get_funding_locked(height) {
 						return Ok(Some(funding_locked));
@@ -3631,7 +3631,7 @@ impl<Signer: Sign> Channel<Signer> {
 	///
 	/// May return some HTLCs (and their payment_hash) which have timed out and should be failed
 	/// back.
-	pub fn update_best_block(&mut self, height: u32, highest_header_time: u32) -> Result<(Option<msgs::FundingLocked>, Vec<(HTLCSource, PaymentHash)>), msgs::ErrorMessage> {
+	pub fn best_block_updated(&mut self, height: u32, highest_header_time: u32) -> Result<(Option<msgs::FundingLocked>, Vec<(HTLCSource, PaymentHash)>), msgs::ErrorMessage> {
 		let mut timed_out_htlcs = Vec::new();
 		let unforwarded_htlc_cltv_limit = height + HTLC_FAIL_BACK_BUFFER;
 		self.holding_cell_htlc_updates.retain(|htlc_update| {
@@ -3683,14 +3683,14 @@ impl<Signer: Sign> Channel<Signer> {
 	/// before the channel has reached funding_locked and we can just wait for more blocks.
 	pub fn funding_transaction_unconfirmed(&mut self) -> Result<(), msgs::ErrorMessage> {
 		if self.funding_tx_confirmation_height != 0 {
-			// We handle the funding disconnection by calling update_best_block with a height one
+			// We handle the funding disconnection by calling best_block_updated with a height one
 			// below where our funding was connected, implying a reorg back to conf_height - 1.
 			let reorg_height = self.funding_tx_confirmation_height - 1;
 			// We use the time field to bump the current time we set on channel updates if its
 			// larger. If we don't know that time has moved forward, we can just set it to the last
 			// time we saw and it will be ignored.
 			let best_time = self.update_time_counter;
-			match self.update_best_block(reorg_height, best_time) {
+			match self.best_block_updated(reorg_height, best_time) {
 				Ok((funding_locked, timed_out_htlcs)) => {
 					assert!(funding_locked.is_none(), "We can't generate a funding with 0 confirmations?");
 					assert!(timed_out_htlcs.is_empty(), "We can't have accepted HTLCs with a timeout before our funding confirmation?");