From 72a4a26c40ef8752159db4ceee55ddc851c026ed Mon Sep 17 00:00:00 2001 From: import this <97586125+serinko@users.noreply.github.com> Date: Mon, 6 Jan 2025 12:46:16 +0000 Subject: [PATCH] [DOCs/operators]: smooth operators (#5311) * smooth minimum expectation * simplify simplify * quick fix * feedback edits * feedback edits * feedback edits --- .../components/operators/snippets/nym-node-specs.mdx | 2 +- .../nyx-outputs/circulating-supply.md | 2 +- .../nyx-outputs/stake-saturation.md | 2 +- .../api-scraping-outputs/nyx-outputs/staking-target.md | 2 +- .../api-scraping-outputs/nyx-outputs/token-table.md | 6 +++--- .../outputs/api-scraping-outputs/time-now.md | 2 +- documentation/docs/pages/operators/introduction.mdx | 10 +++++----- documentation/docs/pages/operators/nodes.mdx | 10 +++++++--- 8 files changed, 20 insertions(+), 16 deletions(-) diff --git a/documentation/docs/components/operators/snippets/nym-node-specs.mdx b/documentation/docs/components/operators/snippets/nym-node-specs.mdx index d6b12aa149..cc94aa933d 100644 --- a/documentation/docs/components/operators/snippets/nym-node-specs.mdx +++ b/documentation/docs/components/operators/snippets/nym-node-specs.mdx @@ -18,7 +18,7 @@ Tor community created a very helpful table called [*Good Bad ISPs*](https://comm #### `nym-node` Before we conclude the testing with exact results, these are the rough specs: -| **Hardware** | **Minimum Specification** w +| **Hardware** | **Minimum Specification** | | :--- | ---: | | CPU Cores | 4 | | Memory | 8 GB RAM | diff --git a/documentation/docs/components/outputs/api-scraping-outputs/nyx-outputs/circulating-supply.md b/documentation/docs/components/outputs/api-scraping-outputs/nyx-outputs/circulating-supply.md index 7f5aad7cd4..da25d07f03 100644 --- a/documentation/docs/components/outputs/api-scraping-outputs/nyx-outputs/circulating-supply.md +++ b/documentation/docs/components/outputs/api-scraping-outputs/nyx-outputs/circulating-supply.md @@ -1 +1 @@ -804_560_131 +805_903_308 diff --git a/documentation/docs/components/outputs/api-scraping-outputs/nyx-outputs/stake-saturation.md b/documentation/docs/components/outputs/api-scraping-outputs/nyx-outputs/stake-saturation.md index b2ed9e28ef..c3c2b23ae3 100644 --- a/documentation/docs/components/outputs/api-scraping-outputs/nyx-outputs/stake-saturation.md +++ b/documentation/docs/components/outputs/api-scraping-outputs/nyx-outputs/stake-saturation.md @@ -1 +1 @@ -1_020_023 +1_022_821 diff --git a/documentation/docs/components/outputs/api-scraping-outputs/nyx-outputs/staking-target.md b/documentation/docs/components/outputs/api-scraping-outputs/nyx-outputs/staking-target.md index 49bf2c6564..f12437bbae 100644 --- a/documentation/docs/components/outputs/api-scraping-outputs/nyx-outputs/staking-target.md +++ b/documentation/docs/components/outputs/api-scraping-outputs/nyx-outputs/staking-target.md @@ -1 +1 @@ -402_280_065 +402_951_654 diff --git a/documentation/docs/components/outputs/api-scraping-outputs/nyx-outputs/token-table.md b/documentation/docs/components/outputs/api-scraping-outputs/nyx-outputs/token-table.md index 413c6d0177..dc74f6501d 100644 --- a/documentation/docs/components/outputs/api-scraping-outputs/nyx-outputs/token-table.md +++ b/documentation/docs/components/outputs/api-scraping-outputs/nyx-outputs/token-table.md @@ -1,7 +1,7 @@ | **Item** | **Description** | **Amount in NYM** | |:-------------------|:------------------------------------------------------|--------------------:| | Total Supply | Maximum amount of NYM token in existence | 1_000_000_000 | -| Mixmining Reserve | Tokens releasing for operators rewards | 195_439_368 | +| Mixmining Reserve | Tokens releasing for operators rewards | 194_096_191 | | Vesting Tokens | Tokens locked outside of cicrulation for future claim | 500 | -| Circulating Supply | Amount of unlocked tokens | 804_560_131 | -| Stake Saturation | Optimal size of node self-bond + delegation | 1_020_023 | +| Circulating Supply | Amount of unlocked tokens | 805_903_308 | +| Stake Saturation | Optimal size of node self-bond + delegation | 1_022_821 | diff --git a/documentation/docs/components/outputs/api-scraping-outputs/time-now.md b/documentation/docs/components/outputs/api-scraping-outputs/time-now.md index 71c0ce06df..9ea1763e81 100644 --- a/documentation/docs/components/outputs/api-scraping-outputs/time-now.md +++ b/documentation/docs/components/outputs/api-scraping-outputs/time-now.md @@ -1 +1 @@ -Monday, December 23rd 2024, 17:41:13 UTC +Monday, January 6th 2025, 11:03:09 UTC diff --git a/documentation/docs/pages/operators/introduction.mdx b/documentation/docs/pages/operators/introduction.mdx index ab2eaa5b40..3ecfabf6ce 100644 --- a/documentation/docs/pages/operators/introduction.mdx +++ b/documentation/docs/pages/operators/introduction.mdx @@ -2,7 +2,7 @@ This is **Nym's Operators guide**, containing information and setup guides for the various components of Nym network and Nyx blockchain validators. -Nym network (also known as mixnet) routes and mixes packets through Gateways and Mixnodes, all run from the same binary called `nym-node`. +Nym network (also known as Nym mixnet) routes and mixes packets through Gateways and Mixnodes, all run from the same binary called `nym-node`. ```ascii ┌─►mix──┐ mix mix @@ -14,13 +14,13 @@ client ───► Gateway ──┘ mix │ mix ┌─►mix ───► mix └─►mix──┘ mix ``` -If you are new to Nym and want to learn about the Mixnet, explore kickstart options and demos, learn how to integrate with the network, and follow developer tutorials check out the [Developer Portal](https://nymtech.net/docs/developers/). +If you want to dive deeper into Nym Network architecture, clients and nodes visit the [Network docs](https://nymtech.net/docs/network). -If you want to dive deeper into Nym's architecture, clients, nodes, and SDK examples visit the [technical docs](https://nymtech.net/docs/network). +If you want to explore kickstart options and examples, learn how to integrate with the network, and follow developer tutorials check out the [Developer Portal](https://nymtech.net/docs/developers/). ## Minimum Requirements -**If you are a new operator and want to join the journey of starting and mantaining a Nym Node, begin with visiting [Minimum Requirements page](nodes.mdx).** +**If you are an operator and want to join the journey of starting and mantaining a Nym Node, begin with visiting [Minimum requirements page](nodes.mdx).** ## Popular pages @@ -55,4 +55,4 @@ If you want to dive deeper into Nym's architecture, clients, nodes, and SDK exam **Archive** -*[FAQ: Project Smoosh](archive/faq/smoosh-faq.mdx) +* [FAQ: Project Smoosh](archive/faq/smoosh-faq.mdx) diff --git a/documentation/docs/pages/operators/nodes.mdx b/documentation/docs/pages/operators/nodes.mdx index 2c0b11c697..a0da0408e2 100644 --- a/documentation/docs/pages/operators/nodes.mdx +++ b/documentation/docs/pages/operators/nodes.mdx @@ -9,17 +9,21 @@ Welcome to the section containing setup guides for operators of Nym Nodes and Ny ## Minimum Requirements -Operating a `nym-node` is not a set-and-forget endeavor. To prevent operators frustration and investment of time or money for sub-optimal server, we composed this list of prerequisites. +Operating a `nym-node` is not a set-and-forget endeavor. To prevent operators committing their time and money into a sub-optimal server, resulting in frustration of never seeing their node active, we composed this list of prerequisites. Please read below about expectations regarding operators [skill set](#knowledge-base), [time dedication](#time) and [minimum hardware specs](#vps-hardware-specs). ### Knowledge base -All nodes are run remotely from operators shell, using [SSH](https://www.ssh.com/academy/ssh) and [Bash](https://www.gnu.org/software/bash/) commands. Node operators need to be an experienced super users or preferably sys-admins. If you never used terminal before, maybe start with some tutorial of [basic Linux administration](https://www.linode.com/docs/guides/linux-system-administration-basics/) before committing to run a node. +**All nodes are run remotely from operators shell, using [SSH](https://www.ssh.com/academy/ssh) and [Bash](https://www.gnu.org/software/bash/) commands. Node operators need to be experienced super users or sys-admins.** If you never used terminal before, maybe start with some tutorial of [basic Linux administration](https://www.linode.com/docs/guides/linux-system-administration-basics/) before committing to run a node. ### Time -Last but not least, managing a Nym Node is work. More skilled an operator is, less time it takes run a node (and search extra details), but just like any other work, it takes time. Reserve 45-120 minutes for the initial setup and configuration (depends on your skills). Then count on a few minutes once in 2-4 weeks to upgrade node version binaries. Outdated nodes are never selected for routing/mixing packets, resulting in not receiving any rewards. You can read more on our [Tokenomics page](tokenomics/mixnet-rewards.mdx) to understand the selection and rewards logic. +Last but not least, managing a Nym Node is work. More skilled an operator is, less time it takes to run and maintain a node (and search extra details), but just like any other work, it takes effort. + +Reserve 45-120 minutes for the initial setup and configuration (depends on your skills). Then count on a few minutes once in 2-4 weeks to upgrade node version binaries. Patches don't always come out [regularly](release-cycle.mdx), operators need to keep their eyes on [Matrix announcement channel](https://matrix.to/#/#node-ops-announcements:nymtech.chat). + +Outdated nodes are never selected for routing/mixing packets, resulting in not receiving any rewards. You can read more on our [Tokenomics page](tokenomics/mixnet-rewards.mdx) to understand the selection and rewards logic. ## Steps for Nym Node Operators