nostr: add Nip11GetOptions

Update `RelayInformationDocument::get` signature.

Pull-Request: #913
Signed-off-by: Yuki Kishimoto <yukikishimoto@protonmail.com>

Author: yukibtc

CHANGELOG.md

@@ -31,6 +31,7 @@
 - nostr: remove `Market::Mention` (NIP-10) ([Yuki Kishimoto] at https://github.com/rust-nostr/nostr/pull/895)
 - nostr: remove `parser` feature ([Yuki Kishimoto] at https://github.com/rust-nostr/nostr/pull/899)
 - nostr: update `Nip19Profile::new` and `Nip19Coordinate::new` signature ([Yuki Kishimoto] at https://github.com/rust-nostr/nostr/pull/910)
+- nostr: update `RelayInformationDocument::get` signature ([Yuki Kishimoto] at https://github.com/rust-nostr/nostr/pull/913)
 - connect: remove `NostrConnect::get_relays` ([Yuki Kishimoto] at https://github.com/rust-nostr/nostr/pull/894)
 
 ### Changed
@@ -41,6 +42,7 @@
 ### Added
 
 - nostr: add NIP-88 support ([Yuki Kishimoto] at https://github.com/rust-nostr/nostr/pull/892)
+- nostr: add `Nip11GetOptions` ([Yuki Kishimoto] at https://github.com/rust-nostr/nostr/pull/913)
 
 ### Fixed
 

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

@@ -271,12 +271,20 @@ impl InnerRelay {
 
     #[cfg(feature = "nip11")]
     fn request_nip11_document(&self) {
-        let (allowed, proxy) = match self.opts.connection_mode {
-            ConnectionMode::Direct => (true, None),
+        #[cfg_attr(target_arch = "wasm32", allow(unused_mut))]
+        let mut opts: Nip11GetOptions =
+            Nip11GetOptions::default().timeout(DEFAULT_CONNECTION_TIMEOUT);
+
+        let allowed: bool = match self.opts.connection_mode {
+            ConnectionMode::Direct => true,
             #[cfg(not(target_arch = "wasm32"))]
-            ConnectionMode::Proxy(proxy) => (true, Some(proxy)),
+            ConnectionMode::Proxy(proxy) => {
+                // Update proxy
+                opts.proxy = Some(proxy);
+                true
+            }
             #[cfg(all(feature = "tor", not(target_arch = "wasm32")))]
-            ConnectionMode::Tor { .. } => (false, None),
+            ConnectionMode::Tor { .. } => false,
         };
 
         if allowed {
@@ -291,7 +299,7 @@ impl InnerRelay {
                 let url = self.url.clone();
                 let atomic = self.atomic.clone();
                 task::spawn(async move {
-                    match RelayInformationDocument::get(url.clone().into(), proxy).await {
+                    match RelayInformationDocument::get(url.clone().into(), opts).await {
                         Ok(document) => {
                             let mut d = atomic.document.write().await;
                             *d = document

crates/nostr/examples/nip11.rs

@@ -8,7 +8,7 @@ use nostr::prelude::*;
 async fn main() -> Result<()> {
     let relay_url = Url::parse("wss://relay.damus.io")?;
 
-    let info = RelayInformationDocument::get(relay_url, None).await?;
+    let info = RelayInformationDocument::get(relay_url, Nip11GetOptions::default()).await?;
 
     println!("{:#?}", info);
 

crates/nostr/src/nips/nip11.rs

@@ -10,6 +10,8 @@
 use alloc::string::String;
 use alloc::vec::Vec;
 use core::fmt;
+use core::time::Duration;
+#[cfg(not(target_arch = "wasm32"))]
 use std::net::SocketAddr;
 
 use reqwest::Client;
@@ -54,6 +56,48 @@ impl From<reqwest::Error> for Error {
     }
 }
 
+/// NIP11 get options
+#[derive(Debug, Clone, Copy, PartialEq, Eq, PartialOrd, Ord, Hash)]
+pub struct Nip11GetOptions {
+    /// Proxy
+    #[cfg(not(target_arch = "wasm32"))]
+    pub proxy: Option<SocketAddr>,
+    /// Timeout
+    pub timeout: Duration,
+}
+
+impl Default for Nip11GetOptions {
+    fn default() -> Self {
+        Self {
+            proxy: None,
+            timeout: Duration::from_secs(60),
+        }
+    }
+}
+
+impl Nip11GetOptions {
+    /// New default options
+    #[inline]
+    pub fn new() -> Self {
+        Self::default()
+    }
+
+    /// Set proxy
+    #[inline]
+    #[cfg(not(target_arch = "wasm32"))]
+    pub fn proxy(mut self, proxy: SocketAddr) -> Self {
+        self.proxy = Some(proxy);
+        self
+    }
+
+    /// Set timeout
+    #[inline]
+    pub fn timeout(mut self, timeout: Duration) -> Self {
+        self.timeout = timeout;
+        self
+    }
+}
+
 /// Relay information document
 #[derive(Debug, Clone, Default, PartialEq, Eq, PartialOrd, Ord, Hash, Serialize, Deserialize)]
 pub struct RelayInformationDocument {
@@ -181,27 +225,27 @@ pub struct FeeSchedule {
 }
 
 impl RelayInformationDocument {
-    /// Create new empty [`RelayInformationDocument`]
+    /// Create a new empty [`RelayInformationDocument`].
     pub fn new() -> Self {
         Self::default()
     }
 
     /// Get Relay Information Document
-    ///
-    /// **Proxy is ignored for WASM targets!**
-    pub async fn get(mut url: Url, _proxy: Option<SocketAddr>) -> Result<Self, Error> {
+    pub async fn get(mut url: Url, opts: Nip11GetOptions) -> Result<Self, Error> {
+        let mut builder = Client::builder();
+
+        // Set proxy
         #[cfg(not(target_arch = "wasm32"))]
-        let client: Client = {
-            let mut builder = Client::builder();
-            if let Some(proxy) = _proxy {
-                let proxy = format!("socks5h://{proxy}");
-                builder = builder.proxy(Proxy::all(proxy)?);
-            }
-            builder.build()?
-        };
+        if let Some(proxy) = opts.proxy {
+            let proxy = format!("socks5h://{proxy}");
+            builder = builder.proxy(Proxy::all(proxy)?);
+        }
+
+        // Set timeout
+        builder = builder.timeout(opts.timeout);
 
-        #[cfg(target_arch = "wasm32")]
-        let client: Client = Client::new();
+        // Build client
+        let client: Client = builder.build()?;
 
         let url: &str = Self::with_http_scheme(&mut url)?;
         let req = client.get(url).header("Accept", "application/nostr+json");