openethereum/ethcore/light/src/lib.rs

83 lines
2.5 KiB
Rust
Raw Normal View History

// Copyright 2015-2017 Parity Technologies (UK) Ltd.
// This file is part of Parity.
// Parity is free software: you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
// Parity is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
// GNU General Public License for more details.
// You should have received a copy of the GNU General Public License
// along with Parity. If not, see <http://www.gnu.org/licenses/>.
//! Light client logic and implementation.
//!
//! A "light" client stores very little chain-related data locally
//! unlike a full node, which stores all blocks, headers, receipts, and more.
//!
//! This enables the client to have a much lower resource footprint in
//! exchange for the cost of having to ask the network for state data
//! while responding to queries. This makes a light client unsuitable for
//! low-latency applications, but perfectly suitable for simple everyday
//! use-cases like sending transactions from a personal account.
//!
2016-12-13 20:13:16 +01:00
//! The light client performs a header-only sync, doing verification and pruning
2017-03-06 12:21:06 +01:00
//! historical blocks. Upon pruning, batches of 2048 blocks have a number => (hash, TD)
2016-12-13 20:13:16 +01:00
//! mapping sealed into "canonical hash tries" which can later be used to verify
//! historical block queries from peers.
#![deny(missing_docs)]
2016-11-09 18:05:56 +01:00
pub mod client;
2017-01-16 16:55:23 +01:00
pub mod cht;
pub mod net;
2017-03-16 20:23:59 +01:00
pub mod on_demand;
2017-02-08 19:21:12 +01:00
pub mod transaction_queue;
2017-02-16 18:07:28 +01:00
pub mod cache;
#[cfg(not(feature = "ipc"))]
pub mod provider;
#[cfg(feature = "ipc")]
pub mod provider {
#![allow(dead_code, unused_assignments, unused_variables, missing_docs)] // codegen issues
include!(concat!(env!("OUT_DIR"), "/provider.rs"));
}
#[cfg(feature = "ipc")]
pub mod remote {
pub use provider::LightProviderClient;
}
2016-12-05 16:55:33 +01:00
mod types;
2017-03-22 21:09:43 +01:00
pub use self::cache::Cache;
2016-11-15 14:53:30 +01:00
pub use self::provider::Provider;
2017-02-09 19:17:37 +01:00
pub use self::transaction_queue::TransactionQueue;
2017-03-03 19:25:29 +01:00
pub use types::request as request;
2016-12-05 16:55:33 +01:00
#[macro_use]
extern crate log;
extern crate ethcore;
extern crate ethcore_util as util;
extern crate ethcore_network as network;
extern crate ethcore_io as io;
extern crate rlp;
extern crate smallvec;
extern crate time;
2016-12-27 16:43:28 +01:00
extern crate futures;
2016-12-28 16:20:46 +01:00
extern crate rand;
2017-02-03 19:50:23 +01:00
extern crate itertools;
extern crate stats;
#[cfg(feature = "ipc")]
extern crate ethcore_ipc as ipc;
2017-03-21 20:57:13 +01:00
#[cfg(test)]
extern crate ethcore_devtools as devtools;