Struct sc_rpc::system::System

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

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> SystemApi<<B as Block>::Hash, <<B as Block>::Header as Header>::Number> for System<B>

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

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

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

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

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

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

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

Get the chain’s type.

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

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

fn system_health(&self) -> Receiver<Health>

Return health status of the node.

fn system_local_peer_id(&self) -> Receiver<String>

Returns the base58-encoded PeerId of the node.

fn system_local_listen_addresses(&self) -> Receiver<Vec<String>>

Returns the multiaddresses that the local node is listening on

fn system_peers(
    &self
) -> Compat<BoxFuture<'static, Result<Vec<PeerInfo<B::Hash, <B::Header as HeaderT>::Number>>>>>

Returns currently connected peers

fn system_network_state(&self) -> Compat<BoxFuture<'static, Result<Value>>>

Returns current state of the network.

fn system_add_reserved_peer(
    &self,
    peer: String
) -> Compat<BoxFuture<'static, Result<(), Error>>>

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

fn system_remove_reserved_peer(
    &self,
    peer: String
) -> Compat<BoxFuture<'static, Result<(), Error>>>

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

fn system_node_roles(&self) -> Receiver<Vec<NodeRole>>

Returns the roles the node is running as.

fn system_sync_state(
    &self
) -> Receiver<SyncState<<B::Header as HeaderT>::Number>>

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) -> Result<(), Error>

Adds the supplied directives to the current log filter

fn system_reset_log_filter(&self) -> Result<(), Error>

Resets the log filter to Substrate defaults

pub fn to_delegate<M>(self) -> IoDelegate<Self, M> where
    Hash: Send + Sync + 'static + Serialize,
    Number: Send + Sync + 'static + Serialize,
    M: Metadata, 

Create an IoDelegate, wiring rpc calls to the trait methods.