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
80 lines
2.9 KiB
Rust
80 lines
2.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/>.
|
|
|
|
//! Substrate block-author/full-node API.
|
|
|
|
pub mod error;
|
|
pub mod hash;
|
|
|
|
use error::Error;
|
|
use jsonrpsee::proc_macros::rpc;
|
|
use sc_transaction_pool_api::TransactionStatus;
|
|
use sp_core::Bytes;
|
|
|
|
/// Substrate authoring RPC API
|
|
#[rpc(client, server)]
|
|
pub trait AuthorApi<Hash, BlockHash> {
|
|
/// Submit hex-encoded extrinsic for inclusion in block.
|
|
#[method(name = "author_submitExtrinsic")]
|
|
async fn submit_extrinsic(&self, extrinsic: Bytes) -> Result<Hash, Error>;
|
|
|
|
/// Insert a key into the keystore.
|
|
#[method(name = "author_insertKey")]
|
|
fn insert_key(&self, key_type: String, suri: String, public: Bytes) -> Result<(), Error>;
|
|
|
|
/// Generate new session keys and returns the corresponding public keys.
|
|
#[method(name = "author_rotateKeys")]
|
|
fn rotate_keys(&self) -> Result<Bytes, Error>;
|
|
|
|
/// Checks if the keystore has private keys for the given session public keys.
|
|
///
|
|
/// `session_keys` is the SCALE encoded session keys object from the runtime.
|
|
///
|
|
/// Returns `true` iff all private keys could be found.
|
|
#[method(name = "author_hasSessionKeys")]
|
|
fn has_session_keys(&self, session_keys: Bytes) -> Result<bool, Error>;
|
|
|
|
/// Checks if the keystore has private keys for the given public key and key type.
|
|
///
|
|
/// Returns `true` if a private key could be found.
|
|
#[method(name = "author_hasKey")]
|
|
fn has_key(&self, public_key: Bytes, key_type: String) -> Result<bool, Error>;
|
|
|
|
/// Returns all pending extrinsics, potentially grouped by sender.
|
|
#[method(name = "author_pendingExtrinsics")]
|
|
fn pending_extrinsics(&self) -> Result<Vec<Bytes>, Error>;
|
|
|
|
/// Remove given extrinsic from the pool and temporarily ban it to prevent reimporting.
|
|
#[method(name = "author_removeExtrinsic")]
|
|
fn remove_extrinsic(
|
|
&self,
|
|
bytes_or_hash: Vec<hash::ExtrinsicOrHash<Hash>>,
|
|
) -> Result<Vec<Hash>, Error>;
|
|
|
|
/// Submit an extrinsic to watch.
|
|
///
|
|
/// See [`TransactionStatus`](sc_transaction_pool_api::TransactionStatus) for details on
|
|
/// transaction life cycle.
|
|
#[subscription(
|
|
name = "author_submitAndWatchExtrinsic" => "author_extrinsicUpdate",
|
|
unsubscribe = "author_unwatchExtrinsic",
|
|
item = TransactionStatus<Hash, BlockHash>,
|
|
)]
|
|
fn watch_extrinsic(&self, bytes: Bytes);
|
|
}
|