Implemented waku management functions

This commit is contained in:
Daniel Sanchez Quiros 2022-09-29 18:46:05 +02:00
parent 438b68aa41
commit 710db3aa07
2 changed files with 119 additions and 3 deletions

View File

@ -18,10 +18,10 @@ pub(crate) enum JsonResponse<T> {
}
/// Waku response, just a `Result` with an `String` error.
/// Convenient we can transform a [`JsonResponse`] into a [`Response`] (`Result`)
type Response<T> = Result<T, String>;
/// Convenient we can transform a [`JsonResponse`] into a [`std::result::Result`]
pub type Result<T> = std::result::Result<T, String>;
impl<T> From<JsonResponse<T>> for Response<T> {
impl<T> From<JsonResponse<T>> for Result<T> {
fn from(response: JsonResponse<T>) -> Self {
match response {
JsonResponse::Result(t) => Ok(t),

View File

@ -0,0 +1,116 @@
// std
use multiaddr::Multiaddr;
use std::ffi::{CStr, CString};
// crates
// internal
use super::config::NodeConfig;
use crate::general::{JsonResponse, Result};
/// Instantiates a Waku node
/// as per the [specification](https://rfc.vac.dev/spec/36/#extern-char-waku_newchar-jsonconfig)
pub fn waku_new(config: &NodeConfig) -> Result<bool> {
let s_config = serde_json::to_string(config)
.expect("Serialization from properly built NodeConfig should never fail");
let result: &str = unsafe {
CStr::from_ptr(waku_sys::waku_new(
CString::new(s_config)
.expect("CString should build properly from the serialized node config")
.into_raw(),
))
}
.to_str()
.expect("Response should always succeed to load to a &str");
let json_response: JsonResponse<bool> =
serde_json::from_str(result).expect("JsonResponse should always succeed to deserialize");
json_response.into()
}
/// Start a Waku node mounting all the protocols that were enabled during the Waku node instantiation.
/// as per the [specification](https://rfc.vac.dev/spec/36/#extern-char-waku_start)
pub fn waku_start() -> Result<bool> {
let response = unsafe { CStr::from_ptr(waku_sys::waku_start()) }
.to_str()
.expect("Response should always succeed to load to a &str");
let json_response: JsonResponse<bool> =
serde_json::from_str(response).expect("JsonResponse should always succeed to deserialize");
json_response.into()
}
/// Stops a Waku node
/// as per the [specification](https://rfc.vac.dev/spec/36/#extern-char-waku_stop)
pub fn waku_stop() -> Result<bool> {
let response = unsafe { CStr::from_ptr(waku_sys::waku_start()) }
.to_str()
.expect("Response should always succeed to load to a &str");
let json_response: JsonResponse<bool> =
serde_json::from_str(response).expect("JsonResponse should always succeed to deserialize");
json_response.into()
}
/// If the execution is successful, the result is the peer ID as a string (base58 encoded)
/// as per the [specification](https://rfc.vac.dev/spec/36/#extern-char-waku_stop)
pub fn waku_peer_id() -> Result<String> {
let response = unsafe { CStr::from_ptr(waku_sys::waku_peerid()) }
.to_str()
.expect("Response should always succeed to load to a &str");
let json_response: JsonResponse<String> =
serde_json::from_str(response).expect("JsonResponse should always succeed to deserialize");
json_response.into()
}
/// Get the multiaddresses the Waku node is listening to
/// as per [specification](https://rfc.vac.dev/spec/36/#extern-char-waku_listen_addresses)
pub fn waku_listen_addressses() -> Result<Vec<Multiaddr>> {
let response = unsafe { CStr::from_ptr(waku_sys::waku_listen_addresses()) }
.to_str()
.expect("Response should always succeed to load to a &str");
let json_response: JsonResponse<Vec<Multiaddr>> =
serde_json::from_str(response).expect("JsonResponse should always succeed to deserialize");
json_response.into()
}
#[cfg(test)]
mod test {
use super::waku_new;
use crate::node_management::node::{
waku_listen_addressses, waku_peer_id, waku_start, waku_stop,
};
#[test]
fn waku_new_default() {
let config = Default::default();
assert!(waku_new(&config).unwrap());
}
#[test]
fn waku_flow() {
let config = Default::default();
waku_new(&config).unwrap();
waku_start().unwrap();
waku_stop().unwrap();
}
#[test]
fn waku_id() {
let config = Default::default();
waku_new(&config).unwrap();
let id = waku_peer_id().unwrap();
dbg!(&id);
assert!(!id.is_empty());
}
#[test]
fn waku_address() {
let config = Default::default();
waku_new(&config).unwrap();
let addresses = waku_listen_addressses().unwrap();
dbg!(&addresses);
assert!(!addresses.is_empty());
}
}