mirror of
https://github.com/pezkuwichain/pezkuwi-subxt.git
synced 2026-05-07 00:18:03 +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
65 lines
2.6 KiB
Rust
65 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/>.
|
|
|
|
//! Substrate dev API containing RPCs that are mainly meant for debugging and stats collection for
|
|
//! developers. The endpoints in this RPC module are not meant to be available to non-local users
|
|
//! and are all marked `unsafe`.
|
|
|
|
pub mod error;
|
|
|
|
use codec::{Decode, Encode};
|
|
use error::Error;
|
|
use jsonrpsee::proc_macros::rpc;
|
|
use scale_info::TypeInfo;
|
|
use serde::{Deserialize, Serialize};
|
|
|
|
/// Statistics of a block returned by the `dev_getBlockStats` RPC.
|
|
#[derive(Eq, PartialEq, Clone, Copy, Encode, Decode, Debug, TypeInfo, Serialize, Deserialize)]
|
|
#[serde(rename_all = "camelCase")]
|
|
pub struct BlockStats {
|
|
/// The length in bytes of the storage proof produced by executing the block.
|
|
pub witness_len: u64,
|
|
/// The length in bytes of the storage proof after compaction.
|
|
pub witness_compact_len: u64,
|
|
/// Length of the block in bytes.
|
|
///
|
|
/// This information can also be acquired by downloading the whole block. This merely
|
|
/// saves some complexity on the client side.
|
|
pub block_len: u64,
|
|
/// Number of extrinsics in the block.
|
|
///
|
|
/// This information can also be acquired by downloading the whole block. This merely
|
|
/// saves some complexity on the client side.
|
|
pub num_extrinsics: u64,
|
|
}
|
|
|
|
/// Substrate dev API.
|
|
///
|
|
/// This API contains unstable and unsafe methods only meant for development nodes. They
|
|
/// are all flagged as unsafe for this reason.
|
|
#[rpc(client, server)]
|
|
pub trait DevApi<Hash> {
|
|
/// Reexecute the specified `block_hash` and gather statistics while doing so.
|
|
///
|
|
/// This function requires the specified block and its parent to be available
|
|
/// at the queried node. If either the specified block or the parent is pruned,
|
|
/// this function will return `None`.
|
|
#[method(name = "dev_getBlockStats")]
|
|
fn block_stats(&self, block_hash: Hash) -> Result<Option<BlockStats>, Error>;
|
|
}
|