mirror of
https://github.com/pezkuwichain/pezkuwi-subxt.git
synced 2026-05-07 15:28:02 +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
69 lines
2.2 KiB
Rust
69 lines
2.2 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/>.
|
|
|
|
//! State RPC errors.
|
|
|
|
use jsonrpsee::types::error::{ErrorObject, ErrorObjectOwned};
|
|
|
|
/// State RPC Result type.
|
|
pub type Result<T> = std::result::Result<T, Error>;
|
|
|
|
/// State RPC errors.
|
|
#[derive(Debug, thiserror::Error)]
|
|
pub enum Error {
|
|
/// Client error.
|
|
#[error("Client error: {}", .0)]
|
|
Client(#[from] Box<dyn std::error::Error + Send + Sync>),
|
|
/// Provided block range couldn't be resolved to a list of blocks.
|
|
#[error("Cannot resolve a block range ['{:?}' ... '{:?}]. {}", .from, .to, .details)]
|
|
InvalidBlockRange {
|
|
/// Beginning of the block range.
|
|
from: String,
|
|
/// End of the block range.
|
|
to: String,
|
|
/// Details of the error message.
|
|
details: String,
|
|
},
|
|
/// Provided count exceeds maximum value.
|
|
#[error("count exceeds maximum value. value: {}, max: {}", .value, .max)]
|
|
InvalidCount {
|
|
/// Provided value
|
|
value: u32,
|
|
/// Maximum allowed value
|
|
max: u32,
|
|
},
|
|
/// Call to an unsafe RPC was denied.
|
|
#[error(transparent)]
|
|
UnsafeRpcCalled(#[from] crate::policy::UnsafeRpcError),
|
|
}
|
|
|
|
/// Base code for all state errors.
|
|
const BASE_ERROR: i32 = crate::error::base::STATE;
|
|
|
|
impl From<Error> for ErrorObjectOwned {
|
|
fn from(e: Error) -> ErrorObjectOwned {
|
|
match e {
|
|
Error::InvalidBlockRange { .. } =>
|
|
ErrorObject::owned(BASE_ERROR + 1, e.to_string(), None::<()>),
|
|
Error::InvalidCount { .. } =>
|
|
ErrorObject::owned(BASE_ERROR + 2, e.to_string(), None::<()>),
|
|
e => ErrorObject::owned(BASE_ERROR + 3, e.to_string(), None::<()>),
|
|
}
|
|
}
|
|
}
|