Struct sc_rpc_api::system::SystemClient
source · [−]pub struct SystemClient<Hash, Number> { /* private fields */ }Expand description
The Client.
Implementations
sourceimpl<Hash, Number> Client<Hash, Number> where
Hash: Send + Sync + 'static + DeserializeOwned,
Number: Send + Sync + 'static + DeserializeOwned,
impl<Hash, Number> Client<Hash, Number> where
Hash: Send + Sync + 'static + DeserializeOwned,
Number: Send + Sync + 'static + DeserializeOwned,
sourcepub fn new(sender: RpcChannel) -> Self
pub fn new(sender: RpcChannel) -> Self
Creates a new Client.
sourcepub fn system_name(&self) -> impl Future<Item = String, Error = RpcError>
pub fn system_name(&self) -> impl Future<Item = String, Error = RpcError>
Get the node’s implementation name. Plain old string.
sourcepub fn system_version(&self) -> impl Future<Item = String, Error = RpcError>
pub fn system_version(&self) -> impl Future<Item = String, Error = RpcError>
Get the node implementation’s version. Should be a semver string.
sourcepub fn system_chain(&self) -> impl Future<Item = String, Error = RpcError>
pub fn system_chain(&self) -> impl Future<Item = String, Error = RpcError>
Get the chain’s name. Given as a string identifier.
sourcepub fn system_type(&self) -> impl Future<Item = ChainType, Error = RpcError>
pub fn system_type(&self) -> impl Future<Item = ChainType, Error = RpcError>
Get the chain’s type.
sourcepub fn system_properties(
&self
) -> impl Future<Item = Properties, Error = RpcError>
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.
sourcepub fn system_health(&self) -> impl Future<Item = Health, Error = RpcError>
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
sourcepub fn system_local_peer_id(
&self
) -> impl Future<Item = String, Error = RpcError>
pub fn system_local_peer_id(
&self
) -> impl Future<Item = String, Error = RpcError>
Returns the base58-encoded PeerId of the node.
sourcepub fn system_local_listen_addresses(
&self
) -> impl Future<Item = Vec<String>, Error = RpcError>
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.
sourcepub fn system_peers(
&self
) -> impl Future<Item = Vec<PeerInfo<Hash, Number>>, Error = RpcError>
pub fn system_peers(
&self
) -> impl Future<Item = Vec<PeerInfo<Hash, Number>>, Error = RpcError>
Returns currently connected peers
sourcepub fn system_network_state(
&self
) -> impl Future<Item = Value, Error = RpcError>
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.
sourcepub fn system_add_reserved_peer(
&self,
peer: String
) -> impl Future<Item = (), Error = RpcError>
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.
sourcepub fn system_remove_reserved_peer(
&self,
peer_id: String
) -> impl Future<Item = (), Error = RpcError>
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.
sourcepub fn system_node_roles(
&self
) -> impl Future<Item = Vec<NodeRole>, Error = RpcError>
pub fn system_node_roles(
&self
) -> impl Future<Item = Vec<NodeRole>, Error = RpcError>
Returns the roles the node is running as.
sourcepub fn system_sync_state(
&self
) -> impl Future<Item = SyncState<Number>, Error = RpcError>
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.
sourcepub fn system_add_log_filter(
&self,
directives: String
) -> impl Future<Item = (), Error = RpcError>
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
sourcepub fn system_reset_log_filter(
&self
) -> impl Future<Item = (), Error = RpcError>
pub fn system_reset_log_filter(
&self
) -> impl Future<Item = (), Error = RpcError>
Resets the log filter to Substrate defaults
Trait Implementations
sourceimpl<Hash, Number> From<RpcChannel> for Client<Hash, Number> where
Hash: Send + Sync + 'static + DeserializeOwned,
Number: Send + Sync + 'static + DeserializeOwned,
impl<Hash, Number> From<RpcChannel> for Client<Hash, Number> where
Hash: Send + Sync + 'static + DeserializeOwned,
Number: Send + Sync + 'static + DeserializeOwned,
sourcefn from(channel: RpcChannel) -> Self
fn from(channel: RpcChannel) -> Self
Performs the conversion.
Auto Trait Implementations
impl<Hash, Number> !RefUnwindSafe for Client<Hash, Number>
impl<Hash, Number> Send for Client<Hash, Number> where
Hash: Send,
Number: Send,
impl<Hash, Number> Sync for Client<Hash, Number> where
Hash: Sync,
Number: Sync,
impl<Hash, Number> Unpin for Client<Hash, Number> where
Hash: Unpin,
Number: Unpin,
impl<Hash, Number> !UnwindSafe for Client<Hash, Number>
Blanket Implementations
sourceimpl<T> BorrowMut<T> for T where
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
const: unstable · sourcepub fn borrow_mut(&mut self) -> &mut T
pub fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
sourceimpl<T> CheckedConversion for T
impl<T> CheckedConversion for T
sourcefn checked_from<T>(t: T) -> Option<Self> where
Self: TryFrom<T>,
fn checked_from<T>(t: T) -> Option<Self> where
Self: TryFrom<T>,
Convert from a value of T into an equivalent instance of Option<Self>. Read more
sourcefn checked_into<T>(self) -> Option<T> where
Self: TryInto<T>,
fn checked_into<T>(self) -> Option<T> where
Self: TryInto<T>,
Consume self to return Some equivalent value of Option<T>. Read more
sourceimpl<T> Instrument for T
impl<T> Instrument for T
sourcefn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
Instruments this type with the provided Span, returning an
Instrumented wrapper. Read more
sourcefn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
sourceimpl<T> Instrument for T
impl<T> Instrument for T
sourcefn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
Instruments this type with the provided Span, returning an
Instrumented wrapper. Read more
sourcefn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
sourceimpl<T, Outer> IsWrappedBy<Outer> for T where
Outer: AsRef<T> + AsMut<T> + From<T>,
T: From<Outer>,
impl<T, Outer> IsWrappedBy<Outer> for T where
Outer: AsRef<T> + AsMut<T> + From<T>,
T: From<Outer>,
sourceimpl<T> SaturatedConversion for T
impl<T> SaturatedConversion for T
sourcefn saturated_from<T>(t: T) -> Self where
Self: UniqueSaturatedFrom<T>,
fn saturated_from<T>(t: T) -> Self where
Self: UniqueSaturatedFrom<T>,
Convert from a value of T into an equivalent instance of Self. Read more
sourcefn saturated_into<T>(self) -> T where
Self: UniqueSaturatedInto<T>,
fn saturated_into<T>(self) -> T where
Self: UniqueSaturatedInto<T>,
Consume self to return an equivalent value of T. Read more
sourceimpl<T> ToOwned for T where
T: Clone,
impl<T> ToOwned for T where
T: Clone,
type Owned = T
type Owned = T
The resulting type after obtaining ownership.
sourcepub fn to_owned(&self) -> T
pub fn to_owned(&self) -> T
Creates owned data from borrowed data, usually by cloning. Read more
sourcepub fn clone_into(&self, target: &mut T)
pub fn clone_into(&self, target: &mut T)
toowned_clone_into)Uses borrowed data to replace owned data, usually by cloning. Read more
sourceimpl<S, T> UncheckedInto<T> for S where
T: UncheckedFrom<S>,
impl<S, T> UncheckedInto<T> for S where
T: UncheckedFrom<S>,
sourcepub fn unchecked_into(self) -> T
pub fn unchecked_into(self) -> T
The counterpart to unchecked_from.
sourceimpl<T, S> UniqueSaturatedInto<T> for S where
T: Bounded,
S: TryInto<T>,
impl<T, S> UniqueSaturatedInto<T> for S where
T: Bounded,
S: TryInto<T>,
sourcepub fn unique_saturated_into(self) -> T
pub fn unique_saturated_into(self) -> T
Consume self to return an equivalent value of T.
sourceimpl<T> WithSubscriber for T
impl<T> WithSubscriber for T
sourcefn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,
fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,
Attaches the provided Subscriber to this type, returning a
WithDispatch wrapper. Read more
sourcefn with_current_subscriber(self) -> WithDispatch<Self>
fn with_current_subscriber(self) -> WithDispatch<Self>
Attaches the current default Subscriber to this type, returning a
WithDispatch wrapper. Read more