openethereum/sync/src/lib.rs

88 lines
2.5 KiB
Rust
Raw Normal View History

// Copyright 2015-2017 Parity Technologies (UK) Ltd.
2016-02-05 13:40:41 +01:00
// 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/>.
2016-01-29 15:56:06 +01:00
#![warn(missing_docs)]
2016-03-11 11:16:49 +01:00
#![cfg_attr(feature="dev", feature(plugin))]
#![cfg_attr(feature="dev", plugin(clippy))]
2016-02-15 00:51:50 +01:00
// Keeps consistency (all lines with `.clone()`) and helpful when changing ref to non-ref.
2016-03-11 11:16:49 +01:00
#![cfg_attr(feature="dev", allow(clone_on_copy))]
2016-03-11 10:57:58 +01:00
// In most cases it expresses function flow better
#![cfg_attr(feature="dev", allow(if_not_else))]
2016-02-15 00:51:50 +01:00
2016-01-29 15:56:06 +01:00
//! Blockchain sync module
//! Implements ethereum protocol version 63 as specified here:
//! https://github.com/ethereum/wiki/wiki/Ethereum-Wire-Protocol
//!
extern crate ethcore_network as network;
extern crate ethcore_io as io;
2016-01-29 15:56:06 +01:00
extern crate ethcore;
extern crate env_logger;
2016-02-02 14:54:46 +01:00
extern crate time;
2016-02-05 18:34:08 +01:00
extern crate rand;
2016-09-01 14:49:12 +02:00
extern crate semver;
extern crate parking_lot;
extern crate rlp;
2016-12-07 13:52:45 +01:00
extern crate ethcore_light as light;
2016-12-06 19:23:15 +01:00
#[cfg(test)] extern crate ethcore_devtools as devtools;
#[cfg(test)] extern crate ethkey;
2016-09-01 14:49:12 +02:00
#[macro_use]
extern crate log;
#[macro_use]
extern crate ethcore_util as util;
2016-02-24 22:37:28 +01:00
#[macro_use]
extern crate heapsize;
#[macro_use]
extern crate ethcore_ipc as ipc;
2015-12-22 22:19:50 +01:00
mod chain;
2016-05-16 14:41:41 +02:00
mod blocks;
mod block_sync;
mod sync_io;
mod snapshot;
mod transactions_stats;
2015-12-22 22:19:50 +01:00
2016-12-15 21:51:08 +01:00
pub mod light_sync;
2015-12-25 14:55:55 +01:00
#[cfg(test)]
mod tests;
2015-12-22 22:19:50 +01:00
2016-12-08 19:52:48 +01:00
#[cfg(feature = "ipc")]
mod api {
#![allow(dead_code, unused_assignments, unused_variables, missing_docs)] // codegen issues
2016-08-01 19:55:38 +02:00
include!(concat!(env!("OUT_DIR"), "/api.rs"));
2015-12-22 22:19:50 +01:00
}
2016-12-08 19:52:48 +01:00
#[cfg(not(feature = "ipc"))]
mod api;
2016-12-16 17:38:16 +01:00
pub use api::{
EthSync, Params, SyncProvider, ManageNetwork, SyncConfig,
ServiceConfiguration, NetworkConfiguration, PeerInfo, AllowIP, TransactionStats,
LightSync, LightSyncParams, LesProtocolInfo, EthProtocolInfo,
2016-12-16 17:38:16 +01:00
};
pub use chain::{SyncStatus, SyncState};
pub use network::{is_valid_node_url, NonReservedPeerMode, NetworkError};
/// IPC interfaces
#[cfg(feature="ipc")]
pub mod remote {
pub use api::{SyncClient, NetworkManagerClient};
}