feat: update version to 0.40.0 and implement user agent configuration (#133)

QuantumExplorer · web-flow · commit 576703c44fbe · 2025-09-03T15:29:33.000+07:00
* feat: update version to 0.40.0 and implement user agent configuration

* updated docs

* fix

* fix
diff --git a/Cargo.toml b/Cargo.toml
@@ -3,7 +3,7 @@ members = ["dash", "dash-network", "dash-network-ffi", "hashes", "internals", "f
 resolver = "2"
 
 [workspace.package]
-version = "0.39.6"
+version = "0.40.0"
 
 [patch.crates-io]
 dashcore_hashes = { path = "hashes" }
diff --git a/dash-network-ffi/Cargo.toml b/dash-network-ffi/Cargo.toml
@@ -1,6 +1,6 @@
 [package]
 name = "dash-network-ffi"
-version.workspace = true
+version = { workspace = true }
 edition = "2021"
 authors = ["Quantum Explorer <quantum@dash.org>"]
 license = "CC0-1.0"
diff --git a/dash-network/README.md b/dash-network/README.md
@@ -19,7 +19,7 @@ Add this to your `Cargo.toml`:
 
 ```toml
 [dependencies]
-dash-network = "0.39.6"
+dash-network = "0.40.0"
 ```
 
 ### Basic Example
diff --git a/dash-spv-ffi/Cargo.toml b/dash-spv-ffi/Cargo.toml
@@ -1,6 +1,6 @@
 [package]
 name = "dash-spv-ffi"
-version = "0.1.0"
+version = { workspace = true }
 edition = "2021"
 authors = ["Dash Core Developers"]
 license = "MIT"
diff --git a/dash-spv-ffi/FFI_API.md b/dash-spv-ffi/FFI_API.md
@@ -59,7 +59,7 @@ Functions: 25
 | `dash_spv_ffi_config_set_persist_mempool` | Sets whether to persist mempool state to disk  # Safety - `config` must be a ... | config |
 | `dash_spv_ffi_config_set_relay_transactions` | Sets whether to relay transactions (currently a no-op)  # Safety - `config` m... | config |
 | `dash_spv_ffi_config_set_start_from_height` | Sets the starting block height for synchronization  # Safety - `config` must ... | config |
-| `dash_spv_ffi_config_set_user_agent` | Sets the user agent string (currently not supported)  # Safety - `config` mus... | config |
+| `dash_spv_ffi_config_set_user_agent` | Sets the user agent string to advertise in the P2P handshake  # Safety - `con... | config |
 | `dash_spv_ffi_config_set_validation_mode` | Sets the validation mode for the SPV client  # Safety - `config` must be a va... | config |
 | `dash_spv_ffi_config_set_wallet_creation_time` | Sets the wallet creation timestamp for synchronization optimization  # Safety... | config |
 | `dash_spv_ffi_config_testnet` | No description | config |
@@ -555,7 +555,7 @@ dash_spv_ffi_config_set_user_agent(config: *mut FFIClientConfig, user_agent: *co
 ```
 
 **Description:**
-Sets the user agent string (currently not supported)  # Safety - `config` must be a valid pointer to an FFIClientConfig created by dash_spv_ffi_config_new/mainnet/testnet - `user_agent` must be a valid null-terminated C string - The caller must ensure both pointers remain valid for the duration of this call
+Sets the user agent string to advertise in the P2P handshake  # Safety - `config` must be a valid pointer to an FFIClientConfig created by dash_spv_ffi_config_new/mainnet/testnet - `user_agent` must be a valid null-terminated C string - The caller must ensure both pointers remain valid for the duration of this call
 
 **Safety:**
 - `config` must be a valid pointer to an FFIClientConfig created by dash_spv_ffi_config_new/mainnet/testnet - `user_agent` must be a valid null-terminated C string - The caller must ensure both pointers remain valid for the duration of this call
diff --git a/dash-spv-ffi/include/dash_spv_ffi.h b/dash-spv-ffi/include/dash_spv_ffi.h
@@ -518,7 +518,7 @@ int32_t dash_spv_ffi_config_add_peer(FFIClientConfig *config,
                                      const char *addr);
 
 /**
- * Sets the user agent string (currently not supported)
+ * Sets the user agent string to advertise in the P2P handshake
  *
  * # Safety
  * - `config` must be a valid pointer to an FFIClientConfig created by dash_spv_ffi_config_new/mainnet/testnet
diff --git a/dash-spv-ffi/src/config.rs b/dash-spv-ffi/src/config.rs
@@ -146,7 +146,7 @@ pub unsafe extern "C" fn dash_spv_ffi_config_add_peer(
     }
 }
 
-/// Sets the user agent string (currently not supported)
+/// Sets the user agent string to advertise in the P2P handshake
 ///
 /// # Safety
 /// - `config` must be a valid pointer to an FFIClientConfig created by dash_spv_ffi_config_new/mainnet/testnet
@@ -162,10 +162,11 @@ pub unsafe extern "C" fn dash_spv_ffi_config_set_user_agent(
 
     // Validate the user_agent string
     match CStr::from_ptr(user_agent).to_str() {
-        Ok(_agent_str) => {
-            // user_agent is not directly settable in current ClientConfig
-            set_last_error("Setting user agent is not supported in current implementation");
-            FFIErrorCode::ConfigError as i32
+        Ok(agent_str) => {
+            // Store as-is; normalization/length capping is applied at handshake build time
+            let cfg = &mut (*config).inner;
+            cfg.user_agent = Some(agent_str.to_string());
+            FFIErrorCode::Success as i32
         }
         Err(e) => {
             set_last_error(&format!("Invalid UTF-8 in user agent: {}", e));
diff --git a/dash-spv-ffi/tests/test_config.rs b/dash-spv-ffi/tests/test_config.rs
@@ -127,7 +127,7 @@ mod tests {
 
             let agent = CString::new("TestAgent/1.0").unwrap();
             let result = dash_spv_ffi_config_set_user_agent(config, agent.as_ptr());
-            assert_eq!(result, FFIErrorCode::ConfigError as i32);
+            assert_eq!(result, FFIErrorCode::Success as i32);
 
             dash_spv_ffi_config_destroy(config);
         }
diff --git a/dash-spv-ffi/tests/unit/test_configuration.rs b/dash-spv-ffi/tests/unit/test_configuration.rs
@@ -185,7 +185,7 @@ mod tests {
             let user_agent = CString::new("TestAgent/1.0").unwrap();
             assert_eq!(
                 dash_spv_ffi_config_set_user_agent(config, user_agent.as_ptr()),
-                FFIErrorCode::ConfigError as i32
+                FFIErrorCode::Success as i32
             );
 
             assert_eq!(
diff --git a/dash-spv/Cargo.toml b/dash-spv/Cargo.toml
@@ -1,6 +1,6 @@
 [package]
 name = "dash-spv"
-version = "0.1.0"
+version = { workspace = true }
 edition = "2021"
 authors = ["Dash Core Team"]
 description = "Dash SPV (Simplified Payment Verification) client library"
diff --git a/dash-spv/src/client/config.rs b/dash-spv/src/client/config.rs
@@ -69,6 +69,10 @@ pub struct ClientConfig {
     /// Log level for tracing.
     pub log_level: String,
 
+    /// Optional user agent string to advertise in the P2P version message.
+    /// If not set, a sensible default is used (includes crate version).
+    pub user_agent: Option<String>,
+
     /// Maximum concurrent filter requests (default: 8).
     pub max_concurrent_filter_requests: usize,
 
@@ -192,6 +196,7 @@ impl Default for ClientConfig {
             max_peers: 8,
             enable_persistence: true,
             log_level: "info".to_string(),
+            user_agent: None,
             max_concurrent_filter_requests: 16,
             enable_filter_flow_control: true,
             filter_request_delay_ms: 0,
@@ -306,6 +311,13 @@ impl ClientConfig {
         self
     }
 
+    /// Set custom user agent string for the P2P handshake.
+    /// The library will lightly validate and normalize it during handshake.
+    pub fn with_user_agent(mut self, agent: impl Into<String>) -> Self {
+        self.user_agent = Some(agent.into());
+        self
+    }
+
     /// Set maximum concurrent filter requests.
     pub fn with_max_concurrent_filter_requests(mut self, max_requests: usize) -> Self {
         self.max_concurrent_filter_requests = max_requests;
diff --git a/dash-spv/src/network/handshake.rs b/dash-spv/src/network/handshake.rs
@@ -40,11 +40,16 @@ pub struct HandshakeManager {
     verack_received: bool,
     version_sent: bool,
     mempool_strategy: MempoolStrategy,
+    user_agent: Option<String>,
 }
 
 impl HandshakeManager {
     /// Create a new handshake manager.
-    pub fn new(network: Network, mempool_strategy: MempoolStrategy) -> Self {
+    pub fn new(
+        network: Network,
+        mempool_strategy: MempoolStrategy,
+        user_agent: Option<String>,
+    ) -> Self {
         Self {
             _network: network,
             state: HandshakeState::Init,
@@ -55,6 +60,7 @@ impl HandshakeManager {
             verack_received: false,
             version_sent: false,
             mempool_strategy,
+            user_agent,
         }
     }
 
@@ -254,14 +260,29 @@ impl HandshakeManager {
             .parse()
             .map_err(|_| NetworkError::AddressParse("Failed to parse local address".to_string()))?;
 
+        // Determine user agent: prefer configured value, else default to crate/version.
+        let default_agent = format!("/rust-dash-spv:{}/", env!("CARGO_PKG_VERSION"));
+        let mut ua = self.user_agent.clone().unwrap_or(default_agent);
+        // Normalize: ensure it starts and ends with '/'; trim if excessively long.
+        if !ua.starts_with('/') {
+            ua.insert(0, '/');
+        }
+        if !ua.ends_with('/') {
+            ua.push('/');
+        }
+        // Keep within a reasonable bound (match peer validation bound of 256)
+        if ua.len() > 256 {
+            ua.truncate(256);
+        }
+
         Ok(VersionMessage {
             version: self.our_version,
             services,
             timestamp,
             receiver: dashcore::network::address::Address::new(&address, ServiceFlags::NETWORK),
             sender: dashcore::network::address::Address::new(&local_addr, services),
             nonce: rand::random(),
-            user_agent: "/rust-dash-spv:0.1.0/".to_string(),
+            user_agent: ua,
             start_height: 0, // SPV client starts at 0
             relay: match self.mempool_strategy {
                 MempoolStrategy::FetchAll => true, // Want all transactions for FetchAll strategy
diff --git a/dash-spv/src/network/mod.rs b/dash-spv/src/network/mod.rs
@@ -168,7 +168,11 @@ impl TcpNetworkManager {
         Ok(Self {
             config: config.clone(),
             connection: None,
-            handshake: HandshakeManager::new(config.network, config.mempool_strategy),
+            handshake: HandshakeManager::new(
+                config.network,
+                config.mempool_strategy,
+                config.user_agent.clone(),
+            ),
             _message_handler: MessageHandler::new(),
             message_sender,
             dsq_preference: false,
diff --git a/dash-spv/src/network/multi_peer.rs b/dash-spv/src/network/multi_peer.rs
@@ -66,6 +66,8 @@ pub struct MultiPeerNetworkManager {
     read_timeout: Duration,
     /// Track which peers have sent us Headers2 messages
     peers_sent_headers2: Arc<Mutex<HashSet<SocketAddr>>>,
+    /// Optional user agent to advertise
+    user_agent: Option<String>,
 }
 
 impl MultiPeerNetworkManager {
@@ -114,6 +116,7 @@ impl MultiPeerNetworkManager {
             last_message_peer: Arc::new(Mutex::new(None)),
             read_timeout: config.read_timeout,
             peers_sent_headers2: Arc::new(Mutex::new(HashSet::new())),
+            user_agent: config.user_agent.clone(),
         })
     }
 
@@ -202,6 +205,7 @@ impl MultiPeerNetworkManager {
         let reputation_manager = self.reputation_manager.clone();
         let mempool_strategy = self.mempool_strategy;
         let read_timeout = self.read_timeout;
+        let user_agent = self.user_agent.clone();
 
         // Spawn connection task
         let mut tasks = self.tasks.lock().await;
@@ -213,7 +217,8 @@ impl MultiPeerNetworkManager {
             {
                 Ok(mut conn) => {
                     // Perform handshake
-                    let mut handshake_manager = HandshakeManager::new(network, mempool_strategy);
+                    let mut handshake_manager =
+                        HandshakeManager::new(network, mempool_strategy, user_agent);
                     match handshake_manager.perform_handshake(&mut conn).await {
                         Ok(_) => {
                             log::info!("Successfully connected to {}", addr);
@@ -971,6 +976,7 @@ impl Clone for MultiPeerNetworkManager {
             last_message_peer: self.last_message_peer.clone(),
             read_timeout: self.read_timeout,
             peers_sent_headers2: self.peers_sent_headers2.clone(),
+            user_agent: self.user_agent.clone(),
         }
     }
 }
diff --git a/dash-spv/src/network/tests.rs b/dash-spv/src/network/tests.rs
@@ -178,6 +178,7 @@ mod multi_peer_tests {
             // QRInfo fields
             qr_info_extra_share: true,
             qr_info_timeout: Duration::from_secs(30),
+            user_agent: None,
         }
     }
 
diff --git a/dash-spv/tests/test_handshake_logic.rs b/dash-spv/tests/test_handshake_logic.rs
@@ -6,7 +6,7 @@ use dashcore::Network;
 
 #[test]
 fn test_handshake_state_transitions() {
-    let mut handshake = HandshakeManager::new(Network::Dash, MempoolStrategy::Selective);
+    let mut handshake = HandshakeManager::new(Network::Dash, MempoolStrategy::Selective, None);
 
     // Initial state should be Init
     assert_eq!(*handshake.state(), HandshakeState::Init);
diff --git a/key-wallet-ffi/Cargo.toml b/key-wallet-ffi/Cargo.toml
@@ -1,6 +1,6 @@
 [package]
 name = "key-wallet-ffi"
-version = "0.39.6"
+version = { workspace = true }
 authors = ["The Dash Core Developers"]
 edition = "2021"
 description = "FFI bindings for key-wallet library"
diff --git a/key-wallet-ffi/include/key_wallet_ffi.h b/key-wallet-ffi/include/key_wallet_ffi.h
diff --git a/key-wallet-manager/Cargo.toml b/key-wallet-manager/Cargo.toml
diff --git a/key-wallet/Cargo.toml b/key-wallet/Cargo.toml
diff --git a/swift-dash-core-sdk/Sources/DashSPVFFI/include/dash_spv_ffi.h b/swift-dash-core-sdk/Sources/DashSPVFFI/include/dash_spv_ffi.h
diff --git a/swift-dash-core-sdk/Sources/SwiftDashCoreSDK/Core/SPVClientConfiguration.swift b/swift-dash-core-sdk/Sources/SwiftDashCoreSDK/Core/SPVClientConfiguration.swift

Original file line number	Diff line number	Diff line change
`@@ -518,7 +518,7 @@ int32_t dash_spv_ffi_config_add_peer(FFIClientConfig *config,`
`518`	`518`	`const char *addr);`
`519`	`519`
`520`	`520`	`/**`
`521`		`- * Sets the user agent string (currently not supported)`
	`521`	`+ * Sets the user agent string to advertise in the P2P handshake`
`522`	`522`	`*`
`523`	`523`	`* # Safety`
`524`	`524`	* - `config` must be a valid pointer to an FFIClientConfig created by dash_spv_ffi_config_new/mainnet/testnet
Original file line number	Diff line number	Diff line change
`@@ -127,7 +127,7 @@ mod tests {`
`127`	`127`
`128`	`128`	`let agent = CString::new("TestAgent/1.0").unwrap();`
`129`	`129`	`let result = dash_spv_ffi_config_set_user_agent(config, agent.as_ptr());`
`130`		`- assert_eq!(result, FFIErrorCode::ConfigError as i32);`
	`130`	`+ assert_eq!(result, FFIErrorCode::Success as i32);`
`131`	`131`
`132`	`132`	`dash_spv_ffi_config_destroy(config);`
`133`	`133`	`}`