logos-messaging-rust-bindings/waku-bindings/src/node/management.rs

//! Node lifcycle [mangement](https://rfc.vac.dev/spec/36/#node-management) related methods

// std
use std::ffi::CString;
// crates
use libc::c_void;
use multiaddr::Multiaddr;
use std::sync::Arc;
use tokio::sync::Notify;
// internal
use super::config::WakuNodeConfig;
use crate::general::Result;
use crate::node::context::WakuNodeContext;
use crate::utils::LibwakuResponse;
use crate::utils::WakuDecode;
use crate::utils::{get_trampoline, handle_no_response, handle_response};

/// Instantiates a Waku node
/// as per the [specification](https://rfc.vac.dev/spec/36/#extern-char-waku_newchar-jsonconfig)
pub async fn waku_new(config: Option<WakuNodeConfig>) -> Result<WakuNodeContext> {
    let config = config.unwrap_or_default();
    let config = CString::new(
        serde_json::to_string(&config)
            .expect("Serialization from properly built NodeConfig should never fail"),
    )
    .expect("CString should build properly from the config");
    let config_ptr = config.as_ptr();

    let notify = Arc::new(Notify::new());
    let notify_clone = notify.clone();
    let mut result = LibwakuResponse::default();
    let result_cb = |r: LibwakuResponse| {
        result = r;
        notify_clone.notify_one(); // Notify that the value has been updated
    };
    let obj_ptr = unsafe {
        let mut closure = result_cb;
        let cb = get_trampoline(&closure);
        waku_sys::waku_new(config_ptr, cb, &mut closure as *mut _ as *mut c_void)
    };

    notify.notified().await; // Wait until a result is received

    match result {
        LibwakuResponse::MissingCallback => panic!("callback is required"),
        LibwakuResponse::Failure(v) => Err(v),
        _ => Ok(WakuNodeContext::new(obj_ptr)),
    }
}

pub async fn waku_destroy(ctx: &WakuNodeContext) -> Result<()> {
    let mut result = LibwakuResponse::default();
    let notify = Arc::new(Notify::new());
    let notify_clone = notify.clone();
    let result_cb = |r: LibwakuResponse| {
        result = r;
        notify_clone.notify_one(); // Notify that the value has been updated
    };
    let code = unsafe {
        let mut closure = result_cb;
        let cb = get_trampoline(&closure);
        waku_sys::waku_destroy(ctx.get_ptr(), cb, &mut closure as *mut _ as *mut c_void)
    };
    notify.notified().await; // Wait until a result is received

    handle_no_response(code, result)
}

/// 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 async fn waku_start(ctx: &WakuNodeContext) -> Result<()> {
    let mut result = LibwakuResponse::default();
    let notify = Arc::new(Notify::new());
    let notify_clone = notify.clone();
    let result_cb = |r: LibwakuResponse| {
        result = r;
        notify_clone.notify_one(); // Notify that the value has been updated
    };
    let code = unsafe {
        let mut closure = result_cb;
        let cb = get_trampoline(&closure);
        waku_sys::waku_start(ctx.get_ptr(), cb, &mut closure as *mut _ as *mut c_void)
    };

    notify.notified().await; // Wait until a result is received
    handle_no_response(code, result)
}

/// Stops a Waku node
/// as per the [specification](https://rfc.vac.dev/spec/36/#extern-char-waku_stop)
pub async fn waku_stop(ctx: &WakuNodeContext) -> Result<()> {
    let mut result = LibwakuResponse::default();
    let notify = Arc::new(Notify::new());
    let notify_clone = notify.clone();
    let result_cb = |r: LibwakuResponse| {
        result = r;
        notify_clone.notify_one(); // Notify that the value has been updated
    };
    let code = unsafe {
        let mut closure = result_cb;
        let cb = get_trampoline(&closure);
        waku_sys::waku_stop(ctx.get_ptr(), cb, &mut closure as *mut _ as *mut c_void)
    };

    notify.notified().await; // Wait until a result is received
    handle_no_response(code, result)
}

/// nwaku version
#[allow(clippy::not_unsafe_ptr_arg_deref)]
pub async fn waku_version(ctx: &WakuNodeContext) -> Result<String> {
    let mut result = LibwakuResponse::default();
    let notify = Arc::new(Notify::new());
    let notify_clone = notify.clone();
    let result_cb = |r: LibwakuResponse| {
        result = r;
        notify_clone.notify_one(); // Notify that the value has been updated
    };
    let code = unsafe {
        let mut closure = result_cb;
        let cb = get_trampoline(&closure);
        waku_sys::waku_version(ctx.get_ptr(), cb, &mut closure as *mut _ as *mut c_void)
    };

    notify.notified().await; // Wait until a result is received
    handle_response(code, result)
}

// Implement WakuDecode for Vec<Multiaddr>
impl WakuDecode for Vec<Multiaddr> {
    fn decode(input: &str) -> Result<Self> {
        input
            .split(',')
            .map(|s| s.trim().parse::<Multiaddr>().map_err(|err| err.to_string()))
            .collect::<Result<Vec<Multiaddr>>>() // Collect results into a Vec
            .map_err(|err| format!("could not parse Multiaddr: {}", err))
    }
}

/// Get the multiaddresses the Waku node is listening to
/// as per [specification](https://rfc.vac.dev/spec/36/#extern-char-waku_listen_addresses)
pub async fn waku_listen_addresses(ctx: &WakuNodeContext) -> Result<Vec<Multiaddr>> {
    let mut result = LibwakuResponse::default();
    let notify = Arc::new(Notify::new());
    let notify_clone = notify.clone();
    let result_cb = |r: LibwakuResponse| {
        result = r;
        notify_clone.notify_one(); // Notify that the value has been updated
    };

    let code = unsafe {
        let mut closure = result_cb;
        let cb = get_trampoline(&closure);
        waku_sys::waku_listen_addresses(ctx.get_ptr(), cb, &mut closure as *mut _ as *mut c_void)
    };

    notify.notified().await; // Wait until a result is received
    handle_response(code, result)
}

#[cfg(test)]
mod test {
    use super::waku_new;
    use crate::node::management::{
        waku_destroy, waku_listen_addresses, waku_start, waku_stop, waku_version,
    };
    use serial_test::serial;

    #[tokio::test]
    #[serial]
    async fn waku_flow() {
        let node = waku_new(None).await.unwrap();

        waku_start(&node).await.unwrap();

        // test addresses
        let addresses = waku_listen_addresses(&node).await.unwrap();
        dbg!(&addresses);
        assert!(!addresses.is_empty());

        waku_stop(&node).await.unwrap();
        waku_destroy(&node).await.unwrap();
    }

    #[tokio::test]
    #[serial]
    async fn nwaku_version() {
        let node = waku_new(None).await.unwrap();

        let version = waku_version(&node)
            .await
            .expect("should return the version");

        print!("Current version: {}", version);

        assert!(!version.is_empty());
        waku_destroy(&node).await.unwrap();
    }
}