Struct sc_rpc::system::System

pub struct System<B: Block> { /* private fields */ }

System API implementation

Implementations

impl<B: Block> System<B>

pub fn new(
    info: SystemInfo,
    send_back: TracingUnboundedSender<Request<B>>,
    deny_unsafe: DenyUnsafe
) -> Self

Creates new System.

The send_back will be used to transmit some of the requests. The user is responsible for reading from that channel and answering the requests.

Trait Implementations

impl<B: Block> SystemApiServer<<B as Block>::Hash, <<B as Block>::Header as Header>::Number> for System<B>

fn system_name(&self) -> RpcResult<String>

Get the node’s implementation name. Plain old string.

fn system_version(&self) -> RpcResult<String>

Get the node implementation’s version. Should be a semver string.

fn system_chain(&self) -> RpcResult<String>

Get the chain’s name. Given as a string identifier.

fn system_type(&self) -> RpcResult<ChainType>

Get the chain’s type.

fn system_properties(&self) -> RpcResult<Properties>

Get a custom set of properties as a JSON object, defined in the chain spec.

fn system_health<'life0, 'async_trait>(
    &'life0 self
) -> Pin<Box<dyn Future<Output = RpcResult<Health>> + Send + 'async_trait>>where
    Self: 'async_trait,
    'life0: 'async_trait,

Return health status of the node.

fn system_local_peer_id<'life0, 'async_trait>(
    &'life0 self
) -> Pin<Box<dyn Future<Output = RpcResult<String>> + Send + 'async_trait>>where
    Self: 'async_trait,
    'life0: 'async_trait,

Returns the base58-encoded PeerId of the node.

fn system_local_listen_addresses<'life0, 'async_trait>(
    &'life0 self
) -> Pin<Box<dyn Future<Output = RpcResult<Vec<String>>> + Send + 'async_trait>>where
    Self: 'async_trait,
    'life0: 'async_trait,

Returns the multi-addresses that the local node is listening on

fn system_peers<'life0, 'async_trait>(
    &'life0 self
) -> Pin<Box<dyn Future<Output = RpcResult<Vec<PeerInfo<B::Hash, <B::Header as HeaderT>::Number>>>> + Send + 'async_trait>>where
    Self: 'async_trait,
    'life0: 'async_trait,

Returns currently connected peers

fn system_network_state<'life0, 'async_trait>(
    &'life0 self
) -> Pin<Box<dyn Future<Output = RpcResult<JsonValue>> + Send + 'async_trait>>where
    Self: 'async_trait,
    'life0: 'async_trait,

Returns current state of the network.

fn system_add_reserved_peer<'life0, 'async_trait>(
    &'life0 self,
    peer: String
) -> Pin<Box<dyn Future<Output = RpcResult<()>> + Send + 'async_trait>>where
    Self: 'async_trait,
    'life0: 'async_trait,

Adds a reserved peer. Returns the empty string or an error. The string parameter should encode a p2p multiaddr.

fn system_remove_reserved_peer<'life0, 'async_trait>(
    &'life0 self,
    peer: String
) -> Pin<Box<dyn Future<Output = RpcResult<()>> + Send + 'async_trait>>where
    Self: 'async_trait,
    'life0: 'async_trait,

Remove a reserved peer. Returns the empty string or an error. The string should encode only the PeerId e.g. QmSk5HQbn6LhUwDiNMseVUjuRYhEtYj4aUZ6WfWoGURpdV.

fn system_reserved_peers<'life0, 'async_trait>(
    &'life0 self
) -> Pin<Box<dyn Future<Output = RpcResult<Vec<String>>> + Send + 'async_trait>>where
    Self: 'async_trait,
    'life0: 'async_trait,

Returns the list of reserved peers

fn system_node_roles<'life0, 'async_trait>(
    &'life0 self
) -> Pin<Box<dyn Future<Output = RpcResult<Vec<NodeRole>>> + Send + 'async_trait>>where
    Self: 'async_trait,
    'life0: 'async_trait,

Returns the roles the node is running as.

fn system_sync_state<'life0, 'async_trait>(
    &'life0 self
) -> Pin<Box<dyn Future<Output = RpcResult<SyncState<<B::Header as HeaderT>::Number>>> + Send + 'async_trait>>where
    Self: 'async_trait,
    'life0: 'async_trait,

Returns the state of the syncing of the node: starting block, current best block, highest known block.

fn system_add_log_filter(&self, directives: String) -> RpcResult<()>

Adds the supplied directives to the current log filter

fn system_reset_log_filter(&self) -> RpcResult<()>

Resets the log filter to Substrate defaults

fn into_rpc(self) -> RpcModule<Self>where
    Hash: 'static + Send + Sync + Serialize,
    Number: 'static + Send + Sync + Serialize,

Collects all the methods and subscriptions defined in the trait and adds them into a single RpcModule.