266 lines
10 KiB
Rust
266 lines
10 KiB
Rust
//! 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::{SsbMessageKVT, 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<TcpStream>,
|
|
rpc_reader: RpcReader<TcpStream>,
|
|
}
|
|
|
|
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<String>, net_id: Option<String>) -> Result<Sbot, GolgiError> {
|
|
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<Vec<SsbMessageKVT>, GolgiError> {
|
|
let req_id = self.client.getsubset_req_send(query).await?;
|
|
|
|
utils::get_source_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<String, GolgiError> {
|
|
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 `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<String, GolgiError> {
|
|
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<String, GolgiError> {
|
|
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<String, GolgiError> {
|
|
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
|
|
}
|
|
|
|
/// Wrapper for publish which constructs and publishes an about name message appropriately from a string.
|
|
///
|
|
/// # Arguments
|
|
///
|
|
/// * `name` - A reference to a string slice which represents the text to be published as an about name.
|
|
pub async fn publish_name(&mut self, name: &str) -> Result<String, GolgiError> {
|
|
let msg = SsbMessageContent::About {
|
|
about: self.id.to_string(),
|
|
name: Some(name.to_string()),
|
|
title: None,
|
|
branch: None,
|
|
image: None,
|
|
description: None,
|
|
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: &str) -> Result<Vec<SsbMessageValue>, GolgiError> {
|
|
let query = SubsetQuery::Author{
|
|
op: "author".to_string(),
|
|
feed: ssb_id.to_string(),
|
|
};
|
|
let kvts: Vec<SsbMessageKVT> = self.get_subset(query).await?;
|
|
let messages: Vec<SsbMessageValue> = 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<SsbMessageValue> = 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| {
|
|
b.timestamp.partial_cmp(&a.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: &str) -> Result<Option<String>, GolgiError> {
|
|
// 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(Some(description_text))
|
|
},
|
|
None => {
|
|
continue
|
|
}
|
|
}
|
|
},
|
|
_ => {}
|
|
}
|
|
}
|
|
// if no about message with a description was found, then return the empty string
|
|
Ok(None)
|
|
}
|
|
|
|
/// Get value of latest about message with given key from given user
|
|
pub async fn get_latest_about_message(&mut self, ssb_id: &str, key: &str) -> Result<Option<String>, GolgiError> {
|
|
// 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 the given key
|
|
// the first one we find is the most recent
|
|
for msg in about_messages {
|
|
let value = msg.content.get(key);
|
|
match value {
|
|
Some(val) => {
|
|
let val_as_str_option = val.as_str();
|
|
match val_as_str_option {
|
|
Some(val_as_str) => {
|
|
return Ok(Some(val_as_str.to_string()))
|
|
},
|
|
None => {
|
|
// if it is an improperly formatted field (not a string)
|
|
// then just continue
|
|
continue
|
|
}
|
|
}
|
|
},
|
|
None => {
|
|
continue
|
|
}
|
|
}
|
|
}
|
|
// if no about message with given key was found, then return None
|
|
Ok(None)
|
|
}
|
|
|
|
pub async fn get_name(&mut self, ssb_id: &str) -> Result<Option<String>, GolgiError> {
|
|
self.get_latest_about_message(ssb_id, "name").await
|
|
}
|
|
|
|
/// Call the `createHistoryStream` RPC method and return a vector
|
|
/// of SsbMessageValue.
|
|
pub async fn create_history_stream(
|
|
&mut self,
|
|
id: String,
|
|
) -> Result<Vec<SsbMessageValue>, GolgiError> {
|
|
let args = CreateHistoryStreamIn::new(id);
|
|
let req_id = self.client.create_history_stream_req_send(&args).await?;
|
|
utils::get_source_until_eof(&mut self.rpc_reader, req_id, utils::ssb_message_res_parse).await
|
|
}
|
|
}
|