]> git.bitcoin.ninja Git - rust-lightning/commitdiff
Mark BDK types exported from transaction-sync as no-export 2024-06-tx-sync-bindings-upstream
authorMatt Corallo <git@bluematt.me>
Wed, 5 Jun 2024 13:38:56 +0000 (13:38 +0000)
committerMatt Corallo <git@bluematt.me>
Wed, 5 Jun 2024 14:46:08 +0000 (14:46 +0000)
lightning-transaction-sync/src/electrum.rs
lightning-transaction-sync/src/esplora.rs

index 046f698d4a259e3b0eace68790e59cfe1d406eb7..d2cb7256fd076fbfa7071d984da5a3e16351c389 100644 (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
        }
index 681075ade5afdbfb1176b52d3751d8eddaec5172..2e35a150c558a2123706ca06af7b56c4952ff85e 100644 (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
        }