README.md

Nostr

Project structure

The project is split up into several crates in the crates/ directory:

• nostr: Rust implementation of Nostr protocol.
• nostr-database: Database for Nostr apps
  • nostr-rocksdb: RocksDB Storage backend for Nostr apps
  • nostr-sqlite: SQLite Storage backend for Nostr apps
  • nostr-indexeddb: IndexedDB Storage backend for Nostr apps
• nostr-sdk: High level client library.
• nostr-sdk-net: Network library for nostr-sdk

Bindings

nostr and nostr-sdk crates can be embedded inside other environments, like Swift, Kotlin, Python and JavaScript. Please, explore the bindings/ directory to learn more.

Embedded

nostr crate can be used in no_std environments. Check the example in the embedded/ directory.

Available packages

• nostr:
  • Rust: https://crates.io/crates/nostr
  • Python: https://pypi.org/project/nostr-protocol
  • Kotlin: io.github.rust-nostr:nostr
  • Swift: https://github.com/rust-nostr/nostr-swift
  • JavaScript: https://www.npmjs.com/package/@rust-nostr/nostr
• nostr-sdk:
  • Rust: https://crates.io/crates/nostr-sdk
  • Python: https://pypi.org/project/nostr-sdk
  • Kotlin: io.github.rust-nostr:nostr-sdk
  • Swift: https://github.com/rust-nostr/nostr-sdk-swift
  • JavaScript: TODO

State

These libraries are in 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

Donations

⚡ Tips: https://getalby.com/p/yuki

⚡ Lightning Address: [email protected]