Tools

SSH into your server (VPS)

• The installation of nym-node using this program requires you to run as root

Download nym-node-cli.py and make executable

wget https://raw.githubusercontent.com/nymtech/nym/refs/heads/develop/scripts/nym-node-setup/nym-node-cli.py && \
chmod +x ./nym-node-cli.py

Run the program

There are two ways how to run the program. fully interactive or with provided arguments. The former has a shorter initial command but then operators must fill the values on the go, the latter requires more complex command, but then there is a minimum prompts during the process.

1. Fully interactive mode - just run:

./nym-node-cli.py install

2. Use arguments - run this command to see all options:

./nym-node-cli.py install --help

usage: nym-node-cli install [-h] [-V] [-d BRANCH] [-v]
                            [--mode {mixnode,entry-gateway,exit-gateway}]
                            [--wireguard-enabled {true,false}]
                            [--hostname HOSTNAME] [--location LOCATION]
                            [--email EMAIL] [--moniker MONIKER]
                            [--description DESCRIPTION]
                            [--public-ip PUBLIC_IP]
                            [--host-ssh-port HOST_SSH_PORT]
                            [--nym-node-binary NYM_NODE_BINARY]
                            [--uplink-dev UPLINK_DEV]
                            [--uplink-dev-v4 UPLINK_DEV_V4]
                            [--uplink-dev-v6 UPLINK_DEV_V6] [--env KEY=VALUE]
 
options:
  -h, --help            show this help message and exit
  -V, --version         show program's version number and exit
  -d, --dev BRANCH      Define github branch (default: develop)
  -v, --verbose         Show full error tracebacks
  --mode {mixnode,entry-gateway,exit-gateway}
                        Node mode: 'mixnode', 'entry-gateway', or 'exit-
                        gateway'
  --wireguard-enabled {true,false}
                        WireGuard functionality switch: true / false
  --hostname HOSTNAME   Node domain / hostname
  --location LOCATION   Node physical country: ISO 3166 alpha-2 (CH), alpha-3
                        (CHE), numeric (756) or name (Switzerland)
  --email EMAIL         Contact email for the node operator
  --moniker MONIKER     Public moniker displayed in explorer & NymVPN app
  --description DESCRIPTION
                        Short public description of the node
  --public-ip PUBLIC_IP
                        External IPv4 address (autodetected if omitted)
  --host-ssh-port HOST_SSH_PORT
                        Host SSH port to allow in the firewall (default: 22)
  --nym-node-binary NYM_NODE_BINARY
                        URL for nym-node binary (autodetected if omitted)
  --uplink-dev UPLINK_DEV
                        Backward-compatible override for both IPv4 and IPv6
                        uplinks, e.g. 'eth0'
  --uplink-dev-v4 UPLINK_DEV_V4
                        Override IPv4 uplink interface used for NAT/FORWARD,
                        e.g. 'eth0'
  --uplink-dev-v6 UPLINK_DEV_V6
                        Override IPv6 uplink interface used for NAT/FORWARD,
                        e.g. 'eth1'
  --env KEY=VALUE       (Optional) Extra ENV VARS, e.g. --env CUSTOM_KEY=value

• An example can look like this:

# substitute with your real values:
./nym-node-cli.py install \
  --hostname test-node.devrel.nymte.ch \
  --moniker MainnetGW-KU \
  --description "This node is installed with nym-node-cli v1.3.0" \
  --wireguard-enabled true \
  --location KU \
  --mode exit-gateway \
  --email kawa_hesinkar@ciya.ku

Read and follow the prompts

There ware a few required confirmations and in case of running the program without the arguments, you will be prompted for values neccessary to setup a nym-node and configure your server.

Read these prompts carefully!

Setup finished

Congratulation, your node is installed.

This version of the program does not prompt an operator for the local node moniker (--id <ID>) therefore it asigns your node an automatic one default-nym-node.

All configuration and data of your node can be found in this location:

ls $HOME/.nym/nym-nodes/default-nym-node/

Download the program

There are two options how to get node_rewards_tracker.py

Download the program, using curl

• Open terminal and navigate to your destination directory and run:

 
curl -L "https://raw.githubusercontent.com/nymtech/nym/refs/heads/develop/scripts/rewards-tracker/node_rewards_tracker.py" -o node_rewards_tracker.py

Pull / clone nymtech/nym repository

• Open terminal and navigate to where you want to have nym repostiry and run:

git clone https://github.com/nymtech/nym

• Copy node_rewards_tracker.py from nym/scripts/rewards-tracker/node_rewards_tracker.py to your destination

Make executable and initialise

• In the directory where you have the program saved, run:

chmod u+x ./node_rewards_tracker.py
 
./node_rewards_tracker.py

The second command created a /data sub-directory:

└── data
    └── wallet-addresses.csv

python3 -m venv .venv && . .venv/bin/activate
pip install requests pyyaml tabulate colorama
# or
sudo apt install python3-requests python3-yaml python3-tabulate python3-colorama

Add your Nyx accounts to wallet-addresses.csv

• Open data/wallet-addresses.csv in your favourite text editor or a sheet managing tool (Like Libre Office Calc)
• Add all node Nyx account addresses to the first column called address that you want to track

Optionally: Add entity and your share to wallet-addresses.csv

• In the same file operators who want to separate the tracked nodes by an entity, can add this entity to the tag column

• Same way an operator can define how many operators are sharing the rewards of that entity (ie in a case of DAO) in the column share

• Csv example with tags:

address, tag, members
n1foofoofoo, personal, 1
n1barbarbar, personal, 1
n1bazbazbaz, mysquad, 5
n1lollollol, mysquad, 5

• For operators having all nodes under one entity, the optional columns will be left empty. Example:

address, tag, members
n1foofoofoo,,
n1barbarbar,,
n1bazbazbaz,,

Save wallet-addresses.csv and exit

Run the program

• Run the program:

./node_rewards_tracker.py

• You can preview all commands with:

./node_rewards_tracker.py --help

Pull nymtech/nym monorepo

• In your desired location, run:

git clone https://github.com/nymtech/nym.git

Build nym-cli

• The nym-cli binary can be built by running cargo build --release in the nym/tools/nym-cli directory
• Or follow the steps in this chapter
• nym-cli will then be in nym/target/release

Get nodes.csv

• Navigate to nym/scripts/nym-node-setup/auto-bond
• Open nodes.csv.example and save it in your desired location as nodes.csv

Populate nodes.csv with your data

• All amounts are in NYM (not unym). The tools convert to unym internally.
• In case you don’t use auto_bond_all.py for multi-bonding, only values needed for topping up your node via nodes_account_topup.py are these:

Check node balances with show_balances.py

Once you populated and saved nodes.csv, run show_balances.py. The program shows both the operator’s bonding balance and the node’s gas-account balance. It flags any node under 1 NYM as a config-score penalty risk.

• Usage

python3 show_balances.py nodes.csv [options]

Shows the node balance when IP is present, and the bonding balance when bonding_account_address is present.

Topup your nodes with nodes_account_topup.py

Tops up each node’s on-chain gas account to a target balance. Reads the node account address from the node’s HTTP endpoint and the balance from the chain. nym-cli is only used for the actual send.

• Usage:

python3 nodes_account_topup.py nodes.csv [options]
# or
MNEMONIC="<MNEMONIC>" python3 nodes_account_topup.py nodes.csv [options]

The program tops up to target (sends target − balance, skips nodes already at or above target). Amounts are in NYM.

Note: Do not keep your nodes.csv opened in a UI spreadsheet while running the operation, or the write-back of balances may not be visible / may be overwritten on save.

SSH into your node server (VPS)

Download and make executable

• Navigate to the directory where you want to have this script
• Download and make executable:

wget https://raw.githubusercontent.com/nymtech/nym/refs/heads/develop/scripts/test-nodes-pings.sh && \
chmod +x test-nodes-pings.sh

Run the script

• Default running command is straight forward

./test-nodes-pings.sh

• If you want to increase the ping attempts from default 2 or lower the concurency, feel free to change the variables, like this:

PING_RETRIES=10 PING_TIMEOUT=5 CONCURRENCY=16 ./test-nodes-pings.sh