Merge "Gossip traits and in-memory storage"

Partially closes #570

Pull-Request: #1114
Signed-off-by: Yuki Kishimoto <[email protected]>

Author: yukibtc

.github/workflows/ci.yml

@@ -35,6 +35,8 @@ jobs:
           - nostr-blossom
           - nostr-http-file-storage
           - nostr-database
+          - nostr-gossip
+          - nostr-gossip-memory
           - nostr-lmdb
           - nostr-indexeddb --target wasm32-unknown-unknown
           - nostr-ndb

Cargo.lock

@@ -8,6 +8,10 @@ members = [
     "database/nostr-lmdb",
     "database/nostr-ndb",
 
+    # Gossip
+    "gossip/nostr-gossip",
+    "gossip/nostr-gossip-memory",
+
     # Remote File Storage implementations
     "rfs/nostr-blossom",
     "rfs/nostr-http-file-storage",
@@ -39,6 +43,8 @@ negentropy = { version = "0.5", default-features = false }
 nostr = { version = "0.43", path = "./crates/nostr", default-features = false }
 nostr-connect = { version = "0.43", path = "./signer/nostr-connect", default-features = false }
 nostr-database = { version = "0.43", path = "./database/nostr-database", default-features = false }
+nostr-gossip = { version = "0.43", path = "./gossip/nostr-gossip", default-features = false }
+nostr-gossip-memory = { version = "0.43", path = "./gossip/nostr-gossip-memory", default-features = false }
 nostr-lmdb = { version = "0.43", path = "./database/nostr-lmdb", default-features = false }
 nostr-ndb = { version = "0.43", path = "./database/nostr-ndb", default-features = false }
 nostr-relay-builder = { version = "0.43", path = "./crates/nostr-relay-builder", default-features = false }

Cargo.toml

@@ -13,6 +13,8 @@ The project is split up into several crates:
     - [**nostr-lmdb**](./database/nostr-lmdb): LMDB storage backend
     - [**nostr-ndb**](./database/nostr-ndb): [nostrdb](https://github.com/damus-io/nostrdb) storage backend
     - [**nostr-indexeddb**](./database/nostr-indexeddb): IndexedDB storage backend
+- [**nostr-gossip**](./gossip/nostr-gossip): Gossip traits
+    - [**nostr-gossip-memory**](./gossip/nostr-gossip-memory): In-memory gossip database
 - Remote File Storage implementations:
     - [**nostr-blossom**](./rfs/nostr-blossom): A library for interacting with the Blossom protocol
     - [**nostr-http-file-storage**](./rfs/nostr-http-file-storage): HTTP File Storage client (NIP-96)

README.md

@@ -34,6 +34,8 @@ buildargs=(
     "-p nostr-blossom"
     "-p nostr-http-file-storage"
     "-p nostr-database"
+    "-p nostr-gossip"
+    "-p nostr-gossip-memory"
     "-p nostr-lmdb"
     "-p nostr-indexeddb --target wasm32-unknown-unknown"
     "-p nostr-ndb"

contrib/scripts/check-crates.sh

@@ -35,6 +35,7 @@ nip98 = ["nostr/nip98"]
 async-utility.workspace = true
 nostr = { workspace = true, features = ["std"] }
 nostr-database.workspace = true
+nostr-gossip.workspace = true
 nostr-relay-pool.workspace = true
 tokio = { workspace = true, features = ["sync"] }
 tracing = { workspace = true, features = ["std"] }
@@ -43,6 +44,7 @@ tracing = { workspace = true, features = ["std"] }
 nostr-connect.workspace = true
 nostr-lmdb.workspace = true
 nostr-ndb.workspace = true
+nostr-gossip-memory.workspace = true
 tokio = { workspace = true, features = ["macros"] }
 tracing-subscriber = { workspace = true, features = ["env-filter"] }
 

crates/nostr-sdk/Cargo.toml

@@ -2,16 +2,18 @@
 // Copyright (c) 2023-2025 Rust Nostr Developers
 // Distributed under the MIT software license
 
+use nostr_gossip_memory::prelude::*;
 use nostr_sdk::prelude::*;
 
 #[tokio::main]
 async fn main() -> Result<()> {
     tracing_subscriber::fmt::init();
 
     let keys = Keys::parse("nsec12kcgs78l06p30jz7z7h3n2x2cy99nw2z6zspjdp7qc206887mwvs95lnkx")?;
+    let gossip = NostrGossipMemory::unbounded();
     let client = Client::builder()
         .signer(keys.clone())
-        .opts(ClientOptions::new().gossip(true))
+        .gossip(gossip)
         .build();
 
     println!("Bot public key: {}", keys.public_key().to_bech32()?);

crates/nostr-sdk/examples/bot.rs

@@ -4,15 +4,16 @@
 
 use std::time::Duration;
 
+use nostr_gossip_memory::prelude::*;
 use nostr_sdk::prelude::*;
 
 #[tokio::main]
 async fn main() -> Result<()> {
     tracing_subscriber::fmt::init();
 
     let keys = Keys::parse("nsec1ufnus6pju578ste3v90xd5m2decpuzpql2295m3sknqcjzyys9ls0qlc85")?;
-    let opts = ClientOptions::new().gossip(true);
-    let client = Client::builder().signer(keys).opts(opts).build();
+    let gossip = NostrGossipMemory::unbounded();
+    let client = Client::builder().signer(keys).gossip(gossip).build();
 
     client.add_discovery_relay("wss://relay.damus.io").await?;
     client.add_discovery_relay("wss://purplepag.es").await?;

crates/nostr-sdk/examples/gossip.rs

@@ -9,6 +9,7 @@ use std::sync::Arc;
 use nostr::signer::{IntoNostrSigner, NostrSigner};
 use nostr_database::memory::MemoryDatabase;
 use nostr_database::{IntoNostrDatabase, NostrDatabase};
+use nostr_gossip::NostrGossip;
 use nostr_relay_pool::monitor::Monitor;
 use nostr_relay_pool::policy::AdmitPolicy;
 use nostr_relay_pool::transport::websocket::{
@@ -29,6 +30,8 @@ pub struct ClientBuilder {
     pub admit_policy: Option<Arc<dyn AdmitPolicy>>,
     /// Database
     pub database: Arc<dyn NostrDatabase>,
+    /// Gossip
+    pub gossip: Option<Arc<dyn NostrGossip>>,
     /// Relay monitor
     pub monitor: Option<Monitor>,
     /// Client options
@@ -42,6 +45,7 @@ impl Default for ClientBuilder {
             websocket_transport: Arc::new(DefaultWebsocketTransport),
             admit_policy: None,
             database: Arc::new(MemoryDatabase::default()),
+            gossip: None,
             monitor: None,
             opts: ClientOptions::default(),
         }
@@ -106,6 +110,16 @@ impl ClientBuilder {
         self
     }
 
+    /// Set a gossip database
+    #[inline]
+    pub fn gossip<T>(mut self, gossip: T) -> Self
+    where
+        T: NostrGossip + 'static,
+    {
+        self.gossip = Some(Arc::new(gossip));
+        self
+    }
+
     /// Set monitor
     #[inline]
     pub fn monitor(mut self, monitor: Monitor) -> Self {

crates/nostr-sdk/src/client/builder.rs

@@ -7,6 +7,7 @@ use std::fmt;
 use nostr::prelude::*;
 use nostr::serde_json;
 use nostr_database::prelude::*;
+use nostr_gossip::error::GossipError;
 use nostr_relay_pool::__private::SharedStateError;
 use nostr_relay_pool::prelude::*;
 
@@ -21,6 +22,8 @@ pub enum Error {
     Database(DatabaseError),
     /// Signer error
     Signer(SignerError),
+    /// Gossip error
+    Gossip(GossipError),
     /// [`EventBuilder`] error
     EventBuilder(event::builder::Error),
     /// Json error
@@ -45,6 +48,7 @@ impl fmt::Display for Error {
             Self::RelayPool(e) => e.fmt(f),
             Self::Database(e) => e.fmt(f),
             Self::Signer(e) => e.fmt(f),
+            Self::Gossip(e) => e.fmt(f),
             Self::EventBuilder(e) => e.fmt(f),
             Self::Json(e) => e.fmt(f),
             Self::SharedState(e) => e.fmt(f),
@@ -82,6 +86,12 @@ impl From<SignerError> for Error {
     }
 }
 
+impl From<GossipError> for Error {
+    fn from(e: GossipError) -> Self {
+        Self::Gossip(e)
+    }
+}
+
 impl From<event::builder::Error> for Error {
     fn from(e: event::builder::Error) -> Self {
         Self::EventBuilder(e)