Merge branch 'serinko/new-operators/command-outputs' of github.com:nymtech/nym into serinko/new-operators/command-outputs

merge conflict fixed
address review comments
2024-10-24 12:10:48 +02:00 · 2024-10-24 12:09:00 +02:00 · 2024-10-24 11:35:26 +02:00 · 2024-10-23 23:06:45 +02:00 · 2024-10-23 23:06:34 +02:00 · 2024-10-23 21:24:24 +02:00
724 changed files with 38960 additions and 15888 deletions
@@ -0,0 +1,7 @@
+.git
+.github
+.gitignore
+**/node_modules
+**/target
+dist
+documentation
@@ -48,4 +48,7 @@ foxyfox.env

 .next
 ppa-private-key.b64
-ppa-private-key.asc
+ppa-private-key.asc
+nym-network-monitor/topology.json
+nym-network-monitor/__pycache__
+nym-network-monitor/*.key
@@ -347,6 +347,14 @@ version = "1.3.0"
 source = "registry+https://github.com/rust-lang/crates.io-index"
 checksum = "0c4b4d0bd25bd0b74681c0ad21497610ce1b7c91b1022cd21c80c6fbdd9476b0"

+[[package]]
+name = "autodoc"
+version = "0.1.0"
+dependencies = [
+ "env_logger 0.11.5",
+ "log",
+]
+
 [[package]]
 name = "axum"
 version = "0.6.20"
@@ -1858,6 +1866,7 @@ dependencies = [
 "lock_api",
 "once_cell",
 "parking_lot_core 0.9.10",
+ "serde",
 ]

 [[package]]
@@ -2184,6 +2193,16 @@ dependencies = [
 "cfg-if",
 ]

+[[package]]
+name = "env_filter"
+version = "0.1.2"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "4f2c92ceda6ceec50f43169f9ee8424fe2db276791afde7b2cd8bc084cb376ab"
+dependencies = [
+ "log",
+ "regex",
+]
+
 [[package]]
 name = "env_logger"
 version = "0.7.1"
@@ -2207,6 +2226,19 @@ dependencies = [
 "regex",
 ]

+[[package]]
+name = "env_logger"
+version = "0.11.5"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "e13fa619b91fb2381732789fc5de83b45675e882f66623b7d8cb4f643017018d"
+dependencies = [
+ "anstream",
+ "anstyle",
+ "env_filter",
+ "humantime 2.1.0",
+ "log",
+]
+
 [[package]]
 name = "equivalent"
 version = "1.0.1"
@@ -2397,6 +2429,12 @@ dependencies = [
 "windows-sys 0.52.0",
 ]

+[[package]]
+name = "fixedbitset"
+version = "0.4.2"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "0ce7134b9999ecaf8bcd65542e436736ef32ddca1b3e06094cb6ec5755203b80"
+
 [[package]]
 name = "flate2"
 version = "1.0.30"
@@ -4253,6 +4291,7 @@ dependencies = [
 "nym-sphinx",
 "nym-task",
 "nym-topology",
+ "nym-types",
 "nym-validator-client",
 "nym-vesting-contract-common",
 "okapi",
@@ -4579,6 +4618,7 @@ dependencies = [
 "nym-topology",
 "nym-validator-client",
 "rand 0.8.5",
+ "rand_chacha 0.3.1",
 "serde",
 "serde_json",
 "sha2 0.10.8",
@@ -5410,6 +5450,36 @@ dependencies = [
 "url",
 ]

+[[package]]
+name = "nym-network-monitor"
+version = "0.1.0"
+dependencies = [
+ "anyhow",
+ "axum 0.7.5",
+ "clap 4.5.7",
+ "dashmap",
+ "futures",
+ "log",
+ "nym-bin-common",
+ "nym-crypto",
+ "nym-network-defaults",
+ "nym-sdk",
+ "nym-sphinx",
+ "nym-topology",
+ "nym-types",
+ "nym-validator-client",
+ "petgraph",
+ "rand 0.8.5",
+ "rand_chacha 0.3.1",
+ "reqwest 0.12.4",
+ "serde",
+ "serde_json",
+ "tokio",
+ "tokio-util",
+ "utoipa",
+ "utoipa-swagger-ui",
+]
+
 [[package]]
 name = "nym-network-requester"
 version = "1.1.40"
@@ -5575,6 +5645,7 @@ dependencies = [
 "nym-task",
 "nym-topology",
 "rand 0.8.5",
+ "rand_chacha 0.3.1",
 "serde",
 "serde_json",
 "thiserror",
@@ -5858,6 +5929,7 @@ version = "0.1.0"
 dependencies = [
 "log",
 "nym-crypto",
+ "nym-metrics",
 "nym-mixnet-contract-common",
 "nym-sphinx-acknowledgements",
 "nym-sphinx-addressing",
@@ -5871,6 +5943,7 @@ dependencies = [
 "nym-sphinx-types",
 "nym-topology",
 "rand 0.8.5",
+ "rand_chacha 0.3.1",
 "rand_distr",
 "thiserror",
 "tokio",
@@ -5927,12 +6000,17 @@ dependencies = [
 name = "nym-sphinx-chunking"
 version = "0.1.0"
 dependencies = [
+ "dashmap",
 "log",
+ "nym-crypto",
+ "nym-metrics",
 "nym-sphinx-addressing",
 "nym-sphinx-params",
 "nym-sphinx-types",
 "rand 0.8.5",
+ "serde",
 "thiserror",
+ "utoipa",
 ]

 [[package]]
@@ -6046,6 +6124,7 @@ dependencies = [
 "nym-sphinx-routing",
 "nym-sphinx-types",
 "rand 0.8.5",
+ "reqwest 0.12.4",
 "semver 0.11.0",
 "serde",
 "serde_json",
@@ -6682,6 +6761,16 @@ dependencies = [
 "sha2 0.10.8",
 ]

+[[package]]
+name = "petgraph"
+version = "0.6.5"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "b4c5cc86750666a3ed20bdaf5ca2a0344f9c67674cae0515bec2da16fbaa47db"
+dependencies = [
+ "fixedbitset",
+ "indexmap 2.2.6",
+]
+
 [[package]]
 name = "pin-project"
 version = "1.1.5"
@@ -14,7 +14,6 @@ panic = "abort"
 opt-level = 3

 [workspace]
-
 resolver = "2"
 members = [
    "clients/native",
@@ -94,6 +93,7 @@ members = [
    "common/wasm/utils",
    "common/wireguard",
    "common/wireguard-types",
+    "documentation/autodoc",
    "explorer-api",
    "explorer-api/explorer-api-requests",
    "explorer-api/explorer-client",
@@ -106,6 +106,7 @@ members = [
    "service-providers/common",
    "service-providers/ip-packet-router",
    "service-providers/network-requester",
+    "nym-network-monitor",
    "nym-api",
    "nym-browser-extension/storage",
    "nym-api/nym-api-requests",
@@ -159,6 +160,7 @@ homepage = "https://nymtech.net"
 documentation = "https://nymtech.net"
 edition = "2021"
 license = "Apache-2.0"
+rust-version = "1.80"

 [workspace.dependencies]
 addr = "0.15.6"
@@ -19,6 +19,7 @@ futures = { workspace = true }
 humantime-serde = { workspace = true }
 log = { workspace = true }
 rand = { workspace = true }
+rand_chacha = { workspace = true }
 serde = { workspace = true, features = ["derive"] }
 serde_json = { workspace = true }
 sha2 = { workspace = true }
@@ -458,7 +458,7 @@ impl PacketStatisticsControl {

    fn report_rates(&self) {
        if let Some((_, rates)) = self.rates.back() {
-            log::info!("{}", rates.summary());
+            log::debug!("{}", rates.summary());
            log::debug!("{}", rates.detailed_summary());
        }
    }
@@ -486,7 +486,7 @@ impl PacketStatisticsControl {
            // Check what the number of retransmissions was during the recording window
            if let Some((_, start_stats)) = self.history.front() {
                let delta = self.stats.clone() - start_stats.clone();
-                log::info!(
+                log::debug!(
                    "mix packet retransmissions/real mix packets: {}/{}",
                    delta.retransmissions_queued,
                    delta.real_packets_queued,
@@ -453,6 +453,7 @@ where

        let mut pending_acks = Vec::with_capacity(fragments.len());
        let mut real_messages = Vec::with_capacity(fragments.len());
+        debug!("Splitting message into {} fragments", fragments.len());
        for fragment in fragments {
            // we need to clone it because we need to keep it in memory in case we had to retransmit
            // it. And then we'd need to recreate entire ACK again.
@@ -90,4 +90,6 @@ default = ["http-client"]
 http-client = ["cosmrs/rpc"]
 generate-ts = []
 contract-testing = ["nym-mixnet-contract-common/contract-testing"]
-
+# Features below are added to make clippy happy, it seems like they're unused we should remove them
+tendermint-rpc-http-client = ["tendermint-rpc/http-client"]
+tendermint-rpc-websocket-client = ["tendermint-rpc/websocket-client"]
@@ -49,5 +49,7 @@ pub const COMPUTE_REWARD_ESTIMATION: &str = "compute-reward-estimation";
 pub const AVG_UPTIME: &str = "avg_uptime";
 pub const STAKE_SATURATION: &str = "stake-saturation";
 pub const INCLUSION_CHANCE: &str = "inclusion-probability";
+pub const SUBMIT_GATEWAY: &str = "submit-gateway-monitoring-results";
+pub const SUBMIT_NODE: &str = "submit-node-monitoring-results";

 pub const SERVICE_PROVIDERS: &str = "services";
@@ -300,8 +300,8 @@ where
    }

    #[cfg(any(
-        feature = "tendermint-rpc/http-client",
-        feature = "tendermint-rpc/websocket-client"
+        feature = "tendermint-rpc-http-client",
+        feature = "tendermint-rpc-websocket-client"
    ))]
    async fn wait_until_healthy<T>(&self, timeout: T) -> Result<(), Error>
    where
@@ -820,8 +820,8 @@ where
    }

    #[cfg(any(
-        feature = "tendermint-rpc/http-client",
-        feature = "tendermint-rpc/websocket-client"
+        feature = "tendermint-rpc-http-client",
+        feature = "tendermint-rpc-websocket-client"
    ))]
    async fn wait_until_healthy<T>(&self, timeout: T) -> Result<(), Error>
    where
@@ -300,8 +300,8 @@ pub trait TendermintRpcClient {
    }

    #[cfg(any(
-        feature = "tendermint-rpc/http-client",
-        feature = "tendermint-rpc/websocket-client"
+        feature = "tendermint-rpc-http-client",
+        feature = "tendermint-rpc-websocket-client"
    ))]
    /// Poll the `/health` endpoint until it returns a successful result or
    /// the given `timeout` has elapsed.
@@ -518,8 +518,8 @@ mod non_wasm {
        }

        #[cfg(any(
-            feature = "tendermint-rpc/http-client",
-            feature = "tendermint-rpc/websocket-client"
+            feature = "tendermint-rpc-http-client",
+            feature = "tendermint-rpc-websocket-client"
        ))]
        async fn wait_until_healthy<T>(&self, timeout: T) -> Result<(), Error>
        where
@@ -22,7 +22,7 @@ use tracing::{debug, error};
 pub mod bandwidth;
 pub mod error;
 mod inboxes;
-pub(crate) mod models;
+pub mod models;
 mod shared_keys;
 mod tickets;
 #[cfg(feature = "wireguard")]
@@ -9,11 +9,12 @@ license.workspace = true
 [dependencies]
 futures = { workspace = true }
 rand = { workspace = true }
+rand_chacha = { workspace = true }

 serde = { workspace = true }
 serde_json = { workspace = true }
 thiserror = { workspace = true }
-tokio = { workspace = true, features = ["macros"]}
+tokio = { workspace = true, features = ["macros"] }

 nym-crypto = { path = "../crypto", features = ["asymmetric"] }
 nym-task = { path = "../task" }
@@ -294,4 +294,8 @@ impl<R: CryptoRng + Rng> FragmentPreparer for NodeTester<R> {
    fn average_ack_delay(&self) -> Duration {
        self.average_ack_delay
    }
+
+    fn nonce(&self) -> i32 {
+        1
+    }
 }
@@ -11,6 +11,7 @@ repository = { workspace = true }
 log = { workspace = true }
 rand = { workspace = true }
 rand_distr = { workspace = true }
+rand_chacha = { workspace = true }
 thiserror = { workspace = true }

 nym-sphinx-acknowledgements = { path = "acknowledgements" }
@@ -27,10 +28,13 @@ nym-sphinx-types = { path = "types" }
 # to separate crate?
 nym-crypto = { path = "../crypto", version = "0.4.0" }
 nym-topology = { path = "../topology" }
+nym-metrics = { path = "../nym-metrics" }

 [dev-dependencies]
 nym-mixnet-contract-common = { path = "../cosmwasm-smart-contracts/mixnet-contract" }
-nym-crypto = { path = "../crypto", version = "0.4.0", features = ["asymmetric"] }
+nym-crypto = { path = "../crypto", version = "0.4.0", features = [
+    "asymmetric",
+] }

 # do not include this when compiling into wasm as it somehow when combined together with reqwest, it will require
 # net2 via tokio-util -> tokio -> mio -> net2
@@ -43,5 +47,13 @@ features = ["sync"]

 [features]
 default = ["sphinx"]
-sphinx = ["nym-crypto/sphinx", "nym-sphinx-params/sphinx", "nym-sphinx-types/sphinx"]
-outfox = ["nym-crypto/outfox", "nym-sphinx-params/outfox", "nym-sphinx-types/outfox"]
+sphinx = [
+    "nym-crypto/sphinx",
+    "nym-sphinx-params/sphinx",
+    "nym-sphinx-types/sphinx",
+]
+outfox = [
+    "nym-crypto/outfox",
+    "nym-sphinx-params/outfox",
+    "nym-sphinx-types/outfox",
+]
@@ -13,7 +13,14 @@ repository = { workspace = true }
 log = { workspace = true }
 rand = { workspace = true }
 thiserror = { workspace = true }
+dashmap = { workspace = true, features = ["serde"] }
+serde = { workspace = true, features = ["derive"] }
+utoipa = { workspace = true }

 nym-sphinx-addressing = { path = "../addressing" }
 nym-sphinx-params = { path = "../params" }
 nym-sphinx-types = { path = "../types" }
+nym-metrics = { path = "../../nym-metrics" }
+nym-crypto = { path = "../../crypto", version = "0.4.0", features = [
+    "asymmetric",
+] }
@@ -3,6 +3,8 @@

 use crate::ChunkingError;
 use nym_sphinx_params::{SerializedFragmentIdentifier, FRAG_ID_LEN};
+use serde::Serialize;
+use utoipa::ToSchema;

 use std::fmt::{self, Debug, Formatter};

@@ -58,7 +60,7 @@ pub const COVER_FRAG_ID: FragmentIdentifier = FragmentIdentifier {
 /// and u8 position of the `Fragment` in the set.
 // TODO: this should really be redesigned, especially how cover and reply messages are really
 // "abusing" this. They should work with it natively instead.
-#[derive(Debug, Clone, Copy, Hash, Eq, PartialEq, Ord, PartialOrd)]
+#[derive(Debug, Clone, Copy, Hash, Eq, PartialEq, Ord, PartialOrd, Serialize)]
 pub struct FragmentIdentifier {
    set_id: i32,
    fragment_position: u8,
@@ -75,6 +77,10 @@ impl fmt::Display for FragmentIdentifier {
 }

 impl FragmentIdentifier {
+    pub fn set_id(&self) -> i32 {
+        self.set_id
+    }
+
    pub fn to_bytes(self) -> SerializedFragmentIdentifier {
        debug_assert_eq!(FRAG_ID_LEN, 5);

@@ -125,6 +131,10 @@ impl Debug for Fragment {
 }

 impl Fragment {
+    pub fn header(&self) -> FragmentHeader {
+        self.header.clone()
+    }
+
    /// Tries to encapsulate provided payload slice and metadata into a `Fragment`.
    /// It can fail if payload would not fully fit in a single `Fragment` or some of the metadata
    /// is malformed or self-contradictory, for example if current_fragment > total_fragments.
@@ -216,6 +226,10 @@ impl Fragment {
        }
    }

+    pub fn seed(&self) -> i32 {
+        self.header().seed()
+    }
+
    /// Gets the size of payload contained in this `Fragment`.
    pub fn payload_size(&self) -> usize {
        self.payload.len()
@@ -297,8 +311,8 @@ impl Fragment {
 /// there is 7 bytes of overhead inside each sphinx packet sent
 /// and for the longest messages, without upper bound, there is usually also only 7 bytes
 /// of overhead apart from first and last fragments in each set that instead have 10 bytes of overhead.
-#[derive(PartialEq, Clone, Debug)]
-pub(crate) struct FragmentHeader {
+#[derive(PartialEq, Clone, Debug, Serialize, ToSchema)]
+pub struct FragmentHeader {
    /// ID associated with `FragmentSet` to which this particular `Fragment` belongs.
    /// Its value is restricted to (0, i32::MAX].
    /// Note that it *excludes* 0, but *includes* i32::MAX.
@@ -324,6 +338,20 @@ pub(crate) struct FragmentHeader {
 }

 impl FragmentHeader {
+    pub fn seed(&self) -> i32 {
+        let mut seed = self.id;
+        seed = seed.wrapping_mul(self.total_fragments as i32);
+        seed = seed.wrapping_mul(self.current_fragment as i32);
+        seed
+    }
+
+    pub fn total_fragments(&self) -> u8 {
+        self.total_fragments
+    }
+
+    pub fn current_fragment(&self) -> u8 {
+        self.current_fragment
+    }
    /// Tries to create a new `FragmentHeader` using provided metadata. Bunch of logical
    /// checks are performed to see if the data is not self-contradictory,
    /// for example if current_fragment > total_fragments.
@@ -1,9 +1,16 @@
 // Copyright 2021 - Nym Technologies SA <contact@nymtech.net>
 // SPDX-License-Identifier: Apache-2.0

+use std::sync::LazyLock;
+
 use crate::fragment::{linked_fragment_payload_max_len, unlinked_fragment_payload_max_len};
+use dashmap::DashMap;
+use fragment::{Fragment, FragmentHeader};
+use nym_crypto::asymmetric::ed25519::PublicKey;
+use serde::Serialize;
 pub use set::split_into_sets;
 use thiserror::Error;
+use utoipa::ToSchema;

 pub const MIN_PADDING_OVERHEAD: usize = 1;

@@ -22,6 +29,118 @@ pub mod fragment;
 pub mod reconstruction;
 pub mod set;

+#[derive(Debug, Clone)]
+pub struct FragmentMixParams {
+    destination: PublicKey,
+    hops: u8,
+}
+
+impl FragmentMixParams {
+    pub fn destination(&self) -> &PublicKey {
+        &self.destination
+    }
+
+    pub fn hops(&self) -> u8 {
+        self.hops
+    }
+}
+
+#[derive(Debug, Clone, Serialize, ToSchema)]
+pub struct SentFragment {
+    header: FragmentHeader,
+    at: u64,
+    client_nonce: i32,
+    #[serde(skip)]
+    mixnet_params: FragmentMixParams,
+}
+
+impl SentFragment {
+    fn new(
+        header: FragmentHeader,
+        at: u64,
+        client_nonce: i32,
+        destination: PublicKey,
+        hops: u8,
+    ) -> Self {
+        let mixnet_params = FragmentMixParams { destination, hops };
+        SentFragment {
+            header,
+            at,
+            client_nonce,
+            mixnet_params,
+        }
+    }
+
+    pub fn header(&self) -> FragmentHeader {
+        self.header.clone()
+    }
+
+    pub fn at(&self) -> u64 {
+        self.at
+    }
+
+    pub fn client_nonce(&self) -> i32 {
+        self.client_nonce
+    }
+
+    pub fn seed(&self) -> i32 {
+        self.header().seed().wrapping_mul(self.client_nonce())
+    }
+
+    pub fn mixnet_params(&self) -> FragmentMixParams {
+        self.mixnet_params.clone()
+    }
+}
+
+#[derive(Debug, Clone, Serialize, ToSchema)]
+pub struct ReceivedFragment {
+    header: FragmentHeader,
+    at: u64,
+}
+
+impl ReceivedFragment {
+    fn new(header: FragmentHeader, at: u64) -> Self {
+        ReceivedFragment { header, at }
+    }
+
+    pub fn header(&self) -> FragmentHeader {
+        self.header.clone()
+    }
+
+    pub fn at(&self) -> u64 {
+        self.at
+    }
+}
+
+pub static FRAGMENTS_RECEIVED: LazyLock<DashMap<i32, Vec<ReceivedFragment>>> =
+    LazyLock::new(DashMap::new);
+
+pub static FRAGMENTS_SENT: LazyLock<DashMap<i32, Vec<SentFragment>>> = LazyLock::new(DashMap::new);
+
+#[macro_export]
+macro_rules! now {
+    () => {
+        match std::time::SystemTime::now().duration_since(std::time::SystemTime::UNIX_EPOCH) {
+            Ok(n) => n.as_secs(),
+            Err(_) => 0,
+        }
+    };
+}
+
+pub fn fragment_received(fragment: &Fragment) {
+    let id = fragment.fragment_identifier().set_id();
+    let mut entry = FRAGMENTS_RECEIVED.entry(id).or_default();
+    let r = ReceivedFragment::new(fragment.header(), now!());
+    entry.push(r);
+}
+
+pub fn fragment_sent(fragment: &Fragment, client_nonce: i32, destination: PublicKey, hops: u8) {
+    let id = fragment.fragment_identifier().set_id();
+    let mut entry = FRAGMENTS_SENT.entry(id).or_default();
+    let s = SentFragment::new(fragment.header(), now!(), client_nonce, destination, hops);
+    entry.push(s);
+}
+
 /// The idea behind the process of chunking is to incur as little data overhead as possible due
 /// to very computationally costly sphinx encapsulation procedure.
 ///
@@ -1,7 +1,7 @@
 // Copyright 2021 - Nym Technologies SA <contact@nymtech.net>
 // SPDX-License-Identifier: Apache-2.0
 use crate::fragment::Fragment;
-use crate::ChunkingError;
+use crate::{fragment_received, ChunkingError};
 use log::*;
 use std::collections::HashMap;

@@ -66,6 +66,12 @@ impl ReconstructionBuffer {
        // if the set is complete.
        debug_assert!(self.is_complete);

+        debug!(
+            "Got {} fragments for set id {}",
+            self.fragments.len(),
+            self.fragments[0].as_ref().unwrap().id()
+        );
+
        self.fragments
            .into_iter()
            .map(|fragment| fragment.unwrap().extract_payload())
@@ -104,6 +110,8 @@ impl ReconstructionBuffer {
            }
        });

+        fragment_received(&fragment);
+
        let fragment_index = fragment.current_fragment() as usize - 1;
        if self.fragments[fragment_index].is_some() {
            // TODO: what to do in that case? give up on the message? overwrite it? panic?
@@ -3,6 +3,7 @@

 use crate::message::{NymMessage, ACK_OVERHEAD, OUTFOX_ACK_OVERHEAD};
 use crate::NymPayloadBuilder;
+use log::debug;
 use nym_crypto::asymmetric::encryption;
 use nym_crypto::Digest;
 use nym_sphinx_acknowledgements::surb_ack::SurbAck;
@@ -11,12 +12,14 @@ use nym_sphinx_addressing::clients::Recipient;
 use nym_sphinx_addressing::nodes::NymNodeRoutingAddress;
 use nym_sphinx_anonymous_replies::reply_surb::ReplySurb;
 use nym_sphinx_chunking::fragment::{Fragment, FragmentIdentifier};
+use nym_sphinx_chunking::fragment_sent;
 use nym_sphinx_forwarding::packet::MixPacket;
 use nym_sphinx_params::packet_sizes::PacketSize;
 use nym_sphinx_params::{PacketType, ReplySurbKeyDigestAlgorithm, DEFAULT_NUM_MIX_HOPS};
 use nym_sphinx_types::{Delay, NymPacket};
 use nym_topology::{NymTopology, NymTopologyError};
-use rand::{CryptoRng, Rng};
+use rand::{CryptoRng, Rng, SeedableRng};
+use rand_chacha::ChaCha20Rng;

 use std::time::Duration;

@@ -49,6 +52,7 @@ pub trait FragmentPreparer {
    type Rng: CryptoRng + Rng;

    fn rng(&mut self) -> &mut Self::Rng;
+    fn nonce(&self) -> i32;
    fn num_mix_hops(&self) -> u8;
    fn average_packet_delay(&self) -> Duration;
    fn average_ack_delay(&self) -> Duration;
@@ -192,9 +196,18 @@ pub trait FragmentPreparer {
        packet_type: PacketType,
        mix_hops: Option<u8>,
    ) -> Result<PreparedFragment, NymTopologyError> {
+        debug!("Preparing chunk for sending");
        // each plain or repliable packet (i.e. not a reply) attaches an ephemeral public key so that the recipient
        // could perform diffie-hellman with its own keys followed by a kdf to re-derive
        // the packet encryption key
+
+        let seed = fragment.seed().wrapping_mul(self.nonce());
+        let mut rng = ChaCha20Rng::seed_from_u64(seed as u64);
+
+        let destination = packet_recipient.gateway();
+        let hops = mix_hops.unwrap_or(self.num_mix_hops());
+        fragment_sent(&fragment, self.nonce(), *destination, hops);
+
        let non_reply_overhead = encryption::PUBLIC_KEY_SIZE;
        let expected_plaintext = match packet_type {
            PacketType::Outfox => {
@@ -228,10 +241,8 @@ pub trait FragmentPreparer {
        };

        // generate pseudorandom route for the packet
-        let hops = mix_hops.unwrap_or(self.num_mix_hops());
        log::trace!("Preparing chunk for sending with {} mix hops", hops);
-        let route =
-            topology.random_route_to_gateway(self.rng(), hops, packet_recipient.gateway())?;
+        let route = topology.random_route_to_gateway(&mut rng, hops, destination)?;
        let destination = packet_recipient.as_sphinx_destination();

        // including set of delays
@@ -313,6 +324,8 @@ pub struct MessagePreparer<R> {
    /// Number of mix hops each packet ('real' message, ack, reply) is expected to take.
    /// Note that it does not include gateway hops.
    num_mix_hops: u8,
+
+    nonce: i32,
 }

 impl<R> MessagePreparer<R>
@@ -325,12 +338,15 @@ where
        average_packet_delay: Duration,
        average_ack_delay: Duration,
    ) -> Self {
+        let mut rng = rng;
+        let nonce = rng.gen();
        MessagePreparer {
            rng,
            sender_address,
            average_packet_delay,
            average_ack_delay,
            num_mix_hops: DEFAULT_NUM_MIX_HOPS,
+            nonce,
        }
    }

@@ -454,6 +470,10 @@ impl<R: CryptoRng + Rng> FragmentPreparer for MessagePreparer<R> {
    fn average_ack_delay(&self) -> Duration {
        self.average_ack_delay
    }
+
+    fn nonce(&self) -> i32 {
+        self.nonce
+    }
 }

 /*
@@ -60,7 +60,7 @@ pub(super) async fn run_outbound(

    loop {
        select! {
-            connection_message = &mut mix_receiver.next() => {
+            connection_message = mix_receiver.next() => {
                if let Some(connection_message) = connection_message {
                    if deal_with_message(connection_message, &mut writer, &local_destination_address, &remote_source_address, connection_id).await {
                        break;
@@ -5,7 +5,6 @@ edition = { workspace = true }
 authors = { workspace = true }
 license = { workspace = true }
 repository = { workspace = true }
-readme = { workspace = true }
 homepage = { workspace = true }
 documentation = { workspace = true }

@@ -15,9 +14,10 @@ documentation = { workspace = true }
 bs58 = { workspace = true }
 log = { workspace = true }
 rand = { workspace = true }
+reqwest = { workspace = true, features = ["json"] }
 thiserror = { workspace = true }
 async-trait = { workspace = true, optional = true }
-semver = "0.11"
+semver = { version = "0.11" }

 # 'serializable' feature
 serde = { workspace = true, features = ["derive"], optional = true }
@@ -28,20 +28,22 @@ tsify = { workspace = true, features = ["js"], optional = true }
 wasm-bindgen = { workspace = true, optional = true }

 ## internal
+nym-bin-common = { path = "../bin-common" }
+nym-config = { path = "../config" }
 nym-crypto = { path = "../crypto", features = ["sphinx", "outfox"] }
 nym-mixnet-contract-common = { path = "../cosmwasm-smart-contracts/mixnet-contract" }
 nym-sphinx-addressing = { path = "../nymsphinx/addressing" }
-nym-sphinx-types = { path = "../nymsphinx/types", features = ["sphinx", "outfox"] }
+nym-sphinx-types = { path = "../nymsphinx/types", features = [
+    "sphinx",
+    "outfox",
+] }
 nym-sphinx-routing = { path = "../nymsphinx/routing" }
-nym-bin-common = { path = "../bin-common" }
+

 # I'm not sure how to feel about pulling in this dependency here...
 nym-api-requests = { path = "../../nym-api/nym-api-requests" }


-# 'serializable' feature
-nym-config = { path = "../config", optional = true }
-
 # 'wasm-serde-types' feature
 wasm-utils = { path = "../wasm/utils", default-features = false, optional = true }

@@ -49,4 +51,5 @@ wasm-utils = { path = "../wasm/utils", default-features = false, optional = true
 default = ["provider-trait"]
 provider-trait = ["async-trait"]
 wasm-serde-types = ["tsify", "wasm-bindgen", "wasm-utils"]
-serializable = ["serde", "nym-config", "serde_json"]
+serializable = ["serde", "serde_json"]
+outfox = []
@@ -51,4 +51,16 @@ pub enum NymTopologyError {

    #[error("{0}")]
    PacketError(#[from] NymPacketError),
+
+    #[error("{0}")]
+    ReqwestError(#[from] reqwest::Error),
+
+    #[error("{0}")]
+    MixnodeConversionError(#[from] crate::mix::MixnodeConversionError),
+
+    #[error("{0}")]
+    GatewayConversionError(#[from] crate::gateway::GatewayConversionError),
+
+    #[error("{0}")]
+    VarError(#[from] std::env::VarError),
 }
@@ -6,7 +6,9 @@

 use crate::filter::VersionFilterable;
 pub use error::NymTopologyError;
-use log::{debug, warn};
+use log::{debug, info, warn};
+use mix::Node;
+use nym_config::defaults::var_names::NYM_API;
 use nym_mixnet_contract_common::mixnode::MixNodeDetails;
 use nym_mixnet_contract_common::{GatewayBond, IdentityKeyRef, MixId};
 use nym_sphinx_addressing::nodes::NodeIdentity;
@@ -116,13 +118,40 @@ impl Display for NetworkAddress {

 pub type MixLayer = u8;

-#[derive(Debug, Clone)]
+#[derive(Debug, Clone, Default)]
 pub struct NymTopology {
    mixes: BTreeMap<MixLayer, Vec<mix::Node>>,
    gateways: Vec<gateway::Node>,
 }

 impl NymTopology {
+    pub async fn new_from_env() -> Result<Self, NymTopologyError> {
+        let api_url = std::env::var(NYM_API)?;
+
+        info!("Generating topology from {}", api_url);
+
+        let mixnodes = reqwest::get(&format!("{}/v1/mixnodes", api_url))
+            .await?
+            .json::<Vec<MixNodeDetails>>()
+            .await?
+            .into_iter()
+            .map(|details| details.bond_information)
+            .map(mix::Node::try_from)
+            .filter(Result::is_ok)
+            .collect::<Result<Vec<_>, _>>()?;
+
+        let gateways = reqwest::get(&format!("{}/v1/gateways", api_url))
+            .await?
+            .json::<Vec<GatewayBond>>()
+            .await?
+            .into_iter()
+            .map(gateway::Node::try_from)
+            .filter(Result::is_ok)
+            .collect::<Result<Vec<_>, _>>()?;
+        let topology = NymTopology::new_unordered(mixnodes, gateways);
+        Ok(topology)
+    }
+
    pub fn new(mixes: BTreeMap<MixLayer, Vec<mix::Node>>, gateways: Vec<gateway::Node>) -> Self {
        NymTopology { mixes, gateways }
    }
@@ -270,7 +299,7 @@ impl NymTopology {
        &self,
        rng: &mut R,
        num_mix_hops: u8,
-    ) -> Result<Vec<SphinxNode>, NymTopologyError>
+    ) -> Result<Vec<Node>, NymTopologyError>
    where
        R: Rng + CryptoRng + ?Sized,
    {
@@ -295,12 +324,32 @@ impl NymTopology {
            let random_mix = layer_mixes
                .choose(rng)
                .ok_or(NymTopologyError::EmptyMixLayer { layer })?;
-            route.push(random_mix.into());
+            route.push(random_mix.clone());
        }

        Ok(route)
    }

+    pub fn random_path_to_gateway<R>(
+        &self,
+        rng: &mut R,
+        num_mix_hops: u8,
+        gateway_identity: &NodeIdentity,
+    ) -> Result<(Vec<mix::Node>, gateway::Node), NymTopologyError>
+    where
+        R: Rng + CryptoRng + ?Sized,
+    {
+        let gateway = self.get_gateway(gateway_identity).ok_or(
+            NymTopologyError::NonExistentGatewayError {
+                identity_key: gateway_identity.to_base58_string(),
+            },
+        )?;
+
+        let path = self.random_mix_route(rng, num_mix_hops)?;
+
+        Ok((path, gateway.clone()))
+    }
+
    /// Tries to create a route to the specified gateway, such that it goes through mixnode on layer 1,
    /// mixnode on layer2, .... mixnode on layer n and finally the target gateway
    pub fn random_route_to_gateway<R>(
@@ -321,6 +370,7 @@ impl NymTopology {
        Ok(self
            .random_mix_route(rng, num_mix_hops)?
            .into_iter()
+            .map(|node| SphinxNode::from(&node))
            .chain(std::iter::once(gateway.into()))
            .collect())
    }
@@ -4,7 +4,7 @@ version = "1.0.0"
 description = "Nym common types"
 authors.workspace = true
 edition = "2021"
-rust-version = "1.58"
+rust-version.workspace = true
 license.workspace = true

 [dependencies]
@@ -11,6 +11,7 @@ pub mod gas;
 pub mod gateway;
 pub mod helpers;
 pub mod mixnode;
+pub mod monitoring;
 pub mod pending_events;
 pub mod transaction;
 pub mod vesting;
@@ -0,0 +1,131 @@
+use std::{collections::HashSet, sync::LazyLock, time::SystemTime};
+
+use nym_crypto::asymmetric::identity::{PrivateKey, PublicKey, Signature};
+use nym_mixnet_contract_common::MixId;
+use schemars::JsonSchema;
+use serde::{Deserialize, Serialize};
+
+static NETWORK_MONITORS: LazyLock<HashSet<String>> = LazyLock::new(|| {
+    let mut nm = HashSet::new();
+    nm.insert("5VsPyLbsBCq9PAMWmjKkToteVAKNabNqex6QwDf5fWzt".to_string());
+    nm
+});
+
+#[derive(Debug, Serialize, Deserialize, JsonSchema, Clone)]
+pub struct NodeResult {
+    pub node_id: MixId,
+    pub identity: String,
+    pub reliability: u8,
+}
+
+#[derive(Debug, Serialize, Deserialize, JsonSchema, Clone)]
+pub struct MixnodeResult {
+    pub mix_id: MixId,
+    pub identity: String,
+    pub owner: String,
+    pub reliability: u8,
+}
+
+impl MixnodeResult {
+    pub fn new(mix_id: MixId, identity: String, owner: String, reliability: u8) -> Self {
+        MixnodeResult {
+            mix_id,
+            identity,
+            owner,
+            reliability,
+        }
+    }
+}
+
+#[derive(Debug, Deserialize, Serialize, JsonSchema, Clone)]
+pub struct GatewayResult {
+    pub identity: String,
+    pub owner: String,
+    pub reliability: u8,
+    pub mix_id: MixId,
+}
+
+impl GatewayResult {
+    pub fn new(identity: String, owner: String, reliability: u8) -> Self {
+        GatewayResult {
+            identity,
+            owner,
+            reliability,
+            mix_id: 0,
+        }
+    }
+}
+
+#[derive(Serialize, Deserialize, JsonSchema)]
+#[serde(untagged)]
+pub enum MonitorResults {
+    Mixnode(Vec<MixnodeResult>),
+    Gateway(Vec<GatewayResult>),
+}
+
+#[derive(Serialize, Deserialize, JsonSchema)]
+pub struct MonitorMessage {
+    results: Vec<NodeResult>,
+    signature: String,
+    signer: String,
+    timestamp: i64,
+}
+
+impl MonitorMessage {
+    fn message_to_sign(results: &[NodeResult], timestamp: i64) -> Vec<u8> {
+        let mut msg = match serde_json::to_vec(results) {
+            Ok(msg) => msg,
+            Err(_) => Vec::new(),
+        };
+        msg.extend_from_slice(&timestamp.to_le_bytes());
+        msg
+    }
+
+    pub fn timely(&self) -> bool {
+        let now = SystemTime::now()
+            .duration_since(SystemTime::UNIX_EPOCH)
+            .expect("Time went backwards")
+            .as_secs() as i64;
+
+        now - self.timestamp < 5
+    }
+
+    pub fn new(results: Vec<NodeResult>, private_key: &PrivateKey) -> Self {
+        let timestamp = SystemTime::now()
+            .duration_since(SystemTime::UNIX_EPOCH)
+            .expect("Time went backwards")
+            .as_secs() as i64;
+
+        let msg = Self::message_to_sign(&results, timestamp);
+        let signature = private_key.sign(&msg);
+        let public_key = private_key.public_key();
+
+        MonitorMessage {
+            results,
+            signature: signature.to_base58_string(),
+            signer: public_key.to_base58_string(),
+            timestamp,
+        }
+    }
+
+    pub fn from_allowed(&self) -> bool {
+        NETWORK_MONITORS.contains(&self.signer)
+    }
+
+    pub fn results(&self) -> &[NodeResult] {
+        &self.results
+    }
+
+    pub fn verify(&self) -> bool {
+        let msg = Self::message_to_sign(&self.results, self.timestamp);
+
+        let signature = match Signature::from_base58_string(&self.signature) {
+            Ok(sig) => sig,
+            Err(_) => return false,
+        };
+
+        PublicKey::from_base58_string(&self.signer)
+            .map(|pk| pk.verify(msg, &signature).is_ok())
+            .unwrap_or(false)
+    }
+}
@@ -30,13 +30,9 @@ workspace = true
 optional = true

 [features]
-default = ["sleep", "console_error_panic_hook"]
+default = ["sleep"]
 sleep = ["web-sys", "web-sys/Window"]
-websocket = [
-    "getrandom",
-    "tungstenite",
-    "gloo-net"
-]
+websocket = ["getrandom", "tungstenite", "gloo-net"]
 crypto = [
    "web-sys",
    "web-sys/Crypto",
@@ -84,6 +84,7 @@ pub struct WireguardData {
 #[cfg(target_os = "linux")]
 pub async fn start_wireguard<St: nym_gateway_storage::Storage + 'static>(
    storage: St,
+    all_peers: Vec<nym_gateway_storage::models::WireguardPeer>,
    task_client: nym_task::TaskClient,
    wireguard_data: WireguardData,
    control_tx: UnboundedSender<peer_controller::PeerControlResponse>,
@@ -95,7 +96,7 @@ pub async fn start_wireguard<St: nym_gateway_storage::Storage + 'static>(

    let mut peers = vec![];
    let mut suspended_peers = vec![];
-    for storage_peer in storage.get_all_wireguard_peers().await? {
+    for storage_peer in all_peers {
        let suspended = storage_peer.suspended;
        let peer = Peer::try_from(storage_peer)?;
        if suspended {
@@ -1,30 +1,27 @@
-# Documentation
+# Nym Docs v2
+
+This is v2 of the nym docs, condensed from various mdbooks projects that we had previously.
+
+These docs are hosted at [nymtech.net/docs](www.nymtech.net/docs).

 ## Doc projects
-Each directory contains a readme with more information about running and contributing to the projects. Each is built with [`mdbook`](https://rust-lang.github.io/mdBook/index.html) - use `mdbook serve` to build and serve them (defaults to `localhost:3000`).
-* `docs` contains technical documentation hosted at [https://nymtech.net/docs](https://nymtech.net/docs)
-* `dev-portal` contains developer documentation hosted at [https://nymtech.net/developers](https://nymtech.net/developers)
-* `operators` contains node setup and maintenance guides hosted at [https://nymtech.net/operators](https://nymtech.net/operators)
+`docs/pages/` contains several subdirs, each hosting a subsection of the docs:
+* `network` contains key concepts, cryptosystems, architecture.
+* `developers` contains key concepts for developers, required architecture, and Rust/Typescript SDK docs.
+* `operators` contains node setup and maintenance guides.

-> If you are looking for the Typescript SDK documentation located at [sdk.nymtech.net](https://sdk.nymtech.net) this can be found in `../sdk/typescript/docs/`
+## Contribution
+* If you wish to add to the documentation please create a PR against this repo, with a `patch` against `develop`.

-## Contribution 
-* If you wish to add to the documentation please create a PR against this repo. 
-* If you are **adding a plugin dependency** make sure to also **add that to the list of plugins in `install_mdbook_deps.sh` line 12**. 
+## Scripts
+* There are several autogenerated command files for clients and binaries. These are generated with `generate:commands`, which runs the `autodoc` rust binary, moves the files to their required places, and then if there is an update, commits them to git. This is for remote deployments.
+* TODO

-## Scripts 
-* `bump_versions.sh` allows you to update the ~~`platform_release_version` and~~ `wallet_release_version` variable~~s~~ in the `book.toml` of each mdbook project at once. You can also optionally update the `minimum_rust_version` as well. Helpful for lazy-updating when cutting a new version of the docs. 
+### Autodoc
+`autodoc` is a script that generates markdown files containing commands and their output (both command and `--help` output). For the moment the binaries and their commands are manually configured in the script.

-* The following scripts are used by the `ci-dev.yml` and `cd-dev.yml` scripts (located in `../.github/workflows/`):
-  * `build_all_to_dist.sh` is used for building all mdbook projects and moving the rendered html to `../dist/` to be rsynced with various servers. 
-  * `install_mdbook_deps.sh` checks for an existing install of mdbook (and plugins), uninstalls them, and then installs them on a clean slate. This is to avoid weird dependency clashes if relying on an existing mdbook version. 
-  * `post_process.sh` is used to post process CSS/image/href links for serving several mdbooks from a subdirectory. 
-  * `removed_existing_config.sh` is used to check for existing nym client/node config files on the CI/CD server and remove it if it exists. This is to mitigate issues with `mdbook-cmdrun` where e.g. a node is already initialised, and the command fails.   
-
-## CI/CD 
-Deployment of the docs is partially automated and partially manual. 
-* `ci-docs.yml` will run on pushes to all branches **apart from `master`**
-* `cd-docs.yml` must be run manually. This pushes to a staging branch which then must be manually promoted to production. 
+## CI/CD
+TODO

 ## Licensing and copyright information
 This is a monorepo and components that make up Nym as a system are licensed individually, so for accurate information, please check individual files.
@@ -36,4 +33,3 @@ As a general approach, licensing is as follows this pattern:
 * Nym applications and binaries are [GPL-3.0-only](https://www.gnu.org/licenses/)

 * Used libraries and different components are [Apache 2.0](https://www.apache.org/licenses/LICENSE-2.0.html) or [MIT](https://mit-license.org/)
-
@@ -0,0 +1 @@
+autodoc-generated-markdown/*
@@ -0,0 +1,13 @@
+[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
@@ -0,0 +1,44 @@
+# Autodoc
+
+WIP command output documentation generator. Run via `../scripts/next-scripts/autodoc.sh` to create a bunch of markdown files which are then moved around for importing into the documentation.
+
+## `Error: Os { code: 2, kind: NotFound, message: "No such file or directory" }`
+If you run into this error, make sure that you have the following directory structure:
+
+```sh
+autodoc/
+├── autodoc-generated-markdown/
+│     └── commands/
+├── Cargo.toml
+├── README.md
+└── src
+    └── main.rs
+```
+
+And if you don't - create it and re-run.
+
+If you are encountering this error with this dir structure in place, check that all Nym binaries that are listed in `main.rs` also exist in `nym/target/release/`.
+
+Run this crate on its own with `debug` logging and it should panic on the missing binary:
+
+```sh
+ RUST_LOG="debug" cargo run --release
+    Finished `release` profile [optimized] target(s) in 0.20s
+     Running `/home/______/src/nym/target/release/autodoc`
+[2024-10-23T08:11:01Z DEBUG autodoc] now running Some(
+        "nym-api",
+    )
+[2024-10-23T08:11:01Z DEBUG autodoc] stderr: " 2024-10-23T08:11:01.981Z INFO  nym_api > Starting nym api...\n"
+[2024-10-23T08:11:01Z DEBUG autodoc] stderr: " 2024-10-23T08:11:01.985Z INFO  nym_api > Starting nym api...\n"
+[2024-10-23T08:11:01Z INFO  autodoc] SKIPPING ../../target/release/nym-api init
+[2024-10-23T08:11:01Z INFO  autodoc] creating own file for ../../target/release/nym-api init --help
+[2024-10-23T08:11:01Z DEBUG autodoc] stderr: " 2024-10-23T08:11:01.993Z INFO  nym_api > Starting nym api...\n"
+
+< snip >
+
+[2024-10-23T08:11:02Z DEBUG autodoc] now running Some(
+        "nym-cli",
+    )
+Error: Os { code: 2, kind: NotFound, message: "No such file or directory" }
+
+```
@@ -0,0 +1,9 @@
+```sh
+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
+```
@@ -0,0 +1,13 @@
+```sh
+
+Binary Name:        nym-api
+Build Timestamp:    2024-10-09T13:56:14.428750844Z
+Build Version:      1.1.42
+Commit SHA:         fac373c1db4fa5389ba61de7943c77023467bccb
+Commit Date:        2024-10-09T14:59:40.000000000+02:00
+Commit Branch:      max/new-docs-framework
+rustc Version:      1.80.0
+rustc Channel:      stable
+cargo Profile:      release
+
+```
@@ -0,0 +1,87 @@
+# `nym-api` Binary Commands (Autogenerated)
+
+These docs are autogenerated by the [`autodocs`](https://github.com/nymtech/nym/tree/max/new-docs-framework/documentation/autodoc) script.
+```sh
+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
+      --no-banner
+          A no-op flag included for consistency with other binaries (and compatibility with nymvisor, oops)
+  -h, --help
+          Print help
+  -V, --version
+          Print version
+```
+
+### `init`
+```sh
+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`
+```sh
+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`
+```sh
+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
+```
@@ -0,0 +1,25 @@
+```sh
+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
+```
@@ -0,0 +1,9 @@
+```sh
+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
+```
@@ -0,0 +1,13 @@
+```sh
+
+Binary Name:        nym-client
+Build Timestamp:    2024-10-09T13:56:14.428750844Z
+Build Version:      1.1.39
+Commit SHA:         fac373c1db4fa5389ba61de7943c77023467bccb
+Commit Date:        2024-10-09T14:59:40.000000000+02:00
+Commit Branch:      max/new-docs-framework
+rustc Version:      1.80.0
+rustc Channel:      stable
+cargo Profile:      release
+
+```
@@ -0,0 +1,11 @@
+```sh
+Generate shell completions
+
+Usage: nym-client completions <SHELL>
+
+Arguments:
+  <SHELL>  [possible values: bash, elvish, fish, power-shell, zsh]
+
+Options:
+  -h, --help  Print help
+```
@@ -0,0 +1,8 @@
+```sh
+Generate Fig specification
+
+Usage: nym-client generate-fig-spec
+
+Options:
+  -h, --help  Print help
+```
@@ -0,0 +1,585 @@
+```sh
+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: "show-ticketbooks",
+      description: "Display information associated with the imported ticketbooks,",
+      options: [
+        {
+          name: "--id",
+          description: "Id of client that is going to display the ticketbook information",
+          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: "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: "show-ticketbooks",
+          description: "Display information associated with the imported ticketbooks,",
+        },
+        {
+          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;
+```
@@ -0,0 +1,15 @@
+```sh
+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
+```
@@ -0,0 +1,27 @@
+```sh
+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
+```
@@ -0,0 +1,10 @@
+```sh
+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
+```
@@ -0,0 +1,21 @@
+```sh
+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
+```
@@ -0,0 +1,10 @@
+```sh
+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
+```
@@ -0,0 +1,12 @@
+```sh
+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
+```
@@ -0,0 +1,3 @@
+```sh
+[2m2024-10-22T13:00:32.542213Z[0m [31mERROR[0m [2mnym-node/src/config/upgrade_helpers.rs[0m[2m:[0m[2m16[0m[2m:[0m Failed to finish upgrade - failed to load config file using path '/home/m/.nym/nym-nodes/default-nym-node/config/config.toml'. detailed message: No such file or directory (os error 2)
+```
@@ -0,0 +1,9 @@
+```sh
+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
+```
@@ -0,0 +1,13 @@
+```sh
+
+Binary Name:        nym-node
+Build Timestamp:    2024-10-09T13:56:14.428750844Z
+Build Version:      1.1.6
+Commit SHA:         fac373c1db4fa5389ba61de7943c77023467bccb
+Commit Date:        2024-10-09T14:59:40.000000000+02:00
+Commit Branch:      max/new-docs-framework
+rustc Version:      1.80.0
+rustc Channel:      stable
+cargo Profile:      release
+
+```
@@ -0,0 +1,231 @@
+# `nym-node` Binary Commands (Autogenerated)
+
+These docs are autogenerated by the [`autodocs`](https://github.com/nymtech/nym/tree/max/new-docs-framework/documentation/autodoc) script.
+```sh
+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`
+```sh
+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`
+```sh
+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`
+```sh
+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`
+```sh
+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-ip <WIREGUARD_PRIVATE_IP>
+          Private IP address of the wireguard gateway. default: `10.1.0.1` [env: NYMNODE_WG_IP=]
+      --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`
+```sh
+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=]
+      --accept-operator-terms-and-conditions
+          Explicitly specify whether you agree with the terms and conditions of a nym node operator as defined at <https://nymtech.net/terms-and-conditions/operators/v1.0.0> [env: NYMNODE_ACCEPT_OPERATOR_TERMS=]
+      --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=]
+      --local
+          Flag specifying this node will be running in a local setting [env: NYMNODE_LOCAL=]
+      --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-ip <WIREGUARD_PRIVATE_IP>
+          Private IP address of the wireguard gateway. default: `10.1.0.1` [env: NYMNODE_WG_IP=]
+      --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`
+```sh
+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
+```
+
+### ``
@@ -0,0 +1,68 @@
+```sh
+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-ip <WIREGUARD_PRIVATE_IP>
+          Private IP address of the wireguard gateway. default: `10.1.0.1` [env: NYMNODE_WG_IP=]
+      --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
+```
@@ -0,0 +1,11 @@
+```sh
+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
+```
@@ -0,0 +1,3 @@
+```sh
+[2m2024-10-22T13:00:32.562750Z[0m [31mERROR[0m [2mnym-node/src/config/upgrade_helpers.rs[0m[2m:[0m[2m16[0m[2m:[0m Failed to finish upgrade - failed to load config file using path '/home/m/.nym/nym-nodes/default-nym-node/config/config.toml'. detailed message: No such file or directory (os error 2)
+```
@@ -0,0 +1,13 @@
+```sh
+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
+```
@@ -0,0 +1,15 @@
+```sh
+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
+```
@@ -0,0 +1,9 @@
+```sh
+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
+```
@@ -0,0 +1,13 @@
+```sh
+
+Binary Name:        nym-socks5-client
+Build Timestamp:    2024-10-09T13:56:14.428750844Z
+Build Version:      1.1.39
+Commit SHA:         fac373c1db4fa5389ba61de7943c77023467bccb
+Commit Date:        2024-10-09T14:59:40.000000000+02:00
+Commit Branch:      max/new-docs-framework
+rustc Version:      1.80.0
+rustc Channel:      stable
+cargo Profile:      release
+
+```
@@ -0,0 +1,11 @@
+```sh
+Generate shell completions
+
+Usage: nym-socks5-client completions <SHELL>
+
+Arguments:
+  <SHELL>  [possible values: bash, elvish, fish, power-shell, zsh]
+
+Options:
+  -h, --help  Print help
+```
@@ -0,0 +1,8 @@
+```sh
+Generate Fig specification
+
+Usage: nym-socks5-client generate-fig-spec
+
+Options:
+  -h, --help  Print help
+```
@@ -0,0 +1,619 @@
+```sh
+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: "show-ticketbooks",
+      description: "Display information associated with the imported ticketbooks,",
+      options: [
+        {
+          name: "--id",
+          description: "Id of client that is going to display the ticketbook information",
+          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: "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: "show-ticketbooks",
+          description: "Display information associated with the imported ticketbooks,",
+        },
+        {
+          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;
+```
@@ -0,0 +1,15 @@
+```sh
+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
+```
@@ -0,0 +1,44 @@
+```sh
+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')
+```
@@ -0,0 +1,10 @@
+```sh
+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
+```
@@ -0,0 +1,34 @@
+```sh
+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')
+```
@@ -0,0 +1,19 @@
+```sh
+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
+```
@@ -0,0 +1,9 @@
+```sh
+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
+```
@@ -0,0 +1,13 @@
+```sh
+
+Binary Name:        nymvisor
+Build Timestamp:    2024-10-09T13:56:14.428750844Z
+Build Version:      0.1.5
+Commit SHA:         fac373c1db4fa5389ba61de7943c77023467bccb
+Commit Date:        2024-10-09T14:59:40.000000000+02:00
+Commit Branch:      max/new-docs-framework
+rustc Version:      1.80.0
+rustc Channel:      stable
+cargo Profile:      release
+
+```
@@ -0,0 +1,154 @@
+# `nymvisor` Binary Commands (Autogenerated)
+
+These docs are autogenerated by the [`autodocs`](https://github.com/nymtech/nym/tree/max/new-docs-framework/documentation/autodoc) script.
+```sh
+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`
+```sh
+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`
+```sh
+Run the associated daemon with the preconfigured settings
+
+Usage: nymvisor run [DAEMON_ARGS]...
+
+Arguments:
+  [DAEMON_ARGS]...
+
+Options:
+  -h, --help  Print help
+```
+
+### `build-info`
+```sh
+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:
+```sh
+
+Binary Name:        nymvisor
+Build Timestamp:    2024-10-23T14:56:21.738216843Z
+Build Version:      0.1.5
+Commit SHA:         7bfd7efe844be83cf5637cad11cf7cd44411026a
+Commit Date:        2024-10-23T16:53:29.000000000+02:00
+Commit Branch:      max/new-docs-framework
+rustc Version:      1.80.0
+rustc Channel:      stable
+cargo Profile:      release
+
+```
+
+### `daemon-build-info`
+```sh
+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
+```
+
+### `add-upgrade`
+```sh
+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`
+```sh
+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
+```
@@ -0,0 +1,9 @@
+```sh
+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
+```
@@ -0,0 +1,9 @@
+```sh
+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
+```
@@ -0,0 +1,48 @@
+```sh
+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
+```
@@ -0,0 +1,347 @@
+use log::{debug, info};
+use std::fs::File;
+use std::io::{self, Write};
+use std::process::{Command, Output};
+use std::{fs, vec};
+
+const WRITE_PATH: &str = "./autodoc-generated-markdown/";
+const COMMAND_PATH: &str = "./autodoc-generated-markdown/commands/";
+
+fn main() -> io::Result<()> {
+    env_logger::init();
+
+    // TODO if this balloons write automated way of grabbing commands from crates.
+    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"]),
+            (
+                "ecash",
+                vec![
+                    "issue-ticket-book",
+                    "recover-ticket-book",
+                    "import-ticket-book",
+                ],
+            ),
+            (
+                "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);
+        debug!("now running {last_word:#?}");
+
+        if !fs::metadata(WRITE_PATH)
+            .map(|metadata| metadata.is_dir())
+            .unwrap_or(false)
+        {
+            fs::create_dir_all(WRITE_PATH)?;
+        }
+
+        let mut file = File::create(format!("{}/{}-commands.md", WRITE_PATH, last_word.unwrap()))?;
+        writeln!(
+            file,
+            "# {} Binary Commands (Autogenerated)",
+            format!("`{}`", last_word.unwrap())
+        )?;
+        writeln!(
+            file,
+            "\nThese docs are autogenerated by the [`autodocs`](https://github.com/nymtech/nym/tree/max/new-docs-framework/documentation/autodoc) script."
+        )?;
+        let output = Command::new(main_command).arg("--help").output()?;
+        write_output_to_file(&mut file, output)?;
+
+        for subcommand in subcommands {
+            // single file
+            execute_command(&mut file, main_command, subcommand, None)?;
+            // file per command
+            execute_command_own_file(main_command, subcommand)?;
+        }
+    }
+
+    // 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);
+        debug!("now running {last_word:#?}");
+        let mut file = File::create(format!("{}/{}-commands.md", WRITE_PATH, last_word.unwrap()))?;
+        writeln!(
+            file,
+            "# {} Binary Commands (Autogenerated)",
+            format!("`{}`", last_word.unwrap())
+        )?;
+        writeln!(
+            file,
+            "\nThese docs are autogenerated by the [`autodocs`](https://github.com/nymtech/nym/tree/max/new-docs-framework/documentation/autodoc) script."
+        )?;
+        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 {
+                debug!("empty stdout - nothing to write");
+            }
+            for subsubcommand in subsubcommands {
+                execute_command(&mut file, main_command, subcommand, Some(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_own_file(main_command: &str, subcommand: &str) -> io::Result<()> {
+    // 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" && subcommand == "run"
+        || get_last_word_from_filepath(main_command).unwrap() == "nym-api" && subcommand == "run"
+        || get_last_word_from_filepath(main_command).unwrap() == "nymvisor" && subcommand == "run"
+    {
+        info!("SKIPPING {} {}", main_command, subcommand);
+    } else {
+        let last_word = get_last_word_from_filepath(main_command);
+        let output = Command::new(main_command).arg(subcommand).output()?;
+        if !output.stdout.is_empty() {
+            info!("creating own file for {} {}", main_command, subcommand,);
+            if !fs::metadata(WRITE_PATH)
+                .map(|metadata| metadata.is_dir())
+                .unwrap_or(false)
+            {
+                fs::create_dir_all(COMMAND_PATH)?;
+            }
+            let mut file = File::create(format!(
+                "{}/{}-{}.md",
+                COMMAND_PATH,
+                last_word.unwrap(),
+                subcommand
+            ))?;
+            write_output_to_file(&mut file, output)?;
+
+            // execute help
+            info!(
+                "creating own file for {} {} --help",
+                main_command, subcommand,
+            );
+            if !fs::metadata(COMMAND_PATH)
+                .map(|metadata| metadata.is_dir())
+                .unwrap_or(false)
+            {
+                fs::create_dir_all(COMMAND_PATH)?;
+            }
+            let mut help_file = File::create(format!(
+                "{}/{}-{}-help.md",
+                COMMAND_PATH,
+                last_word.unwrap(),
+                subcommand
+            ))?;
+
+            let output = Command::new(main_command)
+                .arg(subcommand)
+                .arg("--help")
+                .output()?;
+            if !output.stdout.is_empty() {
+                write_output_to_file(&mut help_file, output)?;
+            } else {
+                debug!("empty stdout - nothing to write");
+            }
+        } else {
+            info!(
+                "creating own file for {} {} --help",
+                main_command, subcommand,
+            );
+            if !fs::metadata(COMMAND_PATH)
+                .map(|metadata| metadata.is_dir())
+                .unwrap_or(false)
+            {
+                fs::create_dir_all(COMMAND_PATH)?;
+            }
+            let mut help_file = File::create(format!(
+                "{}/{}-{}-help.md",
+                COMMAND_PATH,
+                last_word.unwrap(),
+                subcommand
+            ))?;
+
+            let output = Command::new(main_command)
+                .arg(subcommand)
+                .arg("--help")
+                .output()?;
+            write_output_to_file(&mut help_file, output)?;
+            debug!("empty stdout - nothing to write");
+        }
+    }
+    Ok(())
+}
+
+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 {
+            debug!("empty stdout - nothing to write");
+        }
+    // just subcommands
+    } else {
+        writeln!(file, "\n### `{}`", 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 {
+            debug!("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 {
+                debug!("empty stdout - nothing to write");
+                if !&output.stderr.is_empty() {
+                    debug!("stderr: {:#?}", String::from_utf8_lossy(&output.stderr));
+                }
+            }
+        }
+    }
+    Ok(())
+}
+
+fn write_output_to_file(file: &mut File, output: Output) -> io::Result<()> {
+    writeln!(file, "```sh")?;
+    file.write_all(&output.stdout)?;
+    writeln!(file, "```")?;
+
+    if !&output.stderr.is_empty() {
+        debug!("stderr: {:#?}", String::from_utf8_lossy(&output.stderr));
+    }
+    Ok(())
+}
@@ -1,51 +0,0 @@
-#!/usr/bin/env bash
-
-set -o errexit
-set -o nounset
-set -o pipefail
-
-# this is a script called by the github CI and CD workflows to build all 3 docs projects
-# and move them to /dist/ in the root of the monorepo. They are rsynced to various servers
-# from there by subsequent workflow tasks.
-
-# array of project dirs
-declare -a projects=("docs" "dev-portal" "operators")
-
-# check you're calling from the right place
-if [ $(pwd | awk -F/ '{print $NF}') != "documentation" ]
-then
-  echo "failure: please run script from documentation/"
-else
-   for i in "${projects[@]}"
-   do
-      # cd to project dir
-      cd "./$i" &&
-      # little sanity checks
-      echo $(pwd) && echo $(mdbook --version) &&
-      # clean old book
-      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
-        echo "dest doesn't exist: creating dir"
-        mkdir -p ../../dist/docs/$i
-      fi
-      if [ -d ../../dist/docs/$i ]; then
-        echo "cp destination exists, all good"
-      fi
-      # clean old dist/$i
-      rm -rf ../../dist/docs/$i
-      # move newly rendered book/ to dist
-      rsync -r ./book/html/ ../../dist/docs/$i
-      # sanity check
-      ls -laF ../../dist/docs/
-      # cd back to ../documentation/
-      cd ../
-   done
-   # rename for server paths
-   rm -rf ../dist/docs/developers
-   mv ../dist/docs/dev-portal ../dist/docs/developers
-fi
@@ -1,45 +0,0 @@
-#!/usr/bin/env bash
-
-set -o errexit
-set -o nounset
-set -o pipefail
-
-# takes one manadatory arg and one optional arg: wallet release and minimum rust versions
-# it then uses sed to bump them in the three book.toml files.
-#
-# e.g if the upcoming wallet release version was 1.2.9 you'd run this as:
-# `./bump_versions.sh "1.2.9"`
-#
-# you can also set the minumum rust version by passing an optional additional argument:
-# `./bump_versions.sh "1.2.9" "1.67"`
-
-# array of project dirs
-declare -a projects=("docs" "dev-portal" "operators")
-
-# check number of args passed
-if [ "$#" -lt 1 ] || [ "$#" -gt 2 ];
-then
-    echo "failure: please pass at least 1 and at most 2 args: "
-    echo "./bump_version.sh <new wallet_release_version> [OPTIONAL]<new minimum_rust_version>"
-    exit 0
-fi
-
-# check you're calling from the right place
-if [ $(pwd | awk -F/ '{print $NF}') != "documentation" ]
-then
-  echo "failure: please run script from documentation/"
-  exit 0
-else
-  ## now loop through the above array sed-ing the variable values in the book.toml files
-  for i in "${projects[@]}"
-  do
-    # sed the vars in the book.toml file for each project
-    echo "setting wallet version in $i/"
-    sed -i 's/wallet_release_version =.*/wallet_release_version = "'$2'"/' "$i"/book.toml
-    if [ "$3" ]
-    then
-      echo "setting minimum rust version in $i/"
-      sed -i 's/minimum_rust_version = .*/minimum_rust_version = "'$3'"/' "$i"/book.toml
-    fi
-  done
-fi
@@ -1,24 +0,0 @@
-# Generated by Cargo
-# will have compiled files and executables
-/target/
-
-# Remove Cargo.lock from gitignore if creating an executable, leave it for libraries
-# More information here https://doc.rust-lang.org/cargo/guide/cargo-toml-vs-cargo-lock.html
-Cargo.lock
-
-# These are backup files generated by rustfmt
-**/*.rs.bk
-
-# Book specific 
-book
-
-# OSX
-.DS_Store
-
-theme/
-theme
-theme/*
-
-.idea
-
-notes
@@ -1,201 +0,0 @@
-                                 Apache License
-                           Version 2.0, January 2004
-                        http://www.apache.org/licenses/
-
-   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
-
-   1. Definitions.
-
-      "License" shall mean the terms and conditions for use, reproduction,
-      and distribution as defined by Sections 1 through 9 of this document.
-
-      "Licensor" shall mean the copyright owner or entity authorized by
-      the copyright owner that is granting the License.
-
-      "Legal Entity" shall mean the union of the acting entity and all
-      other entities that control, are controlled by, or are under common
-      control with that entity. For the purposes of this definition,
-      "control" means (i) the power, direct or indirect, to cause the
-      direction or management of such entity, whether by contract or
-      otherwise, or (ii) ownership of fifty percent (50%) or more of the
-      outstanding shares, or (iii) beneficial ownership of such entity.
-
-      "You" (or "Your") shall mean an individual or Legal Entity
-      exercising permissions granted by this License.
-
-      "Source" form shall mean the preferred form for making modifications,
-      including but not limited to software source code, documentation
-      source, and configuration files.
-
-      "Object" form shall mean any form resulting from mechanical
-      transformation or translation of a Source form, including but
-      not limited to compiled object code, generated documentation,
-      and conversions to other media types.
-
-      "Work" shall mean the work of authorship, whether in Source or
-      Object form, made available under the License, as indicated by a
-      copyright notice that is included in or attached to the work
-      (an example is provided in the Appendix below).
-
-      "Derivative Works" shall mean any work, whether in Source or Object
-      form, that is based on (or derived from) the Work and for which the
-      editorial revisions, annotations, elaborations, or other modifications
-      represent, as a whole, an original work of authorship. For the purposes
-      of this License, Derivative Works shall not include works that remain
-      separable from, or merely link (or bind by name) to the interfaces of,
-      the Work and Derivative Works thereof.
-
-      "Contribution" shall mean any work of authorship, including
-      the original version of the Work and any modifications or additions
-      to that Work or Derivative Works thereof, that is intentionally
-      submitted to Licensor for inclusion in the Work by the copyright owner
-      or by an individual or Legal Entity authorized to submit on behalf of
-      the copyright owner. For the purposes of this definition, "submitted"
-      means any form of electronic, verbal, or written communication sent
-      to the Licensor or its representatives, including but not limited to
-      communication on electronic mailing lists, source code control systems,
-      and issue tracking systems that are managed by, or on behalf of, the
-      Licensor for the purpose of discussing and improving the Work, but
-      excluding communication that is conspicuously marked or otherwise
-      designated in writing by the copyright owner as "Not a Contribution."
-
-      "Contributor" shall mean Licensor and any individual or Legal Entity
-      on behalf of whom a Contribution has been received by Licensor and
-      subsequently incorporated within the Work.
-
-   2. Grant of Copyright License. Subject to the terms and conditions of
-      this License, each Contributor hereby grants to You a perpetual,
-      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
-      copyright license to reproduce, prepare Derivative Works of,
-      publicly display, publicly perform, sublicense, and distribute the
-      Work and such Derivative Works in Source or Object form.
-
-   3. Grant of Patent License. Subject to the terms and conditions of
-      this License, each Contributor hereby grants to You a perpetual,
-      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
-      (except as stated in this section) patent license to make, have made,
-      use, offer to sell, sell, import, and otherwise transfer the Work,
-      where such license applies only to those patent claims licensable
-      by such Contributor that are necessarily infringed by their
-      Contribution(s) alone or by combination of their Contribution(s)
-      with the Work to which such Contribution(s) was submitted. If You
-      institute patent litigation against any entity (including a
-      cross-claim or counterclaim in a lawsuit) alleging that the Work
-      or a Contribution incorporated within the Work constitutes direct
-      or contributory patent infringement, then any patent licenses
-      granted to You under this License for that Work shall terminate
-      as of the date such litigation is filed.
-
-   4. Redistribution. You may reproduce and distribute copies of the
-      Work or Derivative Works thereof in any medium, with or without
-      modifications, and in Source or Object form, provided that You
-      meet the following conditions:
-
-      (a) You must give any other recipients of the Work or
-          Derivative Works a copy of this License; and
-
-      (b) You must cause any modified files to carry prominent notices
-          stating that You changed the files; and
-
-      (c) You must retain, in the Source form of any Derivative Works
-          that You distribute, all copyright, patent, trademark, and
-          attribution notices from the Source form of the Work,
-          excluding those notices that do not pertain to any part of
-          the Derivative Works; and
-
-      (d) If the Work includes a "NOTICE" text file as part of its
-          distribution, then any Derivative Works that You distribute must
-          include a readable copy of the attribution notices contained
-          within such NOTICE file, excluding those notices that do not
-          pertain to any part of the Derivative Works, in at least one
-          of the following places: within a NOTICE text file distributed
-          as part of the Derivative Works; within the Source form or
-          documentation, if provided along with the Derivative Works; or,
-          within a display generated by the Derivative Works, if and
-          wherever such third-party notices normally appear. The contents
-          of the NOTICE file are for informational purposes only and
-          do not modify the License. You may add Your own attribution
-          notices within Derivative Works that You distribute, alongside
-          or as an addendum to the NOTICE text from the Work, provided
-          that such additional attribution notices cannot be construed
-          as modifying the License.
-
-      You may add Your own copyright statement to Your modifications and
-      may provide additional or different license terms and conditions
-      for use, reproduction, or distribution of Your modifications, or
-      for any such Derivative Works as a whole, provided Your use,
-      reproduction, and distribution of the Work otherwise complies with
-      the conditions stated in this License.
-
-   5. Submission of Contributions. Unless You explicitly state otherwise,
-      any Contribution intentionally submitted for inclusion in the Work
-      by You to the Licensor shall be under the terms and conditions of
-      this License, without any additional terms or conditions.
-      Notwithstanding the above, nothing herein shall supersede or modify
-      the terms of any separate license agreement you may have executed
-      with Licensor regarding such Contributions.
-
-   6. Trademarks. This License does not grant permission to use the trade
-      names, trademarks, service marks, or product names of the Licensor,
-      except as required for reasonable and customary use in describing the
-      origin of the Work and reproducing the content of the NOTICE file.
-
-   7. Disclaimer of Warranty. Unless required by applicable law or
-      agreed to in writing, Licensor provides the Work (and each
-      Contributor provides its Contributions) on an "AS IS" BASIS,
-      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
-      implied, including, without limitation, any warranties or conditions
-      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
-      PARTICULAR PURPOSE. You are solely responsible for determining the
-      appropriateness of using or redistributing the Work and assume any
-      risks associated with Your exercise of permissions under this License.
-
-   8. Limitation of Liability. In no event and under no legal theory,
-      whether in tort (including negligence), contract, or otherwise,
-      unless required by applicable law (such as deliberate and grossly
-      negligent acts) or agreed to in writing, shall any Contributor be
-      liable to You for damages, including any direct, indirect, special,
-      incidental, or consequential damages of any character arising as a
-      result of this License or out of the use or inability to use the
-      Work (including but not limited to damages for loss of goodwill,
-      work stoppage, computer failure or malfunction, or any and all
-      other commercial damages or losses), even if such Contributor
-      has been advised of the possibility of such damages.
-
-   9. Accepting Warranty or Additional Liability. While redistributing
-      the Work or Derivative Works thereof, You may choose to offer,
-      and charge a fee for, acceptance of support, warranty, indemnity,
-      or other liability obligations and/or rights consistent with this
-      License. However, in accepting such obligations, You may act only
-      on Your own behalf and on Your sole responsibility, not on behalf
-      of any other Contributor, and only if You agree to indemnify,
-      defend, and hold each Contributor harmless for any liability
-      incurred by, or claims asserted against, such Contributor by reason
-      of your accepting any such warranty or additional liability.
-
-   END OF TERMS AND CONDITIONS
-
-   APPENDIX: How to apply the Apache License to your work.
-
-      To apply the Apache License to your work, attach the following
-      boilerplate notice, with the fields enclosed by brackets "[]"
-      replaced with your own identifying information. (Don't include
-      the brackets!)  The text should be enclosed in the appropriate
-      comment syntax for the file format. We also recommend that a
-      file or class name and description of purpose be included on the
-      same "printed page" as the copyright notice for easier
-      identification within third-party archives.
-
-   Copyright [yyyy] [name of copyright owner]
-
-   Licensed under the Apache License, Version 2.0 (the "License");
-   you may not use this file except in compliance with the License.
-   You may obtain a copy of the License at
-
-       http://www.apache.org/licenses/LICENSE-2.0
-
-   Unless required by applicable law or agreed to in writing, software
-   distributed under the License is distributed on an "AS IS" BASIS,
-   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-   See the License for the specific language governing permissions and
-   limitations under the License.
@@ -1,24 +0,0 @@
-# Nym Developer Portal
-Developer Portal for the Nym privacy platform built using the [mdBook](https://rust-lang.github.io/mdBook/) docs framework. Deployed version can be found [here](https://nymtech.net/developers).
-
-## Contributing
-Contributions to our documentation are very welcome. Please work on your contribution in either a `feature/<feature-name>` or `chore/<chore-name>` branch from `master` and target your pull request at `master`.
-
-Changes merged to `master` will be autodeployed to the production site.
-
-### Adding community projects and resources
-If you have built a project with Nym or are compiling and writing resources about Nym, we want to include your work in the `community-resources/` section to share with the rest of the community! Just follow the existing formatting and add your project to the page, then put in a pull request.
-
-## Variables
-There are some variables that are shared across this book, such as the current latest software version.
-
-Variables are denoted in the `.md` files wrapped in `{{}}` (e.g `{{wallet_release_version}}`), and are located in the `book.toml` file under the `[preprocessor.variables.variables]` heading. If you are changing something like the software release version, minimum code versions in prerequisites, etc, **check in here first!**
-
-## Building
-When working locally, it is recommended that you use `mdbook serve` to have a local version of the docs served on `localhost:3000`, with hot reloading on any changes made to files in the `src/` directory.
-
-You can find other commands in the [mdBook CLI tool docs](https://rust-lang.github.io/mdBook/cli/index.html).
-
-### I tried to edit files in `theme/` and they aren't taking effect / `mdbook serve` causes a looping reload on file changes after changing fields in `[preprocessor.theme]` config
-
-Looping reload is a known issue with the `mdbook-theme` preprocessor used for the table of contents and layout of these docs. As outlined in the `mdbook-theme` [readme](https://github.com/zjp-CN/mdbook-theme#avoid-repeating-call-on-this-tool-when-mdbook-watch) one way to mitigate this is to set `turn-off = true` under `[preprocessor.theme]`. This means that `mdbook serve` or `mdbook watch` ignores changes to the `theme/` directory, which is the source of the looping reload. If you have changed or commented out this line, reintroduce it to remove the looping reload. If you are trying to edit the theme of the docs and want to apply the change, see [here](https://github.com/zjp-CN/mdbook-theme#avoid-repeating-call-on-this-tool-when-mdbook-watch) for more info on how to remove the block, change the theme, and reintroduce the block.
@@ -1,118 +0,0 @@
-[book]
-title = "Nym Docs"
-authors = ["Max Hampshire, Serinko, Alexia Lorenza Martinel"]
-description = "Nym technical documentation"
-language = "en"
-multilingual = false                                          # for the moment - ideally work on chinese, brazillian ,portugese spanish next
-src = "src"
-
-[rust]
-edition = "2018"
-
-#################
-# PREPROCESSORS #
-#################
-
-[preprocessor.theme]
-pagetoc = true
-sidebar-width = "280px"
-content-max-width = "80%"
-root-font-size = "70%"
-# if you need to change anything in the index.hbs file you need to turn this to `false`, rebuild the book, 
-# probably remove the additional `comment` that gets appended to the header, and then change this back to `true`. 
-# this is because of a bug in the `mdbook-theme` plugin
-turn-off = true
-
-
-[preprocessor.admonish]
-command = "mdbook-admonish"
-assets_version = "3.0.2"    # do not edit: managed by `mdbook-admonish install`
-
-# https://gitlab.com/tglman/mdbook-variables/
-[preprocessor.variables.variables]
-minimum_rust_version = "1.66"
-wallet_release_version = "1.2.8"
-# nym-vpn related variables
-nym_vpn_releases = "https://github.com/nymtech/nym-vpn-client/releases"
-nym_vpn_form_url = "https://opnform.com/forms/nymvpn-user-research-at-37c3-yccqko-2"
-
-# versions are pulled by cmdrun now
-# nym_vpn_gui_version = "0.0.6"
-# nym_vpn_cli_version = "0.0.4"
-
-[preprocessor.last-changed]
-command = "mdbook-last-changed"
-renderer = ["html"]
-
-# used for grabbing output of binary commands for automation https://github.com/FauconFan/mdbook-cmdrun
-[preprocessor.cmdrun]
-
-# more pre-processor plugins to look into from https://github.com/rust-lang/mdBook/wiki/Third-party-plugins & https://lib.rs/keywords/mdbook-preprocessor
-# mdbook-i18n
-
-#########
-# BUILD #
-#########
-
-[build]
-build-dir = "book"               # the directory where the output is placed
-create-missing = true            # whether or not to create missing pages
-use-default-preprocessors = true # use the default preprocessors
-extra-watch-dirs = []            # directories to watch for triggering builds
-
-##########
-# OUTPUT #
-##########
-
-[output.html]
-theme = "themes"
-default-theme = "coal"
-preferred-dark-theme = "coal"
-curly-quotes = true
-copy-fonts = true
-no-section-label = false
-additional-css = [
-  "./themes/custom.css",
-  "./themes/mdbook-admonish.css",
-  "./themes/pagetoc.css",
-]
-additional-js = ["./themes/pagetoc.js"]
-git-repository-url = "https://github.com/nymtech/nym"
-git-repository-icon = "fa-github"
-input-404 = "not-found.md"
-
-[output.html.fold]
-enable = true # whether or not to enable section folding
-level = 0     # the depth to start folding
-
-# controlling rust sample code blocks
-[output.html.playground]
-editable = false    # allows editing the source code
-copyable = true     # include the copy button for copying code snippets
-copy-js = true      # includes the JavaScript for the code editor
-line-numbers = true # displays line numbers for editable code
-runnable = true     # displays a run button for rust code
-
-# options for the built in text search
-[output.html.search]
-enable = true           # enables the search feature
-limit-results = 30      # maximum number of search results
-teaser-word-count = 30  # number of words used for a search result teaser
-use-boolean-and = true  # multiple search terms must all match
-boost-title = 2         # ranking boost factor for matches in headers
-boost-hierarchy = 1     # ranking boost factor for matches in page names
-boost-paragraph = 1     # ranking boost factor for matches in text
-expand = true           # partial words will match longer terms
-heading-split-level = 3 # link results to heading levels
-copy-js = true          # include Javascript code for search
-
-[output.linkcheck]
-warning-policy = "warn"
-
-[output.html.redirect]
-"/faq/general-faq.html" = "https://nymtech.net/developers/faq/integrations-faq.html"
-"/tutorials/simple-service-provider/user-client.html" = "https://nymtech.net/developers/examples/custom-services.html"
-"/quickstart/socks-proxy.html" = "https://nymtech.net/developers/clients/socks5/setup.html"
-"/tutorials/matrix.html" = "https://nymtech.net/developers/archive/nym-connect.html#matrix-element-via-nymconnect"
-"/tutorials/monero.html" = "https://nymtech.net/developers/archive/nym-connect.html#monero-wallet-via-nymconnect"
-"/tutorials/telegram.html" = "https://nymtech.net/developers/archive/nym-connect.html#telegram-via-nymconnect"
@@ -1,24 +0,0 @@
-       +-----------+ 
-       |  Gateway  | 
-       +-----------+
-             ^     
-             |    
-             |     
-             |     
-             |    
-             |   
-             |   
-   +-------------------+ 
-   | +---------------+ | 
-   | |  Nym client   | | 
-   | +---------------+ | 
-   |         ^         | 
-   |         |         | 
-   |         |         | 
-   |         |         | 
-   |         v         | 
-   | +---------------+ | 
-   | | Your app code | | 
-   | +---------------+ | 
-   +-------------------+ 
-    Your Local Machine   
@@ -1,33 +0,0 @@
-                                                                               
-       +----------+              +----------+             +----------+                 
-       | Mix Node |<-----------> | Mix Node |<----------->| Mix Node |                 
-       | Layer 1  |              | Layer 2  |             | Layer 3  |                 
-       +----------+              +----------+             +----------+                 
-            ^                                                   ^                      
-            |                                                   |                      
-            |                                                   |                      
-            v                                                   v                      
-    +--------------+                                   +-----------------+        
-    | Your gateway |                                   | Service gateway |        
-    +--------------+                                   +-----------------+        
-            ^                                                    ^                     
-            |                                                    |                     
-            |                                                    |                     
-            v                                                    v                     
-  +-------------------+                                +-------------------+           
-  | +---------------+ |                                | +---------------+ |           
-  | |  Nym client   | |                                | |  Nym Client   | |           
-  | +---------------+ |                                | +---------------+ |           
-  |         ^         |                                |         ^         |           
-  |         |         |                                |         |         |           
-  |         |         |                                |         |         |           
-  |         v         |                                |         v         |           
-  | +---------------+ |                                | +---------------+ |           
-  | | Your app code | |                                | | Service Code  | |           
-  | +---------------+ |                                | +---------------+ |           
-  +-------------------+                                +-------------------+           
-   Your Local Machine**                               Service Provider Machine**        
-
-
-** note that depending on the technical setup, the Nym client running on these machines may
-be either a seperate process or embedded in the same process as the app code via one of our SDKs. 
@@ -1,34 +0,0 @@
-                                                                               
-       +----------+              +----------+             +----------+                 
-       | Mix Node |<-----------> | Mix Node |<----------->| Mix Node |                 
-       | Layer 1  |              | Layer 2  |             | Layer 3  |                 
-       +----------+              +----------+             +----------+                 
-            ^                                                   ^                      
-            |                                                   |                      
-            |<--------------------------------------------------+
-            |                                                                         
-            v                                                                         
-    +--------------+                                
-    | Your gateway |                               
-    +--------------+                               
-            ^                                       
-            |                                                                      
-            |                                                                         
-            v                                                                         
-  +-------------------+                                        
-  | +---------------+ |                               
-  | |  Nym client   | |                              
-  | +---------------+ |                              
-  |         ^         |                             
-  |         |         |                               
-  |         |         |                               
-  |         v         |                               
-  | +---------------+ |                               
-  | | Your app code | |                               
-  | +---------------+ |                               
-  +-------------------+                               
-   Your Local Machine**                              
-
-
-** note that depending on the technical setup, the Nym client running on this machine may
-be either a seperate process or embedded in the same process as the app code via one of our SDKs. 
@@ -1,14 +0,0 @@
-+-------------------+
-| +---------------+ |
-| |  Nym client   | |
-| +---------------+ |
-|         ^         |
-|         |         |
-|         |         |
-|         |         |
-|         v         |
-| +---------------+ |
-| | Your app code | |
-| +---------------+ |
-+-------------------+
- Your Local Machine 
@@ -1,15 +0,0 @@
-+-------------------+               
-| +---------------+ |  
-| |  Nym client   | |        
-| +---------------+ |  
-|         ^         |          
-|         |         |         
-|         |         |        
-|         |         |         
-|         v         |        
-| +---------------+ |  
-| | Service code  | |       
-| +---------------+ |  
-+-------------------+       
-   Service Machine                           
-                                                                                                       
@@ -1,67 +0,0 @@
-#
- [Introduction](introduction.md)
- [Clients Overview - Start Here!](clients-overview.md)
-
-# SDKs
- [Rust SDK](sdk/rust/rust.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)
-
-# Binaries
- [Pre-built Binaries](binaries/pre-built-binaries.md)
- [Building from Source](binaries/building-nym.md)
-
-# Standalone Clients
- [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)
- [Socks5 Client](clients/socks5-client.md)
-  - [Setup & Run](clients/socks5/setup.md)
-  - [Using Your Client](clients/socks5/usage.md)
- [Webassembly Client](clients/webassembly-client.md)
-
-# Tutorials
- [Stub: Updates Coming Soon!](./tutorials/coming-soon.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)
-
-# FAQ
- [Integrations](faq/integrations-faq.md)
-
-# User Manuals
- [NymVPN alpha](nymvpn/intro.md)
-    - [CLI](nymvpn/cli.md)
---
-
-# Archive
- [NymConnect Setup](archive/nym-connect.md)
-
---
-
-# Misc.
- [Code of Conduct](coc.md)
- [Licensing](licensing.md)
---
@@ -1,6 +0,0 @@
-# Pre-built Binaries
-
-The [Github releases page](https://github.com/nymtech/nym/releases) has pre-built binaries which should work on Ubuntu 20.04 and other Debian-based systems, but at this stage cannot be guaranteed to work everywhere.
-
-If the pre-built binaries don't work or are unavailable for your system, you will need to build the platform yourself.
-
@@ -1,49 +0,0 @@
-# Clients Overview 
-
-A large proportion of the Nym mixnet's functionality is implemented client-side. 
-
-Clients perform the following actions on behalf of users: 
-
-* determine network topology - what mixnodes exist, what their keys are, etc.
-* register with a gateway
-* authenticate with a gateway
-* receive and decrypt messages from the gateway
-* create layer-encrypted Sphinx packets
-* send Sphinx packets with real messages
-* send Sphinx packet _cover traffic_ when no real messages are being sent
-* retransmit un-acknowledged packet sends - if a client sends 100 packets to a gateway, but only receives an acknowledgement ('ack') for 95 of them, it will resend those 5 packets to the gateway again, to make sure that all packets are received.  
-
-> As a developer, you'll want to use a Nym client to send your application network traffic through the mixnet; whether that is an RPC call, a TCP connection request, or treating it like a UDP pipe, you need to send whatever bytes your app needs to send through it. However, unlike (e.g.) a TCP Socket, Nym client communication is message-based, so you cannot (yet) simply plug-and-play using the mixnet as a seamless drop-in replacement. We are currently working on stream-like abstractions for ease of integration with the Rust SDK. 
-
-## Types of Nym clients
-At present, there are three Nym clients:
-
- the websocket (native) client
- the SOCKS5 client
- the wasm (webassembly) client
-
-You need to choose which one you want incorporate into your app. Which one you use will depend largely on your preferred programming style and the purpose of your app.
-
-### The websocket client
-Your first option is the native websocket client (`nym-client`). This is a compiled program that can run on Linux, Mac OS X, and Windows machines. It can be run as a persistent process on a desktop or server machine. You can connect to it with **any language that supports websockets**. 
-
-> Rust developers can import websocket client functionality into their code via the [Rust SDK](sdk/rust/rust.md). 
-
-### The webassembly client
-If you're working in JavaScript or Typescript in the browser, or building an [edge computing](https://en.wikipedia.org/wiki/Edge_computing) app, you'll likely want to choose the webassembly client. 
-
-It's packaged and [available on the npm registry](https://www.npmjs.com/package/@nymproject/nym-client-wasm), so you can `npm install` it into your JavaScript or TypeScript application. 
-
-> The webassembly client is most easily used via the [Typescript SDK](sdk/typescript.md). Typescript developers who wish to send API requests through the mixnet can can also check the [`mixfetch`]() package.
-
-### The SOCKS5 client
-The `nym-socks5-client` is useful for allowing existing applications to use the Nym mixnet without any code changes. All that's necessary is that they can use one of the SOCKS5, SOCKS4a, or SOCKS4 proxy protocols (which many applications can - crypto wallets, browsers, chat applications etc). 
-
-When used as a standalone client, it's less flexible as a way of writing custom applications than the other clients, but able to be used to proxy application traffic through the mixnet without having to make any code changes. 
-
-> Rust developers can import socks client functionality into their code via the [Rust SDK](sdk/rust/rust.md). 
-
-## Commonalities between clients
-All Nym client packages present basically the same capabilities to the privacy application developer. They need to run as a persistent process in order to stay connected and ready to receive any incoming messages from their gateway nodes. They register and authenticate to gateways, and encrypt Sphinx packets.
-
-
@@ -1,45 +0,0 @@
-# Clients Overview
-
-A large proportion of the Nym mixnet's functionality is implemented client-side. 
-
-Clients perform the following actions on behalf of users: 
-
-* determine network topology - what mixnodes exist, what their keys are, etc.
-* register with a gateway
-* authenticate with a gateway
-* receive and decrypt messages from the gateway
-* create layer-encrypted Sphinx packets
-* send Sphinx packets with real messages
-* send Sphinx packet _cover traffic_ when no real messages are being sent
-* retransmit un-acknowledged packet sends - if a client sends 100 packets to a gateway, but only receives an acknowledgement ('ack') for 95 of them, it will resend those 5 packets to the gateway again, to make sure that all packets are received.  
-
-## Types of Nym clients
-At present, there are three Nym clients:
-
- the websocket (native) client
- the SOCKS5 client
- the wasm (webassembly) client
-
-You need to choose which one you want incorporate into your app. Which one you use will depend largely on your preferred programming style and the purpose of your app.
-
-### The websocket client
-Your first option is the native websocket client (`nym-client`). This is a compiled program that can run on Linux, Mac OS X, and Windows machines. It can be run as a persistent process on a desktop or server machine. You can connect to it with **any language that supports websockets**. 
-
-> Rust developers can import websocket client functionality into their code via the [Rust SDK](../sdk/rust/rust.md). 
-
-### The webassembly client
-If you're working in JavaScript or Typescript in the browser, or building an [edge computing](https://en.wikipedia.org/wiki/Edge_computing) app, you'll likely want to choose the webassembly client. 
-
-It's packaged and [available on the npm registry](https://www.npmjs.com/package/@nymproject/nym-client-wasm), so you can `npm install` it into your JavaScript or TypeScript application. 
-
-> The webassembly client is most easily used via the [Typescript SDK](../sdk/typescript.md). Typescript developers who wish to send API requests through the mixnet can can also check the [`mixfetch`]() package.
-
-### The SOCKS5 client
-The `nym-socks5-client` is useful for allowing existing applications to use the Nym mixnet without any code changes. All that's necessary is that they can use one of the SOCKS5, SOCKS4a, or SOCKS4 proxy protocols (which many applications can - crypto wallets, browsers, chat applications etc). 
-
-When used as a standalone client, it's less flexible as a way of writing custom applications than the other clients, but able to be used to proxy application traffic through the mixnet without having to make any code changes. 
-
-_Rust developers can import socks client functionality into their code via the [Rust SDK](../sdk/rust/rust.md)_.
-
-## Commonalities between clients
-All Nym client packages present basically the same capabilities to the privacy application developer. They need to run as a persistent process in order to stay connected and ready to receive any incoming messages from their gateway nodes. They register and authenticate to gateways, and encrypt Sphinx packets.
@@ -1,45 +0,0 @@
-# Setup
-
-> `nym-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.
-
-```admonish info
-Since the beginning of 2024 NymConnect is no longer maintained. Nym is developing a new client called [NymVPN](https://nymvpn.com), an application routing all users traffic thorugh the mixnet.
-If users want to route their traffic through socks5 we advice to use this client. If you want to run deprecated NymConnect, visit [NymConnect archive page](../../archive/nym-connect.md) with setup and application examples.
-```
-
-## Setup and Run
-
-### 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
-
-To initialise your `nym-socks5-client` you need to have an address of a Network Requester (NR). Nowadays NR is part of every Exit Gateway (`nym-node --mode exit-gateway`). The easiest way to get a NR address is to visit [harbourmaster.nymtech.net](https://harbourmaster.nymtech.net/) and scroll down to *SOCKS5 Network Requesters* table. There you can filter the NR by Gateways identity address, and other options.
-
-Use the following command to initialise `nym-socs5-client` where `<ID>` can be anything you want (it's only for local config file storage) and `<PROVIDER>` is suplemented with a NR address:
-
-```
-./nym-socks5-client init --id <ID> --provider <PROVIDER>
-```
-
-~~~admonish tip
-Another option to find a NR address associated with a Gateway is to query nodes [*Self Described* API endpoint](https://validator.nymtech.net/api/v1/gateways/described) where the NR address is noted like in this example:
-```sh
-"network_requester": {
-    "address": "CyuN49nkyeuiLohSpV5A1MbSqcugHLJQ95B5HooCpjv8.CguTh45Vp99QuGWZRBKpBjZDQbsJaHaXqAMGyc4Qhkzp@2w5RduXRqxKgHt1wtp4qGA4AfXaBj8TuUj1LvcPe2Ea1",
-    "uses_exit_policy": true
-}
-```
-~~~
-
-### Start your socks5 client
-Now your client is initialised, start it with the following:
-
-```
-./nym-socks5-client run --id <ID>
-```
@@ -1,33 +0,0 @@
-# Using Your Client 
-
-## Proxying traffic
-After completing the steps above, your local `nym-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.
-
-## Supported Applications
-
-Any application which can be redirected over Socks5 proxy should work. Nym community has been successfully running over Nym Mixnet these applications:
-
- Bitcoin Electrum wallet
- Monero wallet (GUI and CLI with monerod)
- Telegram chat
- Element/Matrix chat
- Firo wallet
- Blockstream Green
-
-> DarkFi's ircd chat was previously supported: they have moved to DarkIrc: whether the existing integration work is still operational needs to be tested. 
-
-Keep in mind that Nym has been developing a new client **[NymVPN](https://nymvpn.com) (GUI and CLI) routing all users traffic through the Mixnet.**
-
-## 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,22 +0,0 @@
-# Webassembly Client 
-
-The Nym webassembly client allows any webassembly-capable runtime to build and send Sphinx packets to the Nym network, for uses in edge computing and browser-based applications. 
-
-This is currently packaged and distributed for ease of use via the [Nym Typescript SDK library](../sdk/typescript.md). **We imagine most developers will use this client via the SDK for ease.**
-
-The webassembly client allows for the easy creation of Sphinx packets from within mobile apps and browser-based client-side apps (including Electron or similar). 
-
-## Building apps with Webassembly Client 
-
-Check out the [Typescript SDK docs](https://sdk.nymtech.net) for examples of usage. 
-
-There are also example applications located in the `clients/webassembly` directory in the main Nym platform codebase.
-
-## Think about what you're sending!
-```admonish caution 
-Think about what information your app sends. That goes for whatever you put into your Sphinx packet messages as well as what your app's environment may leak.
-```
-
-Whenever you write client PEAPPs using HTML/JavaScript, we recommend that you do not load external resources from CDNs. Webapp developers do this all the time, to save load time for common resources, or just for convenience. But when you're writing privacy apps it's better not to make these kinds of requests. Pack everything locally.
-
-If you use only local resources within your Electron app or your browser extensions, explicitly encoding request data in a Sphinx packet does protect you from the normal leakage that gets sent in a browser HTTP request. [There's a lot of stuff that leaks when you make an HTTP request from a browser window](https://panopticlick.eff.org/). Luckily, all that metadata and request leakage doesn't happen in Nym, because you're choosing very explicitly what to encode into Sphinx packets, instead of sending a whole browser environment by default.
@@ -1,13 +0,0 @@
-# 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.
-
-## Current version
-```
-<!-- cmdrun ../../../../target/release/nym-client --version | grep "Build Version" | cut -b 21-26  -->
-```
-
-You can run this client as a standalone process and pipe traffic into it to be sent through the mixnet. This is useful if you're building an application in a language other than Typescript or Rust and cannot utilise one of the SDKs. 
-
-You can find the code for this client [here](https://github.com/nymtech/nym/tree/develop/clients/native). 
-
@@ -1,33 +0,0 @@
-# HCPP23 - Building with Nym workshop 
-
-This is a *reference page*, to see the entire presentation join Max's talk at [HCPP 2023](https://resistance.hcpp.cz/) on [Satuday](https://cfp.paralelnipolis.cz/hcpp23/talk/LLPWXW/).
-
-## Mixnet architecture
-
-* [Mixnet motivations](https://nymtech.net/developers/infrastructure/nym.html)
-* [Mixnet architecture overview](https://nymtech.net/docs/architecture/network-overview.html)
-* [Mixnet traffic flow](https://nymtech.net/docs/architecture/traffic-flow.html) 
-* [Tor + VPN comparison](https://nymtech.net/developers/infrastructure/nym-vs-others.html)
-* [Addressing system](https://nymtech.net/docs/clients/addressing-system.html)
-
-## Clients 
-
-* [Clients overview](https://nymtech.net/docs/clients/overview.html)
-
-## SDKs
-
-* [Rust SDK](https://nymtech.net/docs/sdk/rust.html)
-* [Typescript SDK](https://sdk.nymtech.net/)
-
-### Rust examples
-
-* [Libp2p examples](https://github.com/nymtech/nym/tree/develop/sdk/rust/nym-sdk/examples)
-* [Lighthouse PoC](https://github.com/ChainSafe/lighthouse/blob/nym/USE_NYM.md)
-* [Dev tutoral: chain service](https://nymtech.net/developers/tutorials/cosmos-service/intro.html)
-* [Community: Darkfi over Nym](https://darkrenaissance.github.io/darkfi/clients/nym_outbound.html?highlight=nym#3--run)
-
-### Typescript 
-
-* [Mixfetch NPM](https://www.npmjs.com/package/@nymproject/mix-fetch)
-* [Interactive Typescript SDK docs](https://sdk.nymtech.net)
-
@@ -1,323 +0,0 @@
-# HCPP 2023 - Securing the Lunarpunks Workshop
-
-[Serinko's](https://resistance.hcpp.cz/) [workshop](ttps://cfp.paralelnipolis.cz/hcpp23/talk/LLPWXW/) will introduce ***why*** and ***how to use [Nym](https://nymtech.net) platform as a network protection*** layer when using some of our favorite privacy applications. This page serves as an accessible guide alongside the talk and it includes all the steps, pre-requisities and dependencies needed. Preferably the users interested in this setup start downloading and building the tools before the workshop or in the beginning of it. We can use the limited time for questions and addressing problems. This guide will stay online after the event just in case people were not finished and want to catch up later.  
-
-This page is a *how to guide* so it contains the setup only, to see the entire presentation join in at [HCPP 2023](https://resistance.hcpp.cz/) on [Sunday](https://cfp.paralelnipolis.cz/hcpp23/talk/LLPWXW/).
-
-## Preparation
-
-During this workshop we will introduce [NymConnect](https://nymtech.net/developers/quickstart/nymconnect-gui.html) and [Socks5 client](https://nymtech.net/docs/clients/socks5-client.html). The difference between them is that the Socks5 client does everything Nymconnect does, but it has more optionality and it's run from a commandline. NymConnect is a one-button GUI application that wraps around the `nym-socks5-client` for proxying application traffic through the Mixnet.  
-
-We will learn how to run through [Nym Mixnet](https://nymtech.net/docs/architecture/network-overview.html) the following applications: Electrum Bitcoin wallet, Monero wallet (desktop and CLI), Matrix (Element app) and ircd chat. For those who want to run ircd through the Mixnet, `nym-socks5-client` client is a must. For all other applications you can choose if you settle with our slick app NymConnect which does all the job in the background or you prefer Socks5 client.
-
-> Any syntax in `<>` brackets is a user's/version unique variable. Exchange with a corresponding name without the `<>` brackets.
-
-## NymConnect Installation
-
-NymConnect application is for everyone who does not want to install and run `nym-socks5-client`. NymConnect is plug-and-play, fast and easy use. Electrum Bitcoin wallet, Monero wallet (desktop and CLI) and Matrix (Element app) connects through NymConnect automatically to the Mixnet.
-
-1. [Download](https://nymtech.net/download/nymconnect) NymConnect
-2. On Linux and Mac, make executable by opening terminal in the same directory and run:
-
-```sh
-chmod +x ./nym-connect_<VERSION>.AppImage
-```
-
-3. Start the application
-4. Click on `Connect` button to initialise the connection with the Mixnet
-5. Anytime you'll need to setup Host and Port in your applications, click on `IP` and `Port` to copy the values to clipboard
-6. In case you have problems such as `Gateway Issues`, try to reconnect or restart the application
-
-## Connect Privacy Enhanced Applications (PEApps)
-
-For simplification in this guide we connect Electrum, Monero wallet and Matrix (Element) using NymConnect and ircd over `nym-socks5-client`. Of course if your choice is to run `nym-socks5-client` all these apps will connect through that and you don't need to install NymConnect.
-
-```admonish info
-This guide aims to connect your favourite applications to Nym Mixnet, therefore we do not include detailed guides on how to install them, only reference to the source pages.
-```
-
-### Electrum Bitcoin wallet via NymConnect
-
-To download Electrum visit the [official webpage](https://electrum.org/#download). To connect to the Mixnet follow these steps:
-
-1. Start and connect [NymConnect](./hcpp23-serinko.html#nymconnect-installation) (or [`nym-socks5-client`](./hcpp23-serinko.html#building-nym-platform))
-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)
-
-### Monero wallet via NymConnect
-
-To download Monero wallet visit [getmonero.org](https://www.getmonero.org/downloads/). To connect to the Mixnet follow these steps:
-
-1. Start and connect [NymConnect](./hcpp23-serinko.html#nymconnect-installation) (or [`nym-socks5-client`](./hcpp23-serinko.html#building-nym-platform))
-2. Start your Monero wallet
-3. Go to: *Settings* -> *Interface* -> *Socks5 proxy* -> Add values: IP address `127.0.0.1`, Port `1080` (the values copied from NymConnect)
-5. Now your Monero wallet runs through the Mixnet and it will be connected only if your NymConnect or `nym-socks5-client` are connected.
-
-![Monero wallet setup](../images/monero_tutorial/monero-gui-NC.gif)
-
-If you prefer to run Monero-CLI wallet with Monerod, please check out [this guide](https://nymtech.net/developers/tutorials/monero.html#how-can-i-use-monero-over-the-nym-mixnet).
-
-### Matrix (Element) via NymConnect
-
-To download Element (chat client for Matrix) visit [element.io](https://element.io/download). To connect to the Mixnet follow these steps:
-
-1. Start and connect [NymConnect](./hcpp23-serinko.html#nymconnect-installation) (or [`nym-socks5-client`](./hcpp23-serinko.html#building-nym-platform))
-2. Start `element-desktop` with `--proxy-server` argument:
-
-**Linux**
-
-```sh
-element-desktop --proxy-server=socks5://127.0.0.1:1080
-```
-
-**Mac**
-
-```sh
-open -a Element --args --proxy-server=socks5://127.0.0.1:1080
-```
-
-To setup your own alias or key-binding see our [*Matrix NymConnect Integration* guide](https://nymtech.net/developers/tutorials/matrix.html#optimise-setup-with-a-keybinding--alias).
-
-
-## Building Nym Platform
-
-If you prefer to run to run `nym-socks5-client` the possibility is to download the pre-build binary or build the entire platform. To run ircd through the Mixnet `nym-socks5-client` and `nym-network-requester` are mandatory. Before you start with download and installation, make sure you are on the same machine from which you will connect to ircd.
-
-We recommend to clone and build the entire platform instead of individual binaries as it offers an easier update and more options down the road, however it takes a basic command-line knowledge and more time. The [Nym platform](https://github.com/nymtech/nym) is written in Rust. For that to work we will need a few pre-requisities. If you prefer to download individual pre-build binaries, skip this part and go directly [that chapter](./hcpp23-serinko.html#pre-built-binaries). 
-
-### Prerequisites 
- Debian/Ubuntu: `pkg-config`, `build-essential`, `libssl-dev`, `curl`, `jq`, `git`
-
-```sh
-apt install pkg-config build-essential libssl-dev curl jq git
-```
-
- Arch/Manjaro: `base-devel`
-
-```sh
-pacman -S base-devel
-```
-
- Mac OS X: `pkg-config` , `brew`, `openss1`, `protobuf`, `curl`, `git`
-Running the following the script installs Homebrew and the above dependencies:
-
-```sh
-/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"
-```
-
- `Rust & cargo >= {{minimum_rust_version}}`
-
-We recommend using the [Rust shell script installer](https://www.rust-lang.org/tools/install). Installing cargo from your package manager (e.g. `apt`) is not recommended as the packaged versions are usually too old.
-
-If you really don't want to use the shell script installer, the [Rust installation docs](https://forge.rust-lang.org/infra/other-installation-methods.html) contain instructions for many platforms.
-
-### Download and Compile Nym
-
-The following commands will compile binaries into the `nym/target/release` directory:
-
-```sh
-rustup update
-git clone https://github.com/nymtech/nym.git
-cd nym
-git checkout master # master branch has the latest release version: `develop` will most likely be incompatible with deployed public networks
-cargo build --release # build your binaries with **mainnet** configuration
-```
-
-Quite a bit of stuff gets built. The key working parts for the workshop are:
-
-* [socks5 client](https://nymtech.net/docs/clients/socks5-client.html): `nym-socks5-client`
-* [network requester](https://nymtech.net/operators/nodes/network-requester-setup.html): `nym-network-requester`
-
-## Pre-built Binaries
-
-The [Github releases page](https://github.com/nymtech/nym/releases) has pre-built binaries which should work on Ubuntu 20.04 and other Debian-based systems, but at this stage cannot be guaranteed to work everywhere.
-
-**Download:** Find the binary of your choice, right click on the binary, select *Copy Link*. This will save the binary `<URL>` to clipboard. Run the following commands on your machine:
-
-```
-wget <URL> # to download the binary
-```
-
-If the pre-built binaries don't work or are unavailable for your system, you will need to [build the platform](./hcpp23-serinko.html#building-nym-platform) yourself.
-
-All Nym binaries must first be made executable. 
-
-To make a binary executable, open terminal in the same directory and run:
-
-```sh
-chmod +x ./<BINARY_NAME> 
-# for example: chmod +x ./nym-network-requester
-```
-
-## Initialize Socks5 Client and Network Requester
-
-Whether you build the entire platform or downloaded binaries, `nym-socks5-client` and `nym-network-requester` need to be initialised with `init` before being `run`.
-
-In your terminal navigate to the directory where you have your `nym-socks5-client` and `nym-network-requester`. In case you built the entire platform it's in `nym/target/release`.
-
-```sh
-# change directory from nym repo
-cd target/release
-```
-
-**Network Requester**
-
-The `init` command is usually where you pass flags specifying configuration arguments such as the gateway you wish to communicate with, the ports you wish your binary to listen on, etc. 
-
-The `init` command will also create the necessary keypairs and configuration files at `~/.nym/<BINARY_TYPE>/<BINARY_ID>/` if these files do not already exist. **It will NOT overwrite existing keypairs if they are present.** 
-
-To run [ircd](https://darkrenaissance.github.io/darkfi/clients/nym_outbound.html) through the Mixnet you need to run your own [Network Requester](https://nymtech.net/operators/nodes/network-requester-setup.html) and add known peer's domains/addresses to `~/.nym/service-providers/network-requester/<NETWORK-REQUESTER-ID>/data/allowed.list`. For all other applications `nym-socks5-client` (or NymCOnnect) is enough, no need to initialize and run `nym-network-requester`.
-
-Here are the steps to initialize `nym-network-requester`:
-
-```sh
-# open the directory with your binaries
-./nym-network-requester init --id <CHOOSE_ANY_NAME_AS_ID>
-```
-This will print you information about your client `<ADDRESS>`, it will look like:
-```sh
-The address of this client is: 8hUvtEyZK8umsdxxPS2BizQhEDmbNeXEPBZLgscE57Zh.5P2bWn6WybVL8QgoPEUHf6h2zXktmwrWaqaucEBZy7Vb@5vC8spDvw5VDQ8Zvd9fVvBhbUDv9jABR4cXzd4Kh5vz
-```
-
-**Socks5 Client**
-
-If you run `nym-socks5-client` instead of NymConnect, you can choose your `--provider` [here](https://explorer.nymtech.net/network-components/service-providers) or leave that flag empty and your client will chose one randomly. To run ircd, you will need to connect it to your `nym-network-requester` by using your `<ADDRESS>` for your `nym-socks5-client` initialisation and add a flag `--use-reply-surbs true`. Run the command in the next terminal window:
-
-```sh
-# to connect to your nym-network-requester as a provider for ircd
-./nym-socks5-client init --use-reply-surbs true --id <CHOSE_ANY_NAME_AS_ID> --provider <ADDRESS>
-
-# simple socks5 client init (random provider) for other apps
-./nym-socks5-client init --id <CHOSE_ANY_NAME_AS_ID>
-```
-
-```admonish info
-You can reconfigure your binaries at any time by editing the config file located at `~/.nym/service-providers/<BINARY_TYPE>/<BINARY_ID>/config/config.toml` and restarting the binary process. 
-```
-
-**Run Clients**
-
-Once you have run `init`, you can start your binary with the `run` command, accompanied by the `id` of the binary that you specified. 
-
-This `id` is **never** transmitted over the network, and is used to select which local config and key files to use for startup. 
-
-```sh
-# network requester
-./nym-network-requester run --id <ID>
-
-# socks5 client (in other terminal window)
-./nym-socks5-client run --id <ID>
-```
-
-**Troubleshooting**
-
-In case your `nym-socks5-client` has a problem to connect to your `nym-network-requester` try to setup a firewall by running these commands:
-
-```sh
-# check if you have ufw installed
-ufw version
-
-# if it is not installed, install with
-sudo apt install ufw -y
-
-# enable ufw
-sudo ufw enable
-
-# check the status of the firewall
-sudo ufw status
-
-# open firewall ports for network requester
-sudo ufw allow 22,9000/tcp
-
-# re-check the ufw status
-sudo ufw status
-```
-
-Restart your network requester.
-
-
-## ircd
-
-[Dark.fi](htps://dark.fi) built a fully anonymous and p2p instance of IRC chat called [ircd](https://darkrenaissance.github.io/darkfi/misc/ircd/ircd.html). The team is just finishing their new instance of the program darkirc which we hope to see in production soon.
-
-```admonish info
-It is highly recomended to install [dark.fi architecture](https://github.com/darkrenaissance/darkfi) prior to the workshop following the [documentation](https://darkrenaissance.github.io/darkfi/misc/ircd/ircd.html) so we have enough time for the network configuration.
-```
-
-### Configuration
-
-Make sure to have [ircd installed](https://darkrenaissance.github.io/darkfi/misc/ircd/ircd.html) on the same machine like your `nym-socks5-client` (`nym-network-requester` can run anywhere). 
-
-Currently `nym-network-requester` automatically connnects only to the [whitelisted URLs](https://nymtech.net/.wellknown/network-requester/standard-allowed-list.txt). This will [change soon](https://nymtech.net/operators/faq/smoosh-faq.html) into a more opened setup. This list can be changed by an operator running a node. 
-
-**Edit allowed.list**
-
-1. Open a text editor and add:
-```yaml
-dasman.xyz
-```
-2. Save it as `allowed.list` in `~/.nym/service-providers/network-requester/<NETWORK-REQUESTER-ID>/data/`
-3. Restart your `nym-network-requester`
-```sh
-./nym-network-requester run --id <ID>
-```
-4. Make sure both `nym-socks5-client` and `nym-network-requester` are running and connected
-
-**ircd setup**
-
-In case your ircd has problems to start or connect, run the following:
-
-```sh
-# cd to darkfi repo
-git pull
-git checkout c4b78ead5111b0423fca3bd53cb7185acd6f0faa
-
-# compile ircd
-make ircd
-
-# in case of dependency error: "failed to load source for dependency `halo2_gadgets`"
-rm Cargo.lock
-make ircd
-
-# remove the config file (rename it if you want to safe any values first)
-rm ~/.config/darkfi/ircd_config.toml
-
-# rerun ircd to generate new config file
-./ircd
-
-# add your custom values from the old config file
-```
-
-5. Open `~/.config/darkfi/ircd_config.toml`
-6. Coment the line with `seeds`
-7. Add line:
-```yaml
-peers = ["nym://dasman.xyz:25552"]
-```
-8. Change `outbond_transports` to:
-```yaml
-outbond_transports = ["nym"]
-```
-9. Make sure that
-```yaml
-outbound_connections = 0
-```
-10. Save and restart `ircd`
-
-Observe the ircd deamon to see that the communication is running through the mixnet.
-
-## Bonus: Join hcpp23 channel
-
-Now, when your Darkfi's ircd runs through Nym Mixnet, you can join public and fully anonymous channel `#hcpp23`. To do so, follow one of the two possibilities:
-
-1. Run a command in your weechat:
-```sh
-/join #hcpp23
-```
-2. Open `~/.config/darkfi/ircd_config.toml` and add `"#hcpp23"` to the `autojoin = []` brackets, save and restart ircd.
-
-
@@ -1,38 +0,0 @@
-# Web3 Privacy Now - Nym for Ethereum validator privacy
-
-Serinko's presentation on [Web3Privacy Now: Community 1st](https://lu.ma/web3privacynow_rome) introduces ***why network privacy matters*** for ETH 2.0 validators' security and decentralisation. 
-
-This page serves as an accessible list of references mentioned during the talk.
-
-## References
-
-### Mixnet architecture
-
-* [Mixnet motivations](https://nymtech.net/developers/infrastructure/nym.html)
-* [Mixnet architecture overview](https://nymtech.net/docs/architecture/network-overview.html)
-* [Mixnet traffic flow](https://nymtech.net/docs/architecture/traffic-flow.html) 
-* [Tor + VPN comparison](https://nymtech.net/developers/infrastructure/nym-vs-others.html)
-* [Addressing system](https://nymtech.net/docs/clients/addressing-system.html)
-
-### Nym \<\> ETH 2.0
-
-* [Chainsafe Rust libp2p Nym intergration repo](https://github.com/ChainSafe/rust-libp2p-nym)
-* [rust-libp2p-nym Transport Specification](https://hackmd.io/@nZ-twauPRISEa6G9zg3XRw/HkE8sHuns)
-* [Lighthouse PoC](https://github.com/ChainSafe/lighthouse/blob/nym/USE_NYM.md)
-* [Nym \<\> Aztec partnership](https://blog.nymtech.net/nym-partners-with-aztec-to-provide-integral-infrastructure-privacy-in-ethereum-chains-694963c55192)
-
-### Rust Examples
-
-* [Dev tutorial: chain service](https://nymtech.net/developers/tutorials/cosmos-service/intro.html)
-
-### Clients
-
-* [Clients overview](https://nymtech.net/docs/clients/overview.html)
-
-### Nym Docs
-
-* [Nym Developer Portal](https://nymtech.net/developers)
-* [Nym Operators Guide](https://nymtech.net/operators)
-* [Nym technical Documentation](https://nymtech.net/docs)
-
-
@@ -1,13 +0,0 @@
-# Browser only
-With the Typescript SDK you can run a Nym client in a webworker - meaning you can connect to the mixnet through the browser without having to worry about any other code than your web framework.
-
- Oreowallet have integrated `mixFetch` into their browser-extension wallet to run transactions through the mixnet.
-  - [Codebase](https://github.com/oreoslabs/oreowallet-extension/tree/mixFetch)
-
- [NoTrustVerify](https://notrustverify.ch/) have set up an example application using [`mixFetch`](https://sdk.nymtech.net/examples/mix-fetch) to fetch crypto prices from CoinGecko over the mixnet.
-  - [Website](https://notrustverify.github.io/mixfetch-examples/)
-  - [Codebase](https://github.com/notrustverify/mixfetch-examples)
-
- 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).
-
- 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,21 +0,0 @@
-# Custom Services 
-Custom services involve two pieces of code that communicate via the mixnet: a client, and a custom server/service. This custom service will most likely interact with the wider internet / a clearnet service on your behalf, with the mixnet between you and the service, acting as a privacy shield. 
-
-> The current model of relying on a Service Provider has some issues, such as additional complexity in deployment and maintenance, as well as creating potential chokepoints for app traffic. Work is going on (in the open in our [monorepo](https://github.com/nymtech/nym) ofc) to start removing this requirement as much as possible, by allowing for the creation of packet-contents in such a way that the existing Network Requester/Exit Gateway infrastructure can support network requests in a similar way to `mixFetch`. More on this as and when it is released. 
-
- [Nym Zcash RPC demo](https://github.com/nymtech/nym-zcash-rpc-demo), although used to only pipe RPC traffic, is a proof of concept 'generic' mixnet piping example which exposes a TPC Socket on the client side for incoming traffic, pipes this through the mixnet, and then streams TCP packets 'out' the other side. A good example of non-app-specific traffic transport which developers could also quite easily use as a template for their own app-specific work. 
-  - [Codebase](https://github.com/nymtech/nym-zcash-rpc-demo)
-
- PasteNym is a private pastebin alternative. It involves a browser-based frontend utilising the Typescript SDK and a Python-based backend service communicating with a standalone Nym Websocket Client. **If you're a Python developer, start here!**.
-  - [Frontend codebase](https://github.com/notrustverify/pastenym)
-  - [Backend codebase](https://github.com/notrustverify/pastenym-frontend) 
-  
- Nostr-Nym is another application written by [NoTrustVerify](https://notrustverify.ch/), standing between mixnet users and a Nostr server in order to protect their metadata from being revealed when gossiping. **Useful for Go and Python developers**.  
-  - [Codebase](https://github.com/notrustverify/nostr-nym)
-  
- Spook and Nym-Ethtx are both examples of Ethereum transaction broadcasters utilising the mixnet, written in Rust. Since they were written before the release of the Rust SDK, they utilise standalone clients to communicate with the mixnet. 
-  - [Spook](https://github.com/EdenBlockVC/spook) (**Typescript**)
-  - [Nym-Ethtx](https://github.com/noot/nym-ethtx) (**Rust**)
-  
- NymDrive is an early proof of concept application for privacy-enhanced file storage on IPFS. **JS and CSS**, and a good example of packaging as an Electrum app.  
-  - [Codebase](https://github.com/saleel/nymdrive)
@@ -1,5 +0,0 @@
-# Monorepo examples
-As well as these examples, there are a bunch of examples for each SDK in the Nym monorepo. 
-
- [Rust SDK examples](https://github.com/nymtech/nym/tree/develop/sdk/rust/nym-sdk/examples)
- [Typescript SDK examples](https://github.com/nymtech/nym/tree/develop/sdk/typescript/examples)
--- a/Show More
+++ b/Show More
Author	SHA1	Message	Date
mfahampshire	3baa5ab49d	Merge branch 'serinko/new-operators/command-outputs' of github.com:nymtech/nym into serinko/new-operators/command-outputs	2024-10-24 12:10:48 +02:00
mfahampshire	57155951f8	merge conflict fixed	2024-10-24 12:09:00 +02:00
serinko	bd00ccafdf	address review comments	2024-10-24 11:35:26 +02:00
serinko	6f4fc03bcd	PR ready to go	2024-10-23 23:06:45 +02:00
serinko	629702b3d1	finish accordion	2024-10-23 23:06:34 +02:00
serinko	99090b5a87	more accordions beautifications	2024-10-23 21:24:24 +02:00
serinko	eac2e8fda0	finish all command outputs	2024-10-23 20:13:56 +02:00
serinko	8079533579	add node_api_check outputs	2024-10-23 19:21:46 +02:00
serinko	7e9a931ce2	add changbelog page	2024-10-23 18:05:18 +02:00
mfahampshire	1dc8698c4a	updated messages paradigm with the standalone proxies	2024-10-23 17:43:44 +02:00
mfahampshire	44adf05f9f	auto commit generated command files	2024-10-23 16:58:44 +02:00
mfahampshire	7bfd7efe84	auto commit generated command files	2024-10-23 16:53:29 +02:00
mfahampshire	4302724e9f	remove old docs dirs	2024-10-23 16:29:56 +02:00
serinko	dca69a65ae	initialise changelog page	2024-10-23 14:46:40 +02:00
serinko	e7de645623	add accordion component	2024-10-23 14:28:18 +02:00
serinko	2ae2025f14	auto commit generated command files	2024-10-23 13:44:44 +02:00
serinko	a0f6c3721e	auto commit generated command files	2024-10-23 13:36:38 +02:00
serinko	ec07405dcd	auto commit generated command files	2024-10-23 13:34:26 +02:00
serinko	c38d2f284d	auto commit generated command files	2024-10-23 13:32:13 +02:00
serinko	d87dcb25ba	update after latest prebuild	2024-10-23 13:03:56 +02:00
serinko	c6c9df970c	Merge branch 'max/new-docs-framework' into serinko/new-operators/command-outputs - to sync updated autodocs.sh script	2024-10-23 12:57:44 +02:00
serinko	de8e4703d0	add custom scripts, create prebuild to import data to pages	2024-10-23 12:55:22 +02:00
mx	eda666476f	Max/individual command autodocs (#5018 ) * updated autodoc script * updated autodoc script for fix + reintroduced gitignore file for generated markdown * auto commit generated command files * auto commit generated command files * added command-outputs to autodoc script * fix merge conflicts * repush components	2024-10-23 08:55:42 +00:00
mx	276d4318be	Max/individual command autodocs (#5015 ) * auto commit generated command files * added to autodoc.sh: build all binaries before running * autodoc move individual command outputs to components	2024-10-22 19:22:05 +00:00
mfahampshire	e0edcd8e57	update todo	2024-10-21 21:42:08 +02:00
mfahampshire	0728b3094a	tweaks to clients and reintroduced old examples page	2024-10-21 21:41:56 +02:00
mfahampshire	bc1b198d1d	finalised rewrites	2024-10-21 21:41:32 +02:00
mfahampshire	a4afe99723	updated footer	2024-10-21 21:41:23 +02:00
mfahampshire	00cfeb4f4a	update footer	2024-10-21 19:27:25 +02:00
mfahampshire	3967a747c1	Merge branch 'max/new-docs-framework' of github.com:nymtech/nym into max/new-docs-framework	2024-10-21 18:17:34 +02:00
mfahampshire	f261df2202	added todo comments for old ts sdk redirects	2024-10-21 18:17:08 +02:00
import this	d93e405905	[new-docs/operators] : Fix callout syntax (#5006 ) * fix callout syntax from color to type * correct callout from danger to warning	2024-10-21 14:27:33 +00:00
import this	2a03f2ded9	[new/docs/operators]: Create archive section - PR ready to merge (#5004 )	2024-10-21 13:04:07 +00:00
mfahampshire	07581b6898	pick yana's edits: remove specified callout theming	2024-10-21 11:45:02 +02:00
mfahampshire	04d09fba7b	operator redirects	2024-10-18 17:17:36 +02:00
mfahampshire	3f4361cb8a	minor themeing	2024-10-18 16:24:43 +02:00
mx	b4157a67a2	links (#4990 ) * links * removed todos * updated todo list	2024-10-18 13:36:14 +00:00
mfahampshire	33deb09da8	rename overview to more descriptive	2024-10-18 15:08:40 +02:00
mfahampshire	5bb59466ab	Merge branch 'max/new-docs-framework' of github.com:nymtech/nym into max/new-docs-framework	2024-10-18 15:06:56 +02:00
mfahampshire	da1d7874bb	also moved matrix images to correct place	2024-10-18 15:06:41 +02:00
mx	9e692bfba4	Max/fix links new docs framework (#4989 ) * tweak client links * standardise images in public/ * old images move to public/archive	2024-10-18 13:05:48 +00:00
mfahampshire	38bc98ecc1	tweak client links	2024-10-18 14:05:43 +02:00
import this	937be101d2	[DOCs]: Operators rework to next.js (#4930 ) * initialise operators guides v2 * new introduction page * add variables csv and page * add baseurl to allow short path * add sandbox page * added building from source page * add binary pages * add preliminary steps * clean preliminary steps dir * syntax edit * syntax edit * add configuration page * create new proxy configuration page * create new proxy configuration page * create bonding.mdx page * correct images path * syntax edit * add new validator setup page * add api setup page * add nyx configuration page * add nym node and maintenance pages * finish maintenance and add nymvisor conf page * add manual upgrade page * add nymvisor upgrade page * add performance testing page and dir * add node api check page * add explore nym scripts page * add testing pages * fix menu issue by moving snippets to coomponents * add all troubleshooting pages * add general faq page * add nym node faq page * add nyx faq page * revamp legal forum to community counsel and add all pages * rewire relative paths to new structure * simplify setup and remove lock file * syntax fix * rm package.json * re add package.json, rm package-lock.json * removed old books from commit * address review comments --------- Co-authored-by: mfahampshire <maxhampshire@pm.me> Co-authored-by: mx <33262279+mfahampshire@users.noreply.github.com>	2024-10-18 11:58:48 +00:00
mfahampshire	b514b0a747	updated todo list	2024-10-18 13:49:54 +02:00
mfahampshire	0d4979a2f1	changed theme of mermaid diagram to match everything else	2024-10-18 13:49:41 +02:00
mfahampshire	f15a1d4a9a	tweaked landing page component	2024-10-16 20:15:53 +02:00
Yana	7527deab1e	cherry pick yana landingpage	2024-10-16 19:34:57 +02:00
mfahampshire	b8eeaa9211	brought in archive + done rewrites for devportal	2024-10-16 19:18:56 +02:00
mfahampshire	a6be529103	new pages + rest of redirects for old docs/	2024-10-16 17:47:01 +02:00
mfahampshire	04fc39a544	tweaking	2024-10-16 17:24:32 +02:00
mfahampshire	6082e817b7	docs redirects first pass	2024-10-16 17:23:07 +02:00
mfahampshire	5fd0ab9325	changed erroneous note	2024-10-16 15:47:33 +02:00
mfahampshire	8ebfa810fa	some more themeing	2024-10-15 22:13:51 +02:00
mfahampshire	5b3f986602	update theme: width of page and padding	2024-10-15 21:56:40 +02:00
mfahampshire	8c2255bc9c	update readme	2024-10-15 21:56:25 +02:00
mfahampshire	f5c262dd7c	cherry pick yana commits + some extra config in theme	2024-10-15 19:06:30 +02:00
mfahampshire	e5b10b3995	removed backups of root meta.json	2024-10-15 17:25:56 +02:00
mfahampshire	434518ca43	update readme	2024-10-15 16:51:50 +02:00
mfahampshire	1ff7969fed	update readme	2024-10-15 16:45:10 +02:00
mfahampshire	d43d01ee75	removed mdbook related scripts	2024-10-15 16:42:21 +02:00
mfahampshire	94ed32d493	make subcommand headers smaller	2024-10-15 16:23:46 +02:00
mfahampshire	c4f5642c52	updated readme	2024-10-15 16:23:17 +02:00
mfahampshire	de2dca7017	auto commit generated command files	2024-10-15 16:12:04 +02:00
mfahampshire	63f86f088c	updated autodoc for committing changing else exit	2024-10-15 15:50:34 +02:00
mfahampshire	a8f36f89ab	add link to autodoc generated files	2024-10-15 15:49:40 +02:00
mfahampshire	2e0fa87129	auto commit generated command files	2024-10-15 15:49:02 +02:00
mfahampshire	4f45ff6690	temp	2024-10-15 15:23:51 +02:00
mfahampshire	54f3ded4e1	updated autogenerated docs	2024-10-15 13:50:13 +02:00
mfahampshire	eeadec80fe	made code blocks sh	2024-10-15 13:49:51 +02:00
mfahampshire	c86f0a18cc	make script own command instead of prebuild	2024-10-15 13:44:30 +02:00
mfahampshire	3e233b776e	prebuild and predev script for autodoc commands	2024-10-15 13:28:46 +02:00
mfahampshire	9d0dddb024	remove tools dir moved to wrong palce	2024-10-15 13:11:03 +02:00
mfahampshire	fc52c64ea7	recreated tools dir	2024-10-15 13:00:25 +02:00
mfahampshire	0f7ac8e694	remove test component	2024-10-15 12:59:59 +02:00
mfahampshire	d4d0b71341	update deps	2024-10-15 12:59:36 +02:00
mfahampshire	c47dbf2e11	hardcoded import version for the moment	2024-10-15 11:25:03 +02:00
mfahampshire	8ccd0d70e1	fixed link	2024-10-11 16:47:10 +02:00
mfahampshire	271000b0a5	replaced old diagram with mermaid	2024-10-11 16:47:02 +02:00
mfahampshire	eb214a164e	tweaks	2024-10-11 15:39:04 +02:00
mfahampshire	e0e88d2b80	added note for standalone: can be accessed via sdk	2024-10-11 13:27:07 +02:00
mfahampshire	f7d3599b58	change order in list	2024-10-11 12:51:22 +02:00
mfahampshire	b55ad654f9	diagrams	2024-10-11 12:49:36 +02:00
mfahampshire	55edf9246a	new sock5 diagram, minor client docs tweaks	2024-10-11 10:53:45 +02:00
mfahampshire	fe47b76354	remove diagram title	2024-10-10 20:38:42 +02:00
mfahampshire	efb9dd4e55	small correction re tcpproxy ffi	2024-10-10 20:35:46 +02:00
mfahampshire	a2ca65447b	diagram + concepts overview	2024-10-10 16:51:39 +02:00
mfahampshire	d7ecdf71ba	remove forced dark mode	2024-10-10 16:50:34 +02:00
mfahampshire	b30465cbae	removed todo	2024-10-10 15:24:56 +02:00
mfahampshire	1e58de0e93	added links for codecs + full flow diagram	2024-10-10 14:31:56 +02:00
mfahampshire	68b4d93f94	add mermaid flow diagram	2024-10-10 14:17:32 +02:00
mfahampshire	6219114ac2	redo acks diagram as mermaid	2024-10-10 14:17:21 +02:00
mfahampshire	6d927c6295	final linkchecks	2024-10-09 23:11:45 +02:00
mfahampshire	159314d325	ts sdk links	2024-10-09 22:55:58 +02:00
mfahampshire	cc74172e7a	rust sdk links	2024-10-09 22:40:31 +02:00
mfahampshire	1eb6fd8e2a	added echo server to tools	2024-10-09 22:28:12 +02:00
mfahampshire	c9b570b48e	chain registry	2024-10-09 22:27:59 +02:00
mfahampshire	a996fbe54d	more links	2024-10-09 22:12:46 +02:00
mfahampshire	ceb8322185	links	2024-10-09 22:09:36 +02:00
mfahampshire	b45d45f917	new chain info, left todo links in	2024-10-09 20:22:21 +02:00
mfahampshire	13e8a9fca7	first pass new ws client	2024-10-09 20:15:18 +02:00
mfahampshire	ebb9b37786	moved cli wallet out of tools	2024-10-09 20:04:51 +02:00
mfahampshire	9e29b71ff5	chain first pass	2024-10-09 20:04:30 +02:00
mfahampshire	32684ab456	started on client redo	2024-10-09 20:04:18 +02:00
mfahampshire	8e31cea97d	moved images/ to correct place	2024-10-09 20:04:02 +02:00
mfahampshire	02a18fdb43	commit before moving image dir	2024-10-09 19:13:45 +02:00
mfahampshire	5551612c8b	first pass tcpproxy	2024-10-09 19:02:16 +02:00
mfahampshire	2919d4cee5	updated faq	2024-10-09 18:45:49 +02:00
mfahampshire	000986eadc	tweaks to ffi	2024-10-09 18:42:10 +02:00
mfahampshire	8ec308567c	stripped unnecessary stuff from TS	2024-10-09 18:41:59 +02:00
mfahampshire	9dcebf69c3	added testnet example + note to custom topology example overview	2024-10-09 16:47:46 +02:00
mfahampshire	aac1682414	tweaks	2024-10-09 16:35:23 +02:00
mfahampshire	50a5f8311c	first pass ffi	2024-10-09 16:35:12 +02:00
mfahampshire	fac373c1db	first pass @ rest of rust sdk doc	2024-10-09 14:59:40 +02:00
mfahampshire	54282fa098	finished ffi overview page	2024-10-09 14:59:22 +02:00
mfahampshire	08f856bb5a	added no scroll to inline code	2024-10-09 14:59:05 +02:00
mfahampshire	f28f11ff5d	reorg + added FFI table	2024-10-09 14:27:06 +02:00
mfahampshire	025573b1fc	start reorg of rust sdk docs	2024-10-09 11:30:50 +02:00
mfahampshire	3c307ec2d3	first pass concepts done	2024-10-09 11:30:38 +02:00
mfahampshire	66b1927ace	add credential stub	2024-10-09 11:30:19 +02:00
mfahampshire	1e7a3d7aca	typo fix	2024-10-08 20:22:39 +02:00
mfahampshire	6ff608aafb	crypto overview page	2024-10-08 17:24:32 +02:00
mfahampshire	dca54b62d0	updated arch	2024-10-08 17:24:24 +02:00
mfahampshire	a6acffc400	added to concepts in dev portal	2024-10-08 17:24:10 +02:00
mfahampshire	f6fa071d9d	more for networking pages	2024-10-08 14:56:46 +02:00
mfahampshire	67920ab1bc	stub	2024-10-05 12:52:02 +02:00
mfahampshire	ddadd3c2e9	concepts overview for devporta	2024-09-30 18:13:43 +02:00
mfahampshire	bd31db24b5	integration overview work + tools	2024-09-30 13:26:35 +02:00
mfahampshire	ca470ab757	sidebar autocollapse	2024-09-30 12:13:03 +02:00
mfahampshire	561147573b	add echo serv to tools	2024-09-27 18:31:15 +02:00
mfahampshire	314336a386	rework intro	2024-09-27 18:29:32 +02:00
mfahampshire	92efad3116	initial pass at new clients overview for developers	2024-09-27 18:23:29 +02:00
mfahampshire	1907170e92	move sdks to developers	2024-09-27 18:10:23 +02:00
mfahampshire	044c537a88	updated todo list	2024-09-27 17:51:42 +02:00
mfahampshire	7b1a05acda	added ffi stub files	2024-09-27 17:51:34 +02:00
mfahampshire	8c7e9501e4	todo for the tldr overview	2024-09-27 17:51:13 +02:00
mfahampshire	c85be2b99b	pass @ integration page	2024-09-27 17:50:57 +02:00
mfahampshire	2a4fdc83c4	started moving integrations docs over from ts sdk	2024-09-26 19:53:50 +02:00
mfahampshire	3445ec88a7	smart contracts done	2024-09-26 18:58:43 +02:00
mfahampshire	c0fd0b7b47	note on where to find deployed info	2024-09-26 18:20:16 +02:00
mfahampshire	fbe4931745	added zknym docs	2024-09-26 18:17:18 +02:00
mfahampshire	430928d75a	added zknym docs	2024-09-26 18:17:12 +02:00
mfahampshire	4fa3bd4b72	updating nyx section	2024-09-26 18:16:57 +02:00
mfahampshire	393bbc188e	update todo list	2024-09-26 14:28:41 +02:00
mfahampshire	66637be98e	add links + tweaks	2024-09-26 14:28:01 +02:00
mfahampshire	a6045b7956	overhaul arch	2024-09-26 14:27:40 +02:00
mfahampshire	93157f5308	overhaul arch	2024-09-26 14:27:30 +02:00
mfahampshire	24d714c642	hid root index	2024-09-26 14:27:19 +02:00
mfahampshire	6ac2d8939d	misc	2024-09-25 18:57:50 +02:00
mfahampshire	e58c53dd1a	traffic 2nd pass	2024-09-25 18:57:37 +02:00
mfahampshire	1b1373fb2f	structure change	2024-09-25 18:57:22 +02:00
mfahampshire	fa0a681529	stub for not p2p	2024-09-25 18:57:09 +02:00
mfahampshire	5ae9510933	crypto first proper pass, sphinx	2024-09-25 18:56:50 +02:00
mfahampshire	927558be73	concepts 2nd pass	2024-09-25 18:56:34 +02:00
mfahampshire	28c3e3bb6e	note to client	2024-09-25 15:44:16 +02:00
mfahampshire	b485085a55	removed old reference to archive	2024-09-25 15:39:41 +02:00
mfahampshire	0e6b505d50	moved some chain files to the dev portal stubs	2024-09-25 15:38:26 +02:00
mfahampshire	e0cdb5978f	more network docs	2024-09-25 15:37:50 +02:00
mfahampshire	ae69ecea54	first pass traffic	2024-09-25 15:37:29 +02:00
mfahampshire	3bf7ff0870	first pass concepts	2024-09-25 15:37:02 +02:00
mfahampshire	87bc27daa1	first pass new arch	2024-09-25 15:36:33 +02:00
mfahampshire	cf8910bb72	tweak overview	2024-09-25 11:56:35 +02:00
mfahampshire	d00fd92d9a	mixnet node overview	2024-09-25 11:55:56 +02:00
mfahampshire	21d5ecd4b4	tweak to overview	2024-09-24 16:35:23 +02:00
mfahampshire	505ba9c83d	new list	2024-09-24 14:16:18 +02:00
mfahampshire	c55499df37	add new bits to todo list	2024-09-20 15:58:10 +02:00
mfahampshire	cdc8840868	added arch and concepts stubs	2024-09-05 16:04:42 +02:00
mfahampshire	1e17041d8a	rework of structure of developers	2024-09-05 16:04:11 +02:00
mfahampshire	d46c51a966	quick first sketch of landing page	2024-09-05 16:03:46 +02:00
mx	2f4e74d180	Update rework_todo.md	2024-08-28 14:13:09 +00:00
mx	09feaf4fe1	new autodoc version (#4781 )	2024-08-28 10:31:17 +00:00
mfahampshire	032e990c37	updated todo list	2024-08-28 12:29:50 +02:00
mfahampshire	4d7262e051	moving around new docs - think this is the final dir structure	2024-08-28 12:29:42 +02:00
mfahampshire	2a2ecab852	moved old docs -> old_docs dir for clarity when devving	2024-08-28 12:29:01 +02:00
mfahampshire	f7c39397b3	add licensing	2024-08-27 18:10:48 +02:00
mfahampshire	2c47c932e8	structure	2024-08-27 18:01:42 +02:00
mfahampshire	21acab9857	first pass network structure	2024-08-27 18:01:33 +02:00
mfahampshire	e18dd80b36	first pass developers structure	2024-08-27 18:01:21 +02:00
mfahampshire	712fa519e9	sdk in its own dir	2024-08-27 18:01:08 +02:00
mfahampshire	cf2afc6adf	gen updates	2024-08-27 18:00:52 +02:00
mfahampshire	8318c7ff61	first pass @ operator docs	2024-08-27 18:00:36 +02:00
mfahampshire	e36d4f105d	consolidating images folders in one place	2024-08-27 17:59:59 +02:00
mfahampshire	14f659337c	updated todo list	2024-08-26 17:15:13 +02:00
mfahampshire	cc2d4c3376	small shift typescript org	2024-08-26 17:15:01 +02:00
mfahampshire	d8c3a3f738	first pass rust sdk	2024-08-26 17:14:41 +02:00
mfahampshire	7d561bff63	modified code component filepaths	2024-08-26 13:15:39 +02:00
mfahampshire	9daa2f6e98	rearranged code example dir structure	2024-08-26 13:15:10 +02:00
mfahampshire	74c3dbe169	started new docs draft	2024-08-26 11:53:21 +02:00
mfahampshire	8c4f2fde78	remove ts docs from ts sdk dir	2024-08-26 11:53:10 +02:00
mfahampshire	e5efba2d45	startd long todo list	2024-08-26 11:52:26 +02:00
mfahampshire	02bfa9a7ab	startd long todo list	2024-08-26 11:51:07 +02:00
mfahampshire	cea6ac1d3e	started todo list for rework	2024-08-23 15:55:16 +02:00
Drazen Urch	1ac262ec90	New Network Monitor (#4610 ) * Initial commit * Cherry pick from develop * Keep track of fragments * A bunch of data formats, graphs * Use mix_id for display * Proper API routes * Add openapi + swagger ui * Update locustfile * Add node stats endpoint * Add Swagger and locust to readme * All node stats endpoint * Update dependencies to use workspace * Bunch of pedantic fixes * More version updates, fmt * More lints * Add new_from_env for NymTopology * Nym API endpoint to submit monitoring results (#4616) * Nym API endpoint to submit monitoring results * Add gateway monitoring results * Cleanup, ergonomics * Weaponize * Finalize results submissions * Monitor message signing and verification * Update README * Axum graceful shutdown * More grtacefulness * Restructure result submission * Less fragile routes * Remove gateway unique index on node_id	2024-08-22 11:29:36 +02:00
Bogdan-Ștefan Neacşu	7c1fca8ce4	Persist used wireguard private IPs (#4771 ) * Persist used wireguard private IPs * Fix imports * Remove unnecessary type specification	2024-08-21 11:26:14 +02:00