]> Untitled Git - bdk/commitdiff
Missing docs for electrum.rs
authorRiccardo Casatta <riccardo@casatta.it>
Fri, 27 Nov 2020 09:25:12 +0000 (10:25 +0100)
committerSteve Myers <steve@notmandatory.org>
Wed, 2 Dec 2020 22:19:35 +0000 (14:19 -0800)
src/blockchain/electrum.rs

index e65b53da7069e72e95d2c9ae3a610c0d26c979e1..8b70e7afdf53d57b85633fb8fd255512d2e971c6 100644 (file)
@@ -159,7 +159,11 @@ impl ElectrumLikeSync for Client {
 /// Configuration for an [`ElectrumBlockchain`]
 #[derive(Debug, serde::Deserialize, serde::Serialize)]
 pub struct ElectrumBlockchainConfig {
+    /// URL of the Electrum server (such as ElectrumX, Esplora, BWT) may start with `ssl://` or `tcp://` and include a port
+    ///
+    /// eg. `ssl://electrum.blockstream.info:60002`
     pub url: String,
+    /// URL of the socks5 proxy server or a Tor service
     pub socks5: Option<String>,
     pub retry: u8,
     pub timeout: u8,