mirror of
https://github.com/pezkuwichain/pezkuwi-subxt.git
synced 2026-04-26 16:57:58 +00:00
Tomasz Drwięga
216f77d91f
* Document TransactionStatus and fix termination conditions. * Update client/rpc-api/src/author/mod.rs Co-Authored-By: Bastian Köcher <bkchr@users.noreply.github.com>
88 lines
3.4 KiB
Rust
88 lines
3.4 KiB
Rust
// Copyright 2017-2019 Parity Technologies (UK) Ltd.
|
|
// This file is part of Substrate.
|
|
|
|
// Substrate 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.
|
|
|
|
// Substrate 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 Substrate. If not, see <http://www.gnu.org/licenses/>.
|
|
|
|
//! Substrate system API.
|
|
|
|
pub mod error;
|
|
pub mod helpers;
|
|
|
|
use crate::helpers::Receiver;
|
|
use jsonrpc_derive::rpc;
|
|
use futures::{future::BoxFuture, compat::Compat};
|
|
|
|
use self::error::Result as SystemResult;
|
|
|
|
pub use self::helpers::{Properties, SystemInfo, Health, PeerInfo, NodeRole};
|
|
pub use self::gen_client::Client as SystemClient;
|
|
|
|
/// Substrate system RPC API
|
|
#[rpc]
|
|
pub trait SystemApi<Hash, Number> {
|
|
/// Get the node's implementation name. Plain old string.
|
|
#[rpc(name = "system_name")]
|
|
fn system_name(&self) -> SystemResult<String>;
|
|
|
|
/// Get the node implementation's version. Should be a semver string.
|
|
#[rpc(name = "system_version")]
|
|
fn system_version(&self) -> SystemResult<String>;
|
|
|
|
/// Get the chain's type. Given as a string identifier.
|
|
#[rpc(name = "system_chain")]
|
|
fn system_chain(&self) -> SystemResult<String>;
|
|
|
|
/// Get a custom set of properties as a JSON object, defined in the chain spec.
|
|
#[rpc(name = "system_properties")]
|
|
fn system_properties(&self) -> SystemResult<Properties>;
|
|
|
|
/// Return health status of the node.
|
|
///
|
|
/// Node is considered healthy if it is:
|
|
/// - connected to some peers (unless running in dev mode)
|
|
/// - not performing a major sync
|
|
#[rpc(name = "system_health", returns = "Health")]
|
|
fn system_health(&self) -> Receiver<Health>;
|
|
|
|
/// Returns currently connected peers
|
|
#[rpc(name = "system_peers", returns = "Vec<PeerInfo<Hash, Number>>")]
|
|
fn system_peers(&self) -> Receiver<Vec<PeerInfo<Hash, Number>>>;
|
|
|
|
/// Returns current state of the network.
|
|
///
|
|
/// **Warning**: This API is not stable.
|
|
// TODO: make this stable and move structs https://github.com/paritytech/substrate/issues/1890
|
|
#[rpc(name = "system_networkState", returns = "jsonrpc_core::Value")]
|
|
fn system_network_state(&self) -> Receiver<jsonrpc_core::Value>;
|
|
|
|
/// Adds a reserved peer. Returns the empty string or an error. The string
|
|
/// parameter should encode a `p2p` multiaddr.
|
|
///
|
|
/// `/ip4/198.51.100.19/tcp/30333/p2p/QmSk5HQbn6LhUwDiNMseVUjuRYhEtYj4aUZ6WfWoGURpdV`
|
|
/// is an example of a valid, passing multiaddr with PeerId attached.
|
|
#[rpc(name = "system_addReservedPeer", returns = "()")]
|
|
fn system_add_reserved_peer(&self, peer: String)
|
|
-> Compat<BoxFuture<'static, Result<(), jsonrpc_core::Error>>>;
|
|
|
|
/// Remove a reserved peer. Returns the empty string or an error. The string
|
|
/// should encode only the PeerId e.g. `QmSk5HQbn6LhUwDiNMseVUjuRYhEtYj4aUZ6WfWoGURpdV`.
|
|
#[rpc(name = "system_removeReservedPeer", returns = "()")]
|
|
fn system_remove_reserved_peer(&self, peer_id: String)
|
|
-> Compat<BoxFuture<'static, Result<(), jsonrpc_core::Error>>>;
|
|
|
|
/// Returns the roles the node is running as.
|
|
#[rpc(name = "system_nodeRoles", returns = "Vec<NodeRole>")]
|
|
fn system_node_roles(&self) -> Receiver<Vec<NodeRole>>;
|
|
}
|