Move const to wireguard types

Use a more proper timeout value
2024-08-06 14:10:31 +00:00 · 2024-08-06 14:10:31 +00:00
47 changed files with 275 additions and 895 deletions
@@ -6242,6 +6242,7 @@ name = "nym-wireguard-types"
 version = "0.1.0"
 dependencies = [
 "base64 0.21.7",
+ "dashmap",
 "hmac",
 "log",
 "nym-config",
@@ -422,7 +422,7 @@ impl Handler {
    ) {
        // We don't want a crash in the connection handler to trigger a shutdown of the whole
        // process.
-        task_client.disarm();
+        task_client.mark_as_success();

        let ws_stream = match accept_async(socket).await {
            Ok(ws_stream) => ws_stream,
@@ -455,7 +455,7 @@ where
                Err(ClientCoreError::CustomGatewaySelectionExpected)
            } else {
                // and make sure to invalidate the task client so we wouldn't cause premature shutdown
-                shutdown.disarm();
+                shutdown.mark_as_success();
                custom_gateway_transceiver.set_packet_router(packet_router)?;
                Ok(custom_gateway_transceiver)
            };
@@ -562,7 +562,7 @@ where
        if topology_config.disable_refreshing {
            // if we're not spawning the refresher, don't cause shutdown immediately
            info!("The topology refesher is not going to be started");
-            shutdown.disarm();
+            shutdown.mark_as_success();
        } else {
            // don't spawn the refresher if we don't want to be refreshing the topology.
            // only use the initial values obtained
@@ -474,6 +474,13 @@ where
            Poll::Ready(Some((real_messages, conn_id))) => {
                log::trace!("handling real_messages: size: {}", real_messages.len());

+                // This is the last step in the pipeline where we know the type of the message, so
+                // lets count the number of retransmissions here.
+                if conn_id == TransmissionLane::Retransmission {
+                    self.stats_tx
+                        .report(PacketStatisticsEvent::RetransmissionQueued);
+                }
+
                // First store what we got for the given connection id
                self.transmission_buffer.store(&conn_id, real_messages);
                let real_next = self.pop_next_message().expect("we just added one");
@@ -46,34 +46,13 @@ const MEASUREMENTS: usize = 3;
 const CONN_TIMEOUT: Duration = Duration::from_millis(1500);
 const PING_TIMEOUT: Duration = Duration::from_millis(1000);

-// The abstraction that some of these helpers use
-pub trait ConnectableGateway {
-    fn identity(&self) -> &identity::PublicKey;
-    fn clients_address(&self) -> String;
-    fn is_wss(&self) -> bool;
-}
-
-impl ConnectableGateway for gateway::Node {
-    fn identity(&self) -> &identity::PublicKey {
-        self.identity()
-    }
-
-    fn clients_address(&self) -> String {
-        self.clients_address()
-    }
-
-    fn is_wss(&self) -> bool {
-        self.clients_wss_port.is_some()
-    }
-}
-
-struct GatewayWithLatency<'a, G: ConnectableGateway> {
-    gateway: &'a G,
+struct GatewayWithLatency<'a> {
+    gateway: &'a gateway::Node,
    latency: Duration,
 }

-impl<'a, G: ConnectableGateway> GatewayWithLatency<'a, G> {
-    fn new(gateway: &'a G, latency: Duration) -> Self {
+impl<'a> GatewayWithLatency<'a> {
+    fn new(gateway: &'a gateway::Node, latency: Duration) -> Self {
        GatewayWithLatency { gateway, latency }
    }
 }
@@ -151,14 +130,11 @@ async fn connect(endpoint: &str) -> Result<WsConn, ClientCoreError> {
    JSWebsocket::new(endpoint).map_err(|_| ClientCoreError::GatewayJsConnectionFailure)
 }

-async fn measure_latency<G>(gateway: &G) -> Result<GatewayWithLatency<G>, ClientCoreError>
-where
-    G: ConnectableGateway,
-{
+async fn measure_latency(gateway: &gateway::Node) -> Result<GatewayWithLatency, ClientCoreError> {
    let addr = gateway.clients_address();
    trace!(
        "establishing connection to {} ({addr})...",
-        gateway.identity(),
+        gateway.identity_key,
    );
    let mut stream = connect(&addr).await?;

@@ -201,7 +177,7 @@ where
    let count = results.len() as u64;
    if count == 0 {
        return Err(ClientCoreError::NoGatewayMeasurements {
-            identity: gateway.identity().to_base58_string(),
+            identity: gateway.identity_key.to_base58_string(),
        });
    }

@@ -211,11 +187,11 @@ where
    Ok(GatewayWithLatency::new(gateway, avg))
 }

-pub async fn choose_gateway_by_latency<'a, R: Rng, G: ConnectableGateway + Clone>(
+pub async fn choose_gateway_by_latency<R: Rng>(
    rng: &mut R,
-    gateways: &[G],
+    gateways: &[gateway::Node],
    must_use_tls: bool,
-) -> Result<G, ClientCoreError> {
+) -> Result<gateway::Node, ClientCoreError> {
    let gateways = filter_by_tls(gateways, must_use_tls)?;

    info!(
@@ -247,19 +223,21 @@ pub async fn choose_gateway_by_latency<'a, R: Rng, G: ConnectableGateway + Clone

    info!(
        "chose gateway {} with average latency of {:?}",
-        chosen.gateway.identity(),
-        chosen.latency
+        chosen.gateway.identity_key, chosen.latency
    );

    Ok(chosen.gateway.clone())
 }

-fn filter_by_tls<G: ConnectableGateway>(
-    gateways: &[G],
+fn filter_by_tls(
+    gateways: &[gateway::Node],
    must_use_tls: bool,
-) -> Result<Vec<&G>, ClientCoreError> {
+) -> Result<Vec<&gateway::Node>, ClientCoreError> {
    if must_use_tls {
-        let filtered = gateways.iter().filter(|g| g.is_wss()).collect::<Vec<_>>();
+        let filtered = gateways
+            .iter()
+            .filter(|g| g.clients_wss_port.is_some())
+            .collect::<Vec<_>>();

        if filtered.is_empty() {
            return Err(ClientCoreError::NoWssGateways);
@@ -70,8 +70,8 @@ impl PacketRouter {
        Ok(())
    }

-    pub fn disarm(&mut self) {
-        self.shutdown.disarm();
+    pub fn mark_as_success(&mut self) {
+        self.shutdown.mark_as_success();
    }
 }

@@ -113,8 +113,8 @@ impl PartiallyDelegatedRouter {
        let return_res = match ret {
            Err(err) => self.stream_return.send(Err(err)),
            Ok(_) => {
-                self.packet_router.disarm();
-                task_client.disarm();
+                self.packet_router.mark_as_success();
+                task_client.mark_as_success();
                self.stream_return.send(Ok(split_stream))
            }
        };
@@ -57,7 +57,7 @@ impl PacketListener {
            // cloning the arc as each accepted socket is handled in separate task
            let connection_handler = Arc::clone(&self.connection_handler);
            let mut handler_shutdown_listener = self.shutdown.clone();
-            handler_shutdown_listener.disarm();
+            handler_shutdown_listener.mark_as_success();

            tokio::select! {
                socket = listener.accept() => {
@@ -245,7 +245,7 @@ impl VerlocMeasurer {
        }

        let mut shutdown_listener = self.shutdown_listener.clone().named("VerlocMeasurement");
-        shutdown_listener.disarm();
+        shutdown_listener.mark_as_success();

        for chunk in nodes_to_test.chunks(self.config.tested_nodes_batch_size) {
            let mut chunk_results = Vec::with_capacity(chunk.len());
@@ -84,7 +84,7 @@ impl PacketSender {
        tested_node: TestedNode,
    ) -> Result<VerlocMeasurement, RttError> {
        let mut shutdown_listener = self.shutdown_listener.fork(tested_node.address.to_string());
-        shutdown_listener.disarm();
+        shutdown_listener.mark_as_success();

        let mut conn = match tokio::time::timeout(
            self.connection_timeout,
@@ -218,7 +218,7 @@ impl SocksClient {
        packet_type: Option<PacketType>,
    ) -> Self {
        // If this task fails and exits, we don't want to send shutdown signal
-        shutdown_listener.disarm();
+        shutdown_listener.mark_as_success();

        let connection_id = Self::generate_random();

@@ -294,7 +294,7 @@ impl SocksClient {
            .shutdown()
            .await
            .map_err(|source| SocksProxyError::SocketShutdownFailure { source })?;
-        self.shutdown_listener.disarm();
+        self.shutdown_listener.mark_as_success();
        Ok(())
    }

@@ -172,6 +172,6 @@ where
    trace!("{} - inbound closed", connection_id);
    shutdown_notify.notify_one();

-    shutdown_listener.disarm();
+    shutdown_listener.mark_as_success();
    reader
 }
@@ -148,7 +148,7 @@ where
    }

    pub fn into_inner(mut self) -> (TcpStream, ConnectionReceiver) {
-        self.shutdown_listener.disarm();
+        self.shutdown_listener.mark_as_success();
        (
            self.socket.take().unwrap(),
            self.mix_receiver.take().unwrap(),
@@ -90,6 +90,6 @@ pub(super) async fn run_outbound(
    trace!("{} - outbound closed", connection_id);
    shutdown_notify.notify_one();

-    shutdown_listener.disarm();
+    shutdown_listener.mark_as_success();
    (writer, mix_receiver)
 }
@@ -470,10 +470,14 @@ impl TaskClient {
    // This listener should to *not* notify the ShutdownNotifier to shutdown when dropped. For
    // example when we clone the listener for a task handling connections, we often want to drop
    // without signal failure.
-    pub fn disarm(&mut self) {
+    pub fn mark_as_success(&mut self) {
        self.mode.set_should_not_signal_on_drop();
    }

+    pub fn disarm(&mut self) {
+        self.mark_as_success();
+    }
+
    pub fn send_we_stopped(&mut self, err: SentError) {
        if self.mode.is_dummy() {
            return;
@@ -12,6 +12,7 @@ license.workspace = true

 [dependencies]
 base64 = { workspace = true }
+dashmap = { workspace = true }
 log = { workspace = true }
 serde = { workspace = true, features = ["derive"] }
 thiserror = { workspace = true }
@@ -34,7 +35,7 @@ x25519-dalek = { workspace = true, features = ["static_secrets"] }

 [dev-dependencies]
 rand = "0.8.5"
-nym-crypto = { path = "../crypto", features = ["rand"] }
+nym-crypto = { path = "../crypto", features = ["rand"]}


 [features]
@@ -4,8 +4,8 @@
 use crate::error::Error;
 use crate::PeerPublicKey;
 use base64::{engine::general_purpose, Engine};
+use dashmap::DashMap;
 use serde::{Deserialize, Serialize};
-use std::collections::HashMap;
 use std::net::IpAddr;
 use std::time::SystemTime;
 use std::{fmt, ops::Deref, str::FromStr};
@@ -17,8 +17,8 @@ use nym_crypto::asymmetric::encryption::PrivateKey;
 #[cfg(feature = "verify")]
 use sha2::Sha256;

-pub type PendingRegistrations = HashMap<PeerPublicKey, RegistrationData>;
-pub type PrivateIPs = HashMap<IpAddr, Taken>;
+pub type PendingRegistrations = DashMap<PeerPublicKey, RegistrationData>;
+pub type PrivateIPs = DashMap<IpAddr, Taken>;

 #[cfg(feature = "verify")]
 pub type HmacSha256 = Hmac<Sha256>;
@@ -108,11 +108,3 @@ copy-js = true          # include Javascript code for search

 [output.linkcheck]
 warning-policy = "warn"
-
-[output.html.redirect]
-"/faq/general-faq.html" = "https://nymtech.net/developers/faq/integrations-faq.html"
-"/tutorials/simple-service-provider/user-client.html" = "https://nymtech.net/developers/examples/custom-services.html"
-"/quickstart/socks-proxy.html" = "https://nymtech.net/developers/clients/socks5/setup.html"
-"/tutorials/matrix.html" = "https://nymtech.net/developers/archive/nym-connect.html#matrix-element-via-nymconnect"
-"/tutorials/monero.html" = "https://nymtech.net/developers/archive/nym-connect.html#monero-wallet-via-nymconnect"
-"/tutorials/telegram.html" = "https://nymtech.net/developers/archive/nym-connect.html#telegram-via-nymconnect"
@@ -60,7 +60,7 @@ There are 2 pieces of software that work together to send SOCKS traffic through
 The `nym-socks5-client` allows you to do the following from your local machine:
 * Take a TCP data stream from a application that can send traffic via SOCKS5.
 * Chop up the TCP stream into multiple Sphinx packets, assigning sequence numbers to them, while leaving the TCP connection open for more data
-* Send the Sphinx packets through the Nym Network. Packets are shuffled and mixed as they transit the mixnet.
+* Send the Sphinx packets through the mixnet to a [network requester](https://nymtech.net/operators/nodes/network-requester.md). Packets are shuffled and mixed as they transit the mixnet.

 The `nym-network-requester` then reassembles the original TCP stream using the packets' sequence numbers, and make the intended request. It will then chop up the response into Sphinx packets and send them back through the mixnet to your  `nym-socks5-client`. The application will then receive its data, without even noticing that it wasn't talking to a "normal" SOCKS5 proxy!

@@ -58,7 +58,7 @@ In some applications, e.g. where people are chatting with friends who they know,

 **If that fits your security model, good. However, will probably be the case that you want to send anonymous replies using Single Use Reply Blocks (SURBs)**.

-You can read more about SURBs [here](https://nymtech.net/docs/architecture/traffic-flow.html#private-replies-using-surbs) but in short they are ways for the receiver of this message to anonymously reply to you - the sender - **without them having to know your client address**.
+You can read more about SURBs [here](https://nymtech.net/docs/architecture/traffic-flow.md#private-replies-using-surbs) but in short they are ways for the receiver of this message to anonymously reply to you - the sender - **without them having to know your client address**.

 Your client will send along a number of `replySurbs` to the recipient of the message. These are pre-addressed Sphinx packets that the recipient can write to the payload of (i.e. write response data to), but not view the final destination of. If the recipient is unable to fit the response data into the bucket of SURBs sent to it, it will use a SURB to request more SURBs be sent to it from your client.

@@ -5,20 +5,13 @@ If you are sending 'normal' application traffic, and/or don't require and custom

 > Nym will soon be switching from a whitelist-based approach to a blocklist-based approach to filtering traffic. As such, it will soon be even easier for developers to utilise the mixnet, as they will not have to run their own NRs or have to add their domains to the whitelist

-
-> Nym will soon be switching from a whitelist-based approach to a blocklist-based approach to filtering traffic. As such, it will soon be even easier for developers to utilise the mixnet, as they will not have to run their own NRs or have to add their domains to the whitelist 
- 
-<!-- I DON't THINK THIS WORKS NOW, NEED RESEARCH AND UPGRADE
 - DarkFi over Nym leverages Nym’s mixnet as a pluggable transport for DarkIRC, their p2p IRC variant. Users can anonymously connect to peers over the network, ensuring secure and private communication within the DarkFi ecosystem. Written in **Rust**.
  - [Docs](https://darkrenaissance.github.io/darkfi/clients/nym_outbound.html?highlight=nym#3--run)
-  - [Github](https://github.com/darkrenaissance/darkfi/tree/master/doc) 
-->
-
+  - [Github](https://github.com/darkrenaissance/darkfi/tree/master/doc)

 - MiniBolt is a complete guide to building a Bitcoin & Lightning full node on a personal computer. It has the capacity to run network traffic (transactions and syncing) over the mixnet, so you can privately sync your node and not expose your home IP to the wider world when interacting with the rest of the network!
  - [Docs](https://v2.minibolt.info/bonus-guides/system/nym-mixnet#proxying-bitcoin-core)
  - [Codebase](https://github.com/minibolt-guide/minibolt)

-
 - Email over Nym is a set of configuration options to set up a Network Requester to send and recieve emails over Nym, using something like Thunderbird.
  - [Codebase](https://github.com/dial0ut/nymstr-email)
@@ -1,9 +1,5 @@
 # NymVPN CLI Guide

-```admonish tip title="web3summit testing"
-**If you testing NymVPN CLI on Web3 Summit Berlin, visit our event page with all info tailored for the event: [nym-vpn-cli.sandbox.nymtech.net](https://nym-vpn-cli.sandbox.nymtech.net/).**
-```
-
 ```admonish info
 To download NymVPN desktop version, visit [nymvpn.com/en/download](https://nymvpn.com/en/download).

@@ -42,32 +38,6 @@ tar -xvf <BINARY>.tar.gz
 # tar -xvf nym-vpn-cli_<!-- cmdrun ../../../scripts/cmdrun/nym_vpn_cli_version.sh -->_ubuntu-22.04_x86_64.tar.gz
 ```

-### Building From Source
-
-NymVPN CLI can be built from source. This process is recommended for more advanced users as the installation may require different dependencies based on the operating system used.
-
-Start by installing [Go](https://go.dev/doc/install) and [Rust](https://rustup.rs/) languages on your system and then follow these steps:
-
-1. Clone NymVPN repository:
-```sh
-git clone https://github.com/nymtech/nym-vpn-client.git
-```
-
-2. Move to `nym-vpn-client` directory and compile `wireguard`:
-
-```sh
-cd nym-vpn-client
-
-make build-wireguard
-```
-
-3. Compile NymVPN CLI
-```sh
-make build-nym-vpn-core
-```
-
-Now your NymVPN CLI is installed. Navigate to `nym-vpn-core/target/release` and use the commands the section below to run the client.
-
 ## Running

 If you are running Debian/Ubuntu/PopOS or any other distributio supporting debian packages and systemd, see the [relevant section below](#debian-package-for-debianubuntupopos).
@@ -155,8 +125,7 @@ To see all the possibilities run with `--help` flag:
 ```sh
 ./nym-vpn-cli --help
 ```
-
-~~~admonish example collapsible=true title="nym-vpn-cli --help"
+~~~admonish example collapsible=true title="Console output"
 ```sh
 Usage: nym-vpn-cli [OPTIONS] <COMMAND>

@@ -173,55 +142,25 @@ Options:
 ```
 ~~~

-You can also run any command with `--help` flag to see a list of all options associated witht that command, the most important may be `run` command, like in this example.
+Here is a list of the options and their descriptions. Some are essential, some are more technical and not needed to be adjusted by users.

-~~~admonish example collapsible=true title="nym-vpn-cli run --help"
-```sh
-Run the client
+**Fundamental commands and arguments**

-Usage: nym-vpn-cli run [OPTIONS]
+- `--entry-gateway-id`: paste one of the values labeled with a key `"identityKey"` (without `" "`)
+- `--exit-gateway-id`: paste one of the values labeled with a key `"identityKey"` (without `" "`)
+- `--exit-router-address`: paste one of the values labeled with a key `"address"` (without `" "`)
+- `--enable-wireguard`: Enable the wireguard traffic between the client and the entry gateway. NymVPN uses Mullvad libraries for wrapping `wireguard-go` and to setup local routing rules to route all traffic to the TUN virtual network device
+- `--wg-ip`: The address of the wireguard interface, you can get it [here](https://nymvpn.com/en/alpha)
+- `--private-key`: get your private key for testing purposes [here](https://nymvpn.com/en/alpha)
+- `--enable-two-hop` is a faster setup where the traffic is routed from the client to Entry Gateway and directly to Exit Gateway (default is 5-hops)

-Options:
-      --entry-gateway-id <ENTRY_GATEWAY_ID>
-          Mixnet public ID of the entry gateway
-      --entry-gateway-country <ENTRY_GATEWAY_COUNTRY>
-          Auto-select entry gateway by country ISO
-      --entry-gateway-low-latency
-          Auto-select entry gateway by latency
-      --exit-router-address <EXIT_ROUTER_ADDRESS>
-          Mixnet recipient address
-      --exit-gateway-id <EXIT_GATEWAY_ID>
-          Mixnet public ID of the exit gateway
-      --exit-gateway-country <EXIT_GATEWAY_COUNTRY>
-          Auto-select exit gateway by country ISO
-      --wireguard-mode
-          Enable the wireguard mode
-      --nym-ipv4 <NYM_IPV4>
-          The IPv4 address of the nym TUN device that wraps IP packets in sphinx packets
-      --nym-ipv6 <NYM_IPV6>
-          The IPv6 address of the nym TUN device that wraps IP packets in sphinx packets
-      --nym-mtu <NYM_MTU>
-          The MTU of the nym TUN device that wraps IP packets in sphinx packets
-      --dns <DNS>
-          The DNS server to use
-      --disable-routing
-          Disable routing all traffic through the nym TUN device. When the flag is set, the nym TUN device will be created, but to route traffic through it you will need to do it manually, e.g. ping -Itun0
-      --enable-two-hop
-          Enable two-hop mixnet traffic. This means that traffic jumps directly from entry gateway to exit gateway
-      --enable-poisson-rate
-          Enable Poisson process rate limiting of outbound traffic
-      --disable-background-cover-traffic
-          Disable constant rate background loop cover traffic
-      --enable-credentials-mode
-          Enable credentials mode
-      --min-mixnode-performance <MIN_MIXNODE_PERFORMANCE>
-          Set the minimum performance level for mixnodes
-  -h, --help
-          Print help
-
-```
-~~~
+**Advanced options**

+- `-c` is a path to an enviroment config, like [`sandbox.env`](https://raw.githubusercontent.com/nymtech/nym/develop/envs/sandbox.env)
+- `--enable-poisson`: Enables process rate limiting of outbound traffic (disabled by default). It means that NymVPN client will send packets at a steady stream to the Entry Gateway. By default it's on average one sphinx packet per 20ms, but there is some randomness (poisson distribution). When there are no real data to fill the sphinx packets with, cover packets are generated instead.
+- `--ip` is the IP address of the TUN device. That is the IP address of the local private network that is set up between local client and the Exit Gateway.
+- `--mtu`: The MTU of the TUN device. That is the max IP packet size of the local private network that is set up between local client and the Exit Gateway.
+- `--disable-routing`: Disable routing all traffic through the VPN TUN device.

 ## Testnet environment

@@ -2,10 +2,6 @@

 <div style="padding:56.25% 0 0 0;position:relative;"><iframe src="https://player.vimeo.com/video/897010658?h=1f55870fe6&amp;badge=0&amp;autopause=0&amp;player_id=0&amp;app_id=58479" frameborder="0" allow="autoplay; fullscreen; picture-in-picture" style="position:absolute;top:0;left:0;width:100%;height:100%;" title="NYMVPN alpha demo 37C3"></iframe></div><script src="https://player.vimeo.com/api/player.js"></script>

-```admonish tip title="web3summit testing"
-**If you testing NymVPN CLI on Web3 Summit Berlin, visit our event page with all info tailored for the event: [nym-vpn-cli.sandbox.nymtech.net](https://nym-vpn-cli.sandbox.nymtech.net/).**
-```
-
 **NymVPN alpha** is a client that uses [Nym Mixnet](https://nymtech.net) to anonymise all of a user's internet traffic through either a 5-hop mixnet (for a full network privacy) or the faster 2-hop decentralised VPN (with some extra features).


@@ -110,8 +110,4 @@ warning-policy = "warn"
 "/sdk/rust/rust.html" = "https://nymtech.net/developers/sdk/rust/rust.html"
 "/clients/socks5-client.html" = "https://nymtech.net/developers/clients/socks5-client.html"
 "/clients/webassembly-client.html" = "https://nymtech.net/developers/clients/webassembly-client.html"
-"/sdk/typescript.html" = "https://sdk.nymtech.net"
-"/clients/websocket-client.html" = "https://nymtech.net/developers/clients/websocket-client.html"
-"/use-apps/blockstream-green" = "https://nymtech.net/developers/clients/socks5/usage.html"
-"/use-apps/telegram" = "https://nymtech.net/developers/archive/nym-connect.html#telegram-via-nymconnect"
-
+"/sdk/typescript.html" = "https://sdk/nymtech.net"
@@ -31,15 +31,9 @@
 - [RPC Nodes](nyx/rpc-node.md)
 - [Ledger Live Support](nyx/ledger-live.md)

-# zkNyms (prev. Coconut)
- [What are zkNyms?](ecash/what-are-zknyms.md)
- [zkNym Generation & Useage: Overview](ecash/zknym-overview.md)
-  - [Feature: Unlinkability](ecash/unlinkability.md)
-  - [Feature: Double Spend Protection](ecash/double-spend-prot.md)
-  - [Feature: Rerandomisation & Incremental Spend](ecash/rerandomise.md)
- [Archive](ecash/archive.md)
-  - [Coconut](ecash/coconut.md)
-  - [Bandwidth Credentials](ecash/bandwidth-credentials.md)
+# Coconut
+- [Coconut](coconut.md)
+- [Bandwidth Credentials](bandwidth-credentials.md)

 # Tools
 - [NymCLI](tools/nym-cli.md)
@@ -56,9 +56,9 @@ Quite a bit of stuff gets built. The key working parts are:

 * [Nym Node](https://nymtech.net/operators/nodes/nym-node.html): `nym-node`
 * [Validator](https://nymtech.net/operators/nodes/validator-setup.html)
-* [websocket client](https://nymtech.net/developers/clients/websocket-client.html): `nym-client`
-* [socks5 client](https://nymtech.net/developers/clients/socks5-client.html): `nym-socks5-client`
-* [webassembly client](https://nymtech.net/developers/clients/webassembly-client.html): `webassembly-client`
+* [websocket client](https://nymtech.net/docs/clients/websocket-client.html): `nym-client`
+* [socks5 client](https://nymtech.net/docs/clients/socks5-client.html): `nym-socks5-client`
+* [webassembly client](https://nymtech.net/docs/clients/webassembly-client.html): `webassembly-client`
 * [nym-cli tool](https://nymtech.net/docs/tools/nym-cli.html): `nym-cli`
 * [nym-api](https://nymtech.net/operators/nodes/nym-api.html): `nym-api`
 * [nymvisor](https://nymtech.net/operators/nodes/nymvisor-upgrade.html): `nymvisor`
@@ -1,5 +1,7 @@
 # Coconut

+> Coconut is in active development - stay tuned for code and integration examples
+
 Coconut is a cryptographic signature scheme that produces privacy-enhanced credentials. It lets application programmers who are concerned with resource access control to think and code in a new way.

 Most of the time, when we build system security, we think of _who_ questions:
@@ -1,3 +0,0 @@
-# Archive
-
-You can find the previous pages related to ecash - referred to then as 'Coconut' - in this archive.
@@ -1,41 +0,0 @@
-# Double Spend Protection
-Double spend protection in the context of zkNym is a balancing act between speed, reliability, and UX. There are two possible modes for protecting against attempted double spending of zkNyms:
-
- Online: The online approach mandates that ingress Gateways instantly deposit zkNyms received from clients to the NymAPI Quorum for verification. Once verified by the Quroum, the ingress Gateway is paid proprtional to the amount of bandwidth 'spent' with the zkNym, and proceeds to grant the client access to the network.
- Offline: In contrast, the offline approach involves the periodic submission of collected zkNyms by ingress Gateways to the Quorum, instead of an instant check. Subsequently, the Quorum nodes perform checks to detect any instances of double-spending and identify the public key associated with such occurrences, whereas the ingress Gateways only do a simple check to check that _that particular_ zkNym had not been spent with itself before.
-
-> The zkNym system takes the **offline** approach.
-
-## Offline Approach: Pros & Cons
-The advantages of the offline approach are manifold:
- Immediate access to the Nym network upon zkNym submission, eliminating any delays in service provisioning until payments are deposited and verified as would occur in the online approach.
- Alleviates performance strain on ingress Gateways and Quorum members, serving as a more efficient method compared to the online counterpart. By moving computationally intense work to the Quorum, this means that Gateway nodes are able to be run on less powerful machines, meaning more operators can more easily run them (and cover their costs) and thus increase the overall number and spread of Gateways around the globe.
- Moreover, we can circumvent the potential issue of overwhelming the blockchain with the serial numbers of spent coins (like in the case of the Zcash DoS attack). TODO reword
-
-However, the offline approach introduces certain limitations.
- Ingress Gateways accept zkNyms without preemptively checking for instances of double spending thus making them susceptible to unknowingly accepting double-spent credentials.
- Any potential repercussions against double spenders can only be implemented once the user requests a new credential for their zkNym Generator (aka they have to 'top up' and buy more bandwidth allowance), assuming they haven't altered their identifier, such as the Bech32 address.
-
-An exploitable scenario arises from these limitations:
- A malicious user purchases bandwidth and aggregates a valid credential in the standard way, worth $10 of crypto/fiat. Subsequently, the malicious user proceeds to sell the credential to 100 users for $1 each, allowing each user to generate zkNyms of 100MB from this **valid** credential. Under the offline approach, entry nodes forego double-spending checks, enabling all 100 users to access the network without obtaining a subscription. The 100 MB limit does not prevent that, as the bandwidth consumption is tracked locally between client and ingress node. This loophole highlights the need for stringent measures to counter such potential abuses within the system.
-
-We can, however, mitigate this problem.
-
-## Solution to Offline Double Spending
-To efficiently prevent the fraudulent use of tickets within the Nym network, a two-tiered solution is in place that combines (1) the immediate detection of double-spending attempts at the entry node level and (2) subsequent identification and blacklisting at the nym-API level.
-
-TODO check against https://www.figma.com/board/geUGlj4Dffddx3E08vMZxz/Ecash-Flow?node-id=0-1&node-type=CANVAS&t=yuSZkEQRna8RqzwD-0 to check you havent gone off piste
-
-### Entry Node Implementation: Real-Time Ticket Unspending Validation
-Each zkNym contains as an attribute a unique serial number, which is revealed in plaintext to the respective ingress Gateway. Each Gateway has a copy of a [Bloom Filter](https://www.geeksforgeeks.org/bloom-filters-introduction-and-python-implementation/) - on receiving a zkNym, it will check against its copy in a local database to check whether this serial number has already been seen. If so, it rejects the zkNym as being double-spent and the client's connection request is rejected. If not, it will add the serial number to its local DB cache.
-
-> Since each time a zkNym is rerandomised its serial number is changed, the serial number being shared in no way identifies a client or user.
-
-Each Gateway will periodically share their serial numbers with the Quorum and refresh their copy of the Bloom Filters from the Quorum, in order to refresh the global list shared by all ingress Gateways and the Quorum. See the step below for more on this.
-
-> Crucially, ingress Gateways refrain from extensive computations to identify the original ticket owner, and avoids broadcasting information about the double-spending attempt to other ingress Gateways. The entry node is also not involved in any global blacklisting process of the clients. The sole purpose of this check is to swiftly identify any attempts at double-spending and add the seen ticket's serial number to the local DB cache.
-
-### Nym-API Implementation: Blacklisting and Penalties for Double-Spenders
-All Gateways periodically forward the collected zkNyms to the Quorum, enabling them to pinpoint and blacklist any clients who double spend. Upon receiving the tickets, the Quorum appends all the incoming serial numbers to the global list of spend zkNym serial numbers and proceed with the identification process for any malicious users engaging in double-spending.
-
-This identification phase involves looking for instances of double spending, identifying the id of the double-spending client, and blacklisting this client by its id. Subsequently, when this client requests a new credential, their plaintext public identifier is included in the request. The Quorum then checks if this identifier is blacklisted. If it is, a new credential is not issued. Furthermore, since the PSCs are only attainable after depositing NYM as payment, the Quorum has the authority to withhold the deposited NYMs as a punitive measure for any detected instances of double-spending.
@@ -1,47 +0,0 @@
-# Rerandomisation & Incremental Spend
-
-Each zkNym generated by the Generator will not be valid for the entire amount of data that the credential aggregated from the PSCs is; if the aggregated credential is worth (e.g.) 10GB of Mixnet data, each zkNym created by the Generator will be worth far less.
-
-```admonish info
-The functionality included in the following code block examples were added to the [nym-cli tool](../tools/nym-cli.md) for illustrative purposes only: this is not necessarily how credentials will be accessed in the future.
-
-**Furthermore, the `nym-cli` uses the words 'tickets' in place of 'zkNyms' and 'ticketbook' in place of 'aggregated credential': this was WIP internal wording that we are moving away from now.**
-
-The numbers used in this high level overview are for illustration purposes only. The figures used in production will potentially vary. Note that individual zkNym sizes will be uniform across the Network.
-```
-
-This is to account for the need for a client to change their ingress Gateway, either because the Gateway itself has gone down / is not offering the required bandwidth, or because a user might simply want to split their traffic across multiple Gateways for extra privacy.
-
-In order to accomodate this then each generated zkNym will be worth a far smaller amount than the aggregated credential fed into the zkNym Generator. A single aggregated credential worth (e.g.) 10GB of data might be split into 100MB zkNym chunks. This means that clients are not tied to particular Gateways they have 'spent' their entire subscription amount with; if the ingress Gateway goes down, or the client simply wishes to use another ingress Gateway, the user has multiple other zkNyms they can use that account for their remaining purchased bandwidth.
-
-Going back to the `nym-cli` tool to illustrate this; we can generate multiple unlinkable zkNyms ('tickets' on this command output) from a single aggregated credential ('ticketbook' below):
-
-```
-❯ ./nym-cli ecash generate-ticket --credential-storage storage.db --provider 6qidVK21zpHD298jdDa1RRpbRozP29ENVyqcSbm6hQrG --full
-TICKETBOOK DATA:
-4Ys9pzUf9MPxX4s5RASyrRoY9fPk1a1kFuPBP2jm2L5PyUy535yPEfjHAfpUTC1Lf2d155TmjukvcDycQYfBSDfhEUJM4J3qPNfG3B5aQEEkefESZp3CM5AEnAu1AEyhpepbYw6BuXokiNcmaYtq3yJQbA4KicKP8FowoRzKHmXpJoUqY8wYQughGfdtXgr3rVaZmK21X51P1NL2UW1aCE512WWfy6P1LJHByWywT3qVw28Z83
-
-generating payment information for 50 tickets. this might take a while!...
-AVAILABLE TICKETS
-+-------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------+
-| index | binary data                                                                                                                                                   | spend status       |
-+============================================================================================================================================================================================+
-| 0     | 4kgKyJLq1zQuk9r9AbEFHPqD8mDuxsLSjgo9XW4Lf7EqGSbgfNsWSEcTbRPEMFLzpstbX5azsA3opFh851h4g5qCG2qE3Luwqua4GG2ebJhk91rvEc5JPctbVQxL62fkfQ6svdcNp…1057bytes remaining | NOT SPENT |
-|-------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------|
-| 1     | 4kefQqViRZd5YezMHH1FTcgUGPK2E2ivfmwgf59exvsnR8tsb5aJtGVwpA7wAJT6icPeo8jtDwDZ3WMPJxL3VRLiakAQr79zh7ixM89gowg3ChHEy6ewmHcT7T6RFkZFsMCMj1CNd…1057bytes remaining | NOT SPENT |
-|-------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------|
-| 2     | 4kxaKdBxyFzJ8gxSZCh1v3wBfN7JvnCJuoJ4MWqkkMHtt2XgRKbDmHCv5ZxtA57Qk8LC3NDMBmqjADvY34mAPdT3tLBL4uxse9ASa227Ji96dwgxvfbpvLXSSr5o4vuPRV9K7UfpJ…1057bytes remaining | NOT SPENT |
-|-------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------|
-| 3     | 4kdYwUJwXyxZBLQXextd4GsU2MATjzArVq5Ec459fTXyrm6q3vxurWULzBMpV5UjcmjJtnw1zFqt7f8Ydu5gyxwAVXP3Nwpn83ouguv2n4YrUewZCvFAqQYXgahhhaQGp6RxK2Arh…1057bytes remaining | NOT SPENT |
-|-------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------|
-...
-
-| 46    | 4kg8bfQ7kGgq5TkkqXagpAEu95gmGT4i7NKbaxJtp2gRgWRrQZM1rxaDAzAxfghoM6PFNbYgKsnLD4MF8HtXW3p92CnPBjswzJ1EbtsMGpgDER3CYFt2ivAhMAVXFziF5UjVJXhpa…1057bytes remaining | NOT SPENT |
-|-------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------|
-| 47    | 4kipbH5Fqt5E9hFMynm9vzFh5FkxKRdHrSEiiJWDwmg3mASctR61sXoFD5u5ZMBwGdvz9sWsRfrpR4MX2NNfRhC85aUxqtkAv3hXZiCLtE1pUC54Cq7YXHyv2XTNKpvuFZs2GmwYg…1057bytes remaining | NOT SPENT |
-|-------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------|
-| 48    | 4kxYZ26HXvxVhh4quHXeCUyQokydeF5wkwUi8fMx6P3uoMvuiPaNP1SJTbYnaQEFFtF6U4dGop6QckUYvbtwQFoGJTJesHFHTDtHbshj5Dg8DwbyaHuAR86zGwYMUPved4XKUTMLa…1057bytes remaining | NOT SPENT |
-|-------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------|
-| 49    | 4kb6zmPebRxjKLVicctq2whvANjWJMoohiPBMr21cT4xj78nvXmJEK8EB4PpqQVFo6ddU9uzuer5ggQZNZgETX2VXBzymBYNzXBuXjLJi1WRdAiASqWz5Hv5im1TJh4XBE4mxKo8Q…1057bytes remaining | NOT SPENT |
-+-------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------+
-```
@@ -1,36 +0,0 @@
-# zkNym Unlinkability
-Each time a credential is requested by an ingress Gateway to prove that a client has purchased data to send through the Mixnet, the zkNym Generator will provide a new, unlinkable zkNym. This is a rereandomised value that is able to be verified as being legitimate (in that it was created by feeding a valid root credential into the Generator) but **not linked to any other zkNyms**, either previously generated or to be generated in the future.
-
-```admonish info
-The functionality included in the following code block examples were added to the [nym-cli tool](../tools/nym-cli.md) for illustrative purposes only: this is not necessarily how credentials will be accessed in the future.
-
-**Furthermore, the `nym-cli` uses the words 'tickets' in place of 'zkNyms' and 'ticketbook' in place of 'aggregated credential': this was WIP internal wording that we are moving away from now.**
-
-TODO ONCE THESE DOCS ARE GOOD TO GO, CHANGE NYM-CLI ARGS IN SAME PR
-```
-
-```
-❯ ./nym-cli ecash generate-ticket --credential-storage storage.db --provider 6qidVK21zpHD298jdDa1RRpbRozP29ENVyqcSbm6hQrG --ticket-index=3
-TICKETBOOK DATA:
-4Ys9pzUf9MPxX4s5RASyrRoY9fPk1a1kFuPBP2jm2L5PyUy535yPEfjHAfpUTC1Lf2d155TmjukvcDycQYfBSDfhEUJM4J3qPNfG3B5aQEEkefESZp3CM5AEnAu1AEyhpepbYw6BuXokiNcmaYtq3yJQbA4KicKP8FowoRzKHmXpJoUqY8wYQughGfdtXgr3rVaZmK21X51P1NL2UW1aCE512WWfy6P1LJHByWywT3qVw28Z83
-
-attempting to generate payment for ticket 3...
-
-PAYMENT FOR TICKET 3:
-VfZAuVRRHekQYMvFevNAZmPPuwMAfEhTBY8TXatBysbrNXAg8euEGPpJvdbhNfQSznBb9nRSeBUSVoNTToSA6Uj5dXmJ7oE2rCB439DarLMWHWYfQNhw6yhWJhcg6bt7ebBYTs3vVeQgSB5kYuifzJF4QQmK6uJyTNPvpV1J6V8M32PBkGT3JpVB3GUGZiksETf7TaF9wAhMo2QAMxw5ZvaQVve5ea7Mane6cfb2Gx69SRff5zDfEQvKqKnyyZje4SGZgWUeHWVLhRjg4KMTJ3JcsHxEqj2k5qeGeyBbgzcuEtCpYvaytsz7nuZGJsT4Z87gB5Zq4NGuDmekuN977eRJvua2dASNWeHiAzVyvnS7ARN5cdUjjYKYiWgHaYrHGsv26WTDeiu4U3sdJMrLHGFY5ihX7f8sTZqD6Wx5AWjQNbEtKaVHymDogfLcwGCC42gQ2yhKfPUaWJ8H4yMB65YBDXGjATaUzcDmJcZKx8g31j2uTVNSFUesd5CRNEEcTNW7cSFFCishCD3T4eV9SuyZyEXAZ48pazPzc1BysBNHEXQNUEtEAZTKmpghC2pihhfDub6LnMJPo9DDdhCULCbcWbGAPc1vPekPaWvk7wrUTGwp5xoNUhQLW3MeJzMvrMSsqLdursCKB4h4Tk272WCStCPQwAKMYoxjWvMzxoUTTWCkhLKHruMtsehRnai4vhu13jbui6ji1F389gfazm4ctth2s4Yw3H3SaPtRETBfZNvZ7n5UV1MD6Q3qin92gT65iqXEi4zRN3woYcK6ZehiSvgUksdEFAUSxNMgNXKtHEYDS6kA37tn5JdBa2Ex2jLudFfhg6JBM226ZKyj65o6feYPgbJAR3jMCmQRHe6DSFb4aH895EowNMjfGUhwhmnbYB1djp7iFXxPP7575NAerhxEQ1WFnxTfoX7pu1Vc9YZb5priCAVbATCaDkECJsdedM45Vx96Jc6E5NWqD98RhMsPimVJkSfYJmRxH9qugica6WonFFb2YLvXYyhoBA1VHBcRqZJ5KHitS5AegYSoYprUfubMzcYo2hGVEQkGKAsFq6jZgCsbJoGLXt3No317vcowB5f3hqT9FjASHAzW2j8uJ9RRzX7XtrPhArwx4EyPgYzrvgG7xcenoSgQt8poa7aYky56eZTKHVUZgUEt6St32MjcivMvmNdWiAHHDc2ZxzTJHgeuCckX7n19vQ3XNLuXv9oGKNNCi8kHnT4tUnnGXNAWXWuyBgZKWUL8u3y41iW6dLYK3Pw5zfpKZTrq3q3bTLJRN5LnnUuFVnWsC3SNqa6VAAvhTGR9PzxLk8C6HeLP2AsYPpqeQwbaL3Ks6tvPdob3tQPWRBGL4uiKtNZ23tRYZGZLYFWZK7psRSZg5AETejKxztVzAuYovpVUiDq71o331tjqWWV1SzWT13Rd1uwz6nHtsjgao2863YaizKARcYr1j9MKtNfDs483yho6i7tbCRR9M4CPLqdiKEaRyVC1FP4F3sejA6nZTuAA35JWUzX6BBj7wgdypMLdMmmtcCZm3bRrF3GvJJs67U8JWRc6dnoGUDaD7rUu
-```
-
-Now lets generate another zkNym to spend either topping up once the previous one's data allowance has been used, or with another Gateway. Notice that the `ticket-index` is the same: this is generated from the same aggregated credential as the one above!
-
-```
-❯ ./nym-cli ecash generate-ticket --credential-storage storage.db --provider 6qidVK21zpHD298jdDa1RRpbRozP29ENVyqcSbm6hQrG --ticket-index=3
-TICKETBOOK DATA:
-4Ys9pzUf9MPxX4s5RASyrRoY9fPk1a1kFuPBP2jm2L5PyUy535yPEfjHAfpUTC1Lf2d155TmjukvcDycQYfBSDfhEUJM4J3qPNfG3B5aQEEkefESZp3CM5AEnAu1AEyhpepbYw6BuXokiNcmaYtq3yJQbA4KicKP8FowoRzKHmXpJoUqY8wYQughGfdtXgr3rVaZmK21X51P1NL2UW1aCE512WWfy6P1LJHByWywT3qVw28Z83
-
-attempting to generate payment for ticket 3...
-
-PAYMENT FOR TICKET 3:
-Vev3SmwWtH5vbnejX5Zzc1EcxXAgveqHpKNN8arxXaWLhFcEpdcZ6n7qr3NrQUNURWsK2AsUiX8aSiGSjMPEY3iDE3aDYnjYERVow8RKUmQiYSKvz7v9cEJxt97JAHBfu9WYNHXTnLFSJwWuFtBdzY5dzPdzGckFenGCysa1ZBHGADHChDVXKoPHXxpn5qyJxmi48coUQDptR64QgkCeQ8RRZ396Lxw2NKFSjqavCMMDVm3g1rW7cYyPanBhkoAUzPU9KXX1rtmhD6F9gV89mGZ8fm7ByDuKuYU28seLQ7GkVKkhNeRW9XxbjSiyscTnMUzJ24R5VbSdr141BaquUHezdUTzmA2EjAtcyyiVrCMV13cc96CRbMXENP2soUzckFnh1qPnrfKCvX4JYkztq7UgPT2mZEnSTDW4C6Z2NVCNBPNLqUSYrU4id8Jzcp1mBxqJjdYcQ7P5fWJbT5Q9NAq44PCgfXpsUkNoj35QVQvKXKLb5oNGqnua5YC1WBPcENcpS7ZPWpk2hwe8VK4gNgnwQtWH2RPmWbvBREAV97vS1vKNHJyry9sD2PiMJGSmBnb1bKsGxR9UQN3YvRsdGHzyJHzAMTzxbFJBqMPmxjSHJR4UdwzhB81Ludu1RAffTvecWFxmWH5bNymCQjw3wey7Uequcxgyy8KAWYDzvHGwCZQbHQXghsYREiqquZWaa8hX3iTNBFUtEk8PRVT78MoFNdeBWNjsLr8zyZ5EGnf4kqmw3a91g5p5vywf6e3LgMu19VHjPSNtKMNXiatkPEVjsCuCppmV4sB7FsdKKWcMUSWLsdmrDBg9PStHr7NaJRzLL5E91gvysmB36Nob9cHeHSZj3wM4NVVjFfZeRqQf4bi7ahfXjeeBetgDpqx7JcbU6tTN4JpcGUpp7fp4MhTq7MeVQMLweGUVLqewKgAGzCvEmrK6dzLd3U1P9vkAAVZ3cCAKUywnHGxoxDeEfexP1g1EqJLtKNZVKPf7hSMWqGhoQ36K7y5GnyZ5YhQ7jcDME9orm5w4StoxoDdCPcjbakKG7UaTHuhd7tU1mUffXcEvVerkXoQK9SEaKvGks21RBhW86aHUzJWVbkiDzdaqjJWbmzLV8FKvNxNyzucoH2rq8LiHRMZfV1H3SkVSa4j2Ktw7ZGoQfdj8DgekxXSR2nHPfhybzKYXTBqFo2ACisxkjR4rXr9Xo6eYywQhQ1MP6aYgYCAXFGHPoFf7kx7Jns5sWvHRBdaMF65zeFF2m5NDuMWETtLgFfsyNgR84vfSqTfzj2gsUykRei7q9N4LKmiDwBALTAEcTvZpLtXBjc8JaB9PUeBw7DoSiSK376sGrQ9F6ZGTngXACNz1TbvYhtau4bDa6KC2Qn7wmoyrphpn7TtM1jdwGBxLcaEEWZKQHvWVfTyL2itjqnrcAZkxYdCj56oQYwpWfKQk3zJEUA6SYHqyJjaLNVK6u25j7969EWjdpTsJ8qSsZgXi3T7dQqiwintZbUUUKRq7egN1SGVnA6Wup91uKrYUWEWMqVu4g8ipmRsLD9iXHHr3yA21Cka7pqk1FxR9BFTAnkk1
-```
-
-These are both generated by the _same_ underlying credential fed into the zkNym Generator and verified and used in a way that they cannot be tied to each other. An ingress Gateway might (for instance) get 100 connection requests from 100 Nym clients, each validated with a zkNym. It has no way of knowing whether these are all zkNyms from the same single subscription, or 100 different ones.
@@ -1,51 +0,0 @@
-# What are zkNyms?
-
-The zkNym scheme enables the creation and use of unlinkable, rerandomisable anonymous access credentials that are 'spent' with Gateways in order to anonymously prove that someone has paid for Mixnet access. This implementation incorporates elements of both the [Coconut Credential](./coconut.md) and [Offline Ecash](https://arxiv.org/pdf/2303.08221) schemes.
-
-As outlined in the [overview](./zknym-overview.md) on the next page, zkNyms allow for users to pay for Mixnet access in a manner that is **unlinkable to their payment account**; even with pseudonymous cryptocurrencies, or fiat. This solves one of the fundamental privacy problems with the majority of VPNs and dVPNs in production today: the linkability of a user's session with their payment information, which can in the majority of cases be easily used to deanonymise them, either at the behest of an authority or by the service operators themselves.
-
-> The current zkNym scheme is non-generic in that it is only used for gating Mixnet access. A generic scheme based on zkNyms is being actively researched in order to facilitate more generic and customisable anonymous credentials for other applications and services.
-
-## Motivations
-This scheme lets application programmers who are concerned with resource access control to think and code in a new way.
-
-Most of the time, when we build system security, we think of _who_ questions:
-
- Has Alice identified herself (authentication)?
- Is Alice allowed to take a specific action (authorisation)?
-
-This fundamentally changes these questions. Rather than asking _who_ a user is, it allows application designers to ask different questions, mostly centered around questions of _rights_:
-
- Does the entity taking this action have a right to do X?
-
-This allows a different kind of security. Many of the computer systems we talk to every day don't need to know _who we are_, they only need to know if we have a _right to use_ the system. The credentials are generated cooperatively by decentralised, trustless systems.
-
-Once the credentials are generated, they can be _re-randomized:_ entirely new credentials, which no one has ever seen before, can be presented to the ingress point of the Nym Network, and validated without being linkable back to the signatures produced by the Quorum of credential signers.
-
-These properties allow zkNyms to act as something like cryptographic bearer tokens generated by decentralised systems. The tokens can be mutated so that they are not traceable, but still verified with the original permissions intact.
-
-Users present cryptographic claims encoded inside the credentials to get secure access to resources despite the systems verifying credential usage not being able to know who they are.
-
-### Re-randomisation vs pseudonymity
-We stand on the shoulders of giants. Ten years ago, Bitcoin showed the way forward by allowing people to control resource access without recourse to _who_ questions. Rather, in Bitcoin and succeeding blockchains, a private key proves a _right to use_.
-
-But as we can now see, private keys in blockchain systems act only as a minor barrier to finding out _who_ is accessing resources. A Bitcoin or Ethereum private key is effectively a long-lived pseudonym which is easily traceable through successive transactions.
-
-**zkNyms allows us to build truly private systems rather than pseudonymous ones.**
-
-## Features
-Just like normal credentials, zkNyms can be signed with a secret key and later verified by anybody with the correct public key. They also have additional superpowers when compared to "normal" signature schemes like RSA or DSA.
-
-Specifically, it is an implementation of a blinded, re-randomizable, selective disclosure threshold credential signature scheme.
-
-Let's say you have a `message` with the content `This credential controls X` in hand. In addition to the normal `sign(message, secretKey)` and `verify(message, publicKey)` functions present in other signature schemes, Coconut adds the following:
-
-1. _[Blind signatures](https://en.wikipedia.org/wiki/Blind_signature)_ - disguises message content so that the signer can't see what they're signing. This defends users against signers: the entity that signed can't identify the user who created a given credential, since they've never seen the message they're signing before it's been _blinded_ (turned into seemingly random binary data). The scheme uses zero-knowledge proofs so that the signer can sign confidently without seeing the unblinded content of the message.
-
-2. _Re-randomizable signatures_ - take a signature, and generate a brand new signature that is valid for the same underlying message `This credential controls X`. The new bitstring in the re-randomized signature is equivalent to the original signature but not linkable to it. So a user can generate multiple zkNyms from a single credential source, unlinkable to any previous "shown" zkNym. But the underlying content of the re-randomized credential is the same (including for things like double-spend protection). This once again protects the user against the signer, because the signer can't trace the signed message that they gave back to the user when it is presented. It also protects the user against the relying party that accepts the signed credential. The user can generate multiple re-randomized credentials repeatedly, and although the underlying message is the same in all cases, there's no way of tracking them by watching the user present the same credential multiple times.
-
-3. _Selective disclosure of attributes_ - allows someone with the public key to verify some, but not all, parts of a message. So you could for instance selectively reveal parts of a signed message to some people, but not to others. This is a very powerful property of the scheme which is to be explored more in future work, potentially leading to diverse applications: voting systems, anonymous currency, privacy-friendly KYC systems, etc.
-
-4. _[Threshold issuance](https://en.wikipedia.org/wiki/Threshold_cryptosystem)_ - allows signature generation to be split up across multiple nodes and decentralized, so that either all signers need to sign (_n of n_ where _n_ is the number of signers) or only a threshold number of signers need to sign a message (_t of n_ where _t_ is the threshold value).
-
-Taken together, these properties provide privacy for applications when it comes to generating and using signatures for cryptographic claims. If you compare it to existing tech, you might think of it as a sort of supercharged decentralized privacy-friendly [JWT](https://jwt.io/).
@@ -1,53 +0,0 @@
-# zkNym Generation and Usage: High Level Overview
-
-```admonish info
-Access to the Mixnet is - at the time of publication - free for everyone. However, soon™ it will be required for each connecting client to present a valid credential - a zkNym - to their ingress Gateway to access the Mixnet. This document outlines the payment flow and zkNym generation for zkNyms.
-
-zkNym access will vary depending on use:
- individual developers will have access to something like a faucet for credentials.
- larger application integrations will have their own 'under the hood' credential generation and distribution scheme for importing credentials into apps automatically.
- and NymVPN users will have a variety of payment methods avaliable to them.
-_More on this soon_.
-```
-
-Generation of zkNyms involves the following actors / pieces of infrastructure:
- [NymAPI](https://nymtech.net/operators/nodes/nym-api.html) instances working together on Distributed Key Generation, referred to as the **NymAPI Quorum**. Members of the Quorum are a subset of the Nyx chain Validator set, and are part of a multisig used for triggering reward payouts to the Network Infrastructure Node Operators.
- **zkNym Requester** represented by a Bech32 address on the Nyx blockchain. This Requester might be a single user using the NymVPN app, or represent a company purchasing zkNyms to distribute to their application users, in the instance of an app integrating a Mixnet client via one of the SDKs.
- **OrderAPI**: an API creating crypto/fiat <> NYM swaps and then depositing NYM in a smart contract managed by the NymAPI Quroum for payment verification. Implementation details of the API will be released in the future.
-
-Generation happens in 3 distinct stages:
- Key Generation & Payment
- Deposit NYM tokens & issue credential
- Generate unlinkable zkNyms for Nym Network access
-
-The vast majority of this - from the perspective of the Requester - happens under the hood, but results in the creation and usage of an **unlinkable, rerandomisable anonymous proof-of-payment credential** - a zkNym - with which to access the Mixnet without fear of doxxing themselves via linking app usage and payment information. The user experience is further enhanced by the fact that a single credential can be split into multiple small zkNyms, meaning that a Requester may buy a large chunk of bandwidth but 'spend' this in the form of multiple zkNyms with different ingress Gateways. Whilst this happens under the hood, what it affords the Requester is an ease of experience in that they have to 'top up' their bandwidth less and are able to chop and change ingress points to the Nym Network as they see fit, akin to the UX of most modern day VPNs and dVPNs.
-
-TODO ADD A BIG DIAGRAM FOR EACH STAGE
-
-## Key Generation & Payment
- A Cosmos [Bech32 address](https://docs.cosmos.network/main/build/spec/addresses/bech32) is created for the Requester.
-This is used to identify themselves when interacting with the OrderAPI via signed authentication tokens. This is the only identity that the OrderAPI is able to see, and is not able to link this to generated zkNyms. This identity never leaves the Requester’s device and there is no email or any personal details needed for signup. If a Requester is simply 'topping up' their subscription, the creation of the address is skipped as it already exists.
- The Requester can then interact with various payment backends to pay for their zkNyms with non-NYM crypto, fiat options, or natively with NYM tokens.
- Payment options will trigger the OrderAPI. This will:
-  - Create a swap for <PAYMENT_AMOUNT> <> NYM tokens.
-  - Deposit these tokens with the NymAPI Quorum via a CosmWasm smart contract deployed on the Nyx blockchain.
- The Requester generates an ed25519 keypair: this is used to identify and authenticate them in the case of using zkNyms across several devices as an individual user. However, this is never used in the clear: these keys are used as private attribute values within generated credentials which are verified via zero-knowledge.
- The Requester sends a request to each member of the Quorum requesting a credential. This request is signed with their private key and includes the transaction hash of the NYM deposit into the deposit contract, performed either by themselves or the OrderAPI. _(( TODO double check which keypair and make clear ))_
-
-## Deposit NYM & Issue zkNym
- Once NYM tokens have been deposited into the contract controlled by the Quorum's multisig and a credential is requested, each member of the Quroum performs several checks to verify the request is valid:
-  - They verify the signature sent as part of the request is valid and that the request was made in the last 48 hours.
-  - They verify that the amount requested matches the amount deposited in the transcation, the hash of which was signed and sent as part of the request.
- Each member then creates a partial blinded signature - a 'partial signed credential' ('PSC') - from their fragment of the master key generated and split amongst them at the beginning of the Quroum in the initial DKG ceremony.
-  - The member also creates a `key:value` entry in their local cache with the transaction hash as the key, and the PSC + encrypted signature as the value. This is used later for zkNym validation and is cleaned after a predefined timeout.
- These PSCs are given back to the Requester after setting up a secure channel via DH key ex., with each replying Quorum member also sending their public key for verification that the returned PSC was signed by them.
-
-> In other words, each member of the Quorum who responds to the Requester's request for a zkNym (since this is a threshold cryptsystem, not all members of the Quroum must respond to create a credential, only enough to pass the threshold) returns a PSC signed with part of the master key.
-
- Once the Requester has received > threshold number of PSCs they can assemble them into a credential signed by the master key. The Requester never learns this master key (it is a private attribute) but the credential can be verified by the Quroum as being valid by checking for a proof that the credential's private attribute - the value of the master key - is valid.
- This credential is fed into the Requester's local 'zkNym Generator'.
-
-## Access Network
- The zkNym Generator is entirely offline and holds the credential created from the aggregated threshold PSCs returned from individual members of the Quorum. Each time an application requests an access credential, the Generator will provide an unlinkable and unique zkNym to the requesting ingress Gateway.
- _((TODO add a point on what spend is in other terms))_
- This zkNym is later presented to the Quorum by the Gateway that collected it, which is used to calculate reward percentages given to Nym Network infrastructure operators by the Quorum, with payouts triggered by their multisig wallet.
@@ -2,304 +2,6 @@

 This page displays a full list of all the changes during our release cycle from [`v2024.3-eclipse`](https://github.com/nymtech/nym/blob/nym-binaries-v2024.3-eclipse/CHANGELOG.md) onwards. Operators can find here the newest updates together with links to relevant documentation. The list is sorted so that the newest changes appear first.

-## `v2024.9-topdeck`
-
- [Release binaries](https://github.com/nymtech/nym/releases/tag/nym-binaries-v2024.9-topdeck)
- [Release CHANGELOG.md](https://github.com/nymtech/nym/blob/nym-binaries-v2024.9-topdeck/CHANGELOG.md)
- [`nym-node`](nodes/nym-node.md) version `1.1.6`
-
-~~~admonish example collapsible=true title='CHANGELOG.md'
- chore: fix 1.80 lint issues ([#4731])
- Handle clients with different versions in IPR ([#4723])
- Add 1GB/day/user bandwidth cap ([#4717])
- Feature/merge back ([#4710])
- removed mixnode/gateway config migration code and disabled cli without explicit flag ([#4706])
-
-[#4731]: https://github.com/nymtech/nym/pull/4731
-[#4723]: https://github.com/nymtech/nym/pull/4723
-[#4717]: https://github.com/nymtech/nym/pull/4717
-[#4710]: https://github.com/nymtech/nym/pull/4710
-[#4706]: https://github.com/nymtech/nym/pull/4706
-~~~
-
-### Features
-
-* [Removed `nym-mixnode` and `nym-gateway` config migration code and disabled CLI without explicit flag](https://github.com/nymtech/nym/pull/4706): Gateway and Mixnode commands now won't do anything without explicit `--force-run` to bypass the deprecation, instead it will tell an operator to run a `nym-node`.  The next step, in say a month or so, is to completely remove all `cli` related things.
-~~~admonish example collapsible=true title='Testing steps performed'
- Verify that the `nym-gateway` binary and `nym-mixnode` binary commands return the `_error message_` stating to *update to `nym-node`*
- Check that when adding the `--force-run` flag, it still allows the command to be run (aside from `init` which has been removed) and the message stating to update to `nym-node` is a `_warning_` now
- Check `nym-node` is not affected
- Review the changes in the PR
-~~~
-
-* [Add 1GB/day/user bandwidth cap](https://github.com/nymtech/nym/pull/4717)
-
-~~~admonish example collapsible=true title='Testing steps performed - Scenario 1: Bandwidth Decreasing Continuously'
-1. Start the client and noted the initial bandwidth (e.g., 1GB).
-2. Us the client and track bandwidth usage over time (e.g., decrease by 100MB every hour).
-3. Restart the client after some usage.
-4. Verify the bandwidth continued from the last recorded value, not reset.
-
-**Notes:**
- The bandwidth continued decreasing without resetting upon restart. Logs and reports correctly reflected the decreasing bandwidth.
-~~~
-
-~~~admonish example collapsible=true title='Testing steps performed - Scenario 2: Bandwidth Reset Next Day'
-1. Use the client normally until the end of the day.
-2. Suspend some clients and kept others active.
-3. Check bandwidth at midnight.
-4. Verify that bandwidth reset to 1GB for both suspended and active clients.
-
-**Notes:**
-Bandwidth reset to 1GB for all clients at midnight. Logs and reports correctly showed the reset.
-~~~
-   
-~~~admonish example collapsible=true title='Testing steps performed - Scenario 3: Bandwidth Reset at a Different Time (e.g., Midday)'
-1. Configure the system to reset bandwidth at midday.
-2. Use the client and monitored bandwidth until midday.
-3. Keep the client connected during the reset time.
-4. Verify that bandwidth reset to 1GB live at midday.
- 
-**Notes:**
-Bandwidth reset to 1GB at midday while the client was connected. Logs and reports correctly reflected the reset.
-~~~
-
-* [Handle clients with different versions in IPR](https://github.com/nymtech/nym/pull/4723): Allow the IPR to handle clients connecting both using `v6` and `v7`, independently. The motivation is that we want to be able to roll out an API version change gradually for NymVPN clients without breaking backwards compatibility. The main feature on the new `v7` format that is not yet used, is that it adds signatures for connect/disconnect.
-~~~admonish example collapsible=true title='Testing steps performed'
-Run the same command (using same gateways deployed from this PR) on different versions of the `nym-vpn-cli`. 
-
-Example: 
-```sh
-sudo -E ./nym-vpn-cli -c ../qa.env run --entry-gateway-id $entry_gateway --exit-gateway-id $exit_gateway --enable-two-hop
- 
-sudo -E ./nym-vpn-cli -c ../qa.env run --entry-gateway-id $entry_gateway --exit-gateway-id $exit_gateway --enable-two-hop
-```
-~~~
-
-### Bugfix
-
-* [Feature/merge back](https://github.com/nymtech/nym/pull/4710): Merge back from the release branch the changes that fix the `nym-node` upgrades. 
-
-* [Fix version `1.x.x` not having template correspondent initially](https://github.com/nymtech/nym/pull/4733): This should fix the problem of config deserialisation when operators upgrade nodes and skip over multiple versions. 
-~~~admonish example collapsible=true title='Testing steps performed'
- Tested updating an old nym-node version and ensuring it did not throw any errors.
-~~~
-
-* [chore: fix 1.80 lint issues](https://github.com/nymtech/nym/pull/4731): 
-~~~admonish example collapsible=true title='Testing steps performed'
- Building all binaries is ok
- Running `cargo fmt` returns no issues 
-~~~
-
-### Operators Guide updates
-
-* [WireGuard tunnel configuration guide](nodes/configuration.md#routing-configuration) for `nym-node` (currently Gateways functionalities). For simplicity we made a detailed step by step guide to upgrade an existing `nym-node` to the latest version and configure your VPS routing for WireGuard. Open by clicking on the example block below.
-
-~~~admonish example collapsible=true title='Upgrading  `nym-node` with WG'
-**Prerequisites**
-
- **Nym Node Version:** You must be running the `2024.9-topdeck` release branch, which operates as `nym-node` version `1.1.6`. You can find the release here: [Nym 2024.9-topdeck Release](https://github.com/nymtech/nym/releases/tag/nym-binaries-v2024.9-topdeck).
-
- **Important:** Before proceeding, make sure to [back up](nodes/maintenance.md#backup-a-node) your current `nym-node` configuration to avoid any potential data loss or issues.
-
-
- **Download Nym Node:**
-    - You can download the `nym-node` binary directly using the following command:
-```bash
-curl -L https://github.com/nymtech/nym/releases/download/nym-binaries-v2024.9-topdeck/nym-node -o nym-node && chmod u+x nym-node
-```
-
-**Step 1: Update UFW Firewall Rules**
-
- **Warning:** Enabling the firewall with UFW without allowing SSH port 22 first will lead to losing access over SSH. Make sure port 22 is allowed before proceeding with any UFW configurations.
-
-Run the following as root or with `sudo` prefix:
-
-1. Check the current status of UFW (Uncomplicated Firewall):
-```bash
-ufw status
-```
-
-2. Ensure that the following ports are allowed on your machine before adding the WireGuard port:
-
-```bash
-ufw allow 22/tcp    # SSH - you're in control of these ports
-ufw allow 80/tcp    # HTTP
-ufw allow 443/tcp   # HTTPS
-ufw allow 1789/tcp  # Nym specific
-ufw allow 1790/tcp  # Nym specific
-ufw allow 8080/tcp  # Nym specific - nym-node-api
-ufw allow 9000/tcp  # Nym Specific - clients port
-ufw allow 9001/tcp  # Nym specific - wss port 
-ufw allow 51822/udp # WireGuard
-```
-
-3. Confirm that the UFW rules have been updated:
-```bash
-ufw status
-```
-
-**Step 2: Download and Prepare the Network Tunnel Manager Script**
-
-1. Download the [`network_tunnel_manager.sh`](https://gist.github.com/tommyv1987/ccf6ca00ffb3d7e13192edda61bb2a77) script:
-```bash
-curl -L -o network_tunnel_manager.sh https://gist.githubusercontent.com/tommyv1987/ccf6ca00ffb3d7e13192edda61bb2a77/raw/3c0a38c1416f8fdf22906c013299dd08d1497183/network_tunnel_manager.sh
-```
-
-2. Make the script executable:
-```bash
-chmod u+x network_tunnel_manager.sh
-```
-
-3. Apply the WireGuard IPTables rules:
-```bash
-./network_tunnel_manager.sh apply_iptables_rules_wg
-```
-
-**Step 3: Update the Nym Node Service File**
-
-1. Modify your [`nym-node` service file](nodes/configuration.md#systemd) to enable WireGuard. Open the file (usually located at `/etc/systemd/system/nym-node.service`) and update the `[Service]` section as follows:
-
-```ini
-[Service]
-User=<YOUR_USER_NAME>
-Type=simple
-#Environment=RUST_LOG=debug
-# CAHNGE PATH IF YOU DON'T RUN IT FROM ROOT HOME DIRECTORY
-ExecStart=/root/nym-node run --mode exit-gateway --id <YOUR_NODE_LOCAL_ID> --accept-operator-terms-and-conditions --wireguard-enabled true
-Restart=on-failure
-RestartSec=30
-StartLimitInterval=350
-StartLimitBurst=10
-LimitNOFILE=65536
-
-[Install]
-WantedBy=multi-user.target
-
-# ADD OR TWEAK ANY CUSTOM SETTINGS
-```
-
-2. Reload the systemd daemon to apply the changes:
-```bash
-systemctl daemon-reload
-```
-
-3. Restart the `nym-node service`:
-```bash
-systemctl restart nym-node.service
-```
-
-4. Optionally, you can check if the node is running correctly by monitoring the service logs:
-```bash
-journalctl -u nym-node.service -f -n 100
-```
-
-**Step 4: Run the Network Tunnel Manager Script**
-
-Finally, run the following command to initiate our favorite routing test - run the joke through the WireGuard tunnel:
-```bash
-./network_tunnel_manager.sh joke_through_wg_tunnel
-```
-
- **Note:** Wireguard will return only IPv4 joke, not IPv6. WG IPv6 is under development. Running IPR joke through the mixnet with `./network_tunnel_manager.sh joke_through_the_mixnet` should work with both IPv4 and IPv6!
-~~~
-
-* [Change `--wireguard-enabled` flag to `true`](nodes/setup.md#-initialise--run): With a proper [routing configuration](nodes/configuration.md#routing-configuration) `nym-nodes` running as Gateways can now enable WG. See the example below:
-
-~~~admonish example collapsible=true title='Syntax to run `nym-node` with WG enabled'
-For Exit Gateway:
-```sh
-./nym-node run --id <ID> --mode exit-gateway --public-ips "$(curl -4 https://ifconfig.me)" --hostname "<YOUR_DOMAIN>" --http-bind-address 0.0.0.0:8080 --mixnet-bind-address 0.0.0.0:1789 --location <COUNTRY_FULL_NAME> --accept-operator-terms-and-conditions --wireguard-enabled true
-
-# <YOUR_DOMAIN> is in format without 'https://' prefix
-# <COUNTRY_FULL_NAME> is format like 'Jamaica',  or two-letter alpha2 (e.g. 'JM'), three-letter alpha3 (e.g. 'JAM') or three-digit numeric-3 (e.g. '388') can be provided.
-# wireguard can be enabled from version 1.1.6 onwards
-```
-
-For Entry Gateway:
-```sh
-./nym-node run --id <ID> --mode entry-gateway --public-ips "$(curl -4 https://ifconfig.me)" --hostname "<YOUR_DOMAIN>" --http-bind-address 0.0.0.0:8080 --mixnet-bind-address 0.0.0.0:1789 --accept-operator-terms-and-conditions --wireguard-enabled true
-
-# <YOUR_DOMAIN> is in format without 'https://' prefix
-# <COUNTRY_FULL_NAME> is format like 'Jamaica',  or two-letter alpha2 (e.g. 'JM'), three-letter alpha3 (e.g. 'JAM') or three-digit numeric-3 (e.g. '388') can be provided.
-# wireguard can be enabled from version 1.1.6 onwards
-```
-~~~
-
-* [Update Nym exit policy](https://nymtech.net/.wellknown/network-requester/exit-policy.txt): Based on the survey, AMA and following discussions we added several ports to Nym exit policy. The ports voted upon in the [forum governance](https://forum.nymtech.net/t/poll-a-new-nym-exit-policy-for-exit-gateways-and-the-nym-mixnet-is-inbound/464) have not been added yet due to the concerns raised. These ports were unrestricted: 
-
-~~~admonish example collapsible=true title='Newly opened ports in Nym exit policy'
-```
-22 # SSH
-123 # NTP
-445 # SMB file share Windows
-465 # URD for SSM
-587 # SMTP
-853 # DNS over TLS
-1433 # databases
-1521 # databases
-2049 # NFS
-3074 # Xbox Live
-3306 # databases
-5000-5005 # RTP / VoIP
-5432 # databases
-6543 # databases
-8080 # HTTP Proxies
-8767 # TeamSpeak
-8883 # Secure MQ Telemetry Transport - MQTT over SSL
-9053 # Tari
-9339 # gaming
-9443 # alternative HTTPS
-9735 # Lightning
-25565 # Minecraft
-27000-27050 # Steam and game servers
-60000-61000 # MOSH
-```
-~~~
-
-* [Create a NymConnect archive page](https://nymtech.net/developers/archive/nym-connect.html), PR [\#4750](https://github.com/nymtech/nym/commit/5096c1e60e203dcf8be934823946e24fda16a9a3): Archive deprecated NymConnect for backward compatibility, show PEApps examples for both NC and maintained `nym-socks5-client`.
-
-* Fix broken URLs and correct redirection. PRs: [\#4745](https://github.com/nymtech/nym/commit/7e36595d8fa7706876880b42df1c998a4b8c1478), [\#4752](https://github.com/nymtech/nym/commit/1db61f800c6884e284c5ab21e7abce3bc6d91d99) [\#4755](https://github.com/nymtech/nym/commit/aaf3dca5b999ad7f19d2ff170078b43c9c4476c2), [\#4737](https://github.com/nymtech/nym/commit/6f669866e92e637772726ad05caa5c5501a830f3) 
-~~~admonish example collapsible=true title='Testing steps performed'
- Use [deadlinkchecker.com](https://www.deadlinkchecker.com/website-dead-link-checker.asp) to go over `nymtech.net` and correct all docs URLs
- Go over search engines and old medium articles and check that all dead URLs re-directing correctly
-~~~
-
-* [Clarify syntax on `nym-nodes` ports on VPS setup page](https://nymtech.net/operators/nodes/vps-setup.html#configure-your-firewall), PR [\#4734](https://github.com/nymtech/nym/commit/5e6417f83788f30b2a84e4dd73d6dd9619a2bb16): Make crystal clear that the addresses and ports in operators `config.toml` must be opened using [`ufw`](https://nymtech.net/operators/nodes/vps-setup.html#configure-your-firewall) and set up as in the example below:
-~~~admonish example collapsible=true title='snap of binding addresses and ports in `config.toml`'
-```toml
-[host]
-public_ips = [
-'<YOUR_PUBLIC_IPv4>'
-]
-
-[mixnet]
-bind_address = '0.0.0.0:1789'
-
-[http]
-bind_address = '0.0.0.0:8080'
-
-[mixnode]
-[mixnode.verloc]
-bind_address = '0.0.0.0:1790'
-
-[entry_gateway]
-bind_address = '0.0.0.0:9000'
-```
-~~~
-
-### Tooling
-
-* [Nym Harbourmaster](https://https://harbourmaster.nymtech.net/) has now several new functionalities:
-    - Tab for Mixnodes
-    - Tab with Charts
-    - New columns with: *Moniker (node description)*, *DP delegatee*, *Accepted T&Cs* - also part of a new category 🐼😀
-
-* Nym has a new [Token page](https://nymtech.net/about/token)
-
---
-
-
 ## `v2024.8-wispa`

 - [Release binaries](https://github.com/nymtech/nym/releases/tag/nym-binaries-v2024.8-wispa)
@@ -6,8 +6,7 @@ The entire content of this page is under [Creative Commons Attribution 4.0 Inter

 This page is a part of Nym Community Legal Forum and its content is composed by shared advices in [Node Operators Legal Forum](https://matrix.to/#/!YfoUFsJjsXbWmijbPG:nymtech.chat?via=nymtech.chat&via=matrix.org) (Matrix chat) as well as though pull requests done by the node operators directly to our [repository](https://github.com/nymtech/nym/tree/develop/documentation/operators/src), reviewed by Nym DevRels.

-This document presents an initiative to further support Nym’s mission of allowing privacy for everyone everywhere. This would be achieved with the support of Nym node operators operating Gateways and opening these to any online service. Such setup needs a **clear policy**, one which will remain the **same for all operators** running Nym nodes. [**Nym exit policy**](https://nymtech.net/.wellknown/network-requester/exit-policy.txt) is a combination of safeguards like (nowadays deprecated) `Tor Null deny list` and `Tor reduced policy` together with changes decided by Nym operators community through the governance (like in this [vote](https://forum.nymtech.net/t/poll-a-new-nym-exit-policy-for-exit-gateways-and-the-nym-mixnet-is-inbound/464)). This policy aims to find a healthy compromise between protecting the operators and NymVPN users against attacks while allowing for as wide experience when accessing the internet through Nym Network. 
-
+This document presents an initiative to further support Nym’s mission of allowing privacy for everyone everywhere. This would be achieved with the support of Nym node operators operating Gateways and opening these to any online service. Such setup needs a **clear policy**, one which will remain the **same for all operators** running Nym nodes. The [proposed **Exit policy**](https://nymtech.net/.wellknown/network-requester/exit-policy.txt) is a combination of two existing safeguards: [Tor Null ‘deny’ list](https://tornull.org/) and Tor reduced policy. <!--MISSING LINK as tornull.org is down -->

 All the technical changes on the side of Nym nodes - ***Project Smoosh*** - are described in the [FAQ section](../archive/faq/smoosh-faq.md).

@@ -24,7 +23,7 @@ Nym core team cannot provide comprehensive legal advice across all jurisdictions

 * Currently, Nym Gateway nodes only enable access to apps and services that are on an ‘allow’ list that is maintained by the core team.

-* To decentralise and enable privacy for a broader range of services, this initiative will have to transition from the current ‘allow’ list to a ‘deny’ list - [exit policy](https://nymtech.net/.wellknown/network-requester/exit-policy.txt). In accordance with the (nowadays deprecated) `Tor Null deny list` and `Tor reduced policy` together with changes decided by Nym operators community through the governance (like in this [vote](https://forum.nymtech.net/t/poll-a-new-nym-exit-policy-for-exit-gateways-and-the-nym-mixnet-is-inbound/464))
+* To decentralise and enable privacy for a broader range of services, this initiative will have to transition from the current ‘allow’ list to a ‘deny’ list - [exit policy](https://nymtech.net/.wellknown/network-requester/exit-policy.txt). In accordance with the Tor Null 'deny' list<!--MISSING LINK as tornull.org is down--> and [Tor reduced policy](https://tornull.org/tor-reduced-reduced-exit-policy.php), which are two established safeguards.

 * This will enhance the usage and appeal of Nym products for end users. As a result, increased usage will ultimately lead to higher revenues for Nym operators.

@@ -73,7 +72,7 @@ This restricts the hosts that the NymConnect app can connect to and has the effe

 The principal change in the new configuration is to make this short allow list more permissive. Nym's [exit policy](https://nymtech.net/.wellknown/network-requester/exit-policy.txt) will restrict the hosts to which Nym Mixnet and Nym VPN users are permitted to connect. This will be done in an effort to protect the operators, as Gateways will act both as SOCKS5 Network Requesters, and exit nodes for IP traffic from Nym Mixnet VPN and VPN clients (both wrapped in the same app).

-As of now we the Gateways will be defaulted to a combination of (nowadays deprecated) `Tor Null deny list` (note: Tornull is not affiliated with Tor Project) - reproduction permitted under Creative Commons Attribution 3.0 United States License which is IP-based, e.g., `ExitPolicy reject 5.188.10.0/23:*` and `Tor reduced policy` together with changes decided by Nym operators community through the governance (like in this [vote](https://forum.nymtech.net/t/poll-a-new-nym-exit-policy-for-exit-gateways-and-the-nym-mixnet-is-inbound/464)). This policy will remain the same for all the nodes, without any option to modify it by Nym node operators individually, to secure stable and reliable service for the end users.
+As of now we the Gateways will be defaulted to a combination of [Tor Null ‘deny’ list](https://tornull.org/) (note: Not affiliated with Tor) - reproduction permitted under Creative Commons Attribution 3.0 United States License which is IP-based, e.g., `ExitPolicy reject 5.188.10.0/23:*` and [Tor reduced policy](https://tornull.org/tor-reduced-reduced-exit-policy.php). Whether we will stick with this list, do modifications or compile another one is still a subject of discussion. In all cases, this policy will remain the same for all the nodes, without any option to modify it by Nym node operators to secure stable and reliable service for the end users.

 For exit relays on ports 80 and 443, the Gateways will exhibit an HTML page resembling the one proposed by [Tor](https://gitlab.torproject.org/tpo/core/tor/-/raw/HEAD/contrib/operator-tools/tor-exit-notice.html). By doing so, the operator will be able to disclose details regarding their Gateway, including the currently configured exit policy, all without the need for direct correspondence with regulatory or law enforcement agencies. It also makes the behavior of Exit Gateways transparent and even computable (a possible feature would be to offer a machine readable form of the notice in JSON or YAML).

@@ -140,7 +140,7 @@ Basically, you want the full `/<PATH>/<TO>/nym-mixnode run --id <WHATEVER-YOUR-N

 #### Following steps for Nym nodes running as `systemd` service

-Once your `init` file is saved follow these steps:
+Once your init file is save follow these steps:

 1. Reload systemctl to pickup the new unit file
 ```sh
@@ -189,30 +189,20 @@ This lets your operating system know it's ok to reload the service configuration

 During our ongoing testing events [Fast and Furious](https://nymtech.net/events/fast-and-furious) we found out, that after introducing IP Packet Router (IPR) and [Nym exit policy](https://nymtech.net/.wellknown/network-requester/exit-policy.txt) on embedded Network Requester (NR) by default,  only a fragment of Gateways routes correctly through IPv4 and IPv6. We built a useful monitor to check out your Gateway (`nym-node --mode exit-gateway`) at [harbourmaster.nymtech.net](https://harbourmaster.nymtech.net/).

-
-IPv6 routing is not only a case for gateways. Imagine a rare occasion when you run a `mixnode` without IPv6 enabled and a client will sent IPv6 packets through the Mixnet through such route:
+IPv6 routing is not only a case for gateways. Imagine a rare occassion when you run a `mixnode` without IPv6 enabled and a client will sent IPv6 packets through the Mixnet through such route:
 ```ascii
 [client] -> [entry-gateway] -> [mixnode layer 1] -> [your mixnode] -> [IPv6 mixnode layer3] -> [exit-gateway]
 ```
 In this (unusual) case your `mixnode` will not be able to route the packets. The node will drop the packets and its performance would go down. For that reason it's beneficial to have IPv6 enabled when running a `mixnode` functionality.

-```admonish info
-We recommend operators to configure their `nym-node` with the full routing configuration.
-
-However, most of the time the packets sent through the Mixnet are IPv4 based. The IPv6 packets are still pretty rare and therefore it's not mandatory from operational point of view to have this configuration implemented if you running only `mixnode` mode. 
-
-If you preparing to run a `nym-node` with all modes enabled in the future, this setup is required.
-```
-
-```admonish tip title="Delegation Program"
-For everyone participating in Delegation Program or Service Grant program, this setup is a requirement!
-```
-
 ### Quick IPv6 Check

+```admonish caution
+Make sure to keep your IPv4 address enabled while setting up IPv6, as the majority of routing goes through that one!
+```
+
 You can always check IPv6 address and connectivity by using some of these methods:

-~~~admonish example collapsible=true
 ```sh
 # locally listed IPv6 addresses
 ip -6 addr
@@ -231,69 +221,55 @@ curl -6 https://ipv6.icanhazip.com
 # using telnet
 telnet -6 ipv6.telnetmyip.com
 ```
-~~~

-```admonish caution
-Make sure to keep your IPv4 address enabled while setting up IPv6, as the majority of routing goes through that one!
-```
+### IPv6 Configuration

-### Routing Configuration
-
-While we're working on Rust implementation to have these settings as a part of the binary build, to solve these connectivity requirements in the meantime we wrote a script [`network_tunnel_manager.sh`](https://gist.github.com/tommyv1987/ccf6ca00ffb3d7e13192edda61bb2a77) to support the operators to configure their servers and address all the connectivity requirements.
+While we're working on Rust implementation to have these settings as a part of the binary build, we wrote a script to solve these connectivity requirements in the meantime we wrote a script [`network_tunnel_manager.sh`](https://gist.github.com/tommyv1987/ccf6ca00ffb3d7e13192edda61bb2a77) to support the operators to configure their servers and address all the connectivity requirements.

 Networking configuration across different ISPs and various operation systems does not have a generic solution. If the provided configuration setup doesn't solve your problem check out [IPv6 troubleshooting](../troubleshooting/vps-isp.md#ipv6-troubleshooting) page. Be aware that you may have to do more research and customised adjustments.

+#### Mode: `exit-gateway`

 The `nymtun0` interface is dynamically managed by the `exit-gateway` service. When the service is stopped, `nymtun0` disappears, and when started, `nymtun0` is recreated.

-The script should be used in a context where `nym-node`is running to fully utilise its capabilities, particularly for fetching IPv6 addresses or applying network rules that depend on the `nymtun0` interface and to establish a WireGuard tunnel.
-
-Before starting with the following, make sure you have the [latest `nym-node` binary](https://github.com/nymtech/nym/releases/) installed and your [VPS setup](vps-setup.md) finished properly!
+The script should be used in a context where `nym-node --mode exit-gateway` is running to fully utilise its capabilities, particularly for fetching IPv6 addresses or applying network rules that depend on the `nymtun0` interface.

 1. Download `network_tunnel_manager.sh`, make executable and run:

 ```sh
-curl -L -o network_tunnel_manager.sh https://gist.githubusercontent.com/tommyv1987/ccf6ca00ffb3d7e13192edda61bb2a77/raw/3c0a38c1416f8fdf22906c013299dd08d1497183/network_tunnel_manager.sh && \
-chmod +x network_tunnel_manager.sh && \
-./network_tunnel_manager.sh
+curl -o network_tunnel_manager.sh -L https://gist.githubusercontent.com/tommyv1987/ccf6ca00ffb3d7e13192edda61bb2a77/raw/9d785d6ee3aa2970553633eccbd89a827f49fab5/network_tunnel_manager.sh && chmod +x network_tunnel_manager.sh && ./network_tunnel_manager.sh
 ```

-2. Make sure your `nym-node` service is up and running
- **If you setting up a new node and not upgrading an existing one, keep it running and [bond](bonding.md) your node now**. Then come back here and follow the rest of the configuration.
+Here is a quick command explanation, for more details on the `network_tunnel_manager.sh` script, refer to the [overview](https://gist.github.com/tommyv1987/ccf6ca00ffb3d7e13192edda61bb2a77) under the code block.

-```admonish tip title=""
-Run the following steps as root or with `sudo` prefix!
-```
-
-3. Display IPv6:
- At this point you should see a `global ipv6` address.
+~~~admonish example collapsible=true title="A summarized usage of `network_tunnel_manager.sh`"
 ```sh
-./network_tunnel_manager.sh fetch_and_display_ipv6
-```
+summary:
+This is a comprehensive script for configuring network packet forwarding and iptables rules,
+aimed at ensuring smooth operation of a tunnel interface.
+It includes functionality for both setup and tear-down of nymtun network configurations,
+alongside diagnostics for verifying system settings and network connectivity.
+
+* fetch_ipv6_address_nym_tun - Fetches the IPv6 address assigned to the 'nymtun0'.
+* fetch_and_display_ipv6 - Displays the IPv6 address on the default network device.
+* apply_iptables_rules - Applies necessary IPv4 and IPv6 iptables rules.
+* remove_iptables_rules - Removes applied IPv4 and IPv6 iptables rules.
+* check_ipv6_ipv4_forwarding - Checks if IPv4 and IPv6 forwarding are enabled.
+* check_nymtun_iptables - Check nymtun0 device
+* perform_ipv4_ipv6_pings - Perform ipv4 and ipv6 pings to google
+* check_ip6_ipv4_routing - Check ipv6 and ipv4 routing
+* joke_through_the_mixnet - Run a joke through the mixnet via ipv4 and ipv6

-~~~admonish example collapsible=true title="Correct `./network_tunnel_manager.sh fetch_and_display_ipv6` output:"
-```sh
-iptables-persistent is already installed.
-Using IPv6 address: 2001:db8:a160::1/112 #the address will be different for you
-operation fetch_ipv6_address_nym_tun completed successfully.
 ```
 ~~~

-4. Apply the rules for IPv4 and IPv6:
+  - To run the script next time, just enter `./network_tunnel_manager <ARG>`
+
+2. Make sure your `nym-node --mode exit-gateway` service is up running
+
+3. Check Nymtun IP tables:
 ```sh
-./network_tunnel_manager.sh apply_iptables_rules
-```
-
- The process may prompt you if you want to save current IPv4 and IPv6 rules, choose yes.
-
-![](../images/ip_table_prompt.png)
-
-5. Check Nymtun IP tables:
- If there's no process running it wouldn't return anything.
- In case you see `nymtun0` but not active, this is probably because you are setting up a new (never bonded) node and not upgrading an existing one.
-
-```sh
-./network_tunnel_manager.sh check_nymtun_iptables
+sudo ./network_tunnel_manager.sh check_nymtun_iptables
 ```

 ~~~admonish example collapsible=true title="Correct `./network_tunnel_manager.sh check_nymtun_iptables` output:"
@@ -327,19 +303,40 @@ operation check_nymtun_iptables completed successfully.
 ```
 ~~~

-6. Apply the rules for WG routing:
+ - If there's no process running it wouldn't return anything.
+ - In case you see `nymtun0` but not active, this is probably because you are setting up a new (never bonded) node and not upgrading an exisitng one. In that case you need to [bond](bonding.md) your node now.

+4. Display IPv6:
 ```sh
-./network_tunnel_manager.sh apply_iptables_rules_wg
+sudo ./network_tunnel_manager.sh fetch_and_display_ipv6
+```
+ - if you have a `global ipv6` address this is good
+
+~~~admonish example collapsible=true title="Correct `./network_tunnel_manager.sh fetch_and_display_ipv6` output:"
+```sh
+iptables-persistent is already installed.
+Using IPv6 address: 2001:db8:a160::1/112 #the address will be different for you
+operation fetch_ipv6_address_nym_tun completed successfully.
+```
+~~~
+
+5. Apply the rules:
+```sh
+sudo ./network_tunnel_manager.sh apply_iptables_rules
 ```

-7. At this point your node needs to be [bonded](bonding.md) to the API for `nymtun0` to interact with the network. After bonding please follow up with the remaining steps below to ensure that your node is routing properly.
+  - The process may prompt you if you want to save current IPv4 and IPv6 rules, choose yes.

-8. Check `nymtun0` interface:
+![](../images/ip_table_prompt.png)
+
+   - check IPv6 again like in point 3
+
+6. At this point your node needs to be [bonded](bonding.md) to the API for `nymtun0` to interact with the network. After bonding please follow up with the remaining streps below to ensure that your Exit Gateway is routing properly.
+
+7. Check `nymtun0` interface:
 ```sh
 ip addr show nymtun0
 ```
-
 ~~~admonish example collapsible=true title="Correct `ip addr show nymtun0` output:"
 ```sh
 # your addresses will be different
@@ -354,30 +351,82 @@ ip addr show nymtun0
 ```
 ~~~

-9. Validate your IPv6 and IPv4 networking by running a joke test via Mixnet:
+8. Validate your IPv6 and IPv4 networking by running a joke via Mixnet:
 ```sh
-./network_tunnel_manager.sh joke_through_the_mixnet
+sudo ./network_tunnel_manager.sh joke_through_the_mixnet
 ```

-10. Validate your tunneling by running a joke test via WG:
-```sh
-./network_tunnel_manager.sh joke_through_wg_tunnel
+Make sure that you get the validation of IPv4 and IPv6 connectivity. If there are still any problems, please refer to [troubleshooting section](../troubleshooting/vps-isp.md#incorrect-gateway-network-check).
+
+#### Mode: `mixnode`
+
+```admonish caution title=""
+Most of the time the packets sent through the Mixnet are IPv4 based. The IPv6 packets are still pretty rare and therefore it's not mandatory from operational point of view. If you preparing to run a `nym-node` with all modes enabled once this option is implemented, then the IPv6 setup on your VPS is required.
 ```

- **Note:** WireGuard will return only IPv4 joke, not IPv6. WG IPv6 is under development. Running IPR joke through the mixnet with `./network_tunnel_manager.sh joke_through_the_mixnet` should work with both IPv4 and IPv6!
+1. Download `network_tunnel_manager.sh`, make executable and run:

-11. Now you can run your node with the `--wireguard-enabled true` flag or add it to your [systemd service config](#systemd). Restart your `nym-node` or [systemd](#following-steps-for-nym-nodes-running-as-systemd-service) service (recommended):
 ```sh
-systemctl daemon-reload && systemctl restart nym-node.service	
-```
- Optionally, you can check if the node is running correctly by monitoring the service logs:
-```sh
-journalctl -u nym-node.service -f -n 100
+curl -o network_tunnel_manager.sh -L https://gist.githubusercontent.com/tommyv1987/ccf6ca00ffb3d7e13192edda61bb2a77/raw/9d785d6ee3aa2970553633eccbd89a827f49fab5/network_tunnel_manager.sh && chmod +x network_tunnel_manager.sh && ./network_tunnel_manager.sh
 ```

-Make sure that you get the validation of all connectivity. If there are still any problems, please refer to [troubleshooting section](../troubleshooting/vps-isp.md#incorrect-gateway-network-check).
+Here is a quick command explanation, for more details on the `network_tunnel_manager.sh` script, refer to the [overview](https://gist.github.com/tommyv1987/ccf6ca00ffb3d7e13192edda61bb2a77) under the code block. Mind that for `mixnode` VPS setup we will use only a few of the commands.

+~~~admonish example collapsible=true title="A summarized usage of `network_tunnel_manager.sh`"
+```sh
+summary:
+This is a comprehensive script for configuring network packet forwarding and iptables rules,
+aimed at ensuring smooth operation of a tunnel interface.
+It includes functionality for both setup and tear-down of nymtun network configurations,
+alongside diagnostics for verifying system settings and network connectivity.
+
+* fetch_ipv6_address_nym_tun - Fetches the IPv6 address assigned to the 'nymtun0'.
+* fetch_and_display_ipv6 - Displays the IPv6 address on the default network device.
+* apply_iptables_rules - Applies necessary IPv4 and IPv6 iptables rules.
+* remove_iptables_rules - Removes applied IPv4 and IPv6 iptables rules.
+* check_ipv6_ipv4_forwarding - Checks if IPv4 and IPv6 forwarding are enabled.
+* check_nymtun_iptables - Check nymtun0 device
+* perform_ipv4_ipv6_pings - Perform ipv4 and ipv6 pings to google
+* check_ip6_ipv4_routing - Check ipv6 and ipv4 routing
+* joke_through_the_mixnet - Run a joke through the mixnet via ipv4 and ipv6
+
+```
+~~~
+
+  - To run the script next time, just enter `./network_tunnel_manager <ARG>`
+
+2. Display IPv6:
+```sh
+sudo ./network_tunnel_manager.sh fetch_and_display_ipv6
+```
+ - if you have a `global ipv6` address this is good
+
+~~~admonish example collapsible=true title="Correct `./network_tunnel_manager.sh fetch_and_display_ipv6` output:"
+```sh
+iptables-persistent is already installed.
+Using IPv6 address: 2001:db8:a160::1/112 #the address will be different for you
+operation fetch_ipv6_address_nym_tun completed successfully.
+```
+~~~
+
+3. Apply the rules:
+```sh
+sudo ./network_tunnel_manager.sh apply_iptables_rules
+```
+
+  - The process may prompt you if you want to save current IPv4 and IPv6 rules, choose yes.
+
+![](../images/ip_table_prompt.png)
+
+   - check IPv6 again like in point 2
+
+4. Check connectivity
+```sh
+telnet -6 ipv6.telnetmyip.com
+```
+
+Make sure that you get the validation of IPv4 and IPv6 connectivity. If there are still any problems, please refer to [troubleshooting section](../troubleshooting/vps-isp.md#incorrect-gateway-network-check).

 ## Next Steps

-There are a few more good suggestions for `nym-node` configuration, like Web Secure Socket or Reversed Proxy setup. These are optional and you can skip them if you want. Visit [Proxy configuration](proxy-configuration.md) page to see the guides.
+There are a few more good suggestions for `nym-node` VPS configuration, especially to be considered for `exit-gateway` functionality, like Web Secure Socket or Reversed Proxy setup. Visit [Proxy configuration](proxy-configuration.md) page to see the guides.
@@ -344,18 +344,22 @@ less ~/.nym/nym-nodes/default-nym-node/config/config.toml
 ## Ports
 All `<NODE>`-specific port configuration can be found in `$HOME/.nym/<NODE>/<YOUR_ID>/config/config.toml`. If you do edit any port configs, remember to restart your client and node processes.

-### Nym Node Port Reference
+### Nym Node: Mixnode mode port reference
 | Default port | Use                       |
 | ------------ | ------------------------- |
 | `1789`       | Listen for Mixnet traffic |
 | `1790`       | Listen for VerLoc traffic |
 | `8080`       | Metrics http API endpoint |
+
+
+### Nym Node: Gateway modes port reference
+| Default port | Use                       |
+|--------------|---------------------------|
 | `1789`       | Listen for Mixnet traffic |
 | `9000`       | Listen for Client traffic |
 | `9001`       | WSS                       |
-| `51822/udp`  | WireGuard                 |

-### Validator Port Reference
+### Validator port reference
 All validator-specific port configuration can be found in `$HOME/.nymd/config/config.toml`. If you do edit any port configs, remember to restart your validator.

 | Default port | Use                                  |
@@ -6,25 +6,21 @@ If you are a `nym-mixnode` or `nym-gateway` operator and you are not familiar wi

 NYM NODE is a tool for running a node within the Nym network. Nym Nodes containing functionality such as `mixnode`, `entry-gateway` and `exit-gateway` are fundamental components of Nym Mixnet architecture. Nym Nodes are ran by decentralised node operators.

-To setup any type of Nym Node, start with either building [Nym's platform](../binaries/building-nym.md) from source or download [pre-compiled binaries](../binaries/pre-built-binaries.md) on the [configured server (VPS)](vps-setup.md) where you want to run the node. Your Nym Node will need to be bonded before it can be run. We recommend most users use the [Nym desktop wallet](wallet-preparation.md) for this.
+To setup any type of Nym Node, start with either building [Nym's platform](../binaries/building-nym.md) from source or download [pre-compiled binaries](../binaries/pre-built-binaries.md) on the [configured server (VPS)](vps-setup.md) where you want to run the node. Nym Node will need to be bond to [Nym's wallet](wallet-preparation.md). Follow [preliminary steps](preliminary-steps.md) page before you initialise and run a node.

-**Follow [preliminary steps](preliminary-steps.md) page before you configure and run a `nym-node`!**
+```admonish info
+**Migrating an existing node to a new `nym-node` is simple. The steps are documented on the [next page](setup.md#migrate)**
+```

 ## Steps for Nym Node Operators

-Once [VPS and Nym wallet are configured](preliminary-steps.md), binaries ready, the operators of `nym-node` need to:
+Once VPS and Nym wallet are configured, binaries ready, the operators of `nym-node` need to:

-1. **[Setup](setup.md) the node**
+1. **[Setup & Run](setup.md) the node**

-2. **[Configure](configuration.md) the node and optionally automation, Wireguard, WSS, reversed proxy ...**
+2. **[Configure](configuration.md) the node** (and optionally WSS, reversed proxy, automation)

-3. **[Run](setup.md#initialise--run) the node or [the service](configuration.md#following-steps-for-nym-nodes-running-as-systemd-service)**
-
-4. **[Bond](bonding.md) the node to the Nym API, using Nym wallet**
-
-Make sure to follow the steps thoroughly, in case you find any point difficult don't hesitate to ask in our [Operators channel](https://matrix.to/#/#operators:nymtech.chat).
-
-<!-- COMMENTING OUT
+3. **[Bond](bonding.md) the node to the Nym API, using Nym wallet**

 ## Quick `nym-node --mode exit-gateway` Setup

@@ -102,5 +98,3 @@ ip addr show nymtun0
 ```sh
 sudo ./network_tunnel_manager.sh joke_through_the_mixnet
 ```
-
-->
@@ -82,8 +82,10 @@ To list all available flags for each command, run `./nym-node <COMMAND> --help`
 ```
 ~~~

-```admonish warning
-The Wireguard flags currently have limited functionality. From version `1.1.6` ([`v2024.9-topdeck`](https://github.com/nymtech/nym/releases/tag/nym-binaries-v2024.9-topdeck)) wireguard is available and recommended to be switched on for nodes running as Gateways. Keep in mind that this option needs a bit of a special [configuration](configuration.md#wireguard-setup).
+```admonish bug
+The Wireguard flags currently have limited functionality. This feature is under development and testing.
+
+**Keep Wireguard disabled for the time being!**
 ```

 #### Flags Summary
@@ -168,11 +170,11 @@ To prevent over-flooding of our documentation we cannot provide with every singl
 ./nym-node  run  --mode exit-gateway

 # with other options
-./nym-node run --id <ID> --mode exit-gateway --public-ips "$(curl -4 https://ifconfig.me)" --hostname "<YOUR_DOMAIN>" --http-bind-address 0.0.0.0:8080 --mixnet-bind-address 0.0.0.0:1789 --location <COUNTRY_FULL_NAME> --accept-operator-terms-and-conditions --wireguard-enabled true
+./nym-node run --id <ID> --mode exit-gateway --public-ips "$(curl -4 https://ifconfig.me)" --hostname "<YOUR_DOMAIN>" --http-bind-address 0.0.0.0:8080 --mixnet-bind-address 0.0.0.0:1789 --location <COUNTRY_FULL_NAME> --accept-operator-terms-and-conditions --wireguard-enabled false

 # <YOUR_DOMAIN> is in format without 'https://' prefix
 # <COUNTRY_FULL_NAME> is format like 'Jamaica',  or two-letter alpha2 (e.g. 'JM'), three-letter alpha3 (e.g. 'JAM') or three-digit numeric-3 (e.g. '388') can be provided.
-# wireguard can be enabled from version 1.1.6 onwards
+# keep wireguard disabled
 ```

 **Initialise only** without running the node with `--init-only` command :
@@ -182,11 +184,11 @@ To prevent over-flooding of our documentation we cannot provide with every singl
 ./nym-node run --init-only --mode exit-gateway

 # with a custom `--id` and other options
-./nym-node run --id <ID> --init-only --mode exit-gateway --public-ips "$(curl -4 https://ifconfig.me)" --hostname "<YOUR_DOMAIN>" --http-bind-address 0.0.0.0:8080 --mixnet-bind-address 0.0.0.0:1789 --location <COUNTRY_FULL_NAME> --accept-operator-terms-and-conditions --wireguard-enabled true
+./nym-node run --id <ID> --init-only --mode exit-gateway --public-ips "$(curl -4 https://ifconfig.me)" --hostname "<YOUR_DOMAIN>" --http-bind-address 0.0.0.0:8080 --mixnet-bind-address 0.0.0.0:1789 --location <COUNTRY_FULL_NAME> --accept-operator-terms-and-conditions --wireguard-enabled false

 # <YOUR_DOMAIN> is in format without 'https://' prefix
 # <COUNTRY_FULL_NAME> is format like 'Jamaica',  or two-letter alpha2 (e.g. 'JM'), three-letter alpha3 (e.g. 'JAM') or three-digit numeric-3 (e.g. '388') can be provided.
-# wireguard can be enabled from version 1.1.6 onwards
+# keep wireguard disabled
 ```

 Run the node with custom `--id` without initialising, using `--deny-init` command
@@ -201,16 +203,7 @@ Run the node with custom `--id` without initialising, using `--deny-init` comman
 ./nym-node run --mode entry-gateway
 ```

-Initialise & run with all options
-```sh
-./nym-node run --id <ID> --mode entry-gateway --public-ips "$(curl -4 https://ifconfig.me)" --hostname "<YOUR_DOMAIN>" --http-bind-address 0.0.0.0:8080 --mixnet-bind-address 0.0.0.0:1789 --accept-operator-terms-and-conditions --wireguard-enabled true
-
-# <YOUR_DOMAIN> is in format without 'https://' prefix
-# <COUNTRY_FULL_NAME> is format like 'Jamaica',  or two-letter alpha2 (e.g. 'JM'), three-letter alpha3 (e.g. 'JAM') or three-digit numeric-3 (e.g. '388') can be provided.
-# wireguard can be enabled from version 1.1.6 onwards
-```
-
-Initialise only, with an `--init-only` command (a custom `--id` used):
+Initialise only with a custom `--id` and `--init-only` command:
 ```sh
 ./nym-node run --id <ID> --init-only --mode entry-gateway --public-ips "$(curl -4 https://ifconfig.me)" --hostname "<YOUR_DOMAIN>" --http-bind-address 0.0.0.0:8080 --mixnet-bind-address 0.0.0.0:1789 --accept-operator-terms-and-conditions
 ```
@@ -97,26 +97,18 @@ ufw enable
 ufw status
 ```

-2. Open all needed ports to have your firewall for `nym-node` working correctly:
+2. Open all needed ports to have your firewall working correctly:
 ```sh
-ufw allow 22/tcp    # SSH - you're in control of these ports
-ufw allow 80/tcp    # HTTP
-ufw allow 443/tcp   # HTTPS
-ufw allow 1789/tcp  # Nym specific
-ufw allow 1790/tcp  # Nym specific
-ufw allow 8080/tcp  # Nym specific - nym-node-api
-ufw allow 9000/tcp  # Nym Specific - clients port
-ufw allow 9001/tcp  # Nym specific - wss port 
-ufw allow 51822/udp # WireGuard
-```
+# for nym-node
+ufw allow 1789,1790,8080,9000,9001,22/tcp

- In case of reverse proxy setup add:
-```sh
-ufw allow 443/tcp
-```
+# in case of planning to setup a WSS (for Gateway functionality)
+ufw allow 9001/tcp

- For validator setup open these ports:
-```sh
+# in case of reverse proxy for the swagger page (for Gateway optionality)
+ufw allow 80,443/tcp
+
+# for validator
 ufw allow 1317,26656,26660,22,80,443/tcp
 ```

@@ -245,7 +237,6 @@ All node-specific port configuration can be found in `$HOME/.nym/<NODE>/<YOUR_ID
 | `9000`          | Listen for Client traffic     |
 | `9001`          | WSS                           |
 | `8080, 80, 443` | Reversed Proxy & Swagger page |
-|`51822/udp` | WireGuard |

 #### Embedded Network Requester functionality ports

@@ -43,7 +43,6 @@ Nym asks its decentralised community of operators to join a series of performanc

 Visit [Fast and Furious web page]({{performance_testing_webpage}}) and [Nym Harbour Master](https://harbourmaster.nymtech.net/) Gateways monitoring page to read more about the performance testing and the results of it.

-<!--- THIS NEEDS A REDO:
 ## Performance Testing Work Flow

 * Nym runs a paralel network environment with a chain ID `perf`
@@ -54,5 +53,7 @@ Visit [Fast and Furious web page]({{performance_testing_webpage}}) and [Nym Harb
 * Nym tracks packet flow using Prometheus and Grafana
 * Nym creates a large number of clients to the [performance validator network]({{performance_validator}}), intensifying the packet traffic
 * Observe and record the metrics - this will probably put more strain on mainnet as well as many nodes spec is minimal
--->

+## More Information
+
+* What happens after the test or what operators get for participating is shared up to date on the [performance testing web page]({{performance_testing_webpage}})
@@ -95,7 +95,7 @@ pub(crate) async fn handle_connection<R, S, St>(
    St: Storage + Clone + 'static,
 {
    // If the connection handler abruptly stops, we shouldn't signal global shutdown
-    shutdown.disarm();
+    shutdown.mark_as_success();

    match shutdown
        .run_future(handle.perform_websocket_handshake())
@@ -203,7 +203,7 @@ impl<St: Storage> ConnectionHandler<St> {
        mut shutdown: TaskClient,
    ) {
        debug!("Starting connection handler for {:?}", remote);
-        shutdown.disarm();
+        shutdown.mark_as_success();
        let mut framed_conn = Framed::new(conn, NymCodec);
        while !shutdown.is_shutdown() {
            tokio::select! {
@@ -81,7 +81,7 @@ impl ConnectionHandler {
        mut shutdown: TaskClient,
    ) {
        debug!("Starting connection handler for {:?}", remote);
-        shutdown.disarm();
+        shutdown.mark_as_success();
        let mut framed_conn = Framed::new(conn, NymCodec);
        while !shutdown.is_shutdown() {
            tokio::select! {
@@ -24,7 +24,7 @@ use nym_wireguard_types::{
    GatewayClient, InitMessage, PeerPublicKey,
 };
 use rand::{prelude::IteratorRandom, thread_rng};
-use tokio::sync::{mpsc::UnboundedReceiver, RwLock};
+use tokio::sync::mpsc::UnboundedReceiver;
 use tokio_stream::wrappers::IntervalStream;

 use crate::{config::Config, error::*};
@@ -32,20 +32,6 @@ use crate::{config::Config, error::*};
 type AuthenticatorHandleResult = Result<AuthenticatorResponse>;
 const DEFAULT_REGISTRATION_TIMEOUT_CHECK: Duration = Duration::from_secs(60); // 1 minute

-pub(crate) struct RegistredAndFree {
-    registration_in_progres: PendingRegistrations,
-    free_private_network_ips: PrivateIPs,
-}
-
-impl RegistredAndFree {
-    pub(crate) fn new(free_private_network_ips: PrivateIPs) -> Self {
-        RegistredAndFree {
-            registration_in_progres: Default::default(),
-            free_private_network_ips,
-        }
-    }
-}
-
 pub(crate) struct MixnetListener {
    // The configuration for the mixnet listener
    pub(crate) config: Config,
@@ -57,10 +43,12 @@ pub(crate) struct MixnetListener {
    pub(crate) task_handle: TaskHandle,

    // Registrations awaiting confirmation
-    pub(crate) registred_and_free: RwLock<RegistredAndFree>,
+    pub(crate) registration_in_progres: Arc<PendingRegistrations>,

    pub(crate) peer_manager: PeerManager,

+    pub(crate) free_private_network_ips: Arc<PrivateIPs>,
+
    pub(crate) timeout_check_interval: IntervalStream,
 }

@@ -75,13 +63,15 @@ impl MixnetListener {
    ) -> Self {
        let timeout_check_interval =
            IntervalStream::new(tokio::time::interval(DEFAULT_REGISTRATION_TIMEOUT_CHECK));
-        let free_private_network_ips = private_ip_network.iter().map(|ip| (ip, None)).collect();
        MixnetListener {
            config,
            mixnet_client,
            task_handle,
-            registred_and_free: RwLock::new(RegistredAndFree::new(free_private_network_ips)),
+            registration_in_progres: Default::default(),
            peer_manager: PeerManager::new(wireguard_gateway_data, response_rx),
+            free_private_network_ips: Arc::new(
+                private_ip_network.iter().map(|ip| (ip, None)).collect(),
+            ),
            timeout_check_interval,
        }
    }
@@ -90,15 +80,9 @@ impl MixnetListener {
        self.peer_manager.wireguard_gateway_data.keypair()
    }

-    async fn remove_stale_registrations(&self) -> Result<()> {
-        let mut registred_and_free = self.registred_and_free.write().await;
-        let registred_values: Vec<_> = registred_and_free
-            .registration_in_progres
-            .values()
-            .cloned()
-            .collect();
-        for reg in registred_values {
-            let ip = registred_and_free
+    fn remove_stale_registrations(&self) -> Result<()> {
+        for reg in self.registration_in_progres.iter().map(|reg| reg.clone()) {
+            let mut ip = self
                .free_private_network_ips
                .get_mut(&reg.gateway_data.private_ip)
                .ok_or(AuthenticatorError::InternalDataCorruption(format!(
@@ -106,9 +90,10 @@ impl MixnetListener {
                    reg.gateway_data.private_ip
                )))?;

-            let timestamp = ip.ok_or(AuthenticatorError::InternalDataCorruption(
-                "timestamp should be set".to_string(),
-            ))?;
+            let timestamp = ip.ok_or(AuthenticatorError::InternalDataCorruption(format!(
+                "timestamp should be set for IP {}",
+                ip.key()
+            )))?;
            let duration = SystemTime::now().duration_since(timestamp).map_err(|_| {
                AuthenticatorError::InternalDataCorruption(
                    "set timestamp shouldn't have been set in the future".to_string(),
@@ -116,8 +101,7 @@ impl MixnetListener {
            })?;
            if duration > DEFAULT_REGISTRATION_TIMEOUT_CHECK {
                *ip = None;
-                registred_and_free
-                    .registration_in_progres
+                self.registration_in_progres
                    .remove(&reg.gateway_data.pub_key());
                log::debug!(
                    "Removed stale registration of {}",
@@ -136,15 +120,9 @@ impl MixnetListener {
    ) -> AuthenticatorHandleResult {
        let remote_public = init_message.pub_key();
        let nonce: u64 = fastrand::u64(..);
-        if let Some(registration_data) = self
-            .registred_and_free
-            .read()
-            .await
-            .registration_in_progres
-            .get(&remote_public)
-        {
+        if let Some(registration_data) = self.registration_in_progres.get(&remote_public) {
            return Ok(AuthenticatorResponse::new_pending_registration_success(
-                registration_data.clone(),
+                registration_data.value().clone(),
                request_id,
                reply_to,
            ));
@@ -167,19 +145,18 @@ impl MixnetListener {
                request_id,
            ));
        }
-        let mut registred_and_free = self.registred_and_free.write().await;
-        let private_ip_ref = registred_and_free
+        let mut private_ip_ref = self
            .free_private_network_ips
            .iter_mut()
-            .filter(|r| r.1.is_none())
+            .filter(|r| r.is_none())
            .choose(&mut thread_rng())
            .ok_or(AuthenticatorError::NoFreeIp)?;
        // mark it as used, even though it's not final
-        *private_ip_ref.1 = Some(SystemTime::now());
+        *private_ip_ref = Some(SystemTime::now());
        let gateway_data = GatewayClient::new(
            self.keypair().private_key(),
            remote_public.inner(),
-            *private_ip_ref.0,
+            *private_ip_ref.key(),
            nonce,
        );
        let registration_data = RegistrationData {
@@ -187,8 +164,7 @@ impl MixnetListener {
            gateway_data,
            wg_port: self.config.authenticator.announced_port,
        };
-        registred_and_free
-            .registration_in_progres
+        self.registration_in_progres
            .insert(remote_public, registration_data.clone());

        Ok(AuthenticatorResponse::new_pending_registration_success(
@@ -204,11 +180,11 @@ impl MixnetListener {
        request_id: u64,
        reply_to: Recipient,
    ) -> AuthenticatorHandleResult {
-        let mut registred_and_free = self.registred_and_free.write().await;
-        let registration_data = registred_and_free
+        let registration_data = self
            .registration_in_progres
            .get(&gateway_client.pub_key())
            .ok_or(AuthenticatorError::RegistrationNotInProgress)?
+            .value()
            .clone();

        if gateway_client
@@ -216,8 +192,7 @@ impl MixnetListener {
            .is_ok()
        {
            self.peer_manager.add_peer(&gateway_client).await?;
-            registred_and_free
-                .registration_in_progres
+            self.registration_in_progres
                .remove(&gateway_client.pub_key());

            Ok(AuthenticatorResponse::new_registered(
@@ -319,7 +294,7 @@ impl MixnetListener {
                    log::debug!("Authenticator [main loop]: received shutdown");
                },
                _ = self.timeout_check_interval.next() => {
-                    if let Err(e) = self.remove_stale_registrations().await {
+                    if let Err(e) = self.remove_stale_registrations() {
                        log::error!("Could not clear stale registrations. The registration process might get jammed soon - {:?}", e);
                    }
                }
@@ -495,7 +495,7 @@ impl NRServiceProvider {
                    .send(error_msg)
                    .await
                    .expect("InputMessageReceiver has stopped receiving!");
-                shutdown.disarm();
+                shutdown.mark_as_success();
                return;
            }
Author	SHA1	Message	Date
Bogdan-Ștefan Neacşu	b1d044c999	Move const to wireguard types	2024-08-06 14:10:31 +00:00
Bogdan-Ștefan Neacşu	6572ff1dc7	Use a more proper timeout value	2024-08-06 14:10:31 +00:00