openethereum/sync/src/lib.rs

93 lines
2.7 KiB
Rust
Raw Normal View History

2016-02-05 13:40:41 +01:00
// Copyright 2015, 2016 Ethcore (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/>.
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
//!
//! Usage example:
//!
//! ```rust
//! extern crate ethcore_util as util;
//! extern crate ethcore;
//! extern crate ethsync;
//! use std::env;
//! use std::sync::Arc;
//! use util::io::IoChannel;
2016-02-25 16:32:34 +01:00
//! use ethcore::client::{Client, ClientConfig};
//! use ethsync::{EthSync, SyncConfig, ManageNetwork, NetworkConfiguration};
2016-01-29 15:56:06 +01:00
//! use ethcore::ethereum;
2016-07-09 17:22:20 +02:00
//! use ethcore::miner::{GasPricer, Miner};
2016-01-29 15:56:06 +01:00
//!
//! fn main() {
//! let dir = env::temp_dir();
//! let miner = Miner::new(
//! Default::default(),
2016-07-09 16:59:15 +02:00
//! GasPricer::new_fixed(20_000_000_000u64.into()),
//! ethereum::new_frontier(),
//! None
//! );
2016-06-20 10:28:38 +02:00
//! let client = Client::new(
//! ClientConfig::default(),
2016-07-05 18:18:35 +02:00
//! ethereum::new_frontier(),
2016-06-20 10:28:38 +02:00
//! &dir,
2016-06-24 12:41:48 +02:00
//! miner,
//! IoChannel::disconnected()
2016-06-20 10:28:38 +02:00
//! ).unwrap();
//! let sync = EthSync::new(SyncConfig::default(), client, NetworkConfiguration::from(util::NetworkConfiguration::new())).unwrap();
//! sync.start_network();
2016-01-29 15:56:06 +01:00
//! }
//! ```
#[macro_use]
extern crate log;
#[macro_use]
extern crate ethcore_util as util;
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-02-24 22:37:28 +01:00
#[macro_use]
extern crate heapsize;
#[macro_use]
extern crate ethcore_ipc as ipc;
extern crate semver;
extern crate parking_lot;
2015-12-22 22:19:50 +01:00
mod chain;
2016-05-16 14:41:41 +02:00
mod blocks;
2016-01-09 18:40:13 +01:00
mod io;
2015-12-22 22:19:50 +01:00
2015-12-25 14:55:55 +01:00
#[cfg(test)]
mod tests;
2015-12-22 22:19:50 +01:00
mod api {
#![allow(dead_code, unused_assignments, unused_variables, missing_docs)] // codegen issues
include!(concat!(env!("OUT_DIR"), "/api.ipc.rs"));
2015-12-22 22:19:50 +01:00
}
pub use api::{EthSync, SyncProvider, ManageNetwork, SyncConfig, NetworkConfiguration};
pub use chain::{SyncStatus, SyncState};
2015-12-25 14:55:55 +01:00