Cleaning up polluted namespaces (#3143)

* Renaming ethcore_ to parity_ * Renaming files * Renaming poluted EthSigning * Tidy up the namespaces * Renaming files to match new structure * Splitting EthSigning into separate traits * jsapi move ethcore.* -> parity.* * Move jsonrpc parity definitions * Update UI API calls for parity interfaces * Move jsapi signer interfaces from personal to signer * Update UI to use signer.* where applicable * Updsate jsapi subscriptions for signer * Fix dodgy merge. * Update README. * Fix some tests. * Move parity-only personal.* to parity.* * Update UI for personal -> parity API moves * Update subscription APIs after personal -> parity move * personal. generateAuthorizationToken -> parity. generateAuthorizationToken (UI) * enode, dappsPort & signerPort (UI) * Update subscription tests (accountsInfo) * subscription update * personal -> parity * Additional error logging on method failures * move postTransaction to parity * Additional debug info with method failures * Fix personal tests. * Console wrning shows parameters, error object does not * Include parity_ signing methods. * Console log http transport info * Fix failing tests * Add RPC stubs for parity_accounts. * Allow some secure built-in dapps * Use parity_accounts in place of accountsInfo * Improve error reporting * Cleanup GHH error handling
2016-11-06 12:51:53 +01:00
parent 78f2d88182
commit 9c4979681c
101 changed files with 1899 additions and 1466 deletions
--- a/parity/cli/config.full.toml
+++ b/parity/cli/config.full.toml
@@ -41,13 +41,13 @@ disable = false
 port = 8545
 interface = "local"
 cors = "null"
-apis = ["web3", "eth", "net", "ethcore", "traces", "rpc", "personal_safe"]
+apis = ["web3", "eth", "net", "parity", "traces", "rpc"]
 hosts = ["none"]

 [ipc]
 disable = false
 path = "$HOME/.parity/jsonrpc.ipc"
-apis = ["web3", "eth", "net", "ethcore", "traces", "rpc", "personal", "personal_safe"]
+apis = ["web3", "eth", "net", "parity", "parity_accounts", "personal", "traces", "rpc"]

 [dapps]
 disable = false
--- a/parity/cli/mod.rs
+++ b/parity/cli/mod.rs
@@ -143,7 +143,7 @@ usage! {
 			or |c: &Config| otry!(c.rpc).interface.clone(),
 		flag_jsonrpc_cors: Option<String> = None,
 			or |c: &Config| otry!(c.rpc).cors.clone().map(Some),
-		flag_jsonrpc_apis: String = "web3,eth,net,ethcore,traces,rpc,personal_safe",
+		flag_jsonrpc_apis: String = "web3,eth,net,parity,traces,rpc",
 			or |c: &Config| otry!(c.rpc).apis.clone().map(|vec| vec.join(",")),
 		flag_jsonrpc_hosts: String = "none",
 			or |c: &Config| otry!(c.rpc).hosts.clone().map(|vec| vec.join(",")),
@@ -153,7 +153,7 @@ usage! {
 			or |c: &Config| otry!(c.ipc).disable.clone(),
 		flag_ipc_path: String = "$HOME/.parity/jsonrpc.ipc",
 			or |c: &Config| otry!(c.ipc).path.clone(),
-		flag_ipc_apis: String = "web3,eth,net,ethcore,traces,rpc,personal,personal_safe",
+		flag_ipc_apis: String = "web3,eth,net,parity,parity_accounts,traces,rpc",
 			or |c: &Config| otry!(c.ipc).apis.clone().map(|vec| vec.join(",")),

 		// DAPPS
@@ -540,13 +540,13 @@ mod tests {
 			flag_jsonrpc_port: 8545u16,
 			flag_jsonrpc_interface: "local".into(),
 			flag_jsonrpc_cors: Some("null".into()),
-			flag_jsonrpc_apis: "web3,eth,net,ethcore,traces,rpc,personal_safe".into(),
+			flag_jsonrpc_apis: "web3,eth,net,parity,traces,rpc".into(),
 			flag_jsonrpc_hosts: "none".into(),

 			// IPC
 			flag_no_ipc: false,
 			flag_ipc_path: "$HOME/.parity/jsonrpc.ipc".into(),
-			flag_ipc_apis: "web3,eth,net,ethcore,traces,rpc,personal,personal_safe".into(),
+			flag_ipc_apis: "web3,eth,net,parity,parity_accounts,personal,traces,rpc".into(),

 			// DAPPS
 			flag_no_dapps: false,
--- a/parity/cli/usage.txt
+++ b/parity/cli/usage.txt
@@ -107,7 +107,7 @@ API and Console Options:
  --jsonrpc-apis APIS      Specify the APIs available through the JSONRPC
                           interface. APIS is a comma-delimited list of API
                           name. Possible name are web3, eth, net, personal,
-                           ethcore, ethcore_set, traces, rpc, personal_safe.
+                           parity, parity_set, traces, rpc, parity_accounts.
                           (default: {flag_jsonrpc_apis}).
  --jsonrpc-hosts HOSTS    List of allowed Host header values. This option will
                           validate the Host header sent by the browser, it
@@ -284,7 +284,7 @@ Legacy Options:
  --geth                   Run in Geth-compatibility mode. Sets the IPC path
                           to be the same as Geth's. Overrides the --ipc-path
                           and --ipcpath options. Alters RPCs to reflect Geth
-                           bugs.
+                           bugs. Includes the personal_ RPC by default.
  --testnet                Geth-compatible testnet mode. Equivalent to --chain
                           testnet --keys-path $HOME/parity/testnet-keys.
                           Overrides the --keys-path option.
--- a/parity/configuration.rs
+++ b/parity/configuration.rs
@@ -509,7 +509,11 @@ impl Configuration {
 	}

 	fn rpc_apis(&self) -> String {
-		self.args.flag_rpcapi.clone().unwrap_or(self.args.flag_jsonrpc_apis.clone())
+		let mut apis = self.args.flag_rpcapi.clone().unwrap_or(self.args.flag_jsonrpc_apis.clone());
+		if self.args.flag_geth {
+			apis.push_str(",personal");
+		}
+		apis
 	}

 	fn rpc_cors(&self) -> Option<Vec<String>> {
@@ -541,7 +545,13 @@ impl Configuration {
 		let conf = IpcConfiguration {
 			enabled: !(self.args.flag_ipcdisable || self.args.flag_ipc_off || self.args.flag_no_ipc),
 			socket_addr: self.ipc_path(),
-			apis: try!(self.args.flag_ipcapi.clone().unwrap_or(self.args.flag_ipc_apis.clone()).parse()),
+			apis: {
+				let mut apis = self.args.flag_ipcapi.clone().unwrap_or(self.args.flag_ipc_apis.clone());
+				if self.args.flag_geth {
+					apis.push_str("personal");
+				}
+				try!(apis.parse())
+			},
 		};

 		Ok(conf)
--- a/parity/rpc_apis.rs
+++ b/parity/rpc_apis.rs
@@ -31,15 +31,25 @@ pub use ethcore_rpc::SignerService;

 #[derive(Debug, PartialEq, Clone, Eq, Hash)]
 pub enum Api {
+	/// Web3 (Safe)
 	Web3,
+	/// Net (Safe)
 	Net,
+	/// Eth (Safe)
 	Eth,
-	PersonalSafe,
-	PersonalAccounts,
+	/// Geth-compatible "personal" API (DEPRECATED; only used in `--geth` mode.) 
+	Personal,
+	/// Signer - Confirm transactions in Signer (UNSAFE: Passwords, List of transactions)
 	Signer,
-	Ethcore,
-	EthcoreSet,
+	/// Parity - Custom extensions (Safe)
+	Parity,
+	/// Parity Accounts extensions (UNSAFE: Passwords, Side Effects (new account))
+	ParityAccounts,
+	/// Parity - Set methods (UNSAFE: Side Effects affecting node operation)
+	ParitySet,
+	/// Traces (Safe)
 	Traces,
+	/// Rpc (Safe)
 	Rpc,
 }

@@ -53,11 +63,11 @@ impl FromStr for Api {
 			"web3" => Ok(Web3),
 			"net" => Ok(Net),
 			"eth" => Ok(Eth),
-			"personal" => Ok(PersonalAccounts),
-			"personal_safe" => Ok(PersonalSafe),
+			"personal" => Ok(Personal),
 			"signer" => Ok(Signer),
-			"ethcore" => Ok(Ethcore),
-			"ethcore_set" => Ok(EthcoreSet),
+			"parity" => Ok(Parity),
+			"parity_accounts" => Ok(ParityAccounts),
+			"parity_set" => Ok(ParitySet),
 			"traces" => Ok(Traces),
 			"rpc" => Ok(Rpc),
 			api => Err(format!("Unknown api: {}", api))
@@ -119,11 +129,11 @@ fn to_modules(apis: &[Api]) -> BTreeMap<String, String> {
 			Api::Web3 => ("web3", "1.0"),
 			Api::Net => ("net", "1.0"),
 			Api::Eth => ("eth", "1.0"),
-			Api::PersonalSafe => ("personal_safe", "1.0"),
-			Api::PersonalAccounts => ("personal", "1.0"),
+			Api::Personal => ("personal", "1.0"),
 			Api::Signer => ("signer", "1.0"),
-			Api::Ethcore => ("ethcore", "1.0"),
-			Api::EthcoreSet => ("ethcore_set", "1.0"),
+			Api::Parity => ("parity", "1.0"),
+			Api::ParityAccounts => ("parity_accounts", "1.0"),
+			Api::ParitySet => ("parity_set", "1.0"),
 			Api::Traces => ("traces", "1.0"),
 			Api::Rpc => ("rpc", "1.0"),
 		};
@@ -134,24 +144,37 @@ fn to_modules(apis: &[Api]) -> BTreeMap<String, String> {

 impl ApiSet {
 	pub fn list_apis(&self) -> HashSet<Api> {
+		let mut safe_list = vec![Api::Web3, Api::Net, Api::Eth, Api::Parity, Api::Traces, Api::Rpc]
+			.into_iter().collect();
 		match *self {
 			ApiSet::List(ref apis) => apis.clone(),
-			ApiSet::UnsafeContext => {
-				vec![Api::Web3, Api::Net, Api::Eth, Api::Ethcore, Api::Traces, Api::Rpc, Api::PersonalSafe]
-					.into_iter().collect()
-			},
+			ApiSet::UnsafeContext => safe_list,
 			ApiSet::IpcContext => {
-				vec![Api::Web3, Api::Net, Api::Eth, Api::Ethcore, Api::Traces, Api::Rpc, Api::PersonalAccounts, Api::PersonalSafe]
-					.into_iter().collect()
+				safe_list.insert(Api::ParityAccounts);
+				safe_list
 			},
 			ApiSet::SafeContext => {
-				vec![Api::Web3, Api::Net, Api::Eth, Api::PersonalAccounts, Api::PersonalSafe, Api::Signer, Api::Ethcore, Api::EthcoreSet, Api::Traces, Api::Rpc]
-					.into_iter().collect()
+				safe_list.insert(Api::ParityAccounts);
+				safe_list.insert(Api::ParitySet);
+				safe_list.insert(Api::Signer);
+				safe_list
 			},
 		}
 	}
 }

+macro_rules! add_signing_methods {
+	($namespace:ident, $server:expr, $deps:expr) => {
+		let server = &$server;
+		let deps = &$deps;
+		if deps.signer_service.is_enabled() {
+			server.add_delegate($namespace::to_delegate(SigningQueueClient::new(&deps.signer_service, &deps.client, &deps.miner, &deps.secret_store)))
+		} else {
+			server.add_delegate($namespace::to_delegate(SigningUnsafeClient::new(&deps.client, &deps.secret_store, &deps.miner)))
+		}
+	}
+}
+
 pub fn setup_rpc<T: Extendable>(server: T, deps: Arc<Dependencies>, apis: ApiSet) -> T {
 	use ethcore_rpc::v1::*;

@@ -183,39 +206,39 @@ pub fn setup_rpc<T: Extendable>(server: T, deps: Arc<Dependencies>, apis: ApiSet
 				let filter_client = EthFilterClient::new(&deps.client, &deps.miner);
 				server.add_delegate(filter_client.to_delegate());

-				if deps.signer_service.is_enabled() {
-					server.add_delegate(EthSigningQueueClient::new(&deps.signer_service, &deps.client, &deps.miner, &deps.secret_store).to_delegate());
-				} else {
-					server.add_delegate(EthSigningUnsafeClient::new(&deps.client, &deps.secret_store, &deps.miner).to_delegate());
-				}
+				add_signing_methods!(EthSigning, server, deps);
 			},
-			Api::PersonalAccounts => {
-				server.add_delegate(PersonalAccountsClient::new(&deps.secret_store, &deps.client, &deps.miner, deps.geth_compatibility).to_delegate());
-			},
-			Api::PersonalSafe => {
-				server.add_delegate(PersonalClient::new(&deps.secret_store, &deps.client).to_delegate());
+			Api::Personal => {
+				server.add_delegate(PersonalClient::new(&deps.secret_store, &deps.client, &deps.miner, deps.geth_compatibility).to_delegate());
 			},
 			Api::Signer => {
 				server.add_delegate(SignerClient::new(&deps.secret_store, &deps.client, &deps.miner, &deps.signer_service).to_delegate());
 			},
-			Api::Ethcore => {
+			Api::Parity => {
 				let signer = match deps.signer_service.is_enabled() {
 					true => Some(deps.signer_service.clone()),
 					false => None,
 				};
-				server.add_delegate(EthcoreClient::new(
+				server.add_delegate(ParityClient::new(
 					&deps.client,
 					&deps.miner,
 					&deps.sync,
 					&deps.net_service,
+					&deps.secret_store,
 					deps.logger.clone(),
 					deps.settings.clone(),
 					signer,
 					deps.dapps_port,
-				).to_delegate())
+				).to_delegate());
+
+				add_signing_methods!(EthSigning, server, deps);
+				add_signing_methods!(ParitySigning, server, deps);
 			},
-			Api::EthcoreSet => {
-				server.add_delegate(EthcoreSetClient::new(&deps.client, &deps.miner, &deps.net_service).to_delegate())
+			Api::ParityAccounts => {
+				server.add_delegate(ParityAccountsClient::new(&deps.secret_store, &deps.client).to_delegate());
+			},
+			Api::ParitySet => {
+				server.add_delegate(ParitySetClient::new(&deps.client, &deps.miner, &deps.net_service).to_delegate())
 			},
 			Api::Traces => {
 				server.add_delegate(TracesClient::new(&deps.client, &deps.miner).to_delegate())
@@ -238,11 +261,11 @@ mod test {
 		assert_eq!(Api::Web3, "web3".parse().unwrap());
 		assert_eq!(Api::Net, "net".parse().unwrap());
 		assert_eq!(Api::Eth, "eth".parse().unwrap());
-		assert_eq!(Api::PersonalAccounts, "personal".parse().unwrap());
-		assert_eq!(Api::PersonalSafe, "personal_safe".parse().unwrap());
+		assert_eq!(Api::Personal, "personal".parse().unwrap());
 		assert_eq!(Api::Signer, "signer".parse().unwrap());
-		assert_eq!(Api::Ethcore, "ethcore".parse().unwrap());
-		assert_eq!(Api::EthcoreSet, "ethcore_set".parse().unwrap());
+		assert_eq!(Api::Parity, "parity".parse().unwrap());
+		assert_eq!(Api::ParityAccounts, "parity_accounts".parse().unwrap());
+		assert_eq!(Api::ParitySet, "parity_set".parse().unwrap());
 		assert_eq!(Api::Traces, "traces".parse().unwrap());
 		assert_eq!(Api::Rpc, "rpc".parse().unwrap());
 		assert!("rp".parse::<Api>().is_err());
@@ -260,15 +283,34 @@ mod test {

 	#[test]
 	fn test_api_set_unsafe_context() {
-		let expected = vec![Api::Web3, Api::Net, Api::Eth, Api::Ethcore, Api::Traces, Api::Rpc, Api::PersonalSafe]
-			.into_iter().collect();
+		let expected = vec![
+			// make sure this list contains only SAFE methods
+			Api::Web3, Api::Net, Api::Eth, Api::Parity, Api::Traces, Api::Rpc
+		].into_iter().collect();
 		assert_eq!(ApiSet::UnsafeContext.list_apis(), expected);
 	}

+	#[test]
+	fn test_api_set_ipc_context() {
+		let expected = vec![
+			// safe
+			Api::Web3, Api::Net, Api::Eth, Api::Parity, Api::Traces, Api::Rpc,
+			// semi-safe
+			Api::ParityAccounts
+		].into_iter().collect();
+		assert_eq!(ApiSet::IpcContext.list_apis(), expected);
+	}
+
 	#[test]
 	fn test_api_set_safe_context() {
-		let expected = vec![Api::Web3, Api::Net, Api::Eth, Api::PersonalAccounts, Api::PersonalSafe, Api::Signer, Api::Ethcore, Api::EthcoreSet, Api::Traces, Api::Rpc]
-			.into_iter().collect();
+		let expected = vec![
+			// safe
+			Api::Web3, Api::Net, Api::Eth, Api::Parity, Api::Traces, Api::Rpc,
+			// semi-safe
+			Api::ParityAccounts,
+			// Unsafe
+			Api::ParitySet, Api::Signer,
+		].into_iter().collect();
 		assert_eq!(ApiSet::SafeContext.list_apis(), expected);
 	}
 }