pool: add whitelist support

Closes #571

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

Author: yukibtc

CHANGELOG.md

@@ -102,6 +102,7 @@
 * pool: add `RelayPool::disconnect_relay` method ([Yuki Kishimoto])
 * pool: add `RelayPool::relays_with_flag` and `RelayPool::all_relays` ([Yuki Kishimoto])
 * pool: add support to negentropy v1 ([Yuki Kishimoto])
+* pool: add whitelist support
 * sdk: add `Client::add_discovery_relay` ([Yuki Kishimoto])
 * sdk: add `Client::add_read_relay` and `Client::add_write_relay` ([Yuki Kishimoto])
 * sdk: add `Client::stream_events_targeted` ([Yuki Kishimoto])

bindings/nostr-sdk-ffi/bindings-python/examples/blacklist.py

@@ -17,7 +17,8 @@ async def main():
     other_public_key = PublicKey.parse("npub1xtscya34g58tk0z605fvr788k263gsu6cy9x0mhnm87echrgufzsevkk5s")
 
     # Mute public key
-    await client.mute_public_keys([muted_public_key])
+    filtering = client.filtering()
+    await filtering.add_public_keys([muted_public_key])
 
     # Get events
     f = Filter().authors([muted_public_key, other_public_key]).kind(Kind(0))

bindings/nostr-sdk-ffi/bindings-python/examples/whitelist.py

@@ -0,0 +1,32 @@
+import asyncio
+from nostr_sdk import PublicKey, Client, Filter, Kind, init_logger, LogLevel, EventSource, Options, RelayFilteringMode
+from datetime import timedelta
+
+
+async def main():
+    # Init logger
+    init_logger(LogLevel.INFO)
+
+    # Init client
+    opts = Options().filtering_mode(RelayFilteringMode.WHITELIST)
+    client = Client.with_opts(None, opts)
+    await client.add_relay("wss://relay.damus.io")
+    await client.add_relay("wss://nos.lol")
+    await client.connect()
+
+    whitelisted_public_key = PublicKey.parse("npub1l2vyh47mk2p0qlsku7hg0vn29faehy9hy34ygaclpn66ukqp3afqutajft")
+    not_whitelisted_public_key = PublicKey.parse("npub1xtscya34g58tk0z605fvr788k263gsu6cy9x0mhnm87echrgufzsevkk5s")
+
+    # Mute public key
+    filtering = client.filtering()
+    await filtering.add_public_keys([whitelisted_public_key])
+
+    # Get events
+    f = Filter().authors([whitelisted_public_key, not_whitelisted_public_key]).kind(Kind(0))
+    source = EventSource.relays(timedelta(seconds=10))
+    events = await client.get_events_of([f], source)
+    print(f"Received {events.__len__()} events")
+
+
+if __name__ == '__main__':
+    asyncio.run(main())

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

@@ -30,7 +30,7 @@ use crate::error::Result;
 use crate::pool::result::{Output, ReconciliationOutput, SendEventOutput, SubscribeOutput};
 use crate::pool::RelayPool;
 use crate::relay::options::{NegentropyOptions, SubscribeAutoCloseOptions};
-use crate::relay::RelayBlacklist;
+use crate::relay::RelayFiltering;
 use crate::{HandleNotification, NostrDatabase, Relay};
 
 #[derive(Object)]
@@ -101,51 +101,9 @@ impl Client {
         Arc::new(self.inner.database().into())
     }
 
-    /// Get blacklist
-    pub fn blacklist(&self) -> RelayBlacklist {
-        self.inner.blacklist().into()
-    }
-
-    /// Mute event IDs
-    ///
-    /// Add event IDs to blacklist
-    ///
-    /// <div class="warning">Mute list event is not currently created/updated!</div>
-    pub async fn mute_ids(&self, ids: Vec<Arc<EventId>>) {
-        self.inner.mute_ids(ids.into_iter().map(|id| **id)).await
-    }
-
-    /// Unmute event IDs
-    ///
-    /// Remove event IDs from blacklist
-    ///
-    /// <div class="warning">Mute list event is not currently created/updated!</div>
-    pub async fn unmute_ids(&self, ids: &[Arc<EventId>]) {
-        self.inner
-            .unmute_ids(ids.iter().map(|id| id.as_ref().deref()))
-            .await
-    }
-
-    /// Mute public keys
-    ///
-    /// Add public keys to blacklist
-    ///
-    /// <div class="warning">Mute list event is not currently created/updated!</div>
-    pub async fn mute_public_keys(&self, public_keys: Vec<Arc<PublicKey>>) {
-        self.inner
-            .mute_public_keys(public_keys.into_iter().map(|p| **p))
-            .await
-    }
-
-    /// Unmute public keys
-    ///
-    /// Remove public keys from blacklist
-    ///
-    /// <div class="warning">Mute list event is not currently created/updated!</div>
-    pub async fn unmute_public_keys(&self, public_keys: &[Arc<PublicKey>]) {
-        self.inner
-            .unmute_public_keys(public_keys.iter().map(|p| p.as_ref().deref()))
-            .await
+    /// Get filtering
+    pub fn filtering(&self) -> RelayFiltering {
+        self.inner.filtering().into()
     }
 
     pub async fn shutdown(&self) -> Result<()> {

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

@@ -13,7 +13,7 @@ use nostr_sdk::pool;
 use uniffi::{Enum, Object};
 
 use crate::error::Result;
-use crate::relay::{ConnectionMode, RelayLimits};
+use crate::relay::{ConnectionMode, RelayFilteringMode, RelayLimits};
 
 #[derive(Clone, Object)]
 pub struct Options {
@@ -148,6 +148,13 @@ impl Options {
         builder.inner = builder.inner.max_avg_latency(max);
         builder
     }
+
+    /// Set filtering mode (default: blacklist)
+    pub fn filtering_mode(self: Arc<Self>, mode: RelayFilteringMode) -> Self {
+        let mut builder = unwrap_or_clone_arc(self);
+        builder.inner = builder.inner.filtering_mode(mode.into());
+        builder
+    }
 }
 
 /// Connection target

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

@@ -19,7 +19,7 @@ use crate::error::Result;
 use crate::negentropy::NegentropyItem;
 use crate::pool::result::ReconciliationOutput;
 use crate::relay::options::{FilterOptions, NegentropyOptions};
-use crate::relay::{RelayBlacklist, RelayOptions, RelaySendOptions, SubscribeOptions};
+use crate::relay::{RelayFiltering, RelayOptions, RelaySendOptions, SubscribeOptions};
 use crate::{HandleNotification, NostrDatabase, Relay};
 
 #[derive(Object)]
@@ -62,9 +62,9 @@ impl RelayPool {
         Arc::new(self.inner.database().into())
     }
 
-    /// Get blacklist
-    pub fn blacklist(&self) -> RelayBlacklist {
-        self.inner.blacklist().into()
+    /// Get relay filtering
+    pub fn filtering(&self) -> RelayFiltering {
+        self.inner.filtering().into()
     }
 
     /// Get relays with `READ` or `WRITE` flags