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

//! Nakamoto is a high-assurance Bitcoin light-client library.
//!
//! The project is broken down into the following crates:
//!
//! * [`client`]: the core light-client library
//! * [`p2p`]: the protocol implementation
//! * [`chain`]: the block store and fork selection logic
//! * [`common`]: common functionality used by all crates
//!
//! The [`client`] crate is intended to be the entry point for most users of the
//! library, and is a good place to start, to see how everything fits together.
//!
//! ```no_run
//! use std::{net, thread};
//!
//! use nakamoto::client::{Client, Config, Network};
//! use nakamoto::client::error::Error;
//! use nakamoto::client::handle::Handle as _;
//!
//! /// The network reactor we're going to use.
//! type Reactor = nakamoto::net::poll::Reactor<net::TcpStream>;
//!
//! /// Run the light-client.
//! fn main() {
//!     let cfg = Config {
//!         network: Network::Testnet,
//!         ..Config::default()
//!     };
//!     // Create a client using the above network reactor.
//!     let client = Client::<Reactor>::new(cfg).unwrap();
//!     let handle = client.handle();
//!
//!     // Run the client on a different thread, to not block the main thread.
//!     thread::spawn(|| client.run().unwrap());
//!
//!     // Ask the client to terminate.
//!     handle.shutdown().unwrap()
//! }
//! ```

#[cfg(feature = "nakamoto-chain")]
pub use nakamoto_chain as chain;
#[cfg(feature = "nakamoto-client")]
pub use nakamoto_client as client;
#[cfg(feature = "nakamoto-common")]
pub use nakamoto_common as common;
#[cfg(feature = "nakamoto-node")]
pub use nakamoto_node as node;
#[cfg(feature = "nakamoto-p2p")]
pub use nakamoto_p2p as p2p;
#[cfg(feature = "nakamoto-wallet")]
pub use nakamoto_wallet as wallet;

#[cfg(test)]
#[cfg(feature = "nakamoto-test")]
pub use nakamoto_test as test;

pub mod net {
    #[cfg(feature = "nakamoto-net-poll")]
    pub use nakamoto_net_poll as poll;
}