mirror of
https://github.com/pezkuwichain/pezkuwi-subxt.git
synced 2026-06-28 08:41:05 +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
78 lines
2.6 KiB
Rust
78 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 blockchain API.
|
|
|
|
pub mod error;
|
|
|
|
use error::Error;
|
|
use jsonrpsee::proc_macros::rpc;
|
|
use sp_rpc::{list::ListOrValue, number::NumberOrHex};
|
|
|
|
#[rpc(client, server)]
|
|
pub trait ChainApi<Number, Hash, Header, SignedBlock> {
|
|
/// Get header.
|
|
#[method(name = "chain_getHeader", blocking)]
|
|
fn header(&self, hash: Option<Hash>) -> Result<Option<Header>, Error>;
|
|
|
|
/// Get header and body of a block.
|
|
#[method(name = "chain_getBlock", blocking)]
|
|
fn block(&self, hash: Option<Hash>) -> Result<Option<SignedBlock>, Error>;
|
|
|
|
/// Get hash of the n-th block in the canon chain.
|
|
///
|
|
/// By default returns latest block hash.
|
|
#[method(name = "chain_getBlockHash", aliases = ["chain_getHead"], blocking)]
|
|
fn block_hash(
|
|
&self,
|
|
hash: Option<ListOrValue<NumberOrHex>>,
|
|
) -> Result<ListOrValue<Option<Hash>>, Error>;
|
|
|
|
/// Get hash of the last finalized block in the canon chain.
|
|
#[method(name = "chain_getFinalizedHead", aliases = ["chain_getFinalisedHead"], blocking)]
|
|
fn finalized_head(&self) -> Result<Hash, Error>;
|
|
|
|
/// All head subscription.
|
|
#[subscription(
|
|
name = "chain_subscribeAllHeads" => "chain_allHead",
|
|
unsubscribe = "chain_unsubscribeAllHeads",
|
|
item = Header
|
|
)]
|
|
fn subscribe_all_heads(&self);
|
|
|
|
/// New head subscription.
|
|
#[subscription(
|
|
name = "chain_subscribeNewHeads" => "chain_newHead",
|
|
aliases = ["subscribe_newHead", "chain_subscribeNewHead"],
|
|
unsubscribe = "chain_unsubscribeNewHeads",
|
|
unsubscribe_aliases = ["unsubscribe_newHead", "chain_unsubscribeNewHead"],
|
|
item = Header
|
|
)]
|
|
fn subscribe_new_heads(&self);
|
|
|
|
/// Finalized head subscription.
|
|
#[subscription(
|
|
name = "chain_subscribeFinalizedHeads" => "chain_finalizedHead",
|
|
aliases = ["chain_subscribeFinalisedHeads"],
|
|
unsubscribe = "chain_unsubscribeFinalizedHeads",
|
|
unsubscribe_aliases = ["chain_unsubscribeFinalisedHeads"],
|
|
item = Header
|
|
)]
|
|
fn subscribe_finalized_heads(&self);
|
|
}
|