GRIN/nym
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Initial changes to support extra configurable parameters and to print… #6237

Browse Source 
Improved code quality

Improve logic for mixnet traffic parameters

apply formatting (cargo fmt)

Refactor: improve code readability

Modified MixnetClientConfig and some associated functions to support some new parameters
This commit is contained in:
Nicolas Constantinides
2025-12-07 09:17:34 -05:00
committed by Jędrzej Stuczyński
parent b68e13f0f2
commit 5e67cdf56b
1 changed files with 66 additions and 10 deletions
Download Patch File Download Diff File Expand all files Collapse all files
nym-registration-client/src/builder/config.rs
+66 -10
View File
@@ -48,7 +48,7 @@ pub struct BuilderConfig {
#[derive(Clone, Default, Debug, Eq, PartialEq)]
pub struct MixnetClientConfig {
/// Disable Poission process rate limiting of outbound traffic.
pub disable_poisson_rate: bool,
pub disable_real_traffic_poisson_process: bool,
/// Disable constant rate background loop cover traffic
pub disable_background_cover_traffic: bool,
@@ -58,8 +58,16 @@ pub struct MixnetClientConfig {
/// The minimum performance of gateways to use.
pub min_gateway_performance: Option<u8>,
}
/// Setting optionally the poisson rate for cover traffic stream
pub loop_cover_traffic_average_delay: Option<Duration>,
/// Average packet delay in milliseconds.
pub average_packet_delay: Option<Duration>,
/// Average message sending delay in milliseconds.
pub message_sending_average_delay: Option<Duration>,
}
impl BuilderConfig {
pub fn mixnet_client_debug_config(&self) -> DebugConfig {
if self.two_hops {
@@ -164,13 +172,6 @@ fn mixnet_debug_config(mixnet_client_config: &MixnetClientConfig) -> DebugConfig
let mut debug_config = DebugConfig::default();
debug_config.traffic.average_packet_delay = VPN_AVERAGE_PACKET_DELAY;
debug_config
.traffic
.disable_main_poisson_packet_distribution = mixnet_client_config.disable_poisson_rate;
debug_config.cover_traffic.disable_loop_cover_traffic_stream =
mixnet_client_config.disable_background_cover_traffic;
if let Some(min_mixnode_performance) = mixnet_client_config.min_mixnode_performance {
debug_config.topology.minimum_mixnode_performance = min_mixnode_performance;
}
@@ -178,6 +179,35 @@ fn mixnet_debug_config(mixnet_client_config: &MixnetClientConfig) -> DebugConfig
if let Some(min_gateway_performance) = mixnet_client_config.min_gateway_performance {
debug_config.topology.minimum_gateway_performance = min_gateway_performance;
}
if let Some(avg_packet_ms) = mixnet_client_config.average_packet_delay {
debug_config.traffic.average_packet_delay = avg_packet_ms;
debug_config.acknowledgements.average_ack_delay = avg_packet_ms;
}
// Disable real-traffic Poisson if explicitly disabled OR delay is 0ms
debug_config
.traffic
.disable_main_poisson_packet_distribution = mixnet_client_config
.disable_real_traffic_poisson_process
|| mixnet_client_config
.message_sending_average_delay
.is_some_and(|d| d.is_zero());
if let Some(delay) = mixnet_client_config.message_sending_average_delay {
debug_config.traffic.message_sending_average_delay = delay;
}
// Disable loop cover traffic if explicitly disabled OR delay is 0ms
debug_config.cover_traffic.disable_loop_cover_traffic_stream = mixnet_client_config
.disable_background_cover_traffic
|| mixnet_client_config
.loop_cover_traffic_average_delay
.is_some_and(|d| d.is_zero());
if let Some(delay) = mixnet_client_config.loop_cover_traffic_average_delay {
debug_config.cover_traffic.loop_cover_traffic_average_delay = delay;
}
log_mixnet_client_config(&debug_config);
debug_config
}
@@ -206,6 +236,32 @@ fn log_mixnet_client_config(debug_config: &DebugConfig) {
"mixnet client minimum gateway performance: {}",
debug_config.topology.minimum_gateway_performance,
);
if !debug_config.cover_traffic.disable_loop_cover_traffic_stream {
tracing::info!(
"mixnet client loop cover traffic average delay: {} ms",
debug_config
.cover_traffic
.loop_cover_traffic_average_delay
.as_millis()
);
}
tracing::info!(
"mixnet client average packet delay: {} ms",
debug_config.traffic.average_packet_delay.as_millis()
);
if !debug_config
.traffic
.disable_main_poisson_packet_distribution
{
tracing::info!(
"mixnet client message sending average delay: {} ms",
debug_config
.traffic
.message_sending_average_delay
.as_millis()
);
}
}
fn true_to_disabled(val: bool) -> &'static str {
@@ -219,7 +275,7 @@ mod tests {
#[test]
fn test_mixnet_client_config_default_values() {
let config = MixnetClientConfig::default();
assert!(!config.disable_poisson_rate);
assert!(!config.disable_real_traffic_poisson_process);
assert!(!config.disable_background_cover_traffic);
assert_eq!(config.min_mixnode_performance, None);
assert_eq!(config.min_gateway_performance, None);