1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278
#![warn(missing_docs)]
//! # ring-node-client
//!
//! ring-node-client is a command-line tool for interacting with the Ring Node backend API. It allows users to establish WebRTC connections with remote peers, send and receive messages, and publish and subscribe to topics.
//!
//! ## Usage
//!
//! To use ring-node-client, simply create a new instance of the Client struct, passing in the endpoint URL and signature as arguments. Then, use the various methods on the Client instance to perform the desired actions.
//!
//! # Features
//!
//! - Establish WebRTC connections with remote peers using HTTP as a signaling channel.
//! - Send and receive messages using WebRTC.
//! - Publish and subscribe to topics.
//! - Register and lookup DIDs of services.
//! - Send HTTP requests to remote peers.
//! - Load a seed file to establish a connection with a remote peer.
use std::time::Duration;
use async_stream::stream;
use futures::pin_mut;
use futures::select;
use futures::FutureExt;
use futures::Stream;
use futures_timer::Delay;
use serde_json::json;
use crate::prelude::http;
use crate::prelude::rings_core::inspect::SwarmInspect;
use crate::prelude::rings_core::session::SessionSk;
use crate::prelude::rings_rpc::client::Client as RpcClient;
use crate::prelude::rings_rpc::types::Timeout;
use crate::seed::Seed;
use crate::util::loader::ResourceLoader;
/// Alias about Result<ClientOutput<T>, E>.
type Output<T> = anyhow::Result<ClientOutput<T>>;
/// Wrap json_client send request between nodes or browsers.
pub struct Client {
client: RpcClient,
}
/// Wrap client output contain raw result and humanreadable display.
pub struct ClientOutput<T> {
/// Output data.
pub result: T,
display: String,
}
impl Client {
/// Creates a new Client instance with the specified endpoint URL and signature.
pub fn new(endpoint_url: &str, session_sk: SessionSk) -> anyhow::Result<Self> {
let rpc_client = RpcClient::new(endpoint_url, Some(session_sk));
Ok(Self { client: rpc_client })
}
/// Establishes a WebRTC connection with a remote peer using HTTP as the signaling channel.
///
/// This function allows two peers to establish a WebRTC connection using HTTP,
/// which can be useful in scenarios where a direct peer-to-peer connection is not possible due to firewall restrictions or other network issues.
/// The function sends ICE candidates and Session Description Protocol (SDP) messages over HTTP as a form of signaling to establish the connection.
///
/// Takes a URL for an HTTP server that will be used as the signaling channel to exchange ICE candidates and SDP with the remote peer.
/// Returns a Did that can be used to refer to this connection in subsequent WebRTC operations.
pub async fn connect_peer_via_http(&mut self, http_url: &str) -> Output<String> {
let peer_did = self
.client
.connect_peer_via_http(http_url)
.await
.map_err(|e| anyhow::anyhow!("{}", e))?;
ClientOutput::ok(format!("Remote did: {}", peer_did), peer_did)
}
/// Attempts to connect to a peer using a seed file located at the specified source path.
pub async fn connect_with_seed(&mut self, source: &str) -> Output<()> {
let seed = Seed::load(source).await?;
let seed_v = serde_json::to_value(seed).map_err(|_| anyhow::anyhow!("serialize failed"))?;
self.client
.connect_with_seed(&[seed_v])
.await
.map_err(|e| anyhow::anyhow!("{}", e))?;
ClientOutput::ok("Successful!".to_string(), ())
}
/// Attempts to connect to a peer using a DID stored in a Distributed Hash Table (DHT).
pub async fn connect_with_did(&mut self, did: &str) -> Output<()> {
self.client
.connect_with_did(did)
.await
.map_err(|e| anyhow::anyhow!("{}", e))?;
ClientOutput::ok("Successful!".to_owned(), ())
}
/// Lists all connected peers and their status.
///
/// Returns an Output containing a formatted string representation of the list of peers if successful, or an anyhow::Error if an error occurred.
pub async fn list_peers(&mut self) -> Output<()> {
let peers = self
.client
.list_peers()
.await
.map_err(|e| anyhow::anyhow!("{}", e))?;
let mut display = String::new();
display.push_str("Did, TransportId, Status\n");
display.push_str(
peers
.iter()
.map(|peer| format!("{}, {}, {}", peer.did, peer.did, peer.state))
.collect::<Vec<_>>()
.join("\n")
.as_str(),
);
ClientOutput::ok(display, ())
}
/// Disconnects from the peer with the specified DID.
pub async fn disconnect(&mut self, did: &str) -> Output<()> {
self.client
.disconnect(did)
.await
.map_err(|e| anyhow::anyhow!("{}", e))?;
ClientOutput::ok("Done.".into(), ())
}
/// Sends a message to the specified peer.
pub async fn send_message(&self, did: &str, text: &str) -> Output<()> {
let mut params = serde_json::Map::new();
params.insert("destination".to_owned(), json!(did));
params.insert("text".to_owned(), json!(text));
self.client
.send_message(did, text)
.await
.map_err(|e| anyhow::anyhow!("{}", e))?;
ClientOutput::ok("Done.".into(), ())
}
/// Sends a custom message to the specified peer.
pub async fn send_custom_message(
&self,
did: &str,
message_type: u16,
data: &str,
) -> Output<()> {
self.client
.send_custom_message(did, message_type, data)
.await
.map_err(|e| anyhow::anyhow!("{}", e))?;
ClientOutput::ok("Done.".into(), ())
}
/// Sends an HTTP request message to the specified peer.
#[allow(clippy::too_many_arguments)]
pub async fn send_http_request_message(
&self,
did: &str,
name: &str,
method: http::Method,
url: &str,
timeout: Timeout,
headers: &[(&str, &str)],
body: Option<String>,
) -> Output<()> {
self.client
.send_http_request_message(did, name, method, url, timeout, headers, body)
.await
.map_err(|e| anyhow::anyhow!("{}", e))?;
ClientOutput::ok("Done.".into(), ())
}
/// Sends a simple text message to the specified peer.
pub async fn send_simple_text_message(&self, did: &str, text: &str) -> Output<()> {
self.client
.send_simple_text_message(did, text)
.await
.map_err(|e| anyhow::anyhow!("{}", e))?;
ClientOutput::ok("Done.".into(), ())
}
/// Registers a new service with the given name.
pub async fn register_service(&self, name: &str) -> Output<()> {
self.client
.register_service(name)
.await
.map_err(|e| anyhow::anyhow!("{}", e))?;
ClientOutput::ok("Done.".into(), ())
}
/// Looks up the DIDs of services registered with the given name.
pub async fn lookup_service(&self, name: &str) -> Output<()> {
let dids = self
.client
.lookup_service(name)
.await
.map_err(|e| anyhow::anyhow!("{}", e))?;
ClientOutput::ok(dids.join("\n"), ())
}
/// Publishes a message to the specified topic.
pub async fn publish_message_to_topic(&self, topic: &str, data: &str) -> Output<()> {
self.client
.publish_message_to_topic(topic, data)
.await
.map_err(|e| anyhow::anyhow!("{}", e))?;
ClientOutput::ok("Done.".into(), ())
}
/// Subscribes to the specified topic and returns a stream of messages published to the topic.
pub async fn subscribe_topic<'a, 'b>(
&'a self,
topic: String,
) -> impl Stream<Item = String> + 'b
where
'a: 'b,
{
let mut index = 0;
stream! {
loop {
let timeout = Delay::new(Duration::from_secs(5)).fuse();
pin_mut!(timeout);
select! {
_ = timeout => {
let result = self
.client
.fetch_topic_messages(topic.as_str(), index)
.await;
if let Err(e) = result {
tracing::error!("Failed to fetch messages of topic: {}, {}", topic, e);
continue;
}
let messages = result.unwrap();
for msg in messages.iter().cloned() {
yield msg
}
index += messages.len();
}
}
}
}
}
/// Query for swarm inspect info.
pub async fn inspect(&self) -> Output<SwarmInspect> {
let info = self
.client
.inspect()
.await
.map_err(|e| anyhow::anyhow!("{}", e))?;
let display =
serde_json::to_string_pretty(&info.swarm).map_err(|e| anyhow::anyhow!("{}", e))?;
ClientOutput::ok(display, info.swarm)
}
}
impl<T> ClientOutput<T> {
/// Put display ahead to avoid moved value error.
pub fn ok(display: String, result: T) -> anyhow::Result<Self> {
Ok(Self { result, display })
}
/// Prints the display value of this ClientOutput instance to the console.
pub fn display(&self) {
println!("{}", self.display);
}
}