mirror of
https://github.com/pezkuwichain/pezkuwi-subxt.git
synced 2026-06-13 11:41:04 +00:00
Niklas Adolfsson
e16ef0861f
This is a rather big change in jsonrpsee, the major things in this bump are: - Server backpressure (the subscription impls are modified to deal with that) - Allow custom error types / return types (remove jsonrpsee::core::Error and jsonrpee::core::CallError) - Bug fixes (graceful shutdown in particular not used by substrate anyway) - Less dependencies for the clients in particular - Return type requires Clone in method call responses - Moved to tokio channels - Async subscription API (not used in this PR) Major changes in this PR: - The subscriptions are now bounded and if subscription can't keep up with the server it is dropped - CLI: add parameter to configure the jsonrpc server bounded message buffer (default is 64) - Add our own subscription helper to deal with the unbounded streams in substrate The most important things in this PR to review is the added helpers functions in `substrate/client/rpc/src/utils.rs` and the rest is pretty much chore. Regarding the "bounded buffer limit" it may cause the server to handle the JSON-RPC calls slower than before. The message size limit is bounded by "--rpc-response-size" thus "by default 10MB * 64 = 640MB" but the subscription message size is not covered by this limit and could be capped as well. Hopefully the last release prior to 1.0, sorry in advance for a big PR Previous attempt: https://github.com/paritytech/substrate/pull/13992 Resolves https://github.com/paritytech/polkadot-sdk/issues/748, resolves https://github.com/paritytech/polkadot-sdk/issues/627
81 lines
2.9 KiB
Rust
81 lines
2.9 KiB
Rust
// This file is part of Substrate.
|
|
|
|
// Copyright (C) Parity Technologies (UK) Ltd.
|
|
// SPDX-License-Identifier: GPL-3.0-or-later WITH Classpath-exception-2.0
|
|
|
|
// This program 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.
|
|
|
|
// This program 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 this program. If not, see <https://www.gnu.org/licenses/>.
|
|
|
|
//! Error helpers for `chainHead` RPC module.
|
|
|
|
use jsonrpsee::types::error::ErrorObject;
|
|
|
|
/// ChainHead RPC errors.
|
|
#[derive(Debug, thiserror::Error)]
|
|
pub enum Error {
|
|
/// The provided block hash is invalid.
|
|
#[error("Invalid block hash")]
|
|
InvalidBlock,
|
|
/// The follow subscription was started with `withRuntime` set to `false`.
|
|
#[error("The `chainHead_follow` subscription was started with `withRuntime` set to `false`")]
|
|
InvalidRuntimeCall(String),
|
|
/// Wait-for-continue event not generated.
|
|
#[error("Wait for continue event was not generated for the subscription")]
|
|
InvalidContinue,
|
|
/// Invalid parameter provided to the RPC method.
|
|
#[error("Invalid parameter: {0}")]
|
|
InvalidParam(String),
|
|
/// Internal error.
|
|
#[error("Internal error: {0}")]
|
|
InternalError(String),
|
|
}
|
|
|
|
/// Errors for `chainHead` RPC module, as defined in
|
|
/// <https://github.com/paritytech/json-rpc-interface-spec>.
|
|
pub mod rpc_spec_v2 {
|
|
/// The provided block hash is invalid.
|
|
pub const INVALID_BLOCK_ERROR: i32 = -32801;
|
|
/// The follow subscription was started with `withRuntime` set to `false`.
|
|
pub const INVALID_RUNTIME_CALL: i32 = -32802;
|
|
/// Wait-for-continue event not generated.
|
|
pub const INVALID_CONTINUE: i32 = -32803;
|
|
}
|
|
|
|
/// General purpose errors, as defined in
|
|
/// <https://www.jsonrpc.org/specification#error_object>.
|
|
pub mod json_rpc_spec {
|
|
/// Invalid parameter error.
|
|
pub const INVALID_PARAM_ERROR: i32 = -32602;
|
|
/// Internal error.
|
|
pub const INTERNAL_ERROR: i32 = -32603;
|
|
}
|
|
|
|
impl From<Error> for ErrorObject<'static> {
|
|
fn from(e: Error) -> Self {
|
|
let msg = e.to_string();
|
|
|
|
match e {
|
|
Error::InvalidBlock =>
|
|
ErrorObject::owned(rpc_spec_v2::INVALID_BLOCK_ERROR, msg, None::<()>),
|
|
Error::InvalidRuntimeCall(_) =>
|
|
ErrorObject::owned(rpc_spec_v2::INVALID_RUNTIME_CALL, msg, None::<()>),
|
|
Error::InvalidContinue =>
|
|
ErrorObject::owned(rpc_spec_v2::INVALID_CONTINUE, msg, None::<()>),
|
|
Error::InvalidParam(_) =>
|
|
ErrorObject::owned(json_rpc_spec::INVALID_PARAM_ERROR, msg, None::<()>),
|
|
Error::InternalError(_) =>
|
|
ErrorObject::owned(json_rpc_spec::INTERNAL_ERROR, msg, None::<()>),
|
|
}
|
|
}
|
|
}
|