From: Matt Corallo <git@bluematt.me>
Date: Wed, 5 Jun 2024 13:38:56 +0000 (+0000)
Subject: Mark BDK types exported from transaction-sync as no-export
X-Git-Url: http://git.bitcoin.ninja/?a=commitdiff_plain;h=bff453c341e8e97cfaef11af7eb5d4f826cc0f0a;p=rust-lightning

Mark BDK types exported from transaction-sync as no-export
---

diff --git a/lightning-transaction-sync/src/electrum.rs b/lightning-transaction-sync/src/electrum.rs
index 046f698d4..d2cb7256f 100644
--- a/lightning-transaction-sync/src/electrum.rs
+++ b/lightning-transaction-sync/src/electrum.rs
@@ -58,6 +58,8 @@ where
 	}
 
 	/// Returns a new [`ElectrumSyncClient`] object using the given Electrum client.
+	///
+	/// This is not exported to bindings users as the underlying client from BDK is not exported.
 	pub fn from_client(client: ElectrumClient, logger: L) -> Result<Self, TxSyncError> {
 		let sync_state = Mutex::new(SyncState::new());
 		let queue = Mutex::new(FilterQueue::new());
@@ -450,6 +452,8 @@ where
 	}
 
 	/// Returns a reference to the underlying Electrum client.
+	///
+	/// This is not exported to bindings users as the underlying client from BDK is not exported.
 	pub fn client(&self) -> &ElectrumClient {
 		&self.client
 	}
diff --git a/lightning-transaction-sync/src/esplora.rs b/lightning-transaction-sync/src/esplora.rs
index 538918ada..bff7c52d3 100644
--- a/lightning-transaction-sync/src/esplora.rs
+++ b/lightning-transaction-sync/src/esplora.rs
@@ -59,6 +59,8 @@ where
 	}
 
 	/// Returns a new [`EsploraSyncClient`] object using the given Esplora client.
+	///
+	/// This is not exported to bindings users as the underlying client from BDK is not exported.
 	pub fn from_client(client: EsploraClientType, logger: L) -> Self {
 		let sync_state = MutexType::new(SyncState::new());
 		let queue = std::sync::Mutex::new(FilterQueue::new());
@@ -397,6 +399,8 @@ where
 	}
 
 	/// Returns a reference to the underlying esplora client.
+	///
+	/// This is not exported to bindings users as the underlying client from BDK is not exported.
 	pub fn client(&self) -> &EsploraClientType {
 		&self.client
 	}