sdk: allow enabling sleep-when-idle feature

- Add `ClientOptions::sleep_when_idle`

Closes #927

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

Author: yukibtc

crates/nostr-sdk/CHANGELOG.md

@@ -29,6 +29,10 @@
 
 - Extract at max 3 relays per NIP65 marker (https://github.com/rust-nostr/nostr/pull/951)
 
+### Added
+
+- Add `ClientOptions::sleep_when_idle` (https://github.com/rust-nostr/nostr/pull/959)
+
 ### Deprecated
 
 - Deprecate `Options` in favor of `ClientOptions` (https://github.com/rust-nostr/nostr/pull/958)

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

@@ -21,7 +21,7 @@ pub mod options;
 
 pub use self::builder::ClientBuilder;
 pub use self::error::Error;
-pub use self::options::ClientOptions;
+pub use self::options::{ClientOptions, SleepWhenIdle};
 #[cfg(not(target_arch = "wasm32"))]
 pub use self::options::{Connection, ConnectionTarget};
 use crate::gossip::{BrokenDownFilters, Gossip};
@@ -245,6 +245,14 @@ impl Client {
             },
         };
 
+        // Set sleep when idle
+        let opts: RelayOptions = match self.opts.sleep_when_idle {
+            // Do nothing
+            SleepWhenIdle::Disabled => opts,
+            // Enable: update relay options
+            SleepWhenIdle::Enabled { timeout } => opts.sleep_when_idle(true).idle_timeout(timeout),
+        };
+
         // Set limits
         opts.limits(self.opts.relay_limits.clone())
             .max_avg_latency(self.opts.max_avg_latency)

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

@@ -25,6 +25,7 @@ pub struct ClientOptions {
     pub(super) connection: Connection,
     pub(super) relay_limits: RelayLimits,
     pub(super) max_avg_latency: Option<Duration>,
+    pub(super) sleep_when_idle: SleepWhenIdle,
     pub(super) pool: RelayPoolOptions,
 }
 
@@ -99,6 +100,13 @@ impl ClientOptions {
         self
     }
 
+    /// Set sleep when idle config
+    #[inline]
+    pub fn sleep_when_idle(mut self, config: SleepWhenIdle) -> Self {
+        self.sleep_when_idle = config;
+        self
+    }
+
     /// Notification channel size (default: [`DEFAULT_NOTIFICATION_CHANNEL_SIZE`])
     #[deprecated(since = "0.42.0", note = "Use `Options::pool` instead.")]
     pub fn notification_channel_size(mut self, size: usize) -> Self {
@@ -114,6 +122,21 @@ impl ClientOptions {
     }
 }
 
+/// Put relays to sleep when idle.
+#[derive(Debug, Clone, Copy, Default, PartialEq, Eq, PartialOrd, Ord, Hash)]
+pub enum SleepWhenIdle {
+    /// Disabled
+    #[default]
+    Disabled,
+    /// Enabled for all relays
+    Enabled {
+        /// Idle timeout
+        ///
+        /// After how much time of inactivity put the relay to sleep.
+        timeout: Duration,
+    },
+}
+
 /// Connection target
 #[cfg(not(target_arch = "wasm32"))]
 #[derive(Debug, Clone, Copy, Default, PartialEq, Eq, Hash)]