sdk: deprecate Options in favor of ClientOptions

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

Author: yukibtc

crates/nostr-cli/src/main.rs

@@ -55,7 +55,7 @@ async fn run() -> Result<()> {
                 .embedded_tor();
 
             // Build client
-            let opts: Options = Options::new().connection(connection);
+            let opts: Options = ClientOptions::new().connection(connection);
             let client: Client = Client::builder().database(db).opts(opts).build();
 
             // Add relays

crates/nostr-sdk/CHANGELOG.md

@@ -25,12 +25,14 @@
 
 ## Unreleased
 
-### Breaking changes
-
 ### Changed
 
 - Extract at max 3 relays per NIP65 marker (https://github.com/rust-nostr/nostr/pull/951)
 
+### Deprecated
+
+- Deprecate `Options` in favor of `ClientOptions` (https://github.com/rust-nostr/nostr/pull/958)
+
 ## v0.42.0 - 2025/05/20
 
 ### Added

crates/nostr-sdk/README.md

@@ -39,7 +39,7 @@ async fn main() -> Result<()> {
     let connection: Connection = Connection::new()
         .proxy(addr) // Use `.embedded_tor()` instead to enable the embedded tor client (require `tor` feature)
         .target(ConnectionTarget::Onion);
-    let opts = Options::new().connection(connection);
+    let opts = ClientOptions::new().connection(connection);
 
     // Create new client with custom options
     let client = Client::builder().signer(keys.clone()).opts(opts).build();

crates/nostr-sdk/examples/bot.rs

@@ -11,7 +11,7 @@ async fn main() -> Result<()> {
     let keys = Keys::parse("nsec12kcgs78l06p30jz7z7h3n2x2cy99nw2z6zspjdp7qc206887mwvs95lnkx")?;
     let client = Client::builder()
         .signer(keys.clone())
-        .opts(Options::new().gossip(true))
+        .opts(ClientOptions::new().gossip(true))
         .build();
 
     println!("Bot public key: {}", keys.public_key().to_bech32()?);

crates/nostr-sdk/examples/gossip.rs

@@ -11,7 +11,7 @@ async fn main() -> Result<()> {
     tracing_subscriber::fmt::init();
 
     let keys = Keys::parse("nsec1ufnus6pju578ste3v90xd5m2decpuzpql2295m3sknqcjzyys9ls0qlc85")?;
-    let opts = Options::new().gossip(true);
+    let opts = ClientOptions::new().gossip(true);
     let client = Client::builder().signer(keys).opts(opts).build();
 
     client.add_discovery_relay("wss://relay.damus.io").await?;

crates/nostr-sdk/examples/limits.rs

@@ -17,7 +17,7 @@ async fn main() -> Result<()> {
     let limits = RelayLimits::disable();
 
     // Compose options and limits
-    let opts = Options::new().relay_limits(limits);
+    let opts = ClientOptions::new().relay_limits(limits);
     let client = Client::builder().opts(opts).build();
 
     // Add relays and connect

crates/nostr-sdk/examples/tor.rs

@@ -15,7 +15,7 @@ async fn main() -> Result<()> {
     let connection: Connection = Connection::new()
         .embedded_tor()
         .target(ConnectionTarget::Onion);
-    let opts = Options::new().connection(connection);
+    let opts = ClientOptions::new().connection(connection);
     let client = Client::builder().signer(keys.clone()).opts(opts).build();
 
     // Add relays

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

@@ -15,7 +15,8 @@ use nostr_relay_pool::transport::websocket::{
     DefaultWebsocketTransport, IntoWebSocketTransport, WebSocketTransport,
 };
 
-use crate::{Client, Options};
+use crate::client::options::ClientOptions;
+use crate::client::Client;
 
 /// Client builder
 #[derive(Debug, Clone)]
@@ -31,7 +32,7 @@ pub struct ClientBuilder {
     /// Relay monitor
     pub monitor: Option<Monitor>,
     /// Client options
-    pub opts: Options,
+    pub opts: ClientOptions,
 }
 
 impl Default for ClientBuilder {
@@ -42,7 +43,7 @@ impl Default for ClientBuilder {
             admit_policy: None,
             database: Arc::new(MemoryDatabase::default()),
             monitor: None,
-            opts: Options::default(),
+            opts: ClientOptions::default(),
         }
     }
 }
@@ -114,7 +115,7 @@ impl ClientBuilder {
 
     /// Set opts
     #[inline]
-    pub fn opts(mut self, opts: Options) -> Self {
+    pub fn opts(mut self, opts: ClientOptions) -> Self {
         self.opts = opts;
         self
     }

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::Options;
+pub use self::options::ClientOptions;
 #[cfg(not(target_arch = "wasm32"))]
 pub use self::options::{Connection, ConnectionTarget};
 use crate::gossip::{BrokenDownFilters, Gossip};
@@ -31,7 +31,7 @@ use crate::gossip::{BrokenDownFilters, Gossip};
 pub struct Client {
     pool: RelayPool,
     gossip: Gossip,
-    opts: Options,
+    opts: ClientOptions,
 }
 
 impl Default for Client {
@@ -70,7 +70,7 @@ impl Client {
     /// use nostr_sdk::prelude::*;
     ///
     /// let signer = Keys::generate();
-    /// let opts = Options::default().gossip(true);
+    /// let opts = ClientOptions::default().gossip(true);
     /// let client: Client = Client::builder().signer(signer).opts(opts).build();
     /// ```
     #[inline]

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

@@ -12,9 +12,13 @@ use std::time::Duration;
 
 use nostr_relay_pool::prelude::*;
 
+#[allow(missing_docs)]
+#[deprecated(since = "0.43.0", note = "Use `ClientOptions` instead.")]
+pub type Options = ClientOptions;
+
 /// Options
 #[derive(Debug, Clone, Default)]
-pub struct Options {
+pub struct ClientOptions {
     pub(super) autoconnect: bool,
     pub(super) gossip: bool,
     #[cfg(not(target_arch = "wasm32"))]
@@ -24,8 +28,8 @@ pub struct Options {
     pub(super) pool: RelayPoolOptions,
 }
 
-impl Options {
-    /// Create new (default) [`Options`]
+impl ClientOptions {
+    /// Create new default options
     #[inline]
     pub fn new() -> Self {
         Self::default()