     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
    65
    66
    67
    68
    69
    70
    71
    72
    73
    74
    75
    76
    77
    78
    79
    80
    81
    82
    83
    84
    85
    86
    87

    // 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/>.

    #![warn(missing_docs)]
    #![cfg_attr(feature="dev", feature(plugin))]
    #![cfg_attr(feature="dev", plugin(clippy))]
    // Keeps consistency (all lines with `.clone()`) and helpful when changing ref to non-ref.
    #![cfg_attr(feature="dev", allow(clone_on_copy))]
    // In most cases it expresses function flow better
    #![cfg_attr(feature="dev", allow(if_not_else))]

    //! 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;
    extern crate ethcore;
    extern crate env_logger;
    extern crate time;
    extern crate rand;
    extern crate semver;
    extern crate parking_lot;
    extern crate rlp;

    extern crate ethcore_light as light;

    #[cfg(test)] extern crate ethcore_devtools as devtools;
    #[cfg(test)] extern crate ethkey;

    #[macro_use]
    extern crate log;
    #[macro_use]
    extern crate ethcore_util as util;
    #[macro_use]
    extern crate heapsize;
    #[macro_use]
    extern crate ethcore_ipc as ipc;

    mod chain;
    mod blocks;
    mod block_sync;
    mod sync_io;
    mod snapshot;
    mod transactions_stats;

    pub mod light_sync;

    #[cfg(test)]
    mod tests;

    #[cfg(feature = "ipc")]
    mod api {
    	#![allow(dead_code, unused_assignments, unused_variables, missing_docs)] // codegen issues
    	include!(concat!(env!("OUT_DIR"), "/api.rs"));
    }

    #[cfg(not(feature = "ipc"))]
    mod api;

    pub use api::{
    	EthSync, Params, SyncProvider, ManageNetwork, SyncConfig,
    	ServiceConfiguration, NetworkConfiguration, PeerInfo, AllowIP, TransactionStats,
    	LightSync, LightSyncParams, LesProtocolInfo, EthProtocolInfo,
    };
    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};
    }

# Help

## Keyboard Shortcuts

?
  Show this help dialog
S
  Focus the search field
⇤
  Move up in search results
⇥
  Move down in search results
⏎
  Go to active search result
+
  Collapse/expand all sections

## Search Tricks

Prefix searches with a type followed by a colon (e.g. `fn:`) to restrict the search to a given type.

Accepted types are: `fn`, `mod`, `struct`, `enum`, `trait`, `type`, `macro`, and `const`.

Search functions by type signature (e.g. `vec -> usize` or `* -> vec`)