mirror of
https://github.com/pezkuwichain/pezkuwi-subxt.git
synced 2026-07-10 08:47:32 +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
74 lines
2.6 KiB
Rust
74 lines
2.6 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/>.
|
|
|
|
use jsonrpsee::types::error::{ErrorObject, ErrorObjectOwned};
|
|
|
|
#[derive(Debug, thiserror::Error)]
|
|
/// Top-level error type for the RPC handler
|
|
pub enum Error {
|
|
/// The GRANDPA RPC endpoint is not ready.
|
|
#[error("GRANDPA RPC endpoint not ready")]
|
|
EndpointNotReady,
|
|
/// GRANDPA reports the authority set id to be larger than 32-bits.
|
|
#[error("GRANDPA reports authority set id unreasonably large")]
|
|
AuthoritySetIdReportedAsUnreasonablyLarge,
|
|
/// GRANDPA reports voter state with round id or weights larger than 32-bits.
|
|
#[error("GRANDPA reports voter state as unreasonably large")]
|
|
VoterStateReportsUnreasonablyLargeNumbers,
|
|
/// GRANDPA prove finality failed.
|
|
#[error("GRANDPA prove finality rpc failed: {0}")]
|
|
ProveFinalityFailed(#[from] sc_consensus_grandpa::FinalityProofError),
|
|
}
|
|
|
|
/// The error codes returned by jsonrpc.
|
|
pub enum ErrorCode {
|
|
/// Returned when Grandpa RPC endpoint is not ready.
|
|
NotReady = 1,
|
|
/// Authority set ID is larger than 32-bits.
|
|
AuthoritySetTooLarge,
|
|
/// Voter state with round id or weights larger than 32-bits.
|
|
VoterStateTooLarge,
|
|
/// Failed to prove finality.
|
|
ProveFinality,
|
|
}
|
|
|
|
impl From<Error> for ErrorCode {
|
|
fn from(error: Error) -> Self {
|
|
match error {
|
|
Error::EndpointNotReady => ErrorCode::NotReady,
|
|
Error::AuthoritySetIdReportedAsUnreasonablyLarge => ErrorCode::AuthoritySetTooLarge,
|
|
Error::VoterStateReportsUnreasonablyLargeNumbers => ErrorCode::VoterStateTooLarge,
|
|
Error::ProveFinalityFailed(_) => ErrorCode::ProveFinality,
|
|
}
|
|
}
|
|
}
|
|
|
|
impl From<Error> for ErrorObjectOwned {
|
|
fn from(error: Error) -> Self {
|
|
let message = error.to_string();
|
|
let code = ErrorCode::from(error);
|
|
ErrorObject::owned(code as i32, message, None::<()>)
|
|
}
|
|
}
|
|
|
|
impl From<std::num::TryFromIntError> for Error {
|
|
fn from(_error: std::num::TryFromIntError) -> Self {
|
|
Error::VoterStateReportsUnreasonablyLargeNumbers
|
|
}
|
|
}
|