      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

    // 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::fmt;
    use std::sync::Arc;
    use std::net::SocketAddr;
    use std::io;
    use io::PanicHandler;

    use dir::default_data_path;
    use ethcore_rpc::{self as rpc, RpcServerError, IpcServerError, Metadata};
    use helpers::parity_ipc_path;
    use jsonrpc_core::MetaIoHandler;
    use jsonrpc_core::reactor::{RpcHandler, Remote};
    use rpc_apis;
    use rpc_apis::ApiSet;

    pub use ethcore_rpc::{IpcServer, Server as HttpServer};

    #[derive(Debug, PartialEq)]
    pub struct HttpConfiguration {
    	pub enabled: bool,
    	pub interface: String,
    	pub port: u16,
    	pub apis: ApiSet,
    	pub cors: Option<Vec<String>>,
    	pub hosts: Option<Vec<String>>,
    }

    impl Default for HttpConfiguration {
    	fn default() -> Self {
    		HttpConfiguration {
    			enabled: true,
    			interface: "127.0.0.1".into(),
    			port: 8545,
    			apis: ApiSet::UnsafeContext,
    			cors: None,
    			hosts: Some(Vec::new()),
    		}
    	}
    }

    #[derive(Debug, PartialEq)]
    pub struct IpcConfiguration {
    	pub enabled: bool,
    	pub socket_addr: String,
    	pub apis: ApiSet,
    }

    impl Default for IpcConfiguration {
    	fn default() -> Self {
    		let data_dir = default_data_path();
    		IpcConfiguration {
    			enabled: true,
    			socket_addr: parity_ipc_path(&data_dir, "$BASE/jsonrpc.ipc"),
    			apis: ApiSet::IpcContext,
    		}
    	}
    }

    impl fmt::Display for IpcConfiguration {
    	fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
    		if self.enabled {
    			write!(f, "endpoint address [{}], api list [{:?}]", self.socket_addr, self.apis)
    		} else {
    			write!(f, "disabled")
    		}
    	}
    }

    pub struct Dependencies {
    	pub panic_handler: Arc<PanicHandler>,
    	pub apis: Arc<rpc_apis::Dependencies>,
    	pub remote: Remote,
    }

    pub fn new_http(conf: HttpConfiguration, deps: &Dependencies) -> Result<Option<HttpServer>, String> {
    	if !conf.enabled {
    		return Ok(None);
    	}

    	let url = format!("{}:{}", conf.interface, conf.port);
    	let addr = url.parse().map_err(|_| format!("Invalid JSONRPC listen host/port given: {}", url))?;
    	Ok(Some(setup_http_rpc_server(deps, &addr, conf.cors, conf.hosts, conf.apis)?))
    }

    fn setup_apis(apis: ApiSet, deps: &Dependencies) -> MetaIoHandler<Metadata> {
    	rpc_apis::setup_rpc(MetaIoHandler::default(), deps.apis.clone(), apis)
    }

    pub fn setup_http_rpc_server(
    	dependencies: &Dependencies,
    	url: &SocketAddr,
    	cors_domains: Option<Vec<String>>,
    	allowed_hosts: Option<Vec<String>>,
    	apis: ApiSet
    ) -> Result<HttpServer, String> {
    	let apis = setup_apis(apis, dependencies);
    	let handler = RpcHandler::new(Arc::new(apis), dependencies.remote.clone());
    	let ph = dependencies.panic_handler.clone();
    	let start_result = rpc::start_http(url, cors_domains, allowed_hosts, ph, handler);
    	match start_result {
    		Err(RpcServerError::IoError(err)) => match err.kind() {
    			io::ErrorKind::AddrInUse => Err(format!("RPC address {} is already in use, make sure that another instance of an Ethereum client is not running or change the address using the --jsonrpc-port and --jsonrpc-interface options.", url)),
    			_ => Err(format!("RPC io error: {}", err)),
    		},
    		Err(e) => Err(format!("RPC error: {:?}", e)),
    		Ok(server) => Ok(server),
    	}
    }

    pub fn new_ipc(conf: IpcConfiguration, deps: &Dependencies) -> Result<Option<IpcServer<Metadata>>, String> {
    	if !conf.enabled { return Ok(None); }
    	Ok(Some(setup_ipc_rpc_server(deps, &conf.socket_addr, conf.apis)?))
    }

    pub fn setup_ipc_rpc_server(dependencies: &Dependencies, addr: &str, apis: ApiSet) -> Result<IpcServer<Metadata>, String> {
    	let apis = setup_apis(apis, dependencies);
    	let handler = RpcHandler::new(Arc::new(apis), dependencies.remote.clone());
    	match rpc::start_ipc(addr, handler) {
    		Err(IpcServerError::Io(io_error)) => Err(format!("RPC io error: {}", io_error)),
    		Err(any_error) => Err(format!("Rpc error: {:?}", any_error)),
    		Ok(server) => Ok(server)
    	}
    }

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