Struct smoldot_full_node::Client

pub struct Client { /* private fields */ }

Running client. As long as this object is alive, the client reads/writes the database and has a JSON-RPC server open.

Implementations

impl Client

pub fn json_rpc_server_addr(&self) -> Option<SocketAddr>

Returns the address the JSON-RPC server is listening on.

Returns None if and only if ChainConfig::json_rpc_listen was None in Config::chain.

pub fn relay_chain_json_rpc_server_addr(&self) -> Option<SocketAddr>

Returns the address the relay chain JSON-RPC server is listening on.

Returns None if and only if Config::relay_chain was None or if ChainConfig::json_rpc_listen was None in Config::relay_chain.

pub async fn network_known_best(&self) -> Option<u64>

Returns the best block according to the networking.

pub async fn num_peers(&self) -> u64

Returns the current total number of peers of the client.

pub async fn num_network_connections(&self) -> u64

Returns the current total number of network connections of the client.

pub async fn sync_state(&self) -> SyncState

pub async fn relay_chain_sync_state(&self) -> Option<SyncState>

pub fn send_json_rpc_request(&self, request: String)

Adds a JSON-RPC request to the queue of requests of the virtual endpoint of the chain.

The virtual endpoint doesn’t have any limit.

pub async fn next_json_rpc_response(&self) -> String

Returns the new JSON-RPC response or notification for requests sent using Client::send_json_rpc_request.

If this function is called multiple times simultaneously, only one invocation will receive each response. Which one is unspecified.

pub fn relay_chain_send_json_rpc_request( &self, request: String, ) -> Result<(), RelayChainSendJsonRpcRequestError>

Adds a JSON-RPC request to the queue of requests of the virtual endpoint of the relay chain.

The virtual endpoint doesn’t have any limit.

pub async fn relay_chain_next_json_rpc_response(&self) -> String

Returns the new JSON-RPC response or notification for requests sent using Client::relay_chain_send_json_rpc_request.

If this function is called multiple times simultaneously, only one invocation will receive each response. Which one is unspecified.

If Config::relay_chain was None, this function waits indefinitely.