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
58 lines
1.9 KiB
Rust
58 lines
1.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 `archive` RPC module.
|
|
|
|
use jsonrpsee::types::error::ErrorObject;
|
|
|
|
/// ChainHead RPC errors.
|
|
#[derive(Debug, thiserror::Error)]
|
|
pub enum Error {
|
|
/// Invalid parameter provided to the RPC method.
|
|
#[error("Invalid parameter: {0}")]
|
|
InvalidParam(String),
|
|
/// Runtime call failed.
|
|
#[error("Runtime call: {0}")]
|
|
RuntimeCall(String),
|
|
/// Failed to fetch leaves.
|
|
#[error("Failed to fetch leaves of the chain: {0}")]
|
|
FetchLeaves(String),
|
|
}
|
|
|
|
// Base code for all `archive` errors.
|
|
const BASE_ERROR: i32 = 3000;
|
|
/// Invalid parameter error.
|
|
const INVALID_PARAM_ERROR: i32 = BASE_ERROR + 1;
|
|
/// Runtime call error.
|
|
const RUNTIME_CALL_ERROR: i32 = BASE_ERROR + 2;
|
|
/// Failed to fetch leaves.
|
|
const FETCH_LEAVES_ERROR: i32 = BASE_ERROR + 3;
|
|
|
|
impl From<Error> for ErrorObject<'static> {
|
|
fn from(e: Error) -> Self {
|
|
let msg = e.to_string();
|
|
|
|
match e {
|
|
Error::InvalidParam(_) => ErrorObject::owned(INVALID_PARAM_ERROR, msg, None::<()>),
|
|
Error::RuntimeCall(_) => ErrorObject::owned(RUNTIME_CALL_ERROR, msg, None::<()>),
|
|
Error::FetchLeaves(_) => ErrorObject::owned(FETCH_LEAVES_ERROR, msg, None::<()>),
|
|
}
|
|
.into()
|
|
}
|
|
}
|