      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
    195
    196
    197
    198
    199
    200
    201
    202
    203
    204
    205
    206
    207
    208
    209
    210
    211
    212
    213
    214
    215
    216
    217
    218
    219
    220
    221
    222
    223
    224
    225
    226
    227
    228
    229
    230

    use std::net;
    use clap;
    use storage;
    use message::Services;
    use network::{Network, ConsensusParams, ConsensusFork, BitcoinCashConsensusParams};
    use p2p::InternetProtocol;
    use seednodes::{mainnet_seednodes, testnet_seednodes, bitcoin_cash_seednodes, bitcoin_cash_testnet_seednodes};
    use rpc_apis::ApiSet;
    use {USER_AGENT, REGTEST_USER_AGENT};
    use primitives::hash::H256;
    use rpc::HttpConfiguration as RpcHttpConfig;
    use verification::VerificationLevel;
    use sync::VerificationParameters;
    use util::open_db;

    pub struct Config {
    	pub network: Network,
    	pub consensus: ConsensusParams,
    	pub services: Services,
    	pub port: u16,
    	pub connect: Option<net::SocketAddr>,
    	pub host: net::IpAddr,
    	pub seednodes: Vec<String>,
    	pub quiet: bool,
    	pub inbound_connections: u32,
    	pub outbound_connections: u32,
    	pub p2p_threads: usize,
    	pub db_cache: usize,
    	pub data_dir: Option<String>,
    	pub user_agent: String,
    	pub internet_protocol: InternetProtocol,
    	pub rpc_config: RpcHttpConfig,
    	pub block_notify_command: Option<String>,
    	pub verification_params: VerificationParameters,
    	pub db: storage::SharedStore,
    }

    pub const DEFAULT_DB_CACHE: usize = 512;

    pub fn parse(matches: &clap::ArgMatches) -> Result<Config, String> {
    	let db_cache = match matches.value_of("db-cache") {
    		Some(s) => s.parse().map_err(|_| "Invalid cache size - should be number in MB".to_owned())?,
    		None => DEFAULT_DB_CACHE,
    	};

    	let data_dir = match matches.value_of("data-dir") {
    		Some(s) => Some(s.parse().map_err(|_| "Invalid data-dir".to_owned())?),
    		None => None,
    	};

    	let db = open_db(&data_dir, db_cache);

    	let quiet = matches.is_present("quiet");
    	let network = match (matches.is_present("testnet"), matches.is_present("regtest")) {
    		(true, false) => Network::Testnet,
    		(false, true) => Network::Regtest,
    		(false, false) => Network::Mainnet,
    		(true, true) => return Err("Only one testnet option can be used".into()),
    	};

    	let consensus_fork = parse_consensus_fork(network, &db, &matches)?;
    	let consensus = ConsensusParams::new(network, consensus_fork);

    	let (in_connections, out_connections) = match network {
    		Network::Testnet | Network::Mainnet | Network::Other(_) => (10, 10),
    		Network::Regtest | Network::Unitest => (1, 0),
    	};

    	let p2p_threads = match network {
    		Network::Testnet | Network::Mainnet | Network::Other(_) => 4,
    		Network::Regtest | Network::Unitest => 1,
    	};

    	// to skip idiotic 30 seconds delay in test-scripts
    	let user_agent_suffix = match consensus.fork {
    		ConsensusFork::BitcoinCore => "",
    		ConsensusFork::BitcoinCash(_) => "/UAHF",
    	};
    	let user_agent = match network {
    		Network::Testnet | Network::Mainnet | Network::Unitest | Network::Other(_) => format!("{}{}", USER_AGENT, user_agent_suffix),
    		Network::Regtest => REGTEST_USER_AGENT.into(),
    	};

    	let port = match matches.value_of("port") {
    		Some(port) => port.parse().map_err(|_| "Invalid port".to_owned())?,
    		None => network.port(),
    	};

    	let connect = match matches.value_of("connect") {
    		Some(s) => Some(match s.parse::<net::SocketAddr>() {
    			Err(_) => s.parse::<net::IpAddr>()
    				.map(|ip| net::SocketAddr::new(ip, network.port()))
    				.map_err(|_| "Invalid connect".to_owned()),
    			Ok(a) => Ok(a),
    		}?),
    		None => None,
    	};

    	let seednodes: Vec<String> = match matches.value_of("seednode") {
    		Some(s) => vec![s.parse().map_err(|_| "Invalid seednode".to_owned())?],
    		None => match (network, &consensus.fork) {
    			(Network::Mainnet, &ConsensusFork::BitcoinCash(_)) => bitcoin_cash_seednodes().into_iter().map(Into::into).collect(),
    			(Network::Testnet, &ConsensusFork::BitcoinCash(_)) => bitcoin_cash_testnet_seednodes().into_iter().map(Into::into).collect(),
    			(Network::Mainnet, _) => mainnet_seednodes().into_iter().map(Into::into).collect(),
    			(Network::Testnet, _) => testnet_seednodes().into_iter().map(Into::into).collect(),
    			(Network::Other(_), _) | (Network::Regtest, _) | (Network::Unitest, _) => Vec::new(),
    		},
    	};

    	let only_net = match matches.value_of("only-net") {
    		Some(s) => s.parse()?,
    		None => InternetProtocol::default(),
    	};

    	let host =  match matches.value_of("host") {
    		Some(s) => s.parse::<net::IpAddr>().map_err(|_| "Invalid host".to_owned())?,
    		None => match only_net {
    			InternetProtocol::IpV6 => "::".parse().unwrap(),
    			_ => "0.0.0.0".parse().unwrap(),
    		}
    	};

    	let rpc_config = parse_rpc_config(network, matches)?;

    	let block_notify_command = match matches.value_of("blocknotify") {
    		Some(s) => Some(s.parse().map_err(|_| "Invalid blocknotify commmand".to_owned())?),
    		None => None,
    	};

    	let services = Services::default().with_network(true);
    	let services = match &consensus.fork {
    		&ConsensusFork::BitcoinCash(_) => services.with_bitcoin_cash(true),
    		&ConsensusFork::BitcoinCore => services.with_witness(true),
    	};

    	let verification_level = match matches.value_of("verification-level") {
    		Some(s) if s == "full" => VerificationLevel::Full,
    		Some(s) if s == "header" => VerificationLevel::Header,
    		Some(s) if s == "none" => VerificationLevel::NoVerification,
    		Some(s) => return Err(format!("Invalid verification level: {}", s)),
    		None => VerificationLevel::Full,
    	};

    	let verification_edge = match matches.value_of("verification-edge") {
    		Some(s) if verification_level != VerificationLevel::Full => {
    			let edge: H256 = s.parse().map_err(|_| "Invalid verification edge".to_owned())?;
    			edge.reversed()
    		},
    		_ => network.default_verification_edge(),
    	};

    	let config = Config {
    		quiet: quiet,
    		network: network,
    		consensus: consensus,
    		services: services,
    		port: port,
    		connect: connect,
    		host: host,
    		seednodes: seednodes,
    		inbound_connections: in_connections,
    		outbound_connections: out_connections,
    		p2p_threads: p2p_threads,
    		db_cache: db_cache,
    		data_dir: data_dir,
    		user_agent: user_agent,
    		internet_protocol: only_net,
    		rpc_config: rpc_config,
    		block_notify_command: block_notify_command,
    		verification_params: VerificationParameters {
    			verification_level: verification_level,
    			verification_edge: verification_edge,
    		},
    		db: db,
    	};

    	Ok(config)
    }

    fn parse_consensus_fork(network: Network, db: &storage::SharedStore, matches: &clap::ArgMatches) -> Result<ConsensusFork, String> {
    	let old_consensus_fork = db.consensus_fork()?;
    	let new_consensus_fork = match (matches.is_present("btc"), matches.is_present("bch")) {
    		(false, false) => match &old_consensus_fork {
    			&Some(ref old_consensus_fork) => old_consensus_fork,
    			&None => return Err("You must select fork on first run: --btc, --bch".into()),
    		},
    		(true, false) => "btc",
    		(false, true) => "bch",
    		_ => return Err("You can only pass single fork argument: --btc, --bch".into()),
    	};

    	match &old_consensus_fork {
    		&None => db.set_consensus_fork(new_consensus_fork)?,
    		&Some(ref old_consensus_fork) if old_consensus_fork == new_consensus_fork => (),
    		&Some(ref old_consensus_fork) =>
    			return Err(format!("Cannot select '{}' fork with non-empty database of '{}' fork", new_consensus_fork, old_consensus_fork)),
    	}

    	return match new_consensus_fork {
    		"btc" => Ok(ConsensusFork::BitcoinCore),
    		"bch" => Ok(ConsensusFork::BitcoinCash(BitcoinCashConsensusParams::new(network))),
    		_ => Err(String::from("Fork mandatory")),
    	};
    }

    fn parse_rpc_config(network: Network, matches: &clap::ArgMatches) -> Result<RpcHttpConfig, String> {
    	let mut config = RpcHttpConfig::with_port(network.rpc_port());
    	config.enabled = !matches.is_present("no-jsonrpc");
    	if !config.enabled {
    		return Ok(config);
    	}

    	if let Some(apis) = matches.value_of("jsonrpc-apis") {
    		config.apis = ApiSet::List(vec![apis.parse().map_err(|_| "Invalid APIs".to_owned())?].into_iter().collect());
    	}
    	if let Some(port) = matches.value_of("jsonrpc-port") {
    		config.port = port.parse().map_err(|_| "Invalid JSON RPC port".to_owned())?;
    	}
    	if let Some(interface) = matches.value_of("jsonrpc-interface") {
    		config.interface = interface.to_owned();
    	}
    	if let Some(cors) = matches.value_of("jsonrpc-cors") {
    		config.cors = Some(vec![cors.parse().map_err(|_| "Invalid JSON RPC CORS".to_owned())?]);
    	}
    	if let Some(hosts) = matches.value_of("jsonrpc-hosts") {
    		config.hosts = Some(vec![hosts.parse().map_err(|_| "Invalid JSON RPC hosts".to_owned())?]);
    	}

    	Ok(config)
    }

# Help

## Keyboard Shortcuts

`?`
  Show this help dialog
`S`
  Focus the search field
`↑`
  Move up in search results
`↓`
  Move down in search results
`↹`
  Switch tab
`⏎`
  Go to active search result
`+`
  Expand all sections
`-`
  Collapse 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`)

Search multiple things at once by splitting your query with comma (e.g. `str,u8` or `String,struct:Vec,test`)