sdk: inherit pool subscriptions only when calling Client::add_relay or Client::add_read_relay methods

Signed-off-by: Yuki Kishimoto <[email protected]>

Author: yukibtc

CHANGELOG.md

@@ -73,6 +73,7 @@
 * sdk: update `Client::shutdown` method fingerprint ([Yuki Kishimoto])
 * sdk: deprecate `Client::add_relay_with_opts` and `Client::add_relays` ([Yuki Kishimoto])
 * sdk: deprecate `RelayPool::send_msg` and `RelayPool::batch_msg` ([Yuki Kishimoto])
+* sdk: inherit pool subscriptions only when calling `Client::add_relay` or `Client::add_read_relay` methods ([Yuki Kishimoto])
 * ffi(nostr): impl `Display` for `Coordinate` ([Yuki Kishimoto])
 * ffi(sdk): change `Connection::embedded_tor` fingerprint for `android` and `ios` targets ([Yuki Kishimoto])
 

bindings/nostr-sdk-ffi/src/client/mod.rs

@@ -195,6 +195,9 @@ impl Client {
     /// Add read relay
     ///
     /// If relay already exists, this method add the `READ` flag to it and return `false`.
+    ///
+    /// If are set pool subscriptions, the new added relay will inherit them. Use `subscribe_to` method instead of `subscribe`,
+    /// to avoid to set pool subscriptions.
     pub async fn add_read_relay(&self, url: String) -> Result<bool> {
         Ok(self.inner.add_read_relay(url).await?)
     }

bindings/nostr-sdk-js/src/client/mod.rs

@@ -213,6 +213,9 @@ impl JsClient {
     /// Add read relay
     ///
     /// If relay already exists, this method add the `READ` flag to it and return `false`.
+    ///
+    /// If are set pool subscriptions, the new added relay will inherit them. Use `subscribe_to` method instead of `subscribe`,
+    /// to avoid to set pool subscriptions.
     #[wasm_bindgen(js_name = addReadRelay)]
     pub async fn add_read_relay(&self, url: String) -> Result<bool> {
         self.inner.add_read_relay(url).await.map_err(into_err)

crates/nostr-relay-pool/src/pool/internal.rs

@@ -205,7 +205,12 @@ impl InternalRelayPool {
         subscriptions.clear();
     }
 
-    pub async fn add_relay<U>(&self, url: U, opts: RelayOptions) -> Result<bool, Error>
+    pub async fn add_relay<U>(
+        &self,
+        url: U,
+        inherit_pool_subscriptions: bool,
+        opts: RelayOptions,
+    ) -> Result<bool, Error>
     where
         U: TryIntoUrl,
         Error: From<<U as TryIntoUrl>::Err>,
@@ -217,33 +222,36 @@ impl InternalRelayPool {
         let mut relays = self.relays.write().await;
 
         // Check if map already contains url
-        if !relays.contains_key(&url) {
-            // Compose new relay
-            let relay = Relay::custom(url, self.database.clone(), self.blacklist.clone(), opts);
+        if relays.contains_key(&url) {
+            return Ok(false);
+        }
 
-            // Set notification sender
-            relay
-                .set_notification_sender(Some(self.notification_sender.clone()))
-                .await;
+        // Compose new relay
+        let relay = Relay::custom(url, self.database.clone(), self.blacklist.clone(), opts);
 
-            // Set relay subscriptions
+        // Set notification sender
+        relay
+            .set_notification_sender(Some(self.notification_sender.clone()))
+            .await;
+
+        // Set relay subscriptions
+        if inherit_pool_subscriptions {
             let subscriptions = self.subscriptions().await;
             for (id, filters) in subscriptions.into_iter() {
                 relay.inner.update_subscription(id, filters, false).await;
             }
+        }
 
-            // Insert relay into map
-            relays.insert(relay.url(), relay);
+        // Insert relay into map
+        relays.insert(relay.url(), relay);
 
-            Ok(true)
-        } else {
-            Ok(false)
-        }
+        Ok(true)
     }
 
     pub async fn get_or_add_relay<U>(
         &self,
         url: U,
+        inherit_pool_subscriptions: bool,
         opts: RelayOptions,
     ) -> Result<Option<Relay>, Error>
     where
@@ -253,7 +261,8 @@ impl InternalRelayPool {
         match self.relay(url.clone()).await {
             Ok(relay) => Ok(Some(relay)),
             Err(..) => {
-                self.add_relay(url, opts).await?;
+                self.add_relay(url, inherit_pool_subscriptions, opts)
+                    .await?;
                 Ok(None)
             }
         }

crates/nostr-relay-pool/src/pool/mod.rs

@@ -175,7 +175,7 @@ impl RelayPool {
         U: TryIntoUrl,
         Error: From<<U as TryIntoUrl>::Err>,
     {
-        self.inner.add_relay(url, opts).await
+        self.inner.add_relay(url, true, opts).await
     }
 
     /// Try to get relay by `url` or add it to pool.
@@ -185,13 +185,16 @@ impl RelayPool {
     pub async fn get_or_add_relay<U>(
         &self,
         url: U,
+        inherit_pool_subscriptions: bool,
         opts: RelayOptions,
     ) -> Result<Option<Relay>, Error>
     where
         U: TryIntoUrl + Clone,
         Error: From<<U as TryIntoUrl>::Err>,
     {
-        self.inner.get_or_add_relay(url, opts).await
+        self.inner
+            .get_or_add_relay(url, inherit_pool_subscriptions, opts)
+            .await
     }
 
     /// Disconnect and remove relay

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

@@ -414,6 +414,7 @@ impl Client {
     async fn get_or_add_relay_with_flag<U>(
         &self,
         url: U,
+        inherit_pool_subscriptions: bool,
         flag: RelayServiceFlags,
     ) -> Result<bool, Error>
     where
@@ -430,7 +431,11 @@ impl Client {
         let opts: RelayOptions = opts.flags(flag);
 
         // Add relay with opts or edit current one
-        match self.pool.get_or_add_relay::<&Url>(&url, opts).await? {
+        match self
+            .pool
+            .get_or_add_relay::<&Url>(&url, inherit_pool_subscriptions, opts)
+            .await?
+        {
             Some(relay) => {
                 relay.flags_ref().add(flag);
                 Ok(false)
@@ -481,7 +486,7 @@ impl Client {
         U: TryIntoUrl,
         pool::Error: From<<U as TryIntoUrl>::Err>,
     {
-        self.get_or_add_relay_with_flag(url, RelayServiceFlags::default())
+        self.get_or_add_relay_with_flag(url, true, RelayServiceFlags::default())
             .await
     }
 
@@ -496,21 +501,32 @@ impl Client {
         U: TryIntoUrl,
         pool::Error: From<<U as TryIntoUrl>::Err>,
     {
-        self.get_or_add_relay_with_flag(url, RelayServiceFlags::PING | RelayServiceFlags::DISCOVERY)
-            .await
+        self.get_or_add_relay_with_flag(
+            url,
+            false,
+            RelayServiceFlags::PING | RelayServiceFlags::DISCOVERY,
+        )
+        .await
     }
 
     /// Add read relay
     ///
     /// If relay already exists, this method add the `READ` flag to it and return `false`.
+    ///
+    /// If are set pool subscriptions, the new added relay will inherit them. Use `subscribe_to` method instead of `subscribe`,
+    /// to avoid to set pool subscriptions.
     #[inline]
     pub async fn add_read_relay<U>(&self, url: U) -> Result<bool, Error>
     where
         U: TryIntoUrl,
         pool::Error: From<<U as TryIntoUrl>::Err>,
     {
-        self.get_or_add_relay_with_flag(url, RelayServiceFlags::PING | RelayServiceFlags::READ)
-            .await
+        self.get_or_add_relay_with_flag(
+            url,
+            true,
+            RelayServiceFlags::PING | RelayServiceFlags::READ,
+        )
+        .await
     }
 
     /// Add write relay
@@ -522,8 +538,12 @@ impl Client {
         U: TryIntoUrl,
         pool::Error: From<<U as TryIntoUrl>::Err>,
     {
-        self.get_or_add_relay_with_flag(url, RelayServiceFlags::PING | RelayServiceFlags::WRITE)
-            .await
+        self.get_or_add_relay_with_flag(
+            url,
+            false,
+            RelayServiceFlags::PING | RelayServiceFlags::WRITE,
+        )
+        .await
     }
 
     #[inline]
@@ -532,8 +552,12 @@ impl Client {
         U: TryIntoUrl,
         pool::Error: From<<U as TryIntoUrl>::Err>,
     {
-        self.get_or_add_relay_with_flag(url, RelayServiceFlags::PING | RelayServiceFlags::INBOX)
-            .await
+        self.get_or_add_relay_with_flag(
+            url,
+            false,
+            RelayServiceFlags::PING | RelayServiceFlags::INBOX,
+        )
+        .await
     }
 
     #[inline]
@@ -542,8 +566,12 @@ impl Client {
         U: TryIntoUrl,
         pool::Error: From<<U as TryIntoUrl>::Err>,
     {
-        self.get_or_add_relay_with_flag(url, RelayServiceFlags::PING | RelayServiceFlags::OUTBOX)
-            .await
+        self.get_or_add_relay_with_flag(
+            url,
+            false,
+            RelayServiceFlags::PING | RelayServiceFlags::OUTBOX,
+        )
+        .await
     }
 
     /// Add new relay with custom [`RelayOptions`]