Trait sc_rpc_api::system::SystemApi

source · [−]
pub trait SystemApi<Hash, Number>: Sized + Send + Sync + 'static {

Show 17 methods    fn system_name(&self) -> SystemResult<String>;

    fn system_version(&self) -> SystemResult<String>;

    fn system_chain(&self) -> SystemResult<String>;

    fn system_type(&self) -> SystemResult<ChainType>;

    fn system_properties(&self) -> SystemResult<Properties>;

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

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

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

    fn system_peers(
        &self
    ) -> Compat<BoxFuture<'static, Result<Vec<PeerInfo<Hash, Number>>>>>;

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

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

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

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

    fn system_sync_state(&self) -> Receiver<SyncState<Number>>;

    fn system_add_log_filter(&self, directives: String) -> Result<(), Error>;

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

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

}
Expand description

Substrate system RPC API

Required methods

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

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

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

Get the chain’s type.

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

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

Returns the base58-encoded PeerId of the node.

Returns the multiaddresses that the local node is listening on

The addresses include a trailing /p2p/ with the local PeerId, and are thus suitable to be passed to system_addReservedPeer or as a bootnode address for example.

Returns currently connected peers

Returns current state of the network.

Warning: This API is not stable. Please do not programmatically interpret its output, as its format might change at any time.

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.

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

Returns the roles the node is running as.

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

Adds the supplied directives to the current log filter

The syntax is identical to the CLI <target>=<level>:

sync=debug,state=trace

Resets the log filter to Substrate defaults

Provided methods

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

Implementors