Repository files navigation

The project is split up into several crates:

• nostr: Rust implementation of Nostr protocol
• Signers
  • nostr-browser-signer: Nostr Browser signer implementation (NIP-07)
  • nostr-browser-signer-proxy: Proxy for using the Nostr Browser signer (NIP-07) in native applications
  • nostr-connect: Nostr Connect (NIP-46)
• nostr-database: Events database abstraction and in-memory implementation
  • nostr-lmdb: LMDB storage backend
  • nostr-ndb:nostrdb storage backend
  • nostr-sqlite: SQLite storage backend
  • nostr-indexeddb: IndexedDB storage backend
• nostr-gossip: Gossip traits
  • nostr-gossip-memory: In-memory gossip database
  • nostr-gossip-sqlite: SQLite storage for gossip
• Remote File Storage implementations:
  • nostr-blossom: A library for interacting with the Blossom protocol
  • nostr-http-file-storage: HTTP File Storage client (NIP-96)
• nostr-keyring: Nostr Keyring
• nostr-relay-builder: Build your own custom nostr relay
• nostr-relay-pool: Nostr Relay Pool
• nostr-sdk: High-level client library
• nwc: Nostr Wallet Connect (NWC) client (NIP-47)

Note: this repository contains the Rust codebase.There are several other projects (i.e., bindings, CLI, etc.)which are maintained in other repositorieshttps://rust-nostr.org/projects.

nostr crate can be used inno_std environments.Check the example in theembedded/ directory.

Learn more aboutrust-nostr athttps://rust-nostr.org.

The table below lists which NIPs have implementations somewhere in this workspace.Some features are behind crate flags or only available when using a specific crate (e.g., signer integrations).

✅ means “implemented and tested behind the relevant feature flag”, ❌ means “not available anywhere in this repo yet”.

These libraries are in ALPHA state, things that are implemented generally work but the API will change in breaking ways.

rust-nostr is free and open-source. This means we do not earn any revenue by selling it. Instead, we rely on your financial support. If you actively use any of therust-nostr libs/software/services, then pleasedonate.

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