rust: update electrum-client to 0.13.0

To properly handle some invalid proxy values.

Co-authored-by: noib3 <[email protected]>

Author: noib3

subprojects/gdk_rust/Cargo.lock

@@ -10,7 +10,7 @@ testing = [ "gdk-common/testing" ]
 [dependencies]
 base64 = "0.13"
 block-modes = "0.8.0"
-electrum-client = { version = "0.12.0", default-features = false, features = [ "proxy", "use-openssl" ] }
+electrum-client = { version = "0.13.0", default-features = false, features = [ "proxy", "use-openssl" ] }
 gdk-common = { path = "../gdk_common" }
 gdk-registry = { path = "../gdk_registry" }
 gdk-pin-client = { path = "../gdk_pin_client" }

subprojects/gdk_rust/gdk_electrum/Cargo.toml

@@ -2,7 +2,7 @@ use serde::{Deserialize, Serialize};
 
 use crate::error::*;
 
-use electrum_client::{Client, ConfigBuilder};
+use electrum_client::{Client, ConfigBuilder, Socks5Config};
 use gdk_common::network::NETWORK_REQUEST_TIMEOUT;
 use std::str::FromStr;
 
@@ -17,13 +17,15 @@ impl ElectrumUrl {
         let mut config = ConfigBuilder::new();
 
         // TODO: add support for socks5 credentials?
-        config = config.socks5(
-            proxy.filter(|p| !p.trim().is_empty()).map(|p| electrum_client::Socks5Config::new(p)),
-        )?;
+        if let Some(proxy) = proxy {
+            if !proxy.trim().is_empty() {
+                config = config.socks5(Some(Socks5Config::new(proxy)));
+            }
+        }
 
         let timeout = timeout.unwrap_or(NETWORK_REQUEST_TIMEOUT.as_secs() as u8);
 
-        config = config.timeout(Some(timeout))?;
+        config = config.timeout(Some(timeout));
 
         let (url, config) = match self {
             ElectrumUrl::Tls(url, validate) => {
@@ -85,6 +87,8 @@ mod test {
     use gdk_common::scripts::p2shwpkh_script_sig;
     use std::str::FromStr;
 
+    use super::*;
+
     fn p2pkh_hex(pk: &str) -> (PublicKey, Script) {
         let pk = Vec::<u8>::from_hex(pk).unwrap();
         let pk = PublicKey::from_slice(pk.as_slice()).unwrap();
@@ -191,4 +195,38 @@ mod test {
         let script_sig = p2shwpkh_script_sig(&public_key);
         assert_eq!(tx.input[0].script_sig, script_sig);
     }
+
+    /// Tests that passing an invalid proxy to `ElectrumUrl::build_client()`
+    /// immediately results in an error.
+    #[test]
+    fn invalid_proxy() {
+        let url = ElectrumUrl::Plaintext(String::new());
+
+        let invalid_proxy = "socks5://3.4.5.6";
+
+        assert!(matches!(
+            url.build_client(Some(invalid_proxy), None),
+
+            Err(Error::ClientError(electrum_client::Error::IOError(err)))
+                if err.kind() == std::io::ErrorKind::InvalidInput,
+        ));
+    }
+
+    #[test]
+    fn valid_proxy() {
+        let url = ElectrumUrl::Plaintext(String::new());
+
+        // `build_client()` can still return an error, here we're just checking
+        // that the error it returns (if any) is not caused by an incorrectly
+        // formatted proxy.
+
+        for valid_proxy in ["127.0.0.1:9050", "socks5://127.0.0.1:9050"] {
+            assert!(!matches!(
+                url.build_client(Some(valid_proxy), None),
+
+                Err(Error::ClientError(electrum_client::Error::IOError(err)))
+                    if err.kind() == std::io::ErrorKind::InvalidInput,
+            ));
+        }
+    }
 }

subprojects/gdk_rust/gdk_electrum/src/interface.rs

@@ -24,7 +24,7 @@ android_logger = "0.8.6"
 [dev-dependencies]
 gdk-test = { path = "../gdk_test" }
 tempfile = "3.2.0"
-electrum-client = { version = "0.12.0", default-features = false, features = [ "proxy", "use-openssl" ] }
+electrum-client = { version = "0.13.0", default-features = false, features = [ "proxy", "use-openssl" ] }
 bitcoin = { version = "0.29", features = [ "serde" ] }
 elements = { version = "0.20", features = ["serde"] }
 # TODO: remove "legacy" feature when upgrading electrs binaries

subprojects/gdk_rust/gdk_rust/Cargo.toml

@@ -4,7 +4,7 @@ use std::thread;
 use std::time::{Duration, Instant};
 
 use electrsd::bitcoind::bitcoincore_rpc::RpcApi;
-use electrum_client::ElectrumApi;
+use electrsd::electrum_client::ElectrumApi;
 use gdk_common::bitcoin::util::bip32::DerivationPath;
 use gdk_common::bitcoin::Witness;
 use gdk_common::log::info;

subprojects/gdk_rust/gdk_rust/tests/integration/integration.rs

@@ -5,7 +5,7 @@ edition = "2021"
 
 [dependencies]
 electrsd = { version = "0.22.0", features = [ "legacy" ] }
-electrum-client = { version = "0.12.0", default-features = false, features = [ "proxy", "use-openssl" ] }
+electrum-client = { version = "0.13.0", default-features = false, features = [ "proxy", "use-openssl" ] }
 env_logger = "0.10.0"
 gdk-common = { path = "../gdk_common" }
 gdk-electrum = { path = "../gdk_electrum", features = ["testing"] }

subprojects/gdk_rust/gdk_test/Cargo.toml

@@ -3,7 +3,7 @@ use std::thread;
 use std::time::Duration;
 
 use electrsd::bitcoind::bitcoincore_rpc::RpcApi;
-use electrum_client::ElectrumApi;
+use electrsd::electrum_client::ElectrumApi;
 use gdk_common::bitcoin::hashes::hex::FromHex;
 use gdk_common::bitcoin::secp256k1::SecretKey;
 use gdk_common::bitcoin::Amount;