Client local storage for gateway details by jmwample · Pull Request #6287 · nymtech/nym

jmwample · 2025-12-12T21:45:00Z

Follow on to #6275 (changes applied to develop as part of #6249).

When we open a wss connection to the gateway we we do a DNS lookup that could be prevented be cause we digest away the information about the nodes IPs that clients keep track of.

We digest all of the relevant information about the node and its hostname, ports, and IPs
https://github.com/nymtech/nym/blob/develop/common/topology/src/node.rs

#[derive(Clone, Debug, Serialize, Deserialize)]
pub struct EntryDetails {
    // to allow client to choose ipv6 preference, if available
    pub ip_addresses: Vec<IpAddr>,
    pub clients_ws_port: u16,
    pub hostname: Option<String>,
    pub clients_wss_port: Option<u16>,
}

into a single URL / String and then ignore the rest.

format!("wss://{hostname}:{wss_port}")

format!("ws://{any_ip}:{}", entry.clients_ws_port)

Then when we go to use this url if it has a hostname we resolve it again.

In order to avoid the resolution the previous fix swapped to using ws only and preventing wss usage.

Strategy

This PR keeps the entry details, only creating the url at the last minute when we use the information so that we have all port, hostname, IP information to be used whenever it is needed.
This allows wss usage while preventing the DNS lookup.

This change is

jmwample · 2025-12-12T22:02:38Z

I am working on a vpn-client change to use this and test vpnc/vpnd with.

vercel · 2025-12-15T16:08:59Z

The latest updates on your projects. Learn more about Vercel for GitHub.

Project	Deployment	Review	Updated (UTC)
nym-explorer-v2	Ready	Preview, Comment	Dec 16, 2025 3:55pm

2 Skipped Deployments

Project	Deployment	Review	Updated (UTC)
docs-nextra	Ignored	Preview	Dec 16, 2025 3:55pm
nym-node-status	Ignored	Preview	Dec 16, 2025 3:55pm

jstuczyn · 2025-12-17T09:32:55Z

...client-core/gateways-storage/fs_gateways_migrations/20251212120000_store_gateway_details.sql

+    expiration_timestamp                     DATETIME NOT NULL
+);
+
+-- keep none, the gateways listener URL does not contain the gateway details information


but then we're losing our shared keys

jstuczyn · 2025-12-17T09:33:23Z

common/client-core/gateways-storage/src/backend/fs_backend/manager.rs

        remote: &RawRemoteGatewayDetails,
    ) -> Result<(), sqlx::Error> {
+        let details =
+            serde_json::to_string(&remote.published_data.gateway_details).expect("AHHHHHHHHH");


seems something is missing here : )

jstuczyn · 2025-12-17T09:34:48Z

common/client-core/gateways-storage/src/types.rs

 pub struct RawGatewayPublishedData {
-    pub gateway_listener: String,
-    pub fallback_listener: Option<String>,
+    #[cfg_attr(feature = "sqlx", sqlx(json))]


does json actually work with sqlx + sqlite? i.e. have you run it before? I remember I had problems with that combination in the past and json was only supported with postgres. but that was in an older version so it might have changed

jstuczyn · 2025-12-17T09:34:57Z

common/client-core/gateways-storage/src/types.rs

        Self {
-            gateway_listener: value.listeners.primary.to_string(),
-            fallback_listener: value.listeners.fallback.as_ref().map(|uri| uri.to_string()),
+            // fallback_listener: value.listeners.fallback.as_ref().map(|uri| uri.to_string()),


jstuczyn · 2025-12-17T09:35:23Z

common/client-core/gateways-storage/src/types.rs

+        //     }
+        // })?;

        Ok(GatewayPublishedData {


this now looks to be infallible, so change the TryFrom into a normal From instead

jstuczyn · 2025-12-17T09:46:38Z

common/client-libs/gateway-client/src/client/mod.rs

+            self.gateway_details
+        );
+
+        let (ws_stream, _) = connect_async(


now even though gateway might have multiple ips, we will not attempt a fallback - is this what we want?

jstuczyn · 2025-12-17T09:48:32Z

common/topology/src/node.rs


+impl std::fmt::Display for EntryDetails {
+    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
+        write!(f, "{:?}", self)


I don't think it makes sense to use Debug implementation for Display. imo it should either be properly formatted or not implemented at all if it doesn't make sense

jstuczyn · 2025-12-17T09:48:56Z

nym-api/src/network_monitor/monitor/preparer.rs


        GatewayPackets::new(
-            route.gateway_clients_address(),
+            route.gateway_details().expect("AHHHHHHH"),


jstuczyn · 2025-12-17T09:49:33Z

nym-api/src/network_monitor/monitor/sender.rs

 use nym_task::ShutdownToken;
+use nym_topology::EntryDetails;
 use pin_project::pin_project;
 use sqlx::__rt::timeout;


I know it's not your change, but I've just noticed it. wtf is this import

jstuczyn · 2025-12-17T09:51:19Z

nym-api/src/network_monitor/monitor/sender.rs

 const TIME_CHUNK_SIZE: Duration = Duration::from_millis(50);

 pub(crate) struct GatewayPackets {
    /// Network address of the target gateway if wanted to be accessed by the client.


the comment no longer makes sense

jstuczyn · 2025-12-17T13:41:34Z

oh. and quick question I forgot to ask: have you checked whether it works in WASM with the new expected data structures?

jmwample requested review from jstuczyn and simonwicky and removed request for jstuczyn December 12, 2025 21:48

jmwample force-pushed the jmwample/wss-details branch from f2bfa5f to aeeff70 Compare December 15, 2025 16:08

vercel bot deployed to Preview – nym-explorer-v2 December 15, 2025 16:15 View deployment

initial implementation pass

dba9de8

jmwample force-pushed the jmwample/wss-details branch from aeeff70 to dba9de8 Compare December 16, 2025 15:52

vercel bot deployed to Preview – nym-explorer-v2 December 16, 2025 15:55 View deployment

jstuczyn requested changes Dec 17, 2025

View reviewed changes

Conversation

jmwample commented Dec 12, 2025 • edited by mmsinclair Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Strategy

Uh oh!

jmwample commented Dec 12, 2025

Uh oh!

vercel bot commented Dec 15, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

jstuczyn commented Dec 17, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

jmwample commented Dec 12, 2025 •

edited by mmsinclair

Loading

vercel bot commented Dec 15, 2025 •

edited

Loading