electrum-client 0.25.0

Bitcoin Electrum client library. Supports plaintext, TLS and Onion servers.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64

// SPDX-License-Identifier: MIT OR Apache-2.0

#![warn(missing_docs)]

//! This library provides an extendable Bitcoin-Electrum client that supports batch calls,
//! notifications and multiple transport methods.
//!
//! By default this library is compiled with support for SSL servers using [`rustls`](https://docs.rs/rustls) and support for
//! plaintext connections over a socks proxy, useful for Onion servers. Using different features,
//! the SSL implementation can be removed or replaced with [`openssl`](https://docs.rs/openssl).
//!
//! For a minimal configuration the library can be built with `--no-default-features`, which only includes the plaintext TCP client.
//!
//! # Example
//!
//! ```no_run
//! use electrum_client::{Client, ElectrumApi};
//!
//! let mut client = Client::new("tcp://electrum.blockstream.info:50001")?;
//! let response = client.server_features()?;
//! # Ok::<(), electrum_client::Error>(())
//! ```

pub extern crate bitcoin;
extern crate core;
extern crate log;
#[cfg(feature = "openssl")]
extern crate openssl;
#[cfg(any(feature = "rustls", feature = "rustls-ring"))]
extern crate rustls;
extern crate serde;
extern crate serde_json;

#[cfg(any(feature = "rustls", feature = "rustls-ring"))]
extern crate webpki_roots;

#[cfg(feature = "proxy")]
extern crate byteorder;

#[cfg(all(unix, feature = "proxy"))]
extern crate libc;
#[cfg(all(windows, feature = "proxy"))]
extern crate winapi;

#[cfg(feature = "proxy")]
pub mod socks;

mod api;
mod batch;

pub mod client;

mod config;

pub mod raw_client;
mod stream;
mod types;
pub mod utils;

pub use api::ElectrumApi;
pub use batch::Batch;
pub use client::*;
pub use config::{AuthProvider, Config, ConfigBuilder, Socks5Config};
pub use types::*;