Nostr

Description

Rust implementation of Nostr protocol.

Getting started

[dependencies]
nostr = "0.10"
tungstenite = { version = "0.18", features = ["rustls-tls-webpki-roots"]}

use nostr::{Event, EventBuilder, Metadata, Keys, Result};
use nostr::message::ClientMessage;
use nostr::url::Url;
use tungstenite::{Message as WsMessage};

fn main() -> Result<()> {
    // Generate new random keys
    let my_keys = Keys::generate_from_os_random();

    // or use your already existing
    //
    // From HEX or Bech32
    // use nostr::key::FromSkStr;
    // let my_keys = Keys::from_sk_str("hex-or-bech32-secret-key")?;
    //
    // From Bech32
    // use nostr::key::FromBech32;
    // let my_keys = Keys::from_bech32("nsec1...")?;
    //
    // From HEX
    // use std::str::FromStr;
    // use nostr::secp256k1::SecretKey;
    // let secret_key = SecretKey::from_str("hex-secret-key")?;
    // let my_keys = Keys::from_bech32("nsec1...")?;

    let metadata = Metadata::new()
        .name("username")
        .display_name("My Username")
        .about("Description")
        .picture(Url::parse("https://example.com/avatar.png")?)
        .nip05("username@example.com")
        .lud16("yuki@stacker.news");

    let event: Event = EventBuilder::set_metadata(metadata)?.to_event(&my_keys)?;

    // New text note
    let event: Event = EventBuilder::new_text_note("Hello from Nostr SDK", &[]).to_event(&my_keys)?;

    // New POW text note
    let event: Event = EventBuilder::new_text_note("My first POW text note from Nostr SDK", &[]).to_pow_event(&my_keys, 20)?;

    // Connect to relay
    let (mut socket, _) = tungstenite::connect(Url::parse("wss://relay.damus.io")?).expect("Can't connect to relay");

    // Send msg
    let msg = ClientMessage::new_event(event).as_json();
    socket.write_message(WsMessage::Text(msg)).expect("Impossible to send message");

    Ok(())
}

More examples can be found in the examples directory.

Crate Feature Flags

The following crate feature flags are available:

Supported NIPs

State

This library is in an ALPHA state, things that are implemented generally work but the API will change in breaking ways.

License

This project is distributed under the MIT software license - see the LICENSE file for details