nostr_rust

An ergonomic, Nostr API Client for Rust.

• Changelog

Example

This example uses Tungstenite for event handling, so your Cargo.toml could look like this:

[dependencies]
nostr_rust = "0.5"
tungstenite = "0.17"

And then the code:

use std::{
    str::FromStr,
    sync::{Arc, Mutex},
    thread,
};
use tungstenite::Message;

use nostr_rust::{nostr_client::Client, req::ReqFilter, Identity};

fn handle_message(relay_url: &String, message: &Message) -> Result<(), String> {
    println!("Received message from {}: {:?}", relay_url, message);

    Ok(())
}

fn main() {
    let my_identity =
        Identity::from_str("your private key as hex string")
            .unwrap();

    let nostr_client = Arc::new(Mutex::new(
        Client::new(vec!["wss://relay.nostr.info"]).unwrap(),
    ));

    // Run a new thread to handle messages
    let nostr_clone = nostr_client.clone();
    let handle_thread = thread::spawn(move || {
        println!("Listening...");
        let events = nostr_clone.lock().unwrap().next_data().unwrap();

        for (relay_url, message) in events.iter() {
            handle_message(relay_url, message).unwrap();
        }
    });

    // Change metadata
    nostr_client
        .lock()
        .unwrap()
        .set_metadata(
            &my_identity,
            Some("Rust Nostr Client test account"),
            Some("Hello Nostr! #5"),
            None,
        )
        .unwrap();

    // Subscribe to my last text note
    let subscription_id = nostr_client
        .lock()
        .unwrap()
        .subscribe(
            vec![ReqFilter {
                ids: None,
                authors: Some(vec![
                    "884704bd421721e292edbff42eb77547fe115c6ff9825b08fc366be4cd69e9f6".to_string(),
                ]),
                kinds: None,
                e: None,
                p: None,
                since: None,
                until: None,
                limit: Some(1),
            }],
        )
        .unwrap();

    // Unsubscribe
    nostr_client
        .lock()
        .unwrap()
        .unsubscribe(&subscription_id)
        .unwrap();

    // Publish a text note
    nostr_client
        .lock()
        .unwrap()
        .publish_text_note(&my_identity, "Hello Nostr! :)", &[])
        .unwrap();

    // Wait for the thread to finish
    handle_thread.join().unwrap();
}

NIPs Supported

License

Licensed under MIT license (LICENSE-MIT or http://opensource.org/licenses/MIT)