companion for jsonrpsee v0.10

Cargo.toml

@@ -294,3 +294,7 @@ inherits = "release"
 lto = "fat"
 # https://doc.rust-lang.org/rustc/codegen-options/index.html#codegen-units
 codegen-units = 1
+
+[patch.crates-io]
+jsonrpsee = { git = "https://github.com/paritytech/jsonrpsee" }
+

bin/node/cli/benches/block_production.rs

@@ -92,6 +92,8 @@ fn new_node(tokio_handle: Handle) -> node_cli::service::NewFullBase {
 		rpc_cors: None,
 		rpc_methods: Default::default(),
 		rpc_max_payload: None,
+		rpc_max_request_size: None,
+		rpc_max_response_size: None,
 		rpc_id_provider: None,
 		ws_max_out_buffer_capacity: None,
 		prometheus_config: None,

bin/node/cli/benches/transaction_pool.rs

@@ -84,6 +84,8 @@ fn new_node(tokio_handle: Handle) -> node_cli::service::NewFullBase {
 		rpc_cors: None,
 		rpc_methods: Default::default(),
 		rpc_max_payload: None,
+		rpc_max_request_size: None,
+		rpc_max_response_size: None,
 		rpc_id_provider: None,
 		ws_max_out_buffer_capacity: None,
 		prometheus_config: None,

client/cli/src/commands/run_cmd.rs

@@ -100,18 +100,28 @@ pub struct RunCmd {
 	#[clap(long)]
 	pub unsafe_ws_external: bool,
 
-	/// Set the the maximum RPC payload size for both requests and responses (both http and ws), in
-	/// megabytes. Default is 15MiB.
+	/// DEPERECATED, this has no affect anymore. Use `rpc_max_request_size` or
+	/// `rpc_max_response_size` instead.
 	#[clap(long)]
 	pub rpc_max_payload: Option<usize>,
 
+	/// Set the the maximum RPC request payload size for both HTTP and WS in megabytes.
+	/// Default is 15MiB.
+	#[clap(long)]
+	pub rpc_max_request_size: Option<usize>,
+
+	/// Set the the maximum RPC response payload size for both HTTP and WS in megabytes.
+	/// Default is 15MiB.
+	#[clap(long)]
+	pub rpc_max_response_size: Option<usize>,
+
 	/// Expose Prometheus exporter on all interfaces.
 	///
 	/// Default is local.
 	#[clap(long)]
 	pub prometheus_external: bool,
 
-	/// Specify IPC RPC server path
+	/// DEPERECATED, IPC support has been removed.
 	#[clap(long, value_name = "PATH")]
 	pub ipc_path: Option<String>,
 
@@ -127,7 +137,7 @@ pub struct RunCmd {
 	#[clap(long, value_name = "COUNT")]
 	pub ws_max_connections: Option<usize>,
 
-	/// Set the the maximum WebSocket output buffer size in MiB. Default is 16.
+	/// DEPERECATED, this has no affect anymore. Use `rpc_max_response_size` instead.
 	#[clap(long)]
 	pub ws_max_out_buffer_capacity: Option<usize>,
 
@@ -427,6 +437,7 @@ impl CliConfiguration for RunCmd {
 	}
 
 	fn rpc_ipc(&self) -> Result<Option<String>> {
+		eprintln!("DEPRECATED `--ipc-path` has no effect anymore IPC support has been removed");
 		Ok(self.ipc_path.clone())
 	}
 
@@ -446,10 +457,12 @@ impl CliConfiguration for RunCmd {
 	}
 
 	fn rpc_max_payload(&self) -> Result<Option<usize>> {
+		eprintln!("DEPRECATED `--rpc_max_payload` has been removed use `rpc-max-request-size` or `rpc-max-response-size` instead");
 		Ok(self.rpc_max_payload)
 	}
 
 	fn ws_max_out_buffer_capacity(&self) -> Result<Option<usize>> {
+		eprintln!("DEPRECATED `--ws_max_out_buffer_capacity` has no effect anymore, use `rpc-max-response-size` instead");
 		Ok(self.ws_max_out_buffer_capacity)
 	}
 

client/cli/src/config.rs

@@ -359,6 +359,16 @@ pub trait CliConfiguration<DCV: DefaultConfigurationValues = ()>: Sized {
 		Ok(None)
 	}
 
+	/// Get maximum RPC request payload size.
+	fn rpc_max_request_size(&self) -> Result<Option<usize>> {
+		Ok(None)
+	}
+
+	/// Get maximum RPC response payload size.
+	fn rpc_max_response_size(&self) -> Result<Option<usize>> {
+		Ok(None)
+	}
+
 	/// Get maximum WS output buffer capacity.
 	fn ws_max_out_buffer_capacity(&self) -> Result<Option<usize>> {
 		Ok(None)
@@ -528,6 +538,8 @@ pub trait CliConfiguration<DCV: DefaultConfigurationValues = ()>: Sized {
 			rpc_ws_max_connections: self.rpc_ws_max_connections()?,
 			rpc_cors: self.rpc_cors(is_dev)?,
 			rpc_max_payload: self.rpc_max_payload()?,
+			rpc_max_request_size: self.rpc_max_request_size()?,
+			rpc_max_response_size: self.rpc_max_response_size()?,
 			rpc_id_provider: None,
 			ws_max_out_buffer_capacity: self.ws_max_out_buffer_capacity()?,
 			prometheus_config: self

client/rpc-api/src/author/mod.rs

@@ -71,7 +71,7 @@ pub trait AuthorApi<Hash, BlockHash> {
 	/// transaction life cycle.
 	#[subscription(
 		name = "submitAndWatchExtrinsic" => "extrinsicUpdate",
-		unsubscribe_aliases = ["author_unwatchExtrinsic"],
+		unsubscribe = "author_unwatchExtrinsic",
 		item = TransactionStatus<Hash, BlockHash>,
 	)]
 	fn watch_extrinsic(&self, bytes: Bytes) -> RpcResult<()>;

client/rpc-servers/src/lib.rs

@@ -52,14 +52,14 @@ pub type WsServer = WsServerHandle;
 pub fn start_http<M: Send + Sync + 'static>(
 	addrs: &[SocketAddr],
 	cors: Option<&Vec<String>>,
-	max_payload_mb: Option<usize>,
+	max_payload_in_mb: Option<usize>,
+	max_payload_out_mb: Option<usize>,
 	metrics: Option<RpcMetrics>,
 	rpc_api: RpcModule<M>,
 	rt: tokio::runtime::Handle,
 ) -> Result<HttpServerHandle, anyhow::Error> {
-	let max_request_body_size = max_payload_mb
-		.map(|mb| mb.saturating_mul(MEGABYTE))
-		.unwrap_or(RPC_MAX_PAYLOAD_DEFAULT);
+	let max_payload_in = payload_size_or_default(max_payload_in_mb);
+	let max_payload_out = payload_size_or_default(max_payload_out_mb);
 
 	let mut acl = AccessControlBuilder::new();
 
@@ -71,18 +71,19 @@ pub fn start_http<M: Send + Sync + 'static>(
 	};
 
 	let builder = HttpServerBuilder::new()
-		.max_request_body_size(max_request_body_size as u32)
+		.max_request_body_size(max_payload_in as u32)
+		.max_response_body_size(max_payload_out as u32)
 		.set_access_control(acl.build())
 		.custom_tokio_runtime(rt.clone());
 
 	let rpc_api = build_rpc_api(rpc_api);
 	let handle = if let Some(metrics) = metrics {
 		let middleware = RpcMiddleware::new(metrics, "http".into());
 		let builder = builder.set_middleware(middleware);
-		let server = tokio::task::block_in_place(|| rt.block_on(async { builder.build(addrs) }))?;
+		let server = tokio::task::block_in_place(|| rt.block_on(builder.build(addrs)))?;
 		server.start(rpc_api)?
 	} else {
-		let server = tokio::task::block_in_place(|| rt.block_on(async { builder.build(addrs) }))?;
+		let server = tokio::task::block_in_place(|| rt.block_on(builder.build(addrs)))?;
 		server.start(rpc_api)?
 	};
 
@@ -95,19 +96,21 @@ pub fn start_ws<M: Send + Sync + 'static>(
 	addrs: &[SocketAddr],
 	max_connections: Option<usize>,
 	cors: Option<&Vec<String>>,
-	max_payload_mb: Option<usize>,
+	max_payload_in_mb: Option<usize>,
+	max_payload_out_mb: Option<usize>,
 	metrics: Option<RpcMetrics>,
 	rpc_api: RpcModule<M>,
 	rt: tokio::runtime::Handle,
 	id_provider: Option<Box<dyn IdProvider>>,
 ) -> Result<WsServerHandle, anyhow::Error> {
-	let max_request_body_size = max_payload_mb
-		.map(|mb| mb.saturating_mul(MEGABYTE))
-		.unwrap_or(RPC_MAX_PAYLOAD_DEFAULT);
+	let max_payload_in = payload_size_or_default(max_payload_in_mb);
+	let max_payload_out = payload_size_or_default(max_payload_out_mb);
+
 	let max_connections = max_connections.unwrap_or(WS_MAX_CONNECTIONS);
 
 	let mut builder = WsServerBuilder::new()
-		.max_request_body_size(max_request_body_size as u32)
+		.max_request_body_size(max_payload_in as u32)
+		.max_response_body_size(max_payload_out as u32)
 		.max_connections(max_connections as u64)
 		.custom_tokio_runtime(rt.clone());
 
@@ -163,3 +166,7 @@ fn build_rpc_api<M: Send + Sync + 'static>(mut rpc_api: RpcModule<M>) -> RpcModu
 
 	rpc_api
 }
+
+fn payload_size_or_default(size_mb: Option<usize>) -> usize {
+	size_mb.map_or(RPC_MAX_PAYLOAD_DEFAULT, |mb| mb.saturating_mul(MEGABYTE))
+}

client/rpc/src/author/tests.rs

@@ -26,7 +26,7 @@ use jsonrpsee::{
 		error::{SubscriptionClosed, SubscriptionClosedReason},
 		Error as RpcError,
 	},
-	types::EmptyParams,
+	types::{error::CallError, EmptyParams},
 	RpcModule,
 };
 use sc_transaction_pool::{BasicPool, FullChainApi};
@@ -107,7 +107,7 @@ async fn author_submit_transaction_should_not_cause_error() {
 
 	assert_matches!(
 		api.call::<_, H256>("author_submitExtrinsic", [xt]).await,
-		Err(RpcError::Request(e)) if e.contains("Already imported")
+		Err(RpcError::Call(CallError::Custom { message, ..})) if message.contains("Already imported")
 	);
 }
 
@@ -287,7 +287,7 @@ async fn author_has_session_keys() {
 
 	assert_matches!(
 		api.call::<_, bool>("author_hasSessionKeys", vec![Bytes::from(vec![1, 2, 3])]).await,
-		Err(RpcError::Request(e)) if e.contains("Session keys are not encoded correctly")
+		Err(RpcError::Call(CallError::Custom { message, ..})) if message.as_str() == "Session keys are not encoded correctly"
 	);
 }
 

client/rpc/src/dev/tests.rs

@@ -18,7 +18,7 @@
 
 use super::*;
 use assert_matches::assert_matches;
-use jsonrpsee::core::Error as JsonRpseeError;
+use jsonrpsee::{core::Error as JsonRpseeError, types::error::CallError};
 use sc_block_builder::BlockBuilderProvider;
 use sp_blockchain::HeaderBackend;
 use sp_consensus::BlockOrigin;
@@ -64,6 +64,6 @@ async fn deny_unsafe_works() {
 	assert_matches!(
 		api.call::<_, Option<BlockStats>>("dev_getBlockStats", [client.info().best_hash])
 			.await,
-		Err(JsonRpseeError::Request(e)) if e.to_string().contains("RPC call is unsafe to be called externally")
+		Err(JsonRpseeError::Call(CallError::Custom { message, .. })) if message.as_str() == "RPC call is unsafe to be called externally"
 	);
 }