f: doc updates and clean ups

Author: joostjager

lightning/src/events/bump_transaction/mod.rs

@@ -322,6 +322,8 @@ pub struct CoinSelection {
 /// sign for them. The coin selection method aims to mimic Bitcoin Core's `fundrawtransaction` RPC,
 /// which most wallets should be able to satisfy. Otherwise, consider implementing [`WalletSource`],
 /// which can provide a default implementation of this trait when used with [`Wallet`].
+///
+/// For a synchronous version of this trait, see [`sync::CoinSelectionSourceSync`].
 pub trait CoinSelectionSource {
 	/// Performs coin selection of a set of UTXOs, with at least 1 confirmation each, that are
 	/// available to spend. Implementations are free to pick their coin selection algorithm of
@@ -363,6 +365,8 @@ pub trait CoinSelectionSource {
 
 /// An alternative to [`CoinSelectionSource`] that can be implemented and used along [`Wallet`] to
 /// provide a default implementation to [`CoinSelectionSource`].
+///
+/// For a synchronous version of this trait, see [`sync::WalletSourceSync`].
 pub trait WalletSource {
 	/// Returns all UTXOs, with at least 1 confirmation each, that are available to spend.
 	fn list_confirmed_utxos<'a>(&'a self) -> AsyncResult<'a, Vec<Utxo>>;
@@ -381,6 +385,8 @@ pub trait WalletSource {
 /// A wrapper over [`WalletSource`] that implements [`CoinSelection`] by preferring UTXOs that would
 /// avoid conflicting double spends. If not enough UTXOs are available to do so, conflicting double
 /// spends may happen.
+///
+/// For a synchronous version of this wrapper, see [`sync::WalletSync`].
 pub struct Wallet<W: Deref + MaybeSync + MaybeSend, L: Deref + MaybeSync + MaybeSend>
 where
 	W::Target: WalletSource + MaybeSend,
@@ -574,6 +580,8 @@ where
 /// [`CoinSelectionSource`] to fee bump transactions via Child-Pays-For-Parent (CPFP) or
 /// Replace-By-Fee (RBF).
 ///
+/// For a synchronous version of this handler, see [`sync::BumpTransactionEventHandlerSync`].
+///
 /// [`Event::BumpTransaction`]: crate::events::Event::BumpTransaction
 pub struct BumpTransactionEventHandler<B: Deref, C: Deref, SP: Deref, L: Deref>
 where

lightning/src/events/bump_transaction/sync.rs

@@ -39,45 +39,24 @@ pub trait WalletSourceSync {
 	fn sign_psbt(&self, psbt: Psbt) -> Result<Transaction, ()>;
 }
 
-/// A wrapper around [`WalletSourceSync`] to allow for async calls.
-///
-/// This wrapper isn't intended to be used directly, because that would risk blocking an async context. Instead, it is
-/// built for you in [`WalletSync::new`].
-#[doc(hidden)]
 pub(crate) struct WalletSourceSyncWrapper<T: Deref>(T)
 where
 	T::Target: WalletSourceSync;
 
-impl<T: Deref> WalletSourceSyncWrapper<T>
-where
-	T::Target: WalletSourceSync,
-{
-	/// Creates a new [`WalletSourceSyncWrapper`].
-	pub fn new(source: T) -> Self {
-		Self(source)
-	}
-}
 impl<T: Deref> WalletSource for WalletSourceSyncWrapper<T>
 where
 	T::Target: WalletSourceSync,
 {
-	/// Returns all UTXOs, with at least 1 confirmation each, that are available to spend. Wraps
-	/// [`WalletSourceSync::list_confirmed_utxos`].
 	fn list_confirmed_utxos<'a>(&'a self) -> AsyncResult<'a, Vec<Utxo>> {
 		let utxos = self.0.list_confirmed_utxos();
 		Box::pin(async move { utxos })
 	}
 
-	/// Returns a script to use for change above dust resulting from a successful coin selection attempt. Wraps
-	/// [`WalletSourceSync::get_change_script`].
 	fn get_change_script<'a>(&'a self) -> AsyncResult<'a, ScriptBuf> {
 		let script = self.0.get_change_script();
 		Box::pin(async move { script })
 	}
 
-	/// Signs and provides the full [`TxIn::script_sig`] and [`TxIn::witness`] for all inputs within the transaction
-	/// known to the wallet (i.e., any provided via [`WalletSource::list_confirmed_utxos`]). Wraps
-	/// [`WalletSourceSync::sign_psbt`].
 	fn sign_psbt<'a>(&'a self, psbt: Psbt) -> AsyncResult<'a, Transaction> {
 		let signed_psbt = self.0.sign_psbt(psbt);
 		Box::pin(async move { signed_psbt })
@@ -100,7 +79,7 @@ where
 {
 	/// Constructs a new [`WalletSync`] instance.
 	pub fn new(source: W, logger: L) -> Self {
-		Self { wallet: Wallet::new(Arc::new(WalletSourceSyncWrapper::new(source)), logger) }
+		Self { wallet: Wallet::new(Arc::new(WalletSourceSyncWrapper(source)), logger) }
 	}
 }
 
@@ -145,8 +124,7 @@ where
 	}
 }
 
-/// A synchronous helper trait that can be used to implement [`CoinSelectionSource`] in a synchronous
-/// context.
+/// A synchronous version of the [`CoinSelectionSource`] trait.
 pub trait CoinSelectionSourceSync {
 	/// A synchronous version of [`CoinSelectionSource::select_confirmed_utxos`].
 	fn select_confirmed_utxos(
@@ -162,16 +140,6 @@ struct CoinSelectionSourceSyncWrapper<T: Deref>(T)
 where
 	T::Target: CoinSelectionSourceSync;
 
-impl<T: Deref> CoinSelectionSourceSyncWrapper<T>
-where
-	T::Target: CoinSelectionSourceSync,
-{
-	#[allow(dead_code)]
-	pub fn new(source: T) -> Self {
-		Self(source)
-	}
-}
-
 impl<T: Deref> CoinSelectionSource for CoinSelectionSourceSyncWrapper<T>
 where
 	T::Target: CoinSelectionSourceSync,