//! Sbot type and associated methods. use async_std::net::TcpStream; use kuska_handshake::async_std::BoxStream; use kuska_sodiumoxide::crypto::{auth, sign::ed25519}; use kuska_ssb::{ api::{ dto::{CreateHistoryStreamIn}, ApiCaller, }, discovery, keystore, keystore::OwnedIdentity, rpc::{RpcReader, RpcWriter}, }; use crate::error::GolgiError; use crate::messages::{SsbKVT, SsbMessageContent, SsbMessageValue, SsbMessageContentType}; use crate::utils; // re-export types from kuska pub use kuska_ssb::api::dto::content::SubsetQuery; /// The Scuttlebutt identity, keys and configuration parameters for connecting to a local sbot /// instance, as well as handles for calling RPC methods and receiving responses. pub struct Sbot { id: String, public_key: ed25519::PublicKey, private_key: ed25519::SecretKey, address: String, // aka caps key (scuttleverse identifier) network_id: auth::Key, client: ApiCaller, rpc_reader: RpcReader, } impl Sbot { /// Initiate a connection with an sbot instance. Define the IP address, port and network key /// for the sbot, then retrieve the public key, private key (secret) and identity from the /// `.ssb-go/secret` file. Open a TCP stream to the sbot and perform the secret handshake. If successful, create a box stream and split it into a writer and reader. Return RPC handles to the sbot as part of the `struct` output. pub async fn init(ip_port: Option, net_id: Option) -> Result { let address = if ip_port.is_none() { "127.0.0.1:8008".to_string() } else { ip_port.unwrap() }; let network_id = if net_id.is_none() { discovery::ssb_net_id() } else { auth::Key::from_slice(&hex::decode(net_id.unwrap()).unwrap()).unwrap() }; let OwnedIdentity { pk, sk, id } = keystore::from_gosbot_local() .await .expect("couldn't read local secret"); let socket = TcpStream::connect(&address) .await .map_err(|source| GolgiError::Io { source, context: "socket error; failed to initiate tcp stream connection".to_string(), })?; let handshake = kuska_handshake::async_std::handshake_client( &mut &socket, network_id.clone(), pk, sk.clone(), pk, ) .await .map_err(GolgiError::Handshake)?; let (box_stream_read, box_stream_write) = BoxStream::from_handshake(socket.clone(), socket, handshake, 0x8000).split_read_write(); let rpc_reader = RpcReader::new(box_stream_read); let client = ApiCaller::new(RpcWriter::new(box_stream_write)); Ok(Self { id, public_key: pk, private_key: sk, address, network_id, client, rpc_reader, }) } /// Call the `partialReplication getSubset` RPC method and return a vector /// of messages as KVTs (key, value, timestamp). // TODO: add args for `descending` and `page` (max number of msgs in response) pub async fn get_subset(&mut self, query: SubsetQuery) -> Result, GolgiError> { let req_id = self.client.getsubset_req_send(query).await?; utils::get_async_until_eof(&mut self.rpc_reader, req_id, utils::kvt_res_parse).await } /// Call the `whoami` RPC method and return an `id`. pub async fn whoami(&mut self) -> Result { let req_id = self.client.whoami_req_send().await?; utils::get_async(&mut self.rpc_reader, req_id, utils::string_res_parse).await } /// Call the `createLogStream` RPC method and return a Vec pub async fn log(&mut self) -> Result { let req_id = self.client.log_req_send().await?; utils::get_async(&mut self.rpc_reader, req_id, utils::string_res_parse).await } /// Call the `publish` RPC method and return a message reference. /// /// # Arguments /// /// * `msg` - A `SsbMessageContent` `enum` whose variants include `Pub`, `Post`, `Contact`, `About`, /// `Channel` and `Vote`. See the `kuska_ssb` documentation for further details such as field /// names and accepted values for each variant. pub async fn publish(&mut self, msg: SsbMessageContent) -> Result { let req_id = self.client.publish_req_send(msg).await?; utils::get_async(&mut self.rpc_reader, req_id, utils::string_res_parse).await } /// Wrapper for publish which constructs and publishes a post message appropriately from a string. /// /// # Arguments /// /// * `text` - A reference to a string slice which represents the text to be published in the post pub async fn publish_post(&mut self, text: &str) -> Result { let msg = SsbMessageContent::Post { text: text.to_string(), mentions: None, }; self.publish(msg).await } /// Wrapper for publish which constructs and publishes an about description message appropriately from a string. /// /// # Arguments /// /// * `description` - A reference to a string slice which represents the text to be published as an about description. pub async fn publish_description(&mut self, description: &str) -> Result { let msg = SsbMessageContent::About { about: self.id.to_string(), name: None, title: None, branch: None, image: None, description: Some(description.to_string()), location: None, start_datetime: None, }; self.publish(msg).await } /// Get the about messages for a particular user in order of recency. pub async fn get_about_messages(&mut self, ssb_id: String) -> Result, GolgiError> { let query = SubsetQuery::Author{ op: "author".to_string(), feed: self.id.to_string(), }; let kvts: Vec = self.get_subset(query).await?; let messages: Vec = kvts.into_iter().map(|kvt| kvt.value).collect(); // TODO: after fixing sbot regression, // change this subset query to filter by type about in addition to author // and remove this filter section // filter down to about messages let mut about_messages: Vec = messages.into_iter().filter(|msg| { msg.is_message_type(SsbMessageContentType::About) }).collect(); // TODO: use subset query to order messages instead of doing it this way about_messages.sort_by(|a, b| { a.timestamp.partial_cmp(&b.timestamp).unwrap() }); // return about messages Ok(about_messages) } /// Get the latest description for a particular user from their about messages. pub async fn get_description(&mut self, ssb_id: String) -> Result { // vector of about messages with most recent at the front of the vector let about_messages = self.get_about_messages(ssb_id).await?; // iterate through the vector looking for an about message with a description // the first one we find is th emost recnet for msg in about_messages { let about_message = msg.into_ssb_message_content()?; match about_message { SsbMessageContent::About{description, ..} => { match description { Some(description_text) => { return Ok(description_text) }, None => { continue } } }, _ => {} } } // if no about message with a description was found, then return the empty string Ok("".to_string()) } /// Call the `createHistoryStream` RPC method and return a vector /// of SsbMessageValue. pub async fn create_history_stream( &mut self, id: String, ) -> Result, GolgiError> { let args = CreateHistoryStreamIn::new(id); let req_id = self.client.create_history_stream_req_send(&args).await?; utils::get_async_until_eof(&mut self.rpc_reader, req_id, utils::ssb_message_res_parse).await } }