Splitting RPC Apis into more fine-grained sets

rpc/src/v1/impls/ethcore.rs

@@ -15,7 +15,7 @@
 // along with Parity.  If not, see <http://www.gnu.org/licenses/>.
 
 //! Ethcore-specific rpc implementation.
-use util::{U256, Address, RotatingLogger};
+use util::RotatingLogger;
 use util::network_settings::NetworkSettings;
 use util::misc::version_data;
 use std::sync::{Arc, Weak};
@@ -48,41 +48,6 @@ impl<M> EthcoreClient<M> where M: MinerService {
 
 impl<M> Ethcore for EthcoreClient<M> where M: MinerService + 'static {
 
-	fn set_min_gas_price(&self, params: Params) -> Result<Value, Error> {
-		from_params::<(U256,)>(params).and_then(|(gas_price,)| {
-			take_weak!(self.miner).set_minimal_gas_price(gas_price);
-			to_value(&true)
-		})
-	}
-
-	fn set_gas_floor_target(&self, params: Params) -> Result<Value, Error> {
-		from_params::<(U256,)>(params).and_then(|(gas_floor_target,)| {
-			take_weak!(self.miner).set_gas_floor_target(gas_floor_target);
-			to_value(&true)
-		})
-	}
-
-	fn set_extra_data(&self, params: Params) -> Result<Value, Error> {
-		from_params::<(Bytes,)>(params).and_then(|(extra_data,)| {
-			take_weak!(self.miner).set_extra_data(extra_data.to_vec());
-			to_value(&true)
-		})
-	}
-
-	fn set_author(&self, params: Params) -> Result<Value, Error> {
-		from_params::<(Address,)>(params).and_then(|(author,)| {
-			take_weak!(self.miner).set_author(author);
-			to_value(&true)
-		})
-	}
-
-	fn set_transactions_limit(&self, params: Params) -> Result<Value, Error> {
-		from_params::<(usize,)>(params).and_then(|(limit,)| {
-			take_weak!(self.miner).set_transactions_limit(limit);
-			to_value(&true)
-		})
-	}
-
 	fn transactions_limit(&self, _: Params) -> Result<Value, Error> {
 		to_value(&take_weak!(self.miner).transactions_limit())
 	}

rpc/src/v1/impls/ethcore_set.rs

@@ -0,0 +1,78 @@
+// Copyright 2015, 2016 Ethcore (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/>.
+
+/// Ethcore-specific rpc interface for operations altering the settings.
+use util::{U256, Address};
+use std::sync::{Arc, Weak};
+use jsonrpc_core::*;
+use ethcore::miner::MinerService;
+use v1::traits::EthcoreSet;
+use v1::types::{Bytes};
+
+/// Ethcore-specific rpc interface for operations altering the settings.
+pub struct EthcoreSetClient<M> where
+	M: MinerService {
+
+	miner: Weak<M>,
+}
+
+impl<M> EthcoreSetClient<M> where M: MinerService {
+	/// Creates new `EthcoreSetClient`.
+	pub fn new(miner: &Arc<M>) -> Self {
+		EthcoreSetClient {
+			miner: Arc::downgrade(miner),
+		}
+	}
+}
+
+impl<M> EthcoreSet for EthcoreSetClient<M> where M: MinerService + 'static {
+
+	fn set_min_gas_price(&self, params: Params) -> Result<Value, Error> {
+		from_params::<(U256,)>(params).and_then(|(gas_price,)| {
+			take_weak!(self.miner).set_minimal_gas_price(gas_price);
+			to_value(&true)
+		})
+	}
+
+	fn set_gas_floor_target(&self, params: Params) -> Result<Value, Error> {
+		from_params::<(U256,)>(params).and_then(|(gas_floor_target,)| {
+			take_weak!(self.miner).set_gas_floor_target(gas_floor_target);
+			to_value(&true)
+		})
+	}
+
+	fn set_extra_data(&self, params: Params) -> Result<Value, Error> {
+		from_params::<(Bytes,)>(params).and_then(|(extra_data,)| {
+			take_weak!(self.miner).set_extra_data(extra_data.to_vec());
+			to_value(&true)
+		})
+	}
+
+	fn set_author(&self, params: Params) -> Result<Value, Error> {
+		from_params::<(Address,)>(params).and_then(|(author,)| {
+			take_weak!(self.miner).set_author(author);
+			to_value(&true)
+		})
+	}
+
+	fn set_transactions_limit(&self, params: Params) -> Result<Value, Error> {
+		from_params::<(usize,)>(params).and_then(|(limit,)| {
+			take_weak!(self.miner).set_transactions_limit(limit);
+			to_value(&true)
+		})
+	}
+
+}

rpc/src/v1/impls/mod.rs

@@ -37,6 +37,7 @@ mod net;
 mod personal;
 mod personal_signer;
 mod ethcore;
+mod ethcore_set;
 mod traces;
 mod rpc;
 
@@ -48,6 +49,7 @@ pub use self::net::NetClient;
 pub use self::personal::PersonalClient;
 pub use self::personal_signer::SignerClient;
 pub use self::ethcore::EthcoreClient;
+pub use self::ethcore_set::EthcoreSetClient;
 pub use self::traces::TracesClient;
 pub use self::rpc::RpcClient;
 

rpc/src/v1/mod.rs

@@ -25,6 +25,6 @@ pub mod traits;
 pub mod tests;
 pub mod types;
 
-pub use self::traits::{Web3, Eth, EthFilter, EthSigning, Personal, PersonalSigner, Net, Ethcore, Traces, Rpc};
+pub use self::traits::{Web3, Eth, EthFilter, EthSigning, Personal, PersonalSigner, Net, Ethcore, EthcoreSet, Traces, Rpc};
 pub use self::impls::*;
 pub use self::helpers::{SigningQueue, ConfirmationsQueue};

rpc/src/v1/tests/mocked/ethcore.rs

@@ -17,7 +17,7 @@
 use std::sync::Arc;
 use std::str::FromStr;
 use jsonrpc_core::IoHandler;
-use v1::{Ethcore, EthcoreClient};
+use v1::{Ethcore, EthcoreClient, EthcoreSet, EthcoreSetClient};
 use ethcore::miner::MinerService;
 use v1::tests::helpers::TestMinerService;
 use util::numbers::*;
@@ -49,12 +49,16 @@ fn ethcore_client(miner: &Arc<TestMinerService>) -> EthcoreClient<TestMinerServi
 	EthcoreClient::new(&miner, logger(), settings())
 }
 
+fn ethcore_set_client(miner: &Arc<TestMinerService>) -> EthcoreSetClient<TestMinerService> {
+	EthcoreSetClient::new(&miner)
+}
+
 #[test]
 fn rpc_ethcore_extra_data() {
 	let miner = miner_service();
-	let ethcore = ethcore_client(&miner).to_delegate();
 	let io = IoHandler::new();
-	io.add_delegate(ethcore);
+	io.add_delegate(ethcore_client(&miner).to_delegate());
+	io.add_delegate(ethcore_set_client(&miner).to_delegate());
 
 	let request = r#"{"jsonrpc": "2.0", "method": "ethcore_extraData", "params": [], "id": 1}"#;
 	let response = r#"{"jsonrpc":"2.0","result":"0x01020304","id":1}"#;
@@ -68,9 +72,9 @@ fn rpc_ethcore_default_extra_data() {
 	use util::ToPretty;
 
 	let miner = miner_service();
-	let ethcore = ethcore_client(&miner).to_delegate();
 	let io = IoHandler::new();
-	io.add_delegate(ethcore);
+	io.add_delegate(ethcore_client(&miner).to_delegate());
+	io.add_delegate(ethcore_set_client(&miner).to_delegate());
 
 	let request = r#"{"jsonrpc": "2.0", "method": "ethcore_defaultExtraData", "params": [], "id": 1}"#;
 	let response = format!(r#"{{"jsonrpc":"2.0","result":"0x{}","id":1}}"#, misc::version_data().to_hex());
@@ -81,9 +85,9 @@ fn rpc_ethcore_default_extra_data() {
 #[test]
 fn rpc_ethcore_gas_floor_target() {
 	let miner = miner_service();
-	let ethcore = ethcore_client(&miner).to_delegate();
 	let io = IoHandler::new();
-	io.add_delegate(ethcore);
+	io.add_delegate(ethcore_client(&miner).to_delegate());
+	io.add_delegate(ethcore_set_client(&miner).to_delegate());
 
 	let request = r#"{"jsonrpc": "2.0", "method": "ethcore_gasFloorTarget", "params": [], "id": 1}"#;
 	let response = r#"{"jsonrpc":"2.0","result":"0x3039","id":1}"#;
@@ -94,9 +98,9 @@ fn rpc_ethcore_gas_floor_target() {
 #[test]
 fn rpc_ethcore_min_gas_price() {
 	let miner = miner_service();
-	let ethcore = ethcore_client(&miner).to_delegate();
 	let io = IoHandler::new();
-	io.add_delegate(ethcore);
+	io.add_delegate(ethcore_client(&miner).to_delegate());
+	io.add_delegate(ethcore_set_client(&miner).to_delegate());
 
 	let request = r#"{"jsonrpc": "2.0", "method": "ethcore_minGasPrice", "params": [], "id": 1}"#;
 	let response = r#"{"jsonrpc":"2.0","result":"0x01312d00","id":1}"#;
@@ -107,9 +111,9 @@ fn rpc_ethcore_min_gas_price() {
 #[test]
 fn rpc_ethcore_set_min_gas_price() {
 	let miner = miner_service();
-	let ethcore = ethcore_client(&miner).to_delegate();
 	let io = IoHandler::new();
-	io.add_delegate(ethcore);
+	io.add_delegate(ethcore_client(&miner).to_delegate());
+	io.add_delegate(ethcore_set_client(&miner).to_delegate());
 
 	let request = r#"{"jsonrpc": "2.0", "method": "ethcore_setMinGasPrice", "params":["0xcd1722f3947def4cf144679da39c4c32bdc35681"], "id": 1}"#;
 	let response = r#"{"jsonrpc":"2.0","result":true,"id":1}"#;
@@ -121,9 +125,9 @@ fn rpc_ethcore_set_min_gas_price() {
 #[test]
 fn rpc_ethcore_set_gas_floor_target() {
 	let miner = miner_service();
-	let ethcore = ethcore_client(&miner).to_delegate();
 	let io = IoHandler::new();
-	io.add_delegate(ethcore);
+	io.add_delegate(ethcore_client(&miner).to_delegate());
+	io.add_delegate(ethcore_set_client(&miner).to_delegate());
 
 	let request = r#"{"jsonrpc": "2.0", "method": "ethcore_setGasFloorTarget", "params":["0xcd1722f3947def4cf144679da39c4c32bdc35681"], "id": 1}"#;
 	let response = r#"{"jsonrpc":"2.0","result":true,"id":1}"#;
@@ -135,9 +139,9 @@ fn rpc_ethcore_set_gas_floor_target() {
 #[test]
 fn rpc_ethcore_set_extra_data() {
 	let miner = miner_service();
-	let ethcore = ethcore_client(&miner).to_delegate();
 	let io = IoHandler::new();
-	io.add_delegate(ethcore);
+	io.add_delegate(ethcore_client(&miner).to_delegate());
+	io.add_delegate(ethcore_set_client(&miner).to_delegate());
 
 	let request = r#"{"jsonrpc": "2.0", "method": "ethcore_setExtraData", "params":["0xcd1722f3947def4cf144679da39c4c32bdc35681"], "id": 1}"#;
 	let response = r#"{"jsonrpc":"2.0","result":true,"id":1}"#;
@@ -149,9 +153,9 @@ fn rpc_ethcore_set_extra_data() {
 #[test]
 fn rpc_ethcore_set_author() {
 	let miner = miner_service();
-	let ethcore = ethcore_client(&miner).to_delegate();
 	let io = IoHandler::new();
-	io.add_delegate(ethcore);
+	io.add_delegate(ethcore_client(&miner).to_delegate());
+	io.add_delegate(ethcore_set_client(&miner).to_delegate());
 
 	let request = r#"{"jsonrpc": "2.0", "method": "ethcore_setAuthor", "params":["0xcd1722f3947def4cf144679da39c4c32bdc35681"], "id": 1}"#;
 	let response = r#"{"jsonrpc":"2.0","result":true,"id":1}"#;
@@ -169,6 +173,7 @@ fn rpc_ethcore_dev_logs() {
 	let ethcore = EthcoreClient::new(&miner, logger.clone(), settings()).to_delegate();
 	let io = IoHandler::new();
 	io.add_delegate(ethcore);
+	io.add_delegate(ethcore_set_client(&miner).to_delegate());
 
 	let request = r#"{"jsonrpc": "2.0", "method": "ethcore_devLogs", "params":[], "id": 1}"#;
 	let response = r#"{"jsonrpc":"2.0","result":["b","a"],"id":1}"#;
@@ -179,9 +184,9 @@ fn rpc_ethcore_dev_logs() {
 #[test]
 fn rpc_ethcore_dev_logs_levels() {
 	let miner = miner_service();
-	let ethcore = ethcore_client(&miner).to_delegate();
 	let io = IoHandler::new();
-	io.add_delegate(ethcore);
+	io.add_delegate(ethcore_client(&miner).to_delegate());
+	io.add_delegate(ethcore_set_client(&miner).to_delegate());
 
 	let request = r#"{"jsonrpc": "2.0", "method": "ethcore_devLogsLevels", "params":[], "id": 1}"#;
 	let response = r#"{"jsonrpc":"2.0","result":"rpc=trace","id":1}"#;
@@ -191,9 +196,9 @@ fn rpc_ethcore_dev_logs_levels() {
 #[test]
 fn rpc_ethcore_set_transactions_limit() {
 	let miner = miner_service();
-	let ethcore = ethcore_client(&miner).to_delegate();
 	let io = IoHandler::new();
-	io.add_delegate(ethcore);
+	io.add_delegate(ethcore_client(&miner).to_delegate());
+	io.add_delegate(ethcore_set_client(&miner).to_delegate());
 
 	let request = r#"{"jsonrpc": "2.0", "method": "ethcore_setTransactionsLimit", "params":[10240240], "id": 1}"#;
 	let response = r#"{"jsonrpc":"2.0","result":true,"id":1}"#;
@@ -205,9 +210,9 @@ fn rpc_ethcore_set_transactions_limit() {
 #[test]
 fn rpc_ethcore_transactions_limit() {
 	let miner = miner_service();
-	let ethcore = ethcore_client(&miner).to_delegate();
 	let io = IoHandler::new();
-	io.add_delegate(ethcore);
+	io.add_delegate(ethcore_client(&miner).to_delegate());
+	io.add_delegate(ethcore_set_client(&miner).to_delegate());
 
 	let request = r#"{"jsonrpc": "2.0", "method": "ethcore_transactionsLimit", "params":[], "id": 1}"#;
 	let response = r#"{"jsonrpc":"2.0","result":1024,"id":1}"#;
@@ -218,9 +223,9 @@ fn rpc_ethcore_transactions_limit() {
 #[test]
 fn rpc_ethcore_net_chain() {
 	let miner = miner_service();
-	let ethcore = ethcore_client(&miner).to_delegate();
 	let io = IoHandler::new();
-	io.add_delegate(ethcore);
+	io.add_delegate(ethcore_client(&miner).to_delegate());
+	io.add_delegate(ethcore_set_client(&miner).to_delegate());
 
 	let request = r#"{"jsonrpc": "2.0", "method": "ethcore_netChain", "params":[], "id": 1}"#;
 	let response = r#"{"jsonrpc":"2.0","result":"testchain","id":1}"#;
@@ -231,9 +236,9 @@ fn rpc_ethcore_net_chain() {
 #[test]
 fn rpc_ethcore_net_max_peers() {
 	let miner = miner_service();
-	let ethcore = ethcore_client(&miner).to_delegate();
 	let io = IoHandler::new();
-	io.add_delegate(ethcore);
+	io.add_delegate(ethcore_client(&miner).to_delegate());
+	io.add_delegate(ethcore_set_client(&miner).to_delegate());
 
 	let request = r#"{"jsonrpc": "2.0", "method": "ethcore_netMaxPeers", "params":[], "id": 1}"#;
 	let response = r#"{"jsonrpc":"2.0","result":25,"id":1}"#;
@@ -244,9 +249,9 @@ fn rpc_ethcore_net_max_peers() {
 #[test]
 fn rpc_ethcore_net_port() {
 	let miner = miner_service();
-	let ethcore = ethcore_client(&miner).to_delegate();
 	let io = IoHandler::new();
-	io.add_delegate(ethcore);
+	io.add_delegate(ethcore_client(&miner).to_delegate());
+	io.add_delegate(ethcore_set_client(&miner).to_delegate());
 
 	let request = r#"{"jsonrpc": "2.0", "method": "ethcore_netPort", "params":[], "id": 1}"#;
 	let response = r#"{"jsonrpc":"2.0","result":30303,"id":1}"#;
@@ -257,9 +262,9 @@ fn rpc_ethcore_net_port() {
 #[test]
 fn rpc_ethcore_rpc_settings() {
 	let miner = miner_service();
-	let ethcore = ethcore_client(&miner).to_delegate();
 	let io = IoHandler::new();
-	io.add_delegate(ethcore);
+	io.add_delegate(ethcore_client(&miner).to_delegate());
+	io.add_delegate(ethcore_set_client(&miner).to_delegate());
 
 	let request = r#"{"jsonrpc": "2.0", "method": "ethcore_rpcSettings", "params":[], "id": 1}"#;
 	let response = r#"{"jsonrpc":"2.0","result":{"enabled":true,"interface":"all","port":8545},"id":1}"#;
@@ -270,9 +275,9 @@ fn rpc_ethcore_rpc_settings() {
 #[test]
 fn rpc_ethcore_node_name() {
 	let miner = miner_service();
-	let ethcore = ethcore_client(&miner).to_delegate();
 	let io = IoHandler::new();
-	io.add_delegate(ethcore);
+	io.add_delegate(ethcore_client(&miner).to_delegate());
+	io.add_delegate(ethcore_set_client(&miner).to_delegate());
 
 	let request = r#"{"jsonrpc": "2.0", "method": "ethcore_nodeName", "params":[], "id": 1}"#;
 	let response = r#"{"jsonrpc":"2.0","result":"mynode","id":1}"#;

rpc/src/v1/traits/ethcore.rs

@@ -21,21 +21,6 @@ use jsonrpc_core::*;
 /// Ethcore-specific rpc interface.
 pub trait Ethcore: Sized + Send + Sync + 'static {
 
-	/// Sets new minimal gas price for mined blocks.
-	fn set_min_gas_price(&self, _: Params) -> Result<Value, Error>;
-
-	/// Sets new gas floor target for mined blocks.
-	fn set_gas_floor_target(&self, _: Params) -> Result<Value, Error>;
-
-	/// Sets new extra data for mined blocks.
-	fn set_extra_data(&self, _: Params) -> Result<Value, Error>;
-
-	/// Sets new author for mined block.
-	fn set_author(&self, _: Params) -> Result<Value, Error>;
-
-	/// Sets the limits for transaction queue.
-	fn set_transactions_limit(&self, _: Params) -> Result<Value, Error>;
-
 	/// Returns current transactions limit.
 	fn transactions_limit(&self, _: Params) -> Result<Value, Error>;
 
@@ -75,11 +60,6 @@ pub trait Ethcore: Sized + Send + Sync + 'static {
 	/// Should be used to convert object to io delegate.
 	fn to_delegate(self) -> IoDelegate<Self> {
 		let mut delegate = IoDelegate::new(Arc::new(self));
-		delegate.add_method("ethcore_setMinGasPrice", Ethcore::set_min_gas_price);
-		delegate.add_method("ethcore_setGasFloorTarget", Ethcore::set_gas_floor_target);
-		delegate.add_method("ethcore_setExtraData", Ethcore::set_extra_data);
-		delegate.add_method("ethcore_setAuthor", Ethcore::set_author);
-		delegate.add_method("ethcore_setTransactionsLimit", Ethcore::set_transactions_limit);
 
 		delegate.add_method("ethcore_extraData", Ethcore::extra_data);
 		delegate.add_method("ethcore_gasFloorTarget", Ethcore::gas_floor_target);

rpc/src/v1/traits/ethcore_set.rs

@@ -0,0 +1,51 @@
+// Copyright 2015, 2016 Ethcore (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/>.
+
+//! Ethcore-specific rpc interface for operations altering the settings.
+
+use std::sync::Arc;
+use jsonrpc_core::*;
+
+/// Ethcore-specific rpc interface for operations altering the settings.
+pub trait EthcoreSet: Sized + Send + Sync + 'static {
+
+	/// Sets new minimal gas price for mined blocks.
+	fn set_min_gas_price(&self, _: Params) -> Result<Value, Error>;
+
+	/// Sets new gas floor target for mined blocks.
+	fn set_gas_floor_target(&self, _: Params) -> Result<Value, Error>;
+
+	/// Sets new extra data for mined blocks.
+	fn set_extra_data(&self, _: Params) -> Result<Value, Error>;
+
+	/// Sets new author for mined block.
+	fn set_author(&self, _: Params) -> Result<Value, Error>;
+
+	/// Sets the limits for transaction queue.
+	fn set_transactions_limit(&self, _: Params) -> Result<Value, Error>;
+
+	/// Should be used to convert object to io delegate.
+	fn to_delegate(self) -> IoDelegate<Self> {
+		let mut delegate = IoDelegate::new(Arc::new(self));
+		delegate.add_method("ethcore_setMinGasPrice", EthcoreSet::set_min_gas_price);
+		delegate.add_method("ethcore_setGasFloorTarget", EthcoreSet::set_gas_floor_target);
+		delegate.add_method("ethcore_setExtraData", EthcoreSet::set_extra_data);
+		delegate.add_method("ethcore_setAuthor", EthcoreSet::set_author);
+		delegate.add_method("ethcore_setTransactionsLimit", EthcoreSet::set_transactions_limit);
+
+		delegate
+	}
+}

rpc/src/v1/traits/mod.rs

@@ -21,6 +21,7 @@ pub mod eth;
 pub mod net;
 pub mod personal;
 pub mod ethcore;
+pub mod ethcore_set;
 pub mod traces;
 pub mod rpc;
 
@@ -29,6 +30,7 @@ pub use self::eth::{Eth, EthFilter, EthSigning};
 pub use self::net::Net;
 pub use self::personal::{Personal, PersonalSigner};
 pub use self::ethcore::Ethcore;
+pub use self::ethcore_set::EthcoreSet;
 pub use self::traces::Traces;
 pub use self::rpc::Rpc;