Struct sc_rpc_api::system::SystemClient

pub struct SystemClient<Hash, Number> { /* fields omitted */ }

The Client.

Implementations

impl<Hash, Number> Client<Hash, Number> where
    Hash: Send + Sync + 'static + DeserializeOwned,
    Number: Send + Sync + 'static + DeserializeOwned, 

pub fn new(sender: RpcChannel) -> Self

Creates a new Client.

pub fn system_name(&self) -> impl Future<Item = String, Error = RpcError>

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

pub fn system_version(&self) -> impl Future<Item = String, Error = RpcError>

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

pub fn system_chain(&self) -> impl Future<Item = String, Error = RpcError>

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

pub fn system_type(&self) -> impl Future<Item = ChainType, Error = RpcError>

Get the chain’s type.

pub fn system_properties(
    &self
) -> impl Future<Item = Properties, Error = RpcError>

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

pub fn system_health(&self) -> impl Future<Item = Health, Error = RpcError>

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

pub fn system_local_peer_id(
    &self
) -> impl Future<Item = String, Error = RpcError>

Returns the base58-encoded PeerId of the node.

pub fn system_local_listen_addresses(
    &self
) -> impl Future<Item = Vec<String>, Error = RpcError>

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.

pub fn system_peers(
    &self
) -> impl Future<Item = Vec<PeerInfo<Hash, Number>>, Error = RpcError>

Returns currently connected peers

pub fn system_network_state(
    &self
) -> impl Future<Item = Value, Error = RpcError>

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.

pub fn system_add_reserved_peer(
    &self,
    peer: String
) -> impl Future<Item = (), Error = RpcError>

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.

pub fn system_remove_reserved_peer(
    &self,
    peer_id: String
) -> impl Future<Item = (), Error = RpcError>

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

pub fn system_reserved_peers(
    &self
) -> impl Future<Item = Vec<String>, Error = RpcError>

Returns the list of reserved peers

pub fn system_node_roles(
    &self
) -> impl Future<Item = Vec<NodeRole>, Error = RpcError>

Returns the roles the node is running as.

pub fn system_sync_state(
    &self
) -> impl Future<Item = SyncState<Number>, Error = RpcError>

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

pub fn system_add_log_filter(
    &self,
    directives: String
) -> impl Future<Item = (), Error = RpcError>

Adds the supplied directives to the current log filter

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

sync=debug,state=trace

pub fn system_reset_log_filter(
    &self
) -> impl Future<Item = (), Error = RpcError>

Resets the log filter to Substrate defaults

Trait Implementations

impl<Hash: Clone, Number: Clone> Clone for Client<Hash, Number>

fn clone(&self) -> Client<Hash, Number>

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<Hash, Number> From<RpcChannel> for Client<Hash, Number> where
    Hash: Send + Sync + 'static + DeserializeOwned,
    Number: Send + Sync + 'static + DeserializeOwned, 

fn from(channel: RpcChannel) -> Self

Performs the conversion.