feat(kyoto): configure log level and DNS resolver

Author: rustaceanrob

bdk-ffi/src/kyoto.rs

@@ -29,6 +29,8 @@ use crate::wallet::Wallet;
 use crate::FeeRate;
 use crate::Update;
 
+type LogLevel = bdk_kyoto::kyoto::LogLevel;
+
 const TIMEOUT: u64 = 10;
 const DEFAULT_CONNECTIONS: u8 = 2;
 const CWD_PATH: &str = ".";
@@ -94,6 +96,8 @@ pub struct LightClientBuilder {
     connections: u8,
     data_dir: Option<String>,
     scan_type: ScanType,
+    log_level: LogLevel,
+    dns_resolver: Option<Arc<IpAddress>>,
     peers: Vec<Peer>,
 }
 
@@ -106,6 +110,8 @@ impl LightClientBuilder {
             connections: DEFAULT_CONNECTIONS,
             data_dir: None,
             scan_type: ScanType::default(),
+            log_level: LogLevel::default(),
+            dns_resolver: None,
             peers: Vec::new(),
         }
     }
@@ -135,6 +141,15 @@ impl LightClientBuilder {
         })
     }
 
+    /// Set the log level for the node. Production applications may want to omit `Debug` messages
+    /// to avoid heap allocations.
+    pub fn log_level(&self, log_level: LogLevel) -> Arc<Self> {
+        Arc::new(LightClientBuilder {
+            log_level,
+            ..self.clone()
+        })
+    }
+
     /// Bitcoin full-nodes to attempt a connection with.
     pub fn peers(&self, peers: Vec<Peer>) -> Arc<Self> {
         Arc::new(LightClientBuilder {
@@ -143,6 +158,15 @@ impl LightClientBuilder {
         })
     }
 
+    /// Configure a custom DNS resolver when querying DNS seeds. Default is `1.1.1.1` managed by
+    /// CloudFlare.
+    pub fn dns_resolver(&self, dns_resolver: Arc<IpAddress>) -> Arc<Self> {
+        Arc::new(LightClientBuilder {
+            dns_resolver: Some(dns_resolver),
+            ..self.clone()
+        })
+    }
+
     /// Construct a [`LightClient`] for a [`Wallet`].
     pub fn build(&self, wallet: &Wallet) -> Result<LightClient, LightClientBuilderError> {
         let wallet = wallet.get_wallet();
@@ -157,13 +181,18 @@ impl LightClientBuilder {
             .map(|path| PathBuf::from(&path))
             .unwrap_or(PathBuf::from(CWD_PATH));
 
-        let builder = BDKLightClientBuilder::new()
+        let mut builder = BDKLightClientBuilder::new()
             .connections(self.connections)
             .data_dir(path_buf)
             .scan_type(self.scan_type.into())
+            .log_level(self.log_level)
             .timeout_duration(Duration::from_secs(TIMEOUT))
             .peers(trusted_peers);
 
+        if let Some(ip_addr) = self.dns_resolver.clone().map(|ip| ip.inner) {
+            builder = builder.dns_resolver(ip_addr);
+        }
+
         let BDKLightClient {
             requester,
             log_subscriber,
@@ -361,6 +390,17 @@ impl From<Warn> for Warning {
     }
 }
 
+/// Select the category of messages for the node to emit.
+#[uniffi::remote(Enum)]
+pub enum LogLevel {
+    /// Send `Log::Debug` messages. These messages are intended for debugging or troubleshooting
+    /// node operation.
+    Debug,
+    /// Omit `Log::Debug` messages, including their memory allocations. Ideal for a production
+    /// application that uses minimal logging.
+    Warning,
+}
+
 /// Sync a wallet from the last known block hash, recover a wallet from a specified height,
 /// or perform an expedited block header download for a new wallet.
 #[derive(Debug, Clone, Copy, Default, uniffi::Enum)]