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 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365
// Copyright 2019-2021 Parity Technologies (UK) Ltd.
//
// Permission is hereby granted, free of charge, to any
// person obtaining a copy of this software and associated
// documentation files (the "Software"), to deal in the
// Software without restriction, including without
// limitation the rights to use, copy, modify, merge,
// publish, distribute, sublicense, and/or sell copies of
// the Software, and to permit persons to whom the Software
// is furnished to do so, subject to the following
// conditions:
//
// The above copyright notice and this permission notice
// shall be included in all copies or substantial portions
// of the Software.
//
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF
// ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
// TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A
// PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT
// SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
// CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
// OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR
// IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
// DEALINGS IN THE SOFTWARE.
//! # jsonrpsee-ws-client
//!
//! `jsonrpsee-ws-client` is a [JSON RPC](https://www.jsonrpc.org/specification) WebSocket client library that's is built for `async/await`.
//!
//! ## Async runtime support
//!
//! This library uses `tokio` as the runtime and does not support other runtimes.
#![warn(missing_docs, missing_debug_implementations, missing_copy_implementations, unreachable_pub)]
#![cfg_attr(not(test), warn(unused_crate_dependencies))]
#![cfg_attr(docsrs, feature(doc_cfg))]
#[cfg(test)]
mod tests;
pub use http::{HeaderMap, HeaderValue};
pub use jsonrpsee_core::client::async_client::PingConfig;
pub use jsonrpsee_core::client::Client as WsClient;
pub use jsonrpsee_types as types;
use jsonrpsee_client_transport::ws::{AsyncRead, AsyncWrite, WsTransportClientBuilder};
use jsonrpsee_core::client::{ClientBuilder, Error, IdKind, MaybeSend, TransportReceiverT, TransportSenderT};
use jsonrpsee_core::TEN_MB_SIZE_BYTES;
use std::time::Duration;
use url::Url;
#[cfg(feature = "tls")]
pub use jsonrpsee_client_transport::ws::CustomCertStore;
#[cfg(feature = "tls")]
use jsonrpsee_client_transport::ws::CertificateStore;
/// Builder for [`WsClient`].
///
/// # Examples
///
/// ```no_run
///
/// use jsonrpsee_ws_client::{WsClientBuilder, HeaderMap, HeaderValue};
///
/// #[tokio::main]
/// async fn main() {
/// // Build custom headers used during the handshake process.
/// let mut headers = HeaderMap::new();
/// headers.insert("Any-Header-You-Like", HeaderValue::from_static("42"));
///
/// // Build client
/// let client = WsClientBuilder::default()
/// .set_headers(headers)
/// .build("wss://localhost:443")
/// .await
/// .unwrap();
///
/// // use client....
/// }
///
/// ```
#[derive(Clone, Debug)]
pub struct WsClientBuilder {
#[cfg(feature = "tls")]
certificate_store: CertificateStore,
max_request_size: u32,
max_response_size: u32,
request_timeout: Duration,
connection_timeout: Duration,
ping_config: Option<PingConfig>,
headers: http::HeaderMap,
max_concurrent_requests: usize,
max_buffer_capacity_per_subscription: usize,
max_redirections: usize,
id_kind: IdKind,
max_log_length: u32,
tcp_no_delay: bool,
}
impl Default for WsClientBuilder {
fn default() -> Self {
Self {
#[cfg(feature = "tls")]
certificate_store: CertificateStore::Native,
max_request_size: TEN_MB_SIZE_BYTES,
max_response_size: TEN_MB_SIZE_BYTES,
request_timeout: Duration::from_secs(60),
connection_timeout: Duration::from_secs(10),
ping_config: None,
headers: HeaderMap::new(),
max_concurrent_requests: 256,
max_buffer_capacity_per_subscription: 1024,
max_redirections: 5,
id_kind: IdKind::Number,
max_log_length: 4096,
tcp_no_delay: true,
}
}
}
impl WsClientBuilder {
/// Create a new WebSocket client builder.
pub fn new() -> WsClientBuilder {
WsClientBuilder::default()
}
/// Force to use a custom certificate store.
///
/// # Optional
///
/// This requires the optional `tls` feature.
///
/// # Example
///
/// ```no_run
/// use jsonrpsee_ws_client::{WsClientBuilder, CustomCertStore};
/// use rustls::{
/// client::danger::{self, HandshakeSignatureValid, ServerCertVerified},
/// pki_types::{CertificateDer, ServerName, UnixTime},
/// Error,
/// };
///
/// #[derive(Debug)]
/// struct NoCertificateVerification;
///
/// impl rustls::client::danger::ServerCertVerifier for NoCertificateVerification {
/// fn verify_server_cert(
/// &self,
/// _: &CertificateDer<'_>,
/// _: &[CertificateDer<'_>],
/// _: &ServerName<'_>,
/// _: &[u8],
/// _: UnixTime,
/// ) -> Result<ServerCertVerified, Error> {
/// Ok(ServerCertVerified::assertion())
/// }
///
/// fn supported_verify_schemes(&self) -> Vec<rustls::SignatureScheme> {
/// vec![rustls::SignatureScheme::ECDSA_NISTP256_SHA256]
/// }
///
/// fn verify_tls12_signature(
/// &self,
/// _: &[u8],
/// _: &CertificateDer<'_>,
/// _: &rustls::DigitallySignedStruct,
/// ) -> Result<rustls::client::danger::HandshakeSignatureValid, Error> {
/// Ok(HandshakeSignatureValid::assertion())
/// }
///
/// fn verify_tls13_signature(
/// &self,
/// _: &[u8],
/// _: &CertificateDer<'_>,
/// _: &rustls::DigitallySignedStruct,
/// ) -> Result<HandshakeSignatureValid, Error> {
/// Ok(HandshakeSignatureValid::assertion())
/// }
/// }
///
/// let tls_cfg = CustomCertStore::builder()
/// .dangerous()
/// .with_custom_certificate_verifier(std::sync::Arc::new(NoCertificateVerification))
/// .with_no_client_auth();
///
/// // client builder with disabled certificate verification.
/// let client_builder = WsClientBuilder::new().with_custom_cert_store(tls_cfg);
/// ```
#[cfg(feature = "tls")]
pub fn with_custom_cert_store(mut self, cfg: CustomCertStore) -> Self {
self.certificate_store = CertificateStore::Custom(cfg);
self
}
/// See documentation [`WsTransportClientBuilder::max_request_size`] (default is 10 MB).
pub fn max_request_size(mut self, size: u32) -> Self {
self.max_request_size = size;
self
}
/// See documentation [`WsTransportClientBuilder::max_response_size`] (default is 10 MB).
pub fn max_response_size(mut self, size: u32) -> Self {
self.max_response_size = size;
self
}
/// See documentation [`ClientBuilder::request_timeout`] (default is 60 seconds).
pub fn request_timeout(mut self, timeout: Duration) -> Self {
self.request_timeout = timeout;
self
}
/// See documentation [`WsTransportClientBuilder::connection_timeout`] (default is 10 seconds).
pub fn connection_timeout(mut self, timeout: Duration) -> Self {
self.connection_timeout = timeout;
self
}
/// See documentation [`ClientBuilder::enable_ws_ping`] (disabled by default).
pub fn enable_ws_ping(mut self, cfg: PingConfig) -> Self {
self.ping_config = Some(cfg);
self
}
/// See documentation [`ClientBuilder::disable_ws_ping`]
pub fn disable_ws_ping(mut self) -> Self {
self.ping_config = None;
self
}
/// See documentation [`WsTransportClientBuilder::set_headers`] (default is none).
pub fn set_headers(mut self, headers: http::HeaderMap) -> Self {
self.headers = headers;
self
}
/// See documentation [`ClientBuilder::max_concurrent_requests`] (default is 256).
pub fn max_concurrent_requests(mut self, max: usize) -> Self {
self.max_concurrent_requests = max;
self
}
/// See documentation [`ClientBuilder::max_buffer_capacity_per_subscription`] (default is 1024).
pub fn max_buffer_capacity_per_subscription(mut self, max: usize) -> Self {
self.max_buffer_capacity_per_subscription = max;
self
}
/// See documentation [`WsTransportClientBuilder::max_redirections`] (default is 5).
pub fn max_redirections(mut self, redirect: usize) -> Self {
self.max_redirections = redirect;
self
}
/// See documentation for [`ClientBuilder::id_format`] (default is Number).
pub fn id_format(mut self, kind: IdKind) -> Self {
self.id_kind = kind;
self
}
/// Set maximum length for logging calls and responses.
///
/// Logs bigger than this limit will be truncated.
pub fn set_max_logging_length(mut self, max: u32) -> Self {
self.max_log_length = max;
self
}
/// See documentation [`ClientBuilder::set_tcp_no_delay`] (default is true).
pub fn set_tcp_no_delay(mut self, no_delay: bool) -> Self {
self.tcp_no_delay = no_delay;
self
}
/// Build the [`WsClient`] with specified [`TransportSenderT`] [`TransportReceiverT`] parameters
///
/// ## Panics
///
/// Panics if being called outside of `tokio` runtime context.
pub fn build_with_transport<S, R>(self, sender: S, receiver: R) -> WsClient
where
S: TransportSenderT + Send,
R: TransportReceiverT + Send,
{
let Self {
max_concurrent_requests,
request_timeout,
ping_config,
max_buffer_capacity_per_subscription,
id_kind,
max_log_length,
tcp_no_delay,
..
} = self;
let mut client = ClientBuilder::default()
.max_buffer_capacity_per_subscription(max_buffer_capacity_per_subscription)
.request_timeout(request_timeout)
.max_concurrent_requests(max_concurrent_requests)
.id_format(id_kind)
.set_max_logging_length(max_log_length)
.set_tcp_no_delay(tcp_no_delay);
if let Some(cfg) = ping_config {
client = client.enable_ws_ping(cfg);
}
client.build_with_tokio(sender, receiver)
}
/// Build the [`WsClient`] with specified data stream, using [`WsTransportClientBuilder::build_with_stream`].
///
/// ## Panics
///
/// Panics if being called outside of `tokio` runtime context.
pub async fn build_with_stream<T>(self, url: impl AsRef<str>, data_stream: T) -> Result<WsClient, Error>
where
T: AsyncRead + AsyncWrite + Unpin + MaybeSend + 'static,
{
let transport_builder = WsTransportClientBuilder {
#[cfg(feature = "tls")]
certificate_store: self.certificate_store.clone(),
connection_timeout: self.connection_timeout,
headers: self.headers.clone(),
max_request_size: self.max_request_size,
max_response_size: self.max_response_size,
max_redirections: self.max_redirections,
tcp_no_delay: self.tcp_no_delay,
};
let uri = Url::parse(url.as_ref()).map_err(|e| Error::Transport(e.into()))?;
let (sender, receiver) =
transport_builder.build_with_stream(uri, data_stream).await.map_err(|e| Error::Transport(e.into()))?;
let ws_client = self.build_with_transport(sender, receiver);
Ok(ws_client)
}
/// Build the [`WsClient`] with specified URL to connect to, using the default
/// [`WsTransportClientBuilder::build_with_stream`], therefore with the default TCP as transport layer.
///
/// ## Panics
///
/// Panics if being called outside of `tokio` runtime context.
pub async fn build(self, url: impl AsRef<str>) -> Result<WsClient, Error> {
let transport_builder = WsTransportClientBuilder {
#[cfg(feature = "tls")]
certificate_store: self.certificate_store.clone(),
connection_timeout: self.connection_timeout,
headers: self.headers.clone(),
max_request_size: self.max_request_size,
max_response_size: self.max_response_size,
max_redirections: self.max_redirections,
tcp_no_delay: self.tcp_no_delay,
};
let uri = Url::parse(url.as_ref()).map_err(|e| Error::Transport(e.into()))?;
let (sender, receiver) = transport_builder.build(uri).await.map_err(|e| Error::Transport(e.into()))?;
let ws_client = self.build_with_transport(sender, receiver);
Ok(ws_client)
}
}