      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
     88
     89
     90
     91
     92
     93
     94
     95
     96
     97
     98
     99
    100
    101
    102
    103
    104
    105
    106
    107
    108
    109
    110
    111
    112
    113
    114
    115
    116
    117
    118
    119
    120
    121
    122
    123
    124
    125
    126
    127
    128
    129
    130
    131
    132
    133
    134
    135
    136
    137
    138
    139
    140
    141
    142
    143
    144
    145
    146
    147
    148
    149
    150
    151
    152
    153
    154
    155
    156
    157
    158
    159
    160
    161
    162
    163
    164
    165
    166
    167
    168
    169
    170
    171
    172
    173
    174
    175
    176
    177
    178
    179
    180
    181
    182
    183
    184
    185
    186
    187
    188
    189
    190
    191
    192
    193
    194

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

    use std::sync::Arc;
    use std::path::Path;

    use ethcore::client::BlockChainClient;
    use hypervisor::Hypervisor;
    use ethsync::{SyncConfig, NetworkConfiguration, NetworkError, Params};
    use ethcore::snapshot::SnapshotService;
    use light::Provider;

    #[cfg(not(feature="ipc"))]
    use self::no_ipc_deps::*;

    #[cfg(not(feature="ipc"))]
    use ethcore_logger::Config as LogConfig;

    #[cfg(feature="ipc")]
    use self::ipc_deps::*;

    #[cfg(feature="ipc")]
    pub mod service_urls {
    	use std::path::PathBuf;

    	pub const CLIENT: &'static str = "parity-chain.ipc";
    	pub const SNAPSHOT: &'static str = "parity-snapshot.ipc";
    	pub const SYNC: &'static str = "parity-sync.ipc";
    	pub const SYNC_NOTIFY: &'static str = "parity-sync-notify.ipc";
    	pub const NETWORK_MANAGER: &'static str = "parity-manage-net.ipc";
    	pub const SYNC_CONTROL: &'static str = "parity-sync-control.ipc";
    	pub const LIGHT_PROVIDER: &'static str = "parity-light-provider.ipc";

    	#[cfg(feature="stratum")]
    	pub const STRATUM_CONTROL: &'static str = "parity-stratum-control.ipc";

    	pub fn with_base(data_dir: &str, service_path: &str) -> String {
    		let mut path = PathBuf::from(data_dir);
    		path.push(service_path);

    		format!("ipc://{}", path.to_str().unwrap())
    	}
    }

    #[cfg(not(feature="ipc"))]
    mod no_ipc_deps {
    	pub use ethsync::{EthSync, SyncProvider, ManageNetwork};
    	pub use ethcore::client::ChainNotify;
    }

    #[cfg(feature="ipc")]
    pub type SyncModules = (
    	GuardedSocket<SyncClient<NanoSocket>>,
    	GuardedSocket<NetworkManagerClient<NanoSocket>>,
    	GuardedSocket<ChainNotifyClient<NanoSocket>>
    );

    #[cfg(not(feature="ipc"))]
    pub type SyncModules = (Arc<SyncProvider>, Arc<ManageNetwork>, Arc<ChainNotify>);

    #[cfg(feature="ipc")]
    mod ipc_deps {
    	pub use ethsync::remote::{SyncClient, NetworkManagerClient};
    	pub use ethsync::ServiceConfiguration;
    	pub use ethcore::client::remote::ChainNotifyClient;
    	pub use hypervisor::{SYNC_MODULE_ID, BootArgs, HYPERVISOR_IPC_URL};
    	pub use nanoipc::{GuardedSocket, NanoSocket, generic_client, fast_client};
    	pub use ipc::IpcSocket;
    	pub use ipc::binary::serialize;
    	pub use light::remote::LightProviderClient;
    }

    #[cfg(feature="ipc")]
    pub fn hypervisor(base_path: &Path) -> Option<Hypervisor> {
    	Some(Hypervisor
    		::with_url(&service_urls::with_base(base_path.to_str().unwrap(), HYPERVISOR_IPC_URL))
    		.io_path(base_path.to_str().unwrap()))
    }

    #[cfg(not(feature="ipc"))]
    pub fn hypervisor(_: &Path) -> Option<Hypervisor> {
    	None
    }

    #[cfg(feature="ipc")]
    fn sync_arguments(io_path: &str, sync_cfg: SyncConfig, net_cfg: NetworkConfiguration, log_settings: &LogConfig) -> BootArgs {
    	let service_config = ServiceConfiguration {
    		sync: sync_cfg,
    		net: net_cfg,
    		io_path: io_path.to_owned(),
    	};

    	// initialisation payload is passed via stdin
    	let service_payload = serialize(&service_config).expect("Any binary-derived struct is serializable by definition");

    	// client service url and logging settings are passed in command line
    	let mut cli_args = Vec::new();
    	cli_args.push("sync".to_owned());
    	if !log_settings.color { cli_args.push("--no-color".to_owned()); }
    	if let Some(ref mode) = log_settings.mode {
    		cli_args.push("-l".to_owned());
    		cli_args.push(mode.to_owned());
    	}
    	if let Some(ref file) = log_settings.file {
    		cli_args.push("--log-file".to_owned());
    		cli_args.push(file.to_owned());
    	}

    	BootArgs::new().stdin(service_payload).cli(cli_args)
    }

    #[cfg(feature="ipc")]
    pub fn stratum(
    	hypervisor_ref: &mut Option<Hypervisor>,
    	config: &::ethcore::miner::StratumOptions
    ) {
    	use ethcore_stratum;

    	let mut hypervisor = hypervisor_ref.take().expect("There should be hypervisor for ipc configuration");
    	let args = BootArgs::new().stdin(
    			serialize(&ethcore_stratum::ServiceConfiguration {
    				io_path: hypervisor.io_path.to_owned(),
    				port: config.port,
    				listen_addr: config.listen_addr.to_owned(),
    				secret: config.secret,
    			}).expect("Any binary-derived struct is serializable by definition")
    		).cli(vec!["stratum".to_owned()]);
    	hypervisor = hypervisor.module(super::stratum::MODULE_ID, args);
    	*hypervisor_ref = Some(hypervisor);
    }

    #[cfg(feature="ipc")]
    pub fn sync(
    	hypervisor_ref: &mut Option<Hypervisor>,
    	sync_cfg: SyncConfig,
    	net_cfg: NetworkConfiguration,
    	_client: Arc<BlockChainClient>,
    	_snapshot_service: Arc<SnapshotService>,
    	_provider: Arc<Provider>,
    	log_settings: &LogConfig,
    ) -> Result<SyncModules, NetworkError> {
    	let mut hypervisor = hypervisor_ref.take().expect("There should be hypervisor for ipc configuration");
    	let args = sync_arguments(&hypervisor.io_path, sync_cfg, net_cfg, log_settings);
    	hypervisor = hypervisor.module(SYNC_MODULE_ID, args);

    	hypervisor.start();
    	hypervisor.wait_for_startup();

    	let sync_client = generic_client::<SyncClient<_>>(
    		&service_urls::with_base(&hypervisor.io_path, service_urls::SYNC)).unwrap();
    	let notify_client = generic_client::<ChainNotifyClient<_>>(
    		&service_urls::with_base(&hypervisor.io_path, service_urls::SYNC_NOTIFY)).unwrap();
    	let manage_client = generic_client::<NetworkManagerClient<_>>(
    		&service_urls::with_base(&hypervisor.io_path, service_urls::NETWORK_MANAGER)).unwrap();
    	let provider_client = generic_client::<LightProviderClient<_>>(
    		&service_urls::with_base(&hypervisor.io_path, service_urls::LIGHT_PROVIDER)).unwrap();

    	*hypervisor_ref = Some(hypervisor);
    	Ok((sync_client, manage_client, notify_client))
    }

    #[cfg(not(feature="ipc"))]
    pub fn sync(
    	_hypervisor: &mut Option<Hypervisor>,
    	sync_cfg: SyncConfig,
    	net_cfg: NetworkConfiguration,
    	client: Arc<BlockChainClient>,
    	snapshot_service: Arc<SnapshotService>,
    	provider: Arc<Provider>,
    	_log_settings: &LogConfig,
    ) -> Result<SyncModules, NetworkError> {
    	let eth_sync = EthSync::new(Params {
    		config: sync_cfg,
    		chain: client,
    		provider: provider,
    		snapshot_service: snapshot_service,
    		network_config: net_cfg,
    	})?;

    	Ok((eth_sync.clone() as Arc<SyncProvider>, eth_sync.clone() as Arc<ManageNetwork>, eth_sync.clone() as Arc<ChainNotify>))
    }

# 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`)