feat: make client ignore dual mode nodes by default (#5388)

common/client-core/config-types/src/lib.rs

@@ -517,7 +517,7 @@ impl Default for Acknowledgements {
 }
 
 #[derive(Debug, Clone, Copy, Deserialize, PartialEq, Serialize)]
-#[serde(default, deny_unknown_fields)]
+#[serde(default)]
 pub struct Topology {
     /// The uniform delay every which clients are querying the directory server
     /// to try to obtain a compatible network topology to send sphinx packets through.
@@ -558,6 +558,10 @@ pub struct Topology {
     /// Specifies whether this client should ignore the current epoch role of the target egress node
     /// when constructing the final hop packets.
     pub ignore_egress_epoch_role: bool,
+
+    /// Specifies whether this client should ignore the current epoch role of the ingress node
+    /// when attempting to establish new connection
+    pub ignore_ingress_epoch_role: bool,
 }
 
 #[allow(clippy::large_enum_variant)]
@@ -595,7 +599,9 @@ impl Default for Topology {
             minimum_mixnode_performance: DEFAULT_MIN_MIXNODE_PERFORMANCE,
             minimum_gateway_performance: DEFAULT_MIN_GATEWAY_PERFORMANCE,
             use_extended_topology: false,
-            ignore_egress_epoch_role: false,
+
+            ignore_egress_epoch_role: true,
+            ignore_ingress_epoch_role: true,
         }
     }
 }

common/client-core/src/cli_helpers/client_add_gateway.rs

@@ -120,6 +120,7 @@ where
             &core.client.nym_api_urls,
             user_agent,
             core.debug.topology.minimum_gateway_performance,
+            core.debug.topology.ignore_ingress_epoch_role,
         )
         .await?
     };

common/client-core/src/cli_helpers/client_init.rs

@@ -175,6 +175,7 @@ where
             &core.client.nym_api_urls,
             user_agent,
             core.debug.topology.minimum_gateway_performance,
+            core.debug.topology.ignore_ingress_epoch_role,
         )
         .await?
     };

common/client-core/src/init/helpers.rs

@@ -91,6 +91,7 @@ pub async fn gateways_for_init<R: Rng>(
     nym_apis: &[Url],
     user_agent: Option<UserAgent>,
     minimum_performance: u8,
+    ignore_epoch_roles: bool,
 ) -> Result<Vec<RoutingNode>, ClientCoreError> {
     let nym_api = nym_apis
         .choose(rng)
@@ -112,7 +113,7 @@ pub async fn gateways_for_init<R: Rng>(
     // (we don't want instability)
     let valid_gateways = gateways
         .iter()
-        .filter(|g| !g.supported_roles.mixnode)
+        .filter(|g| !ignore_epoch_roles && !g.supported_roles.mixnode)
         .filter(|g| g.performance.round_to_integer() >= minimum_performance)
         .filter_map(|gateway| gateway.try_into().ok())
         .collect::<Vec<_>>();

common/wasm/client-core/src/config/mod.rs

@@ -395,6 +395,10 @@ pub struct TopologyWasm {
     /// Specifies whether this client should ignore the current epoch role of the target egress node
     /// when constructing the final hop packets.
     pub ignore_egress_epoch_role: bool,
+
+    /// Specifies whether this client should ignore the current epoch role of the ingress node
+    /// when attempting to establish new connection
+    pub ignore_ingress_epoch_role: bool,
 }
 
 impl Default for TopologyWasm {
@@ -419,6 +423,7 @@ impl From<TopologyWasm> for ConfigTopology {
             minimum_gateway_performance: topology.minimum_gateway_performance,
             use_extended_topology: topology.use_extended_topology,
             ignore_egress_epoch_role: topology.ignore_egress_epoch_role,
+            ignore_ingress_epoch_role: topology.ignore_ingress_epoch_role,
         }
     }
 }
@@ -436,6 +441,7 @@ impl From<ConfigTopology> for TopologyWasm {
             minimum_gateway_performance: topology.minimum_gateway_performance,
             use_extended_topology: topology.use_extended_topology,
             ignore_egress_epoch_role: topology.ignore_egress_epoch_role,
+            ignore_ingress_epoch_role: topology.ignore_ingress_epoch_role,
         }
     }
 }

common/wasm/client-core/src/config/override.rs

@@ -281,6 +281,11 @@ pub struct TopologyWasmOverride {
     /// when constructing the final hop packets.
     #[tsify(optional)]
     pub ignore_egress_epoch_role: Option<bool>,
+
+    /// Specifies whether this client should ignore the current epoch role of the ingress node
+    /// when attempting to establish new connection
+    #[tsify(optional)]
+    pub ignore_ingress_epoch_role: Option<bool>,
 }
 
 impl From<TopologyWasmOverride> for TopologyWasm {
@@ -310,6 +315,9 @@ impl From<TopologyWasmOverride> for TopologyWasm {
             ignore_egress_epoch_role: value
                 .ignore_egress_epoch_role
                 .unwrap_or(def.ignore_egress_epoch_role),
+            ignore_ingress_epoch_role: value
+                .ignore_ingress_epoch_role
+                .unwrap_or(def.ignore_ingress_epoch_role),
         }
     }
 }

common/wasm/client-core/src/helpers.rs

@@ -132,9 +132,17 @@ pub async fn setup_gateway_from_api(
     chosen_gateway: Option<IdentityKey>,
     nym_apis: &[Url],
     minimum_performance: u8,
+    ignore_epoch_roles: bool,
 ) -> Result<InitialisationResult, WasmCoreError> {
     let mut rng = thread_rng();
-    let gateways = gateways_for_init(&mut rng, nym_apis, None, minimum_performance).await?;
+    let gateways = gateways_for_init(
+        &mut rng,
+        nym_apis,
+        None,
+        minimum_performance,
+        ignore_epoch_roles,
+    )
+    .await?;
     setup_gateway_wasm(client_store, force_tls, chosen_gateway, gateways).await
 }
 
@@ -142,9 +150,17 @@ pub async fn current_gateways_wasm(
     nym_apis: &[Url],
     user_agent: Option<UserAgent>,
     minimum_performance: u8,
+    ignore_epoch_roles: bool,
 ) -> Result<Vec<RoutingNode>, ClientCoreError> {
     let mut rng = thread_rng();
-    gateways_for_init(&mut rng, nym_apis, user_agent, minimum_performance).await
+    gateways_for_init(
+        &mut rng,
+        nym_apis,
+        user_agent,
+        minimum_performance,
+        ignore_epoch_roles,
+    )
+    .await
 }
 
 pub async fn setup_from_topology(
@@ -163,6 +179,7 @@ pub async fn generate_new_client_keys(store: &ClientStorage) -> Result<(), WasmC
     Ok(())
 }
 
+#[allow(clippy::too_many_arguments)]
 pub async fn add_gateway(
     preferred_gateway: Option<IdentityKey>,
     latency_based_selection: Option<bool>,
@@ -170,6 +187,7 @@ pub async fn add_gateway(
     nym_apis: &[Url],
     user_agent: UserAgent,
     min_performance: u8,
+    ignore_epoch_roles: bool,
     storage: &ClientStorage,
 ) -> Result<(), WasmCoreError> {
     let selection_spec = GatewaySelectionSpecification::new(
@@ -203,8 +221,13 @@ pub async fn add_gateway(
 
     // Setup gateway by either registering a new one, or creating a new config from the selected
     // one but with keys kept, or reusing the gateway configuration.
-    let available_gateways =
-        current_gateways_wasm(nym_apis, Some(user_agent), min_performance).await?;
+    let available_gateways = current_gateways_wasm(
+        nym_apis,
+        Some(user_agent),
+        min_performance,
+        ignore_epoch_roles,
+    )
+    .await?;
 
     // since we're registering with a brand new gateway,
     // make sure the list of available gateways doesn't overlap the list of known gateways

nym-wallet/Cargo.lock

@@ -4223,7 +4223,7 @@ dependencies = [
  "itertools 0.13.0",
  "proc-macro2",
  "quote",
- "syn 2.0.85",
+ "syn 2.0.96",
 ]
 
 [[package]]

sdk/rust/nym-sdk/src/mixnet/client.rs

@@ -489,7 +489,7 @@ where
         user_chosen_gateway: &str,
     ) -> Result<bool> {
         let storage = self.storage.gateway_details_store();
-        // Stricly speaking, `set_active_gateway` does this check internally as well, but since the
+        // Strictly speaking, `set_active_gateway` does this check internally as well, but since the
         // error is boxed away and we're using a generic storage, it's not so easy to match on it.
         // This function is at least less likely to fail on something unrelated to the existence of
         // the gateway in the set of registered gateways
@@ -512,15 +512,14 @@ where
 
         let user_agent = self.user_agent.clone();
 
+        let topology_cfg = &self.config.debug_config.topology;
         let mut rng = OsRng;
         let available_gateways = gateways_for_init(
             &mut rng,
             &nym_api_endpoints,
             user_agent,
-            self.config
-                .debug_config
-                .topology
-                .minimum_gateway_performance,
+            topology_cfg.minimum_gateway_performance,
+            topology_cfg.ignore_ingress_epoch_role,
         )
         .await?;
 

wasm/client/src/client.rs

@@ -217,6 +217,7 @@ impl NymClientBuilder {
                 &self.config.base.client.nym_api_urls,
                 bin_info!().into(),
                 self.config.base.debug.topology.minimum_gateway_performance,
+                self.config.base.debug.topology.ignore_ingress_epoch_role,
                 &client_store,
             )
             .await?;

wasm/mix-fetch/src/client.rs

@@ -156,6 +156,7 @@ impl MixFetchClientBuilder {
                 &self.config.base.client.nym_api_urls,
                 bin_info!().into(),
                 self.config.base.debug.topology.minimum_gateway_performance,
+                self.config.base.debug.topology.ignore_ingress_epoch_role,
                 &client_store,
             )
             .await?;