Skip to content

Commit b183367

Browse files
Merge pull request #3095 from TheBlueMatt/2024-06-tx-sync-bindings-upstream
Mark BDK types exported from transaction-sync as no-export
2 parents e5b7402 + 4ec2869 commit b183367

File tree

2 files changed

+8
-0
lines changed

2 files changed

+8
-0
lines changed

lightning-transaction-sync/src/electrum.rs

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -58,6 +58,8 @@ where
5858
}
5959

6060
/// Returns a new [`ElectrumSyncClient`] object using the given Electrum client.
61+
///
62+
/// This is not exported to bindings users as the underlying client from BDK is not exported.
6163
pub fn from_client(client: ElectrumClient, logger: L) -> Result<Self, TxSyncError> {
6264
let sync_state = Mutex::new(SyncState::new());
6365
let queue = Mutex::new(FilterQueue::new());
@@ -450,6 +452,8 @@ where
450452
}
451453

452454
/// Returns a reference to the underlying Electrum client.
455+
///
456+
/// This is not exported to bindings users as the underlying client from BDK is not exported.
453457
pub fn client(&self) -> &ElectrumClient {
454458
&self.client
455459
}

lightning-transaction-sync/src/esplora.rs

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -59,6 +59,8 @@ where
5959
}
6060

6161
/// Returns a new [`EsploraSyncClient`] object using the given Esplora client.
62+
///
63+
/// This is not exported to bindings users as the underlying client from BDK is not exported.
6264
pub fn from_client(client: EsploraClientType, logger: L) -> Self {
6365
let sync_state = MutexType::new(SyncState::new());
6466
let queue = std::sync::Mutex::new(FilterQueue::new());
@@ -397,6 +399,8 @@ where
397399
}
398400

399401
/// Returns a reference to the underlying esplora client.
402+
///
403+
/// This is not exported to bindings users as the underlying client from BDK is not exported.
400404
pub fn client(&self) -> &EsploraClientType {
401405
&self.client
402406
}

0 commit comments

Comments
 (0)