A high-level, Nostr client library written in Rust.
If you're writing a typical Nostr client or bot, this is likely the crate you need.
However, the crate is designed in a modular way and depends on several other lower-level crates. If you're attempting something more custom, you might be interested in these:
nostr-sdk-base: Rust implementation of Nostr protocol.toml
[dependencies]
anyhow = "1"
nostr-sdk = "0.1"
tokio = { version = "1", features = ["full"] }
```rust,norun use nostrsdk::base::{Event, Keys}; use nostr_sdk::Client;
async fn main() -> anyhow::Result<()> { // Init logger env_logger::init();
// Generate new keys
let my_keys: Keys = Client::generate_keys();
//
// or use your already existing
//
// use nostr_sdk::base::key::FromBech32;
// let my_keys: Keys = Keys::from_bech32("nsec1...")?;
// Create new client
let mut client = Client::new(&my_keys);
// Add relays
client.add_relay("wss://relay.damus.io", None)?;
client.add_relay("wss://nostr.openchain.fr", None)?;
// Connect to relays and keep alive connection
client.connect().await?;
// Publish a text note
client.publish_text_note("My first text note from Nostr SDK!", &[]).await?;
// Disconnect from all relays
client.disconnect().await?;
Ok(())
} ```
More examples can be found in the examples directory.
The following crate feature flags are available:
| Feature | Default | Description |
| ------------------- | :-----: | -------------------------------------------------------------------------------------------------------------------------- |
| blocking | No | Needed if you want to use this library in not async/await context |
This project is distributed under the MIT software license - see the LICENSE file for details