updated module path

removed cflag import for test
updated module path.. again
2024-05-31 15:19:34 +02:00 · 2024-05-31 15:14:54 +02:00 · 2024-05-31 15:07:16 +02:00 · 2024-05-31 14:54:14 +02:00 · 2024-05-31 14:49:29 +02:00 · 2024-05-31 14:43:13 +02:00
195 changed files with 3438 additions and 5813 deletions
@@ -9,7 +9,7 @@ jobs:
    steps:
      - uses: actions/checkout@v3
      - name: Install Dependencies (Linux)
-        run: sudo apt-get update && sudo apt-get install -y build-essential curl wget libssl-dev libudev-dev squashfs-tools protobuf-compiler
+        run: sudo apt-get update && sudo apt-get install -y build-essential curl wget libssl-dev libudev-dev squashfs-tools protobuf-compiler git
      - name: Install rsync
        run: sudo apt-get install rsync
      - uses: rlespinasse/github-slug-action@v3.x
@@ -30,9 +30,24 @@ jobs:
      - name: Remove existing Nym config directory (`~/.nym/`)
        run: cd documentation && ./remove_existing_config.sh
        continue-on-error: false
-      - name: Build all projects in documentation/ & move to ~/dist/docs/
+# This is the original flow
+#      - name: Build all projects in documentation/ & move to ~/dist/docs/
+#        run: cd documentation && ./build_all_to_dist.sh
+
+# 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: Build all projects in documentation/ & move to ~/dist/docs/ from b332a6b55668f60988e36961f3f62a794ba82ddb
        run: cd documentation && ./build_all_to_dist.sh
-        continue-on-error: false
+
+      - name: Switch to current branch
+        run: git checkout $echo "$(cat ~/current_branch)"
+      - name: Build all projects in documentation/ & move to ~/dist/docs/ on current branch
+        run: cd documentation && ./build_all_to_dist.sh && rm ~/current_branch
+
+# End of replacemet

      - name: Post process
        run: cd documentation && ./post_process.sh
@@ -13,7 +13,7 @@ jobs:
    steps:
      - uses: actions/checkout@v3
      - name: Install Dependencies (Linux)
-        run: sudo apt-get update && sudo apt-get install -y build-essential curl wget libssl-dev libudev-dev squashfs-tools protobuf-compiler
+        run: sudo apt-get update && sudo apt-get install -y build-essential curl wget libssl-dev libudev-dev squashfs-tools protobuf-compiler git
      - name: Install rsync
        run: sudo apt-get install rsync
      - uses: rlespinasse/github-slug-action@v3.x
@@ -34,9 +34,25 @@ jobs:
      - name: Remove existing Nym config directory (`~/.nym/`)
        run: cd documentation && ./remove_existing_config.sh
        continue-on-error: false
-      - name: Build all projects in documentation/ & move to ~/dist/docs/
+
+# This is the original flow
+#      - name: Build all projects in documentation/ & move to ~/dist/docs/
+#        run: cd documentation && ./build_all_to_dist.sh
+
+# 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: Build all projects in documentation/ & move to ~/dist/docs/ from b332a6b55668f60988e36961f3f62a794ba82ddb
        run: cd documentation && ./build_all_to_dist.sh
-        continue-on-error: false
+
+      - name: Switch to current branch
+        run: git checkout $echo "$(cat ~/current_branch)"
+      - name: Build all projects in documentation/ & move to ~/dist/docs/ on current branch
+        run: cd documentation && ./build_all_to_dist.sh && rm ~/current_branch
+
+# End of replacemet

      - name: Deploy branch to CI www
        continue-on-error: true
@@ -102,6 +102,18 @@ jobs:
            nym-wallet/target/release/bundle/dmg/*.dmg
            nym-wallet/target/release/bundle/macos/*.app.tar.gz*

+      - name: Deploy artifacts to CI www
+        continue-on-error: true
+        uses: easingthemes/ssh-deploy@main
+        env:
+          SSH_PRIVATE_KEY: ${{ secrets.CI_WWW_SSH_PRIVATE_KEY }}
+          ARGS: "-avzr"
+          SOURCE: "nym-wallet/target/release/bundle/macos/nym-wallet.app.tar.gz"
+          REMOTE_HOST: ${{ secrets.CI_WWW_REMOTE_HOST }}
+          REMOTE_USER: ${{ secrets.CI_WWW_REMOTE_USER }}
+          TARGET: ${{ secrets.CI_WWW_REMOTE_TARGET }}/builds/${{ github.ref_name }}/nym-wallet
+          EXCLUDE: "/dist/, /node_modules/"            
+
  push-release-data:
    if: ${{ (startsWith(github.ref, 'refs/tags/nym-wallet-') && github.event_name == 'release') || github.event_name == 'workflow_dispatch' }}
    uses: ./.github/workflows/release-calculate-hash.yml
@@ -77,6 +77,18 @@ jobs:
            nym-wallet/target/release/bundle/appimage/*.AppImage
            nym-wallet/target/release/bundle/appimage/*.AppImage.tar.gz*

+      - name: Deploy artifacts to CI www
+        continue-on-error: true
+        uses: easingthemes/ssh-deploy@main
+        env:
+          SSH_PRIVATE_KEY: ${{ secrets.CI_WWW_SSH_PRIVATE_KEY }}
+          ARGS: "-avzr"
+          SOURCE: "nym-wallet/target/release/bundle/appimage/nym-wallet*.AppImage.tar.gz"
+          REMOTE_HOST: ${{ secrets.CI_WWW_REMOTE_HOST }}
+          REMOTE_USER: ${{ secrets.CI_WWW_REMOTE_USER }}
+          TARGET: ${{ secrets.CI_WWW_REMOTE_TARGET }}/builds/${{ github.ref_name }}/nym-wallet
+          EXCLUDE: "/dist/, /node_modules/"               
+
  push-release-data:
    if: ${{ (startsWith(github.ref, 'refs/tags/nym-wallet-') && github.event_name == 'release') || github.event_name == 'workflow_dispatch' }}
    uses: ./.github/workflows/release-calculate-hash.yml
@@ -97,6 +97,18 @@ jobs:
            nym-wallet/target/release/bundle/msi/*.msi
            nym-wallet/target/release/bundle/msi/*.msi.zip*

+      - name: Deploy artifacts to CI www
+        continue-on-error: true
+        uses: easingthemes/ssh-deploy@main
+        env:
+          SSH_PRIVATE_KEY: ${{ secrets.CI_WWW_SSH_PRIVATE_KEY }}
+          ARGS: "-avzr"
+          SOURCE: "nym-wallet/target/release/bundle/msi/nym-wallet_1.*.msi"
+          REMOTE_HOST: ${{ secrets.CI_WWW_REMOTE_HOST }}
+          REMOTE_USER: ${{ secrets.CI_WWW_REMOTE_USER }}
+          TARGET: ${{ secrets.CI_WWW_REMOTE_TARGET }}/builds/${{ github.ref_name }}/nym-wallet
+          EXCLUDE: "/dist/, /node_modules/"            
+
  push-release-data:
    if: ${{ (startsWith(github.ref, 'refs/tags/nym-wallet-') && github.event_name == 'release') || github.event_name == 'workflow_dispatch' }}
    uses: ./.github/workflows/release-calculate-hash.yml
@@ -4,6 +4,16 @@ Post 1.0.0 release, the changelog format is based on [Keep a Changelog](https://

 ## [Unreleased]

+## [2024.4-nutella] (2024-05-08)
+
+- [fix] apply disable_poisson_rate from internal NR/IPR cfgs ([#4579])
+- updating sign commands to include nym-node ([#4578])
+- changed nym-node redirects from 308 'Permanent Redirect' to 303: 'See Other' ([#4572])
+
+[#4579]: https://github.com/nymtech/nym/pull/4579
+[#4578]: https://github.com/nymtech/nym/pull/4578
+[#4572]: https://github.com/nymtech/nym/pull/4572
+
 ## [2024.3-eclipse] (2024-04-22)

 - Initial release of the first iteration of the Nym Node
@@ -223,24 +223,23 @@ checksum = "4b46cbb362ab8752921c97e041f5e366ee6297bd428a31275b9fcf1e380f7299"

 [[package]]
 name = "anstream"
-version = "0.6.14"
+version = "0.6.4"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "418c75fa768af9c03be99d17643f93f79bbba589895012a80e3452a19ddda15b"
+checksum = "2ab91ebe16eb252986481c5b62f6098f3b698a45e34b5b98200cf20dd2484a44"
 dependencies = [
 "anstyle",
 "anstyle-parse",
 "anstyle-query",
 "anstyle-wincon",
 "colorchoice",
- "is_terminal_polyfill",
 "utf8parse",
 ]

 [[package]]
 name = "anstyle"
-version = "1.0.7"
+version = "1.0.4"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "038dfcf04a5feb68e9c60b21c9625a54c2c0616e79b72b0fd87075a056ae1d1b"
+checksum = "7079075b41f533b8c61d2a4d073c4676e1f8b249ff94a393b0595db304e0dd87"

 [[package]]
 name = "anstyle-parse"
@@ -537,14 +536,6 @@ version = "1.1.0"
 source = "registry+https://github.com/rust-lang/crates.io-index"
 checksum = "d468802bab17cbc0cc575e9b053f41e72aa36bfa6b7f55e3529ffa43161b97fa"

-[[package]]
-name = "autodoc"
-version = "0.1.0"
-dependencies = [
- "env_logger 0.11.3",
- "log",
-]
-
 [[package]]
 name = "axum"
 version = "0.6.20"
@@ -2500,16 +2491,6 @@ dependencies = [
 "syn 1.0.109",
 ]

-[[package]]
-name = "env_filter"
-version = "0.1.0"
-source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "a009aa4810eb158359dda09d0c87378e4bbb89b5a801f016885a4707ba24f7ea"
-dependencies = [
- "log",
- "regex",
-]
-
 [[package]]
 name = "env_logger"
 version = "0.7.1"
@@ -2533,19 +2514,6 @@ dependencies = [
 "regex",
 ]

-[[package]]
-name = "env_logger"
-version = "0.11.3"
-source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "38b35839ba51819680ba087cd351788c9a3c476841207e0b8cee0b04722343b9"
-dependencies = [
- "anstream",
- "anstyle",
- "env_filter",
- "humantime 2.1.0",
- "log",
-]
-
 [[package]]
 name = "equivalent"
 version = "1.0.1"
@@ -3884,12 +3852,6 @@ dependencies = [
 "windows-sys 0.48.0",
 ]

-[[package]]
-name = "is_terminal_polyfill"
-version = "1.70.0"
-source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "f8478577c03552c21db0e2724ffb8986a5ce7af88107e6be5d2ee6e158c12800"
-
 [[package]]
 name = "isahc"
 version = "1.7.2"
@@ -4502,9 +4464,9 @@ dependencies = [

 [[package]]
 name = "log"
-version = "0.4.21"
+version = "0.4.20"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "90ed8c1e510134f979dbc4f070f87d4313098b704861a105fe34231c70a3901c"
+checksum = "b5e6163cb8c49088c2c36f57875e58ccd8c87c7427f7fbd50ea6710b2f3f2e8f"

 [[package]]
 name = "loom"
@@ -5722,7 +5684,7 @@ dependencies = [

 [[package]]
 name = "nym-gateway"
-version = "1.1.35"
+version = "1.1.36"
 dependencies = [
 "anyhow",
 "async-trait",
@@ -6136,7 +6098,7 @@ dependencies = [

 [[package]]
 name = "nym-network-requester"
-version = "1.1.34"
+version = "1.1.35"
 dependencies = [
 "addr",
 "anyhow",
@@ -6205,7 +6167,7 @@ dependencies = [

 [[package]]
 name = "nym-node"
-version = "1.1.0"
+version = "1.1.1"
 dependencies = [
 "anyhow",
 "bip39",
@@ -90,7 +90,6 @@ members = [
    "common/wasm/utils",
    "common/wireguard",
    "common/wireguard-types",
-    "documentation/autodoc",
    "explorer-api",
    "explorer-api/explorer-api-requests",
    "explorer-api/explorer-client",
@@ -122,7 +121,7 @@ members = [
    "wasm/client",
    #    "wasm/full-nym-wasm",
    "wasm/mix-fetch",
-    "wasm/node-tester", "documentation/autodoc",
+    "wasm/node-tester",
 ]

 default-members = [
@@ -8,3 +8,12 @@ use thiserror::Error;
 pub struct ConfigUpgradeFailure {
    pub current_version: String,
 }
+
+#[derive(Error, Debug)]
+pub enum InvalidTrafficModeFailure {
+    #[error("attempted to set medium toggle traffic mode with fast mode flag")]
+    MediumToggleWithFastMode,
+
+    #[error("attempted to set medium toggle traffic mode with no cover flag")]
+    MediumToggleWithNoCover,
+}
@@ -56,6 +56,7 @@ const DEFAULT_MAXIMUM_REPLY_SURB_AGE: Duration = Duration::from_secs(12 * 60 * 6
 // 24 hours
 const DEFAULT_MAXIMUM_REPLY_KEY_AGE: Duration = Duration::from_secs(24 * 60 * 60);

+use crate::error::InvalidTrafficModeFailure;
 pub use nym_country_group::CountryGroup;

 #[derive(Debug, Clone, Deserialize, PartialEq, Serialize)]
@@ -127,6 +128,56 @@ impl Config {
        self
    }

+    // TODO: this should be refactored properly
+    // as of 12.09.23 the below is true (not sure how this comment will rot in the future)
+    // medium_toggle:
+    // - sets secondary packet size to 16kb
+    // - disables poisson distribution of the main traffic stream
+    // - sets the cover traffic stream to 1 packet / 5s (on average)
+    // - disables per hop delay
+    //
+    // fastmode (to be renamed to `fast-poisson`):
+    // - sets average per hop delay to 10ms
+    // - sets the cover traffic stream to 1 packet / 2000s (on average); for all intents and purposes it disables the stream
+    // - sets the poisson distribution of the main traffic stream to 4ms, i.e. 250 packets / s on average
+    //
+    // no_cover:
+    // - disables poisson distribution of the main traffic stream
+    // - disables the secondary cover traffic stream
+    #[doc(hidden)]
+    pub fn try_apply_traffic_modes(
+        &mut self,
+        disable_poisson_process: bool,
+        medium_toggle: bool,
+        fast_mode: bool,
+        no_cover: bool,
+    ) -> Result<(), InvalidTrafficModeFailure> {
+        if disable_poisson_process {
+            self.set_no_poisson_process()
+        }
+
+        if medium_toggle {
+            if fast_mode {
+                return Err(InvalidTrafficModeFailure::MediumToggleWithFastMode);
+            }
+            if no_cover {
+                return Err(InvalidTrafficModeFailure::MediumToggleWithNoCover);
+            }
+
+            self.set_experimental_medium_toggle();
+        }
+
+        if fast_mode {
+            self.set_high_default_traffic_volume()
+        }
+
+        if no_cover {
+            self.set_no_cover_traffic();
+        }
+
+        Ok(())
+    }
+
    pub fn set_high_default_traffic_volume(&mut self) {
        self.debug.traffic.average_packet_delay = Duration::from_millis(10);
        // basically don't really send cover messages
@@ -136,6 +187,15 @@ impl Config {
        self.debug.traffic.message_sending_average_delay = Duration::from_millis(4);
    }

+    /// Enable medium mixnet traffic, for experiments only.
+    /// This includes things like disabling cover traffic, no per hop delays, etc.
+    #[doc(hidden)]
+    pub fn set_experimental_medium_toggle(&mut self) {
+        self.set_no_cover_traffic_with_keepalive();
+        self.set_no_per_hop_delays();
+        self.debug.traffic.secondary_packet_size = Some(PacketSize::ExtendedPacket16);
+    }
+
    pub fn with_disabled_poisson_process(mut self, disabled: bool) -> Self {
        if disabled {
            self.set_no_poisson_process()
@@ -442,7 +442,7 @@ impl<C, St> GatewayClient<C, St> {
        }

        debug_assert!(self.connection.is_available());
-        log::trace!("Registering gateway");
+        log::debug!("Registering gateway");

        // it's fine to instantiate it here as it's only used once (during authentication or registration)
        // and putting it into the GatewayClient struct would be a hassle
@@ -494,6 +494,7 @@ impl<C, St> GatewayClient<C, St> {
        if !self.connection.is_established() {
            return Err(GatewayClientError::ConnectionNotEstablished);
        }
+        log::debug!("Authenticating with gateway");

        // it's fine to instantiate it here as it's only used once (during authentication or registration)
        // and putting it into the GatewayClient struct would be a hassle
@@ -529,6 +530,7 @@ impl<C, St> GatewayClient<C, St> {
                self.authenticated = status;
                self.bandwidth_remaining = bandwidth_remaining;
                self.negotiated_protocol = protocol_version;
+                log::debug!("authenticated: {status}, bandwidth remaining: {bandwidth_remaining}");
                Ok(())
            }
            ServerResponse::Error { message } => Err(GatewayClientError::GatewayError(message)),
@@ -541,10 +543,11 @@ impl<C, St> GatewayClient<C, St> {
        &mut self,
    ) -> Result<Arc<SharedKeys>, GatewayClientError> {
        if self.authenticated {
+            debug!("Already authenticated");
            return if let Some(shared_key) = &self.shared_key {
                Ok(Arc::clone(shared_key))
            } else {
-                Err(GatewayClientError::AuthenticationFailure)
+                Err(GatewayClientError::AuthenticationFailureWithPreexistingSharedKey)
            };
        }

@@ -71,6 +71,9 @@ pub enum GatewayClientError {
    #[error("Authentication failure")]
    AuthenticationFailure,

+    #[error("Authentication failure with preexisting shared key")]
+    AuthenticationFailureWithPreexistingSharedKey,
+
    #[error("Timed out")]
    Timeout,

@@ -159,7 +159,7 @@ impl TunDevice {
                "add",
                &format!("{}/{}", ipv6, netmaskv6),
                "dev",
-                &tun.name(),
+                (tun.name()),
            ])
            .output()?;
        Ok(tun)
@@ -50,7 +50,7 @@ pub struct DelegationWithEverything {
    pub accumulated_by_delegates: Option<DecCoin>,
    pub accumulated_by_operator: Option<DecCoin>,
    pub block_height: u64,
-    pub delegated_on_iso_datetime: String,
+    pub delegated_on_iso_datetime: Option<String>,
    pub cost_params: Option<MixNodeCostParams>,
    pub avg_uptime_percent: Option<u8>,

@@ -60,6 +60,8 @@ pub struct DelegationWithEverything {
    pub uses_vesting_contract_tokens: bool,
    pub unclaimed_rewards: Option<DecCoin>,

+    pub errors: Option<String>,
+
    // DEPRECATED, IF POSSIBLE TRY TO DISCONTINUE USE OF IT!
    pub pending_events: Vec<DelegationEvent>,
    pub mixnode_is_unbonding: Option<bool>,
@@ -1,13 +0,0 @@
-[package]
-name = "autodoc"
-version = "0.1.0"
-authors.workspace = true
-repository.workspace = true
-homepage.workspace = true
-documentation.workspace = true
-edition.workspace = true
-license.workspace = true
-
-[dependencies]
-env_logger = "0.11.3"
-log.workspace = true
@@ -1,4 +0,0 @@
-# `autodoc`
-
-Command output documentation generator WIP 
-
@@ -1,88 +0,0 @@
-# `nym-api` Binary Commands
-
-These docs are autogenerated by the `autodocs` script. 
-            
-**TODO add link**
-```
-Starting nym api...
-Usage: nym-api [OPTIONS] <COMMAND>
-
-Commands:
-  init        Initialise a Nym Api instance with persistent config.toml file
-  run         Run the Nym Api with provided configuration optionally overriding set parameters
-  build-info  Show build information of this binary
-  help        Print this message or the help of the given subcommand(s)
-
-Options:
-  -c, --config-env-file <CONFIG_ENV_FILE>  Path pointing to an env file that configures the Nym API
-  -h, --help                               Print help
-  -V, --version                            Print version
-```
-
-### `init`
-```
-Starting nym api...
-Initialise a Nym Api instance with persistent config.toml file
-
-Usage: nym-api init [OPTIONS]
-
-Options:
-      --id <ID>
-          Id of the nym-api we want to initialise. if unspecified, a default value will be used. default: "default" [default: default]
-  -m, --enable-monitor
-          Specifies whether network monitoring is enabled on this API default: false
-  -r, --enable-rewarding
-          Specifies whether network rewarding is enabled on this API default: false
-      --nyxd-validator <NYXD_VALIDATOR>
-          Endpoint to nyxd instance used for contract information. default: http://localhost:26657
-      --mnemonic <MNEMONIC>
-          Mnemonic of the network monitor used for sending rewarding and zk-nyms transactions default: None
-      --enable-zk-nym
-          Flag to indicate whether credential signer authority is enabled on this API default: false
-      --announce-address <ANNOUNCE_ADDRESS>
-          Announced address that is going to be put in the DKG contract where zk-nym clients will connect to obtain their credentials default: None
-      --monitor-credentials-mode
-          Set this nym api to work in a enabled credentials that would attempt to use gateway with the bandwidth credential requirement
-  -h, --help
-          Print help
-```
-
-### `run`
-```
-Starting nym api...
-Run the Nym Api with provided configuration optionally overriding set parameters
-
-Usage: nym-api run [OPTIONS]
-
-Options:
-      --id <ID>
-          Id of the nym-api we want to run.if unspecified, a default value will be used. default: "default" [default: default]
-  -m, --enable-monitor <ENABLE_MONITOR>
-          Specifies whether network monitoring is enabled on this API default: None - config value will be used instead [possible values: true, false]
-  -r, --enable-rewarding <ENABLE_REWARDING>
-          Specifies whether network rewarding is enabled on this API default: None - config value will be used instead [possible values: true, false]
-      --nyxd-validator <NYXD_VALIDATOR>
-          Endpoint to nyxd instance used for contract information. default: None - config value will be used instead
-      --mnemonic <MNEMONIC>
-          Mnemonic of the network monitor used for sending rewarding and zk-nyms transactions default: None - config value will be used instead
-      --enable-zk-nym <ENABLE_ZK_NYM>
-          Flag to indicate whether coconut signer authority is enabled on this API default: None - config value will be used instead [possible values: true, false]
-      --announce-address <ANNOUNCE_ADDRESS>
-          Announced address that is going to be put in the DKG contract where zk-nym clients will connect to obtain their credentials default: None - config value will be used instead
-      --monitor-credentials-mode <MONITOR_CREDENTIALS_MODE>
-          Set this nym api to work in a enabled credentials that would attempt to use gateway with the bandwidth credential requirement default: None - config value will be used instead [possible values: true, false]
-  -h, --help
-          Print help
-```
-
-### `build-info`
-```
-Starting nym api...
-Show build information of this binary
-
-Usage: nym-api build-info [OPTIONS]
-
-Options:
-  -o, --output <OUTPUT>  [default: text] [possible values: text, json]
-  -h, --help             Print help
-```
@@ -1,721 +0,0 @@
-# `nym-client` Binary Commands
-
-These docs are autogenerated by the `autodocs` script. 
-            
-**TODO add link**
-```
-Implementation of the Nym Client
-
-Usage: nym-client [OPTIONS] <COMMAND>
-
-Commands:
-  init               Initialise a Nym client. Do this first!
-  run                Run the Nym client with provided configuration client optionally overriding set parameters
-  import-credential  Import a pre-generated credential
-  list-gateways      List all registered with gateways
-  add-gateway        Add new gateway to this client
-  switch-gateway     Change the currently active gateway. Note that you must have already registered with the new gateway!
-  build-info         Show build information of this binary
-  completions        Generate shell completions
-  generate-fig-spec  Generate Fig specification
-  help               Print this message or the help of the given subcommand(s)
-
-Options:
-  -c, --config-env-file <CONFIG_ENV_FILE>  Path pointing to an env file that configures the client
-      --no-banner                          Flag used for disabling the printed banner in tty
-  -h, --help                               Print help
-  -V, --version                            Print version
-```
-
-### `init`
-```
-Initialise a Nym client. Do this first!
-
-Usage: nym-client init [OPTIONS] --id <ID>
-
-Options:
-      --id <ID>
-          Id of client we want to create config for
-      --gateway <GATEWAY>
-          Id of the gateway we are going to connect to
-      --force-tls-gateway
-          Specifies whether the client will attempt to enforce tls connection to the desired gateway
-      --latency-based-selection
-          Specifies whether the new gateway should be determined based by latency as opposed to being chosen uniformly
-      --nym-apis <NYM_APIS>
-          Comma separated list of rest endpoints of the API validators
-      --disable-socket <DISABLE_SOCKET>
-          Whether to not start the websocket [possible values: true, false]
-  -p, --port <PORT>
-          Port for the socket (if applicable) to listen on in all subsequent runs
-      --host <HOST>
-          Ip for the socket (if applicable) to listen for requests
-  -o, --output <OUTPUT>
-          [default: text] [possible values: text, json]
-  -h, --help
-          Print help
-```
-
-### `run`
-```
-Run the Nym client with provided configuration client optionally overriding set parameters
-
-Usage: nym-client run [OPTIONS] --id <ID>
-
-Options:
-      --id <ID>
-          Id of client we want to create config for
-      --gateway <GATEWAY>
-          Id of the gateway we want to connect to. If overridden, it is user's responsibility to ensure prior registration happened
-      --nym-apis <NYM_APIS>
-          Comma separated list of rest endpoints of the API validators
-      --disable-socket <DISABLE_SOCKET>
-          Whether to not start the websocket [possible values: true, false]
-  -p, --port <PORT>
-          Port for the socket to listen on
-      --host <HOST>
-          Ip for the socket (if applicable) to listen for requests
-  -h, --help
-          Print help
-```
-
-### `import-credential`
-```
-Import a pre-generated credential
-
-Usage: nym-client import-credential --id <ID> <--credential-data <CREDENTIAL_DATA>|--credential-path <CREDENTIAL_PATH>>
-
-Options:
-      --id <ID>
-          Id of client that is going to import the credential
-      --credential-data <CREDENTIAL_DATA>
-          Explicitly provide the encoded credential data (as base58)
-      --credential-path <CREDENTIAL_PATH>
-          Specifies the path to file containing binary credential data
-  -h, --help
-          Print help
-```
-
-### `list-gateways`
-```
-List all registered with gateways
-
-Usage: nym-client list-gateways [OPTIONS] --id <ID>
-
-Options:
-      --id <ID>          Id of client we want to list gateways for
-  -o, --output <OUTPUT>  [default: text] [possible values: text, json]
-  -h, --help             Print help
-```
-
-### `switch-gateway`
-```
-Change the currently active gateway. Note that you must have already registered with the new gateway!
-
-Usage: nym-client switch-gateway --id <ID> --gateway-id <GATEWAY_ID>
-
-Options:
-      --id <ID>                  Id of client we want to list gateways for
-      --gateway-id <GATEWAY_ID>  Id of the gateway we want to switch to
-  -h, --help                     Print help
-```
-
-### `build-info`
-```
-Show build information of this binary
-
-Usage: nym-client build-info [OPTIONS]
-
-Options:
-  -o, --output <OUTPUT>  [default: text] [possible values: text, json]
-  -h, --help             Print help
-```
-Example output:
-```
-
-Binary Name:        nym-client
-Build Timestamp:    2024-05-07T13:11:43.523733081Z
-Build Version:      1.1.34
-Commit SHA:         7d233a4a2fc697a2f97e504db6a3765cc9f2dd49
-Commit Date:        2024-04-25T11:27:18.000000000+02:00
-Commit Branch:      max/auto-docs
-rustc Version:      1.78.0
-rustc Channel:      stable
-cargo Profile:      release
-
-```
-
-### `completions`
-```
-Generate shell completions
-
-Usage: nym-client completions <SHELL>
-
-Arguments:
-  <SHELL>  [possible values: bash, elvish, fish, power-shell, zsh]
-
-Options:
-  -h, --help  Print help
-```
-
-### `generate-fig-spec`
-```
-Generate Fig specification
-
-Usage: nym-client generate-fig-spec
-
-Options:
-  -h, --help  Print help
-```
-Example output:
-```
-const completion: Fig.Spec = {
-  name: "nym-native-client",
-  description: "Implementation of the Nym Client",
-  subcommands: [
-    {
-      name: "init",
-      description: "Initialise a Nym client. Do this first!",
-      options: [
-        {
-          name: "--id",
-          description: "Id of client we want to create config for",
-          isRepeatable: true,
-          args: {
-            name: "id",
-          },
-        },
-        {
-          name: "--gateway",
-          description: "Id of the gateway we are going to connect to",
-          isRepeatable: true,
-          args: {
-            name: "gateway",
-            isOptional: true,
-          },
-        },
-        {
-          name: "--nyxd-urls",
-          description: "Comma separated list of rest endpoints of the nyxd validators",
-          hidden: true,
-          isRepeatable: true,
-          args: {
-            name: "nyxd_urls",
-            isOptional: true,
-          },
-        },
-        {
-          name: "--nym-apis",
-          description: "Comma separated list of rest endpoints of the API validators",
-          isRepeatable: true,
-          args: {
-            name: "nym_apis",
-            isOptional: true,
-          },
-        },
-        {
-          name: "--custom-mixnet",
-          description: "Path to .json file containing custom network specification",
-          hidden: true,
-          isRepeatable: true,
-          args: {
-            name: "custom_mixnet",
-            isOptional: true,
-            template: "filepaths",
-          },
-        },
-        {
-          name: "--enabled-credentials-mode",
-          description: "Set this client to work in a enabled credentials mode that would attempt to use gateway with bandwidth credential requirement",
-          hidden: true,
-          isRepeatable: true,
-          args: {
-            name: "enabled_credentials_mode",
-            isOptional: true,
-            suggestions: [
-              "true",
-              "false",
-            ],
-          },
-        },
-        {
-          name: "--disable-socket",
-          description: "Whether to not start the websocket",
-          isRepeatable: true,
-          args: {
-            name: "disable_socket",
-            isOptional: true,
-            suggestions: [
-              "true",
-              "false",
-            ],
-          },
-        },
-        {
-          name: ["-p", "--port"],
-          description: "Port for the socket (if applicable) to listen on in all subsequent runs",
-          isRepeatable: true,
-          args: {
-            name: "port",
-            isOptional: true,
-          },
-        },
-        {
-          name: "--host",
-          description: "Ip for the socket (if applicable) to listen for requests",
-          isRepeatable: true,
-          args: {
-            name: "host",
-            isOptional: true,
-          },
-        },
-        {
-          name: ["-o", "--output"],
-          isRepeatable: true,
-          args: {
-            name: "output",
-            isOptional: true,
-            suggestions: [
-              "text",
-              "json",
-            ],
-          },
-        },
-        {
-          name: "--force-tls-gateway",
-          description: "Specifies whether the client will attempt to enforce tls connection to the desired gateway",
-        },
-        {
-          name: "--latency-based-selection",
-          description: "Specifies whether the new gateway should be determined based by latency as opposed to being chosen uniformly",
-          exclusiveOn: [
-            "--gateway",
-          ],
-        },
-        {
-          name: "--fastmode",
-          description: "Mostly debug-related option to increase default traffic rate so that you would not need to modify config post init",
-        },
-        {
-          name: "--no-cover",
-          description: "Disable loop cover traffic and the Poisson rate limiter (for debugging only)",
-        },
-        {
-          name: ["-h", "--help"],
-          description: "Print help",
-        },
-      ],
-    },
-    {
-      name: "run",
-      description: "Run the Nym client with provided configuration client optionally overriding set parameters",
-      options: [
-        {
-          name: "--id",
-          description: "Id of client we want to create config for",
-          isRepeatable: true,
-          args: {
-            name: "id",
-          },
-        },
-        {
-          name: "--gateway",
-          description: "Id of the gateway we want to connect to. If overridden, it is user's responsibility to ensure prior registration happened",
-          isRepeatable: true,
-          args: {
-            name: "gateway",
-            isOptional: true,
-          },
-        },
-        {
-          name: "--nyxd-urls",
-          description: "Comma separated list of rest endpoints of the nyxd validators",
-          hidden: true,
-          isRepeatable: true,
-          args: {
-            name: "nyxd_urls",
-            isOptional: true,
-          },
-        },
-        {
-          name: "--nym-apis",
-          description: "Comma separated list of rest endpoints of the API validators",
-          isRepeatable: true,
-          args: {
-            name: "nym_apis",
-            isOptional: true,
-          },
-        },
-        {
-          name: "--custom-mixnet",
-          description: "Path to .json file containing custom network specification",
-          hidden: true,
-          isRepeatable: true,
-          args: {
-            name: "custom_mixnet",
-            isOptional: true,
-            template: "filepaths",
-          },
-        },
-        {
-          name: "--enabled-credentials-mode",
-          description: "Set this client to work in a enabled credentials mode that would attempt to use gateway with bandwidth credential requirement",
-          hidden: true,
-          isRepeatable: true,
-          args: {
-            name: "enabled_credentials_mode",
-            isOptional: true,
-            suggestions: [
-              "true",
-              "false",
-            ],
-          },
-        },
-        {
-          name: "--disable-socket",
-          description: "Whether to not start the websocket",
-          isRepeatable: true,
-          args: {
-            name: "disable_socket",
-            isOptional: true,
-            suggestions: [
-              "true",
-              "false",
-            ],
-          },
-        },
-        {
-          name: ["-p", "--port"],
-          description: "Port for the socket to listen on",
-          isRepeatable: true,
-          args: {
-            name: "port",
-            isOptional: true,
-          },
-        },
-        {
-          name: "--host",
-          description: "Ip for the socket (if applicable) to listen for requests",
-          isRepeatable: true,
-          args: {
-            name: "host",
-            isOptional: true,
-          },
-        },
-        {
-          name: "--fastmode",
-          description: "Mostly debug-related option to increase default traffic rate so that you would not need to modify config post init",
-        },
-        {
-          name: "--no-cover",
-          description: "Disable loop cover traffic and the Poisson rate limiter (for debugging only)",
-        },
-        {
-          name: ["-h", "--help"],
-          description: "Print help",
-        },
-      ],
-    },
-    {
-      name: "import-credential",
-      description: "Import a pre-generated credential",
-      options: [
-        {
-          name: "--id",
-          description: "Id of client that is going to import the credential",
-          isRepeatable: true,
-          args: {
-            name: "id",
-          },
-        },
-        {
-          name: "--credential-data",
-          description: "Explicitly provide the encoded credential data (as base58)",
-          isRepeatable: true,
-          args: {
-            name: "credential_data",
-            isOptional: true,
-          },
-        },
-        {
-          name: "--credential-path",
-          description: "Specifies the path to file containing binary credential data",
-          isRepeatable: true,
-          args: {
-            name: "credential_path",
-            isOptional: true,
-            template: "filepaths",
-          },
-        },
-        {
-          name: "--version",
-          hidden: true,
-          isRepeatable: true,
-          args: {
-            name: "version",
-            isOptional: true,
-          },
-        },
-        {
-          name: ["-h", "--help"],
-          description: "Print help",
-        },
-      ],
-    },
-    {
-      name: "list-gateways",
-      description: "List all registered with gateways",
-      options: [
-        {
-          name: "--id",
-          description: "Id of client we want to list gateways for",
-          isRepeatable: true,
-          args: {
-            name: "id",
-          },
-        },
-        {
-          name: ["-o", "--output"],
-          isRepeatable: true,
-          args: {
-            name: "output",
-            isOptional: true,
-            suggestions: [
-              "text",
-              "json",
-            ],
-          },
-        },
-        {
-          name: ["-h", "--help"],
-          description: "Print help",
-        },
-      ],
-    },
-    {
-      name: "add-gateway",
-      description: "Add new gateway to this client",
-      options: [
-        {
-          name: "--id",
-          description: "Id of client we want to add gateway for",
-          isRepeatable: true,
-          args: {
-            name: "id",
-          },
-        },
-        {
-          name: "--gateway-id",
-          description: "Explicitly specify id of the gateway to register with. If unspecified, a random gateway will be chosen instead",
-          isRepeatable: true,
-          args: {
-            name: "gateway_id",
-            isOptional: true,
-          },
-        },
-        {
-          name: "--nym-apis",
-          description: "Comma separated list of rest endpoints of the API validators",
-          isRepeatable: true,
-          args: {
-            name: "nym_apis",
-            isOptional: true,
-          },
-        },
-        {
-          name: "--custom-mixnet",
-          description: "Path to .json file containing custom network specification",
-          hidden: true,
-          isRepeatable: true,
-          args: {
-            name: "custom_mixnet",
-            isOptional: true,
-            template: "filepaths",
-          },
-        },
-        {
-          name: ["-o", "--output"],
-          isRepeatable: true,
-          args: {
-            name: "output",
-            isOptional: true,
-            suggestions: [
-              "text",
-              "json",
-            ],
-          },
-        },
-        {
-          name: "--force-tls-gateway",
-          description: "Specifies whether the client will attempt to enforce tls connection to the desired gateway",
-        },
-        {
-          name: "--latency-based-selection",
-          description: "Specifies whether the new gateway should be determined based by latency as opposed to being chosen uniformly",
-          exclusiveOn: [
-            "--gateway-id",
-          ],
-        },
-        {
-          name: "--set-active",
-          description: "Specify whether this new gateway should be set as the active one",
-        },
-        {
-          name: ["-h", "--help"],
-          description: "Print help",
-        },
-      ],
-    },
-    {
-      name: "switch-gateway",
-      description: "Change the currently active gateway. Note that you must have already registered with the new gateway!",
-      options: [
-        {
-          name: "--id",
-          description: "Id of client we want to list gateways for",
-          isRepeatable: true,
-          args: {
-            name: "id",
-          },
-        },
-        {
-          name: "--gateway-id",
-          description: "Id of the gateway we want to switch to",
-          isRepeatable: true,
-          args: {
-            name: "gateway_id",
-          },
-        },
-        {
-          name: ["-h", "--help"],
-          description: "Print help",
-        },
-      ],
-    },
-    {
-      name: "build-info",
-      description: "Show build information of this binary",
-      options: [
-        {
-          name: ["-o", "--output"],
-          isRepeatable: true,
-          args: {
-            name: "output",
-            isOptional: true,
-            suggestions: [
-              "text",
-              "json",
-            ],
-          },
-        },
-        {
-          name: ["-h", "--help"],
-          description: "Print help",
-        },
-      ],
-    },
-    {
-      name: "completions",
-      description: "Generate shell completions",
-      options: [
-        {
-          name: ["-h", "--help"],
-          description: "Print help",
-        },
-      ],
-      args: {
-        name: "shell",
-        suggestions: [
-          "bash",
-          "elvish",
-          "fish",
-          "power-shell",
-          "zsh",
-        ],
-      },
-    },
-    {
-      name: "generate-fig-spec",
-      description: "Generate Fig specification",
-      options: [
-        {
-          name: ["-h", "--help"],
-          description: "Print help",
-        },
-      ],
-    },
-    {
-      name: "help",
-      description: "Print this message or the help of the given subcommand(s)",
-      subcommands: [
-        {
-          name: "init",
-          description: "Initialise a Nym client. Do this first!",
-        },
-        {
-          name: "run",
-          description: "Run the Nym client with provided configuration client optionally overriding set parameters",
-        },
-        {
-          name: "import-credential",
-          description: "Import a pre-generated credential",
-        },
-        {
-          name: "list-gateways",
-          description: "List all registered with gateways",
-        },
-        {
-          name: "add-gateway",
-          description: "Add new gateway to this client",
-        },
-        {
-          name: "switch-gateway",
-          description: "Change the currently active gateway. Note that you must have already registered with the new gateway!",
-        },
-        {
-          name: "build-info",
-          description: "Show build information of this binary",
-        },
-        {
-          name: "completions",
-          description: "Generate shell completions",
-        },
-        {
-          name: "generate-fig-spec",
-          description: "Generate Fig specification",
-        },
-        {
-          name: "help",
-          description: "Print this message or the help of the given subcommand(s)",
-        },
-      ],
-    },
-  ],
-  options: [
-    {
-      name: ["-c", "--config-env-file"],
-      description: "Path pointing to an env file that configures the client",
-      isRepeatable: true,
-      args: {
-        name: "config_env_file",
-        isOptional: true,
-        template: "filepaths",
-      },
-    },
-    {
-      name: "--no-banner",
-      description: "Flag used for disabling the printed banner in tty",
-    },
-    {
-      name: ["-h", "--help"],
-      description: "Print help",
-    },
-    {
-      name: ["-V", "--version"],
-      description: "Print version",
-    },
-  ],
-};
-
-export default completion;
-```
@@ -1,227 +0,0 @@
-# `nym-node` Binary Commands
-
-These docs are autogenerated by the `autodocs` script. 
-            
-**TODO add link**
-```
-Usage: nym-node [OPTIONS] <COMMAND>
-
-Commands:
-  build-info           Show build information of this binary
-  bonding-information  Show bonding information of this node depending on its currently selected mode
-  node-details         Show details of this node
-  migrate              Attempt to migrate an existing mixnode or gateway into a nym-node
-  run                  Start this nym-node
-  sign                 Use identity key of this node to sign provided message
-  help                 Print this message or the help of the given subcommand(s)
-
-Options:
-  -c, --config-env-file <CONFIG_ENV_FILE>
-          Path pointing to an env file that configures the nym-node and overrides any preconfigured values [env: NYMNODE_CONFIG_ENV_FILE_ARG=]
-      --no-banner
-          Flag used for disabling the printed banner in tty [env: NYMNODE_NO_BANNER=]
-  -h, --help
-          Print help
-  -V, --version
-          Print version
-```
-
-### `build-info`
-```
-Show build information of this binary
-
-Usage: nym-node build-info [OPTIONS]
-
-Options:
-  -o, --output <OUTPUT>  [default: text] [possible values: text, json]
-  -h, --help             Print help
-```
-
-### `bonding-information`
-```
-Show bonding information of this node depending on its currently selected mode
-
-Usage: nym-node bonding-information [OPTIONS]
-
-Options:
-      --id <ID>                    Id of the nym-node to use [env: NYMNODE_ID=] [default: default-nym-node]
-      --config-file <CONFIG_FILE>  Path to a configuration file of this node [env: NYMNODE_CONFIG=]
-      --mode <MODE>                [env: NYMNODE_MODE=] [possible values: mixnode, entry-gateway, exit-gateway]
-  -o, --output <OUTPUT>            Specify the output format of the bonding information (`text` or `json`) [default: text] [possible values: text, json]
-  -h, --help                       Print help
-```
-
-### `node-details`
-```
-Show details of this node
-
-Usage: nym-node node-details [OPTIONS]
-
-Options:
-      --id <ID>                    Id of the nym-node to use [env: NYMNODE_ID=] [default: default-nym-node]
-      --config-file <CONFIG_FILE>  Path to a configuration file of this node [env: NYMNODE_CONFIG=]
-  -o, --output <OUTPUT>            Specify the output format of the node details (`text` or `json`) [default: text] [possible values: text, json]
-  -h, --help                       Print help
-```
-
-### `migrate`
-```
-Attempt to migrate an existing mixnode or gateway into a nym-node
-
-Usage: nym-node migrate [OPTIONS] <--id <ID>|--config-file <CONFIG_FILE>> <NODE_TYPE>
-
-Arguments:
-  <NODE_TYPE>  Type of node (mixnode or gateway) to migrate into a nym-node [possible values: mixnode, gateway]
-
-Options:
-      --id <ID>
-          Id of the node that's going to get migrated
-      --config-file <CONFIG_FILE>
-          Path to a configuration file of the node that's going to get migrated
-      --preserve-id
-          Specify whether to preserve id of the imported node
-      --public-ips <PUBLIC_IPS>
-          Comma separated list of public ip addresses that will be announced to the nym-api and subsequently to the clients. In nearly all circumstances, it's going to be identical to the address you're going to use for bonding [env: NYMNODE_PUBLIC_IPS=]
-      --hostname <HOSTNAME>
-          Optional hostname associated with this gateway that will be announced to the nym-api and subsequently to the clients [env: NYMNODE_HOSTNAME=]
-      --location <LOCATION>
-          Optional **physical** location of this node's server. Either full country name (e.g. 'Poland'), two-letter alpha2 (e.g. 'PL'), three-letter alpha3 (e.g. 'POL') or three-digit numeric-3 (e.g. '616') can be provided [env: NYMNODE_LOCATION=]
-      --http-bind-address <HTTP_BIND_ADDRESS>
-          Socket address this node will use for binding its http API. default: `0.0.0.0:8080` [env: NYMNODE_HTTP_BIND_ADDRESS=]
-      --landing-page-assets-path <LANDING_PAGE_ASSETS_PATH>
-          Path to assets directory of custom landing page of this node [env: NYMNODE_HTTP_LANDING_ASSETS=]
-      --http-access-token <HTTP_ACCESS_TOKEN>
-          An optional bearer token for accessing certain http endpoints. Currently only used for prometheus metrics [env: NYMNODE_HTTP_ACCESS_TOKEN=]
-      --expose-system-info <EXPOSE_SYSTEM_INFO>
-          Specify whether basic system information should be exposed. default: true [env: NYMNODE_HTTP_EXPOSE_SYSTEM_INFO=] [possible values: true, false]
-      --expose-system-hardware <EXPOSE_SYSTEM_HARDWARE>
-          Specify whether basic system hardware information should be exposed. default: true [env: NYMNODE_HTTP_EXPOSE_SYSTEM_HARDWARE=] [possible values: true, false]
-      --expose-crypto-hardware <EXPOSE_CRYPTO_HARDWARE>
-          Specify whether detailed system crypto hardware information should be exposed. default: true [env: NYMNODE_HTTP_EXPOSE_CRYPTO_HARDWARE=] [possible values: true, false]
-      --mixnet-bind-address <MIXNET_BIND_ADDRESS>
-          Address this node will bind to for listening for mixnet packets default: `0.0.0.0:1789` [env: NYMNODE_MIXNET_BIND_ADDRESS=]
-      --nym-api-urls <NYM_API_URLS>
-          Addresses to nym APIs from which the node gets the view of the network [env: NYMNODE_NYM_APIS=]
-      --nyxd-urls <NYXD_URLS>
-          Addresses to nyxd chain endpoint which the node will use for chain interactions [env: NYMNODE_NYXD=]
-      --wireguard-enabled <WIREGUARD_ENABLED>
-          Specifies whether the wireguard service is enabled on this node [env: NYMNODE_WG_ENABLED=] [possible values: true, false]
-      --wireguard-bind-address <WIREGUARD_BIND_ADDRESS>
-          Socket address this node will use for binding its wireguard interface. default: `0.0.0.0:51822` [env: NYMNODE_WG_BIND_ADDRESS=]
-      --wireguard-private-network-ip <WIREGUARD_PRIVATE_NETWORK_IP>
-          Ip address of the private wireguard network. default: `10.1.0.0` [env: NYMNODE_WG_IP_NETWORK=]
-      --wireguard-announced-port <WIREGUARD_ANNOUNCED_PORT>
-          Port announced to external clients wishing to connect to the wireguard interface. Useful in the instances where the node is behind a proxy [env: NYMNODE_WG_ANNOUNCED_PORT=]
-      --wireguard-private-network-prefix <WIREGUARD_PRIVATE_NETWORK_PREFIX>
-          The prefix denoting the maximum number of the clients that can be connected via Wireguard. The maximum value for IPv4 is 32 and for IPv6 is 128 [env: NYMNODE_WG_PRIVATE_NETWORK_PREFIX=]
-      --verloc-bind-address <VERLOC_BIND_ADDRESS>
-          Socket address this node will use for binding its verloc API. default: `0.0.0.0:1790` [env: NYMNODE_VERLOC_BIND_ADDRESS=]
-      --entry-bind-address <ENTRY_BIND_ADDRESS>
-          Socket address this node will use for binding its client websocket API. default: `0.0.0.0:9000` [env: NYMNODE_ENTRY_BIND_ADDRESS=]
-      --announce-ws-port <ANNOUNCE_WS_PORT>
-          Custom announced port for listening for websocket client traffic. If unspecified, the value from the `bind_address` will be used instead [env: NYMNODE_ENTRY_ANNOUNCE_WS_PORT=]
-      --announce-wss-port <ANNOUNCE_WSS_PORT>
-          If applicable, announced port for listening for secure websocket client traffic [env: NYMNODE_ENTRY_ANNOUNCE_WSS_PORT=]
-      --enforce-zk-nyms <ENFORCE_ZK_NYMS>
-          Indicates whether this gateway is accepting only coconut credentials for accessing the mixnet or if it also accepts non-paying clients [env: NYMNODE_ENFORCE_ZK_NYMS=] [possible values: true, false]
-      --mnemonic <MNEMONIC>
-          Custom cosmos wallet mnemonic used for zk-nym redemption. If no value is provided, a fresh mnemonic is going to be generated [env: NYMNODE_MNEMONIC=]
-      --upstream-exit-policy-url <UPSTREAM_EXIT_POLICY_URL>
-          Specifies the url for an upstream source of the exit policy used by this node [env: NYMNODE_UPSTREAM_EXIT_POLICY=]
-      --open-proxy <OPEN_PROXY>
-          Specifies whether this exit node should run in 'open-proxy' mode and thus would attempt to resolve **ANY** request it receives [env: NYMNODE_OPEN_PROXY=] [possible values: true, false]
-  -h, --help
-          Print help
-```
-
-### `run`
-```
-Start this nym-node
-
-Usage: nym-node run [OPTIONS]
-
-Options:
-      --id <ID>
-          Id of the nym-node to use [env: NYMNODE_ID=] [default: default-nym-node]
-      --config-file <CONFIG_FILE>
-          Path to a configuration file of this node [env: NYMNODE_CONFIG=]
-      --deny-init
-          Forbid a new node from being initialised if configuration file for the provided specification doesn't already exist [env: NYMNODE_DENY_INIT=]
-      --init-only
-          If this is a brand new nym-node, specify whether it should only be initialised without actually running the subprocesses [env: NYMNODE_INIT_ONLY=]
-      --mode <MODE>
-          Specifies the current mode of this nym-node [env: NYMNODE_MODE=] [possible values: mixnode, entry-gateway, exit-gateway]
-  -w, --write-changes
-          If this node has been initialised before, specify whether to write any new changes to the config file [env: NYMNODE_WRITE_CONFIG_CHANGES=]
-      --bonding-information-output <BONDING_INFORMATION_OUTPUT>
-          Specify output file for bonding information of this nym-node, i.e. its encoded keys. NOTE: the required bonding information is still a subject to change and this argument should be treated only as a preview of future features [env: NYMNODE_BONDING_INFORMATION_OUTPUT=]
-  -o, --output <OUTPUT>
-          Specify the output format of the bonding information (`text` or `json`) [env: NYMNODE_OUTPUT=] [default: text] [possible values: text, json]
-      --public-ips <PUBLIC_IPS>
-          Comma separated list of public ip addresses that will be announced to the nym-api and subsequently to the clients. In nearly all circumstances, it's going to be identical to the address you're going to use for bonding [env: NYMNODE_PUBLIC_IPS=]
-      --hostname <HOSTNAME>
-          Optional hostname associated with this gateway that will be announced to the nym-api and subsequently to the clients [env: NYMNODE_HOSTNAME=]
-      --location <LOCATION>
-          Optional **physical** location of this node's server. Either full country name (e.g. 'Poland'), two-letter alpha2 (e.g. 'PL'), three-letter alpha3 (e.g. 'POL') or three-digit numeric-3 (e.g. '616') can be provided [env: NYMNODE_LOCATION=]
-      --http-bind-address <HTTP_BIND_ADDRESS>
-          Socket address this node will use for binding its http API. default: `0.0.0.0:8080` [env: NYMNODE_HTTP_BIND_ADDRESS=]
-      --landing-page-assets-path <LANDING_PAGE_ASSETS_PATH>
-          Path to assets directory of custom landing page of this node [env: NYMNODE_HTTP_LANDING_ASSETS=]
-      --http-access-token <HTTP_ACCESS_TOKEN>
-          An optional bearer token for accessing certain http endpoints. Currently only used for prometheus metrics [env: NYMNODE_HTTP_ACCESS_TOKEN=]
-      --expose-system-info <EXPOSE_SYSTEM_INFO>
-          Specify whether basic system information should be exposed. default: true [env: NYMNODE_HTTP_EXPOSE_SYSTEM_INFO=] [possible values: true, false]
-      --expose-system-hardware <EXPOSE_SYSTEM_HARDWARE>
-          Specify whether basic system hardware information should be exposed. default: true [env: NYMNODE_HTTP_EXPOSE_SYSTEM_HARDWARE=] [possible values: true, false]
-      --expose-crypto-hardware <EXPOSE_CRYPTO_HARDWARE>
-          Specify whether detailed system crypto hardware information should be exposed. default: true [env: NYMNODE_HTTP_EXPOSE_CRYPTO_HARDWARE=] [possible values: true, false]
-      --mixnet-bind-address <MIXNET_BIND_ADDRESS>
-          Address this node will bind to for listening for mixnet packets default: `0.0.0.0:1789` [env: NYMNODE_MIXNET_BIND_ADDRESS=]
-      --nym-api-urls <NYM_API_URLS>
-          Addresses to nym APIs from which the node gets the view of the network [env: NYMNODE_NYM_APIS=]
-      --nyxd-urls <NYXD_URLS>
-          Addresses to nyxd chain endpoint which the node will use for chain interactions [env: NYMNODE_NYXD=]
-      --wireguard-enabled <WIREGUARD_ENABLED>
-          Specifies whether the wireguard service is enabled on this node [env: NYMNODE_WG_ENABLED=] [possible values: true, false]
-      --wireguard-bind-address <WIREGUARD_BIND_ADDRESS>
-          Socket address this node will use for binding its wireguard interface. default: `0.0.0.0:51822` [env: NYMNODE_WG_BIND_ADDRESS=]
-      --wireguard-private-network-ip <WIREGUARD_PRIVATE_NETWORK_IP>
-          Ip address of the private wireguard network. default: `10.1.0.0` [env: NYMNODE_WG_IP_NETWORK=]
-      --wireguard-announced-port <WIREGUARD_ANNOUNCED_PORT>
-          Port announced to external clients wishing to connect to the wireguard interface. Useful in the instances where the node is behind a proxy [env: NYMNODE_WG_ANNOUNCED_PORT=]
-      --wireguard-private-network-prefix <WIREGUARD_PRIVATE_NETWORK_PREFIX>
-          The prefix denoting the maximum number of the clients that can be connected via Wireguard. The maximum value for IPv4 is 32 and for IPv6 is 128 [env: NYMNODE_WG_PRIVATE_NETWORK_PREFIX=]
-      --verloc-bind-address <VERLOC_BIND_ADDRESS>
-          Socket address this node will use for binding its verloc API. default: `0.0.0.0:1790` [env: NYMNODE_VERLOC_BIND_ADDRESS=]
-      --entry-bind-address <ENTRY_BIND_ADDRESS>
-          Socket address this node will use for binding its client websocket API. default: `0.0.0.0:9000` [env: NYMNODE_ENTRY_BIND_ADDRESS=]
-      --announce-ws-port <ANNOUNCE_WS_PORT>
-          Custom announced port for listening for websocket client traffic. If unspecified, the value from the `bind_address` will be used instead [env: NYMNODE_ENTRY_ANNOUNCE_WS_PORT=]
-      --announce-wss-port <ANNOUNCE_WSS_PORT>
-          If applicable, announced port for listening for secure websocket client traffic [env: NYMNODE_ENTRY_ANNOUNCE_WSS_PORT=]
-      --enforce-zk-nyms <ENFORCE_ZK_NYMS>
-          Indicates whether this gateway is accepting only coconut credentials for accessing the mixnet or if it also accepts non-paying clients [env: NYMNODE_ENFORCE_ZK_NYMS=] [possible values: true, false]
-      --mnemonic <MNEMONIC>
-          Custom cosmos wallet mnemonic used for zk-nym redemption. If no value is provided, a fresh mnemonic is going to be generated [env: NYMNODE_MNEMONIC=]
-      --upstream-exit-policy-url <UPSTREAM_EXIT_POLICY_URL>
-          Specifies the url for an upstream source of the exit policy used by this node [env: NYMNODE_UPSTREAM_EXIT_POLICY=]
-      --open-proxy <OPEN_PROXY>
-          Specifies whether this exit node should run in 'open-proxy' mode and thus would attempt to resolve **ANY** request it receives [env: NYMNODE_OPEN_PROXY=] [possible values: true, false]
-  -h, --help
-          Print help
-```
-
-### `sign`
-```
-Use identity key of this node to sign provided message
-
-Usage: nym-node sign [OPTIONS] <--text <TEXT>|--contract-msg <CONTRACT_MSG>>
-
-Options:
-      --id <ID>                      Id of the nym-node to use [env: NYMNODE_ID=] [default: default-nym-node]
-      --config-file <CONFIG_FILE>    Path to a configuration file of this node [env: NYMNODE_CONFIG=]
-      --text <TEXT>                  Signs an arbitrary piece of text with your identity key
-      --contract-msg <CONTRACT_MSG>  Signs a transaction-specific payload, that is going to be sent to the smart contract, with your identity key
-  -o, --output <OUTPUT>              [default: text] [possible values: text, json]
-  -h, --help                         Print help
-```
@@ -1,790 +0,0 @@
-# `nym-socks5-client` Binary Commands
-
-These docs are autogenerated by the `autodocs` script. 
-            
-**TODO add link**
-```
-A SOCKS5 localhost proxy that converts incoming messages to Sphinx and sends them to a Nym address
-
-Usage: nym-socks5-client [OPTIONS] <COMMAND>
-
-Commands:
-  init               Initialise a Nym client. Do this first!
-  run                Run the Nym client with provided configuration client optionally overriding set parameters
-  import-credential  Import a pre-generated credential
-  list-gateways      List all registered with gateways
-  add-gateway        Add new gateway to this client
-  switch-gateway     Change the currently active gateway. Note that you must have already registered with the new gateway!
-  build-info         Show build information of this binary
-  completions        Generate shell completions
-  generate-fig-spec  Generate Fig specification
-  help               Print this message or the help of the given subcommand(s)
-
-Options:
-  -c, --config-env-file <CONFIG_ENV_FILE>  Path pointing to an env file that configures the client
-      --no-banner                          Flag used for disabling the printed banner in tty
-  -h, --help                               Print help
-  -V, --version                            Print version
-```
-
-### `init`
-```
-Initialise a Nym client. Do this first!
-
-Usage: nym-socks5-client init [OPTIONS] --id <ID> --provider <PROVIDER>
-
-Options:
-      --id <ID>
-          Id of client we want to create config for
-
-      --gateway <GATEWAY>
-          Id of the gateway we are going to connect to
-
-      --force-tls-gateway
-          Specifies whether the client will attempt to enforce tls connection to the desired gateway
-
-      --latency-based-selection
-          Specifies whether the new gateway should be determined based by latency as opposed to being chosen uniformly
-
-      --nym-apis <NYM_APIS>
-          Comma separated list of rest endpoints of the API validators
-
-      --provider <PROVIDER>
-          Address of the socks5 provider to send messages to
-
-      --use-reply-surbs <USE_REPLY_SURBS>
-          Specifies whether this client is going to use an anonymous sender tag for communication with the service provider. While this is going to hide its actual address information, it will make the actual communication slower and consume nearly double the bandwidth as it will require sending reply SURBs.
-          
-          Note that some service providers might not support this.
-          
-          [possible values: true, false]
-
-  -p, --port <PORT>
-          Port for the socket to listen on in all subsequent runs
-
-      --host <HOST>
-          The custom host on which the socks5 client will be listening for requests
-
-  -o, --output <OUTPUT>
-          [default: text]
-          [possible values: text, json]
-
-  -h, --help
-          Print help (see a summary with '-h')
-```
-
-### `run`
-```
-Run the Nym client with provided configuration client optionally overriding set parameters
-
-Usage: nym-socks5-client run [OPTIONS] --id <ID>
-
-Options:
-      --id <ID>
-          Id of client we want to create config for
-
-      --gateway <GATEWAY>
-          Id of the gateway we want to connect to. If overridden, it is user's responsibility to ensure prior registration happened
-
-      --nym-apis <NYM_APIS>
-          Comma separated list of rest endpoints of the API validators
-
-      --use-anonymous-replies <USE_ANONYMOUS_REPLIES>
-          Specifies whether this client is going to use an anonymous sender tag for communication with the service provider. While this is going to hide its actual address information, it will make the actual communication slower and consume nearly double the bandwidth as it will require sending reply SURBs.
-          
-          Note that some service providers might not support this.
-          
-          [possible values: true, false]
-
-      --provider <PROVIDER>
-          Address of the socks5 provider to send messages to
-
-  -p, --port <PORT>
-          Port for the socket to listen on
-
-      --host <HOST>
-          The custom host on which the socks5 client will be listening for requests
-
-  -h, --help
-          Print help (see a summary with '-h')
-```
-
-### `import-credential`
-```
-Import a pre-generated credential
-
-Usage: nym-socks5-client import-credential --id <ID> <--credential-data <CREDENTIAL_DATA>|--credential-path <CREDENTIAL_PATH>>
-
-Options:
-      --id <ID>
-          Id of client that is going to import the credential
-      --credential-data <CREDENTIAL_DATA>
-          Explicitly provide the encoded credential data (as base58)
-      --credential-path <CREDENTIAL_PATH>
-          Specifies the path to file containing binary credential data
-  -h, --help
-          Print help
-```
-
-### `list-gateways`
-```
-List all registered with gateways
-
-Usage: nym-socks5-client list-gateways [OPTIONS] --id <ID>
-
-Options:
-      --id <ID>          Id of client we want to list gateways for
-  -o, --output <OUTPUT>  [default: text] [possible values: text, json]
-  -h, --help             Print help
-```
-
-### `add-gateway`
-```
-Add new gateway to this client
-
-Usage: nym-socks5-client add-gateway [OPTIONS] --id <ID>
-
-Options:
-      --id <ID>                  Id of client we want to add gateway for
-      --gateway-id <GATEWAY_ID>  Explicitly specify id of the gateway to register with. If unspecified, a random gateway will be chosen instead
-      --force-tls-gateway        Specifies whether the client will attempt to enforce tls connection to the desired gateway
-      --latency-based-selection  Specifies whether the new gateway should be determined based by latency as opposed to being chosen uniformly
-      --set-active               Specify whether this new gateway should be set as the active one
-      --nym-apis <NYM_APIS>      Comma separated list of rest endpoints of the API validators
-  -o, --output <OUTPUT>          [default: text] [possible values: text, json]
-  -h, --help                     Print help
-```
-
-### `build-info`
-```
-Show build information of this binary
-
-Usage: nym-socks5-client build-info [OPTIONS]
-
-Options:
-  -o, --output <OUTPUT>  [default: text] [possible values: text, json]
-  -h, --help             Print help
-```
-Example output:
-```
-
-Binary Name:        nym-socks5-client
-Build Timestamp:    2024-05-07T13:11:43.523733081Z
-Build Version:      1.1.34
-Commit SHA:         7d233a4a2fc697a2f97e504db6a3765cc9f2dd49
-Commit Date:        2024-04-25T11:27:18.000000000+02:00
-Commit Branch:      max/auto-docs
-rustc Version:      1.78.0
-rustc Channel:      stable
-cargo Profile:      release
-
-```
-
-### `completions`
-```
-Generate shell completions
-
-Usage: nym-socks5-client completions <SHELL>
-
-Arguments:
-  <SHELL>  [possible values: bash, elvish, fish, power-shell, zsh]
-
-Options:
-  -h, --help  Print help
-```
-
-### `generate-fig-spec`
-```
-Generate Fig specification
-
-Usage: nym-socks5-client generate-fig-spec
-
-Options:
-  -h, --help  Print help
-```
-Example output:
-```
-const completion: Fig.Spec = {
-  name: "nym-socks5-client",
-  description: "A SOCKS5 localhost proxy that converts incoming messages to Sphinx and sends them to a Nym address",
-  subcommands: [
-    {
-      name: "init",
-      description: "Initialise a Nym client. Do this first!",
-      options: [
-        {
-          name: "--id",
-          description: "Id of client we want to create config for",
-          isRepeatable: true,
-          args: {
-            name: "id",
-          },
-        },
-        {
-          name: "--gateway",
-          description: "Id of the gateway we are going to connect to",
-          isRepeatable: true,
-          args: {
-            name: "gateway",
-            isOptional: true,
-          },
-        },
-        {
-          name: "--nyxd-urls",
-          description: "Comma separated list of rest endpoints of the nyxd validators",
-          hidden: true,
-          isRepeatable: true,
-          args: {
-            name: "nyxd_urls",
-            isOptional: true,
-          },
-        },
-        {
-          name: "--nym-apis",
-          description: "Comma separated list of rest endpoints of the API validators",
-          isRepeatable: true,
-          args: {
-            name: "nym_apis",
-            isOptional: true,
-          },
-        },
-        {
-          name: "--custom-mixnet",
-          description: "Path to .json file containing custom network specification",
-          hidden: true,
-          isRepeatable: true,
-          args: {
-            name: "custom_mixnet",
-            isOptional: true,
-            template: "filepaths",
-          },
-        },
-        {
-          name: "--enabled-credentials-mode",
-          description: "Set this client to work in a enabled credentials mode that would attempt to use gateway with bandwidth credential requirement",
-          hidden: true,
-          isRepeatable: true,
-          args: {
-            name: "enabled_credentials_mode",
-            isOptional: true,
-            suggestions: [
-              "true",
-              "false",
-            ],
-          },
-        },
-        {
-          name: "--provider",
-          description: "Address of the socks5 provider to send messages to",
-          isRepeatable: true,
-          args: {
-            name: "provider",
-          },
-        },
-        {
-          name: "--use-reply-surbs",
-          description: "Specifies whether this client is going to use an anonymous sender tag for communication with the service provider. While this is going to hide its actual address information, it will make the actual communication slower and consume nearly double the bandwidth as it will require sending reply SURBs",
-          isRepeatable: true,
-          args: {
-            name: "use_reply_surbs",
-            isOptional: true,
-            suggestions: [
-              "true",
-              "false",
-            ],
-          },
-        },
-        {
-          name: ["-p", "--port"],
-          description: "Port for the socket to listen on in all subsequent runs",
-          isRepeatable: true,
-          args: {
-            name: "port",
-            isOptional: true,
-          },
-        },
-        {
-          name: "--host",
-          description: "The custom host on which the socks5 client will be listening for requests",
-          isRepeatable: true,
-          args: {
-            name: "host",
-            isOptional: true,
-          },
-        },
-        {
-          name: ["-o", "--output"],
-          isRepeatable: true,
-          args: {
-            name: "output",
-            isOptional: true,
-            suggestions: [
-              "text",
-              "json",
-            ],
-          },
-        },
-        {
-          name: "--force-tls-gateway",
-          description: "Specifies whether the client will attempt to enforce tls connection to the desired gateway",
-        },
-        {
-          name: "--latency-based-selection",
-          description: "Specifies whether the new gateway should be determined based by latency as opposed to being chosen uniformly",
-          exclusiveOn: [
-            "--gateway",
-          ],
-        },
-        {
-          name: "--fastmode",
-          description: "Mostly debug-related option to increase default traffic rate so that you would not need to modify config post init",
-        },
-        {
-          name: "--no-cover",
-          description: "Disable loop cover traffic and the Poisson rate limiter (for debugging only)",
-        },
-        {
-          name: ["-h", "--help"],
-          description: "Print help (see more with '--help')",
-        },
-      ],
-    },
-    {
-      name: "run",
-      description: "Run the Nym client with provided configuration client optionally overriding set parameters",
-      options: [
-        {
-          name: "--id",
-          description: "Id of client we want to create config for",
-          isRepeatable: true,
-          args: {
-            name: "id",
-          },
-        },
-        {
-          name: "--gateway",
-          description: "Id of the gateway we want to connect to. If overridden, it is user's responsibility to ensure prior registration happened",
-          isRepeatable: true,
-          args: {
-            name: "gateway",
-            isOptional: true,
-          },
-        },
-        {
-          name: "--nyxd-urls",
-          description: "Comma separated list of rest endpoints of the nyxd validators",
-          hidden: true,
-          isRepeatable: true,
-          args: {
-            name: "nyxd_urls",
-            isOptional: true,
-          },
-        },
-        {
-          name: "--nym-apis",
-          description: "Comma separated list of rest endpoints of the API validators",
-          isRepeatable: true,
-          args: {
-            name: "nym_apis",
-            isOptional: true,
-          },
-        },
-        {
-          name: "--custom-mixnet",
-          description: "Path to .json file containing custom network specification",
-          hidden: true,
-          isRepeatable: true,
-          args: {
-            name: "custom_mixnet",
-            isOptional: true,
-            template: "filepaths",
-          },
-        },
-        {
-          name: "--enabled-credentials-mode",
-          description: "Set this client to work in a enabled credentials mode that would attempt to use gateway with bandwidth credential requirement",
-          hidden: true,
-          isRepeatable: true,
-          args: {
-            name: "enabled_credentials_mode",
-            isOptional: true,
-            suggestions: [
-              "true",
-              "false",
-            ],
-          },
-        },
-        {
-          name: "--use-anonymous-replies",
-          description: "Specifies whether this client is going to use an anonymous sender tag for communication with the service provider. While this is going to hide its actual address information, it will make the actual communication slower and consume nearly double the bandwidth as it will require sending reply SURBs",
-          isRepeatable: true,
-          args: {
-            name: "use_anonymous_replies",
-            isOptional: true,
-            suggestions: [
-              "true",
-              "false",
-            ],
-          },
-        },
-        {
-          name: "--provider",
-          description: "Address of the socks5 provider to send messages to",
-          isRepeatable: true,
-          args: {
-            name: "provider",
-            isOptional: true,
-          },
-        },
-        {
-          name: ["-p", "--port"],
-          description: "Port for the socket to listen on",
-          isRepeatable: true,
-          args: {
-            name: "port",
-            isOptional: true,
-          },
-        },
-        {
-          name: "--host",
-          description: "The custom host on which the socks5 client will be listening for requests",
-          isRepeatable: true,
-          args: {
-            name: "host",
-            isOptional: true,
-          },
-        },
-        {
-          name: "--geo-routing",
-          description: "Set geo-aware mixnode selection when sending mixnet traffic, for experiments only",
-          hidden: true,
-          isRepeatable: true,
-          args: {
-            name: "geo_routing",
-            isOptional: true,
-          },
-        },
-        {
-          name: "--fastmode",
-          description: "Mostly debug-related option to increase default traffic rate so that you would not need to modify config post init",
-        },
-        {
-          name: "--no-cover",
-          description: "Disable loop cover traffic and the Poisson rate limiter (for debugging only)",
-        },
-        {
-          name: "--medium-toggle",
-          description: "Enable medium mixnet traffic, for experiments only. This includes things like disabling cover traffic, no per hop delays, etc",
-        },
-        {
-          name: "--outfox",
-        },
-        {
-          name: ["-h", "--help"],
-          description: "Print help (see more with '--help')",
-        },
-      ],
-    },
-    {
-      name: "import-credential",
-      description: "Import a pre-generated credential",
-      options: [
-        {
-          name: "--id",
-          description: "Id of client that is going to import the credential",
-          isRepeatable: true,
-          args: {
-            name: "id",
-          },
-        },
-        {
-          name: "--credential-data",
-          description: "Explicitly provide the encoded credential data (as base58)",
-          isRepeatable: true,
-          args: {
-            name: "credential_data",
-            isOptional: true,
-          },
-        },
-        {
-          name: "--credential-path",
-          description: "Specifies the path to file containing binary credential data",
-          isRepeatable: true,
-          args: {
-            name: "credential_path",
-            isOptional: true,
-            template: "filepaths",
-          },
-        },
-        {
-          name: "--version",
-          hidden: true,
-          isRepeatable: true,
-          args: {
-            name: "version",
-            isOptional: true,
-          },
-        },
-        {
-          name: ["-h", "--help"],
-          description: "Print help",
-        },
-      ],
-    },
-    {
-      name: "list-gateways",
-      description: "List all registered with gateways",
-      options: [
-        {
-          name: "--id",
-          description: "Id of client we want to list gateways for",
-          isRepeatable: true,
-          args: {
-            name: "id",
-          },
-        },
-        {
-          name: ["-o", "--output"],
-          isRepeatable: true,
-          args: {
-            name: "output",
-            isOptional: true,
-            suggestions: [
-              "text",
-              "json",
-            ],
-          },
-        },
-        {
-          name: ["-h", "--help"],
-          description: "Print help",
-        },
-      ],
-    },
-    {
-      name: "add-gateway",
-      description: "Add new gateway to this client",
-      options: [
-        {
-          name: "--id",
-          description: "Id of client we want to add gateway for",
-          isRepeatable: true,
-          args: {
-            name: "id",
-          },
-        },
-        {
-          name: "--gateway-id",
-          description: "Explicitly specify id of the gateway to register with. If unspecified, a random gateway will be chosen instead",
-          isRepeatable: true,
-          args: {
-            name: "gateway_id",
-            isOptional: true,
-          },
-        },
-        {
-          name: "--nym-apis",
-          description: "Comma separated list of rest endpoints of the API validators",
-          isRepeatable: true,
-          args: {
-            name: "nym_apis",
-            isOptional: true,
-          },
-        },
-        {
-          name: "--custom-mixnet",
-          description: "Path to .json file containing custom network specification",
-          hidden: true,
-          isRepeatable: true,
-          args: {
-            name: "custom_mixnet",
-            isOptional: true,
-            template: "filepaths",
-          },
-        },
-        {
-          name: ["-o", "--output"],
-          isRepeatable: true,
-          args: {
-            name: "output",
-            isOptional: true,
-            suggestions: [
-              "text",
-              "json",
-            ],
-          },
-        },
-        {
-          name: "--force-tls-gateway",
-          description: "Specifies whether the client will attempt to enforce tls connection to the desired gateway",
-        },
-        {
-          name: "--latency-based-selection",
-          description: "Specifies whether the new gateway should be determined based by latency as opposed to being chosen uniformly",
-          exclusiveOn: [
-            "--gateway-id",
-          ],
-        },
-        {
-          name: "--set-active",
-          description: "Specify whether this new gateway should be set as the active one",
-        },
-        {
-          name: ["-h", "--help"],
-          description: "Print help",
-        },
-      ],
-    },
-    {
-      name: "switch-gateway",
-      description: "Change the currently active gateway. Note that you must have already registered with the new gateway!",
-      options: [
-        {
-          name: "--id",
-          description: "Id of client we want to list gateways for",
-          isRepeatable: true,
-          args: {
-            name: "id",
-          },
-        },
-        {
-          name: "--gateway-id",
-          description: "Id of the gateway we want to switch to",
-          isRepeatable: true,
-          args: {
-            name: "gateway_id",
-          },
-        },
-        {
-          name: ["-h", "--help"],
-          description: "Print help",
-        },
-      ],
-    },
-    {
-      name: "build-info",
-      description: "Show build information of this binary",
-      options: [
-        {
-          name: ["-o", "--output"],
-          isRepeatable: true,
-          args: {
-            name: "output",
-            isOptional: true,
-            suggestions: [
-              "text",
-              "json",
-            ],
-          },
-        },
-        {
-          name: ["-h", "--help"],
-          description: "Print help",
-        },
-      ],
-    },
-    {
-      name: "completions",
-      description: "Generate shell completions",
-      options: [
-        {
-          name: ["-h", "--help"],
-          description: "Print help",
-        },
-      ],
-      args: {
-        name: "shell",
-        suggestions: [
-          "bash",
-          "elvish",
-          "fish",
-          "power-shell",
-          "zsh",
-        ],
-      },
-    },
-    {
-      name: "generate-fig-spec",
-      description: "Generate Fig specification",
-      options: [
-        {
-          name: ["-h", "--help"],
-          description: "Print help",
-        },
-      ],
-    },
-    {
-      name: "help",
-      description: "Print this message or the help of the given subcommand(s)",
-      subcommands: [
-        {
-          name: "init",
-          description: "Initialise a Nym client. Do this first!",
-        },
-        {
-          name: "run",
-          description: "Run the Nym client with provided configuration client optionally overriding set parameters",
-        },
-        {
-          name: "import-credential",
-          description: "Import a pre-generated credential",
-        },
-        {
-          name: "list-gateways",
-          description: "List all registered with gateways",
-        },
-        {
-          name: "add-gateway",
-          description: "Add new gateway to this client",
-        },
-        {
-          name: "switch-gateway",
-          description: "Change the currently active gateway. Note that you must have already registered with the new gateway!",
-        },
-        {
-          name: "build-info",
-          description: "Show build information of this binary",
-        },
-        {
-          name: "completions",
-          description: "Generate shell completions",
-        },
-        {
-          name: "generate-fig-spec",
-          description: "Generate Fig specification",
-        },
-        {
-          name: "help",
-          description: "Print this message or the help of the given subcommand(s)",
-        },
-      ],
-    },
-  ],
-  options: [
-    {
-      name: ["-c", "--config-env-file"],
-      description: "Path pointing to an env file that configures the client",
-      isRepeatable: true,
-      args: {
-        name: "config_env_file",
-        isOptional: true,
-        template: "filepaths",
-      },
-    },
-    {
-      name: "--no-banner",
-      description: "Flag used for disabling the printed banner in tty",
-    },
-    {
-      name: ["-h", "--help"],
-      description: "Print help",
-    },
-    {
-      name: ["-V", "--version"],
-      description: "Print version",
-    },
-  ],
-};
-
-export default completion;
-```
@@ -1,192 +0,0 @@
-# `nymvisor` Binary Commands
-
-These docs are autogenerated by the `autodocs` script. 
-            
-**TODO add link**
-```
-Usage: nymvisor [OPTIONS] <COMMAND>
-
-Commands:
-  init               Initialise a nymvisor instance with persistent Config.toml file
-  run                Run the associated daemon with the preconfigured settings
-  build-info         Show build information of this binary
-  daemon-build-info  Show build information of the associated daemon
-  add-upgrade        Queues up another upgrade for the associated daemon
-  config             Show configuration options being used by this instance of nymvisor
-  help               Print this message or the help of the given subcommand(s)
-
-Options:
-  -c, --config-env-file <CONFIG_ENV_FILE>
-          Path pointing to an env file that configures the nymvisor and overrides any preconfigured values
-  -h, --help
-          Print help
-  -V, --version
-          Print version
-```
-
-### `init`
-```
-Initialise a nymvisor instance with persistent Config.toml file
-
-Usage: nymvisor init [OPTIONS] <DAEMON_BINARY>
-
-Arguments:
-  <DAEMON_BINARY>  Path to the daemon's executable
-
-Options:
-      --id <ID>
-          ID specifies the human readable ID of this particular nymvisor instance. Can be overridden with $NYMVISOR_ID environmental variable
-      --upstream-base-upgrade-url <UPSTREAM_BASE_UPGRADE_URL>
-          Sets the base url of the upstream source for obtaining upgrade information for the deaemon. It will be used fo constructing the full url, i.e. $NYMVISOR_UPSTREAM_BASE_UPGRADE_URL/$DAEMON_NAME/upgrade-info.json Can be overridden with $NYMVISOR_UPSTREAM_BASE_UPGRADE_URL environmental variable
-      --upstream-polling-rate <UPSTREAM_POLLING_RATE>
-          Specifies the rate of polling the upstream url for upgrade information. default: 1h Can be overridden with $NYMVISOR_UPSTREAM_POLLING_RATE
-      --disable-nymvisor-logs
-          If enabled, this will disable `nymvisor` logs (but not the underlying process) Can be overridden with $NYMVISOR_DISABLE_LOGS environmental variable
-      --upgrade-data-directory <UPGRADE_DATA_DIRECTORY>
-          Set custom directory for upgrade data - binaries and upgrade plans. If not set, the global nymvisors' data directory will be used instead. Can be overridden with $NYMVISOR_UPGRADE_DATA_DIRECTORY environmental variable
-      --daemon-home <DAEMON_HOME>
-          The location where the `nymvisor/` directory is kept that contains the auxiliary files associated with the underlying daemon, such as any backups or current version information. (e.g. $HOME/.nym/nym-api/my-nym-api, $HOME/.nym/mixnodes/my-mixnode, etc.). Can be overridden with $DAEMON_HOME environmental variable
-      --daemon-absolute-upstream-upgrade-url <DAEMON_ABSOLUTE_UPSTREAM_UPGRADE_URL>
-          Override url to the upstream source for upgrade plans for this daeamon. The Url has to point to an endpoint containing a valid [`UpgradeInfo`] json. Note: if set this takes precedence over `upstream_base_upgrade_url` Can be overridden with $DAEMON_ABSOLUTE_UPSTREAM_UPGRADE_URL environmental variable
-      --allow-download-upgrade-binaries <ALLOW_DOWNLOAD_UPGRADE_BINARIES>
-          If set to true, this will enable auto-downloading of new binaries using the url provided in the `upgrade-info.json` Can be overridden with $DAEMON_ALLOW_BINARIES_DOWNLOAD environmental variable [possible values: true, false]
-      --enforce-download-checksum <ENFORCE_DOWNLOAD_CHECKSUM>
-          If enabled nymvisor will require that a checksum is provided in the upgrade plan for the binary to be downloaded. If disabled, nymvisor will not require a checksum to be provided, but still check the checksum if one is provided. Can be overridden with $DAEMON_ENFORCE_DOWNLOAD_CHECKSUM environmental variable [possible values: true, false]
-      --restart-daemon-after-upgrade <RESTART_DAEMON_AFTER_UPGRADE>
-          If enabled, nymvisor will restart the subprocess with the same command-line arguments and flags (but with the new binary) after a successful upgrade. Otherwise (if disabled), nymvisor will stop running after an upgrade and will require the system administrator to manually restart it. Note restart is only after the upgrade and does not auto-restart the subprocess after an error occurs. Can be overridden with $DAEMON_RESTART_AFTER_UPGRADE environmental variable [possible values: true, false]
-      --restart-daemon-on-failure
-          If enabled, nymvisor will restart the subprocess with the same command-line arguments and flags after it has crashed Can be overridden with $DAEMON_RESTART_ON_FAILURE environmental variable
-      --on-failure-daemon-restart-delay <ON_FAILURE_DAEMON_RESTART_DELAY>
-          If `restart_on_failure` is enabled, the following value defines the amount of time `nymvisor` shall wait before restarting the subprocess. Can be overridden with $DAEMON_FAILURE_RESTART_DELAY environmental variable
-      --max-daemon-startup-failures <MAX_DAEMON_STARTUP_FAILURES>
-          Defines the maximum number of startup failures the subprocess can experience in a quick succession before no further restarts will be attempted and `nymvisor` will exit. Can be overridden with $DAEMON_MAX_STARTUP_FAILURES environmental variable
-      --startup-period-duration <STARTUP_PERIOD_DURATION>
-          Defines the length of time during which the subprocess is still considered to be in the startup phase when its failures are going to be considered in `max_startup_failures`. Can be overridden with $DAEMON_STARTUP_PERIOD_DURATION environmental variable
-      --daemon-shutdown-grace-period <DAEMON_SHUTDOWN_GRACE_PERIOD>
-          Specifies the amount of time `nymvisor` is willing to wait for the subprocess to undergo graceful shutdown after receiving an interrupt (for either an upgrade or shutdown of the `nymvisor` itself) Once the time passes, a kill signal is going to be sent instead. Can be overridden with $DAEMON_SHUTDOWN_GRACE_PERIOD environmental variable
-      --daemon-backup-data-directory <DAEMON_BACKUP_DATA_DIRECTORY>
-          Set custom backup directory for daemon data. If not set, the daemon's home directory will be used instead. Can be overridden with $DAEMON_BACKUP_DATA_DIRECTORY environmental variable
-      --unsafe-skip-backup
-          If enabled, `nymvisor` will perform upgrades directly without performing any backups. default: false Can be overridden with $DAEMON_UNSAFE_SKIP_BACKUP environmental variable
-  -o, --output <OUTPUT>
-          [default: text] [possible values: text, json]
-  -h, --help
-          Print help
-```
-
-### `run`
-```
-Run the associated daemon with the preconfigured settings
-
-Usage: nymvisor run [DAEMON_ARGS]...
-
-Arguments:
-  [DAEMON_ARGS]...  
-
-Options:
-  -h, --help  Print help
-```
-
-### `build-info`
-```
-Show build information of this binary
-
-Usage: nymvisor build-info [OPTIONS]
-
-Options:
-  -o, --output <OUTPUT>  [default: text] [possible values: text, json]
-  -h, --help             Print help
-```
-Example output:
-```
-
-Binary Name:        nymvisor
-Build Timestamp:    2024-05-07T13:11:43.523733081Z
-Build Version:      0.1.0
-Commit SHA:         7d233a4a2fc697a2f97e504db6a3765cc9f2dd49
-Commit Date:        2024-04-25T11:27:18.000000000+02:00
-Commit Branch:      max/auto-docs
-rustc Version:      1.78.0
-rustc Channel:      stable
-cargo Profile:      release
-
-```
-
-### `daemon-build-info`
-```
-Show build information of the associated daemon
-
-Usage: nymvisor daemon-build-info [OPTIONS]
-
-Options:
-  -o, --output <OUTPUT>  [default: text] [possible values: text, json]
-  -h, --help             Print help
-```
-Example output:
-```
-
-Binary Name:        nym-mixnode
-Build Timestamp:    2024-03-22T17:49:30.278145161Z
-Build Version:      1.1.34
-Commit SHA:         31bbfdecf5ea6deff69bd72a0bccd9dddae1003f
-Commit Date:        2024-02-19T10:52:15.000000000+01:00
-Commit Branch:      max/docs-overhaul-1
-rustc Version:      1.74.1
-rustc Channel:      stable
-cargo Profile:      release
-
-```
-
-### `add-upgrade`
-```
-Queues up another upgrade for the associated daemon
-
-Usage: nymvisor add-upgrade [OPTIONS] --upgrade-name <UPGRADE_NAME> <DAEMON_BINARY>
-
-Arguments:
-  <DAEMON_BINARY>  Path to the daemon's upgrade executable
-
-Options:
-      --upgrade-name <UPGRADE_NAME>    Name of this upgrade
-      --force                          Overwrite existing upgrade binary / upgrade-info.json file
-      --add-binary                     Indicate that this command should only add binary to an *existing* scheduled upgrade
-      --now                            Force the upgrade to happen immediately
-      --publish-date <PUBLISH_DATE>    Specifies the publish date metadata field of this upgrade. If unset, the current time will be used
-      --upgrade-time <UPGRADE_TIME>    Specifies the time at which the provided upgrade will be performed (RFC3339 formatted). If left unset, the upgrade will be performed in 15min
-      --upgrade-delay <UPGRADE_DELAY>  Specifies delay until the provided upgrade is going to get performed. If let unset, the upgrade will be performed in 15min
-  -o, --output <OUTPUT>                [default: text] [possible values: text, json]
-  -h, --help                           Print help
-```
-
-### `config`
-```
-Show configuration options being used by this instance of nymvisor
-
-Usage: nymvisor config [OPTIONS]
-
-Options:
-  -o, --output <OUTPUT>  [default: text] [possible values: text, json]
-  -h, --help             Print help
-```
-Example output:
-```
-
-id:                                nym-mixnode-default
-daemon name:                       nym-mixnode
-daemon home:                       /home/xen/.nym/mixnodes/my-node
-upstream base upgrade url:         https://nymtech.net/.wellknown/
-disable nymvisor logs:             false
-CUSTOM upgrade data directory      ""
-upstream absolute upgrade url:     ""
-allow binaries download:           true
-enforce download checksum:         true
-restart after upgrade:             true
-restart on failure:                false
-on failure restart delay:          10s
-max startup failures:              10
-startup period duration:           2m
-shutdown grace period:             10s
-CUSTOM backup data directory       ""
-UNSAFE skip backups                false
-
-```
@@ -1,311 +0,0 @@
-use log::info;
-use std::fs::File;
-use std::io::{self, Write};
-use std::process::{Command, Output};
-use std::{fs, vec};
-
-const PATH: &str = "./autodoc-generated-markdown/";
-
-fn main() -> io::Result<()> {
-    env_logger::init();
-
-    // TODO try and write to grab the commands from Clap at some point
-    let commands_with_subcommands = vec![
-        (
-            "../../target/release/nym-api",
-            vec!["init", "run", "build-info"],
-        ),
-        (
-            "../../target/release/nym-client",
-            vec![
-                "init",
-                "run",
-                "import-credential",
-                "list-gateways",
-                "switch-gateway",
-                "build-info",
-                "completions",
-                "generate-fig-spec",
-            ],
-        ),
-        (
-            "../../target/release/nym-socks5-client",
-            vec![
-                "init",
-                "run",
-                "import-credential",
-                "list-gateways",
-                "add-gateway",
-                "build-info",
-                "completions",
-                "generate-fig-spec",
-            ],
-        ),
-        (
-            "../../target/release/nym-node",
-            vec![
-                "build-info",
-                "bonding-information",
-                "node-details",
-                "migrate",
-                "run",
-                "sign",
-            ],
-        ),
-        (
-            "../../target/release/nymvisor",
-            vec![
-                "init",
-                "run",
-                "build-info",
-                "daemon-build-info",
-                "add-upgrade",
-                "config",
-            ],
-        ),
-    ];
-
-    let commands_with_subsubcommands = vec![(
-        "../../target/release/nym-cli",
-        vec![
-            (
-                "account",
-                vec!["create", "balance", "pub-key", "send", "send-multiple"],
-            ),
-            ("signature", vec!["sign", "verify"]),
-            (
-                "coconut",
-                vec![
-                    "generate-freepass",
-                    "issue-credentials",
-                    "recover-credentials",
-                    "import-credential",
-                ],
-            ),
-            ("block", vec!["get", "time", "current-height"]),
-            (
-                "cosmwasm",
-                vec![
-                    "upload",
-                    "init",
-                    "generate-init-message",
-                    "migrate",
-                    "execute",
-                ],
-            ),
-            ("tx", vec!["get", "query"]),
-            (
-                "vesting-schedule",
-                vec!["create", "query", "vested-balance", "withdraw-vested"],
-            ),
-            ("mixnet", vec!["query", "delegators", "operators"]),
-            ("generate-fig", vec![""]),
-        ],
-    )];
-
-    for (main_command, subcommands) in commands_with_subcommands {
-        let last_word = get_last_word_from_filepath(main_command);
-        info!("{last_word:#?}");
-
-        if !fs::metadata(PATH)
-            .map(|metadata| metadata.is_dir())
-            .unwrap_or(false)
-        {
-            fs::create_dir_all(PATH)?;
-        }
-
-        let mut file = File::create(format!("{}/{}-commands.md", PATH, last_word.unwrap()))?;
-        writeln!(
-            file,
-            "# {} Binary Commands",
-            format!("`{}`", last_word.unwrap())
-        )?;
-        writeln!(
-            file,
-            "\nThese docs are autogenerated by the `autodocs` script. 
-            \n**TODO add link**"
-        )?;
-        let output = Command::new(main_command).arg("--help").output()?;
-        write_output_to_file(&mut file, output)?;
-
-        for subcommand in subcommands {
-            execute_command(&mut file, main_command, subcommand, None)?;
-        }
-    }
-
-    // nym-cli has subsubcommands so needs its own loop
-    for (main_command, subcommands) in &commands_with_subsubcommands {
-        let last_word = get_last_word_from_filepath(main_command);
-        info!("{last_word:#?}");
-        let mut file = File::create(format!("{}/{}-commands.md", PATH, last_word.unwrap()))?;
-        writeln!(
-            file,
-            "# {} Binary Commands",
-            format!("`{}`", last_word.unwrap())
-        )?;
-        writeln!(
-            file,
-            "\nThese docs are autogenerated by the `autodocs` script. 
-            \n**TODO add link**"
-        )?;
-        let output = Command::new(main_command).arg("--help").output()?;
-
-        write_output_to_file(&mut file, output)?;
-
-        for (subcommand, subsubcommands) in subcommands {
-            writeln!(file, "\n### `{}` ", subcommand)?;
-            let output = Command::new(main_command)
-                .arg(subcommand)
-                .arg("--help")
-                .output()?;
-            if !output.stdout.is_empty() {
-                write_output_to_file(&mut file, output)?;
-            } else {
-                info!("empty stdout - nothing to write");
-            }
-            for subsubcommand in subsubcommands {
-                execute_command(&mut file, main_command, subcommand, Some(subsubcommand))?;
-                /*
-                println!(
-                    "{:#?} {:#?} {:#?}",
-                    last_word.unwrap(),
-                    subcommand,
-                    subsubcommand
-                );
-                */
-            }
-        }
-    }
-
-    Ok(())
-}
-
-fn get_last_word_from_filepath(filepath: &str) -> Option<&str> {
-    let parts: Vec<&str> = filepath.split('/').collect();
-    parts.last().copied()
-}
-
-fn execute_command(
-    file: &mut File,
-    main_command: &str,
-    subcommand: &str,
-    subsubcommand: Option<&str>,
-) -> io::Result<()> {
-    // checking for the nym-cli subsubcommands
-    if subsubcommand.is_some() {
-        writeln!(file, "\n### `{} {}`", subcommand, subsubcommand.unwrap())?;
-
-        info!("executing {} {} --help ", main_command, subcommand);
-        let output = Command::new(main_command)
-            .arg(subcommand)
-            .arg(subsubcommand.unwrap())
-            .arg("--help")
-            .output()?;
-        if !output.stdout.is_empty() {
-            write_output_to_file(file, output)?;
-        } else {
-            info!("empty stdout - nothing to write");
-        }
-    // just subcommands
-    } else {
-        writeln!(file, "\n### `{}`", subcommand)?;
-
-        // println!("{}", subcommand);
-        // execute help
-        let output = Command::new(main_command)
-            .arg(subcommand)
-            .arg("--help")
-            .output()?;
-        if !output.stdout.is_empty() {
-            write_output_to_file(file, output)?;
-        } else {
-            info!("empty stdout - nothing to write");
-        }
-
-        // then execute w/out help: the majority of functions will fail since you're not passing
-        // required params but thats fine as we can just not render stderr into the final file.
-        //
-        // this check is basically checking for the rare commands (rn just one) that start a process with no params
-        // perhaps if this list grows we could just add a timeout and shunt the running and writing
-        // into a thread with a timeout or something but for right now its fine / thats overkill
-        if get_last_word_from_filepath(main_command).unwrap() == "nym-node"
-            || get_last_word_from_filepath(main_command).unwrap() == "nym-api"
-            || get_last_word_from_filepath(main_command).unwrap() == "nymvisor"
-                && subcommand == "run"
-        {
-            info!("SKIPPING {} {}", main_command, subcommand);
-        } else {
-            info!("executing {} {}", main_command, subcommand);
-            let output = Command::new(main_command).arg(subcommand).output()?;
-            if !output.stdout.is_empty() {
-                writeln!(file, "Example output:")?;
-                write_output_to_file(file, output)?;
-            } else {
-                info!("empty stdout - nothing to write");
-                if !&output.stderr.is_empty() {
-                    info!("stderr: {:#?}", String::from_utf8_lossy(&output.stderr));
-                }
-            }
-        }
-    }
-    Ok(())
-}
-
-/*
- fn execute_command(file: &mut File, main_command: &str, subcommand: &str) -> io::Result<()> {
-    // title
-    writeln!(file, "\n### `{}`", subcommand)?;
-
-    // first execute the command with `--help`
-    info!("executing {} {} --help ", main_command, subcommand);
-    let output = Command::new(main_command)
-        .arg(subcommand)
-        .arg("--help")
-        .output()?;
-    if !output.stdout.is_empty() {
-        write_output_to_file(file, output)?;
-    } else {
-        info!("empty stdout - nothing to write");
-    }
-
-    // then execute w/out help: the majority of functions will fail since you're not passing
-    // required params but thats fine as we can just not render stderr into the final file.
-    //
-    // this check is basically checking for the rare commands (rn just one) that start a process with no params
-    // perhaps if this list grows we could just add a timeout and shunt the running and writing
-    // into a thread with a timeout or something but for right now its fine / thats overkill
-    if get_last_word_from_filepath(main_command).unwrap() == "nym-node"
-        || get_last_word_from_filepath(main_command).unwrap() == "nym-api"
-        || get_last_word_from_filepath(main_command).unwrap() == "nymvisor" && subcommand == "run"
-    {
-        info!("SKIPPING {} {}", main_command, subcommand);
-    } else {
-        info!("executing {} {}", main_command, subcommand);
-        let output = Command::new(main_command).arg(subcommand).output()?;
-        if !output.stdout.is_empty() {
-            writeln!(file, "Example output:")?;
-            write_output_to_file(file, output)?;
-        } else {
-            info!("empty stdout - nothing to write");
-            if !&output.stderr.is_empty() {
-                info!("stderr: {:#?}", String::from_utf8_lossy(&output.stderr));
-            }
-        }
-    }
-    Ok(())
-}
-*/
-
-fn write_output_to_file(file: &mut File, output: Output) -> io::Result<()> {
-    writeln!(file, "```")?;
-    file.write_all(&output.stdout)?;
-    writeln!(file, "```")?;
-
-    // if we want to keep this we could create 2 copies if you run this in a certain mode ("debug"
-    // oder so) so you can see the stderr but in reality, we want dont want the errors in teh md
-    // file and also probaly not write 'stdout', but just have <command><output> in a clean fashion
-    if !&output.stderr.is_empty() {
-        info!("stderr: {:#?}", String::from_utf8_lossy(&output.stderr));
-    }
-    Ok(())
-}
@@ -26,6 +26,7 @@ else
      echo "cleaning old book"
      rm -rf ./book/
      # build book
+      # mdbook test || true
      mdbook build
      # check for destination, if ! then mkdir & check again else echo thumbs up
      if [ ! -d ../../dist/docs/$i ]; then
@@ -24,7 +24,7 @@ turn-off = false

 [preprocessor.admonish]
 command = "mdbook-admonish"
-assets_version = "3.0.0" # 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]
@@ -1,20 +1,4 @@
@charset "UTF-8";
-:root {
-  --md-admonition-icon--admonish-note: url("data:image/svg+xml;charset=utf-8,<svg xmlns='http://www.w3.org/2000/svg' viewBox='0 0 24 24'><path d='M20.71 7.04c.39-.39.39-1.04 0-1.41l-2.34-2.34c-.37-.39-1.02-.39-1.41 0l-1.84 1.83 3.75 3.75M3 17.25V21h3.75L17.81 9.93l-3.75-3.75L3 17.25z'/></svg>");
-  --md-admonition-icon--admonish-abstract: url("data:image/svg+xml;charset=utf-8,<svg xmlns='http://www.w3.org/2000/svg' viewBox='0 0 24 24'><path d='M17 9H7V7h10m0 6H7v-2h10m-3 6H7v-2h7M12 3a1 1 0 0 1 1 1 1 1 0 0 1-1 1 1 1 0 0 1-1-1 1 1 0 0 1 1-1m7 0h-4.18C14.4 1.84 13.3 1 12 1c-1.3 0-2.4.84-2.82 2H5a2 2 0 0 0-2 2v14a2 2 0 0 0 2 2h14a2 2 0 0 0 2-2V5a2 2 0 0 0-2-2z'/></svg>");
-  --md-admonition-icon--admonish-info: url("data:image/svg+xml;charset=utf-8,<svg xmlns='http://www.w3.org/2000/svg' viewBox='0 0 24 24'><path d='M13 9h-2V7h2m0 10h-2v-6h2m-1-9A10 10 0 0 0 2 12a10 10 0 0 0 10 10 10 10 0 0 0 10-10A10 10 0 0 0 12 2z'/></svg>");
-  --md-admonition-icon--admonish-tip: url("data:image/svg+xml;charset=utf-8,<svg xmlns='http://www.w3.org/2000/svg' viewBox='0 0 24 24'><path d='M17.66 11.2c-.23-.3-.51-.56-.77-.82-.67-.6-1.43-1.03-2.07-1.66C13.33 7.26 13 4.85 13.95 3c-.95.23-1.78.75-2.49 1.32-2.59 2.08-3.61 5.75-2.39 8.9.04.1.08.2.08.33 0 .22-.15.42-.35.5-.23.1-.47.04-.66-.12a.58.58 0 0 1-.14-.17c-1.13-1.43-1.31-3.48-.55-5.12C5.78 10 4.87 12.3 5 14.47c.06.5.12 1 .29 1.5.14.6.41 1.2.71 1.73 1.08 1.73 2.95 2.97 4.96 3.22 2.14.27 4.43-.12 6.07-1.6 1.83-1.66 2.47-4.32 1.53-6.6l-.13-.26c-.21-.46-.77-1.26-.77-1.26m-3.16 6.3c-.28.24-.74.5-1.1.6-1.12.4-2.24-.16-2.9-.82 1.19-.28 1.9-1.16 2.11-2.05.17-.8-.15-1.46-.28-2.23-.12-.74-.1-1.37.17-2.06.19.38.39.76.63 1.06.77 1 1.98 1.44 2.24 2.8.04.14.06.28.06.43.03.82-.33 1.72-.93 2.27z'/></svg>");
-  --md-admonition-icon--admonish-success: url("data:image/svg+xml;charset=utf-8,<svg xmlns='http://www.w3.org/2000/svg' viewBox='0 0 24 24'><path d='m9 20.42-6.21-6.21 2.83-2.83L9 14.77l9.88-9.89 2.83 2.83L9 20.42z'/></svg>");
-  --md-admonition-icon--admonish-question: url("data:image/svg+xml;charset=utf-8,<svg xmlns='http://www.w3.org/2000/svg' viewBox='0 0 24 24'><path d='m15.07 11.25-.9.92C13.45 12.89 13 13.5 13 15h-2v-.5c0-1.11.45-2.11 1.17-2.83l1.24-1.26c.37-.36.59-.86.59-1.41a2 2 0 0 0-2-2 2 2 0 0 0-2 2H8a4 4 0 0 1 4-4 4 4 0 0 1 4 4 3.2 3.2 0 0 1-.93 2.25M13 19h-2v-2h2M12 2A10 10 0 0 0 2 12a10 10 0 0 0 10 10 10 10 0 0 0 10-10c0-5.53-4.5-10-10-10z'/></svg>");
-  --md-admonition-icon--admonish-warning: url("data:image/svg+xml;charset=utf-8,<svg xmlns='http://www.w3.org/2000/svg' viewBox='0 0 24 24'><path d='M13 14h-2V9h2m0 9h-2v-2h2M1 21h22L12 2 1 21z'/></svg>");
-  --md-admonition-icon--admonish-failure: url("data:image/svg+xml;charset=utf-8,<svg xmlns='http://www.w3.org/2000/svg' viewBox='0 0 24 24'><path d='M20 6.91 17.09 4 12 9.09 6.91 4 4 6.91 9.09 12 4 17.09 6.91 20 12 14.91 17.09 20 20 17.09 14.91 12 20 6.91z'/></svg>");
-  --md-admonition-icon--admonish-danger: url("data:image/svg+xml;charset=utf-8,<svg xmlns='http://www.w3.org/2000/svg' viewBox='0 0 24 24'><path d='M11 15H6l7-14v8h5l-7 14v-8z'/></svg>");
-  --md-admonition-icon--admonish-bug: url("data:image/svg+xml;charset=utf-8,<svg xmlns='http://www.w3.org/2000/svg' viewBox='0 0 24 24'><path d='M14 12h-4v-2h4m0 6h-4v-2h4m6-6h-2.81a5.985 5.985 0 0 0-1.82-1.96L17 4.41 15.59 3l-2.17 2.17a6.002 6.002 0 0 0-2.83 0L8.41 3 7 4.41l1.62 1.63C7.88 6.55 7.26 7.22 6.81 8H4v2h2.09c-.05.33-.09.66-.09 1v1H4v2h2v1c0 .34.04.67.09 1H4v2h2.81c1.04 1.79 2.97 3 5.19 3s4.15-1.21 5.19-3H20v-2h-2.09c.05-.33.09-.66.09-1v-1h2v-2h-2v-1c0-.34-.04-.67-.09-1H20V8z'/></svg>");
-  --md-admonition-icon--admonish-example: url("data:image/svg+xml;charset=utf-8,<svg xmlns='http://www.w3.org/2000/svg' viewBox='0 0 24 24'><path d='M7 13v-2h14v2H7m0 6v-2h14v2H7M7 7V5h14v2H7M3 8V5H2V4h2v4H3m-1 9v-1h3v4H2v-1h2v-.5H3v-1h1V17H2m2.25-7a.75.75 0 0 1 .75.75c0 .2-.08.39-.21.52L3.12 13H5v1H2v-.92L4 11H2v-1h2.25z'/></svg>");
-  --md-admonition-icon--admonish-quote: url("data:image/svg+xml;charset=utf-8,<svg xmlns='http://www.w3.org/2000/svg' viewBox='0 0 24 24'><path d='M14 17h3l2-4V7h-6v6h3M6 17h3l2-4V7H5v6h3l-2 4z'/></svg>");
-  --md-details-icon: url("data:image/svg+xml;charset=utf-8,<svg xmlns='http://www.w3.org/2000/svg' viewBox='0 0 24 24'><path d='M8.59 16.58 13.17 12 8.59 7.41 10 6l6 6-6 6-1.41-1.42Z'/></svg>");
-}
-
 :is(.admonition) {
  display: flow-root;
  margin: 1.5625em 0;
@@ -71,6 +55,8 @@ a.admonition-anchor-link::before {
  padding-inline: 4.4rem 1.2rem;
  font-weight: 700;
  background-color: rgba(68, 138, 255, 0.1);
+  print-color-adjust: exact;
+  -webkit-print-color-adjust: exact;
  display: flex;
 }
 :is(.admonition-title, summary.admonition-title) p {
@@ -86,6 +72,8 @@ html :is(.admonition-title, summary.admonition-title):last-child {
  width: 2rem;
  height: 2rem;
  background-color: #448aff;
+  print-color-adjust: exact;
+  -webkit-print-color-adjust: exact;
  mask-image: url('data:image/svg+xml;charset=utf-8,<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"></svg>');
  -webkit-mask-image: url('data:image/svg+xml;charset=utf-8,<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"></svg>');
  mask-repeat: no-repeat;
@@ -119,6 +107,25 @@ details[open].admonition > summary.admonition-title::after {
  transform: rotate(90deg);
 }

+:root {
+  --md-details-icon: url("data:image/svg+xml;charset=utf-8,<svg xmlns='http://www.w3.org/2000/svg' viewBox='0 0 24 24'><path d='M8.59 16.58 13.17 12 8.59 7.41 10 6l6 6-6 6-1.41-1.42Z'/></svg>");
+}
+
+:root {
+  --md-admonition-icon--admonish-note: url("data:image/svg+xml;charset=utf-8,<svg xmlns='http://www.w3.org/2000/svg' viewBox='0 0 24 24'><path d='M20.71 7.04c.39-.39.39-1.04 0-1.41l-2.34-2.34c-.37-.39-1.02-.39-1.41 0l-1.84 1.83 3.75 3.75M3 17.25V21h3.75L17.81 9.93l-3.75-3.75L3 17.25z'/></svg>");
+  --md-admonition-icon--admonish-abstract: url("data:image/svg+xml;charset=utf-8,<svg xmlns='http://www.w3.org/2000/svg' viewBox='0 0 24 24'><path d='M17 9H7V7h10m0 6H7v-2h10m-3 6H7v-2h7M12 3a1 1 0 0 1 1 1 1 1 0 0 1-1 1 1 1 0 0 1-1-1 1 1 0 0 1 1-1m7 0h-4.18C14.4 1.84 13.3 1 12 1c-1.3 0-2.4.84-2.82 2H5a2 2 0 0 0-2 2v14a2 2 0 0 0 2 2h14a2 2 0 0 0 2-2V5a2 2 0 0 0-2-2z'/></svg>");
+  --md-admonition-icon--admonish-info: url("data:image/svg+xml;charset=utf-8,<svg xmlns='http://www.w3.org/2000/svg' viewBox='0 0 24 24'><path d='M13 9h-2V7h2m0 10h-2v-6h2m-1-9A10 10 0 0 0 2 12a10 10 0 0 0 10 10 10 10 0 0 0 10-10A10 10 0 0 0 12 2z'/></svg>");
+  --md-admonition-icon--admonish-tip: url("data:image/svg+xml;charset=utf-8,<svg xmlns='http://www.w3.org/2000/svg' viewBox='0 0 24 24'><path d='M17.66 11.2c-.23-.3-.51-.56-.77-.82-.67-.6-1.43-1.03-2.07-1.66C13.33 7.26 13 4.85 13.95 3c-.95.23-1.78.75-2.49 1.32-2.59 2.08-3.61 5.75-2.39 8.9.04.1.08.2.08.33 0 .22-.15.42-.35.5-.23.1-.47.04-.66-.12a.58.58 0 0 1-.14-.17c-1.13-1.43-1.31-3.48-.55-5.12C5.78 10 4.87 12.3 5 14.47c.06.5.12 1 .29 1.5.14.6.41 1.2.71 1.73 1.08 1.73 2.95 2.97 4.96 3.22 2.14.27 4.43-.12 6.07-1.6 1.83-1.66 2.47-4.32 1.53-6.6l-.13-.26c-.21-.46-.77-1.26-.77-1.26m-3.16 6.3c-.28.24-.74.5-1.1.6-1.12.4-2.24-.16-2.9-.82 1.19-.28 1.9-1.16 2.11-2.05.17-.8-.15-1.46-.28-2.23-.12-.74-.1-1.37.17-2.06.19.38.39.76.63 1.06.77 1 1.98 1.44 2.24 2.8.04.14.06.28.06.43.03.82-.33 1.72-.93 2.27z'/></svg>");
+  --md-admonition-icon--admonish-success: url("data:image/svg+xml;charset=utf-8,<svg xmlns='http://www.w3.org/2000/svg' viewBox='0 0 24 24'><path d='m9 20.42-6.21-6.21 2.83-2.83L9 14.77l9.88-9.89 2.83 2.83L9 20.42z'/></svg>");
+  --md-admonition-icon--admonish-question: url("data:image/svg+xml;charset=utf-8,<svg xmlns='http://www.w3.org/2000/svg' viewBox='0 0 24 24'><path d='m15.07 11.25-.9.92C13.45 12.89 13 13.5 13 15h-2v-.5c0-1.11.45-2.11 1.17-2.83l1.24-1.26c.37-.36.59-.86.59-1.41a2 2 0 0 0-2-2 2 2 0 0 0-2 2H8a4 4 0 0 1 4-4 4 4 0 0 1 4 4 3.2 3.2 0 0 1-.93 2.25M13 19h-2v-2h2M12 2A10 10 0 0 0 2 12a10 10 0 0 0 10 10 10 10 0 0 0 10-10c0-5.53-4.5-10-10-10z'/></svg>");
+  --md-admonition-icon--admonish-warning: url("data:image/svg+xml;charset=utf-8,<svg xmlns='http://www.w3.org/2000/svg' viewBox='0 0 24 24'><path d='M13 14h-2V9h2m0 9h-2v-2h2M1 21h22L12 2 1 21z'/></svg>");
+  --md-admonition-icon--admonish-failure: url("data:image/svg+xml;charset=utf-8,<svg xmlns='http://www.w3.org/2000/svg' viewBox='0 0 24 24'><path d='M20 6.91 17.09 4 12 9.09 6.91 4 4 6.91 9.09 12 4 17.09 6.91 20 12 14.91 17.09 20 20 17.09 14.91 12 20 6.91z'/></svg>");
+  --md-admonition-icon--admonish-danger: url("data:image/svg+xml;charset=utf-8,<svg xmlns='http://www.w3.org/2000/svg' viewBox='0 0 24 24'><path d='M11 15H6l7-14v8h5l-7 14v-8z'/></svg>");
+  --md-admonition-icon--admonish-bug: url("data:image/svg+xml;charset=utf-8,<svg xmlns='http://www.w3.org/2000/svg' viewBox='0 0 24 24'><path d='M14 12h-4v-2h4m0 6h-4v-2h4m6-6h-2.81a5.985 5.985 0 0 0-1.82-1.96L17 4.41 15.59 3l-2.17 2.17a6.002 6.002 0 0 0-2.83 0L8.41 3 7 4.41l1.62 1.63C7.88 6.55 7.26 7.22 6.81 8H4v2h2.09c-.05.33-.09.66-.09 1v1H4v2h2v1c0 .34.04.67.09 1H4v2h2.81c1.04 1.79 2.97 3 5.19 3s4.15-1.21 5.19-3H20v-2h-2.09c.05-.33.09-.66.09-1v-1h2v-2h-2v-1c0-.34-.04-.67-.09-1H20V8z'/></svg>");
+  --md-admonition-icon--admonish-example: url("data:image/svg+xml;charset=utf-8,<svg xmlns='http://www.w3.org/2000/svg' viewBox='0 0 24 24'><path d='M7 13v-2h14v2H7m0 6v-2h14v2H7M7 7V5h14v2H7M3 8V5H2V4h2v4H3m-1 9v-1h3v4H2v-1h2v-.5H3v-1h1V17H2m2.25-7a.75.75 0 0 1 .75.75c0 .2-.08.39-.21.52L3.12 13H5v1H2v-.92L4 11H2v-1h2.25z'/></svg>");
+  --md-admonition-icon--admonish-quote: url("data:image/svg+xml;charset=utf-8,<svg xmlns='http://www.w3.org/2000/svg' viewBox='0 0 24 24'><path d='M14 17h3l2-4V7h-6v6h3M6 17h3l2-4V7H5v6h3l-2 4z'/></svg>");
+}
+
 :is(.admonition):is(.admonish-note) {
  border-color: #448aff;
 }
@@ -1,95 +1,96 @@
+[//]: # (TODO change the URLs in the top handlebars)
 #
-# Summary
-
+# Start Here
 - [Introduction](introduction.md)

-# Infrastructure
+[//]: # (this is where you pull in some stuff from the infrastructure section as well as a general approach to how to start )
+- [Development Overview](dev-overview.md)

- [What is Nym?](infrastructure/nym.md)
- [Nym vs Other Systems](infrastructure/nym-vs-others.md)
- [Node Types](infrastructure/node-types.md)
+[//]: # (TODO see what you can take from here and put in the intro file )
+  [//]: # (# Infrastructure)
+  [//]: # ()
+  [//]: # (- [What is Nym?]&#40;infrastructure/nym.md&#41;)
+  [//]: # (- [Nym vs Other Systems]&#40;infrastructure/nym-vs-others.md&#41;)
+  [//]: # (- [Node Types]&#40;infrastructure/node-types.md&#41;)

-# Quickstart
+[//]: # (TODO change this to something like 'where to get started' and extensively rewrite)
+# Integrations
+- [Integration Options](integrations/integration-options.md)
+- [Payment Integration](integrations/payment-integration.md)

- [Overview](quickstart/overview.md)
- [Chat demo (webapp)](quickstart/chat-demo.md)
- [Coconut Credential Playground (webapp)](quickstart/cred-playground.md)
- [SOCKS Proxy (CLI)](quickstart/socks-proxy.md)
- [NymConnect Beta (GUI)](quickstart/nymconnect-gui.md)
+# SDKs
+- [Rust SDK](sdk/rust/rust.md)
+  - [Interacting with Clients - Read First!](sdk/rust/readfirst.md)
+  - [Message Types](sdk/rust/message-types.md)
+  - [Message Helpers](sdk/rust/message-helpers.md)
+  - [Troubleshooting](sdk/rust/troubleshooting.md)
+  - [Examples](sdk/rust/examples.md)
+      - [Simple Send](sdk/rust/examples/simple.md)
+      - [Create and Store Keys](sdk/rust/examples/keys.md)
+      - [Manual Storage](sdk/rust/examples/storage.md)
+      - [Anonymous Replies](sdk/rust/examples/surbs.md)
+      - [Use Custom Network Topology](sdk/rust/examples/custom-network.md)
+      - [Socks Proxy](sdk/rust/examples/socks.md)
+      - [Split Send and Receive](sdk/rust/examples/split-send.md)
+      - [Testnet Bandwidth Cred](sdk/rust/examples/credential.md)
+      - [Example Cargo file](sdk/rust/examples/cargo.md)
+- [Typescript SDK](sdk/typescript.md)

+# Clients
+- [Client Binaries](clients/client-binaries.md)
+  - [Building Nym](clients/building-nym.md)
+  - [Prebuilt Binaries](clients/pre-built-binaries.md)
+- [Clients Overview](clients/overview.md)
+- [Websocket Client](clients/websocket-client.md)
+  - [Setup & Run](clients/websocket/setup.md)
+  - [Configuration](clients/websocket/config.md)
+  - [Using Your Client](clients/websocket/usage.md)
+  - [Examples](clients/websocket/examples.md)
+  - [Command Documentation (Autogenerated)](clients/websocket/nym-client-commands.md)
+- [Socks5 Client](clients/socks5-client.md)
+  - [Setup Guide](clients/socks5/setup.md)
+  - [Command Documentation (Autogenerated)](clients/socks5/nym-socks5-client-commands)
+- [Webassembly Client](clients/webassembly-client.md)
+- [Addressing System](clients/addressing-system.md)
+
+# Nyx Blockchain
+- [Interacting with Nyx Chain and Smart Contracts](nyx/interacting-with-chain.md)
+- [Smart Contracts](nyx/smart-contracts.md)
+    - [Mixnet Contract](nyx/mixnet-contract.md)
+    - [Vesting Contract](nyx/vesting-contract.md)
+- [RPC Nodes](nyx/rpc-node.md)
+- [Ledger Live Support](nyx/ledger-live.md)
+
+# Tools
+- [NymCLI](tools/nym-cli.md)
+- [Command Documentation (Autogenerated)](tools/nym-cli-commands.md)
+   
 # User Manuals
-
 - [NymVPN alpha](nymvpn/intro.md)
-    - [GUI](nymvpn/gui.md)
-        - [Linux](nymvpn/gui-linux.md)
-        - [MacOS](nymvpn/gui-mac.md)
    - [CLI](nymvpn/cli.md)
-    - [Troubleshooting](nymvpn/troubleshooting.md)
-    - [NymVPN FAQ](nymvpn/faq.md)
- [NymConnect X Monero](tutorials/monero.md)
- [NymConnect X Matrix](tutorials/matrix.md)
- [NymConnect X Telegram](tutorials/telegram.md)
- [NymConnect X Electrum](tutorials/electrum.md)
- [NymConnect X Firo wallet](tutorials/firo.md)

 # Code Examples
-
 - [Custom Service Providers](examples/custom-services.md)
 - [Apps Using Network Requesters](examples/using-nrs.md)
 - [Browser only](examples/browser-only.md)
 - [Monorepo examples](examples/monorepo-examples.md)

-# Integrations
-
- [Integration Options](integrations/integration-options.md)
-[//]: # (- [Mixnet Integration]&#40;integrations/mixnet-integration.md&#41;)
- [Payment Integration](integrations/payment-integration.md)
-
 # Tutorials
+- [Under Construction](tutorials/comingsoon.md)

- [Rust SDK](tutorials/rust-sdk.md)
-	- [Blockchain Service pt1](tutorials/cosmos-service/intro.md)
-		- [Tutorial Overview](tutorials/cosmos-service/overview.md)
-		- [Preparing Your Environment](tutorials/cosmos-service/preparing-env.md)
-		- [Preparing Your Lib](tutorials/cosmos-service/lib.md)
-		- [Preparing Your Client](tutorials/cosmos-service/client.md)
-		- [Preparing Your Client pt2](tutorials/cosmos-service/client-src.md)
-		- [Preparing Your Service](tutorials/cosmos-service/service.md)
-		- [Preparing Your Service pt2](tutorials/cosmos-service/service-src.md)
-		- [Querying the Chain](tutorials/cosmos-service/querying.md)
-
- [Typescript](tutorials/typescript.md)
-    - [Simple Service Provider](tutorials/simple-service-provider/simple-service-provider.md)
-      	- [Tutorial Overview](tutorials/simple-service-provider/overview.md)
-      	- [Preparing Your User Client Environment](tutorials/simple-service-provider/preparating-env.md)
-      	- [Building Your User Client](tutorials/simple-service-provider/user-client.md)
-      	- [Preparing Your Service Provider Environment](tutorials/simple-service-provider/preparating-env2.md)
-      	- [Building Your Service Provider](tutorials/simple-service-provider/service-provider.md)
-      	- [Sending a Message Through the Mixnet](tutorials/simple-service-provider/sending-message.md)
-
-[//]: # (TODO make generic )
-[//]: # (# Shipyard Builders Hackathon 2023 )
-[//]: # (- [General Info & Resources]&#40;shipyard/general.md&#41;)
-[//]: # (- [Hackathon Challenges]&#40;shipyard/challenges-overview.md&#41;)
-[//]: # (- [A Note on Infrastructure]&#40;shipyard/infra.md&#41;)
-[//]: # (- [Submission Guidelines]&#40;shipyard/guidelines.md&#41;)
-
-# Events
-
+# Previous Events
 - [Web3Privacy Now](./events/web3-privacy.md)
 - [HCPP23-serinko](./events/hcpp23-serinko.md)
 - [HCPP23-max](./events/hcpp23-max.md)

+[//]: # (Maybe we can get rid of these?)
 # FAQ
 - [General](faq/general-faq.md)
 - [Integrations](faq/integrations-faq.md)
 - [Rewards & Token](faq/rewards-faq.md)

 # Community Resources
-
- [Nym DevRel AMAs](community-resources/ama.md)
 - [Community Applications and Guides](community-resources/community-applications-and-guides.md)
- [Change Service Grantee Information](info-request.md)

 ---
 # Misc.
@@ -8,7 +8,7 @@ Nym has two main codebases:
 - the [Nym platform](https://github.com/nymtech/nym), written in Rust. This contains all of our code _except_ for the validators.
 - the [Nym validators](https://github.com/nymtech/nyxd), written in Go.

-> This page details how to build the main Nym platform code. **If you want to build and run a validator, [go here](../nodes/validator.md) instead.**
+> This page details how to build the main Nym platform code. **If you want to build and run a validator, [go here](https://nymtech.net/operators/nodes/validator.md) instead.**

 ## Prerequisites
 - Debian/Ubuntu: `pkg-config`, `build-essential`, `libssl-dev`, `curl`, `jq`, `git`
@@ -54,19 +54,18 @@ cargo build --release # build your binaries with **mainnet** configuration

 Quite a bit of stuff gets built. The key working parts are:

-* [mix node](../nodes/mixnode.md): `nym-mixnode`
-* [gateway node](../nodes/gateway.md): `nym-gateway`
+* [mix node](https://nymtech.net/operators/nodes/mixnode.md): `nym-mixnode`
+* [gateway node](https://nymtech.net/operators/nodes/gateway.md): `nym-gateway`
 * [websocket client](../clients/websocket-client.md): `nym-client`
 * [socks5 client](../clients/socks5-client.md): `nym-socks5-client`
-* [network requester](../nodes/network-requester.md): `nym-network-requester`
+* [network requester](https://nymtech.net/operators/nodes/network-requester.md): `nym-network-requester`
 * [nym-cli tool](../tools/nym-cli.md): `nym-cli`
 * [nym-api](https://nymtech.net/operators/nodes/nym-api.html): `nym-api`
+* [nymvisor](https://nymtech.net/operators/nodes/nymvisor-upgrade.html): `nymvisor`

-[//]: # (* [nymvisor]&#40;https://nymtech.net/operators/nodes/nymvisor-upgrade.html&#41;: `nymvisor`)
-
-The repository also contains Typescript applications which aren't built in this process. These can be built by following the instructions on their respective docs pages.
-* [Nym Wallet](../wallet/desktop-wallet.md)
-* [Nym Connect](https://nymtech.net/developers/quickstart/nymconnect-gui.html)
-* [Network Explorer UI](../explorers/mixnet-explorer.md)
+[//]: # (The repository also contains Typescript applications which aren't built in this process. These can be built by following the instructions on their respective docs pages.)
+[//]: # (* [Nym Wallet]&#40;../../../docs/src/wallet/desktop-wallet.md&#41;)
+[//]: # (* [Nym Connect]&#40;https://nymtech.net/developers/quickstart/nymconnect-gui.html&#41;)
+[//]: # (* [Network Explorer UI]&#40;../../../docs/src/explorers/mixnet-explorer.md&#41;)

 > You cannot build from GitHub's .zip or .tar.gz archive files on the releases page - the Nym build scripts automatically include the current git commit hash in the built binary during compilation, so the build will fail if you use the archive code (which isn't a Git repository). Check the code out from github using `git clone` instead.
@@ -0,0 +1,5 @@
+# Client Binaries
+
+The Nym codebase is written primarily in Rust. There are two methods to getting access to the different client and node binaries: 
+* [build them yourself](building-nym.md)
+* [download pre-compiled binaries from github](pre-built-binaries.md)
@@ -0,0 +1,66 @@
+# Socks5 Client
+
+> The Nym socks5 client was built in the [building nym](./building-nym.md) section. If you haven't yet built Nym and want to run the code on this page, go there first.
+
+## Current version
+```
+<!-- cmdrun ../../../../target/release/nym-socks5-client --version | grep "Build Version" | cut -b 21-26  -->
+```
+
+## What is this client for?
+Many existing applications are able to use either the SOCKS4, SOCKS4A, or SOCKS5 proxy protocols. If you want to send such an application's traffic through the mixnet, you can use the `nym-socks5-client` to bounce network traffic through the Nym network, like this:
+
+```
+                                                                              External Systems:
+                                                                                     +--------------------+
+                                                                             |------>| Monero blockchain  |
+                                                                             |       +--------------------+
+                                                                             |       +--------------------+
+                                                                             |------>|    Email server    |
+                                                                             |       +--------------------+
+                                                                             |       +--------------------+
+                                                                             |------>|    RPC endpoint    |
+                                                                             |       +--------------------+
+                                                                             |       +--------------------+
+                                                                             |------>|       Website      |
+                                                                             |       +--------------------+
+                                                                             |       +--------------------+
+  +----------------------------------+                                       |------>|       etc...       |
+  | Mixnet:                          |                                       |       +--------------------+
+  |       * Gateway your client is   |                                       |
+  |       connected to               |          +--------------------+       |
+  |       * Mix nodes 1 -> 3         |<-------->| Network requester  |<------+
+  |       * Gateway that network     |          +--------------------+
+  |       requester is connected to  |
+  +----------------------------------+
+           ^
+           |
+           |
+           |
+           |
+           v
+ +-------------------+
+ | +---------------+ |
+ | |  Nym client   | |
+ | +---------------+ |
+ |         ^         |
+ |         |         |
+ |         |         |
+ |         |         |
+ |         v         |
+ | +---------------+ |
+ | | Your app code | |
+ | +---------------+ |
+ +-------------------+
+  Your Local Machine
+```
+
+There are 2 pieces of software that work together to send SOCKS traffic through the mixnet: the `nym-socks5-client`, and the `nym-network-requester`.
+
+The `nym-socks5-client` allows you to do the following from your local machine:
+* Take a TCP data stream from a application that can send traffic via SOCKS5.
+* Chop up the TCP stream into multiple Sphinx packets, assigning sequence numbers to them, while leaving the TCP connection open for more data
+* Send the Sphinx packets through the mixnet to a [network requester](https://nymtech.net/operators/nodes/network-requester.md). Packets are shuffled and mixed as they transit the mixnet.
+
+The `nym-network-requester` then reassembles the original TCP stream using the packets' sequence numbers, and make the intended request. It will then chop up the response into Sphinx packets and send them back through the mixnet to your  `nym-socks5-client`. The application will then receive its data, without even noticing that it wasn't talking to a "normal" SOCKS5 proxy!
+
@@ -0,0 +1 @@
+# Command Documentation (Autogenerated)
@@ -0,0 +1 @@
+# Command Documentation (Autogenerated)
@@ -0,0 +1 @@
+# Command Documentation
@@ -1,69 +1,4 @@
-# Socks5 Client
-
-> The Nym socks5 client was built in the [building nym](../binaries/building-nym.md) section. If you haven't yet built Nym and want to run the code on this page, go there first.
-
-## Current version
-```
-<!-- cmdrun ../../../../target/release/nym-socks5-client --version | grep "Build Version" | cut -b 21-26  -->
-```
-
-## What is this client for?
-Many existing applications are able to use either the SOCKS4, SOCKS4A, or SOCKS5 proxy protocols. If you want to send such an application's traffic through the mixnet, you can use the `nym-socks5-client` to bounce network traffic through the Nym network, like this:
-
-```
-                                                                              External Systems:
-                                                                                     +--------------------+
-                                                                             |------>| Monero blockchain  |
-                                                                             |       +--------------------+
-                                                                             |       +--------------------+
-                                                                             |------>|    Email server    |
-                                                                             |       +--------------------+
-                                                                             |       +--------------------+
-                                                                             |------>|    RPC endpoint    |
-                                                                             |       +--------------------+
-                                                                             |       +--------------------+
-                                                                             |------>|       Website      |
-                                                                             |       +--------------------+
-                                                                             |       +--------------------+
-  +----------------------------------+                                       |------>|       etc...       |
-  | Mixnet:                          |                                       |       +--------------------+
-  |       * Gateway your client is   |                                       |
-  |       connected to               |          +--------------------+       |
-  |       * Mix nodes 1 -> 3         |<-------->| Network requester  |<------+
-  |       * Gateway that network     |          +--------------------+
-  |       requester is connected to  |
-  +----------------------------------+
-           ^
-           |
-           |
-           |
-           |
-           v
- +-------------------+
- | +---------------+ |
- | |  Nym client   | |
- | +---------------+ |
- |         ^         |
- |         |         |
- |         |         |
- |         |         |
- |         v         |
- | +---------------+ |
- | | Your app code | |
- | +---------------+ |
- +-------------------+
-  Your Local Machine
-```
-
-There are 2 pieces of software that work together to send SOCKS traffic through the mixnet: the `nym-socks5-client`, and the `nym-network-requester`.
-
-The `nym-socks5-client` allows you to do the following from your local machine:
-* Take a TCP data stream from a application that can send traffic via SOCKS5.
-* Chop up the TCP stream into multiple Sphinx packets, assigning sequence numbers to them, while leaving the TCP connection open for more data
-* Send the Sphinx packets through the mixnet to a [network requester](../nodes/network-requester.md). Packets are shuffled and mixed as they transit the mixnet.
-
-The `nym-network-requester` then reassembles the original TCP stream using the packets' sequence numbers, and make the intended request. It will then chop up the response into Sphinx packets and send them back through the mixnet to your  `nym-socks5-client`. The application will then receive its data, without even noticing that it wasn't talking to a "normal" SOCKS5 proxy!
-
+# Setup Guide
 ## Client setup
 ### Viewing command help

@@ -84,6 +19,7 @@ You can check the necessary parameters for the available commands by running:
 ```
 ./nym-client <COMMAND> --help
 ```
+or check the autogenerated command documentation on the [next page](./nym-socks5-client-commands). 

 ### Initialising a new client instance
 Before you can use the client, you need to initalise a new instance of it, which can be done with the following command:
@@ -100,11 +36,9 @@ Before you can use the client, you need to initalise a new instance of it, which

 The `--id` in the example above is a local identifier so that you can name your clients and keep track of them on your local system; it is **never** transmitted over the network.

-The `--use-reply-surbs` field denotes whether you wish to send [SURBs](../architecture/traffic-flow.md#private-replies-using-surbs) along with your request. It defaults to `false`, we are explicitly setting it as `true`. It defaults to `false` for compatibility with older versions of the [Network Requester](../nodes/network-requester.md).
+The `--use-reply-surbs` field denotes whether you wish to send [SURBs](https://nymtech.net/docs/architecture/traffic-flow.md#private-replies-using-surbs) along with your request. It defaults to `false`, we are explicitly setting it as `true`. It defaults to `false` for compatibility with older versions of the [Network Requester](https://nymtech.net/operators/nodes/network-requester.md).

-The `--provider` field needs to be filled with the Nym address of a Network Requester that can make network requests on your behalf. If you don't want to [run your own](../nodes/network-requester.md) you can select one from the [mixnet explorer](https://explorer.nymtech.net/network-components/service-providers) by copying its `Client ID` and using this as the value of the `--provider` flag. Alternatively, you could use [this list](https://harbourmaster.nymtech.net/).
-
-Since the nodes on this list are the infrastructure for [Nymconnect](https://nymtech.net/developers/quickstart/nymconnect-gui.html) they will support all apps on the [default whitelist](../nodes/network-requester.md#network-requester-whitelist): Keybase, Telegram, Electrum, Blockstream Green, and Helios.
+The `--provider` field needs to be filled with the Nym address of a Network Requester that can make network requests on your behalf. If you don't want to [run your own](https://nymtech.net/operators/nodes/network-requester.md) you can select one from the [mixnet explorer](https://explorer.nymtech.net/network-components/service-providers) by copying its `Client ID` and using this as the value of the `--provider` flag. Alternatively, you could use [this list](https://harbourmaster.nymtech.net/).

 #### Choosing a Gateway
 By default - as in the example above - your client will choose a random gateway to connect to.
@@ -112,9 +46,9 @@ By default - as in the example above - your client will choose a random gateway
 However, there are several options for choosing a gateway, if you do not want one that is randomly assigned to your client:
 * If you wish to connect to a specific gateway, you can specify this with the `--gateway` flag when running `init`.
 * You can also choose a gateway based on its location relative to your client. This can be done by appending the `--latency-based-selection` flag to your `init` command. This command means that to select a gateway, your client will:
-	* fetch a list of all availiable gateways
-	* send few ping messages to all of them, and measure response times.
-	* create a weighted distribution to randomly choose one, favouring ones with lower latency.
+    * fetch a list of all available gateways
+    * send few ping messages to all of them, and measure response times.
+    * create a weighted distribution to randomly choose one, favouring ones with lower latency.

 > Note this doesn't mean that your client will pick the closest gateway to you, but it will be far more likely to connect to gateway with a 20ms ping rather than 200ms

@@ -195,7 +129,7 @@ When trying to connect your app, generally the proxy settings are found in `sett

 Here is an example of setting the proxy connecting in Blockstream Green:

-![Blockstream Green settings](../images/wallet-proxy-settings/blockstream-green.gif)
+![Blockstream Green settings](../../images/blockstream-green.gif)

 Most wallets and other applications will work basically the same way: find the network proxy settings, enter the proxy url (host: **localhost**, port: **1080**).

@@ -1,6 +1,6 @@
 # Websocket Client

-> The Nym Websocket Client was built in the [building nym](../binaries/building-nym.md) section. If you haven't yet built Nym and want to run the code on this page, go there first.
+> The Nym Websocket Client was built in the [building nym](./building-nym.md) section. If you haven't yet built Nym and want to run the code on this page, go there first.

 ## Current version
 ```
@@ -0,0 +1 @@
+# Setup Guide
@@ -0,0 +1 @@
+# Command Documentation (Autogenerated)
@@ -25,6 +25,8 @@ You can check the necessary parameters for the available commands by running:
 ./nym-client <command> --help
 ```

+Or check the autogenerated command documentation on the [next page](./nym-client-commands.md).
+
 ## Initialising your client

 Before you can use the client, you need to initalise a new instance of it. Each instance of the client has its own public/private keypair, and connects to its own gateway node. Taken together, these 3 things (public/private keypair + gateway node identity key) make up an app's identity.
@@ -58,7 +58,7 @@ In some applications, e.g. where people are chatting with friends who they know,

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

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

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

@@ -1,7 +0,0 @@
-# DevRel AMAs
-
-The Nym Technology Developer Relations AMA (Ask Me Anything) is an event organised by the Nym team to engage and connect with the developer community as well as answer any questions that they may have.
-
-> ⚠️ Hosted every fortnight on Wednesday @ 4pm UTC
-
-Archives of these calls can be found [here](https://www.youtube.com/watch?v=0kVXR7aNOyg&list=PLoc3wV2YJYwohgwzf5IinyebV4GGYsa9K).
@@ -1,6 +0,0 @@
-# Forums
-
-Welcome to our page dedicated to providing you with links to open forums discussing privacy-enhancing technologies, as well as general privacy topics. These forums are a great place to learn more about the latest developments in privacy technology, as well as to connect with other individuals who are passionate about protecting their online privacy. Whether you're new to the world of privacy or an experienced user, you're sure to find valuable information and resources on these forums.
-
-
-🚧 coming soon 🚧
@@ -0,0 +1 @@
+# Development Overview
@@ -1,7 +1,5 @@
 # Nym General FAQ

-> If you have questions which are not answered below, please share them at our [DevRel AMAs](../community-resources/ama.md) or seek support in [Nym's community](https://nymtech.net/community)
-
 ### What is Nym? 

 Nym is a privacy platform that secures user data and protects against surveillance at the network level. 
@@ -198,7 +198,7 @@ For the moment then yes, the mixnet is free to use. There are no limits on the a
 No, although we do recommend that apps that wish to integrate look into running some of their own infrastructure such as gateways in order to assure uptime. 

 ### How can I find out if an application is already supported by network requester services? 
-You can check the [default allowed list](https://nymtech.net/.wellknown/network-requester/standard-allowed-list.txt) file to see which application traffic is whitelisted by default. If the domain is present on that list, it means that existing [network requesters](https://nymtech.net/docs/nodes/network-requester.html) can be used to privacy-protect your application traffic. Simply use [NymConnect](../quickstart/nymconnect-gui.md) to connect to this service through the mixnet.
+You can check the [default allowed list](https://nymtech.net/.wellknown/network-requester/standard-allowed-list.txt) file to see which application traffic is whitelisted by default. If the domain is present on that list, it means that existing [network requesters](https://nymtech.net/docs/nodes/network-requester.html) can be used to privacy-protect your application traffic. 

 Currently we are undergoing changes on this policy under the name [Project Smoosh](https://nymtech.net/operators/faq/smoosh-faq.html) where a new type of node [Exit Gateway](https://nymtech.net/operators/legal/exit-gateway.html) will allow users to connect to much wider range of domains, restricted by our new [exit policy](https://nymtech.net/.wellknown/network-requester/exit-policy.txt). Follow the changes [here](https://nymtech.net/operators/faq/smoosh-faq.html#what-are-the-changes).

@@ -1,106 +0,0 @@
-# Glossary
-
-__Familiarise yourself with Nym's specific terms and jargon through our glossary, making your understanding of Nym technology more enjoyable and educational.__
-
-## A
-**[Address](https://nymtech.net/docs/stable/integrations/addresses-in-nym/)** - A unique string of characters generated from a client keypair. Used to identify clients in the mixnet.
-
-**[Ack](https://nymtech.net/docs/architecture/traffic-flow.html#acks--package-retransmission)** - Short for "acknowledgement". Whenever a hop is completed, the recieving node will send back an 'ack', so that the sending node knows that the packet was recieved.
-
-**Attacker** - A person or entity who attempts to gain unauthorised access to a computer system, network, or other information resource.
-
-## B
-**Binary** - Is a type of computer file that contains machine code, which is a set of instructions that a computer can execute directly. The file consists of a series of 1s and 0s, which are the two digits used in the binary number system.
-
-**Blockchain** - A distributed database that maintains a continuously growing list of ordered records, called blocks.
-
-## C
-**[Coconut](https://nymtech.net/docs/stable/coconut/)** - A distributed cryptographic signing scheme providing a high degree of privacy for its users.
-
-**[CLI](https://nymtech.net/docs/stable/nym-cli/)** - A command-line interface (CLI) is a text-based user interface (UI) used to run programs, manage computer files and interact with the computer.
-
-**Credentials** - Unique values that prove the legitimacy of a user or individual.
-
-**Centralisation** - Refers to the concentration of control of an activity or organisation under a single authority, or small group of authorities.
-
-**[CosmWasm](https://cosmwasm.com)** - Cosmos WebAssembly is a WebAssembly (Wasm) interpreter that is used in the Cosmos SDK, a framework for building decentralised applications (dApps) on the Cosmos network. It allows us to write smart contracts in Rust and then compile them to webassembly to be uploaded on the blockchain.
-
-## D
-**DAO** - Stands for Decentralised Autonomous Organisation. A type of organisation made up of smart contracts on a blockchain. It operates on a set of rules encoded in a computer program, and is governed by the people who use it, rather than by a central authority.
-
-**[Delegating NYM](https://medium.com/coinmonks/what-you-have-to-know-about-staking-and-delegating-458b6d2300a5)** - Similar to bonding but by non-operators and as proof of their trust in a node operator providing a good quality of service. 
-
-**Decentralisation** - Refers to the transfer of control and decision-making from a centralised entity (individual, organization, or group thereof) to a distributed network.
-
-## E
-**Encryption** - The process of encoding information.
-
-## G
-**[Gateways](https://blog.nymtech.net/gateways-to-privacy-51196005bf5)** - The entrance to the mixnet that encrypted packets must pass through before being forwarded to mix nodes. They also act as a sort of mailbox for messages.
-
-**[Gateway Bonding](https://nymtech.net/docs/stable/run-nym-nodes/nodes/gateways/#bonding-your-gateway)** - The action of node operators to bond their stake (in the form of NYM tokens) to a Gateway in order to join the network topology and begin routing traffic through.
-
-## I
-**IPFS** - Stands for InterPlanetary File System. It's a decentralised, peer-to-peer protocol for sharing and storing files. It is designed to make it easier to share and access large amounts of data in a distributed manner, without the need for a central server or authority
-
-## M
-**[Metadata](https://www.opendatasoft.com/en/blog/what-is-metadata-and-why-is-it-important-data)** - A set of data that describes and gives information about other data such as IP addresses, device types, geolocations etc.
-
-**[Mixnet](https://nymtech.net/docs/architecture/traffic-flow.html#mixnet-traffic-flow-1)** - A routing protocol which encrypts and mixes Sphinx packet traffic so that it cannot be determined who is communicating with whom. 
-
-**[Mix Nodes](https://blog.nymtech.net/nym-mixnodes-deep-dive-d2b91917f097)** - The backbone of the Nym infrastructure, that are organised in a three-layer network referred to as the mixnet that network traffic passes through. It mixes, hides and reorders traffic and are rewarded in NYM tokens for their quality of service.
-
-**[Mix node Bonding](https://nymtech.net/docs/stable/run-nym-nodes/nodes/mixnodes/#bonding-your-mix-node)** - The action of node operators bonding their stake (in the form of NYM tokens) to a Mix node in order to join the network topology and begin routing traffic through.
-
-## N
-**[Network Requester](https://nymtech.net/docs/stable/run-nym-nodes/nodes/requester)** - Is a binary that can be ran alongside a Nym Client on a VPS, which allows for private network requests to be made outside the mixnet from you local Nym client
-
-**Nym** - The in-text name of the organisation.
-
-**[Nym Typescript SDK](https://nymtech.net/docs/stable/sdk/overview)** - A Typescript software development kit which allows developers to build browser-based Mixnet application.
-
-**[NYM](https://nymtech.net/docs/stable/nym-cli/#send-tokens-to-an-account)** - Natively distributed token. 
-
-**[Nym Wallet](https://nymtech.net/docs/stable/wallet/)** - The Nym Wallet handles all things regarding handling Nym Tokens about your Nym Node. It is a GUI application that can be downloaded and run on your machine.
-
-**[Nym Technologies SA](https://nymtech.net)** - The official company name.
-
-**[Nyx](https://nymtech.net/docs/stable/integrations/payment-integration-overview/)** - A CosmWasm-enabled blockchain smart contracts platform that functions as the backbone of the Nym network, used to keep track and provide the history of the NYM token's transactions.
-
-## P
-**Payload** - The carrying capacity of a packet or other transmission data unit.
-
-**Pledge** - The number of tokens that are put up by node operators on their nodes as their commitment to provide good quality of service and insure against future bad behaviour.
-
-**Private Key** - A large numerical value that is used to decrypt data.
-
-**Proof-of-Mixing** - The reward of NYM tokens is based on the good quality of service carried out by node operators.
-
-**POC** - Stands for Proof of Concept. It's a demonstration that a proposed product, system, or service can be built and will work as intended. It is a way of testing whether an idea is feasible and likely to succeed.
-
-**Public Key** - A large numerical value that is used to encrypt data.
-
-## S
-**Sphinx** - A cryptographic message format used to relay anonymised messages within the mixnet, also used by the Lightning Network or something similar.
-
-**[Socks5](https://en.wikipedia.org/wiki/SOCKS)** - An proxy protocol that exchanges network packets between a client and server through a proxy server.
-
-**[Service Provider](https://nymtech.net/docs/stable/tutorials/nym-simple-websocket-tutorial/)** - Any type of app that can communicate with the mixnet via a Nym Client.
-
-**[SURBs](https://nymtech.net/docs/architecture/traffic-flow.html#private-replies-using-surbs)** - Stands for 'Single Use Reply Blocks'. They are a type of crytographic construct used to facilitate secure communication between parties and are designed to allow a sender to send a message to a recipient in sucha a way that the message can only be read by the intended recipient, and cannot be read by anyone else.
-
-**Sybil** - In the context of computer networks, a Sybil attach is a type of security attack in which an attacker creates multiple fake identities or "sybils" and uses them to manipulate a network thus gaining control of a network by overwhelming it.
-
-## T
-**Tokenomics** - Is the study of the economic and financial aspects of a cryptocurrency or blockchain-based project. It involves the creation, distribution, and management of tokens, which are digital assets that represent a certain value of utility whithin a particular ecosystem.
-
-## V
-**[Validators](https://nymtech.net/docs/stable/run-nym-nodes/nodes/validators/)** - Secures the Nyx blockchain with a staking token, defending the network from attacks.
-
-**[VPS](https://en.wikipedia.org/wiki/Virtual_private_server)** - Stands for Virtual Private Server. Its a virtual machine that acts as an isolated virtual environment on a physical server operated by a cloud, web or internet hosting provider.
-
-## W
-**Websocket** - A computer communications protocol that provides a full-duplex channel over a single TCP connection. It is designed to be used as a base for real-time, two-way communication between a client and a server over the web.
-
-## Z
-**Zero Knowledge Proofs** - Cryptographic techniques that make it possible to prove something to be true without having to reveal the evidence. 
@@ -1,14 +0,0 @@
-# Change Service Grantee Information
-
-If you wish to update any of the following information: 
- - `Email Address`
- - `NYM address`
- - `Network Requester`
- - `Gateway ID Key` 
- - `Gateway Address`
- - `Service`
- - `Payment Address` 
-
-Please reach out either in the `#service-grantees` channel on Discord or on [Matrix](https://matrix.to/#/#nym-community:nymtech.chat). 
-
-
@@ -11,4 +11,4 @@ For more in-depth information on the network architecture, head to the [Network
 If you would like to concentrate on building an application that uses the mixnet:
 * Explore the [Quickstart](../quickstart/overview.md) options.
 * Check out examples of [Community Apps](../community-resources/community-applications-and-guides.md). 
-* Run through the [Rust SDK](../tutorials/rust-sdk.md) or [Typescript](../tutorials/typescript.md) tutorials. 
+* Run through the [Rust SDK](../tutorials/archive/setups/rust-sdk.md) or [Typescript](../tutorials/archive/setups/typescript.md) tutorials. 
@@ -1,13 +1,11 @@
 # Integration Options
-If you've already gone through the different [Quick Start](../quickstart/overview.md) options and had a look at the tutorials, you have seen the possibilities available to you for quickly connecting existing application code to another Nym process. 
-
 Below are a resources that will be useful for either beginning to integrate mixnet functionality into existing application code or build a new app using Nym.  

 - **We suggest you begin with this [integration decision tree](https://sdk.nymtech.net/integrations)**. This will give you a better idea of what pieces of software (SDKs, standalone clients, service providers) your integration might involve, and what is currently possible to do with as little custom code as possible. 

 - The [integrations FAQ](../faq/integrations-faq.md) has a list of common questions regarding integrating with Nym and Nyx, as well as commonly required links. 

- To get an idea of what is possible / has already been built, check the [community applications and resources](../community-resources/community-applications-and-guides.md) page, as well as the [developer tutorials codebase](https://github.com/nymtech/developer-tutorials). 
+- To get an idea of what is possible / has already been built, check the [community applications and resources](../community-resources/community-applications-and-guides.md) page. 

 > If you wish to integrate with the Nyx blockchain to use `NYM` for payments, start with the [payment integration](./payment-integration.md) page.

@@ -2,7 +2,7 @@

 If you want to integrate with Nym in order to send `NYM` tokens (for instance, if running a `NYM` <-> `BTC` swap application, or using `NYM` for payments), then you will need to interact with the Nyx blockchain. 

-Nyx is the blockchain supporting the Nym network, hosting both the `NYM` and `NYX` cryptocurrencies, the CosmWasm smart contracts keeping track of the network, and (coming soon) facilitating zk-Nym credential generation. It is built with the [Cosmos SDK](https://tendermint.com/sdk/).
+Nyx is the blockchain supporting the Nym network, hosting both the `NYM` and `NYX` cryptocurrencies, the CosmWasm smart contracts keeping track of the network, and facilitating zk-Nym credential generation. It is built with the [Cosmos SDK](https://tendermint.com/sdk/).

 ### Interacting with the Nyx blockchain 
 Check out the integration options in the [Integration FAQ](../faq/integrations-faq.md#how-can-i-use-json-rpc-methods-to-interact-with-the-nyx-blockchain). 
@@ -1,9 +1,20 @@
-# NymVPN alpha CLI Guide
+# NymVPN CLI Guide

 ```admonish info
-NymVPN is an experimental software and it's for testing purposes only. All users testing the client are expected to sign GDPR Information Sheet and Consent Form (shared at the workshop) so we use their results to improve the client, and submit the form [*NymVPN User research*]({{nym_vpn_form_url}}) with the testing results.
+NymVPN is an experimental software and it's for testing purposes only. Anyone can submit a registration to the private alpha round on [nymvpn.com](https://nymvpn.com/en).
 ```

+## Overview
+
+The core binaries consist of:
+
+- **`nym-vpn-cli`**: Basic commandline client for running the vpn. This runs in the foreground.
+
+- **`nym-vpnd`**: Daemon implementation of the vpn client that can run in the background and interacted with using `nym-vpnc`.
+
+- **`nym-vpnc`**: The commandline client used to interact with `nym-vpnd`.
+
+
 ## Installation

 > Any syntax in `<>` brackets is a user's/version unique variable. Exchange with a corresponding name without the `<>` brackets.
@@ -15,47 +26,93 @@ NymVPN is an experimental software and it's for testing purposes only. All users
 echo "<SHA_STRING>" | shasum -a 256 -c

 # choose a correct one according to your binary, this is just an example
-# echo "0e4abb461e86b2c168577e0294112a3bacd3a24bf8565b49783bfebd9b530e23  nym-vpn-cli_<!-- cmdrun scripts/nym_vpn_cli_version.sh -->_ubuntu-22.04_amd64.tar.gz" | shasum -a 256 -c
+# echo "0e4abb461e86b2c168577e0294112a3bacd3a24bf8565b49783bfebd9b530e23  nym-vpn-cli_<!-- cmdrun ../../../scripts/cmdrun/nym_vpn_cli_version.sh -->_ubuntu-22.04_amd64.tar.gz" | shasum -a 256 -c
 ```

 3. Extract files:
 ```sh
 tar -xvf <BINARY>.tar.gz
 # for example
-# tar -xvf nym-vpn-cli_<!-- cmdrun scripts/nym_vpn_cli_version.sh -->_ubuntu-22.04_x86_64.tar.gz
+# tar -xvf nym-vpn-cli_<!-- cmdrun ../../../scripts/cmdrun/nym_vpn_cli_version.sh -->_ubuntu-22.04_x86_64.tar.gz
 ```

-4. Make executable:
+## Running
+
+If you are running Debian/Ubuntu/PopOS or any other distributio supporting debian packages and systemd, see the [relevant section below](#debian-package-for-debianubuntupopos).
+
+### Daemon
+
+Start the daemon with
+
 ```sh
-# make sure you are in the right sub-directory
-chmod u+x nym-vpn-cli
+sudo -E ./nym-vpnd
 ```

-## Run NymVPN
+Then run

-**For NymVPN to work, all other VPNs must be switched off!** At this alpha stage of NymVPN, the network connection (wifi) must be reconnected after or in between the testing rounds.
-
-Make sure your terminal is open in the same directory as your `nym-vpn-cli` binary.
-
-1. Run it as root with `sudo` - the command will look like this with specified arguments:
 ```sh
-# choose only one conditional --argument listed in {brackets}
-sudo ./nym-vpn-cli { --exit-router-address <EXIT_ROUTER_ADDRESS>|--exit-gateway-id <EXIT_GATEWAY_ID>|--exit-gateway-country <EXIT_GATEWAY_COUNTRY> }
+./nym-vpnc status
+./nym-vpnc connect
+./nym-vpnc disconnect
 ```

-2. To choose different Gateways, visit [explorer.nymtech.net/network-components/gateways](https://explorer.nymtech.net/network-components/gateways) and copy-paste an identity key of your choice
+### CLI
+
+An alternative to the daemon is to run the `nym-vpn-cli` commandline client that runs in the foreground.
+```sh
+./nym-vpn-cli run
+```
+
+## Credentials
+
+NymVPN uses [zkNym bandwidth credentials](https://nymtech.net/docs/bandwidth-credentials.html). Those can be imported as a file or base58 encoded string.
+
+
+```sh
+sudo -E ./nym-vpn-cli import-credential --credential-path </PATH/TO/freepass.nym>
+sudo -E ./nym-vpn-cli import-credential --credential-data "<STRING>"
+```
+
+## Debian package for Debian/Ubuntu/PopOS
+
+For linux platforms using deb packages and systemd, there are also debian packages.
+
+```sh
+sudo apt install ./nym-vpnd_<!-- cmdrun ../../../scripts/cmdrun/nym_vpn_cli_version.sh -->-1_amd64.deb ./nym-vpnc_<!-- cmdrun ../../../scripts/cmdrun/nym_vpn_cli_version.sh -->-1_amd64.deb
+
+# In case of error please substitute the correct version
+```
+
+Installing the `nym-vpnd` deb package starts a `nym-vpnd.service`. Check that the daemon is running with
+```sh
+systemctl status nym-vpnd.service
+```
+and check its logs with
+```sh
+sudo journalctl -u nym-vpnd.service -f
+```
+To stop the background service
+```sh
+systemctl stop nym-vpnd.service
+```
+It will start again on startup, so disable with
+```sh
+systemctl disable nym-vpnd.service
+```
+
+Interact with it with `nym-vpnc`
+```sh
+nym-vpnc status
+nym-vpnc connect
+nym-vpnc disconnect
+```
+
+## Commands & Options

 ```admonish note
-Nym Exit Gateway functionality was implemented just recently and not all the Gateways are upgraded and ready to handle the VPN connections. If you want to make sure you are connecting to a Gateway with an embedded Network Requester, IP Packet Router and applied Nym exit policy, visit [this page](https://nymtech.net/events/fast-and-furious), scroll down to the list and search Gateways with all the functionalities enabled.
+Nym Exit Gateway functionality was implemented just recently and not all the Gateways are upgraded and ready to handle the VPN connections. If you want to make sure you are connecting to a Gateway with an embedded Network Requester, IP Packet Router and applied Nym exit policy, visit [harbourmaster.nymtech.net](https://harbourmaster.nymtech.net/) and search Gateways with all the functionalities enabled.
 ```

-3. See all possibilities in [command explanation](#cli-commands-and-options) section below
-
-4. In case of errors, see [troubleshooting section](troubleshooting.md)
-
-
-### CLI Commands and Options
-
 The basic syntax of `nym-vpn-cli` is:
 ```sh
 # choose only one conditional --argument listed in {brackets}
@@ -68,49 +125,18 @@ To see all the possibilities run with `--help` flag:
 ```
 ~~~admonish example collapsible=true title="Console output"
 ```sh
-Usage: nym-vpn-cli [OPTIONS] <--exit-router-address <EXIT_ROUTER_ADDRESS>|--exit-gateway-id <EXIT_GATEWAY_ID>|--exit-gateway-country <EXIT_GATEWAY_COUNTRY>>
+Usage: nym-vpn-cli [OPTIONS] <COMMAND>
+
+Commands:
+  run                Run the client
+  import-credential  Import credential
+  help               Print this message or the help of the given subcommand(s)

 Options:
-  -c, --config-env-file <CONFIG_ENV_FILE>
-          Path pointing to an env file describing the network
-      --mixnet-client-path <MIXNET_CLIENT_PATH>
-          Path to the data directory of a previously initialised mixnet client, where the keys reside
-      --entry-gateway-id <ENTRY_GATEWAY_ID>
-          Mixnet public ID of the entry gateway
-      --entry-gateway-country <ENTRY_GATEWAY_COUNTRY>
-          Auto-select entry gateway by country ISO
-      --entry-gateway-low-latency
-          Auto-select entry gateway by latency
-      --exit-router-address <EXIT_ROUTER_ADDRESS>
-          Mixnet recipient address
-      --exit-gateway-id <EXIT_GATEWAY_ID>
-
-      --exit-gateway-country <EXIT_GATEWAY_COUNTRY>
-          Mixnet recipient address
-      --enable-wireguard
-          Enable the wireguard traffic between the client and the entry gateway
-      --private-key <PRIVATE_KEY>
-          Associated private key
-      --wg-ip <WG_IP>
-          The IP address of the wireguard interface used for the first hop to the entry gateway
-      --nym-ipv4 <NYM_IPV4>
-          The IPv4 address of the nym TUN device that wraps IP packets in sphinx packets
-      --nym-ipv6 <NYM_IPV6>
-          The IPv6 address of the nym TUN device that wraps IP packets in sphinx packets
-      --nym-mtu <NYM_MTU>
-          The MTU of the nym TUN device that wraps IP packets in sphinx packets
-      --disable-routing
-          Disable routing all traffic through the nym TUN device. When the flag is set, the nym TUN device will be created, but to route traffic through it you will need to do it manually, e.g. ping -Itun0
-      --enable-two-hop
-          Enable two-hop mixnet traffic. This means that traffic jumps directly from entry gateway to exit gateway
-      --enable-poisson-rate
-          Enable Poisson process rate limiting of outbound traffic
-      --disable-background-cover-traffic
-          Disable constant rate background loop cover traffic
-  -h, --help
-          Print help
-  -V, --version
-          Print version
+  -c, --config-env-file <CONFIG_ENV_FILE>  Path pointing to an env file describing the network
+      --data-path <DATA_PATH>              Path to the data directory of the mixnet client
+  -h, --help                               Print help
+  -V, --version                            Print version
 ```
 ~~~

@@ -143,9 +169,9 @@ If you want to run NymVPN CLI in Nym Sandbox environment, there are a few adjust
 curl -o sandbox.env -L https://raw.githubusercontent.com/nymtech/nym/develop/envs/sandbox.env
 ```

-1. Check available Gateways at [nymvpn.com/en/alpha/api/gateways](https://nymvpn.com/en/alpha/api/gateways)
+2. Check available Gateways at [nymvpn.com/en/alpha/api/gateways](https://nymvpn.com/en/alpha/api/gateways)

-2. Run with a flag `-c`
+3. Run with a flag `-c`
 ```sh
 sudo ./nym-vpn-cli -c <PATH_TO>/sandbox.env <--exit-router-address <EXIT_ROUTER_ADDRESS>|--exit-gateway-id <EXIT_GATEWAY_ID>|--exit-gateway-country <EXIT_GATEWAY_COUNTRY>>
 ```
@@ -2,20 +2,12 @@

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

-**Nym proudly presents NymVPN alpha** - a client that uses [Nym Mixnet](https://nymtech.net) to anonymise all of a user's internet traffic through either a 5-hop mixnet (for a full network privacy) or the faster 2-hop decentralised VPN (with some extra features).
+**NymVPN alpha** is a client that uses [Nym Mixnet](https://nymtech.net) to anonymise all of a user's internet traffic through either a 5-hop mixnet (for a full network privacy) or the faster 2-hop decentralised VPN (with some extra features).


-**You are invited to take part in the alpha testing** of this new application. The following pages provide a how-to guide, explaining steps to install and run NymVPN [CLI](cli.md) and [GUI](gui.md).
+**You are invited to take part in the alpha testing** of this new application. Register for private testing round at [nymvpn.com](https://nymvpn.com/en), that will grant you access to the [download page](https://nymvpn.com/download). Visit [NymVPN Support & FAQ](https://nymvpn.com/en/support) or join the [NymVPN matrix channel](https://matrix.to/#/#NymVPN:nymtech.chat) if you have any questions, comments or blockers.

-**Here is how**
-
-1. Go to the NymVPN [testers form]({{nym_vpn_form_url}})
-2. Fill and submit the [form!]({{nym_vpn_form_url}})
-3. To test the GUI, [go here](gui.md)
-4. To test the CLI, [go here](cli.md)
-5. Join the [NymVPN matrix channel](https://matrix.to/#/#NymVPN:nymtech.chat) if you have any questions, comments or blockers
-
-***NymVPN alpha testing will last from 15th of January - 15th of February.***
+Checkout the [release page](https://github.com/nymtech/nym-vpn-client/releases) for available binaries.

 *NOTE: NymVPN alpha is experimental software for testing purposes only.*

@@ -36,16 +28,7 @@ client ───► Gateway ──┘  mix  │  mix  ┌─►mix ───►
                         mix  └─►mix──┘  mix
 ```

-Users can switch to 2-hop only mode, which is a faster but less private option. In this mode traffic is only sent between the two Gateways, and is not passed between Mix Nodes.
-
-The client can optionally do the first hop (local client to Entry Gateway) using Wireguard. NymVPN uses Mullvad libraries for wrapping `wireguard-go` and to setup local routing rules to route all traffic to the TUN virtual network device.
-
-## NymVPN Resources & Guides
-
-* [NymVPN webpage](https://nymvpn.com)
-* [Alpha release page]({{nym_vpn_releases}})
-* [NymVPN application (GUI) guide](gui.md)
-* [NymVPN Command Line Interface (CLI) guide](cli.md)
-* [Troubleshooting](troubleshooting.md)
-* [NymVPN FAQ](faq.md)
-* [NymVPN matrix channel](https://matrix.to/#/#NymVPN:nymtech.chat)
+Users can switch to 2-hop only mode, which is a faster but less private option. In this mode traffic is only sent between the two Gateways, and is not passed between Mix Nodes. It uses Mixnet Sphinx packets with shorter, fixed routes, which improve latency, but doesn't offer the same level of protection as the 5 hop mode.
+<!-- TO BE IMPLEMENTED:
+Users can switch to 2-hop only mode, which is a faster but less private option. In this mode traffic is only sent between the two Gateways, and is not passed between Mix Nodes. The client than use two wireguard tunnels with the entry and exit gateway, the Exit Gateway one being tunnelled itself through the entry gateway tunnel. NymVPN uses Mullvad libraries for wrapping `wireguard-go` and to setup local routing rules to route all traffic to the TUN virtual network device.
+-->
@@ -3,7 +3,7 @@
 The Nyx blockchain is based on [CosmWasm](https://cosmwasm.com/). It allows users to code smart contracts in a safe subset of the Rust programming language, easily export them to WebAssembly, and upload them to the blockchain. Information about the chain can be found on the [Nyx blockchain explorer](https://nym.explorers.guru/). 

 There are currently two smart contracts on the Nyx chain: 
-* the [Mixnet contract](./mixnet-contract.md) which manages the network topology of the mixnet, tracking delegations and rewarding. 
-* the [Vesting contract](./vesting-contract.md) which manages `NYM` token vesting functionality.  
+* the [Mixnet contract](mixnet-contract.md) which manages the network topology of the mixnet, tracking delegations and rewarding. 
+* the [Vesting contract](vesting-contract.md) which manages `NYM` token vesting functionality.  

 > Users will soon be able to create and upload their own CosmWasm smart contracts to Nyx and take advantage of applications such as the Coconut Credential Scheme - more to be announced regarding this very soon.
@@ -1,5 +0,0 @@
-# Chat demo (webapp)
-
-You can find a browser-based 'hello world' chat app [here](https://chat-demo.nymtech.net).
-
-Either open in two browser windows and send messages to yourself, or share with a friend and send messages to each other through the mixnet.
@@ -1,5 +0,0 @@
-# Coconut Credential Playground (webapp)
-
-There is a coconut-scheme based Credential Library playground [here](https://coco-demo.nymtech.net/). This is a WASM implementation of our Coconut libraries which generate raw Coconut credentials. Test it to create and re-randomize your own credentials.
-
-For more information on what is happening here check out the [Coconut docs](https://nymtech.net/docs/coconut.html).
@@ -1,22 +0,0 @@
-# NymConnect Beta (GUI)
-
-NymConnect is a one-button GUI application that wraps around the `nym-socks5-client` for proxying application traffic through the Mixnet. 
-
-You can watch our video on getting started with NymConnect: 
-
-<iframe width="700" height="400" src="https://www.youtube.com/embed/quj8H2qeOwY" title="YouTube video player" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share" allowfullscreen></iframe>
-
-Install NymConnect and select an application that you want to privacy-enhance from the dropdown menu. For now, NymConnect can be used with Electrum Wallet, Keybase, desktop Telegram and Blockstream Green. Configure these to run via a SOCKS5 proxy and send their data through the Nym mixnet!
-
-**Please note that NymConnect is currently released in beta. Please report bugs via Github**. 
-
-## Usage instuctions 
-* [Download](https://github.com/nymtech/nym/releases/) and install NymConnect.
-* Select your service provider from the dropdown menu.
-* Click `connect` - NymConnect will connect to a service provider and its SOCKS Proxy (IP) and Port will be displayed.
-* Click on IP or Port to copy their values to the clipboard.
-* Go to your app settings and look for the network/proxy settings. Select `running via SOCKS5 proxy` and paste the IP and Port values given by NymConnect.
-
-Your traffic from that application will now run through the mixnet for privacy and unlinkability!
-
-
@@ -1,7 +0,0 @@
-# Overview
-
-There are multiple options to quickly connect to Nym and play with both the mixnet and credentials on the Sandbox testnet.
-
-At most, these involve running Nym as a second process alongside an existing application in order to send traffic through the mixnet, most are either interact webpages or a standalone app.
-
-If you've already covered the information in this section, or want to jump straight into integrating/ a Nym connection into an existing application, head to the [Integrations](../integrations/integration-options.md) section.
@@ -1,45 +0,0 @@
-# SOCKS Proxy (CLI)
-
->The `socks5` client now also supports SOCKS4 and SOCKS4A protocols as well as SOCKS5.
-
-The Nym socks5 client allows you to proxy traffic from a desktop application through the mixnet, meaning you can send and receive information from remote application servers without leaking metadata which can be used to deanonymise you, even if you're using an encrypted application such as Signal.
-
-### Download or compile socks5 client
-
-If you are using OSX or a Debian-based operating system, you can download the `nym-socks5-client` binary from our [Github releases page](https://github.com/nymtech/nym/releases).
-
-If you are using a different operating system, head over to the [Building from Source](https://nymtech.net/docs/binaries/building-nym.html) page for instructions on how to build the repository from source.
-
-### Initialise your socks5 client
-
-Use the following command to initialise your socks5 client with the address of a Nym-operated [Network Requester](https://nymtech.net/docs/nodes/network-requester.html) as a provider (the endpoint that will be proxying your traffic out of the mixnet) for ease:
-
-```
-./nym-socks5-client init --id quickstart --provider Entztfv6Uaz2hpYHQJ6JKoaCTpDL5dja18SuQWVJAmmx.Cvhn9rBJw5Ay9wgHcbgCnVg89MPSV5s2muPV2YF1BXYu@Fo4f4SQLdoyoGkFae5TpVhRVoXCF8UiypLVGtGjujVPf
-```
-
-You can always check out the list of endpoints you can use otherwise on the [mixnet service provider explorer page](https://explorer.nymtech.net/network-components/service-providers).
-
-### Start your socks5 client
-Now your client is initialised, start it with the following:
-
-```
-./nym-socks5-client run --id quickstart
-```
-
-### Proxying traffic
-After completing the steps above, your local socks5 Client will be listening on `localhost:1080` ready to proxy traffic to the Network Requester set as the `--provider` when initialising.
-
-When trying to connect your app, generally the proxy settings are found in `settings->advanced` or `settings->connection`.
-
-Here is an example of setting the proxy connecting in Blockstream Green:
-
-![Blockstream Green settings](../images/blockstream-green.gif)
-
-Most wallets and other applications will work basically the same way: find the network proxy settings, enter the proxy url (host: **localhost**, port: **1080**).
-
-In some other applications, this might be written as **localhost:1080** if there's only one proxy entry field.
-
-## Further reading
-
-If you want to dig more into the architecture and use of the socks5 client check out its documentation [here](https://nymtech.net/docs/clients/socks5-client.html).
@@ -1,9 +1,9 @@
 # Coconut credential generation
-The following code shows how you can use the SDK to create and use a [credential](../../../bandwidth-credentials.md) representing paid bandwidth on the Sandbox testnet.
+The following code shows how you can use the SDK to create and use a [credential](https://nymtech.net/docs/bandwidth-credentials.md) representing paid bandwidth on the Sandbox testnet.

 ```rust,noplayground
 {{#include ../../../../../../sdk/rust/nym-sdk/examples/bandwidth.rs}}
 ```

-You can read more about Coconut credentials (also referred to as `zk-Nym`) [here](../../../coconut.md).
+You can read more about Coconut credentials (also referred to as `zk-Nym`) [here](https://nymtech.net/docs/coconut.md).

@@ -1,13 +1,11 @@
 # Anonymous Replies with SURBs (Single Use Reply Blocks)
 Both functions used to send messages through the mixnet (`send_message` and `send_plain_message`) send a pre-determined number of SURBs along with their messages by default.

-The number of SURBs is set [here](https://github.com/nymtech/nym/blob/master/sdk/rust/nym-sdk/src/mixnet/client.rs#L33).
-
 ```rust,noplayground
 {{#include ../../../../../../sdk/rust/nym-sdk/src/mixnet/client.rs:33}}
 ```

-You can read more about how SURBs function under the hood [here](../../../architecture/traffic-flow.md#private-replies-using-surbs).
+You can read more about how SURBs function under the hood [here](https://nymtech.net/docs/architecture/traffic-flow.md#private-replies-using-surbs).

 In order to reply to an incoming message using SURBs, you can construct a `recipient` from the `sender_tag` sent along with the message you wish to reply to:

@@ -1,7 +1,7 @@
 # Message Helpers

 ## Handling incoming messages
-As seen in the [Chain querier tutorial](https://github.com/nymtech/developer-tutorials/blob/0130ee5a61cd6801bdcfc84608b2a520b5392714/rust/chain-query-service/) when listening out for a response to a sent message (e.g. if you have sent a request to a service, and are awaiting the response) you will want to await [non-empty messages (if you don't know why, read the info on this here)](troubleshooting.md#client-receives-empty-messages-when-listening-for-response). This can be done with something like the helper functions [here](https://github.com/nymtech/developer-tutorials/blob/0130ee5a61cd6801bdcfc84608b2a520b5392714/rust/chain-query-service/src/lib.rs#L71): 
+When listening out for a response to a sent message (e.g. if you have sent a request to a service, and are awaiting the response) you will want to await non-empty messages [(if you don't know why, read the info on this here)](troubleshooting.md#client-receives-empty-messages-when-listening-for-response). This can be done with something like the helper functions [here](https://github.com/nymtech/developer-tutorials/blob/0130ee5a61cd6801bdcfc84608b2a520b5392714/rust/chain-query-service/src/lib.rs#L71): 

 ```rust
 use nym_sdk::mixnet::ReconstructedMessage; 
@@ -0,0 +1 @@
+# Interacting with Clients - Read First!
@@ -1,53 +0,0 @@
-# Hackathon Challenges
-There are a few different challenges to choose from, each with different approaches. It is also recommended to check out the _**Examples**_ directory above for inspiration. 
-
-## Tooling challenge
-The tooling challenge involves creating tooling for users, operators, or developers of Nym.
-
-### Examples of user-centric tools:
- Facilitate onboarding new users more easily to staking their Nym, and understanding the pros and cons, as well as finding a good node to stake on. Examples of tools like this:
-    - [ExploreNym dashboard](https://explorenym.net/)
-
- Show information on a dashboard about the network. NOTE due to the amount of dashboards currently available, we expect a good justification for why / something to set this apart from existing ones e.g. it is presenting information that is not already presented, or it is presented in a different manner, such as a TUI or CLI app instead of a web dashboard - maybe an onion service, or no-JS site for those who do not wish to enable Javascript in their day-to-day browsing. Examples of tools like this:
-    - [NTV's node dashboard](https://status.notrustverify.ch/d/CW3L7dVVk/nym-mixnet?orgId=1)
-    - [IsNymUp dashboard](https://isnymup.com/)
-
-### Examples of operator-centric tooling:
- An APY calculator for determining different financial outcomes of running a node in different situations. 
-    
- Scripting for updating and maintaining nodes. Examples of tools like this:
-    - [ExploreNym's bash scripts](https://github.com/ExploreNYM/bash-tool) 
-
- Scripting for packaging node binaries for different OSes.
-
-### Examples of developer-centric tooling:
- Tooling for use in development: are there pain points you’ve found when developing apps with Nym that you have created scripts/hacks/workarounds for? Is there a pain point that you’ve thought ‘oh it would be great if I could just do X’? These are often the best places to start for building out developer tooling - if you’ve run into this issue, it's very likely someone else already has, or will!
-
- Interacting with one of the SDKs via FFI: perhaps you’re a Go developer who would love to have the functionality of one of the Nym SDKs. Building an FFI tool might be something that would make your life easier, and can be shared with other developers in your situation. 
-
-## Integrations challenge
-Integration options for Nym are currently relatively restrictive due to the manner in which Nym handles sending and receiving traffic (as unordered Sphinx packets). This challenge will involve (most likely) implementing custom logic for handling Nym traffic for an existing application.
-
-There are several potential avenues developers can take here:
- If your application (or the application you wish to modify) is written in either Javascript or Typescript, and relies on the `fetch` library to make API calls, then you can use its drop-in replacement: [`mixfetch`](). Perhaps you wish to interact with Coingecko, or a private search engine like Kagi without leaking your IP and metadata, or an RPC endpoint.
-    - Example with [NTV’s privacy-preserving Coingecko API](https://github.com/notrustverify/mixfetch-examples)
-    - [Mixfetch docs examples](https://github.com/nymtech/nym/tree/develop/sdk/typescript/examples)
-
- If you instead have an application that is able to use any of the SOCKS5, 4a, or 4 protocols (a rule of thumb: if it can communicate over Tor, it will) then you can experiment with using Nym as the transport layer. 
-  - For Rustaceans, check out our [socks5 rust sdk example](https://nymtech.net/docs/sdk/rust.html#socks-client-example).  
-  - For those of you who aren’t Crustaceans, then you will have to run the [Socks Client]() alongside your application as a separate process. _NOTE If you are taking this route, please make sure to include detailed documentation on how you expect users to do this, as well as including any process management tools, scripts, and configs (e.g. if you use systemd then include the configuration file for the client, as well as initialisation logic) that may streamline this process._
-    - [NTV's PasteNym backend](https://github.com/notrustverify/pastenym) is a great example of an application with this architecture. 
-
- Nym is not only useful for blockchain-related apps, but for anything that requires network level privacy! Email clients, messaging clients, and decentralised storage are all key elements of the privacy-enabled web. Several of these sorts of apps can be found in the [community apps page](../community-resources/community-applications-and-guides.md). 
-
- There is currently a proof of concept using Rust Libp2p with Nym as a transport layer. Perhaps you can think of an app that uses Gossipsub for p2p communication could benefit from network-level privacy. 
-  - [GossipSub chat example](https://github.com/nymtech/nym/tree/develop/sdk/rust/nym-sdk/examples/libp2p_chat) 
-  - [Chainsafe's Lighthouse Nym PoC](https://github.com/ChainSafe/lighthouse/blob/nym/USE_NYM.md#usage)
-
- Alternatively if you know of an app that is written in Rust or TS and could benefit from using Nym, you could fork and modify it using the SDKs. Applications such as:
-  - Magic Wormhole (has a [rust implementation](https://github.com/magic-wormhole/magic-wormhole.rs))
-  - [Qual](https://github.com/qaul/qaul.net) (uses Rust Libp2p)
-  - [Syncthing](https://github.com/syncthing/syncthing)
-
-### MiniApp challenge 
-Write an app, either using one of the SDKs or a standalone client (harder). Think of what you can ‘nymify’ e.g. a version of the [TorBirdy](https://support.torproject.org/glossary/torbirdy/) extension that uses Nym instead of Tor. This is very similar to the Integration challenge in terms of the different potential _architectures_ and approaches, but just for new applications. 
@@ -1,16 +0,0 @@
-# General Info & Resources 
-Discussions and announcements will be taking place in the [builders channel on Matrix](https://matrix.to/#/#shipyardbuilders:nymtech.chat). This channel can be used for all discussions. 
-
-There will be daily office horse between 12-14:00 CET. 
-
-This is an open call and questions will be answered on a first come first serve basis. 
-
-The timetable can be found on the [Shipyard website](https://nymtech.net/learn/shipyard). 
-
-## Links 
- You can find **code examples**, **tutorials**, & **quickstart** information here, on the Developer Portal. 
- [Rust SDK docs](https://nymtech.net/docs/sdk/rust.html)
- [Typescript SDK docs](https://sdk.nymtech.net)
- [Platform docs](https://nymtech.net/docs)
- [NoTrustVerify's Awesome Nym list](https://github.com/notrustverify/awesome-nym)
- [Builders channel Matrix](https://matrix.to/#/#shipyardbuilders:nymtech.chat)
@@ -1,15 +0,0 @@
-# Submission Guidelines
-We expect to see the following for submissions: 
- Working code demos hosted publicly (Gitlab, Github, some other git instance).
- Quality > quantity here: we’d prefer to see a contained, working, and well documented Proof of Concept over a sprawling and messy app that does more but is poorly explained and presented. _The repo must be open source and able to be used and modified by others. The license is up to you._
- If you already have existing apps / projects you are more than welcome to extend them, instead of starting from scratch - we will only be looking at the NEW additions to make this fair. If you are doing this, make sure to write a detailed account of what it is you;ve added to the existing project, preferably with the possibility to see the ‘old’ version as well as the new one.
- Proper documentation:
-  - If an app / tool:
-    - How do you install and run the code? How is it to be used? 
-    - An overview of the application architecture: what is it doing? Is it relying on other services? 
-  - If a UI-based solution:
-    - How to run it locally? We are happy to also accept staging deployments as part of the submission (e.g. via Vercel) but this does not replace being able to run it locally.
- Please make sure that your application works on commonly reproducible system environments (e.g. if you’re developing on Artix Linux please check for the necessary dependencies for more common-place OSes such as Debian, or Arch). If you are developing on Windows please make sure that it works on non-Windows machines also. Where possible please try to include build and install instructions for a variety of OSes. 
-
-## How to submit? 
-Please follow the instructions [here](https://github.com/nymtech/nym/discussions/4143). 
@@ -1,12 +0,0 @@
-# A Note on Infrastructure
-If you are writing an application that requires sending messages through the mixnet, then you will either be relying on existing infrastructure nodes (network requesters), or writing your own custom service (for example, the service written as part of the Rust SDK tutorial).
-
-If you are relying on network requesters then chances are that the IPs or domains your app relies on will not already be on the whitelist. Ideally, you would [run your own,](https://nymtech.net/operators/nodes/network-requester-setup.html) but we will also run a few nodes in ‘open proxy’ mode and share the addresses so that you can use them when beginning to develop. 
-
-## Node Details:
- NR1
-  - Location: Singapore
-  - Nym Address: `FDeWfd8q686PWLXJDCqNJTCbydTk1KSux5HVftimsPyx.9XyThN4yh92eTMuLp1NvWicRZob8Ei5xpba9dvcMLxcN@9Byd9VAtyYMnbVAcqdoQxJnq76XEg2dbxbiF5Aa5Jj9J`
- NR2
-  - Location: Frankfurt
-  - Nym Address: `BNypKaGiGY8GNRN4gpV95GcaVS8n7CrHuoZNgQ2ezqv2.ACpaixzuaSzuMajVQj6aR7cbpbvp676tm21MiLbX1gni@678qVUJ21uwxZBhp3r56z7GRf6gMh3NYDHruTegPtgMf`
@@ -0,0 +1 @@
+# Command Documentation (Autogenerated)
@@ -68,6 +68,8 @@ subcommands:
 ```
 ~~~

+Or check the autogenerated command documentation on the [next page](./nym-cli-commands.md).
+
 ## Example Usage
 Below we have listed some example commands for some of the features listed above.

@@ -304,7 +306,7 @@ Verify a signature.

 ### Create a Vesting Schedule

-Creates a vesting schedule for an account in the [vesting smart contract](../nyx/vesting-contract.md).
+Creates a vesting schedule for an account in the [vesting smart contract](../../../dev-portal/src/nyx/vesting-contract.md).

 ```
 ./nym-cli vesting-schedule create --mnemonic <mnemonic> --address <ADDRESS> --amount <AMOUNT>
@@ -312,7 +314,7 @@ Creates a vesting schedule for an account in the [vesting smart contract](../nyx

 ### Query a Vesting Schedule

-Query for vesting schedule in the [vesting smart contract](../nyx/vesting-contract.md).
+Query for vesting schedule in the [vesting smart contract](../../../dev-portal/src/nyx/vesting-contract.md).

 ```
 ./nym-cli vesting-schedule query --mnemonic <mnemonic>
@@ -27,10 +27,10 @@ chmod +x ./nym-connect_<VERSION>

 To download Electrum visit the [official webpage](https://electrum.org/#download). To connect to the Mixnet follow these steps:

-7. Start and connect [NymConnect](./electrum.md#nymconnect-installation) (or [`nym-socks5-client`](https://nymtech.net/docs/clients/socks5-client.html))
+7. Start and connect [NymConnect](electrum.mdymconnect-installation) (or [`nym-socks5-client`](https://nymtech.net/docs/clients/socks5-client.html))
 2. Start your Electrum Bitcoin wallet
 3. Go to: *Tools* -> *Network* -> *Proxy*
 4. Set *Use proxy* to ✅, choose `SOCKS5` from the drop-down and add the values from your NymConnect application
 5. Now your Electrum Bitcoin wallet runs through the Mixnet and it will be connected only if your NymConnect or `nym-socks5-client` are connected.

-![Electrum Bitcoin wallet setup](../images/electrum_tutorial/electrum.gif)
+![Electrum Bitcoin wallet setup](../../../images/electrum_tutorial/electrum.gif)
--- a/Show More
+++ b/Show More
Author	SHA1	Message	Date
mfahampshire	e8ead6aadf	updated module path	2024-05-31 15:19:34 +02:00
mfahampshire	91f75fd360	removed cflag import for test	2024-05-31 15:14:54 +02:00
mfahampshire	472e389d9d	updated module path.. again	2024-05-31 15:07:16 +02:00
mfahampshire	04bfb6a658	updated module path	2024-05-31 14:54:14 +02:00
mfahampshire	2900a63c21	updated module path	2024-05-31 14:49:29 +02:00
mfahampshire	9641e5f9dd	updated go mod import	2024-05-31 14:43:13 +02:00
mfahampshire	bcdc548289	added nym-cli-tool autogen	2024-05-14 16:55:09 +02:00
mfahampshire	e59ef01400	more reorg and dead links	2024-05-14 16:29:35 +02:00
mfahampshire	098155f6b9	fixed broken links in dev portal + moved a bunch of files from docs -> dev portal	2024-05-14 15:54:15 +02:00
mfahampshire	5ef17a506b	cont. with restructure	2024-05-13 22:45:59 +02:00
mfahampshire	46e858a097	reorg of files and SUMMARY files	2024-05-13 22:36:31 +02:00
benedetta davico	0902539332	Merge pull request #4583 from nymtech/release/2024.4-nutella Release 2024.4-nutella to master	2024-05-13 10:27:08 +02:00
benedettadavico	f0a4350e83	pruning version bump and changelog updates	2024-05-08 11:01:50 +02:00
import this	d5c2a01a34	[DOCs/operators]: 2024.4 nutella release changelog & mixnode ipv6 clarification (#4581 ) * edit IPv6 mixnode info * add mixnode ipv6 info and nuttela changelog * syntax edit	2024-05-07 15:49:29 +00:00
benedetta davico	b1c58b36fe	Merge pull request #4578 from nymtech/update-sign-nym-node updating sign commands to include nym-node	2024-05-07 14:50:51 +02:00
benedettadavico	dfbcc781db	extra space..	2024-05-07 14:36:43 +02:00
benedettadavico	5026960169	linting	2024-05-07 14:10:57 +02:00
benedetta davico	7c2710b61a	Merge pull request #4579 from nymtech/bugfix/exit-poisson [fix] apply disable_poisson_rate from internal NR/IPR cfgs	2024-05-07 14:09:44 +02:00
Jędrzej Stuczyński	bf9fc2d537	external clippy	2024-05-07 11:49:25 +01:00
Jędrzej Stuczyński	4182af9199	[fix] apply disable_poisson_rate from internal NR/IPR cfgs	2024-05-07 11:41:57 +01:00
benedettadavico	408d803344	adding both options	2024-05-07 12:34:26 +02:00
benedettadavico	c2a5d6c035	updating sign commands to nym-node	2024-05-07 12:20:55 +02:00
Tommy Verrall	1136901daf	Merge pull request #4572 from nymtech/bugfix/change-redirects changed nym-node redirects from 308 'Permanent Redirect' to 303: 'See Other'	2024-05-07 09:29:41 +01:00
Tommy Verrall	593a1da0ff	Merge pull request #4565 from nymtech/bugfix/delegations Bug fix: wallet delegations list is empty when RPC node doesn't hold block	2024-05-07 09:07:04 +01:00
Tommy Verrall	9c17b7c269	Merge pull request #4571 from nymtech/operators/ipv6-troubleshooting [DOC/operators]: More troubleshooting for IPv6 & install dependencies guides	2024-05-07 08:50:55 +01:00
serinko	df398dbe05	add mixnode IPv6 setup	2024-05-06 13:00:51 +02:00
Tommy Verrall	effd03b2f5	Merge pull request #4567 from nymtech/dependabot/npm_and_yarn/ejs-3.1.10 Bump ejs from 3.1.9 to 3.1.10	2024-05-06 11:49:46 +01:00
Sachin Kamath	e00db6adb9	docs: fix links to archive (#4576 )	2024-05-06 09:08:21 +00:00
Jędrzej Stuczyński	fd207d4699	changed nym-node redirects from 308 'Permanent Redirect' to 303: 'See Other'	2024-05-03 15:43:49 +01:00
serinko	b9126dfc0e	add troubleshooting for IPv6 & install dependencies	2024-05-03 13:19:59 +02:00
Jon Häggblad	7bbe153b8f	Add AuthenticationFailureWithPreexistingSharedKey and a few log statements (#4568 )	2024-05-03 09:53:53 +02:00
import this	36e1e73ed2	[DOCs]/operators: Create changelog page & add more nym-node troubleshooting (#4570 ) * add note to binary download * initialise changelog page * finalise changelog draft * add local ID rename guide * remove old id * syntax edit * syntax edit * syntax edit	2024-05-02 19:11:02 +02:00
Mark Sinclair	6e23322ac4	Update nym-wallet/src/components/Delegation/DelegationList.tsx	2024-05-02 14:57:00 +01:00
Mark Sinclair	729eedc960	Update publish-nym-wallet-win10.yml	2024-05-02 13:45:51 +01:00
Mark Sinclair	025cbf5231	Update publish-nym-wallet-ubuntu.yml	2024-05-02 13:45:46 +01:00
Mark Sinclair	3db3959a74	Update publish-nym-wallet-macos.yml	2024-05-02 13:45:39 +01:00
fmtabbara	3ba83795d4	add error dialog	2024-05-02 11:22:34 +01:00
dependabot[bot]	39b01d10bd	Bump ejs from 3.1.9 to 3.1.10 Bumps [ejs](https://github.com/mde/ejs) from 3.1.9 to 3.1.10. - [Release notes](https://github.com/mde/ejs/releases) - [Commits](https://github.com/mde/ejs/compare/v3.1.9...v3.1.10) --- updated-dependencies: - dependency-name: ejs dependency-type: indirect ... Signed-off-by: dependabot[bot] <support@github.com>	2024-05-02 07:02:37 +00:00
Tommy Verrall	f99bedd7e8	Merge pull request #4566 from nymtech/dependabot/npm_and_yarn/nym-wallet/webdriver/ejs-3.1.10 Bump ejs from 3.1.7 to 3.1.10 in /nym-wallet/webdriver	2024-05-02 08:01:12 +01:00
dependabot[bot]	7717bf5cf9	Bump ejs from 3.1.7 to 3.1.10 in /nym-wallet/webdriver Bumps [ejs](https://github.com/mde/ejs) from 3.1.7 to 3.1.10. - [Release notes](https://github.com/mde/ejs/releases) - [Commits](https://github.com/mde/ejs/compare/v3.1.7...v3.1.10) --- updated-dependencies: - dependency-name: ejs dependency-type: indirect ... Signed-off-by: dependabot[bot] <support@github.com>	2024-05-02 00:47:12 +00:00
fmtabbara	6060ce5fb8	fix error tooltip overflow	2024-05-01 23:38:06 +01:00
Mark Sinclair	8fbad9cad8	Remove test errors	2024-05-01 19:33:10 +01:00
Mark Sinclair	650865e59a	Wallet delegations: slow refresh from 1 min to 5 mins	2024-05-01 18:02:34 +01:00
Mark Sinclair	08e580ec8b	Wallet delegations list - add an error to each row, and display as a tooltip if present	2024-05-01 17:59:46 +01:00
Mark Sinclair	ad86ec9315	Wallet delegations: add more error information	2024-05-01 15:59:45 +01:00
Mark Sinclair	53ab4c8ec9	Wallet delegations: tap errors in requests per delegation. Return an error with strings of all sub errors.	2024-05-01 15:24:29 +01:00
import this	f34c9d5d28	[DOCs]: Get nym-vpn guides ready for launch (#4563 ) * update nymvpn cli guide * update nymvpn landing page * update nymvpn landing page * syntax edit * final version for review * final version for review * fix on feedback * fix on feedback	2024-04-29 15:07:51 +00:00
import this	b93afe7756	add useful feedback and edits (#4562 )	2024-04-26 17:22:24 +00:00
benedetta davico	140cd7d940	Merge pull request #4560 from nymtech/master Master to develop	2024-04-25 12:59:58 +02:00
import this	5f60344c2b	HOTFIX ci-docs (#4558 ) * HOTFIX ci-docs * add a flag to bonding	2024-04-24 15:09:51 +00:00
import this	c53b46ee1d	[DOCs]: HOTFix CI/CD GH runners (#4554 ) * build on master first * rename pages to unique names * rename pages to unique names * module updates * rm old cmrdun and fix modules * syntax fix * comment out cmdrun * comment out cmdrun * feedback fix * TEMP hack to build books * adding sleep to build script * adding test to mdbook script * TEMP hack to build books * add cmdrun back * add cmdrun back * final commit - ready to go	2024-04-24 15:00:56 +02:00
import this	ce067db401	[DOCs]: Guides for NYM-NODE (#4541 ) * initialise nym node pages * new TOC flow and archive section * vps setup page draft * syntax fix * syntax fix * syntax fix * add ulimit setup * initialise nym-node page * add ports * syntax edit * syntax edit * add flags * add setup, run and bonding pages * add info * syntax edit * add configuration page * syntax fix * syntax fix * add vps troubleshooting * add vps troubleshooting * create nyx configuration page * add quickflow * add quickflow * add quickflow * add quickflow * add quickflow * add quickflow * syntax fix * syntax fix * move vps setup to configuration * syntax fix * syntax fix * syntax fix * edit points * finish nym-node setup.md page * new connnectivity configuration - page finished * finish proxy and landing page guide * finish nymvisor update * finish performance testing upgdate * finish faq pages update * fix troubleshooting * fix troubleshooting * fix manual-upgrade * finish introduction page * update introduction * update summary * correct all links * update graphs * update cmdruns * syntax edit and spellcheck * updated mdbook plugins * mdbook update * update modules * remove redundant * fix version cmdrun * removed smoosh-faw to archive * syntax fix * attempt to update mdbook admonish * try dirty workaround hack * try dirty workaround hack * try dirty workaround hack * try dirty workaround hack * try dirty workaround hack * try dirty workaround hack * try dirty workaround hack * try dirty workaround hack * try dirty workaround hack * address review comments * address review comments * address review comments * PR ready to merge	2024-04-23 09:14:27 +00:00