Nostr

Description

Rust implementation of Nostr protocol.

Getting started

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

```rust,no_run 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 mykeys = Keys::generatefromosrandom();

// 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:

| Feature | Default | Description | | ------------------- | :-----: | -------------------------------------------------------------------------------------------------------------------------- | | all-nips | Yes | Enable all NIPs | | nip04 | Yes | Enable NIP-04: Encrypted Direct Message | | nip05 | Yes | Enable NIP-05: Mapping Nostr keys to DNS-based internet identifiers | | nip06 | Yes | Enable NIP-06: Basic key derivation from mnemonic seed phrase | | nip11 | Yes | Enable NIP-11: Relay Information Document | | blocking | No | Needed to use NIP-05 and NIP-11features in not async/await context |

Supported NIPs

| Supported | NIP | |:----------:| ---------------------------------------------------------------------------------------------------------------------------------- | | ✅ | 01 - Basic protocol flow description | | ✅ | 02 - Contact List and Petnames | | ❌ | 03 - OpenTimestamps Attestations for Events | | ✅ | 04 - Encrypted Direct Message | | ✅ | 05 - Mapping Nostr keys to DNS-based internet identifiers | | ✅ | 06 - Basic key derivation from mnemonic seed phrase | | ❌ | 08 - Handling Mentions | | ✅ | 09 - Event Deletion | | ❌ | 10 - Conventions for clients' use of e and p tags in text events | | ✅ | 11 - Relay Information Document | | ❌ | 12 - Generic Tag Queries | | ✅ | 13 - Proof of Work | | ❌ | 14 - Subject tag in text events | | ✅ | 15 - End of Stored Events Notice | | ❌ | 16 - Event Treatment | | ❌ | 19 - bech32-encoded entities | | ✅ | 20 - Command Results | | ❌ | 22 - Event created_at Limits | | ✅ | 25 - Reactions | | ✅ | 26 - Delegated Event Signing | | ✅ | 28 - Public Chat | | ✅ | 36 - Sensitive Content | | ❌ | 40 - Expiration Timestamp |

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