complete sync wrapper

Author: joostjager

lightning-background-processor/src/lib.rs

@@ -36,10 +36,10 @@ use lightning::onion_message::messenger::AOnionMessenger;
 use lightning::routing::gossip::{NetworkGraph, P2PGossipSync};
 use lightning::routing::scoring::{ScoreUpdate, WriteableScore};
 use lightning::routing::utxo::UtxoLookup;
-use lightning::sign::{ChangeDestinationSource, OutputSpender};
+use lightning::sign::{ChangeDestinationSource, ChangeDestinationSourceSync, OutputSpender};
 use lightning::util::logger::Logger;
 use lightning::util::persist::{KVStore, Persister};
-use lightning::util::sweep::OutputSweeper;
+use lightning::util::sweep::{OutputSweeper, OutputSweeperSync};
 #[cfg(feature = "std")]
 use lightning::util::wakers::Sleeper;
 use lightning_rapid_gossip_sync::RapidGossipSync;
@@ -946,16 +946,17 @@ impl BackgroundProcessor {
 		PM: 'static + Deref + Send + Sync,
 		S: 'static + Deref<Target = SC> + Send + Sync,
 		SC: for<'b> WriteableScore<'b>,
-		D: 'static + Deref + Send + Sync,
+		D: Deref,
 		O: 'static + Deref + Send + Sync,
 		K: 'static + Deref + Send + Sync,
-		OS: 'static + Deref<Target = OutputSweeper<T, D, F, CF, K, L, O>> + Send + Sync,
+		OS: 'static + Deref<Target = OutputSweeperSync<T, D, F, CF, K, L, O>> + Send + Sync,
 	>(
 		persister: PS, event_handler: EH, chain_monitor: M, channel_manager: CM,
 		onion_messenger: Option<OM>, gossip_sync: GossipSync<PGS, RGS, G, UL, L>, peer_manager: PM,
 		sweeper: OS, logger: L, scorer: Option<S>,
 	) -> Self
 	where
+		D::Target: ChangeDestinationSourceSync,
 		UL::Target: 'static + UtxoLookup,
 		CF::Target: 'static + chain::Filter + Sync + Send,
 		T::Target: 'static + BroadcasterInterface,
@@ -967,7 +968,6 @@ impl BackgroundProcessor {
 		OM::Target: AOnionMessenger + Send + Sync,
 		PM::Target: APeerManager + Send + Sync,
 		O::Target: 'static + OutputSpender + Send + Sync,
-		D::Target: 'static + ChangeDestinationSource + Send + Sync,
 		K::Target: 'static + KVStore + Send + Sync,
 	{
 		let stop_thread = Arc::new(AtomicBool::new(false));
@@ -1117,7 +1117,7 @@ mod tests {
 	use lightning::routing::gossip::{NetworkGraph, P2PGossipSync};
 	use lightning::routing::router::{CandidateRouteHop, DefaultRouter, Path, RouteHop};
 	use lightning::routing::scoring::{ChannelUsage, LockableScore, ScoreLookUp, ScoreUpdate};
-	use lightning::sign::{AsyncGetChangeDestinationScriptResult, ChangeDestinationSource, InMemorySigner, KeysManager};
+	use lightning::sign::{AsyncGetChangeDestinationScriptResult, ChangeDestinationSource, ChangeDestinationSourceSync, InMemorySigner, KeysManager};
 	use lightning::types::features::{ChannelFeatures, NodeFeatures};
 	use lightning::types::payment::PaymentHash;
 	use lightning::util::config::UserConfig;
@@ -1129,7 +1129,7 @@ mod tests {
 		SCORER_PERSISTENCE_SECONDARY_NAMESPACE,
 	};
 	use lightning::util::ser::Writeable;
-	use lightning::util::sweep::{OutputSpendStatus, OutputSweeper, PRUNE_DELAY_BLOCKS};
+	use lightning::util::sweep::{OutputSpendStatus, OutputSweeper, OutputSweeperSync, PRUNE_DELAY_BLOCKS};
 	use lightning::util::test_utils;
 	use lightning::{get_event, get_event_msg};
 	use lightning_persister::fs_store::FilesystemStore;
@@ -1250,7 +1250,7 @@ mod tests {
 		best_block: BestBlock,
 		scorer: Arc<LockingWrapper<TestScorer>>,
 		sweeper: Arc<
-			OutputSweeper<
+			OutputSweeperSync<
 				Arc<test_utils::TestBroadcaster>,
 				Arc<TestWallet>,
 				Arc<test_utils::TestFeeEstimator>,
@@ -1551,11 +1551,9 @@ mod tests {
 
 	struct TestWallet {}
 
-	impl ChangeDestinationSource for TestWallet {
-		fn get_change_destination_script<'a>(&self) -> AsyncGetChangeDestinationScriptResult<'a, ScriptBuf> {
-			Box::pin(async move {
-				Ok(ScriptBuf::new())
-			})
+	impl ChangeDestinationSourceSync for TestWallet {
+		fn get_change_destination_script(&self) -> Result<ScriptBuf, ()> {
+			Ok(ScriptBuf::new())
 		}
 	}
 
@@ -1632,7 +1630,7 @@ mod tests {
 				IgnoringMessageHandler {},
 			));
 			let wallet = Arc::new(TestWallet {});
-			let sweeper = Arc::new(OutputSweeper::new(
+			let sweeper = Arc::new(OutputSweeperSync::new(
 				best_block,
 				Arc::clone(&tx_broadcaster),
 				Arc::clone(&fee_estimator),

lightning/src/sign/mod.rs

@@ -1006,16 +1006,15 @@ pub trait ChangeDestinationSourceSync {
 }
 
 /// A wrapper around [`ChangeDestinationSource`] to allow for async calls.
-pub struct ChangeDestinationSourceSyncWrapper<T>(T) where T: ChangeDestinationSourceSync;
+pub struct ChangeDestinationSourceSyncWrapper<T: Deref>(T) where T::Target:ChangeDestinationSourceSync;
 
-impl<T: ChangeDestinationSourceSync> ChangeDestinationSourceSyncWrapper<T> {
+impl<T: Deref> ChangeDestinationSourceSyncWrapper<T> where T::Target:ChangeDestinationSourceSync {
 	/// Creates a new [`ChangeDestinationSourceSyncWrapper`].
 	pub fn new(source: T) -> Self {
 		Self(source)
 	}
 }
-
-impl<T: ChangeDestinationSourceSync> ChangeDestinationSource for ChangeDestinationSourceSyncWrapper<T> {
+impl<T: Deref> ChangeDestinationSource for ChangeDestinationSourceSyncWrapper<T> where T::Target:ChangeDestinationSourceSync{
 	fn get_change_destination_script<'a>(&self) -> AsyncGetChangeDestinationScriptResult<'a, ScriptBuf> {
 		let script = self.0.get_change_destination_script();
 		Box::pin(async move { script })

lightning/src/util/sweep.rs

@@ -357,10 +357,11 @@ where
 	logger: L,
 }
 
-/// XXX
-pub struct OutputSweeperSync<B: Deref, D: ChangeDestinationSourceSync, E: Deref, F: Deref, K: Deref, L: Deref, O: Deref>
+/// A synchronous wrapper around [`OutputSweeper`] to be used in contexts where async is not available.
+pub struct OutputSweeperSync<B: Deref, D: Deref, E: Deref, F: Deref, K: Deref, L: Deref, O: Deref>
 where
 	B::Target: BroadcasterInterface,
+	D::Target: ChangeDestinationSourceSync,
 	E::Target: FeeEstimator,
 	F::Target: Filter + Sync + Send,
 	K::Target: KVStore,
@@ -370,17 +371,19 @@ where
 	sweeper: OutputSweeper<B, Arc<ChangeDestinationSourceSyncWrapper<D>>, E, F, K, L, O>,
 }
 
-impl<B: Deref, D: ChangeDestinationSourceSync, E: Deref, F: Deref, K: Deref, L: Deref, O: Deref>
+impl<B: Deref, D: Deref, E: Deref, F: Deref, K: Deref, L: Deref, O: Deref>
 OutputSweeperSync<B, D, E, F, K, L, O>
 where
 	B::Target: BroadcasterInterface,
+	D::Target: ChangeDestinationSourceSync,
 	E::Target: FeeEstimator,
 	F::Target: Filter + Sync + Send,
 	K::Target: KVStore,
 	L::Target: Logger,
 	O::Target: OutputSpender,
 {
-	fn new(
+	/// Constructs a new [`OutputSweeperSync`] instance.
+	pub fn new(
 		best_block: BestBlock, broadcaster: B, fee_estimator: E, chain_data_source: Option<F>,
 		output_spender: O, change_destination_source: D, kv_store: K, logger: L,
 	) -> Self {
@@ -408,6 +411,48 @@ where
 			},
 		}
 	}
+
+	pub fn track_spendable_outputs(
+		&self, output_descriptors: Vec<SpendableOutputDescriptor>, channel_id: Option<ChannelId>,
+		exclude_static_outputs: bool, delay_until_height: Option<u32>,
+	) -> Result<(), ()> {
+		self.sweeper.track_spendable_outputs(
+			output_descriptors, channel_id, exclude_static_outputs, delay_until_height,
+		)
+	}
+
+	pub fn tracked_spendable_outputs(&self) -> Vec<TrackedSpendableOutput> {
+		self.sweeper.tracked_spendable_outputs()
+	}
+}
+
+impl<B: Deref, D: Deref, E: Deref, F: Deref, K: Deref, L: Deref, O: Deref> Confirm for OutputSweeperSync<B, D, E, F, K, L, O>
+where
+	B::Target: BroadcasterInterface,
+	D::Target: ChangeDestinationSourceSync,
+	E::Target: FeeEstimator,
+	F::Target: Filter + Sync + Send,
+	K::Target: KVStore,
+	L::Target: Logger,
+	O::Target: OutputSpender,
+{
+	fn transactions_confirmed(
+		&self, header: &Header, txdata: &chain::transaction::TransactionData, height: u32,
+	) {
+		self.sweeper.transactions_confirmed(header, txdata, height)
+	}
+
+	fn transaction_unconfirmed(&self, txid: &Txid) {
+		self.sweeper.transaction_unconfirmed(txid)
+	}
+
+	fn best_block_updated(&self, header: &Header, height: u32) {
+		self.sweeper.best_block_updated(header, height);
+	}
+
+	fn get_relevant_txids(&self) -> Vec<(Txid, u32, Option<BlockHash>)> {
+		self.sweeper.get_relevant_txids()
+	}
 }
 
 impl<B: Deref, D: Deref, E: Deref, F: Deref, K: Deref, L: Deref, O: Deref>