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

This commit is contained in:
Matt Corallo 2024-06-05 13:38:56 +00:00
parent e5b74026a0
commit 4ec286979c
2 changed files with 8 additions and 0 deletions

View file

@ -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
}

View file

@ -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
}