Skip to content

Commit

Permalink
[DOCs/operators]: Guides, changes and release-notes for v2025.1-reeses (
Browse files Browse the repository at this point in the history
#5340)

* create ToC snippet

* fund node client account

* revamp node guide

* finish setup page revamp

* add new update to changelog

* fix wallet dowload uls

* fix operator steps urls

* fix operator steps urls

* fix operator steps urls

* finish release notes

* finish changelog

* debug build

* correct links syntax

* add remote mnemonic pull command
  • Loading branch information
serinko authored Jan 16, 2025
1 parent 03c4895 commit 1b64cb4
Show file tree
Hide file tree
Showing 12 changed files with 378 additions and 79 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ import Stack from '@mui/material/Stack';
import Paper from '@mui/material/Paper';
import type { SetupMixFetchOps } from '@nymproject/mix-fetch';

const defaultUrl = 'https://nymtech.net/favicon.svg';
const defaultUrl = 'https://nym.com/favicon.svg';
const args = { mode: 'unsafe-ignore-cors' };

const mixFetchOptions: SetupMixFetchOps = {
Expand Down
9 changes: 9 additions & 0 deletions documentation/docs/components/operators/snippets/tc-info.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
import { Callout } from 'nextra/components';

### Terms & Conditions

<Callout type="info" emoji="ℹ️">
From `nym-node` version `1.1.3` onward is required to accept [**Operators Terms & Conditions**](https://nymtech.net/terms-and-conditions/operators/v1.0.0) in order to be part of the active set. Make sure to read them before you add the flag.
</Callout>

There has been a long ongoing discussion whether and how to apply Terms and Conditions for Nym network operators, with an aim to stay aligned with the philosophy of Free Software and provide legal defense for both node operators and Nym developers. To understand better the reasoning behind this decision, you can listen to the first [Nym Operator Town Hall](https://www.youtube.com/live/7hwb8bAZIuc?si=3mQ2ed7AyUA1SsCp&t=915) introducing the T&Cs or to [Operator AMA with CEO Harry Halpin](https://www.youtube.com/watch?v=yIN-zYQw0I0) from June 4th, 2024, explaining pros and cons of T&Cs implementation.
Original file line number Diff line number Diff line change
@@ -1 +1 @@
Wednesday, January 8th 2025, 15:01:28 UTC
Thursday, January 16th 2025, 09:57:52 UTC
242 changes: 238 additions & 4 deletions documentation/docs/pages/operators/changelog.mdx

Large diffs are not rendered by default.

6 changes: 2 additions & 4 deletions documentation/docs/pages/operators/faq/general-faq.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

## Nym Network

To see different stats about Nym Network live, we recommend you to visit [Nym Harbourmaster](https://harbourmaster.nymtech.net) and dynamic [Nym token page](https://nymtech.net/about/token.
To see different stats about Nym Network live, we recommend you to visit [Nym Harbourmaster](https://harbourmaster.nymtech.net) and dynamic [Nym token page](https://nymtech.net/about/token).

### Is there an explorer for Nym Mixnet?

Expand All @@ -12,7 +12,7 @@ Yes, there are..

* [Nym Explorer](https://explorer.nymtech.net/)
* [Sandbox testnet](https://sandbox-explorer.nymtech.net/)
* [Nym Harbourmaster](https://harbourmaster.nymtech.net)
* [Nym Harbourmaster](https://harbourmaster.nymtech.net)

**Built by community**

Expand Down Expand Up @@ -43,5 +43,3 @@ At this point the most crucial component needed are [Exit Gateways](../nodes/nym
### Are Nym Nodes whitelisted?

Nope, anyone can run a Nym Node. whether your node is chosen to mix is purely reliant on the node's performance and reputation (self stake + delegations).


19 changes: 12 additions & 7 deletions documentation/docs/pages/operators/nodes.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@ import { Callout } from 'nextra/components';
import { Steps } from 'nextra/components';
import { Tabs } from 'nextra/components';
import NymNodeSpecs from 'components/operators/snippets/nym-node-specs.mdx';
import TermsConditions from 'components/operators/snippets/tc-info.mdx';

# Nym Nodes Operator Guides

Expand All @@ -25,21 +26,25 @@ Reserve 45-120 minutes for the initial setup and configuration (depends on your

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.

<TermsConditions />

Accepting T&Cs is done via a flag `--accept-operator-terms-and-conditions` added explicitly to `nym-node run` command every time. Detailed info and proper syntax is provided on the [setup page](nodes/nym-node/setup#terms--conditions).

## Steps for Nym Node Operators

This is a summary of all needed steps for node operators to setup and configure a `nym-node` and register it to Nym Network:


1. **Start with [Preliminary Steps](preliminary-steps.mdx), preparing:**
- [VPS](preliminary-steps/vps-setup.mdx)
- [Nym wallet](preliminary-steps/wallet-preparation/mdx)
1. **Start with [Preliminary Steps](nodes/preliminary-steps.mdx), preparing:**
- [VPS](nodes/preliminary-steps/vps-setup.mdx)
- [Nym wallet](nodes/preliminary-steps/wallet-preparation)

2. **[Setup](nym-node/setup.mdx) the node**
2. **[Setup](nodes/nym-node/setup.mdx) the node**

3. **[Configure](nym-node/configuration.mdx) the node and (optionally) automation, Wireguard, WSS, reverse proxy ...**
3. **[Configure](nodes/nym-node/configuration.mdx) the node and (optionally) automation, Wireguard, WSS, reverse proxy ...**

4. **[Run](nym-node/setup.mdx#initialise--run) the node or [the service](nym-node/configuration.md#systemd)**
4. **[Run](nodes/nym-node/setup.mdx#initialise--run) the node or [the service](nodes/nym-node/configuration.md#systemd)**

5. **[Bond](nym-node/bonding.mdx) the node to the Nym API, using Nym wallet**
5. **[Bond](nodes/nym-node/bonding.mdx) the node to the Nym API, using Nym wallet**

Make sure to follow the steps thoroughly, in case you find any point difficult don't hesitate to ask in our [Operators channel](https://matrix.to/#/#operators:nymtech.chat).
4 changes: 2 additions & 2 deletions documentation/docs/pages/operators/nodes/nym-node.mdx
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
import { VarInfo } from 'components/variable-info.tsx'
import { VarInfo } from 'components/variable-info.tsx';
import {Callout} from 'nextra/components';

# Nym Node


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

To setup any type of Nym Node, start with either building [Nym's platform](../binaries/building-nym.mdx) from source or download [pre-compiled binaries](../binaries/pre-built-binaries.mdx) on the [configured server (VPS)](preliminary-steps/vps-setup.mdx) where you want to run the node. Your Nym Node will need to be bonded before it can be run. We recommend most users use the [Nym desktop wallet](preliminary-steps/wallet-preparation.mdx) for this.
Expand Down
49 changes: 49 additions & 0 deletions documentation/docs/pages/operators/nodes/nym-node/bonding.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,10 @@ Any new bonded node will provide only the bare minimum information: host, identi

**Every operator has to make sure that their nodes [self-described endpoint works](nodes/performance-and-testing/node-api-check#basic-api-usage), otherwise the node will be un-routable and thus won't get any rewards!**

<Callout type="warning" emoji="⚠️">
**Reveal your menominc phrase only in areas out of surveillance of other people and never share it with others. Nym team will never ask you for your mnemonic phrase - in case you were asked by someone it's a scam, do *not* reply to it!**
</Callout>

## Bond via the Desktop wallet (recommended)

You can bond your `nym-node` via the Desktop wallet.
Expand Down Expand Up @@ -150,3 +154,48 @@ Versions older than `nym-wallet v 1.2.15` will not allow bonding new nodes.
## Bond via the CLI (power users)

If you want to bond your Mix Node via the CLI, then check out the [relevant section in the Nym CLI](../../../developers/tools/nym-cli/usage#usage) docs.

## Fund `nym-node` Client Nyx Account

<Callout type="info">
This is not relevant for operators running exclusively `mixnode` functionality. For any type of gateway functionality this is a preparation requirement for the upcoming [ticket rewarding](../../tokenomics/mixnet-rewards#roadmap).
</ Callout>

Every `nym-node` client contains a mnemonic of a Nyx account, generated with node initialisation (first `run` command creating all configuration and data files). This mnemonic is located in `$HOME/.nym/nym-nodes/<ID>/data/cosmos_mnemonic`. **This is *not* the same account as the one used for bondng!**

This client account will be used for the process of redemption of tickets collected by nodes running as `entry-gateway` and `exit-gateway` as the redemption requires gateway to create a multisig proposal on the chain for which the client (node) needs to pay transaction fee.

Giving the low transaction cost on Cosmos, funding your client Nyx account with 25 NYM tokens should be more than enough. To do so, follow these steps:

<Steps>

###### 1. Get your `nym-node` client Nyx account mnemonic phrase
- Make sure your screen is not exposed to other people or recording devices
- To store sensitive credentials use audited and open source password managers, like [KeePassXC](https://keepassxc.org/)
- To print out your node client mnemonic phrase, run:
```sh
cat $HOME/.nym/nym-nodes/<ID>/data/cosmos_mnemonic
```
```sh
# for example
# cat $HOME/.nym/nym-nodes/default-nym-node/data/cosmos_mnemonic
```
- **Alternatively:** You can use `scp` command to copy the file `cosmos_mnemonic` remotely. If this is your preference, use this command:
```sh
scp <USER>@<HOST>:.nym/nym-nodes/<ID>/data/cosmos_mnemonic <LOCAL_TARGET_PATH>
```
- Copy this phrase and save it to your password manager


###### 2. Get the address of your client Nyx account using desktop wallet
- Open desktop wallet and choose to sign in with mnemonic
- Use the phrase from step 1
- Open `Receive` tab and copy Nym account address
- We recommend operators to store this address for future funding

###### 3. Fund the client Nyx account
- Open wallet with Nym tokens and send a minimum of 25 NYM to the address copied in the previous step
- In case you don't have any spare NYM, you can send tokens from any exchange directly to the address copied in the previous step
</ Steps>

Now your `nym-node` client can use inbuilt Nyx account to create a multisig proposal on chain and redeem user tickets.
Loading

0 comments on commit 1b64cb4

Please sign in to comment.