Merge branch 'develop' into conflicts

Merge pull request #4667 from nymtech/feature/authenticator
Add authenticator
2024-07-10 11:43:54 +02:00 · 2024-07-10 10:14:58 +02:00 · 2024-07-10 09:55:43 +02:00 · 2024-07-09 21:54:57 +05:30 · 2024-07-09 21:24:58 +05:30 · 2024-07-09 20:36:36 +05:30
228 changed files with 5274 additions and 2872 deletions
@@ -41,8 +41,8 @@ jobs:
 # This is a workaround replacement which builds on the last working commit b332a6b55668f60988e36961f3f62a794ba82ddb and then on current branch
      - name: Save current branch to ~/current_branch
        run: git rev-parse --abbrev-ref HEAD > ~/current_branch
-      - name: Git pull & switch to b332a6b55668f60988e36961f3f62a794ba82ddb
-        run: git pull && git checkout b332a6b55668f60988e36961f3f62a794ba82ddb
+      - name: Git pull, reset & switch to b332a6b55668f60988e36961f3f62a794ba82ddb
+        run: git pull && git reset --hard && git checkout b332a6b55668f60988e36961f3f62a794ba82ddb
      - name: Build all projects in documentation/ & move to ~/dist/docs/ from b332a6b55668f60988e36961f3f62a794ba82ddb
        run: cd documentation && ./build_all_to_dist.sh

@@ -46,8 +46,8 @@ jobs:
 # This is a workaround replacement which builds on the last working commit b332a6b55668f60988e36961f3f62a794ba82ddb and then on current branch
      - name: Save current branch to ~/current_branch
        run: git rev-parse --abbrev-ref HEAD > ~/current_branch
-      - name: Git pull & switch to b332a6b55668f60988e36961f3f62a794ba82ddb
-        run: git pull && git checkout b332a6b55668f60988e36961f3f62a794ba82ddb
+      - name: Git pull, reset & switch to b332a6b55668f60988e36961f3f62a794ba82ddb
+        run: git pull && git reset --hard && git checkout b332a6b55668f60988e36961f3f62a794ba82ddb
      - name: Build all projects in documentation/ & move to ~/dist/docs/ from b332a6b55668f60988e36961f3f62a794ba82ddb
        run: cd documentation && ./build_all_to_dist.sh

@@ -2100,7 +2100,7 @@ dependencies = [
 "dotenvy",
 "humantime-serde",
 "isocountry",
- "itertools 0.10.5",
+ "itertools 0.12.1",
 "log",
 "maxminddb",
 "nym-bin-common",
@@ -2221,7 +2221,7 @@ dependencies = [
 "atomic 0.6.0",
 "pear",
 "serde",
- "toml 0.8.12",
+ "toml 0.8.14",
 "uncased",
 "version_check",
 ]
@@ -3272,15 +3272,6 @@ dependencies = [
 "either",
 ]

-[[package]]
-name = "itertools"
-version = "0.11.0"
-source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "b1c173a5686ce8bfa551b3563d0c2170bf24ca44da99c7ca4bfdab5418c3fe57"
-dependencies = [
- "either",
-]
-
 [[package]]
 name = "itertools"
 version = "0.12.1"
@@ -3959,6 +3950,54 @@ dependencies = [
 "tokio",
 ]

+[[package]]
+name = "nym-authenticator"
+version = "0.1.0"
+dependencies = [
+ "anyhow",
+ "bincode",
+ "bs58 0.5.1",
+ "bytes",
+ "clap 4.5.4",
+ "fastrand 2.1.0",
+ "futures",
+ "ipnetwork 0.16.0",
+ "log",
+ "nym-authenticator-requests",
+ "nym-bin-common",
+ "nym-client-core",
+ "nym-config",
+ "nym-crypto",
+ "nym-id",
+ "nym-network-defaults",
+ "nym-sdk",
+ "nym-service-providers-common",
+ "nym-sphinx",
+ "nym-task",
+ "nym-types",
+ "nym-wireguard",
+ "nym-wireguard-types",
+ "rand 0.8.5",
+ "serde",
+ "serde_json",
+ "thiserror",
+ "tokio",
+ "tokio-stream",
+ "tokio-util",
+ "url",
+]
+
+[[package]]
+name = "nym-authenticator-requests"
+version = "0.1.0"
+dependencies = [
+ "bincode",
+ "nym-sphinx",
+ "nym-wireguard-types",
+ "rand 0.8.5",
+ "serde",
+]
+
 [[package]]
 name = "nym-bandwidth-controller"
 version = "0.1.0"
@@ -4282,7 +4321,7 @@ dependencies = [
 "ff",
 "getrandom 0.2.15",
 "group",
- "itertools 0.10.5",
+ "itertools 0.12.1",
 "nym-dkg",
 "nym-pemstore",
 "rand 0.8.5",
@@ -4523,6 +4562,7 @@ dependencies = [
 "ipnetwork 0.16.0",
 "log",
 "nym-api-requests",
+ "nym-authenticator",
 "nym-bin-common",
 "nym-config",
 "nym-credentials",
@@ -4537,7 +4577,6 @@ dependencies = [
 "nym-node-http-api",
 "nym-pemstore",
 "nym-sphinx",
- "nym-statistics-common",
 "nym-task",
 "nym-types",
 "nym-validator-client",
@@ -4633,6 +4672,7 @@ version = "0.1.0"
 dependencies = [
 "async-trait",
 "http 1.1.0",
+ "nym-bin-common",
 "reqwest 0.12.4",
 "serde",
 "serde_json",
@@ -4939,7 +4979,6 @@ dependencies = [
 "nym-socks5-proxy-helpers",
 "nym-socks5-requests",
 "nym-sphinx",
- "nym-statistics-common",
 "nym-task",
 "nym-types",
 "pretty_env_logger",
@@ -4991,6 +5030,7 @@ dependencies = [
 "cupid",
 "humantime-serde",
 "ipnetwork 0.16.0",
+ "nym-authenticator",
 "nym-bin-common",
 "nym-client-core-config-types",
 "nym-config",
@@ -5014,7 +5054,7 @@ dependencies = [
 "sysinfo 0.30.12",
 "thiserror",
 "tokio",
- "toml 0.8.12",
+ "toml 0.8.14",
 "tracing",
 "url",
 "zeroize",
@@ -5160,7 +5200,7 @@ dependencies = [
 "chacha20poly1305",
 "criterion",
 "curve25519-dalek 4.1.2",
- "fastrand 1.9.0",
+ "fastrand 2.1.0",
 "getrandom 0.2.15",
 "log",
 "rand 0.8.5",
@@ -5260,6 +5300,7 @@ dependencies = [
 "nym-socks5-client-core",
 "nym-sphinx",
 "nym-topology",
+ "nym-validator-client",
 "rand 0.8.5",
 "serde",
 "serde_json",
@@ -5505,20 +5546,6 @@ dependencies = [
 "thiserror",
 ]

-[[package]]
-name = "nym-statistics-common"
-version = "1.0.1"
-dependencies = [
- "async-trait",
- "log",
- "reqwest 0.12.4",
- "serde",
- "serde_json",
- "sqlx",
- "thiserror",
- "tokio",
-]
-
 [[package]]
 name = "nym-store-cipher"
 version = "0.1.0"
@@ -5593,7 +5620,7 @@ dependencies = [
 "cosmwasm-std",
 "eyre",
 "hmac",
- "itertools 0.11.0",
+ "itertools 0.12.1",
 "log",
 "nym-config",
 "nym-crypto",
@@ -5632,7 +5659,7 @@ dependencies = [
 "eyre",
 "flate2",
 "futures",
- "itertools 0.10.5",
+ "itertools 0.12.1",
 "log",
 "nym-api-requests",
 "nym-coconut",
@@ -7594,9 +7621,9 @@ dependencies = [

 [[package]]
 name = "serde_spanned"
-version = "0.6.5"
+version = "0.6.6"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "eb3622f419d1296904700073ea6cc23ad690adbd66f13ea683df73298736f0c1"
+checksum = "79e674e01f999af37c49f70a6ede167a8a60b2503e56c5599532a65baa5969a0"
 dependencies = [
 "serde",
 ]
@@ -8616,21 +8643,21 @@ dependencies = [

 [[package]]
 name = "toml"
-version = "0.8.12"
+version = "0.8.14"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "e9dd1545e8208b4a5af1aa9bbd0b4cf7e9ea08fabc5d0a5c67fcaafa17433aa3"
+checksum = "6f49eb2ab21d2f26bd6db7bf383edc527a7ebaee412d17af4d40fdccd442f335"
 dependencies = [
 "serde",
 "serde_spanned",
 "toml_datetime",
- "toml_edit 0.22.12",
+ "toml_edit 0.22.14",
 ]

 [[package]]
 name = "toml_datetime"
-version = "0.6.5"
+version = "0.6.6"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "3550f4e9685620ac18a50ed434eb3aec30db8ba93b0287467bca5826ea25baf1"
+checksum = "4badfd56924ae69bcc9039335b2e017639ce3f9b001c393c1b2d1ef846ce2cbf"
 dependencies = [
 "serde",
 ]
@@ -8650,9 +8677,9 @@ dependencies = [

 [[package]]
 name = "toml_edit"
-version = "0.22.12"
+version = "0.22.14"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "d3328d4f68a705b2a4498da1d580585d39a6510f98318a2cec3018a7ec61ddef"
+checksum = "f21c7aaf97f1bd9ca9d4f9e73b0a6c74bd5afef56f2bc931943a6e1c37e04e38"
 dependencies = [
 "indexmap 2.2.6",
 "serde",
@@ -20,6 +20,7 @@ members = [
    "clients/native",
    "clients/native/websocket-requests",
    "clients/socks5",
+    "common/authenticator-requests",
    "common/async-file-watcher",
    "common/bandwidth-controller",
    "common/bin-common",
@@ -76,7 +77,6 @@ members = [
    "common/socks5-client-core",
    "common/socks5/proxy-helpers",
    "common/socks5/requests",
-    "common/statistics",
    "common/store-cipher",
    "common/task",
    "common/topology",
@@ -96,10 +96,10 @@ members = [
    "mixnode",
    "sdk/lib/socks5-listener",
    "sdk/rust/nym-sdk",
+    "service-providers/authenticator",
    "service-providers/common",
    "service-providers/ip-packet-router",
    "service-providers/network-requester",
-    "service-providers/network-statistics",
    "nym-api",
    "nym-browser-extension/storage",
    "nym-api/nym-api-requests",
@@ -127,7 +127,6 @@ default-members = [
    "clients/socks5",
    "gateway",
    "service-providers/network-requester",
-    "service-providers/network-statistics",
    "mixnode",
    "nym-api",
    "tools/nymvisor",
@@ -192,12 +191,15 @@ cupid = "0.6.1"
 curve25519-dalek = "4.1"
 dashmap = "5.5.3"
 defguard_wireguard_rs = "0.4.2"
+digest = "0.10.7"
+dirs = "4.0"
 doc-comment = "0.3"
 dotenvy = "0.15.6"
 ecdsa = "0.16"
 ed25519-dalek = "2.1"
 etherparse = "0.13.0"
 eyre = "0.6.9"
+fastrand = "2.1.0"
 flate2 = "1.0.28"
 futures = "0.3.28"
 generic-array = "0.14.7"
@@ -209,14 +211,15 @@ hex = "0.4.3"
 hex-literal = "0.3.3"
 hkdf = "0.12.3"
 hmac = "0.12.1"
+http = "1"
 httpcodec = "0.2.3"
 humantime = "2.1.0"
 humantime-serde = "1.1.1"
-http = "1"
 hyper = "1.3.1"
 indexed_db_futures = "0.3.0"
 inquire = "0.6.2"
 ip_network = "0.4.1"
+ipnetwork = "0.16"
 isocountry = "0.3.2"
 k256 = "0.13"
 lazy_static = "1.4.0"
@@ -239,6 +242,7 @@ publicsuffix = "2.2.3"
 quote = "1"
 rand = "0.8.5"
 rand-07 = "0.7.3"
+rand_chacha = "0.3"
 rand_chacha_02 = "0.2"
 rand_core = "0.6.3"
 rand_distr = "0.4"
@@ -252,6 +256,7 @@ rocket_cors = "0.6.0"
 rocket_okapi = "0.8.0"
 safer-ffi = "0.1.4"
 schemars = "0.8.1"
+semver = "1.0.23"
 serde = "1.0.152"
 serde_bytes = "0.11.6"
 serde_derive = "1.0"
@@ -259,12 +264,14 @@ serde_json = "1.0.91"
 serde_repr = "0.1"
 serde_with = "3.4.0"
 serde_yaml = "0.9.25"
+sha2 = "0.10.8"
 si-scale = "0.2.2"
 sphinx-packet = "0.1.1"
 sqlx = "0.6.3"
 strum = "0.25"
 subtle-encoding = "0.5"
 syn = "1"
+sysinfo = "0.30.12"
 tap = "1.0.1"
 tar = "0.4.40"
 tempfile = "3.5.0"
@@ -275,6 +282,7 @@ tokio-stream = "0.1.14"
 tokio-test = "0.4.2"
 tokio-tungstenite = { version = "0.20.1" }
 tokio-util = "0.7.10"
+toml = "0.8.14"
 tower = "0.4.13"
 tower-http = "0.5.2"
 tracing = "0.1.37"
@@ -289,6 +297,7 @@ utoipa-swagger-ui = "6.0.0"
 vergen = { version = "=8.3.1", default-features = false }
 walkdir = "2"
 wasm-bindgen-test = "0.3.36"
+x25519-dalek = "2.0.0"
 zeroize = "1.6.0"

 prometheus = { version = "0.13.0" }
@@ -336,6 +345,7 @@ wasm-bindgen = "0.2.92"
 wasm-bindgen-futures = "0.4.39"
 wasmtimer = "0.2.0"
 web-sys = "0.3.69"
+itertools = "0.12.0"


 # Profile settings for individual crates
@@ -7,86 +7,66 @@ SPDX-License-Identifier: Apache-2.0

 The platform is composed of multiple Rust crates. Top-level executable binary crates include:

-* nym-mixnode - shuffles [Sphinx](https://github.com/nymtech/sphinx) packets together to provide privacy against network-level attackers.
-* nym-client - an executable which you can build into your own applications. Use it for interacting with Nym nodes.
-* nym-socks5-client - a Socks5 proxy you can run on your machine and use with existing applications.
-* nym-gateway - acts sort of like a mailbox for mixnet messages, which removes the need for direct delivery to potentially offline or firewalled devices.
-* nym-network-monitor - sends packets through the full system to check that they are working as expected, and stores node uptime histories as the basis of a rewards system ("mixmining" or "proof-of-mixing").
-* nym-explorer - a (projected) block explorer and (existing) mixnet viewer.
-* nym-wallet - a desktop wallet implemented using the [Tauri](https://tauri.studio/en/docs/about/intro) framework.
+* `nym-node` - 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. Read more about `nym-node` in [Operators Guide documentation](https://nymtech.net/operators/nodes/nym-node.html). Network functionality of `nym-node` (labeled with `--mode` flag) can be:
+	- `mixnode` - shuffles [Sphinx](https://github.com/nymtech/sphinx) packets together to provide privacy against network-level attackers.
+	- `gateway` - acts sort of like a mailbox for mixnet messages, which removes the need for direct delivery to potentially offline or firewalled devices. Gateways can be further categorized as `entry-gateway` and `exit-gateway`. The latter has an extra embedded IP packet router and Network requester to route data to the internet.
+* `nym-client` - an executable which you can build into your own applications. Use it for interacting with Nym nodes.
+* `nym-socks5-client` - a Socks5 proxy you can run on your machine and use with existing applications.
+* `nym-explorer` - a (projected) block explorer and (existing) mixnet viewer.
+* `nym-wallet` - a desktop wallet implemented using the [Tauri](https://tauri.studio/en/docs/about/intro) framework.
+<!-- coming soon
+* `nym-network-monitor` - sends packets through the full system to check that they are working as expected, and stores node uptime histories as the basis of a rewards system ("mixmining" or "proof-of-mixing").
+-->
+
+```ascii
+                      ┌─►mix──┐  mix     mix
+                      │       │
+            Entry     │       │                   Exit
+client ───► Gateway ──┘  mix  │  mix  ┌─►mix ───► Gateway ───► internet
+                              │       │
+                              │       │
+                         mix  └─►mix──┘  mix
+
+```

 [![Build Status](https://img.shields.io/github/actions/workflow/status/nymtech/nym/build.yml?branch=develop&style=for-the-badge&logo=github-actions)](https://github.com/nymtech/nym/actions?query=branch%3Adevelop)


 ### Building

-Platform build instructions are available on [our docs site](https://nymtech.net/docs/binaries/pre-built-binaries.html).
-Wallet build instructions are also available on [our docs site](https://nymtech.net/docs/wallet/desktop-wallet.html).
+* Platform build instructions are available on Nym [Operators Guide documentation](https://nymtech.net/operators/binaries/building-nym.html).
+* Wallet build instructions are available on Nym [Technical docs](https://nymtech.net/docs/wallet/desktop-wallet.html).

 ### Developing

-There's a `.env.sample-dev` file provided which you can rename to `.env` if you want convenient logging, backtrace, or other environment variables pre-set. The `.env` file is ignored so you don't need to worry about checking it in.
+There's a [`sandbox.env`](https://github.com/nymtech/nym/envs/sandbox.env) file provided which you can rename to `.env` if you want convenient testing environment. Read more about sandbox environment in our [Operators Guide page](https://nymtech.net/operators/sandbox.html).

-For Typescript components, please see [ts-packages](./ts-packages).
+References for developers:
+
+* [Developers Portal](https://nymtech.net/developers)
+* [Typescript SDKs](https://sdk.nymtech.net/)
+* [Technical Documentation - Nym network overview](https://nymtech.net/docs/)
+* [Release Cycle - git flow](https://nymtech.net/operators/release-cycle.html)

 ### Developer chat

-> We used to use Keybase for developer chats, but we have since migrated to Matrix and Discord. We no longer check the old **nymtech.friends** Keybase team.
-
 You can chat to us in two places:
 * The #dev channel on [Matrix](https://matrix.to/#/#dev:nymtech.chat)
-* The various developer channels on [Discord](https://discord.gg/nym)
+* The various developer channels on [Discord](https://discord.gg/FaTJb8q8)

-### Rewards
+### Tokenomics & Rewards

-Node, node operator and delegator rewards are determined according to the principles laid out in the section 6 of [Nym Whitepaper](https://nymtech.net/nym-whitepaper.pdf). Below is a TLDR of the variables and formulas involved in calculating the epoch rewards. Initial reward pool is set to 250 million Nym, making the circulating supply 750 million Nym.
-
-|Symbol|Definition|
-|---|---|
-|<img src="https://render.githubusercontent.com/render/math?math=R#gh-light-mode-only"><img src="https://render.githubusercontent.com/render/math?math=\color{white}R#gh-dark-mode-only">|global share of rewards available, starts at 2% of the reward pool.
-|<img src="https://render.githubusercontent.com/render/math?math=R_{i}#gh-light-mode-only"><img src="https://render.githubusercontent.com/render/math?math=\color{white}R_{i}#gh-dark-mode-only">|node reward for mixnode `i`.
-|<img src="https://render.githubusercontent.com/render/math?math=\sigma_{i}#gh-light-mode-only"><img src="https://render.githubusercontent.com/render/math?math=\color{white}\sigma_{i}#gh-dark-mode-only">|ratio of total node stake (node bond + all delegations) to the token circulating supply.
-|<img src="https://render.githubusercontent.com/render/math?math=\lambda_{i}#gh-light-mode-only"><img src="https://render.githubusercontent.com/render/math?math=\color{white}\lambda_{i}#gh-dark-mode-only">|ratio of stake operator has pledged to their node to the token circulating supply.
-|<img src="https://render.githubusercontent.com/render/math?math=\omega_{i}#gh-light-mode-only"><img src="https://render.githubusercontent.com/render/math?math=\color{white}\omega_{i}#gh-dark-mode-only">|fraction of total effort undertaken by node `i`, set to `1/k`.
-|<img src="https://render.githubusercontent.com/render/math?math=k#gh-light-mode-only"><img src="https://render.githubusercontent.com/render/math?math=\color{white}k#gh-dark-mode-only">|number of nodes stakeholders are incentivised to create, set by the validators, a matter of governance. Currently determined by the `reward set` size, and set to 720 in testnet Sandbox.
-|<img src="https://render.githubusercontent.com/render/math?math=\alpha#gh-light-mode-only"><img src="https://render.githubusercontent.com/render/math?math=\color{white}\alpha#gh-dark-mode-only">|A Sybil attack resistance parameter - the higher this parameter is set, the stronger the reduction in competitiveness for a Sybil attacker.
-|<img src="https://render.githubusercontent.com/render/math?math=PM_{i}#gh-light-mode-only"><img src="https://render.githubusercontent.com/render/math?math=\color{white}PM_{i}#gh-dark-mode-only">|declared profit margin of operator `i`, defaults to 10%.
-|<img src="https://render.githubusercontent.com/render/math?math=PF_{i}#gh-light-mode-only"><img src="https://render.githubusercontent.com/render/math?math=\color{white}PF_{i}#gh-dark-mode-only">|uptime of node `i`, scaled to 0 - 1, for the rewarding epoch
-|<img src="https://render.githubusercontent.com/render/math?math=PP_{i}#gh-light-mode-only"><img src="https://render.githubusercontent.com/render/math?math=\color{white}PP_{i}#gh-dark-mode-only">|cost of operating node `i` for the duration of the rewarding epoch, set to 40 NYMs.
-
-Node reward for node `i` is determined as:
-
-<img src="https://render.githubusercontent.com/render/math?math=R_{i}=PF_{i} \cdot R \cdot (\sigma^'_{i} \cdot \omega_{i} \cdot k %2b \alpha \cdot \lambda^'_{i} \cdot \sigma^'_{i} \cdot k)/(1 %2b \alpha)#gh-light-mode-only">
-<img src="https://render.githubusercontent.com/render/math?math=\color{white}R_{i}=PF_{i} \cdot R \cdot (\sigma^'_{i} \cdot \omega_{i} \cdot k %2b \alpha \cdot \lambda^'_{i} \cdot \sigma^'_{i} \cdot k)/(1 %2b \alpha)#gh-dark-mode-only">
-where:
-
-<img src="https://render.githubusercontent.com/render/math?math=\sigma^'_{i} = min\{\sigma_{i}, 1/k\}#gh-light-mode-only">
-<img src="https://render.githubusercontent.com/render/math?math=\color{white}\sigma^'_{i} = min\{\sigma_{i}, 1/k\}#gh-dark-mode-only">
-
-and
-
-<img src="https://render.githubusercontent.com/render/math?math=\lambda^'_{i} = min\{\lambda_{i}, 1/k\}#gh-light-mode-only">
-<img src="https://render.githubusercontent.com/render/math?math=\color{white}\lambda^'_{i} = min\{\lambda_{i}, 1/k\}#gh-dark-mode-only">
-
-Operator of node `i` is credited with the following amount:
-
-<img src="https://render.githubusercontent.com/render/math?math=min\{PP_{i},R_{i})\} %2b max\{0, (PM_{i} %2b (1 - PM_{i}) \cdot \lambda_{i}/\delta_{i}) \cdot (R_{i} - PP_{i})\}#gh-light-mode-only">
-<img src="https://render.githubusercontent.com/render/math?math=\color{white}min\{PP_{i},R_{i})\} %2b max\{0, (PM_{i} %2b (1 - PM_{i}) \cdot \lambda_{i}/\delta_{i}) \cdot (R_{i} - PP_{i})\}#gh-dark-mode-only">
-
-Delegate with stake `s` receives:
-
-<img src="https://render.githubusercontent.com/render/math?math=max\{0, (1-PM_{i}) \cdot (s^'/\sigma_{i}) \cdot (R_{i} - PP_{i})\}#gh-light-mode-only">
-<img src="https://render.githubusercontent.com/render/math?math=\color{white}max\{0, (1-PM_{i}) \cdot (s^'/\sigma_{i}) \cdot (R_{i} - PP_{i})\}#gh-dark-mode-only">
-
-where `s'` is stake `s` scaled over total token circulating supply.
+Nym network economic incentives, operator and validator rewards, and scalability of the network are determined according to the principles laid out in the section 6 of [Nym Whitepaper](https://nymtech.net/nym-whitepaper.pdf).
+Initial reward pool is set to 250 million Nym, making the circulating supply 750 million Nym.

 ### Licensing and copyright information

 This is a monorepo and components that make up Nym as a system are licensed individually, so for accurate information, please check individual files.

 As a general approach, licensing is as follows this pattern:
+
 - applications and binaries are GPLv3
 - libraries and components are Apache 2.0 or MIT
 - documentation is Apache 2.0 or CC0-1.0

-Again, for accurate information, please check individual files.
+Nym Node Operators and Validators Temrs and Conditions can be found [here](https://nymtech.net/terms-and-conditions/operators/v1.0.0).
@@ -23,7 +23,7 @@ url = { workspace = true }

 bs58 = { workspace = true }
 clap = { workspace = true, features = ["cargo", "derive"] }
-dirs = "4.0"
+dirs = { workspace = true }
 log = { workspace = true } # self explanatory
 rand = { workspace = true }
 serde = { workspace = true, features = ["derive"] } # for config serialization/deserialization
@@ -37,7 +37,7 @@ zeroize = { workspace = true }

 ## internal
 nym-bandwidth-controller = { path = "../../common/bandwidth-controller" }
-nym-bin-common = { path = "../../common/bin-common", features = ["output_format"] }
+nym-bin-common = { path = "../../common/bin-common", features = ["output_format", "clap"] }
 nym-client-core = { path = "../../common/client-core", features = ["fs-surb-storage", "fs-gateways-storage", "cli"] }
 nym-config = { path = "../../common/config" }
 nym-credential-storage = { path = "../../common/credential-storage" }
@@ -106,8 +106,10 @@ impl SocketClient {
        };

        let storage = self.initialise_storage().await?;
+        let user_agent = nym_bin_common::bin_info!().into();

-        let mut base_client = BaseClientBuilder::new(&self.config.base, storage, dkg_query_client);
+        let mut base_client = BaseClientBuilder::new(&self.config.base, storage, dkg_query_client)
+            .with_user_agent(user_agent);

        if let Some(custom_mixnet) = &self.custom_mixnet {
            base_client = base_client.with_stored_topology(custom_mixnet)?;
@@ -22,8 +22,9 @@ impl AsRef<CommonClientAddGatewayArgs> for Args {
 }

 pub(crate) async fn execute(args: Args) -> Result<(), ClientError> {
+    let user_agent = nym_bin_common::bin_info!().into();
    let output = args.output;
-    let res = add_gateway::<CliNativeClient, _>(args).await?;
+    let res = add_gateway::<CliNativeClient, _>(args, Some(user_agent)).await?;

    println!("{}", output.format(&res));
    Ok(())
@@ -114,8 +114,9 @@ impl Display for InitResults {
 pub(crate) async fn execute(args: Init) -> Result<(), ClientError> {
    eprintln!("Initialising client...");

+    let user_agent = nym_bin_common::bin_info!().into();
    let output = args.output;
-    let res = initialise_client::<CliNativeClient>(args).await?;
+    let res = initialise_client::<CliNativeClient>(args, Some(user_agent)).await?;

    let init_results = InitResults::new(res);
    println!("{}", output.format(&init_results));
@@ -25,17 +25,18 @@ zeroize = { workspace = true }
 nym-bin-common = { path = "../../common/bin-common", features = ["output_format"] }
 nym-client-core = { path = "../../common/client-core", features = ["fs-surb-storage", "fs-gateways-storage", "cli"] }
 nym-config = { path = "../../common/config" }
+nym-credential-storage = { path = "../../common/credential-storage" }
 nym-credentials = { path = "../../common/credentials" }
 nym-crypto = { path = "../../common/crypto" }
 nym-gateway-requests = { path = "../../gateway/gateway-requests" }
-nym-credential-storage = { path = "../../common/credential-storage" }
+nym-id = { path = "../../common/nym-id" }
 nym-network-defaults = { path = "../../common/network-defaults" }
-nym-sphinx = { path = "../../common/nymsphinx" }
 nym-ordered-buffer = { path = "../../common/socks5/ordered-buffer" }
 nym-pemstore = { path = "../../common/pemstore" }
-nym-topology = { path = "../../common/topology" }
 nym-socks5-client-core = { path = "../../common/socks5-client-core" }
-nym-id = { path = "../../common/nym-id" }
+nym-sphinx = { path = "../../common/nymsphinx" }
+nym-topology = { path = "../../common/topology" }
+nym-validator-client = { path = "../../common/client-libs/validator-client", features = ["http-client"] }

 [features]
 default = []
@@ -22,8 +22,9 @@ impl AsRef<CommonClientAddGatewayArgs> for Args {
 }

 pub(crate) async fn execute(args: Args) -> Result<(), Socks5ClientError> {
+    let user_agent = nym_bin_common::bin_info!().into();
    let output = args.output;
-    let res = add_gateway::<CliSocks5Client, _>(args).await?;
+    let res = add_gateway::<CliSocks5Client, _>(args, Some(user_agent)).await?;

    println!("{}", output.format(&res));
    Ok(())
@@ -129,8 +129,9 @@ impl Display for InitResults {
 pub(crate) async fn execute(args: Init) -> Result<(), Socks5ClientError> {
    eprintln!("Initialising client...");

+    let user_agent = nym_bin_common::bin_info!().into();
    let output = args.output;
-    let res = initialise_client::<CliSocks5Client>(args).await?;
+    let res = initialise_client::<CliSocks5Client>(args, Some(user_agent)).await?;

    let init_results = InitResults::new(res);
    println!("{}", output.format(&init_results));
@@ -116,7 +116,13 @@ pub(crate) async fn execute(args: Run) -> Result<(), Box<dyn std::error::Error +
    let storage =
        OnDiskPersistent::from_paths(config.storage_paths.common_paths, &config.core.base.debug)
            .await?;
-    NymClient::new(config.core, storage, args.common_args.custom_mixnet)
-        .run_forever()
-        .await
+    let user_agent = nym_bin_common::bin_info!().into();
+    NymClient::new(
+        config.core,
+        storage,
+        user_agent,
+        args.common_args.custom_mixnet,
+    )
+    .run_forever()
+    .await
 }
@@ -0,0 +1,17 @@
+[package]
+name = "nym-authenticator-requests"
+version = "0.1.0"
+authors.workspace = true
+repository.workspace = true
+homepage.workspace = true
+documentation.workspace = true
+edition.workspace = true
+license.workspace = true
+
+[dependencies]
+bincode = { workspace = true }
+rand = { workspace = true }
+serde = { workspace = true, features = ["derive"] }
+
+nym-sphinx = { path = "../nymsphinx" }
+nym-wireguard-types = { path = "../wireguard-types" }
@@ -0,0 +1,13 @@
+// Copyright 2024 - Nym Technologies SA <contact@nymtech.net>
+// SPDX-License-Identifier: Apache-2.0
+
+pub mod v1;
+
+pub const CURRENT_VERSION: u8 = 1;
+
+fn make_bincode_serializer() -> impl bincode::Options {
+    use bincode::Options;
+    bincode::DefaultOptions::new()
+        .with_big_endian()
+        .with_varint_encoding()
+}
@@ -0,0 +1,7 @@
+// Copyright 2024 - Nym Technologies SA <contact@nymtech.net>
+// SPDX-License-Identifier: Apache-2.0
+
+pub mod request;
+pub mod response;
+
+const VERSION: u8 = 1;
@@ -0,0 +1,70 @@
+// Copyright 2024 - Nym Technologies SA <contact@nymtech.net>
+// SPDX-License-Identifier: Apache-2.0
+
+use nym_sphinx::addressing::Recipient;
+use nym_wireguard_types::{GatewayClient, InitMessage};
+use serde::{Deserialize, Serialize};
+
+use crate::make_bincode_serializer;
+
+use super::VERSION;
+
+fn generate_random() -> u64 {
+    use rand::RngCore;
+    let mut rng = rand::rngs::OsRng;
+    rng.next_u64()
+}
+
+#[derive(Clone, Debug, Serialize, Deserialize)]
+pub struct AuthenticatorRequest {
+    pub version: u8,
+    pub data: AuthenticatorRequestData,
+    pub reply_to: Recipient,
+    pub request_id: u64,
+}
+
+impl AuthenticatorRequest {
+    pub fn from_reconstructed_message(
+        message: &nym_sphinx::receiver::ReconstructedMessage,
+    ) -> Result<Self, bincode::Error> {
+        use bincode::Options;
+        make_bincode_serializer().deserialize(&message.message)
+    }
+
+    pub fn new_initial_request(init_message: InitMessage, reply_to: Recipient) -> (Self, u64) {
+        let request_id = generate_random();
+        (
+            Self {
+                version: VERSION,
+                data: AuthenticatorRequestData::Initial(init_message),
+                reply_to,
+                request_id,
+            },
+            request_id,
+        )
+    }
+
+    pub fn new_final_request(gateway_client: GatewayClient, reply_to: Recipient) -> (Self, u64) {
+        let request_id = generate_random();
+        (
+            Self {
+                version: VERSION,
+                data: AuthenticatorRequestData::Final(gateway_client),
+                reply_to,
+                request_id,
+            },
+            request_id,
+        )
+    }
+
+    pub fn to_bytes(&self) -> Result<Vec<u8>, bincode::Error> {
+        use bincode::Options;
+        make_bincode_serializer().serialize(self)
+    }
+}
+
+#[derive(Clone, Debug, Serialize, Deserialize)]
+pub enum AuthenticatorRequestData {
+    Initial(InitMessage),
+    Final(GatewayClient),
+}
@@ -0,0 +1,88 @@
+// Copyright 2024 - Nym Technologies SA <contact@nymtech.net>
+// SPDX-License-Identifier: Apache-2.0
+
+use nym_sphinx::addressing::Recipient;
+use nym_wireguard_types::registration::RegistrationData;
+use serde::{Deserialize, Serialize};
+
+use crate::make_bincode_serializer;
+
+use super::VERSION;
+
+#[derive(Clone, Debug, Serialize, Deserialize)]
+pub struct AuthenticatorResponse {
+    pub version: u8,
+    pub data: AuthenticatorResponseData,
+    pub reply_to: Recipient,
+}
+
+impl AuthenticatorResponse {
+    pub fn new_pending_registration_success(
+        registration_data: RegistrationData,
+        request_id: u64,
+        reply_to: Recipient,
+    ) -> Self {
+        Self {
+            version: VERSION,
+            data: AuthenticatorResponseData::PendingRegistration(PendingRegistrationResponse {
+                reply: registration_data,
+                reply_to,
+                request_id,
+            }),
+            reply_to,
+        }
+    }
+
+    pub fn new_registered(reply_to: Recipient, request_id: u64) -> Self {
+        Self {
+            version: VERSION,
+            data: AuthenticatorResponseData::Registered(RegisteredResponse {
+                reply_to,
+                request_id,
+            }),
+            reply_to,
+        }
+    }
+
+    pub fn recipient(&self) -> Recipient {
+        self.reply_to
+    }
+
+    pub fn to_bytes(&self) -> Result<Vec<u8>, bincode::Error> {
+        use bincode::Options;
+        make_bincode_serializer().serialize(self)
+    }
+
+    pub fn from_reconstructed_message(
+        message: &nym_sphinx::receiver::ReconstructedMessage,
+    ) -> Result<Self, bincode::Error> {
+        use bincode::Options;
+        make_bincode_serializer().deserialize(&message.message)
+    }
+
+    pub fn id(&self) -> Option<u64> {
+        match &self.data {
+            AuthenticatorResponseData::PendingRegistration(response) => Some(response.request_id),
+            AuthenticatorResponseData::Registered(response) => Some(response.request_id),
+        }
+    }
+}
+
+#[derive(Clone, Debug, Serialize, Deserialize)]
+pub enum AuthenticatorResponseData {
+    PendingRegistration(PendingRegistrationResponse),
+    Registered(RegisteredResponse),
+}
+
+#[derive(Clone, Debug, Serialize, Deserialize)]
+pub struct PendingRegistrationResponse {
+    pub request_id: u64,
+    pub reply_to: Recipient,
+    pub reply: RegistrationData,
+}
+
+#[derive(Clone, Debug, Serialize, Deserialize)]
+pub struct RegisteredResponse {
+    pub request_id: u64,
+    pub reply_to: Recipient,
+}
@@ -0,0 +1,13 @@
+// Copyright 2024 - Nym Technologies SA <contact@nymtech.net>
+// SPDX-License-Identifier: Apache-2.0
+
+// See other comments for other TaskStatus message enumds about abusing the Error trait when we
+// should have a new trait for TaskStatus messages
+#[derive(Debug, thiserror::Error)]
+pub enum BandwidthStatusMessage {
+    #[error("remaining bandwidth: {0}")]
+    RemainingBandwidth(i64),
+
+    #[error("no bandwidth left")]
+    NoBandwidth,
+}
@@ -14,8 +14,11 @@ use nym_validator_client::coconut::all_coconut_api_clients;
 use nym_validator_client::nym_api::EpochId;
 use nym_validator_client::nyxd::contract_traits::DkgQueryClient;

+pub use event::BandwidthStatusMessage;
+
 pub mod acquire;
 pub mod error;
+mod event;
 mod utils;

 #[derive(Debug)]
@@ -9,9 +9,9 @@ repository = { workspace = true }

 [dependencies]
 const-str = { workspace = true }
-clap = { workspace = true, features = ["derive"] }
-clap_complete = { workspace = true }
-clap_complete_fig = { workspace = true }
+clap = { workspace = true, features = ["derive"], optional = true }
+clap_complete = { workspace = true, optional = true }
+clap_complete_fig = { workspace = true, optional = true }
 log = { workspace = true }
 pretty_env_logger = { workspace = true }
 semver = "0.11"
@@ -34,7 +34,7 @@ vergen = { workspace = true, features = ["build", "git", "gitcl", "rustc", "carg
 [features]
 default = []
 openapi = ["utoipa"]
-output_format = ["serde_json"]
+output_format = ["serde_json", "dep:clap"]
 bin_info_schema = ["schemars"]
 basic_tracing = ["tracing-subscriber"]
 tracing = [
@@ -44,3 +44,4 @@ tracing = [
    "tracing-opentelemetry",
    "opentelemetry",
 ]
+clap = [ "dep:clap", "dep:clap_complete", "dep:clap_complete_fig" ]
@@ -44,6 +44,10 @@ pub struct BinaryBuildInformation {
    /// Provides the cargo debug mode that was used for the build.
    // NOTE: keep the old name cargo_profile instead of cargo_debug for backwards compatibility
    pub cargo_profile: &'static str,
+
+    // VERGEN_CARGO_TARGET_TRIPLE
+    /// Provides the cargo target triple that was used for the build.
+    pub cargo_triple: &'static str,
 }

 impl BinaryBuildInformation {
@@ -66,6 +70,7 @@ impl BinaryBuildInformation {
            rustc_version: env!("VERGEN_RUSTC_SEMVER"),
            rustc_channel: env!("VERGEN_RUSTC_CHANNEL"),
            cargo_profile,
+            cargo_triple: env!("VERGEN_CARGO_TARGET_TRIPLE"),
        }
    }

@@ -95,6 +100,7 @@ impl BinaryBuildInformation {
            rustc_version: env!("VERGEN_RUSTC_SEMVER"),
            rustc_channel: env!("VERGEN_RUSTC_CHANNEL"),
            cargo_profile,
+            cargo_triple: env!("VERGEN_CARGO_TARGET_TRIPLE"),
        }
    }

@@ -109,6 +115,7 @@ impl BinaryBuildInformation {
            rustc_version: self.rustc_version.to_owned(),
            rustc_channel: self.rustc_channel.to_owned(),
            cargo_profile: self.cargo_profile.to_owned(),
+            cargo_triple: self.cargo_triple.to_owned(),
        }
    }

@@ -156,6 +163,15 @@ pub struct BinaryBuildInformationOwned {
    /// Provides the cargo debug mode that was used for the build.
    // NOTE: keep the old name cargo_profile instead of cargo_debug for backwards compatibility
    pub cargo_profile: String,
+
+    // VERGEN_CARGO_TARGET_TRIPLE
+    /// Provides the cargo target triple that was used for the build.
+    #[serde(default = "unknown")]
+    pub cargo_triple: String,
+}
+
+fn unknown() -> String {
+    "unknown".to_string()
 }

 impl Display for BinaryBuildInformationOwned {
@@ -2,9 +2,11 @@
 // SPDX-License-Identifier: Apache-2.0

 pub mod build_information;
-pub mod completions;
 pub mod logging;
 pub mod version_checker;

+#[cfg(feature = "clap")]
+pub mod completions;
+
 #[cfg(feature = "output_format")]
 pub mod output_format;
@@ -10,7 +10,7 @@ license.workspace = true

 [dependencies]
 async-trait = { workspace = true }
-base64 = "0.21.2"
+base64 = { workspace = true }
 bs58 = { workspace = true }
 cfg-if = { workspace = true }
 clap = { workspace = true, optional = true }
@@ -20,7 +20,7 @@ log = { workspace = true }
 rand = { workspace = true }
 serde = { workspace = true, features = ["derive"] }
 serde_json = { workspace = true }
-sha2 = "0.10.6"
+sha2 = { workspace = true }
 si-scale = { workspace = true }
 tap = { workspace = true }
 thiserror = { workspace = true }
@@ -16,6 +16,7 @@ use log::info;
 use nym_client_core_gateways_storage::GatewayDetails;
 use nym_crypto::asymmetric::identity;
 use nym_topology::NymTopology;
+use nym_validator_client::UserAgent;
 use std::path::PathBuf;

 #[cfg_attr(feature = "cli", derive(clap::Args))]
@@ -60,7 +61,10 @@ pub struct CommonClientAddGatewayArgs {
    pub custom_mixnet: Option<PathBuf>,
 }

-pub async fn add_gateway<C, A>(args: A) -> Result<GatewayInfo, C::Error>
+pub async fn add_gateway<C, A>(
+    args: A,
+    user_agent: Option<UserAgent>,
+) -> Result<GatewayInfo, C::Error>
 where
    A: AsRef<CommonClientAddGatewayArgs>,
    C: CliClient,
@@ -111,7 +115,8 @@ where
        hardcoded_topology.get_gateways()
    } else {
        let mut rng = rand::thread_rng();
-        crate::init::helpers::current_gateways(&mut rng, &core.client.nym_api_urls).await?
+        crate::init::helpers::current_gateways(&mut rng, &core.client.nym_api_urls, user_agent)
+            .await?
    };

    // since we're registering with a brand new gateway,
@@ -16,6 +16,7 @@ use log::info;
 use nym_client_core_gateways_storage::GatewayDetails;
 use nym_crypto::asymmetric::identity;
 use nym_topology::NymTopology;
+use nym_validator_client::UserAgent;
 use rand::rngs::OsRng;
 use std::path::PathBuf;

@@ -96,6 +97,7 @@ pub struct InitResultsWithConfig<T> {

 pub async fn initialise_client<C>(
    init_args: C::InitArgs,
+    user_agent: Option<UserAgent>,
 ) -> Result<InitResultsWithConfig<C::Config>, C::Error>
 where
    C: InitialisableClient,
@@ -163,7 +165,8 @@ where
        hardcoded_topology.get_gateways()
    } else {
        let mut rng = rand::thread_rng();
-        crate::init::helpers::current_gateways(&mut rng, &core.client.nym_api_urls).await?
+        crate::init::helpers::current_gateways(&mut rng, &core.client.nym_api_urls, user_agent)
+            .await?
    };

    let gateway_setup = GatewaySetup::New {
@@ -53,7 +53,7 @@ use nym_task::connections::{ConnectionCommandReceiver, ConnectionCommandSender,
 use nym_task::{TaskClient, TaskHandle};
 use nym_topology::provider_trait::TopologyProvider;
 use nym_topology::HardcodedTopologyProvider;
-use nym_validator_client::nyxd::contract_traits::DkgQueryClient;
+use nym_validator_client::{nyxd::contract_traits::DkgQueryClient, UserAgent};
 use rand::rngs::OsRng;
 use std::fmt::Debug;
 use std::os::raw::c_int as RawFd;
@@ -184,6 +184,7 @@ pub struct BaseClientBuilder<'a, C, S: MixnetClientStorage> {
    custom_topology_provider: Option<Box<dyn TopologyProvider + Send + Sync>>,
    custom_gateway_transceiver: Option<Box<dyn GatewayTransceiver + Send>>,
    shutdown: Option<TaskClient>,
+    user_agent: Option<UserAgent>,

    setup_method: GatewaySetup,
 }
@@ -207,6 +208,7 @@ where
            custom_topology_provider: None,
            custom_gateway_transceiver: None,
            shutdown: None,
+            user_agent: None,
            setup_method: GatewaySetup::MustLoad { gateway_id: None },
        }
    }
@@ -250,6 +252,12 @@ where
        self
    }

+    #[must_use]
+    pub fn with_user_agent(mut self, user_agent: UserAgent) -> Self {
+        self.user_agent = Some(user_agent);
+        self
+    }
+
    pub fn with_stored_topology<P: AsRef<Path>>(
        mut self,
        file: P,
@@ -467,6 +475,7 @@ where
        custom_provider: Option<Box<dyn TopologyProvider + Send + Sync>>,
        config_topology: config::Topology,
        nym_api_urls: Vec<Url>,
+        user_agent: Option<UserAgent>,
    ) -> Box<dyn TopologyProvider + Send + Sync> {
        // if no custom provider was ... provided ..., create one using nym-api
        custom_provider.unwrap_or_else(|| match config_topology.topology_structure {
@@ -477,6 +486,7 @@ where
                },
                nym_api_urls,
                env!("CARGO_PKG_VERSION").to_string(),
+                user_agent,
            )),
            config::TopologyStructure::GeoAware(group_by) => {
                Box::new(GeoAwareTopologyProvider::new(
@@ -689,6 +699,7 @@ where
            self.custom_topology_provider.take(),
            self.config.debug.topology,
            self.config.get_nym_api_endpoints(),
+            self.user_agent.clone(),
        );

        // needs to be started as the first thing to block if required waiting for the gateway
@@ -5,6 +5,7 @@ use async_trait::async_trait;
 use log::{debug, error, warn};
 use nym_topology::provider_trait::TopologyProvider;
 use nym_topology::{NymTopology, NymTopologyError};
+use nym_validator_client::UserAgent;
 use rand::prelude::SliceRandom;
 use rand::thread_rng;
 use url::Url;
@@ -39,14 +40,26 @@ pub(crate) struct NymApiTopologyProvider {
 }

 impl NymApiTopologyProvider {
-    pub(crate) fn new(config: Config, mut nym_api_urls: Vec<Url>, client_version: String) -> Self {
+    pub(crate) fn new(
+        config: Config,
+        mut nym_api_urls: Vec<Url>,
+        client_version: String,
+        user_agent: Option<UserAgent>,
+    ) -> Self {
        nym_api_urls.shuffle(&mut thread_rng());

+        let validator_client = if let Some(user_agent) = user_agent {
+            nym_validator_client::client::NymApiClient::new_with_user_agent(
+                nym_api_urls[0].clone(),
+                user_agent,
+            )
+        } else {
+            nym_validator_client::client::NymApiClient::new(nym_api_urls[0].clone())
+        };
+
        NymApiTopologyProvider {
            config,
-            validator_client: nym_validator_client::client::NymApiClient::new(
-                nym_api_urls[0].clone(),
-            ),
+            validator_client,
            nym_api_urls,
            client_version,
            currently_used_api: 0,
@@ -9,6 +9,7 @@ use nym_crypto::asymmetric::identity;
 use nym_gateway_client::GatewayClient;
 use nym_topology::{filter::VersionFilterable, gateway, mix};
 use nym_validator_client::client::IdentityKeyRef;
+use nym_validator_client::UserAgent;
 use rand::{seq::SliceRandom, Rng};
 use std::{sync::Arc, time::Duration};
 use tungstenite::Message;
@@ -59,11 +60,16 @@ impl<'a> GatewayWithLatency<'a> {
 pub async fn current_gateways<R: Rng>(
    rng: &mut R,
    nym_apis: &[Url],
+    user_agent: Option<UserAgent>,
 ) -> Result<Vec<gateway::Node>, ClientCoreError> {
    let nym_api = nym_apis
        .choose(rng)
        .ok_or(ClientCoreError::ListOfNymApisIsEmpty)?;
-    let client = nym_validator_client::client::NymApiClient::new(nym_api.clone());
+    let client = if let Some(user_agent) = user_agent {
+        nym_validator_client::client::NymApiClient::new_with_user_agent(nym_api.clone(), user_agent)
+    } else {
+        nym_validator_client::client::NymApiClient::new(nym_api.clone())
+    };

    log::debug!("Fetching list of gateways from: {nym_api}");

@@ -11,7 +11,7 @@ use crate::traits::GatewayPacketRouter;
 use crate::{cleanup_socket_message, try_decrypt_binary_message};
 use futures::{SinkExt, StreamExt};
 use log::*;
-use nym_bandwidth_controller::BandwidthController;
+use nym_bandwidth_controller::{BandwidthController, BandwidthStatusMessage};
 use nym_credential_storage::ephemeral_storage::EphemeralStorage as EphemeralCredentialStorage;
 use nym_credential_storage::storage::Storage as CredentialStorage;
 use nym_credentials::CredentialSpendingData;
@@ -105,8 +105,8 @@ pub struct GatewayClient<C, St = EphemeralCredentialStorage> {
    // currently unused (but populated)
    negotiated_protocol: Option<u8>,

-    /// Listen to shutdown messages.
-    shutdown: TaskClient,
+    /// Listen to shutdown messages and send notifications back to the task manager
+    task_client: TaskClient,
 }

 impl<C, St> GatewayClient<C, St> {
@@ -117,7 +117,7 @@ impl<C, St> GatewayClient<C, St> {
        shared_key: Option<Arc<SharedKeys>>,
        packet_router: PacketRouter,
        bandwidth_controller: Option<BandwidthController<C, St>>,
-        shutdown: TaskClient,
+        task_client: TaskClient,
    ) -> Self {
        GatewayClient {
            authenticated: false,
@@ -135,7 +135,7 @@ impl<C, St> GatewayClient<C, St> {
            reconnection_attempts: DEFAULT_RECONNECTION_ATTEMPTS,
            reconnection_backoff: DEFAULT_RECONNECTION_BACKOFF,
            negotiated_protocol: None,
-            shutdown,
+            task_client,
        }
    }

@@ -299,7 +299,7 @@ impl<C, St> GatewayClient<C, St> {

        loop {
            tokio::select! {
-                _ = self.shutdown.recv() => {
+                _ = self.task_client.recv() => {
                    log::trace!("GatewayClient control response: Received shutdown");
                    log::debug!("GatewayClient control response: Exiting");
                    break Err(GatewayClientError::ConnectionClosedGatewayShutdown);
@@ -540,6 +540,9 @@ impl<C, St> GatewayClient<C, St> {
                self.bandwidth_remaining = bandwidth_remaining;
                self.negotiated_protocol = protocol_version;
                log::debug!("authenticated: {status}, bandwidth remaining: {bandwidth_remaining}");
+                self.task_client.send_status_msg(Box::new(
+                    BandwidthStatusMessage::RemainingBandwidth(bandwidth_remaining),
+                ));
                Ok(())
            }
            ServerResponse::Error { message } => Err(GatewayClientError::GatewayError(message)),
@@ -805,7 +808,7 @@ impl<C, St> GatewayClient<C, St> {
                                .as_ref()
                                .expect("no shared key present even though we're authenticated!"),
                        ),
-                        self.shutdown.clone(),
+                        self.task_client.clone(),
                    )
                }
                _ => unreachable!(),
@@ -879,8 +882,8 @@ impl GatewayClient<InitOnly, EphemeralCredentialStorage> {
        // perfectly fine here, because it's not meant to be used
        let (ack_tx, _) = mpsc::unbounded();
        let (mix_tx, _) = mpsc::unbounded();
-        let shutdown = TaskClient::dummy();
-        let packet_router = PacketRouter::new(ack_tx, mix_tx, shutdown.clone());
+        let task_client = TaskClient::dummy();
+        let packet_router = PacketRouter::new(ack_tx, mix_tx, task_client.clone());

        GatewayClient {
            authenticated: false,
@@ -898,7 +901,7 @@ impl GatewayClient<InitOnly, EphemeralCredentialStorage> {
            reconnection_attempts: DEFAULT_RECONNECTION_ATTEMPTS,
            reconnection_backoff: DEFAULT_RECONNECTION_BACKOFF,
            negotiated_protocol: None,
-            shutdown,
+            task_client,
        }
    }

@@ -906,7 +909,7 @@ impl GatewayClient<InitOnly, EphemeralCredentialStorage> {
        self,
        packet_router: PacketRouter,
        bandwidth_controller: Option<BandwidthController<C, St>>,
-        shutdown: TaskClient,
+        task_client: TaskClient,
    ) -> GatewayClient<C, St> {
        // invariants that can't be broken
        // (unless somebody decided to expose some field that wasn't meant to be exposed)
@@ -930,7 +933,7 @@ impl GatewayClient<InitOnly, EphemeralCredentialStorage> {
            reconnection_attempts: self.reconnection_attempts,
            reconnection_backoff: self.reconnection_backoff,
            negotiated_protocol: self.negotiated_protocol,
-            shutdown,
+            task_client,
        }
    }
 }
@@ -54,7 +54,7 @@ cw-controllers = { workspace = true }
 prost = { workspace = true, default-features = false }
 flate2 = { workspace = true }
 sha2 = { version = "0.9.5" }
-itertools = { version = "0.10" }
+itertools = { workspace = true }
 zeroize = { workspace = true, features = ["zeroize_derive"] }
 cosmwasm-std = { workspace = true }

@@ -19,6 +19,7 @@ use nym_api_requests::models::{
    RewardEstimationResponse, StakeSaturationResponse,
 };
 use nym_api_requests::nym_nodes::SkimmedNode;
+use nym_http_api_client::UserAgent;
 use nym_network_defaults::NymNetworkDetails;
 use url::Url;

@@ -258,6 +259,16 @@ impl NymApiClient {
        NymApiClient { nym_api }
    }

+    pub fn new_with_user_agent(api_url: Url, user_agent: UserAgent) -> Self {
+        let nym_api = nym_api::Client::builder::<_, ValidatorClientError>(api_url)
+            .expect("invalid api url")
+            .with_user_agent(user_agent)
+            .build::<ValidatorClientError>()
+            .expect("failed to build nym api client");
+
+        NymApiClient { nym_api }
+    }
+
    pub fn api_url(&self) -> &Url {
        self.nym_api.current_url()
    }
@@ -17,6 +17,7 @@ pub use crate::signing::direct_wallet::DirectSecp256k1HdWallet;
 pub use client::NymApiClient;
 pub use client::{Client, CoconutApiClient, Config};
 pub use nym_api_requests::*;
+pub use nym_http_api_client::UserAgent;

 #[cfg(feature = "http-client")]
 pub use cosmrs::rpc::HttpClient as HttpRpcClient;
@@ -3,7 +3,7 @@

 use crate::nyxd::cosmwasm_client::client_traits::CosmWasmClient;
 use crate::nyxd::cosmwasm_client::helpers::{compress_wasm_code, CheckResponse};
-use crate::nyxd::cosmwasm_client::logs::{self, parse_raw_logs};
+use crate::nyxd::cosmwasm_client::logs::parse_raw_logs;
 use crate::nyxd::cosmwasm_client::types::*;
 use crate::nyxd::error::NyxdError;
 use crate::nyxd::fee::{Fee, DEFAULT_SIMULATED_GAS_MULTIPLIER};
@@ -19,6 +19,7 @@ use cosmrs::feegrant::{
 };
 use cosmrs::proto::cosmos::tx::signing::v1beta1::SignMode;
 use cosmrs::staking::{MsgDelegate, MsgUndelegate};
+use cosmrs::tendermint::abci::{Event, EventAttribute};
 use cosmrs::tx::{self, Msg};
 use cosmrs::{cosmwasm, AccountId, Any, Tx};
 use log::debug;
@@ -51,6 +52,20 @@ fn single_unspecified_signer_auth(
    }
    .auth_info(empty_fee())
 }
+// Searches in events for an event of the given event type which contains an
+// attribute for with the given key.
+fn find_attribute<'a>(
+    events: &'a [Event],
+    event_type: &str,
+    attr_key: &str,
+) -> Option<&'a EventAttribute> {
+    events
+        .iter()
+        .find(|attr| attr.kind == event_type)?
+        .attributes
+        .iter()
+        .find(|attr| attr.key == attr_key)
+}

 #[cfg_attr(target_arch = "wasm32", async_trait(?Send))]
 #[cfg_attr(not(target_arch = "wasm32"), async_trait)]
@@ -118,6 +133,7 @@ where
            .check_response()?;

        let logs = parse_raw_logs(tx_res.tx_result.log)?;
+        let events = tx_res.tx_result.events;
        let gas_info = GasInfo {
            gas_wanted: tx_res.tx_result.gas_wanted.try_into().unwrap_or_default(),
            gas_used: tx_res.tx_result.gas_used.try_into().unwrap_or_default(),
@@ -127,7 +143,7 @@ where
        // the reason I think unwrap here is fine is that if the transaction succeeded and those
        // fields do not exist or code_id is not a number, there's no way we can recover, we're probably connected
        // to wrong validator or something
-        let code_id = logs::find_attribute(&logs, "store_code", "code_id")
+        let code_id = find_attribute(&events, "store_code", "code_id")
            .unwrap()
            .value
            .parse()
@@ -140,6 +156,7 @@ where
            compressed_checksum,
            code_id,
            logs,
+            events,
            transaction_hash: tx_res.hash,
            gas_info,
        })
@@ -182,6 +199,7 @@ where
            .check_response()?;

        let logs = parse_raw_logs(tx_res.tx_result.log)?;
+        let events = tx_res.tx_result.events;
        let gas_info = GasInfo {
            gas_wanted: tx_res.tx_result.gas_wanted.try_into().unwrap_or_default(),
            gas_used: tx_res.tx_result.gas_used.try_into().unwrap_or_default(),
@@ -190,7 +208,7 @@ where
        // the reason I think unwrap here is fine is that if the transaction succeeded and those
        // fields do not exist or address is malformed, there's no way we can recover, we're probably connected
        // to wrong validator or something
-        let contract_address = logs::find_attribute(&logs, "instantiate", "_contract_address")
+        let contract_address = find_attribute(&events, "instantiate", "_contract_address")
            .unwrap()
            .value
            .parse()
@@ -199,6 +217,7 @@ where
        Ok(InstantiateResult {
            contract_address,
            logs,
+            events,
            transaction_hash: tx_res.hash,
            gas_info,
        })
@@ -231,6 +250,7 @@ where
        };
        Ok(ChangeAdminResult {
            logs: parse_raw_logs(tx_res.tx_result.log)?,
+            events: tx_res.tx_result.events,
            transaction_hash: tx_res.hash,
            gas_info,
        })
@@ -261,6 +281,7 @@ where
        };
        Ok(ChangeAdminResult {
            logs: parse_raw_logs(tx_res.tx_result.log)?,
+            events: tx_res.tx_result.events,
            transaction_hash: tx_res.hash,
            gas_info,
        })
@@ -298,6 +319,7 @@ where
        };
        Ok(MigrateResult {
            logs: parse_raw_logs(tx_res.tx_result.log)?,
+            events: tx_res.tx_result.events,
            transaction_hash: tx_res.hash,
            gas_info,
        })
@@ -335,6 +357,7 @@ where
        };
        Ok(ExecuteResult {
            logs: parse_raw_logs(tx_res.tx_result.log)?,
+            events: tx_res.tx_result.events,
            data: tx_res.tx_result.data.into(),
            transaction_hash: tx_res.hash,
            gas_info,
@@ -378,6 +401,7 @@ where
        };
        Ok(ExecuteResult {
            logs: parse_raw_logs(tx_res.tx_result.log)?,
+            events: tx_res.tx_result.events,
            data: tx_res.tx_result.data.into(),
            transaction_hash: tx_res.hash,
            gas_info,
@@ -35,6 +35,7 @@ pub fn find_attribute<'a>(

 // these two functions were separated so that the internal logic could actually be tested
 fn parse_raw_str_logs(raw: &str) -> Result<Vec<Log>, NyxdError> {
+    // From Cosmos SDK > 0.50 onwards, log field is not populated
    if raw.is_empty() {
        return Ok(Vec::new());
    }
@@ -232,6 +232,8 @@ pub struct UploadResult {

    pub logs: Vec<Log>,

+    pub events: Vec<abci::Event>,
+
    /// Transaction hash (might be used as transaction ID)
    pub transaction_hash: Hash,

@@ -269,6 +271,8 @@ pub struct InstantiateResult {

    pub logs: Vec<Log>,

+    pub events: Vec<abci::Event>,
+
    /// Transaction hash (might be used as transaction ID)
    pub transaction_hash: Hash,

@@ -279,6 +283,8 @@ pub struct InstantiateResult {
 pub struct ChangeAdminResult {
    pub logs: Vec<Log>,

+    pub events: Vec<abci::Event>,
+
    /// Transaction hash (might be used as transaction ID)
    pub transaction_hash: Hash,

@@ -289,6 +295,8 @@ pub struct ChangeAdminResult {
 pub struct MigrateResult {
    pub logs: Vec<Log>,

+    pub events: Vec<abci::Event>,
+
    /// Transaction hash (might be used as transaction ID)
    pub transaction_hash: Hash,

@@ -301,6 +309,8 @@ pub struct ExecuteResult {

    pub data: Vec<u8>,

+    pub events: Vec<abci::Event>,
+
    /// Transaction hash (might be used as transaction ID)
    pub transaction_hash: Hash,

@@ -29,7 +29,7 @@ time = { workspace = true, features = ["parsing", "formatting"] }
 ts-rs = { workspace = true, optional = true }

 [dev-dependencies]
-rand_chacha = "0.3"
+rand_chacha = { workspace = true }
 time = { workspace = true, features = ["serde", "macros"] }

 [features]
@@ -12,16 +12,16 @@ aes = { workspace = true, optional = true }
 bs58 = { workspace = true }
 blake3 = { workspace = true, features = ["traits-preview"], optional = true }
 ctr = { workspace = true, optional = true }
-digest = { version = "0.10.3", optional = true }
+digest = { workspace = true, optional = true }
 generic-array = { workspace = true, optional = true }
 hkdf = { workspace = true, optional = true }
 hmac = { workspace = true, optional = true }
 cipher = { workspace = true, optional = true }
-x25519-dalek = { version = "2.0", optional = true, features = ["static_secrets"]}
-ed25519-dalek = { version = "2.1", features = ["rand_core"], optional = true }
+x25519-dalek = { workspace = true, features = ["static_secrets"], optional = true }
+ed25519-dalek = { workspace = true, features = ["rand_core"], optional = true }
 rand = { workspace = true, optional = true }
 serde_bytes = { version = "0.11.6", optional = true }
-serde_crate = { version = "1.0", optional = true, default_features = false, features = ["derive"], package = "serde" }
+serde_crate = { version = "1.0", optional = true, default-features = false, features = ["derive"], package = "serde" }
 subtle-encoding = { workspace = true, features = ["bech32-preview"] }
 thiserror = { workspace = true }
 zeroize = { workspace = true, optional = true, features = ["zeroize_derive"] }
@@ -31,7 +31,7 @@ nym-sphinx-types = { path = "../nymsphinx/types", version = "0.2.0", default-fea
 nym-pemstore = { path = "../../common/pemstore", version = "0.3.0" }

 [dev-dependencies]
-rand_chacha = "0.3"
+rand_chacha = { workspace = true }

 [features]
 default = ["sphinx"]
@@ -19,7 +19,7 @@ bs58 = { workspace = true }

 lazy_static = { workspace = true }
 rand = { version = "0.8.5", default-features = false}
-rand_chacha = "0.3"
+rand_chacha = { workspace = true }
 rand_core = { workspace = true }
 sha2 = "0.9"
 serde = { workspace = true }
@@ -20,6 +20,8 @@ serde_json = { workspace = true }
 thiserror = { workspace = true }
 tracing = { workspace = true }

+nym-bin-common = { path = "../bin-common" }
+
 # for request timeout until https://github.com/seanmonstar/reqwest/issues/1135 is fixed
 [target."cfg(target_arch = \"wasm32\")".dependencies.wasmtimer]
 workspace = true
@@ -14,6 +14,10 @@ use url::Url;

 pub use reqwest::IntoUrl;

+pub use user_agent::UserAgent;
+
+mod user_agent;
+
 pub const DEFAULT_TIMEOUT: Duration = Duration::from_secs(10);

 pub type PathSegments<'a> = &'a [&'a str];
@@ -0,0 +1,56 @@
+// Copyright 2024 - Nym Technologies SA <contact@nymtech.net>
+// SPDX-License-Identifier: Apache-2.0
+
+use std::fmt;
+
+use http::HeaderValue;
+use nym_bin_common::build_information::{BinaryBuildInformation, BinaryBuildInformationOwned};
+
+#[derive(Clone, Debug)]
+pub struct UserAgent {
+    pub application: String,
+    pub version: String,
+    pub platform: String,
+    pub git_commit: String,
+}
+
+impl fmt::Display for UserAgent {
+    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
+        let abbreviated_commit = self.git_commit.chars().take(7).collect::<String>();
+        write!(
+            f,
+            "{}/{}/{}/{}",
+            self.application, self.version, self.platform, abbreviated_commit
+        )
+    }
+}
+
+impl TryFrom<UserAgent> for HeaderValue {
+    type Error = http::header::InvalidHeaderValue;
+
+    fn try_from(user_agent: UserAgent) -> Result<Self, Self::Error> {
+        HeaderValue::from_str(&user_agent.to_string())
+    }
+}
+
+impl From<BinaryBuildInformation> for UserAgent {
+    fn from(build_info: BinaryBuildInformation) -> Self {
+        UserAgent {
+            application: build_info.binary_name.to_string(),
+            version: build_info.build_version.to_string(),
+            platform: build_info.cargo_triple.to_string(),
+            git_commit: build_info.commit_sha.to_string(),
+        }
+    }
+}
+
+impl From<BinaryBuildInformationOwned> for UserAgent {
+    fn from(build_info: BinaryBuildInformationOwned) -> Self {
+        UserAgent {
+            application: build_info.binary_name,
+            version: build_info.build_version,
+            platform: build_info.cargo_triple,
+            git_commit: build_info.commit_sha,
+        }
+    }
+}
@@ -14,7 +14,7 @@ bytes = { workspace = true }
 nym-bin-common = { path = "../bin-common" }
 nym-crypto = { path = "../crypto" }
 nym-sphinx = { path = "../nymsphinx" }
-rand = "0.8.5"
+rand = { workspace = true }
 serde = { workspace = true, features = ["derive"] }
 thiserror = { workspace = true }
 time = { workspace = true }
@@ -27,7 +27,6 @@ pub const COCONUT_DKG_CONTRACT_ADDRESS: &str =

 pub const REWARDING_VALIDATOR_ADDRESS: &str = "n10yyd98e2tuwu0f7ypz9dy3hhjw7v772q6287gy";

-pub const STATISTICS_SERVICE_DOMAIN_ADDRESS: &str = "https://mainnet-stats.nymte.ch:8090/";
 pub const NYXD_URL: &str = "https://rpc.nymtech.net";
 pub const NYM_API: &str = "https://validator.nymtech.net/api/";
 pub const NYXD_WS: &str = "wss://rpc.nymtech.net/websocket";
@@ -110,10 +109,6 @@ pub fn export_to_env() {
        var_names::REWARDING_VALIDATOR_ADDRESS,
        REWARDING_VALIDATOR_ADDRESS,
    );
-    set_var_to_default(
-        var_names::STATISTICS_SERVICE_DOMAIN_ADDRESS,
-        STATISTICS_SERVICE_DOMAIN_ADDRESS,
-    );
    set_var_to_default(var_names::NYXD, NYXD_URL);
    set_var_to_default(var_names::NYM_API, NYM_API);
    set_var_to_default(var_names::NYXD_WEBSOCKET, NYXD_WS);
@@ -155,10 +150,6 @@ pub fn export_to_env_if_not_set() {
        var_names::REWARDING_VALIDATOR_ADDRESS,
        REWARDING_VALIDATOR_ADDRESS,
    );
-    set_var_conditionally_to_default(
-        var_names::STATISTICS_SERVICE_DOMAIN_ADDRESS,
-        STATISTICS_SERVICE_DOMAIN_ADDRESS,
-    );
    set_var_conditionally_to_default(var_names::NYXD, NYXD_URL);
    set_var_conditionally_to_default(var_names::NYM_API, NYM_API);
    set_var_conditionally_to_default(var_names::NYXD_WEBSOCKET, NYXD_WS);
@@ -19,7 +19,6 @@ pub const GROUP_CONTRACT_ADDRESS: &str = "GROUP_CONTRACT_ADDRESS";
 pub const MULTISIG_CONTRACT_ADDRESS: &str = "MULTISIG_CONTRACT_ADDRESS";
 pub const COCONUT_DKG_CONTRACT_ADDRESS: &str = "COCONUT_DKG_CONTRACT_ADDRESS";
 pub const REWARDING_VALIDATOR_ADDRESS: &str = "REWARDING_VALIDATOR_ADDRESS";
-pub const STATISTICS_SERVICE_DOMAIN_ADDRESS: &str = "STATISTICS_SERVICE_DOMAIN_ADDRESS";
 pub const NYXD: &str = "NYXD";
 pub const NYM_API: &str = "NYM_API";
 pub const NYXD_WEBSOCKET: &str = "NYXD_WS";
@@ -9,7 +9,7 @@ license.workspace = true

 [dependencies]
 bls12_381 = { workspace = true, default-features = false, features = ["pairings", "alloc", "experimental"] }
-itertools = "0.10"
+itertools = { workspace = true }
 digest = "0.9"
 rand = "0.8"
 thiserror = { workspace = true }
@@ -33,7 +33,7 @@ default-features = false
 [dev-dependencies]
 criterion = { workspace = true, features = ["html_reports"] }
 doc-comment = { workspace = true }
-rand_chacha = "0.3"
+rand_chacha = { workspace = true }

 [[bench]]
 name = "benchmarks"
@@ -9,7 +9,7 @@ repository = { workspace = true }

 [dependencies]
 rand = { workspace = true }
-serde_crate = { version = "1.0", optional = true, default_features = false, features = ["derive"], package = "serde" }
+serde_crate = { version = "1.0", optional = true, default-features = false, features = ["derive"], package = "serde" }
 generic-array = { workspace = true, optional = true, features = ["serde"] }
 thiserror = { workspace = true }
 zeroize = { workspace = true }
@@ -24,4 +24,4 @@ nym-topology = { path = "../../topology" }
 version = "0.2.83"

 [dev-dependencies]
-rand_chacha = "0.3"
+rand_chacha = { workspace = true }
@@ -17,7 +17,7 @@ cosmrs.workspace = true
 eyre = { workspace = true }
 futures.workspace = true
 humantime = { workspace = true }
-sha2 = "0.10.8"
+sha2 = { workspace = true }
 serde = { workspace = true, features = ["derive"] }
 sqlx = { workspace = true, features = ["runtime-tokio-rustls", "sqlite", "macros", "migrate", "time"] }
 tendermint.workspace = true
@@ -8,7 +8,7 @@ license.workspace = true

 [dependencies]
 anyhow = { workspace = true }
-dirs = "4.0"
+dirs = { workspace = true }
 futures = { workspace = true }
 log = { workspace = true }
 pin-project = { workspace = true }
@@ -27,6 +27,7 @@ use nym_task::manager::TaskStatus;
 use nym_task::{TaskClient, TaskHandle};

 use anyhow::anyhow;
+use nym_validator_client::UserAgent;
 use std::error::Error;
 use std::path::PathBuf;

@@ -61,6 +62,8 @@ pub struct NymClient<S> {

    setup_method: GatewaySetup,

+    user_agent: UserAgent,
+
    /// Optional path to a .json file containing standalone network details.
    custom_mixnet: Option<PathBuf>,
 }
@@ -74,11 +77,17 @@ where
    <S::GatewaysDetailsStore as GatewaysDetailsStore>::StorageError: Sync + Send,
    <S::KeyStore as KeyStore>::StorageError: Send + Sync,
 {
-    pub fn new(config: Config, storage: S, custom_mixnet: Option<PathBuf>) -> Self {
+    pub fn new(
+        config: Config,
+        storage: S,
+        user_agent: UserAgent,
+        custom_mixnet: Option<PathBuf>,
+    ) -> Self {
        NymClient {
            config,
            storage,
            setup_method: GatewaySetup::MustLoad { gateway_id: None },
+            user_agent,
            custom_mixnet,
        }
    }
@@ -226,7 +235,8 @@ where

        let mut base_builder =
            BaseClientBuilder::new(&self.config.base, self.storage, dkg_query_client)
-                .with_gateway_setup(self.setup_method);
+                .with_gateway_setup(self.setup_method)
+                .with_user_agent(self.user_agent);

        if let Some(custom_mixnet) = &self.custom_mixnet {
            base_builder = base_builder.with_stored_topology(custom_mixnet)?;
@@ -1,20 +0,0 @@
-# Copyright 2022 - Nym Technologies SA <contact@nymtech.net>
-# SPDX-License-Identifier: Apache-2.0
-
-[package]
-name = "nym-statistics-common"
-version = "1.0.1"
-edition = "2021"
-license.workspace = true
-
-# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
-
-[dependencies]
-async-trait = { workspace = true }
-log = { workspace = true }
-reqwest = { workspace = true, features = ["json"] }
-serde = { workspace = true, features = ["derive"] }
-serde_json = { workspace = true }
-sqlx = { workspace = true, features = ["runtime-tokio-rustls", "chrono"]}
-thiserror = { workspace = true }
-tokio = { workspace = true, features = ["time"] }
@@ -1,51 +0,0 @@
-// Copyright 2022 - Nym Technologies SA <contact@nymtech.net>
-// SPDX-License-Identifier: Apache-2.0
-
-use crate::error::StatsError;
-use crate::StatsMessage;
-
-pub const DEFAULT_STATISTICS_SERVICE_ADDRESS: &str = "127.0.0.1";
-pub const DEFAULT_STATISTICS_SERVICE_PORT: u16 = 8091;
-
-pub const STATISTICS_SERVICE_VERSION: &str = "/v1";
-pub const STATISTICS_SERVICE_API_STATISTICS: &str = "statistic";
-
-pub async fn build_and_send_statistics_request(
-    msg: StatsMessage,
-    url: String,
-) -> Result<(), StatsError> {
-    reqwest::Client::new()
-        .post(format!(
-            "{url}{STATISTICS_SERVICE_VERSION}/{STATISTICS_SERVICE_API_STATISTICS}"
-        ))
-        .json(&msg)
-        .send()
-        .await?;
-
-    Ok(())
-}
-
-pub fn build_statistics_request_bytes(msg: StatsMessage) -> Result<Vec<u8>, StatsError> {
-    let json_msg = msg.to_json()?;
-
-    let req = reqwest::Request::new(
-        reqwest::Method::POST,
-        reqwest::Url::parse(&format!(
-            "http://{DEFAULT_STATISTICS_SERVICE_ADDRESS}:{DEFAULT_STATISTICS_SERVICE_PORT}{STATISTICS_SERVICE_VERSION}/{STATISTICS_SERVICE_API_STATISTICS}"
-        ))
-        .unwrap(),
-    );
-    let data = format!(
-        "{} {} {:?}\n\
-        Content-Type: application/json\n\
-        Content-Length: {}\n\n\
-        {}\n",
-        req.method().as_str(),
-        req.url().as_str(),
-        req.version(),
-        json_msg.len(),
-        json_msg
-    );
-
-    Ok(data.into_bytes())
-}
@@ -1,57 +0,0 @@
-// Copyright 2022 - Nym Technologies SA <contact@nymtech.net>
-// SPDX-License-Identifier: Apache-2.0
-
-use async_trait::async_trait;
-use log::error;
-use sqlx::types::chrono::{DateTime, Utc};
-use std::time::Duration;
-use tokio::time;
-
-use crate::error::StatsError;
-use crate::StatsMessage;
-
-const STATISTICS_TIMER_INTERVAL: Duration = Duration::from_secs(60);
-
-#[async_trait]
-pub trait StatisticsCollector {
-    async fn create_stats_message(
-        &self,
-        interval: Duration,
-        timestamp: DateTime<Utc>,
-    ) -> StatsMessage;
-    async fn send_stats_message(&self, stats_message: StatsMessage) -> Result<(), StatsError>;
-    async fn reset_stats(&mut self);
-}
-
-pub struct StatisticsSender<T: StatisticsCollector> {
-    collector: T,
-    interval: Duration,
-    timestamp: DateTime<Utc>,
-}
-
-impl<T: StatisticsCollector> StatisticsSender<T> {
-    pub fn new(collector: T) -> Self {
-        StatisticsSender {
-            collector,
-            interval: STATISTICS_TIMER_INTERVAL,
-            timestamp: Utc::now(),
-        }
-    }
-
-    pub async fn run(&mut self) {
-        let mut interval = time::interval(self.interval);
-        loop {
-            interval.tick().await;
-
-            let stats_message = self
-                .collector
-                .create_stats_message(self.interval, self.timestamp)
-                .await;
-            if let Err(e) = self.collector.send_stats_message(stats_message).await {
-                error!("Statistics not sent: {}", e);
-            }
-            self.collector.reset_stats().await;
-            self.timestamp = Utc::now();
-        }
-    }
-}
@@ -1,13 +0,0 @@
-// Copyright 2022 - Nym Technologies SA <contact@nymtech.net>
-// SPDX-License-Identifier: Apache-2.0
-
-use thiserror::Error;
-
-#[derive(Debug, Error)]
-pub enum StatsError {
-    #[error("Serde JSON error: {0}")]
-    SerdeJsonError(#[from] serde_json::Error),
-
-    #[error("Reqwest error: {0}")]
-    ReqwestError(#[from] reqwest::Error),
-}
@@ -1,65 +0,0 @@
-// Copyright 2022 - Nym Technologies SA <contact@nymtech.net>
-// SPDX-License-Identifier: Apache-2.0
-
-use serde::{Deserialize, Serialize};
-
-use error::StatsError;
-
-pub mod api;
-pub mod collector;
-pub mod error;
-
-#[derive(Clone, Debug, Deserialize, Serialize)]
-pub struct StatsMessage {
-    pub stats_data: Vec<StatsData>,
-    pub interval_seconds: u32,
-    pub timestamp: String,
-}
-
-impl StatsMessage {
-    pub fn to_json(&self) -> Result<String, StatsError> {
-        Ok(serde_json::to_string(self)?)
-    }
-
-    pub fn from_json(s: &str) -> Result<Self, StatsError> {
-        Ok(serde_json::from_str(s)?)
-    }
-}
-
-#[derive(Clone, Debug, Deserialize, Serialize)]
-pub enum StatsData {
-    Service(StatsServiceData),
-    Gateway(StatsGatewayData),
-}
-
-#[derive(Clone, Debug, Deserialize, Serialize)]
-pub struct StatsGatewayData {
-    pub gateway_id: String,
-    pub inbox_count: u32,
-}
-
-impl StatsGatewayData {
-    pub fn new(gateway_id: String, inbox_count: u32) -> Self {
-        StatsGatewayData {
-            gateway_id,
-            inbox_count,
-        }
-    }
-}
-
-#[derive(Clone, Debug, Deserialize, Serialize)]
-pub struct StatsServiceData {
-    pub requested_service: String,
-    pub request_bytes: u32,
-    pub response_bytes: u32,
-}
-
-impl StatsServiceData {
-    pub fn new(requested_service: String, request_bytes: u32, response_bytes: u32) -> Self {
-        StatsServiceData {
-            requested_service,
-            request_bytes,
-            response_bytes,
-        }
-    }
-}
@@ -8,21 +8,21 @@ rust-version = "1.58"
 license.workspace = true

 [dependencies]
-base64 = "0.21.4"
+base64 = { workspace = true }
 eyre = { workspace = true }
 hmac = { workspace = true }
-itertools = "0.11"
+itertools = { workspace = true }
 log = { workspace = true }
 reqwest = { workspace = true }
 schemars = { workspace = true }
 serde = { workspace = true, features = ["derive"] }
 serde_json = { workspace = true }
-sha2 = "0.10.8"
+sha2 = { workspace = true }
 strum = { workspace = true, features = ["derive"] }
 thiserror = { workspace = true }
 ts-rs = { workspace = true }
 url = { workspace = true }
-x25519-dalek = { version = "2.0.0", features = ["static_secrets"] }
+x25519-dalek = { workspace = true, features = ["static_secrets"] }

 cosmwasm-std = { workspace = true }
 cosmrs = { workspace = true }
@@ -124,7 +124,6 @@ pub struct GatewayNetworkRequesterDetails {
    pub encryption_key: String,

    pub open_proxy: bool,
-    pub enabled_statistics: bool,

    // just a convenience wrapper around all the keys
    pub address: String,
@@ -142,8 +141,7 @@ impl fmt::Display for GatewayNetworkRequesterDetails {
        writeln!(f, "\tencryption key: {}", self.encryption_key)?;
        writeln!(f, "\taddress: {}", self.address)?;

-        writeln!(f, "\tuses open proxy: {}", self.open_proxy)?;
-        writeln!(f, "\tsends statistics: {}", self.enabled_statistics)
+        writeln!(f, "\tuses open proxy: {}", self.open_proxy)
    }
 }

@@ -122,7 +122,7 @@ pub async fn setup_gateway_from_api(
    nym_apis: &[Url],
 ) -> Result<InitialisationResult, WasmCoreError> {
    let mut rng = thread_rng();
-    let gateways = current_gateways(&mut rng, nym_apis).await?;
+    let gateways = current_gateways(&mut rng, nym_apis, None).await?;
    setup_gateway_wasm(client_store, force_tls, chosen_gateway, &gateways).await
 }

@@ -25,13 +25,13 @@ nym-network-defaults = { path = "../network-defaults" }

 ## verify:
 hmac = { workspace = true, optional = true }
-sha2 = { version = "0.10.8", optional = true }
+sha2 = { workspace = true, optional = true }

 ## openapi:
 utoipa = { workspace = true, optional = true }
 serde_json = { workspace = true, optional = true }

-x25519-dalek = { version = "2.0.0", features = ["static_secrets"] }
+x25519-dalek = { workspace = true, features = ["static_secrets"] }

 [dev-dependencies]
 rand = "0.8.5"
@@ -10,8 +10,7 @@ pub use config::Config;
 pub use error::Error;
 pub use public_key::PeerPublicKey;
 pub use registration::{
-    ClientMac, ClientMessage, ClientRegistrationResponse, GatewayClient, GatewayClientRegistry,
-    InitMessage, Nonce,
+    ClientMac, ClientMessage, GatewayClient, GatewayClientRegistry, InitMessage, Nonce,
 };

 #[cfg(feature = "verify")]
@@ -7,6 +7,7 @@ use base64::{engine::general_purpose, Engine};
 use dashmap::DashMap;
 use serde::{Deserialize, Serialize};
 use std::net::IpAddr;
+use std::time::SystemTime;
 use std::{fmt, ops::Deref, str::FromStr};

 #[cfg(feature = "verify")]
@@ -18,13 +19,13 @@ use sha2::Sha256;

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

 #[cfg(feature = "verify")]
 pub type HmacSha256 = Hmac<Sha256>;

 pub type Nonce = u64;
-pub type Free = bool;
+pub type Taken = Option<SystemTime>;

 #[derive(Serialize, Deserialize, Debug, Clone)]
 #[serde(tag = "type", rename_all = "camelCase")]
@@ -53,15 +54,6 @@ impl InitMessage {
 }

 #[derive(Serialize, Deserialize, Debug, Clone)]
-#[serde(tag = "type", rename_all = "camelCase")]
-#[cfg_attr(feature = "openapi", derive(utoipa::ToSchema))]
-pub enum ClientRegistrationResponse {
-    PendingRegistration(RegistrationData),
-    Registered,
-}
-
-#[derive(Serialize, Deserialize, Debug, Clone)]
-#[cfg_attr(feature = "openapi", derive(utoipa::ToSchema))]
 pub struct RegistrationData {
    pub nonce: u64,
    pub gateway_data: GatewayClient,
@@ -11,13 +11,13 @@ license.workspace = true
 # See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html

 [dependencies]
-base64 = "0.21.3"
+base64 = { workspace = true }
 dashmap = { workspace = true }
 defguard_wireguard_rs = { workspace = true }
 # The latest version on crates.io at the time of writing this (6.0.0) has a
 # version mismatch with x25519-dalek/curve25519-dalek that is resolved in the
 # latest commit. So pick that for now.
-x25519-dalek = "2.0.0"
+x25519-dalek = { workspace = true }
 ip_network = { workspace = true }
 log.workspace = true
 nym-crypto = { path = "../crypto", features = ["asymmetric"] }
@@ -3,7 +3,7 @@ title = "Nym Docs"
 authors = ["Max Hampshire, Serinko, Alexia Lorenza Martinel"]
 description = "Nym technical documentation"
 language = "en"
-multilingual = false # for the moment - ideally work on chinese, brazillian ,portugese spanish next
+multilingual = false                                          # for the moment - ideally work on chinese, brazillian ,portugese spanish next
 src = "src"

 [rust]
@@ -14,17 +14,19 @@ edition = "2018"
 #################

 [preprocessor.theme]
-sidebar-width             = "280px"
-content-max-width         = "70%"
-content-main-margin-left  = "5%"
-content-main-margin-right = "5%"
-root-font-size            = "70%"
-# DO NOT CHANGE or you might overwrite the custom hbs file
-turn-off = false
+pagetoc = true
+sidebar-width = "280px"
+content-max-width = "80%"
+root-font-size = "70%"
+# if you need to change anything in the index.hbs file you need to turn this to `false`, rebuild the book, 
+# probably remove the additional `comment` that gets appended to the header, and then change this back to `true`. 
+# this is because of a bug in the `mdbook-theme` plugin
+turn-off = true
+

 [preprocessor.admonish]
 command = "mdbook-admonish"
-assets_version = "3.0.2" # do not edit: managed by `mdbook-admonish install`
+assets_version = "3.0.2"    # do not edit: managed by `mdbook-admonish install`

 # https://gitlab.com/tglman/mdbook-variables/
 [preprocessor.variables.variables]
@@ -53,52 +55,56 @@ renderer = ["html"]
 #########

 [build]
-build-dir = "book"                # the directory where the output is placed
-create-missing = true             # whether or not to create missing pages
-use-default-preprocessors = true  # use the default preprocessors
-extra-watch-dirs = []             # directories to watch for triggering builds
+build-dir = "book"               # the directory where the output is placed
+create-missing = true            # whether or not to create missing pages
+use-default-preprocessors = true # use the default preprocessors
+extra-watch-dirs = []            # directories to watch for triggering builds

 ##########
 # OUTPUT #
 ##########

 [output.html]
-theme         = "nym_themes"
+theme = "themes"
 default-theme = "coal"
 preferred-dark-theme = "coal"
 curly-quotes = true
 copy-fonts = true
 no-section-label = false
-additional-css = ["./nym_themes/custom.css", "./nym_themes/mdbook-admonish.css", "./nym_themes/pagetoc.css"]
-additional-js  = ["./nym_themes/pagetoc.js"]
+additional-css = [
+  "./themes/custom.css",
+  "./themes/mdbook-admonish.css",
+  "./themes/pagetoc.css",
+]
+additional-js = ["./themes/pagetoc.js"]
 git-repository-url = "https://github.com/nymtech/nym"
 git-repository-icon = "fa-github"
 input-404 = "not-found.md"

 [output.html.fold]
-enable = true    # whether or not to enable section folding
-level = 0        # the depth to start folding
+enable = true # whether or not to enable section folding
+level = 0     # the depth to start folding

 # controlling rust sample code blocks
 [output.html.playground]
-editable = false         # allows editing the source code
-copyable = true          # include the copy button for copying code snippets
-copy-js = true           # includes the JavaScript for the code editor
-line-numbers = true      # displays line numbers for editable code
-runnable = true          # displays a run button for rust code
+editable = false    # allows editing the source code
+copyable = true     # include the copy button for copying code snippets
+copy-js = true      # includes the JavaScript for the code editor
+line-numbers = true # displays line numbers for editable code
+runnable = true     # displays a run button for rust code

 # options for the built in text search
 [output.html.search]
-enable = true            # enables the search feature
-limit-results = 30       # maximum number of search results
-teaser-word-count = 30   # number of words used for a search result teaser
-use-boolean-and = true   # multiple search terms must all match
-boost-title = 2          # ranking boost factor for matches in headers
-boost-hierarchy = 1      # ranking boost factor for matches in page names
-boost-paragraph = 1      # ranking boost factor for matches in text
-expand = true            # partial words will match longer terms
-heading-split-level = 3  # link results to heading levels
-copy-js = true           # include Javascript code for search
+enable = true           # enables the search feature
+limit-results = 30      # maximum number of search results
+teaser-word-count = 30  # number of words used for a search result teaser
+use-boolean-and = true  # multiple search terms must all match
+boost-title = 2         # ranking boost factor for matches in headers
+boost-hierarchy = 1     # ranking boost factor for matches in page names
+boost-paragraph = 1     # ranking boost factor for matches in text
+expand = true           # partial words will match longer terms
+heading-split-level = 3 # link results to heading levels
+copy-js = true          # include Javascript code for search

 [output.linkcheck]
 warning-policy = "warn"
@@ -46,4 +46,4 @@ If you have successfully completed KYC on Synaps earlier and provided your Nym w

 Using the Nym network is free for now, but user fees will be introduced in the future and those will be paid in NYM tokens, so set them aside! And until then, you can contribute to running our decentralized infrastructure and earn mix mining rewards by setting up Nym mix nodes and bonding your tokens to them. You don't need to run nodes to contribute to the security and performance of the Nym network though. You can pledge your trust in someone else's node by delegating your NYM tokens to it, and receive a share of their mix mining rewards.

-You can find out more about how staking works in [this](https://www.youtube.com/watch?v=PcNGcTwlm0I) video from our Chief Scientist Claudia Diaz and if you need help setting up your mix node, choosing one to delegate your tokens to, or anything else, our community is there to help on [Discord](https://discord.gg/nym) and [Telegram](https://t.me/nymchan). 
+You can find out more about how staking works in [this](https://www.youtube.com/watch?v=PcNGcTwlm0I) video from our Chief Scientist Claudia Diaz and if you need help setting up your mix node, choosing one to delegate your tokens to, or anything else, our community is there to help on [Discord](https://discord.gg/FaTJb8q8) and [Telegram](https://t.me/nymchan). 
@@ -39,5 +39,5 @@ Follow this [video](https://youtu.be/quj8H2qeOwY?t=97) to see the steps on Teleg

 **Now your Telegram runs over NymConnect.**

-NymConnect is currently available for several applications and service providers. Support for more apps is on the way. For any bug reports or feedback please reach out to us on Telegram or our [Discord](http://discord.gg/nym) server.
+NymConnect is currently available for several applications and service providers. Support for more apps is on the way. For any bug reports or feedback please reach out to us on Telegram or our [Discord](http://discord.gg/FaTJb8q8) server.

@@ -6,7 +6,7 @@
    --sidebar-resize-indicator-width: 8px;
    --sidebar-resize-indicator-space: 2px;
    --page-padding: 15px;
-    --content-max-width: 70%;
+    --content-max-width: 80%;
    --menu-bar-height: 40px;
    --mono-font: "Source Code Pro", Consolas, "Ubuntu Mono", Menlo, "DejaVu Sans Mono", monospace, monospace;
    --code-font-size: 0.875em /* please adjust the ace font size accordingly in editor.js */
@@ -8,10 +8,12 @@
  --sidebar-active: #fb6e4e;
  --icons-hover: #fb6e4e;
  --links: #fb6e4e;
+
  ::selection {
    color: #121726;
    background-color: #c5573d;
  }
+
  select option {
    background-color: #121726;
  }
@@ -21,17 +23,18 @@
  --sidebar-active: #fb6e4e;
  --icons-hover: #fb6e4e;
  --links: #fb6e4e;
+
  ::selection {
-    color:#f2f2f2;
+    color: #f2f2f2;
    background-color: #c5573d;
  }
 }

 /*properly centering the title given the additional header items*/
 .menu-title {
-  position: absolute;
-  left: 50%;
+  left: 45%;
 }
+
 .menu-bar .a:hover,

 /*necessary because of ^*/
@@ -159,20 +159,14 @@
                        </ul>

                        <!-- CUSTOM -->
-                        <select id="dropdown-menu3" class="icon-button">
-                            <option value="">Network Protocol</option>
+                        <select id="dropdown-menu" class="icon-button">
                            <option value="https://nymtech.net/docs">Network Docs</option>
                            <option value="https://nymtech.net/learn/papers">Academic Papers</option>
-                        </select>
-
-                        <select id="dropdown-menu" class="icon-button">
-                            <option value="">Developer Docs</option>
+                            <option value="">--------</option>
                            <option value="https://nymtech.net/developers">Dev Portal</option>
                            <option value="https://nymtech.net/docs/sdk/rust/rust.html">Rust SDK</option>
                            <option value="https://sdk.nymtech.net">Typescript SDK</option>
-                        </select>
-
-                        <select id="dropdown-menu2" class="icon-button">
+                            <option value="">--------</option>
                            <option value="">Setup Guides</option>
                            <option value="https://nymtech.net/operators">Operators</option>
                            <option value="https://nymtech.net/developers/nymvpn/intro.html">NymVPN Testing</option>
@@ -186,24 +180,7 @@
                                }
                            });
                        </script>
-
-                        <script>
-                            document.getElementById('dropdown-menu2').addEventListener('change', function() {
-                                const selected = this.options[this.selectedIndex];
-                                if (selected.value !== '') {
-                                    window.location.href = selected.value;
-                                }
-                            });
-                        </script>
-
-                        <script>
-                            document.getElementById('dropdown-menu3').addEventListener('change', function() {
-                                const selected = this.options[this.selectedIndex];
-                                if (selected.value !== '') {
-                                    window.location.href = selected.value;
-                                }
-                            });
-                        </script>
+                        
                        <!-- END CUSTOM -->
                    </div>

@@ -263,7 +240,8 @@
                                <nav class="pagetoc"></nav>
                            </div>
                            <div class="content-wrap">
-                                {{{ content }}}
+
+                        {{{ content }}}
                            </div>
                        </main>
                    </main>
@@ -1,6 +1,5 @@
 # mdbook files
 book/
-theme/

 # Compiled assets
 .sass-cache
@@ -11,7 +11,7 @@ Since these docs autogenerate command output and import docs from binaries in `t
 Changes merged to `master` will be autodeployed to the production site.

 ### Contributing a new translation
-To contribute tranlsations in a new language, please get in touch via [Matrix](https://matrix.to/#/#general:nymtech.chat) or [Discord](discord.gg/nym).
+To contribute tranlsations in a new language, please get in touch via [Matrix](https://matrix.to/#/#general:nymtech.chat) or [Discord](https://discord.gg/FaTJb8q8).

 ### Variables
 There are some variables that are shared across the entire docs site, such as the current latest software version.
@@ -3,7 +3,7 @@ title = "Nym Docs"
 authors = ["Max Hampshire, Serinko, Alexia Lorenza Martinel"]
 description = "Nym technical documentation"
 language = "en"
-multilingual = false # for the moment - ideally work on chinese, brazillian portugese, spanish next
+multilingual = false                                          # for the moment - ideally work on chinese, brazillian portugese, spanish next
 src = "src"

 [rust]
@@ -14,18 +14,18 @@ edition = "2018"
 #################

 [preprocessor.theme]
-pagetoc                   = true
-sidebar-width             = "280px"
-content-max-width         = "70%"
-content-main-margin-left  = "5%"
-content-main-margin-right = "5%"
-root-font-size            = "70%"
-# DO NOT CHANGE or you might overwrite the custom hbs file
+pagetoc = true
+sidebar-width = "280px"
+content-max-width = "80%"
+root-font-size = "70%"
+# if you need to change anything in the index.hbs file you need to turn this to `false`, rebuild the book, 
+# probably remove the additional `comment` that gets appended to the header, and then change this back to `true`. 
+# this is because of a bug in the `mdbook-theme` plugin
 turn-off = true

 [preprocessor.admonish]
 command = "mdbook-admonish"
-assets_version = "3.0.2" # do not edit: managed by `mdbook-admonish install`
+assets_version = "3.0.2"    # do not edit: managed by `mdbook-admonish install`

 # https://gitlab.com/tglman/mdbook-variables/
 [preprocessor.variables.variables]
@@ -50,52 +50,56 @@ renderer = ["html"]
 #########

 [build]
-build-dir = "book"                # the directory where the output is placed
-create-missing = true             # whether or not to create missing pages
-use-default-preprocessors = true  # use the default preprocessors
-extra-watch-dirs = []             # directories to watch for triggering builds
+build-dir = "book"               # the directory where the output is placed
+create-missing = true            # whether or not to create missing pages
+use-default-preprocessors = true # use the default preprocessors
+extra-watch-dirs = []            # directories to watch for triggering builds

 ##########
 # OUTPUT #
 ##########

 [output.html]
-theme         = "nym_themes"
+theme = "themes"
 default-theme = "coal"
 preferred-dark-theme = "coal"
 curly-quotes = true
 copy-fonts = true
 no-section-label = false
-additional-css = ["./nym_themes/custom.css", "./nym_themes/mdbook-admonish.css", "./nym_themes/pagetoc.css"]
-additional-js  = ["./nym_themes/pagetoc.js"]
-git-repository-url = "https://github.com/nymtech/nym"
+additional-css = [
+  "./themes/custom.css",
+  "./themes/mdbook-admonish.css",
+  "./themes/pagetoc.css",
+]
+additional-js = ["./themes/pagetoc.js"]
+git-repository-url = "https://github.com/nymtech/nym/documentation/"
 git-repository-icon = "fa-github"
 input-404 = "not-found.md"

 [output.html.fold]
-enable = true    # whether or not to enable section folding
-level = 0        # the depth to start folding
+enable = true # whether or not to enable section folding
+level = 0     # the depth to start folding

 # controlling rust sample code blocks
 [output.html.playground]
-editable = false         # allows editing the source code
-copyable = true          # include the copy button for copying code snippets
-copy-js = true           # includes the JavaScript for the code editor
-line-numbers = true      # displays line numbers for editable code
-runnable = true          # displays a run button for rust code
+editable = false    # allows editing the source code
+copyable = true     # include the copy button for copying code snippets
+copy-js = true      # includes the JavaScript for the code editor
+line-numbers = true # displays line numbers for editable code
+runnable = true     # displays a run button for rust code

 # options for the built in text search
 [output.html.search]
-enable = true            # enables the search feature
-limit-results = 30       # maximum number of search results
-teaser-word-count = 30   # number of words used for a search result teaser
-use-boolean-and = true   # multiple search terms must all match
-boost-title = 2          # ranking boost factor for matches in headers
-boost-hierarchy = 1      # ranking boost factor for matches in page names
-boost-paragraph = 1      # ranking boost factor for matches in text
-expand = true            # partial words will match longer terms
-heading-split-level = 3  # link results to heading levels
-copy-js = true           # include Javascript code for search
+enable = true           # enables the search feature
+limit-results = 30      # maximum number of search results
+teaser-word-count = 30  # number of words used for a search result teaser
+use-boolean-and = true  # multiple search terms must all match
+boost-title = 2         # ranking boost factor for matches in headers
+boost-hierarchy = 1     # ranking boost factor for matches in page names
+boost-paragraph = 1     # ranking boost factor for matches in text
+expand = true           # partial words will match longer terms
+heading-split-level = 3 # link results to heading levels
+copy-js = true          # include Javascript code for search

 [output.linkcheck]
 warning-policy = "warn"
@@ -36,7 +36,7 @@ Create an account on Sandbox using the nym-cli:

 ```./nym-cli --config-env-file <path-to>sandbox.env account create```

-You will need `nymt` funds sent to this account. Get in touch via Nym [Telegram](https://t.me/nymchan) or [Discord](https://discord.com/invite/nym) and we can send them to you. 
+You will need `nymt` funds sent to this account. Get in touch via Nym [Telegram](https://t.me/nymchan) or [Discord](https://discord.gg/FaTJb8q8) and we can send them to you. 

 Next, you init the nym-client with the enabled credentials mode set to true:  

@@ -6,7 +6,7 @@
    --sidebar-resize-indicator-width: 8px;
    --sidebar-resize-indicator-space: 2px;
    --page-padding: 15px;
-    --content-max-width: 70%;
+    --content-max-width: 80%;
    --menu-bar-height: 40px;
    --mono-font: "Source Code Pro", Consolas, "Ubuntu Mono", Menlo, "DejaVu Sans Mono", monospace, monospace;
    --code-font-size: 0.875em /* please adjust the ace font size accordingly in editor.js */
@@ -8,10 +8,12 @@
  --sidebar-active: #fb6e4e;
  --icons-hover: #fb6e4e;
  --links: #fb6e4e;
+
  ::selection {
    color: #121726;
    background-color: #c5573d;
  }
+
  select option {
    background-color: #121726;
  }
@@ -21,17 +23,18 @@
  --sidebar-active: #fb6e4e;
  --icons-hover: #fb6e4e;
  --links: #fb6e4e;
+
  ::selection {
-    color:#f2f2f2;
+    color: #f2f2f2;
    background-color: #c5573d;
  }
 }

 /*properly centering the title given the additional header items*/
 .menu-title {
-  position: absolute;
-  left: 50%;
+  left: 45%;
 }
+
 .menu-bar .a:hover,

 /*necessary because of ^*/
@@ -44,8 +47,6 @@ select {
  font-size: 16px;
 }

-
-
 footer {
  font-size: 0.8em;
  text-align: center;
@@ -159,20 +159,14 @@
                        </ul>

                        <!-- CUSTOM -->
-                        <select id="dropdown-menu3" class="icon-button">
-                            <option value="">Network Protocol</option>
+                        <select id="dropdown-menu" class="icon-button">
                            <option value="https://nymtech.net/docs">Network Docs</option>
                            <option value="https://nymtech.net/learn/papers">Academic Papers</option>
-                        </select>
-
-                        <select id="dropdown-menu" class="icon-button">
-                            <option value="">Developer Docs</option>
+                            <option value="">--------</option>
                            <option value="https://nymtech.net/developers">Dev Portal</option>
                            <option value="https://nymtech.net/docs/sdk/rust/rust.html">Rust SDK</option>
                            <option value="https://sdk.nymtech.net">Typescript SDK</option>
-                        </select>
-
-                        <select id="dropdown-menu2" class="icon-button">
+                            <option value="">--------</option>
                            <option value="">Setup Guides</option>
                            <option value="https://nymtech.net/operators">Operators</option>
                            <option value="https://nymtech.net/developers/nymvpn/intro.html">NymVPN Testing</option>
@@ -186,24 +180,7 @@
                                }
                            });
                        </script>
-
-                        <script>
-                            document.getElementById('dropdown-menu2').addEventListener('change', function() {
-                                const selected = this.options[this.selectedIndex];
-                                if (selected.value !== '') {
-                                    window.location.href = selected.value;
-                                }
-                            });
-                        </script>
-
-                        <script>
-                            document.getElementById('dropdown-menu3').addEventListener('change', function() {
-                                const selected = this.options[this.selectedIndex];
-                                if (selected.value !== '') {
-                                    window.location.href = selected.value;
-                                }
-                            });
-                        </script>
+                        
                        <!-- END CUSTOM -->
                    </div>

@@ -263,7 +240,8 @@
                                <nav class="pagetoc"></nav>
                            </div>
                            <div class="content-wrap">
-                                {{{ content }}}
+
+                        {{{ content }}}
                            </div>
                        </main>
                    </main>
@@ -15,27 +15,26 @@ declare -a plugins=("admonish" "linkcheck" "last-changed" "theme" "variables" "c
 install_mdbook_deps() {
 	printf "\ninstalling mdbook..."
 	# installing mdbook with only specific features for speed
-#  cargo install mdbook --no-default-features --features search --vers "^$MINOR_VERSION"
-	cargo install mdbook --vers "^$MINOR_VERSION"
+	# cargo install mdbook --no-default-features --features search --vers "^$MINOR_VERSION"
+	cargo install mdbook --no-default-features --vers "^$MINOR_VERSION"

 	printf "\ninstalling plugins..."
-	for i in "${plugins[@]}"
-	do
+	for i in "${plugins[@]}"; do
 		cargo install mdbook-$i
 	done

-# mdbook-admonish config
-#	if [ $(pwd | awk -F/ '{print $NF}') != "documentation" ]; then
-#		printf "not in documentation/ - changing dir but something isn't right in the workflow file"
-#  		cd documentation/
-#		mdbook-admonish install dev-portal
-#        	mdbook-admonish install docs
-#        	mdbook-admonish install operators
-#	else
-#        mdbook-admonish install dev-portal
-#        mdbook-admonish install docs
-#        mdbook-admonish install operators
-#	fi
+	# mdbook-admonish config
+	#	if [ $(pwd | awk -F/ '{print $NF}') != "documentation" ]; then
+	#		printf "not in documentation/ - changing dir but something isn't right in the workflow file"
+	#  		cd documentation/
+	#		mdbook-admonish install dev-portal
+	#        	mdbook-admonish install docs
+	#        	mdbook-admonish install operators
+	#	else
+	#        mdbook-admonish install dev-portal
+	#        mdbook-admonish install docs
+	#        mdbook-admonish install operators
+	#	fi
 }

 # uninstall mdbook + plugins
@@ -53,28 +52,27 @@ uninstall_mdbook_deps() {

 	# plugins
 	printf "\nuninstalling existing plugins...\n"
-	for i in "${plugins[@]}"
-	do
+	for i in "${plugins[@]}"; do
 		cargo uninstall mdbook-$i
 		# check it worked
 		if [ $? -ne 0 ]; then
 			printf "\nsomething went wrong, exiting"
 			exit 1
 		else
-		printf "\nmdbook-$i deleted\n"
-	fi
+			printf "\nmdbook-$i deleted\n"
+		fi
 	done
 }

 main() {
 	if test -f ~/.cargo/bin/mdbook; then
 		printf "mdbook already installed (located at: $(which mdbook))"
-		uninstall_mdbook_deps;
-		install_mdbook_deps;
+		uninstall_mdbook_deps
+		install_mdbook_deps
 	else
 		printf "mdbook not installed"
-		install_mdbook_deps;
+		install_mdbook_deps
 	fi
 }

-main;
+main
@@ -3,7 +3,7 @@ title = "Nym Operators Guide"
 authors = ["Max Hampshire, Serinko, Alexia Lorenza Martinel"]
 description = "Everything needed to run Nym Mixnet components"
 language = "en"
-multilingual = false # for the moment - ideally work on chinese, brazillian portugese, spanish next
+multilingual = false                                           # for the moment - ideally work on chinese, brazillian portugese, spanish next
 src = "src"

 [rust]
@@ -14,17 +14,18 @@ edition = "2018"
 #################

 [preprocessor.theme]
-sidebar-width             = "280px"
-content-max-width         = "70%"
-content-main-margin-left  = "5%"
-content-main-margin-right = "5%"
-root-font-size            = "70%"
-# DO NOT CHANGE or you might overwrite the custom hbs file
+pagetoc = true
+sidebar-width = "280px"
+content-max-width = "80%"
+root-font-size = "70%"
+# if you need to change anything in the index.hbs file you need to turn this to `false`, rebuild the book, 
+# probably remove the additional `comment` that gets appended to the header, and then change this back to `true`. 
+# this is because of a bug in the `mdbook-theme` plugin
 turn-off = true

 [preprocessor.admonish]
 command = "mdbook-admonish"
-assets_version = "3.0.2" # do not edit: managed by `mdbook-admonish install`
+assets_version = "3.0.2"    # do not edit: managed by `mdbook-admonish install`

 # https://gitlab.com/tglman/mdbook-variables/
 [preprocessor.variables.variables]
@@ -35,6 +36,7 @@ performance_validator = "http://validator.performance.nymte.ch/"
 performance_testing_release = "v2024.2-fast-and-furious-v2"
 # dependencies
 prometheus_latest_version = "v2.50.1"
+toc_page = "https://nymtech.net/terms-and-conditions/operators/v1.0.0"

 [preprocessor.last-changed]
 command = "mdbook-last-changed"
@@ -54,53 +56,57 @@ renderer = ["html"]
 #########

 [build]
-build-dir = "book"                # the directory where the output is placed
-create-missing = true             # whether or not to create missing pages
-use-default-preprocessors = true  # use the default preprocessors
-extra-watch-dirs = []             # directories to watch for triggering builds
+build-dir = "book"               # the directory where the output is placed
+create-missing = true            # whether or not to create missing pages
+use-default-preprocessors = true # use the default preprocessors
+extra-watch-dirs = []            # directories to watch for triggering builds

 ##########
 # OUTPUT #
 ##########

 [output.html]
-theme         = "nym_themes"
+theme = "themes"
 default-theme = "coal"
 preferred-dark-theme = "coal"
 #curly-quotes = true
 smart-punctuation = true
 copy-fonts = true
 no-section-label = false
-additional-css = ["./nym_themes/custom.css", "./nym_themes/mdbook-admonish.css", "./nym_themes/pagetoc.css"]
-additional-js  = ["./nym_themes/pagetoc.js"]
+additional-css = [
+  "./themes/custom.css",
+  "./themes/mdbook-admonish.css",
+  "./themes/pagetoc.css",
+]
+additional-js = ["./themes/pagetoc.js"]
 git-repository-url = "https://github.com/nymtech/nym"
 git-repository-icon = "fa-github"
 input-404 = "not-found.md"

 [output.html.fold]
-enable = true    # whether or not to enable section folding
-level = 0        # the depth to start folding
+enable = true # whether or not to enable section folding
+level = 0     # the depth to start folding

 # controlling rust sample code blocks
 [output.html.playground]
-editable = false         # allows editing the source code
-copyable = true          # include the copy button for copying code snippets
-copy-js = true           # includes the JavaScript for the code editor
-line-numbers = true      # displays line numbers for editable code
-runnable = true          # displays a run button for rust code
+editable = false    # allows editing the source code
+copyable = true     # include the copy button for copying code snippets
+copy-js = true      # includes the JavaScript for the code editor
+line-numbers = true # displays line numbers for editable code
+runnable = true     # displays a run button for rust code

 # options for the built in text search
 [output.html.search]
-enable = true            # enables the search feature
-limit-results = 30       # maximum number of search results
-teaser-word-count = 30   # number of words used for a search result teaser
-use-boolean-and = true   # multiple search terms must all match
-boost-title = 2          # ranking boost factor for matches in headers
-boost-hierarchy = 1      # ranking boost factor for matches in page names
-boost-paragraph = 1      # ranking boost factor for matches in text
-expand = true            # partial words will match longer terms
-heading-split-level = 3  # link results to heading levels
-copy-js = true           # include Javascript code for search
+enable = true           # enables the search feature
+limit-results = 30      # maximum number of search results
+teaser-word-count = 30  # number of words used for a search result teaser
+use-boolean-and = true  # multiple search terms must all match
+boost-title = 2         # ranking boost factor for matches in headers
+boost-hierarchy = 1     # ranking boost factor for matches in page names
+boost-paragraph = 1     # ranking boost factor for matches in text
+expand = true           # partial words will match longer terms
+heading-split-level = 3 # link results to heading levels
+copy-js = true          # include Javascript code for search

 [output.linkcheck]
 warning-policy = "warn"
@@ -84,5 +84,6 @@
 ---
 # Misc.
 - [Code of Conduct](coc.md)
+- [Terms & Conditions](toc.md)
 - [Licensing](licensing.md)
 ---
@@ -2,6 +2,211 @@

 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.6-chomp`
+
+- [Release binaries](https://github.com/nymtech/nym/releases/tag/nym-binaries-v2024.6-chomp)
+- [Release CHANGELOG.md](https://github.com/nymtech/nym/blob/nym-binaries-v2024.6-chomp/CHANGELOG.md)
+- [`nym-node`](nodes/nym-node.md) version `1.1.3`
+- Standalone `nym-gateway` and `nym-mixnode` binaries are no longer released
+
+~~~admonish example collapsible=true title='CHANGELOG.md'
+- Remove additional code as part of Ephemera Purge and SP and contracts ([#4650])
+- bugfix: make sure nym-api can handle non-cw2 (or without detailed build info) compliant contracts ([#4648])
+- introduced a flag to accept toc and exposed it via self-described API ([#4647])
+- bugfix: make sure to return an error on invalid public ip ([#4646])
+- Add ci check for PR having an assigned milestone ([#4644])
+- Removed ephemera code ([#4642])
+- Remove stale peers ([#4640])
+- Add generic wg private network routing ([#4636])
+- Feature/new node endpoints ([#4635])
+- standarised ContractBuildInformation and added it to all contracts ([#4631])
+- validate nym-node public ips on startup ([#4630])
+- Bump defguard wg ([#4625])
+- Fix cargo warnings ([#4624])
+- Update kernel peers on peer modification ([#4622])
+- Handle v6 and v7 requests in the IPR, but reply with v6 ([#4620])
+- fix typo ([#4619])
+- Update crypto and rand crates ([#4607])
+- Purge name service and service provider directory contracts ([#4603])
+
+[#4650]: https://github.com/nymtech/nym/pull/4650
+[#4648]: https://github.com/nymtech/nym/pull/4648
+[#4647]: https://github.com/nymtech/nym/pull/4647
+[#4646]: https://github.com/nymtech/nym/pull/4646
+[#4644]: https://github.com/nymtech/nym/pull/4644
+[#4642]: https://github.com/nymtech/nym/pull/4642
+[#4640]: https://github.com/nymtech/nym/pull/4640
+[#4636]: https://github.com/nymtech/nym/pull/4636
+[#4635]: https://github.com/nymtech/nym/pull/4635
+[#4631]: https://github.com/nymtech/nym/pull/4631
+[#4630]: https://github.com/nymtech/nym/pull/4630
+[#4625]: https://github.com/nymtech/nym/pull/4625
+[#4624]: https://github.com/nymtech/nym/pull/4624
+[#4622]: https://github.com/nymtech/nym/pull/4622
+[#4620]: https://github.com/nymtech/nym/pull/4620
+[#4619]: https://github.com/nymtech/nym/pull/4619
+[#4607]: https://github.com/nymtech/nym/pull/4607
+[#4603]: https://github.com/nymtech/nym/pull/4603
+~~~
+
+### Features
+
+- [Make embedded NR/IPR ignore performance of the Gateway](https://github.com/nymtech/nym/pull/4671): fixes bug in relation to scoring issue on nym-nodes operating as exit gateways failing to come online.
+- [Introduce a flag to accept Operators Terms and Conditions and exposed it via self-described API](https://github.com/nymtech/nym/pull/4647)
+~~~admonish example collapsible=true title='Testing steps performed'
+- Verify that the `execute` function correctly checks if the `accept_operator_terms` flag is set.
+- Test that a warning is displayed when the `accept_operator_terms` flag is not set.
+- Confirm that the `NymNode` instance is initialized with `with_accepted_toc(accepted_toc)` when the flag is set.
+- Apply the `--accept-toc` flag in the service and confirmed the change by running:
+```
+curl -s -X 'GET' 'http://18.171.251.41:8080/api/v1/auxiliary-details?output=json' -H 'accept: application/json' | jq .accepted_toc
+```
+- Verify that the output is `true`.
+~~~
+
+- [Rename 'accept-toc' flag and fields into explicit 'accept-operator-terms-and-conditions'](https://github.com/nymtech/nym/pull/4654): makes the `accept-toc` flag more explicit.
+- [Validate nym-node public ips on startup](https://github.com/nymtech/nym/pull/4630): makes sure `nym-node` is not run with an empty `public_ips` and that they do not correspond to common misconfigurations like `127.0.0.1` or `0.0.0.0` unless run with `--local` flag.
+~~~admonish example collapsible=true title='Testing steps performed'
+- Use the latest release/chomp binary with nym-node and input a dodgy ip
+<img width="361" alt="image" src="https://github.com/nymtech/nym/assets/60836166/6f2210f9-90ec-48fb-932f-f325c701de09">
+
+- Validation:
+<img width="1104" alt="image" src="https://github.com/nymtech/nym/assets/60836166/3bac221f-82f2-44cd-b8c0-6c599b0eb325">
+When restarting the node it complains within the service launch file
+~~~
+
+- [New node endpoints](https://github.com/nymtech/nym/pull/4635): introduces new endpoints on nym-api (and creates scaffolding for additional ones) for providing **unfiltered** network topology alongside performance score of all nodes.
+    - `NymApiTopologyProvider` got modified to use those endpoints alongside (configurable) filtering of nodes with score < 50% (like our current blacklist)
+    - Old clients should work as before as no existing endpoint got removed
+~~~admonish example collapsible=true title='Testing steps performed'
+- Validate that the `skimmed` endpoints are working, keeping in mind that they are unstable. The *full-fat* and *semi-skimmed* have not yet been implemented.
+~~~
+
+- [Remove stale peers](https://github.com/nymtech/nym/pull/4640)
+- [Removed ephemera code](https://github.com/nymtech/nym/pull/4642)
+~~~admonish example collapsible=true title='Testing steps performed'
+- Check references to everything named SP and Ephemera and removed any additional references
+~~~
+
+- [Remove additional code as part of Ephemera Purge and SP and contracts](https://github.com/nymtech/nym/pull/4650): in line with [#4642](https://github.com/nymtech/nym/pull/4642) and [#4603](https://github.com/nymtech/nym/pull/4603)
+~~~admonish example collapsible=true title='Testing steps performed'
+- Check references to everything named SP and Ephemera and removed any additional references
+~~~
+
+- [Add ci check for PR having an assigned milestone](https://github.com/nymtech/nym/pull/4644): add a CI check for checking that a PR is assigned to a milestone. Can bypassed the check by adding a `no-milestone` label to a PR
+~~~admonish example collapsible=true title='Testing steps performed'
+- CI complains if no milestone is associated with the an issue.
+~~~
+
+- [Bump defguard wireguard](https://github.com/nymtech/nym/pull/4625)
+- [Add generic wireguard private network routing](https://github.com/nymtech/nym/pull/4636): as defguard wireguard only allows for peer routing modifications, we will configure the entire wireguard private network to be routed to the wg device. Configuring per peer is also not desirable, as the interface doesn't allow removing routes, so unused ip routing won't be cleaned until gateway restart (and it would also pollute to routing table with a lot of rules when many peers are added).
+~~~admonish example collapsible=true title='Testing steps performed'
+- This is a part of a bigger ticket, but initial testing has proven to shown that launching nym-nodes (entry and exit gateways) in WG enable mode to be working
+
+*QA will use this template for the other related WG tickets in this release milestone.*
+~~~
+- [Standarise `ContractBuildInformation` and add it to all contracts](https://github.com/nymtech/nym/pull/4631): Similarly to `cw2`, we're now saving `ContractBuildInformation` under a constant storage key, i.e. `b"contract_build_info"` that standarises the retrieval by nym-api.
+    - Also each of our contracts now saves and updates that information upon init and migration.
+~~~admonish example collapsible=true title='Testing steps performed'
+- Use the latest release/chomp contracts and deploy these to QA
+- Use the `nym-api` to query for the results of these new contracts
+
+```sh
+ curl -X 'GET' \
+   'https://qa-nym-api.qa.nymte.ch/api/v1/network/nym-contracts-detailed' \
+   -H 'accept: application/json'
+```
+
+- It returns a detailed view of the contracts and which branch they were built from, alongside rust versions and so forth.
+<img width="1257" alt="image" src="https://github.com/nymtech/nym/assets/60836166/b5711431-c2f6-44ee-bf02-b17e6c48c5ee">
+~~~
+
+- [Update kernel peers on peer modification](https://github.com/nymtech/nym/pull/4622):
+~~~admonish example collapsible=true title='Testing steps performed'
+- This is a part of a bigger ticket, but initial testing has proven to shown that launching nym-nodes (entry and exit gateways) in WG enable mode to be working.
+*QA will use this template for the other related WG tickets in this release milestone.*
+~~~
+
+- [Handle v6 and v7 requests in the IPR, but reply with v6](https://github.com/nymtech/nym/pull/4620): teach the IPR to read both v6 and v7 requests, but always reply with v6. This is to prepare for bumping to v7 and signed connect/disconnect messages. Follow up PRs will add
+    - Verify signature
+    - Send v7 in client with signatures included
+- [Purge name service and service provider directory contracts](https://github.com/nymtech/nym/pull/4603): this is a compiler assisted purge of the `nym-name-service` and `nym-service-provider-directory` contracts that were never deployed on mainnet, and will anyhow be superseded by the new mixnode directory that is being worked on.
+~~~admonish example collapsible=true title='Testing steps performed'
+It works insofar that it compiles, we need to deploy and test this on non-mainnet before merging in
+
+- Purge `nym-name-service` contract
+- Purge `nym-name-service-common`
+- Purge `nym-service-provider-directory` contract
+- Purge `nym-service-provider-directory-common`
+- Remove everywhere name-service contract is used
+- Remove everywhere sp contract is used
+
+Performed:
+- Check references to everything named SP and Ephemera and removed any additional references
+~~~
+
+### Crypto
+
+- [Update crypto and rand crates](https://github.com/nymtech/nym/pull/4607): Update sphinx crate to `0.1.1` along with 25519 crates and `rand` crates
+~~~admonish example collapsible=true title="Comments"
+This PR contains a test failure due to the update [here](https://github.com/nymtech/nym/blob/b4a0487a41375167b2f481c00917b957b9f89789/common/crypto/src/asymmetric/encryption/mod.rs#L353-L358)
+
+- This is due a change in `x25519-dalek` from `1.1.1` to `2`.
+- Crypto operations should be identical, but the byte representation has changed (sphinx clamps at creation, x25519 clamps at use). This cannot be changed in the sphinx crate without breaking changes.
+- There is a good chance that this failure doesn't impact anything else, but it has to be tested to see.
+- A mix of old and new clients with a mix of old and new mixnodes should do
+~~~
+
+### Bugfix
+- [Make sure nym-api can handle non-cw2 (or without detailed build info) compliant contracts](https://github.com/nymtech/nym/pull/4648): fixes the issue (even if some contracts aren't uploaded on chain it doesn't prohibit the api from working - caveat, the essential vesting and mixnet contract are required)
+~~~admonish example collapsible=true title='Testing steps performed'
+- Use the latest release/chomp contracts and deploy these to QA
+- If the contract was not found, the API would complain of invalid contracts, thus not starting the rest of the operations of the API (network monitor / rewarding etc)
+
+ `Jun 11 16:27:34 qa-v2-nym-api bash[1352642]:  2024-06-11T16:27:34.551Z ERROR nym_api::nym_contract_cache::cache::refresher > Failed to refresh validator cache - Abci query failed with code 6 - address n14y2x8a60knc5jjfeztt84kw8x8l5pwdgnqg256v0p9v4p7t2q6eswxyusw: no such contract: unknown request`
+~~~
+
+- [Make sure to return an error on `nym-node` invalid public ip](https://github.com/nymtech/nym/pull/4646): bugfix for [#4630](https://github.com/nymtech/nym/pull/4630) that interestingly hasn't been detected by clippy.
+~~~admonish example collapsible=true title='Testing steps performed'
+- Use the latest release/chomp binary with nym-node and input a dodgy ip
+<img width="361" alt="image" src="https://github.com/nymtech/nym/assets/60836166/6f2210f9-90ec-48fb-932f-f325c701de09">
+
+- Validation:
+<img width="1104" alt="image" src="https://github.com/nymtech/nym/assets/60836166/3bac221f-82f2-44cd-b8c0-6c599b0eb325">
+~~~
+
+- [Extend the return error when connecting to gateway fails](https://github.com/nymtech/nym/pull/4626)
+~~~admonish example collapsible=true title='Testing steps performed'
+- Verify that the `establish_connection` function correctly attempts to establish a connection to the gateway.
+- Test error handling for `NetworkConnectionFailed` by simulating a failed connection.
+- Ensure that the `NetworkConnectionFailed` error includes the `address` and `source` details as expected.
+- Checked that `SocketState::Available` is set correctly when a connection is successfully established.
+~~~
+
+- [Fix Cargo warnings](https://github.com/nymtech/nym/pull/4624): On every cargo command we have the set warnings:
+~~~admonish example collapsible=true title="Cargo warnings"
+warning: /home/alice/src/nym/nym/common/dkg/Cargo.toml: `default-features` is ignored for bls12_381, since `default-features` was not specified for `workspace.dependencies.bls12_381`, this could become a hard error in the future warning: /home/alice/src/nym/nym/common/dkg/Cargo.toml: `default-features` is ignored for ff, since `default-features` was not specified for `workspace.dependencies.ff`, this could become a hard error in the future warning: /home/alice/src/nym/nym/common/dkg/Cargo.toml: `default-features` is ignored for group, since `default-features` was not specified for `workspace.dependencies.group`, this could become a hard error in the future warning: /home/alice/src/nym/nym/common/client-libs/validator-client/Cargo.toml: `default-features` is ignored for bip32, since `default-features` was not specified for `workspace.dependencies.bip32`, this could become a hard error in the future warning: /home/alice/src/nym/nym/common/client-libs/validator-client/Cargo.toml: `default-features` is ignored for prost, since `default-features` was not specified for `workspace.dependencies.prost`, this could become a hard error in the future warning: /home/alice/src/nym/nym/common/credentials-interface/Cargo.toml: `default-features` is ignored for bls12_381, since `default-features` was not specified for `workspace.dependencies.bls12_381`, this could become a hard error in the future warning: /home/alice/src/nym/nym/common/credentials/Cargo.toml: `default-features` is ignored for bls12_381, since `default-features` was not specified for `workspace.dependencies.bls12_381`, this could become a hard error in the future warning: /home/alice/src/nym/nym/common/nymcoconut/Cargo.toml: `default-features` is ignored for bls12_381, since `default-features` was not specified for `workspace.dependencies.bls12_381`, this could become a hard error in the future warning: /home/alice/src/nym/nym/common/nymcoconut/Cargo.toml: `default-features` is ignored for ff, since `default-features` was not specified for `workspace.dependencies.ff`, this could become a hard error in the future warning: /home/alice/src/nym/nym/common/nymcoconut/Cargo.toml: `default-features` is ignored for group, since `default-features` was not specified for `workspace.dependencies.group`, this could become a hard error in the future.
+~~~
+    - This PR adds `default-features = false` to the workspace dependencies to fix these. An alternative way would be to remove `default-features = false` in the crates, but we assume these were put there for a good reason. Also we might have other crates outside of the main workspace that depends on these crates having default features disabled.
+    - We also have the warning `warning: profile package spec nym-wasm-sdk in profile release did not match any packages`  which we fix by commenting out the profile settings, since the crate is currently commented out in the workspace crate list.
+~~~admonish example collapsible=true title='Testing steps performed'
+- All binaries have been built and deployed from this branch and no issues have surfaced.
+~~~
+
+### Operators Guide updates
+
+- [New Release Cycle](release-cycle.md) introduced: a transparent release flow, including:
+    - New environments
+    - Stable testnet
+    - [Testnet token faucet](https://nymtech.net/operators/sandbox.html#sandbox-token-faucet)
+    - Flow [chart](release-cycle.md#release-flow)
+- [Sandbox testnet](sandbox.md) guide: teaching Nym node operators how to run their nodes in Nym Sandbox testnet environment.
+- [Terms & Conditions flag](nodes/setup.md#terms--conditions)
+- [Node API Check CLI](testing/node-api-check.md)
+- [Pruning VPS `syslog` scripts](troubleshooting/vps-isp.md#pruning-logs)
+- [Black-xit: Exiting the blacklist](troubleshooting/nodes.md#my-gateway-is-blacklisted)
+
+---

 ## `v2024.5-ragusa`

@@ -11,7 +11,7 @@ This document presents an initiative to further support Nym’s mission of allow
 All the technical changes on the side of Nym nodes - ***Project Smoosh*** - are described in the [FAQ section](../archive/faq/smoosh-faq.md).

 ```admonish warning
-Nym core team cannot provide comprehensive legal advice across all jurisdictions. Knowledge and experience with the legalities are being built up with the help of our counsel and with you, the community of Nym node operators. We encourage Nym node operators to join the operator channels ([Element](https://matrix.to/#/#operators:nymtech.chat), [Discord](https://discord.com/invite/nym), [Telegram](https://t.me/nymchan_help_chat)) to share best practices and experiences.
+Nym core team cannot provide comprehensive legal advice across all jurisdictions. Knowledge and experience with the legalities are being built up with the help of our counsel and with you, the community of Nym node operators. We encourage Nym node operators to join the operator channels ([Element](https://matrix.to/#/#operators:nymtech.chat), [Discord](https://discord.gg/FaTJb8q8), [Telegram](https://t.me/nymchan_help_chat)) to share best practices and experiences.
 ```


@@ -24,30 +24,36 @@ To run a new node, you can simply execute the `nym-node` command without any fla

 The most crucial aspect of running the node is specifying the `--mode`, which can be one of three: `mixnode`, `entry-gateway`, and `exit-gateway`.

-Currently `nym-node` binary enables to run only one `--mode` at a time. In the future the operators will be able to specify multiple modes within one `nym-node`. Our goal is to have as many nodes each running all the available modes enabled and let the Nym API to position the node acoording the network needs in the beginning of each epoch.
+Currently the `nym-node` binary can only be run in a single `--mode` at any one time. In the future however, operators will be able to specify multiple modes that a single `nym-node` binary can run. Our goal is to have as many nodes as possible enabling multiple modes, and allow the Nym API to position the node according the network's needs in the beginning of each epoch.

 Every `exit-gateway` mode is basically an `entry-gateway` with NR (Network Requester) and IPR (IP Packet Router) enabled. This means that every `exit-gateway` is automatically seen as an `entry-gateway` but not the opposite.

 Gateway operators can check out the node performance, connectivity and much more in our new tool [harbourmaster.nymtech.net](https://harbourmaster.nymtech.net/).

 To determine which mode your node is running, you can check the `:8080/api/v1/roles` endpoint. For example:
-```
+```sh
+# sustitude <NODE_IP_ADDRESS> or <NODE_DOMAIN> with a real one
 # for http
-http://<IP_ADDRESS>:8080/api/v1/roles
+http://<NODE_IP_ADDRESS>:8080/api/v1/roles
+# or
+http://<NODE_IP_ADDRESS>/api/v1/roles

-# for https reversed proxy
-https://<DOMAIN>/api/v1/roles
+# for reversed proxy/WSS
+https://<NODE_DOMAIN>/api/v1/roles
 ```

 Everything necessary will exist on your node by default. For instance, if you're running a mixnode, you'll find that a NR (Network Requester) and IPR (IP Packet Router) address exist, but they will be ignored in `mixnode` mode.

 For more information about available endpoints and their status, you can refer to:
-```
+```sh
+# sustitude <NODE_IP_ADDRESS> or <NODE_DOMAIN> with a real one
 # for http
-http://<IP>:8080/api/v1/swagger/#/
+http://<NODE_IP_ADDRESS>:8080/api/v1/swagger/#/
+# or
+http://<NODE_IP_ADDRESS>/api/v1/swagger/#/

-# for https reversed proxy
-https://<DOMAIN>/api/v1/swagger/#/
+# for reversed proxy/WSS
+https://<NODE_DOMAIN>/api/v1/swagger/#/
 ```

 ## Usage
@@ -88,6 +94,7 @@ Some of the most useful flags and their explanation:

 ~~~admonish example collapsible=true title="Flags explanation:"
 - `--id <YOUR_ID>`: Local identifier of your node. This `<ID>` determines your config path located at `~/.nym/nym-nodes/<ID>/config/config.toml`, default value is `default-nym-node`
+- `--accept-operator-terms-and-conditions`:  Explicitly specify whether you agree with the terms and conditions of a nym node operator as defined at [nymtech.net/terms-and-conditions/operators/v1.0.0]({{toc_page}})
 - `--config-file <PATH>`: Used for the migrate command to indicate the location of the existing node config file. Default path is `~/.nym/nym-nodes/default-nym-node/config/config.toml`
 - `--deny-init`: Use this flag to prevent a new node from being initialized. It's recommended to use this after the first run to avoid accidental spinning up of a second node.
 - `--init-only`: Use this flag if you want to set up a node without starting it.
@@ -99,10 +106,46 @@ Some of the most useful flags and their explanation:
 - `--expose-crypto-hardware <true/false>`: Sets your crypto hardware info visibility on the network.
 ~~~

+### Terms & Conditions
+
+```admonish info
+From `nym-node` version `1.1.3` onward is required to accept [**Operators Terms & Conditions**]({{toc_page}}) in order to be part of the active set. Make sure to read them before you add the flag.
+```
+
+There has been a long ongoing discussion whether and how to apply Terms and Conditions for Nym network operators, with an aim to stay aligned with the philosophy of Free Software and provide legal defense for both node operators and Nym developers. To understand better the reasoning behind this decision, you can listen to the first [Nym Operator Town Hall](https://www.youtube.com/live/7hwb8bAZIuc?si=3mQ2ed7AyUA1SsCp&t=915) introducing the T&Cs or to [Operator AMA with CEO Harry Halpin](https://www.youtube.com/watch?v=yIN-zYQw0I0) from June 4th, 2024, explaining pros and cons of T&Cs implementation.
+
+Accepting T&Cs is done via an explicit flag `--accept-operator-terms-and-conditions` added to `nym-node run` command.
+
+To check whether any node has T&Cs accepted or not can be done by querying Swagger API endpoint `/auxiliary_details` via one of these ports (depending on node setup):
+```sh
+# sustitude <NODE_IP_ADDRESS> or <NODE_DOMAIN> with a real one
+http://<NODE_IP_ADDRESS>:8080/api/v1/auxiliary_details
+https://<NODE_DOMAIN>/api/v1/auxiliary_details
+http://<NODE_IP_ADDRESS>/api/v1/auxiliary_details
+```
+
+~~~admonish example collapsible=true title="Example of `/auxiliary_details` query"
+```sh
+# substitude <NODE_IP_ADDRESS> with a real one
+curl -X 'GET' \
+  'http://<NODE_IP_ADDRESS>:8080/api/v1/auxiliary-details' \
+  -H 'accept: application/json'
+
+{
+  "location": "Kurdistan",
+  "accepted_operator_terms_and_conditions": true
+}
+```
+~~~
+
 ### Commands & Examples

 **`nym-node` introduces a default human readible ID (local only) `default-nym-node`, which is used if there is not an explicit custom `--id <ID>` specified. All configuration is stored in `~/.nym/nym-nodes/default-nym-node/config/config.toml` or `~/.nym/nym-nodes/<ID>/config/config.toml` respectively.**

+```admonish info
+All commands with more options listed below include `--accept-operator-terms-and-conditions` flag, read [Terms & Conditions](#terms--conditions) chapter above before executing these commands.
+```
+
 ### Initialise & Run

 When we use `run` command the node will do `init` as well, unless we specify with a flag `--deny-init`. Below are some examples of initialising and running `nym-node` with different modes (`--mode`) like `mixnode`, `entry-gateway`, `exit-gateway`.
@@ -121,15 +164,13 @@ To prevent over-flooding of our documentation we cannot provide with every singl

 #### Mode: `exit-gateway`

-As part of the transition, `allowed.list` on Exit Gateway embedded Network Requester was depreciated.
-
 **Initialise and run** in one command:
 ```sh
 # simple default
 ./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> --wireguard-enabled false
+./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.
@@ -143,7 +184,7 @@ As part of the transition, `allowed.list` on Exit Gateway embedded Network Reque
 ./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> --wireguard-enabled false
+./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.
@@ -152,7 +193,7 @@ As part of the transition, `allowed.list` on Exit Gateway embedded Network Reque

 Run the node with custom `--id` without initialising, using `--deny-init` command
 ```sh
-./nym-node run --id <ID> --deny-init --mode exit-gateway
+./nym-node run --id <ID> --deny-init --mode exit-gateway --accept-operator-terms-and-conditions
 ```

 #### Mode: `entry-gateway`
@@ -164,12 +205,12 @@ Run the node with custom `--id` without initialising, using `--deny-init` comman

 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
+./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
 ```

 Run the node with custom `--id` without initialising:
 ```sh
-./nym-node run --id <ID> --deny-init --mode entry-gateway
+./nym-node run --id <ID> --deny-init --mode entry-gateway --accept-operator-terms-and-conditions
 ```

 #### Mode: `mixnode`
@@ -181,17 +222,17 @@ Run the node with custom `--id` without initialising:

 Initialise only with a custom `--id` and `--init-only` command:
 ```sh
-./nym-node run --id <ID> --init-only --mode mixnode --verloc-bind-address 0.0.0.0:1790 --public-ips "$(curl -4 https://ifconfig.me)"
+./nym-node run --id <ID> --init-only --mode mixnode --verloc-bind-address 0.0.0.0:1790 --public-ips "$(curl -4 https://ifconfig.me)" --accept-operator-terms-and-conditions
 ```

 Run the node with custom `--id` without initialising:
 ```sh
-./nym-node run --id <ID> --deny-init --mode mixnode
+./nym-node run --id <ID> --deny-init --mode mixnode --accept-operator-terms-and-conditions
 ```

 Run the node with custom `--id` without initialising:
 ```sh
-./nym-node run --id <ID> --deny-init --mode entry-gateway
+./nym-node run --id <ID> --deny-init --mode entry-gateway --accept-operator-terms-and-conditions
 ```

 ### Migrate
@@ -212,7 +253,7 @@ Make sure to use `--deny-init` flag to prevent initialisation of a new node.
 ./nym-node migrate --config-file ~/.nym/mixnodes/<MIXNODE_ID>/config/config.toml mixnode

 # initialise with the new nym-node config
-./nym-node run --mode mixnode --id <NYM-NODE_ID> --deny-init
+./nym-node run --mode mixnode --id <NYM-NODE_ID> --accept-operator-terms-and-conditions
 ```

 #### Mode: `entry-gateway` and `exit-gateway`
@@ -220,8 +261,11 @@ Make sure to use `--deny-init` flag to prevent initialisation of a new node.
 # move relevant infor from config.toml
 ./nym-node migrate --config-file ~/.nym/gateways/<GATEWAY_ID>/config/config.toml gateway

-# initialise with the new nym-node config
-./nym-node run --mode exit-gateway --id <NYM-NODE_ID> --deny-init # or change to entry-gateway
+# initialise with the new nym-node config - entry-gateway
+./nym-node run --mode entry-gateway --id <NYM-NODE_ID> --accept-operator-terms-and-conditions
+
+# or as exit-gateway
+./nym-node run --id <NYM-NODE_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
 ```

 ### Next steps
@@ -8,7 +8,7 @@ Below are steps to [setup your environment](#sandbox-environment-setup) and an i
 This page is for Nym node operators. If you want to run NymVPN CLI over Sandbox testnet, visit our [developers portal](https://nymtech.net/developers/nymvpn/cli.html#testnet-environment).
 ```

-## Sanbox Environment Setup
+## Sandbox Environment Setup

 > Any syntax in `<>` brackets is a user's unique variable. Exchange with a corresponding name without the `<>` brackets.

@@ -40,9 +40,9 @@ curl -o sandbox.env -L https://raw.githubusercontent.com/nymtech/nym/develop/env
 ![](images/sandbox.png)

 ~~~admonish tip
-1. If you [built Nym from source](building-nym.md), you already have `sanbox.env` as a part of the monorepo (`nym/envs/sandbox.env`). Giving that you are likely to run `nym-node` from `nym/target/release`, the flag will look like this `--config-env-file ../../envs/sandbox.env`
+1. If you [built Nym from source](building-nym.md), you already have `sandbox.env` as a part of the monorepo (`nym/envs/sandbox.env`). Giving that you are likely to run `nym-node` from `nym/target/release`, the flag will look like this `--config-env-file ../../envs/sandbox.env`

-2. You can export the path to `sanbox.env` to your enviromental variables:
+2. You can export the path to `sandbox.env` to your enviromental variables:
 ```sh
 export NYMNODE_CONFIG_ENV_FILE_ARG=<PATH/TO/sandbox.env>
 ```
@@ -12,26 +12,32 @@ Besides that, Gateway operators can check out their node performance, connectivi
 ### Basic API usage

 For information about available endpoints and their status, you can refer to:
-```
+```sh
+# sustitude <NODE_IP_ADDRESS> or <NODE_DOMAIN> with a real one
 # for http
-http://<IP>:8080/api/v1/swagger/#/
+http://<NODE_IP_ADDRESS>:8080/api/v1/swagger/#/
+# or
+http://<NODE_IP_ADDRESS>/api/v1/swagger/#/

-# for https reversed proxy
-https://<DOMAIN>/api/v1/swagger/#/
+# for reversed proxy/WSS
+https://<NODE_DOMAIN>/api/v1/swagger/#/
 ```

 For example to determine which mode your node is running, you can check `:8080/api/v1/roles` endpoint:
-```
+```sh
+# sustitude <NODE_IP_ADDRESS> or <NODE_DOMAIN> with a real one
 # for http
-http://<IP_ADDRESS>:8080/api/v1/roles
+http://<NODE_IP_ADDRESS>:8080/api/v1/roles
+# or
+http://<NODE_IP_ADDRESS>/api/v1/roles

-# for https reversed proxy
-https://<DOMAIN>/api/v1/roles
+# for reversed proxy/WSS
+https://<NODE_DOMAIN>/api/v1/roles
 ```

 ## `node_api_check.py`

-To make this a bit easier, we made a CLI tool quering all vailable API endpoints based on node `Identity Key` (further denoted as `<ID_KEY>`) called `node_api_check.py`. To diagnose your node performance, whether by yourself or by sharing an output in our [operator channel](https://matrix.to/#/#operators:nymtech.chat), this tool provides you with a quick overview of live data. We recommend to run this checker alongside [`nym_gateway_probe`](gateway-probe.md) to triage both performance and an actual routing.
+To make this a bit easier, we made a CLI tool querying all available API endpoints based on node `Identity Key` (further denoted as `<ID_KEY>`) called `node_api_check.py`. To diagnose your node performance, whether by yourself or by sharing an output in our [operator channel](https://matrix.to/#/#operators:nymtech.chat), this tool provides you with a quick overview of live data. We recommend to run this checker alongside [`nym_gateway_probe`](gateway-probe.md) to triage both performance and an actual routing.

 Besides querying any bonded node APIs, `nym_api_check` has a function counting all existing nodes in provided version.

@@ -43,7 +49,7 @@ Besides querying any bonded node APIs, `nym_api_check` has a function counting a

 1. Start with installing Python3:
 ```sh
-sudo apt install Python3
+sudo apt install python3
 ```

 2. Make sure Python3 is your default Python version:
@@ -52,6 +58,7 @@ update-alternatives --install  /usr/bin/python python /usr/bin/python3 1

 # controll
 python --version
+
 # should return higher than 3
 ```

@@ -100,14 +107,14 @@ When you want to see all the options connected to a command, add a `--help` flag
 ```
 ~~~

-The most common usage may be `./node_api_check.py query_stats <ID_KEY>` where `<ID_KEY>` is required, sustitute it with node Identity Key.
+The most common usage may be `./node_api_check.py query_stats <ID_KEY>` where `<ID_KEY>` is required, substitute it with node Identity Key.

 **Optional arguments**

 | Flag                   | Shortcut | Description                                                 |
 | :---                   |     :---      | :---                                                        |
 | `--markdown`           |     `-m`      | returns output in markdown format                           |
-| `--no_routing_history` |     `-n`      | returns output without routing history which can be lenghty |
+| `--no_routing_history` |     `-n`      | returns output without routing history which can be lengthy |
 | `--output`             |     `-o`      | exports output to a file, possible to add a target path     |

 #### `version_count`
@@ -0,0 +1,9 @@
+# Terms and Conditions
+
+With `nym-node` version `1.1.3`, NymTech SA introduced [**Operators Terms & Conditions**]({{toc_page}}) for operators who want their nodes to become a part of the active set of Nym Mixnet.
+
+There has been a long ongoing discussion whether and how to apply Terms and Conditions for Nym network operators, with an aim to stay aligned with the philosophy of Free Software and provide legal defense for both node operators and Nym developers. To understand better the reasoning behind this decision, you can listen to the first [Nym Operator Town Hall](https://www.youtube.com/live/7hwb8bAZIuc?si=3mQ2ed7AyUA1SsCp&t=915) introducing the T&Cs or to [Operator AMA with CEO Harry Halpin](https://www.youtube.com/watch?v=yIN-zYQw0I0) from June 4th, 2024, explaining pros and cons of T&Cs implementation.
+
+Accepting T&Cs is done via an explicit flag `--accept-operator-terms-and-conditions` added to `nym-node run` command.
+
+More information on how to setup your node or check whether any node has T&C accepted can be found in [`nym-node` setup guide](nodes/setup.md#terms--conditions).
@@ -85,6 +85,8 @@ There are 2 community explorers currently, which have been created by [Nodes Gur
 * [Mainnet](https://mixnet.explorers.guru/)
 * [Sandbox testnet](https://sandbox.mixnet.explorers.guru/)

+You can run [Node API Check CLI](../testing/node-api-check.md) to query all API endpoints of your node at once.
+
 [Here](https://github.com/cosmos/chain-registry/blob/master/nyx/chain.json#L158-L187) is a dictionary with Nyx chain registry entry regarding all explorers.

 If you want more information, or if your node isn't showing up on the explorer of your choice and you want to double-check, here are some examples on how to check if the node is configured properly.
@@ -291,50 +293,67 @@ Let your Gateway run and follow these steps:

 ### My Gateway is blacklisted

-Nym API measures performance by routing traffic through the Mixnet. If the average of a Gateway's routing score in past 24h is less than 50%, the Gateway gets blacklisted and remains so until this number is higher than 50%.
+Nym API measures performance by routing traffic through the Mixnet. If the average of a Gateway's routing score in past 24h is less than 50%, the Gateway gets blacklisted and it remains so until its performance is higher than 50%.

 In case your Gateway appeared on the [blacklist](https://validator.nymtech.net/api/v1/gateways/blacklisted), it's because there is some flaw in the configuration. The most common sources of problems are:

+- Outdated version of `nym-node`
 - Bonding before starting the node/service
 - Bonding before opening [needed ports](../nodes/vps-setup.md#configure-your-firewall)
- VPS restarted without operator having a [systemd automation](../nodes/configuration.md#systemd) or some alert notification flow setup
+- VPS restarted without operator having a [systemd automation](../nodes/configuration.md#systemd) or some alert notification flow setup (so the operator doesn't know the node was stopped)
+- IP address or host is incorrectly configured
+- Process logs grew too big
+- Node is wrapped in [systemd service](../nodes/configuration.md#systemd) and the operator forgot to run `systemctl daemon-reload` after last changes

-What to do:
+**What to do**

-1. Make sure your node is running and do not stop it if there is no need
-2. Open all needed [needed ports](../nodes/vps-setup.md#configure-your-firewall)
-3. Check your `config.toml` - often people have filled `hostname` without such hostname being configured or a wrong IP address after moving their node.
+Begin with a sanity check by opening [harbourmaster.nymtech.net](https://harbourmaster.nymtech.net) and check your node there. To query all API endpoints of your node at once, you can run [Node API Check CLI](../testing/node-api-check.md). To see IPv4 and IPv6 routing in real time (harbourmaster can have a cache up to 90 min), run [Gateway Probe CLI](../testing/gateway-probe.md).
+
+Then follow these steps:
+
+1. Make sure your node is on the [latest version](../changelog.md) and it's running . Do *not* stop it if there is no need!
+2. Open all [needed ports](../nodes/vps-setup.md#configure-your-firewall)
+3. Check your `config.toml` - often people have filled `hostname` without the domain being registered to `nym-node` IP, or a wrong IP address after moving their node.
 4. [Check Gateway Connectivity](#check-gateway-connectivity)
 5. See logs of your Gateway and search [for errors](#nym-node-errors) - if you find any unusual one, you can ask in the [Element Node Operators](https://matrix.to/#/#operators:nymtech.chat) channel
  - If your logs show that your Node has `cover down: 0.00` that means that the embedded IPR and NR is not sending any cover traffic.
-6. When all problems addressed:Wait until your node gets above 50% of performance (average of last 24h) - this will likely take several hours, up to a day. During this time your node is tested by `nym-api` and every positive response picks up your Gateway's routing score.
+6. [Check out if your `syslog`s](vps-isp.md#pruning-logs) aren't eating all your disk space and prune them
+7. When all problems are addressed: Restart the node/service (don't forget `systemctl daemon-reload`) and wait until your node gets above 50% of performance (average of last 24h) - this will likely take 24-48 hours. During this time your node is tested by `nym-api` and every positive response picks up your routing score.
+8. If your node doesn't pick up the routing score within 24h at all and it was running in `--mode exit-gateway`, run it as `--mode entry-gateway`. When your node is above 75% performance (past 24h), switch back to `--mode exit-gateway`.

-**Do not restart your Nym Node without reason, your routing score will only get worse!**
+**Do not repeatedly restart your Nym Node without reason, your routing score will only get worse!**

 ### Check Gateway connectivity

 **1. Check out the API endpoints**

 Start with checking if your Gateway IPR and NR is active. To determine which mode your node is running, you can check the `:8080/api/v1/roles` endpoint. For example:
-```
+```sh
+# sustitude <NODE_IP_ADDRESS> or <NODE_DOMAIN> with a real one
 # for http
-http://<IP_ADDRESS>:8080/api/v1/roles
+http://<NODE_IP_ADDRESS>:8080/api/v1/roles
+# or
+http://<NODE_IP_ADDRESS>/api/v1/roles

-# for https reversed proxy
-https://<DOMAIN>/api/v1/roles
+# for reversed proxy/WSS
+https://<NODE_DOMAIN>/api/v1/roles
 ```

 Everything necessary will exist on your node by default. For instance, if you're running a mixnode, you'll find that a NR (Network Requester) and IPR (IP Packet Router) address exist, but they will be ignored in `mixnode` mode.

 For more information about available endpoints and their status, you can refer to:
 ```sh
+# sustitude <NODE_IP_ADDRESS> or <NODE_DOMAIN> with a real one
 # for http
-http://<IP>:8080/api/v1/swagger/#/
+http://<NODE_IP_ADDRESS>:8080/api/v1/swagger/#/
+# or
+http://<NODE_IP_ADDRESS>/api/v1/swagger/#/

-# for https reversed proxy
-https://<DOMAIN>/api/v1/swagger/#/
+# for reversed proxy/WSS
+https://<NODE_DOMAIN>/api/v1/swagger/#/
 ```

+
 **2. Configure IPv4 and IPv6 tables and rules**

 - In case you haven't, follow the steps in the node [configuration](../nodes/configuration.md) chapter [connectivity test and configurastion](../nodes/configuration.md#connectivity-test-and-configuration).
@@ -11,6 +11,6 @@ If the `/dev/sda` partition is almost full, try pruning some of the `.gz` syslog

 ## Where can I get more help?

-The fastest way to reach one of us or get a help from the community, visit our [Telegram Node Setup Help Chat](https://t.me/nymchan_help_chat) or head to our [Discord](https://Discord.gg/nym).
+The fastest way to reach one of us or get a help from the community, visit our [Telegram Node Setup Help Chat](https://t.me/nymchan_help_chat) or head to our [Discord](https://discord.gg/FaTJb8q8).

 For more tech heavy question join our [Matrix core community channel](https://matrix.to/#/#general:nymtech.chat), where you can meet other builders and Nym core team members.
@@ -49,3 +49,43 @@ To find the right IP configuration, contact your VPS provider for support to fin
 On self-hosted machine it's a bit more tricky. In that case as an operator you must be sure that your ISP allows for public IPv4 and IPv6 and then it may be a bit of playing around to find the right configuration. One way may be to bind your binary with the `--host` flag to local address `127.0.0.1` and run `echo "$(curl -4 https://ifconfig.me)"` to get a public address which you use to bond your Mix Node to `nym-api` via Nym wallet.

 It's up to you as a node operator to ensure that your public and private IPs match up properly.
+
+### Pruning Logs
+
+Running a `nym-node` as a standalone process or wrapped in a service can produce gigabytes of logs. Eventually your operation can malfunction due to the logs chewing up too much disk space or memory. Below are two scripts that can help you clean this up.
+
+```admonish warning
+`rm` is a powerful tool, without an easy way of revoking. If you need to extract or backup anything, do it now. Make sure you understand what you removing before you execute these commands.
+```
+
+```sh
+# I WANT TO SEE WHATS EATING ALL MY DISKSPACE
+sudo find /var -type f -printf "%s\t%p\n" | sort -n -r | head -n 20 | ls -lh
+sudo find /var -type f -exec ls -lh {} + 2>/dev/null | sort -k 5 -n -r | head -n 20
+
+sudo du -h --max-depth=1 /var
+sudo du -h /var/log
+
+#PRUNE THOSE LOGS
+sudo rm -f /var/log/syslog.1
+sudo rm -f /var/log/syslog
+journalctl --disk-usage
+sudo journalctl --vacuum-time=3d
+sudo journalctl --vacuum-size=50M
+
+#ENFORCE LOG ROTATION
+sudo logrotate --force /etc/logrotate.conf
+sudo service rsyslog restart
+
+# REMOVE ALL THOSE OLD PACKAGES...
+sudo apt-get clean
+sudo apt-get autoremove
+
+sudo apt-get clean
+sudo rm -rf /var/lib/apt/lists/*
+sudo apt-get update
+
+for snap in $(sudo snap list --all | awk '/disabled/{print $1, $3}'); do
+    sudo snap remove $snap
+done
+```
--- a/Show More
+++ b/Show More
Author	SHA1	Message	Date
Tommy Verrall	a2c473e9d3	Merge branch 'develop' into conflicts	2024-07-10 11:43:54 +02:00
Tommy Verrall	962684ff56	Merge pull request #4667 from nymtech/feature/authenticator Add authenticator	2024-07-10 10:14:58 +02:00
Tommy Verrall	7b3804c078	Merge pull request #4697 from nymtech/event-parsing add event parsing to support cosmos_sdk > 0.50	2024-07-10 09:55:43 +02:00
Sachin Kamath	170f1823e1	fix tests	2024-07-09 21:54:57 +05:30
Sachin Kamath	dc2020559a	parse attributes from events instead of raw logs	2024-07-09 21:24:58 +05:30
Tommy Verrall	2b9444cce3	add an early return in parse_raw_str_logs for empty raw log strings. this accommodates for the v50 chain upgrade	2024-07-09 20:36:36 +05:30
Bogdan-Ștefan Neacşu	68c1c068ac	Add old config upgrade flow	2024-07-09 09:16:00 +00:00
Drazen Urch	3d0b70a237	Add mixnodes to self describing api cache (#4684 ) * Add mixnodes to self describing api cache * Use NodeRole enum * Add route for described mixnodes * Cleanup contract_cache * Remove nodestatuscache * wait_until_ready impl	2024-07-09 10:54:48 +02:00
Bogdan-Ștefan Neacşu	65a6edc78c	Add authenticator debug to entry gateway config	2024-07-08 11:00:53 +00:00
Sachin Kamath	2ec8349897	update social links (#4695 ) * replace vanity link * fix links	2024-07-05 14:19:09 +00:00
Bogdan-Ștefan Neacşu	38a2d94f80	Fix clippy	2024-07-05 11:36:15 +00:00
Bogdan-Ștefan Neacşu	c7fa910516	Fix add of req id	2024-07-05 10:36:18 +00:00
Bogdan-Ștefan Neacşu	2fe08274dd	Add another layer for request id field	2024-07-05 10:20:56 +00:00
mx	be89d848dc	Max/try fix doc search (#4692 ) * minimised dropdown bar * update ci scripts * theme changes to dev portal * theme changes to operators * theme changes to docs * theme -> themes * fixed theme -> themes import in book * removed bak files * remove logging from post_process + remove search feature from mdbook --------- Co-authored-by: mfahampshire <mfahampshire@pm.me>	2024-07-05 12:19:14 +02:00
Bogdan-Ștefan Neacşu	a230a9b8b9	Merge remote-tracking branch 'origin/develop' into feature/authenticator	2024-07-05 09:57:48 +00:00
Bogdan-Ștefan Neacşu	72eae7cdf3	Remove stale mid-registrations	2024-07-05 09:38:17 +00:00
Bogdan-Ștefan Neacşu	7cae195370	Typo	2024-07-05 07:54:29 +00:00
Bogdan-Ștefan Neacşu	dfb16e385c	Rand from workspace	2024-07-05 07:53:33 +00:00
Bogdan-Ștefan Neacşu	660e1cad0a	Reconstruction msg	2024-07-04 14:26:37 +00:00
Bogdan-Ștefan Neacşu	7c1aa57a7e	Add curr version	2024-07-04 14:15:25 +00:00
Bogdan-Ștefan Neacşu	a06e496f78	Add final req creation	2024-07-04 13:54:13 +00:00
Jon Häggblad	70599b97b9	Send bandwidth status messages when connecting (#4691 ) * Send bandwidth status messages when connecting * Rename to task_client * Move status message type to bandwidth controller	2024-07-04 13:10:16 +02:00
Bogdan-Ștefan Neacşu	02b194bde0	Function to create AuthReq	2024-07-04 10:40:53 +00:00
Bogdan-Ștefan Neacşu	20ec049db5	Remove more unnecessary structures	2024-07-04 09:41:17 +00:00
Bogdan-Ștefan Neacşu	fec3d46b33	Include auth in self description	2024-07-03 13:50:44 +00:00
Bogdan-Ștefan Neacşu	a4eb3a7dbf	Named fork for better logging	2024-07-03 13:03:32 +00:00
Bogdan-Ștefan Neacşu	28d15f2c4f	Remove unused import	2024-07-03 11:28:09 +00:00
Jon Häggblad	6078787daa	Remove constructor since it's weakly typed (#4689 )	2024-07-03 12:26:47 +02:00
Jon Häggblad	6d93f36c82	Fix NR config compatibility (#4690 ) * Make NR able to read config with old keys in We removed stuff related to the old statistics service, so we ignore unknown fields to be nice to our users * Remove deleted config keys from NR template	2024-07-03 12:10:41 +02:00
Bogdan-Ștefan Neacşu	c6f93e38f5	Remove unused post function	2024-07-03 09:34:03 +00:00
Bogdan-Ștefan Neacşu	2159f71888	Fix wg feature	2024-07-03 09:04:01 +00:00
Bogdan-Ștefan Neacşu	a9abea3446	Fix macos build	2024-07-03 08:27:10 +00:00
Bogdan-Ștefan Neacşu	8e2713c9ba	Remove unwrap	2024-07-03 08:21:58 +00:00
Bogdan-Ștefan Neacşu	2ba0ef0e35	Remove unused wg http endpoint	2024-07-02 14:09:34 +00:00
Bogdan-Ștefan Neacşu	d3713cbc79	Fix user agent arg	2024-07-02 16:40:11 +03:00
Bogdan-Ștefan Neacşu	4d3fb2b585	Merge remote-tracking branch 'origin/develop' into feature/authenticator	2024-07-02 16:25:29 +03:00
import this	e65e611859	remove roles selection on blacklisting node - PR done (#4687 )	2024-07-02 13:37:23 +01:00
Bogdan-Ștefan Neacşu	c465eb3efc	Fix error type	2024-07-02 08:58:48 +00:00
Bogdan-Ștefan Neacşu	b90136ac4e	Uniformise non-linux wg function	2024-07-01 15:10:36 +00:00
Bogdan-Ștefan Neacşu	ae5373168d	Fmt	2024-07-01 14:42:10 +00:00
Bogdan-Ștefan Neacşu	6f3942f6b7	Move implementation for final request	2024-07-01 14:38:48 +00:00
import this	4a25725a11	README.md update (#4685 ) * start README update * test alpha on github preview * test alpha on github preview * comment out rewards * finish README update	2024-07-01 16:27:59 +02:00
Bogdan-Ștefan Neacşu	13f38343aa	Finalize cli build	2024-07-01 13:44:59 +00:00
Jon Häggblad	d34c829174	Create UserAgent that can be passed from the binary to the nym api client (#4677 ) * Create UserAgent that can be passed from the binary to the nym api client * TryFrom for UserAgent to HeaderValue * Add user agent for getting the list of gateways * Fix wasm client * Move clap behind feature flag in bin-common * Implement conversion to UserAgent * Set user_agent on base client in native and socks5 clients * Set user agent in socks5-listener lib * wip * wip * Deserialize cargo_triple to unknown by default * Abbreviate git hash * Remove unused import * Add missing dep, and remove dbg statements * Reorder string representation * Remove commented out code * Revert temporary log level change	2024-07-01 13:29:10 +02:00
Bogdan-Ștefan Neacşu	f75b4843e8	Merge remote-tracking branch 'origin/develop' into feature/authenticator	2024-07-01 09:56:34 +00:00
Jędrzej Stuczyński	6963ead65a	minor cleanup	2024-07-01 08:25:31 +01:00
Jon Häggblad	0425cdeaf0	Merge pull request #4680 from nymtech/jon/deps-to-workspace Move and whole bump of crates to workspace and upgrade some	2024-06-27 13:25:21 +02:00
import this	789914b096	[DOCs/operators]: Updates v2024.6-chomp and T&Cs (#4674 ) * initialise updates and ToC * add toc flag * changelog and node black-xit improvement * add node-api-check option * syntax fix * syntax fix * change CI/CD with git reset * fix typo * add T&C AMA explanation link - ready for review * fix typo * resolve review comments * add ToC standalone page * minor edit - ready to go	2024-06-27 09:59:57 +00:00
Jon Häggblad	8acd3a0975	Move a few more deps partially to workspace	2024-06-27 10:52:15 +02:00
Jon Häggblad	fa1519ec6a	Move itertools to workspace deps	2024-06-27 10:52:15 +02:00
Jon Häggblad	da94b7e8df	Sort list	2024-06-27 10:52:15 +02:00
Jon Häggblad	4aa8cb4647	Move dalek and rand_chacha crates to workspace	2024-06-27 10:52:15 +02:00
Jon Häggblad	5d13538508	Use workspace base64 dep	2024-06-27 10:52:15 +02:00
Jon Häggblad	4bbbcf629d	Fix warning for default_features	2024-06-27 10:52:15 +02:00
Jon Häggblad	34ef970fd8	Move dirs 4.0 to workspace deps	2024-06-27 10:52:14 +02:00
Jon Häggblad	fec570613c	Remove code that refers to removed nym-network-statistics (#4679 ) * Remove nym-network-statistics from workspace * Remove nym-network-statistics * Cargo.lock * Update ci workflow * Remove code that refers to removed nym-network-statistics * Remove more * Remove nym-statistics-common * Delete commented out modules * Remove commented out code * Remove more commented out code * Remove more commented out stuff * Remove unused function	2024-06-27 10:32:32 +02:00
Jon Häggblad	14a904eff0	Remove nym-network-statistics (#4678 ) * Remove nym-network-statistics from workspace * Remove nym-network-statistics * Cargo.lock * Update ci workflow	2024-06-27 10:32:09 +02:00
Bogdan-Ștefan Neacşu	b43844bd7a	Embed into gateway	2024-06-21 15:51:02 +00:00
Bogdan-Ștefan Neacşu	cd89feb57e	Fix path	2024-06-20 15:15:05 +00:00
Bogdan-Ștefan Neacşu	17553d606e	Requests and responses	2024-06-20 16:58:21 +03:00
Bogdan-Ștefan Neacşu	b6d9ed960b	Specify version	2024-06-19 11:37:09 +03:00
Bogdan-Ștefan Neacşu	1d89a887fb	Add authenticator	2024-06-18 19:05:23 +03:00