:8000/api/v1/description` |
diff --git a/documentation/docs/pages/operators/changelog.mdx b/documentation/docs/pages/operators/changelog.mdx
index 1f5dc1a8eb..cb0c8f3744 100644
--- a/documentation/docs/pages/operators/changelog.mdx
+++ b/documentation/docs/pages/operators/changelog.mdx
@@ -17,16 +17,25 @@ export const TryYourself = () => (
);
+export const CiConfig = () => (
+
+ Components of ci-binary-config-checker
+
+);
+
+
# Changelog
This page displays a full list of all the changes during our release cycle from [`v2024.3-eclipse`](https://github.com/nymtech/nym/blob/nym-binaries-v2024.3-eclipse/CHANGELOG.md) onwards. Operators can find here the newest updates together with links to relevant documentation. The list is sorted so that the newest changes appear first.
+
+
## `v2024.12-aero`
- [Release binaries](https://github.com/nymtech/nym/releases/tag/nym-binaries-v2024.12-aero)
- [Release CHANGELOG.md](https://github.com/nymtech/nym/blob/nym-binaries-v2024.12-aero/CHANGELOG.md)
-- [`nym-node`](nodes/nym-node.md) version `1.1.9`
+- [`nym-node`](nodes/nym-node.mdx) version `1.1.9`
```sh
nym-node
@@ -185,6 +194,7 @@ More info about testing and tools for performance monitoring can be found in [th
In October we again proceeded with our Delegation Program. 22 nodes didn't meet the program rules and got their delegation removed and 25 nodes from the que received delegation. Below is a complete list.
+
Delegated:
```
@@ -246,7 +256,7 @@ sjL9n9ymxfWWwkQJxXdsMkdwamXfh3AJ3vCe7rJ8RrT
E2HAJrHnk56QZDUCkcjc4i4pVEqtyuPYL5bNFYtweQuL
4PytR3tmodsvqGTKdY47yie8kmrkARQdb5Ht3Ro3ChH4
```
-
+
---
@@ -254,7 +264,7 @@ E2HAJrHnk56QZDUCkcjc4i4pVEqtyuPYL5bNFYtweQuL
- [Release binaries](https://github.com/nymtech/nym/releases/tag/nym-binaries-v2024.11-wedel)
- [Release CHANGELOG.md](https://github.com/nymtech/nym/blob/nym-binaries-v2024.11-wedel/CHANGELOG.md)
-- [`nym-node`](nodes/nym-node.md) version `1.1.8`
+- [`nym-node`](nodes/nym-node.mdx) version `1.1.8`
```sh
Binary Name: nym-node
@@ -278,7 +288,7 @@ cargo Profile: release
- [Remove deprecated mark_as_success and use new disarm](https://github.com/nymtech/nym/pull/4751): Update function name to keep terminology consistent with tokio `CancellationToken DropGuard`.
- [Update peer refresh value](https://github.com/nymtech/nym/pull/4754): `lso` expose the value by moving it to wireguard types, and separate the refresh time to the database sync time, so that more probable and needed actions happen faster (refresh) and more improbable ones don't overload the system (peer suspended or stale)
-~~~admonish example collapsible=true title='Testing steps performed'
+}>
- **Noted** that the constants `DEFAULT_PEER_TIMEOUT` and `DEFAULT_PEER_TIMEOUT_CHECK` have been moved to `common/wireguard-types/src/lib.rs` and are now being used across modules for consistency
- **Observed** that the `peer_controller.rs` now separates the in-memory updates from the storage sync operations to reduce system load
- **Identified** that in-memory updates of peer bandwidth usage happen every `DEFAULT_PEER_TIMEOUT_CHECK` (every 5 seconds), while storage updates occur every 5 * `DEFAULT_PEER_TIMEOUT_CHECK` (every 25 seconds)
@@ -290,19 +300,19 @@ cargo Profile: release
- **Ensured** that the system remained responsive and no performance bottlenecks were introduced
- **Efficiency Improvement:** The separation of in-memory updates and storage syncs effectively reduced unnecessary database writes, improving system efficiency without compromising data accuracy
-~~~
+
- [Remove duplicate stat count for retransmissions](https://github.com/nymtech/nym/pull/4756)
- [Make gateway latency check generic](https://github.com/nymtech/nym/pull/4759): Replace concrete gateway type with trait in latency check, so we can make use of it in the vpn client.
-~~~admonish example collapsible=true title='Testing steps performed'
+}>
- Initialised new `nym-client` with the `--latency-based-selection` flag and ensured it still works as normal.
-~~~
+
- [chore: remove repetitive words](https://github.com/nymtech/nym/pull/4763)
- [Avoid race on ip and registration structures](https://github.com/nymtech/nym/pull/4766): To avoid a state where the ip is being cleared out before the registration is also cleared out, couple the two structures under the same lock, since they are anyway very inter-dependent.
-~~~admonish example collapsible=true title='Testing steps performed'
+}>
1. - **Checked out** the release/2024.10-wedel branch containing the fix for the race condition on IP and registration structures
- **Deployed** the on a controlled test environment to prevent interference
@@ -322,7 +332,7 @@ cargo Profile: release
4. **Validated Normal Operation:**
- **Conducted standard registration processes** with individual clients to confirm that regular functionality is unaffected via `nym-vpn-cli`
- Ensured that authenticated clients could communicate over the network as expected
-~~~
+
- [Persist used wireguard private IPs](https://github.com/nymtech/nym/pull/4771)
@@ -339,7 +349,8 @@ cargo Profile: release
- [Remove unused wireguard flag from SDK](https://github.com/nymtech/nym/pull/4823)
- [Expose wireguard details on self described endpoint](https://github.com/nymtech/nym/pull/4825)
-~~~admonish example collapsible=true title='Testing steps performed'
+
+}>
Wireguard details are now visible at the nym-node endpoint `/api/v1/gateway/client-interfaces` as well as on the nym-api self-described endpoint `/api/v1/gateways/described`, above the existing data displaying mixnet_websocket information.
An example of what will be shown is:
@@ -349,10 +360,10 @@ An example of what will be shown is:
"public_key": ""
}
```
-~~~
+
- [Revamped ticketbook serialisation and exposed additional cli methods](https://github.com/nymtech/nym/pull/4827): `wip` branch that includes changes needed for `vpn-api` alongside additional `ecash utils`
-~~~admonish example collapsible=true title='Testing steps performed'
+}>
Checked the following commands:
```sh
show-ticket-books # which displays the information about all ticketbooks associated to the client
@@ -360,7 +371,7 @@ import-ticket-book # which imports a normal ticketbook to the client alongside `
```
On the cli, the following were added: `import-coin-index-signatures`, `import-expiration-date-signatures` and `import-master-verification-key`.
-~~~
+
- [Run cargo autoinherit following last weeks dependabot updates](https://github.com/nymtech/nym/pull/4831)
@@ -372,7 +383,7 @@ On the cli, the following were added: `import-coin-index-signatures`, `import-ex
2. Copy the repo spec to `/etc/apt/sources.list.d/nymtech.list`
- Also create a meta package `nym-vpn` which only purpose is to depend on the daemon and UI.
-~~~admonish example collapsible=true title='Usage'
+}>
1. Install with
```sh
sudo dpkg -i ./nym-repo-setup.deb
@@ -381,16 +392,16 @@ sudo dpkg -i ./nym-repo-setup.deb
```sh
sudo apt install nym-vpnc
```
-3. To reemove the repo, use
+3. To remove the repo, use
```sh
sudo apt remove nym-repo-setup
```
NOTE: removing the repo will not remove any installed nym-vpn packages
-~~~
+
-~~~admonish example collapsible=true title='Testing steps performed'
+}>
1. **Downloaded** the `nym-repo-setup.deb` package to a Debian-based test system
2. **Installed** the repository setup package using the command:
@@ -430,13 +441,15 @@ sudo apt remove nym-repo-setup
10. **Verified** that the repository specification file `/etc/apt/sources.list.d/nymtech.list` was removed
11. **Ensured** that the installed `nym-vpnc` packages remained installed and functional after removing the repo setup package
-~~~
+
- [Use ecash credential type for bandwidth value](https://github.com/nymtech/nym/pull/4840)
- [Start switching over jobs to arc-ubuntu-20.04](https://github.com/nymtech/nym/pull/4843)
-~~~admonish example collapsible=true title='`ci-binary-config-checker`'
+
+
+}>
```
- ci-build-upload-binaries
- ci-build
@@ -448,7 +461,7 @@ sudo apt remove nym-repo-setup
- ci-nym-wallet-rust
- ci-sdk-wasm
```
-~~~
+
- [Move credential verification into common crate](https://github.com/nymtech/nym/pull/4853)
@@ -475,9 +488,9 @@ sudo apt remove nym-repo-setup
- [Allow updating globally stored signatures](https://github.com/nymtech/nym/pull/4891)
- [Bugfix/ticketbook false double spending](https://github.com/nymtech/nym/pull/4892)
-~~~admonish example collapsible=true title='Testing steps performed'
+}>
Tested running a client in mixnet mode, with a standard ticketbook, as well as a client using an imported ticketbook. The double spending bug is no longer an issue, bandwidth is consumed properly, and upon consumption of one ticket another ticket is properly obtained.
-~~~
+
### Operators Guide, Tooling & Updates
@@ -514,9 +527,9 @@ This release is a patch only, there are no additional features, everything else
- [Release binaries](https://github.com/nymtech/nym/releases/tag/nym-binaries-v2024.10-caramello)
- [Release CHANGELOG.md](https://github.com/nymtech/nym/blob/nym-binaries-v2024.10-caramello/CHANGELOG.md)
-- [`nym-node`](nodes/nym-node.md) version `1.1.7`
+- [`nym-node`](nodes/nym-node.mdx) version `1.1.7`
-~~~admonish example collapsible=true title='CHANGELOG.md'
+
- Backport 4844 and 4845 ([#4857])
- Bugfix/client registration vol2 ([#4856])
- Remove wireguard feature flag and pass runtime enabled flag ([#4839])
@@ -568,13 +581,13 @@ This release is a patch only, there are no additional features, everything else
[#4716]: https://github.com/nymtech/nym/pull/4716
[#4681]: https://github.com/nymtech/nym/pull/4681
[#4623]: https://github.com/nymtech/nym/pull/4623
-~~~
+
### Features
- [Add 1GB/day/user bandwidth cap](https://github.com/nymtech/nym/pull/4717)
-~~~admonish example collapsible=true title='Testing steps performed'
+}>
**Scenario 1: Bandwidth Decreasing Continuously**
1. Started the client and noted the initial bandwidth (e.g., 1GB).
@@ -610,31 +623,31 @@ Bandwidth reset to 1GB at midday while the client was connected. Logs and report
4. Restarted a client within 3 days and verified it retained the same private IP.
The client was removed from the peer list after 3 days of inactivity. Upon re-connection after 3 days, the client received a new private IP. The client retained the same private IP when restarted within 3 days.
-~~~
+
- [Feature/merge back](https://github.com/nymtech/nym/pull/4710): Merge back from the release branch the changes that fix the `nym-node` upgrades
- [Removed mixnode/gateway config migration code and disabled cli without explicit flag](https://github.com/nymtech/nym/pull/4706): Commands for archived / legacy binaries `nym-gateway` and `nym-mixnode` won't do anything without explicit `--force-run` to bypass the deprecation. The next step, in say a month or so, is to completely remove all `cli` related things.
-~~~admonish example collapsible=true title='Testing steps performed'
+}>
- Verify that the `nym-gateway` binary and `nym-mixnode` binary commands return the _error message_ stating to update to nym-node
- Check that when adding the `--force-run` flag, it still allows the command to be run (aside from `init` which has been removed) and the message stating to update to nym-node is a _warning_ now
- Check `nym-node` is not affected
- Reviewed the changes in the PR
-~~~
+
- [Handle clients with different versions in IPR](https://github.com/nymtech/nym/pull/4723): Allow the IPR to handle clients connecting both using `v6` and `v7`, independently. The motivation is that we want to be able to roll out a API version change gradually for VPN clients without breaking backwards compatibility. The main feature on the new `v7` format that is not yet used, is that it adds signatures for connect/disconnect.
-~~~admonish example collapsible=true title='Testing steps performed'
+}>
Run the same command (using same gateways deployed from this PR) on different versions of the `nym-vpn-cli`.
Example:
```sh
-~/nym-vpn-core-v0.1.10_macos_universal ❯ sudo -E ./nym-vpn-cli -c ../qa.env run --entry-gateway-id $entry_gateway --exit-gateway-id $exit_gateway --enable-two-hop
+sudo -E ./nym-vpn-cli -c ../qa.env run --entry-gateway-id $entry_gateway --exit-gateway-id $exit_gateway --enable-two-hop
-~/nym-vpn-core-v0.1.11-dev_macos_universal ❯ sudo -E ./nym-vpn-cli -c ../qa.env run --entry-gateway-id $entry_gateway --exit-gateway-id $exit_gateway --enable-two-hop
+sudo -E ./nym-vpn-cli -c ../qa.env run --entry-gateway-id $entry_gateway --exit-gateway-id $exit_gateway --enable-two-hop
```
-~~~
+
- [Backport `#4844` and `#4845`](https://github.com/nymtech/nym/pull/4857)
@@ -671,7 +684,7 @@ Example:
- [Persist wireguard peers](https://github.com/nymtech/nym/pull/4732)
- [Feature/vesting purge plus ranged cost params](https://github.com/nymtech/nym/pull/4716): Combines [\#4715](https://github.com/nymtech/nym/pull/4715) and [\#4711](https://github.com/nymtech/nym/pull/4711) into one.
- - Disables all non-essential operations on the vesting contract => you can no longer bond mixnodes/make delegations/etc. (you can still, however, withdraw your vested tokens and so on)
+ - Disables all non-essential operations on the vesting contract \=\> you can no longer bond mixnodes/make delegations/etc. (you can still, however, withdraw your vested tokens and so on)
- Introduces admin-controlled minimum (and maximum) profit margin and interval operating costs.
- both contracts have to be migrated **at the same time**. ideally within the same transaction
- mixnet contract migration is not allowed (and will fail) if there are any pending actions involving vesting tokens, like delegating, increasing pledge, etc
@@ -682,16 +695,16 @@ Example:
- [chore: fix 1.80 lint issues](https://github.com/nymtech/nym/pull/4731)
-~~~admonish example collapsible=true title='Testing steps performed'
+}>
- Building all binaries is ok
- Running `cargo fmt` returns no issues
-~~~
+
- [Fix version 1 not having template correspondent initially](https://github.com/nymtech/nym/pull/4733)
-~~~admonish example collapsible=true title='Testing steps performed'
+}>
Tested updating an old `nym-node` version and ensuring it did not throw any errors.
-~~~
+
- [Bugfix/client registration vol2](https://github.com/nymtech/nym/pull/4856)
@@ -701,24 +714,24 @@ Tested updating an old `nym-node` version and ensuring it did not throw any erro
- [Fix (some) feature unification build failures](https://github.com/nymtech/nym/pull/4681): Running a script in the root workspace that builds each crate independently
-~~~admonish example collapsible=true title='The script'
- ```sh
- #!/bin/bash
+
+```sh
+#!/bin/bash
- packages=$(cargo metadata --format-version 1 --no-deps | jq -r '.packages[].name')
+packages=$(cargo metadata --format-version 1 --no-deps | jq -r '.packages[].name')
- # Loop through each package and build
- for package in $packages; do
- echo "Building $package"
- cargo clean
- cargo check -p "$package"
- if [ $? -ne 0 ]; then
- echo "Build failed for $package. Stopping."
- exit 1
- fi
- done
- ```
-~~~
+# Loop through each package and build
+for package in $packages; do
+ echo "Building $package"
+ cargo clean
+ cargo check -p "$package"
+ if [ $? -ne 0 ]; then
+ echo "Build failed for $package. Stopping."
+ exit 1
+ fi
+done
+```
+
- [bugfix: make sure DKG parses data out of events if logs are empty](https://github.com/nymtech/nym/pull/4764): This will be the case on post `0.50` chains
@@ -743,12 +756,13 @@ Tested updating an old `nym-node` version and ensuring it did not throw any erro
- Wireguard peers stay connected for longer time, re-connections are also faster
- Profit margin and operating cost values are set to the values agreed by operators off-chain vote, the values can be changed in the future through [Nym Operators governance process](https://forum.nymtech.net/t/poll-proposal-for-on-chain-minimum-profit-margin-for-all-nym-nodes/253)
-```admonish success title=""
-- Minimum profit margin = 20%
-- Maximum profit margin = 50%
-- Minimum operating cost = 0 NYM
-- Maximum operating cost = 1000 NYM
-```
+
+
+*Minimum profit margin = 20%*
+*Maximum profit margin = 50%*
+*Minimum operating cost = 0 NYM*
+*Maximum operating cost = 1000 NYM*
+
- [Nym Harbourmater](https://harbourmaster.nymtech.net) has several new functionalities:
- Version counting graph for Gateways and Mixnodes
@@ -756,7 +770,7 @@ Tested updating an old `nym-node` version and ensuring it did not throw any erro
- Top routing score now includes:
- Wireguard registration and complete handshake test, to configure see [tasklist below](#operators-tasks)
- DNS resolution check, to configure see [tasklist below](#operators-tasks)
- - Wireguard perfomance > 0.75, to configure see [tasklist below](#operators-tasks)
+ - Wireguard perfomance bigger than 0.75, to configure see [tasklist below](#operators-tasks)
- New [Nym Wallet](https://github.com/nymtech/nym/releases/tag/nym-wallet-v1.2.14) is out!
- Vesting contract functionalities have been purged, users can only remove tokens from vesting
@@ -767,11 +781,11 @@ Tested updating an old `nym-node` version and ensuring it did not throw any erro
#### Operators Tasks
-```admonish warning title=""
+
**The steps below are highly recommended for all operators and mandatory for everyone who is a part of Nym Delegation or Grant program. Deadline is Friday, September 20th, 2024.**
-```
+
-Every `nym-node` should be upgraded to the latest version! Operators can test using [Sandbox env](sandbox.md) during the pre-release period, then upgrade on mainnet. During the upgrade, please follow the points below before you restart the node:
+Every `nym-node` should be upgraded to the latest version! Operators can test using [Sandbox env](sandbox.mdx) during the pre-release period, then upgrade on mainnet. During the upgrade, please follow the points below before you restart the node:
**`nym-node`**
@@ -780,11 +794,11 @@ Every `nym-node` should be upgraded to the latest version! Operators can test us
- Enable Wireguard with `--wireguard-enabled true` flag included in your run command (Gateways only for the time being)
- Note: On some VPS this setup may not be enough to get the correct results as some ISPs have their own security groups setup below the individual VPS. In that case a ticket to ISP will have to be issued to open the needed settings. We are working on a template for such ticket.
- Setup [reverse proxy and WSS](nodes/proxy-configuration.md) on `nym-node` (Gateways only for the time being)
-- Don't forget to restart your node - or (preferably using [systemd automation](nodes/configuration.md#systemd)) reload daemon and restart the service
+- Don't forget to restart your node - or (preferably using [systemd automation](nodes/nym-node/configuration.mdx#systemd)) reload daemon and restart the service
- Optional: Use [`nym-gateway-probe`](testing/gateway-probe.html) and [NymVPN CLI](https://nymtech.net/developers/nymvpn/cli.html) to test your own Gateway
- Optional: Run the script below to measure ping speed of your Gateway and share your results in [Nym Operators channel](https://matrix.to/#/#operators:nymtech.chat)
-~~~admonish example collapsible=true title='The script to measure Gateway ping results'
+
We made a script for pinging nymtech.net from your GWs. Can you please install it and then share the result together with your Gateway ID:
1. Get the script onto your machine (soon on github for curl or wget):
@@ -850,7 +864,7 @@ sudo apt install bc
5. Share results and ID key in [Nym Operators channel](https://matrix.to/#/#operators:nymtech.chat)
THANK YOU!
-~~~
+
**validators**
@@ -880,9 +894,9 @@ From what we found out it seems that one of our [dependencies - `DefGuard` - is
- [Release binaries](https://github.com/nymtech/nym/releases/tag/nym-binaries-v2024.9-topdeck)
- [Release CHANGELOG.md](https://github.com/nymtech/nym/blob/nym-binaries-v2024.9-topdeck/CHANGELOG.md)
-- [`nym-node`](nodes/nym-node.md) version `1.1.6`
+- [`nym-node`](nodes/nym-node.mdx) version `1.1.6`
-~~~admonish example collapsible=true title='CHANGELOG.md'
+
- chore: fix 1.80 lint issues ([#4731])
- Handle clients with different versions in IPR ([#4723])
- Add 1GB/day/user bandwidth cap ([#4717])
@@ -894,21 +908,23 @@ From what we found out it seems that one of our [dependencies - `DefGuard` - is
[#4717]: https://github.com/nymtech/nym/pull/4717
[#4710]: https://github.com/nymtech/nym/pull/4710
[#4706]: https://github.com/nymtech/nym/pull/4706
-~~~
+
### Features
* [Removed `nym-mixnode` and `nym-gateway` config migration code and disabled CLI without explicit flag](https://github.com/nymtech/nym/pull/4706): Gateway and Mixnode commands now won't do anything without explicit `--force-run` to bypass the deprecation, instead it will tell an operator to run a `nym-node`. The next step, in say a month or so, is to completely remove all `cli` related things.
-~~~admonish example collapsible=true title='Testing steps performed'
+}>
- Verify that the `nym-gateway` binary and `nym-mixnode` binary commands return the `_error message_` stating to *update to `nym-node`*
- Check that when adding the `--force-run` flag, it still allows the command to be run (aside from `init` which has been removed) and the message stating to update to `nym-node` is a `_warning_` now
- Check `nym-node` is not affected
- Review the changes in the PR
-~~~
+
* [Add 1GB/day/user bandwidth cap](https://github.com/nymtech/nym/pull/4717)
-~~~admonish example collapsible=true title='Testing steps performed - Scenario 1: Bandwidth Decreasing Continuously'
+}>
+**Scenario 1: Bandwidth Decreasing Continuously'**
+
1. Start the client and noted the initial bandwidth (e.g., 1GB).
2. Us the client and track bandwidth usage over time (e.g., decrease by 100MB every hour).
3. Restart the client after some usage.
@@ -916,9 +932,10 @@ From what we found out it seems that one of our [dependencies - `DefGuard` - is
**Notes:**
The bandwidth continued decreasing without resetting upon restart. Logs and reports correctly reflected the decreasing bandwidth.
-~~~
-~~~admonish example collapsible=true title='Testing steps performed - Scenario 2: Bandwidth Reset Next Day'
+
+**Scenario 2: Bandwidth Reset Next Day'**
+
1. Use the client normally until the end of the day.
2. Suspend some clients and kept others active.
3. Check bandwidth at midnight.
@@ -926,9 +943,9 @@ From what we found out it seems that one of our [dependencies - `DefGuard` - is
**Notes:**
Bandwidth reset to 1GB for all clients at midnight. Logs and reports correctly showed the reset.
-~~~
-~~~admonish example collapsible=true title='Testing steps performed - Scenario 3: Bandwidth Reset at a Different Time (e.g., Midday)'
+**Scenario 3: Bandwidth Reset at a Different Time (e.g., Midday)'**
+
1. Configure the system to reset bandwidth at midday.
2. Use the client and monitored bandwidth until midday.
3. Keep the client connected during the reset time.
@@ -936,10 +953,10 @@ Bandwidth reset to 1GB for all clients at midnight. Logs and reports correctly s
**Notes:**
Bandwidth reset to 1GB at midday while the client was connected. Logs and reports correctly reflected the reset.
-~~~
+
* [Handle clients with different versions in IPR](https://github.com/nymtech/nym/pull/4723): Allow the IPR to handle clients connecting both using `v6` and `v7`, independently. The motivation is that we want to be able to roll out an API version change gradually for NymVPN clients without breaking backwards compatibility. The main feature on the new `v7` format that is not yet used, is that it adds signatures for connect/disconnect.
-~~~admonish example collapsible=true title='Testing steps performed'
+}>
Run the same command (using same gateways deployed from this PR) on different versions of the `nym-vpn-cli`.
Example:
@@ -948,28 +965,28 @@ sudo -E ./nym-vpn-cli -c ../qa.env run --entry-gateway-id $entry_gateway --exit-
sudo -E ./nym-vpn-cli -c ../qa.env run --entry-gateway-id $entry_gateway --exit-gateway-id $exit_gateway --enable-two-hop
```
-~~~
+
### Bugfix
* [Feature/merge back](https://github.com/nymtech/nym/pull/4710): Merge back from the release branch the changes that fix the `nym-node` upgrades.
* [Fix version `1.x.x` not having template correspondent initially](https://github.com/nymtech/nym/pull/4733): This should fix the problem of config deserialisation when operators upgrade nodes and skip over multiple versions.
-~~~admonish example collapsible=true title='Testing steps performed'
+}>
- Tested updating an old nym-node version and ensuring it did not throw any errors.
-~~~
+
* [chore: fix 1.80 lint issues](https://github.com/nymtech/nym/pull/4731):
-~~~admonish example collapsible=true title='Testing steps performed'
+}>
- Building all binaries is ok
- Running `cargo fmt` returns no issues
-~~~
+
### Operators Guide updates
* [WireGuard tunnel configuration guide](nodes/configuration.md#routing-configuration) for `nym-node` (currently Gateways functionalities). For simplicity we made a detailed step by step guide to upgrade an existing `nym-node` to the latest version and configure your VPS routing for WireGuard. Open by clicking on the example block below.
-~~~admonish example collapsible=true title='Upgrading `nym-node` with WG'
+
**Prerequisites**
- **Nym Node Version:** You must be running the `2024.9-topdeck` release branch, which operates as `nym-node` version `1.1.6`. You can find the release here: [Nym 2024.9-topdeck Release](https://github.com/nymtech/nym/releases/tag/nym-binaries-v2024.9-topdeck).
@@ -978,7 +995,7 @@ sudo -E ./nym-vpn-cli -c ../qa.env run --entry-gateway-id $entry_gateway --exit-
- **Download Nym Node:**
- - You can download the `nym-node` binary directly using the following command:
+- You can download the `nym-node` binary directly using the following command:
```bash
curl -L https://github.com/nymtech/nym/releases/download/nym-binaries-v2024.9-topdeck/nym-node -o nym-node && chmod u+x nym-node
```
@@ -1076,33 +1093,29 @@ Finally, run the following command to initiate our favorite routing test - run t
```
- **Note:** Wireguard will return only IPv4 joke, not IPv6. WG IPv6 is under development. Running IPR joke through the mixnet with `./network_tunnel_manager.sh joke_through_the_mixnet` should work with both IPv4 and IPv6!
-~~~
+
* [Change `--wireguard-enabled` flag to `true`](nodes/setup.md#-initialise--run): With a proper [routing configuration](nodes/configuration.md#routing-configuration) `nym-nodes` running as Gateways can now enable WG. See the example below:
-~~~admonish example collapsible=true title='Syntax to run `nym-node` with WG enabled'
+
For Exit Gateway:
```sh
-./nym-node run --id --mode exit-gateway --public-ips "$(curl -4 https://ifconfig.me)" --hostname "" --http-bind-address 0.0.0.0:8080 --mixnet-bind-address 0.0.0.0:1789 --location --accept-operator-terms-and-conditions --wireguard-enabled true
+./nym-node run --id --mode exit-gateway --public-ips "$(curl -4 https://ifconfig.me)" --hostname --http-bind-address 0.0.0.0:8080 --mixnet-bind-address 0.0.0.0:1789 --location --accept-operator-terms-and-conditions --wireguard-enabled true
-# is in format without 'https://' prefix
-# is format like 'Jamaica', or two-letter alpha2 (e.g. 'JM'), three-letter alpha3 (e.g. 'JAM') or three-digit numeric-3 (e.g. '388') can be provided.
# wireguard can be enabled from version 1.1.6 onwards
```
For Entry Gateway:
```sh
-./nym-node run --id --mode entry-gateway --public-ips "$(curl -4 https://ifconfig.me)" --hostname "" --http-bind-address 0.0.0.0:8080 --mixnet-bind-address 0.0.0.0:1789 --accept-operator-terms-and-conditions --wireguard-enabled true
+./nym-node run --id --mode entry-gateway --public-ips "$(curl -4 https://ifconfig.me)" --hostname --http-bind-address 0.0.0.0:8080 --mixnet-bind-address 0.0.0.0:1789 --accept-operator-terms-and-conditions --wireguard-enabled true
-# is in format without 'https://' prefix
-# is format like 'Jamaica', or two-letter alpha2 (e.g. 'JM'), three-letter alpha3 (e.g. 'JAM') or three-digit numeric-3 (e.g. '388') can be provided.
# wireguard can be enabled from version 1.1.6 onwards
```
-~~~
+
* [Update Nym exit policy](https://nymtech.net/.wellknown/network-requester/exit-policy.txt): Based on the survey, AMA and following discussions we added several ports to Nym exit policy. The ports voted upon in the [forum governance](https://forum.nymtech.net/t/poll-a-new-nym-exit-policy-for-exit-gateways-and-the-nym-mixnet-is-inbound/464) have not been added yet due to the concerns raised. These ports were unrestricted:
-~~~admonish example collapsible=true title='Newly opened ports in Nym exit policy'
+
```
22 # SSH
123 # NTP
@@ -1129,22 +1142,22 @@ For Entry Gateway:
27000-27050 # Steam and game servers
60000-61000 # MOSH
```
-~~~
+
* [Create a NymConnect archive page](https://nymtech.net/developers/archive/nym-connect.html), PR [\#4750](https://github.com/nymtech/nym/commit/5096c1e60e203dcf8be934823946e24fda16a9a3): Archive deprecated NymConnect for backward compatibility, show PEApps examples for both NC and maintained `nym-socks5-client`.
* Fix broken URLs and correct redirection. PRs: [\#4745](https://github.com/nymtech/nym/commit/7e36595d8fa7706876880b42df1c998a4b8c1478), [\#4752](https://github.com/nymtech/nym/commit/1db61f800c6884e284c5ab21e7abce3bc6d91d99) [\#4755](https://github.com/nymtech/nym/commit/aaf3dca5b999ad7f19d2ff170078b43c9c4476c2), [\#4737](https://github.com/nymtech/nym/commit/6f669866e92e637772726ad05caa5c5501a830f3)
-~~~admonish example collapsible=true title='Testing steps performed'
+}>
- Use [deadlinkchecker.com](https://www.deadlinkchecker.com/website-dead-link-checker.asp) to go over `nymtech.net` and correct all docs URLs
- Go over search engines and old medium articles and check that all dead URLs re-directing correctly
-~~~
+
* [Clarify syntax on `nym-nodes` ports on VPS setup page](https://nymtech.net/operators/nodes/vps-setup.html#configure-your-firewall), PR [\#4734](https://github.com/nymtech/nym/commit/5e6417f83788f30b2a84e4dd73d6dd9619a2bb16): Make crystal clear that the addresses and ports in operators `config.toml` must be opened using [`ufw`](https://nymtech.net/operators/nodes/vps-setup.html#configure-your-firewall) and set up as in the example below:
-~~~admonish example collapsible=true title='snap of binding addresses and ports in `config.toml`'
+
```toml
[host]
public_ips = [
-''
+''
]
[mixnet]
@@ -1160,7 +1173,7 @@ bind_address = '0.0.0.0:1790'
[entry_gateway]
bind_address = '0.0.0.0:9000'
```
-~~~
+
### Tooling
@@ -1178,10 +1191,10 @@ bind_address = '0.0.0.0:9000'
- [Release binaries](https://github.com/nymtech/nym/releases/tag/nym-binaries-v2024.8-wispa)
- [Release CHANGELOG.md](https://github.com/nymtech/nym/blob/nym-binaries-v2024.8-wispa/CHANGELOG.md)
-- [`nym-node`](nodes/nym-node.md) version `1.1.5`
+- [`nym-node`](nodes/nym-node.mdx) version `1.1.5`
-~~~admonish example collapsible=true title='CHANGELOG.md'
-- add event parsing to support cosmos_sdk > 0.50 ([#4697])
+
+- add event parsing to support cosmos_sdk to 0.50 ([#4697])
- Fix NR config compatibility ([#4690])
- Remove UserAgent constructor since it's weakly typed ([#4689])
- [bugfix]: Node_api_check CLI looked over roles on blacklisted nodes ([#4687])
@@ -1202,86 +1215,87 @@ bind_address = '0.0.0.0:9000'
[#4678]: https://github.com/nymtech/nym/pull/4678
[#4677]: https://github.com/nymtech/nym/pull/4677
[#4667]: https://github.com/nymtech/nym/pull/4667
-~~~
+
### Features
* [Default construct NodeRole](https://github.com/nymtech/nym/pull/4721): To preserve compatibility with newer clients interacting with older `nym-api`
-~~~admonish example collapsible=true title='Testing steps performed'
- 1. Reviewed the changes in the `nym-api-requests/src/models.rs` file.
- 2. Verified that the `NymNodeDescription` struct includes the new `role` field with a default value set by `default_node_role`.
- 3. Checked the implementation of the `default_node_role` function to ensure it returns `NodeRole::Inactive`.
- 4. Ran the updated code in the sandbox environment.
- 5. Monitored the sandbox environment for any issues or errors related to the changes.
+}>
+1. Reviewed the changes in the `nym-api-requests/src/models.rs` file.
+2. Verified that the `NymNodeDescription` struct includes the new `role` field with a default value set by `default_node_role`.
+3. Checked the implementation of the `default_node_role` function to ensure it returns `NodeRole::Inactive`.
+4. Ran the updated code in the sandbox environment.
+5. Monitored the sandbox environment for any issues or errors related to the changes.
- **Notes (if any):**
- The test was successful. No issues were flagged during the testing in the sandbox environment. The new default value for `NodeRole` ensures backward compatibility without causing disruptions.
-~~~
+**Notes (if any):**
+
+The test was successful. No issues were flagged during the testing in the sandbox environment. The new default value for `NodeRole` ensures backward compatibility without causing disruptions.
+
* [Default construct NodeRole for backwards compatibility (apply [\#4721](https://github.com/nymtech/nym/pull/4721) on develop)](https://github.com/nymtech/nym/pull/4722)
* [Add upgrades to `nym-node` for `authenticator` changes](https://github.com/nymtech/nym/pull/4703)
-~~~admonish example collapsible=true title='Testing steps performed'
- 1. Reviewed the changes in the `gateway/src/error.rs` and `gateway/src/node/mod.rs` files.
- 2. Verified the new error enum `AuthenticatorStartupFailure` was added to `GatewayError`.
- 3. Confirmed the implementation of the `StartedAuthenticator` struct and its usage in the `start_authenticator` function.
- 4. Ran the updated code in the canary environment.
- 5. Monitored the canary environment for any issues or errors related to the changes.
-~~~
+}>
+1. Reviewed the changes in the `gateway/src/error.rs` and `gateway/src/node/mod.rs` files.
+2. Verified the new error enum `AuthenticatorStartupFailure` was added to `GatewayError`.
+3. Confirmed the implementation of the `StartedAuthenticator` struct and its usage in the `start_authenticator` function.
+4. Ran the updated code in the canary environment.
+5. Monitored the canary environment for any issues or errors related to the changes.
+
-* [Add event parsing to support `cosmos_sdk` > `0.50`](https://github.com/nymtech/nym/pull/4697)
-~~~admonish example collapsible=true title='Testing steps performed'
- 1. Reviewed the changes in `common/client-libs/validator-client/src/nyxd/cosmwasm_client/client_traits/signing_client.rs`, `logs.rs`, `types.rs`, and `nym-api/src/coconut/tests/mod.rs` files.
- 2. Verified the addition of event parsing in the relevant functions and structs.
- 3. Ensured that the `find_attribute` function correctly parses event attributes.
- 4. Ran the updated code in the sandbox environment.
- 5. Broadcasted transactions on the sandbox network to test the changes.
- 6. Monitored the sandbox network for any malformed responses or errors after the test chain upgrade.
-~~~
+* [Add event parsing to support `cosmos_sdk` to `0.50`](https://github.com/nymtech/nym/pull/4697)
+}>
+1. Reviewed the changes in `common/client-libs/validator-client/src/nyxd/cosmwasm_client/client_traits/signing_client.rs`, `logs.rs`, `types.rs`, and `nym-api/src/coconut/tests/mod.rs` files.
+2. Verified the addition of event parsing in the relevant functions and structs.
+3. Ensured that the `find_attribute` function correctly parses event attributes.
+4. Ran the updated code in the sandbox environment.
+5. Broadcasted transactions on the sandbox network to test the changes.
+6. Monitored the sandbox network for any malformed responses or errors after the test chain upgrade.
+
* [Send bandwidth status messages when connecting](https://github.com/nymtech/nym/pull/4691): When connecting to the gateway we get received the available bandwidth left. Emit a status messages for this, for consumption by the application layer.
-~~~admonish example collapsible=true title='Testing steps performed'
- 1. Reviewed the changes in `common/bandwidth-controller/src/event.rs`, `common/bandwidth-controller/src/lib.rs`, and `common/client-libs/gateway-client/src/client.rs` files.
- 2. Verified the implementation of `BandwidthStatusMessage` enum for emitting status messages.
- 3. Ensured `GatewayClient` is updated to send bandwidth status messages when connecting.
- 4. Deployed the updated code on the canary environment.
- 5. Connected to the gateway and checked for the emission of bandwidth status messages.
- 6. Verified that the messages were correctly parsed and consumed by the application layer.
- 7. Ran the VPN client to observe the parsed events.
- ~~~
+}>
+1. Reviewed the changes in `common/bandwidth-controller/src/event.rs`, `common/bandwidth-controller/src/lib.rs`, and `common/client-libs/gateway-client/src/client.rs` files.
+2. Verified the implementation of `BandwidthStatusMessage` enum for emitting status messages.
+3. Ensured `GatewayClient` is updated to send bandwidth status messages when connecting.
+4. Deployed the updated code on the canary environment.
+5. Connected to the gateway and checked for the emission of bandwidth status messages.
+6. Verified that the messages were correctly parsed and consumed by the application layer.
+7. Ran the VPN client to observe the parsed events.
+
* [Fix NR config compatibility](https://github.com/nymtech/nym/pull/4690): Recently we deleted the old statistics service provider. This fixes some issues where old configs didn't work with the latest changes.
- Make NR able to read config with old keys in
- Remove deleted config keys from NR template
-~~~admonish example collapsible=true title='Testing steps performed'
- 1. Reviewed the changes in the `service-providers/network-requester/src/config/mod.rs` and `service-providers/network-requester/src/config/template.rs` files.
- 2. Ensured `NetworkRequester` config is able to read old keys for compatibility.
- 3. Removed old and deleted config keys from the `NetworkRequester` template.
- 4. Compiled the project to verify no issues or warnings appeared.
- 5. Ran all tests to ensure that the changes did not affect the functionality.
- 6. Validated that no leftover code from the old statistics service provider caused any issues.
- ~~~
+}>
+1. Reviewed the changes in the `service-providers/network-requester/src/config/mod.rs` and `service-providers/network-requester/src/config/template.rs` files.
+2. Ensured `NetworkRequester` config is able to read old keys for compatibility.
+3. Removed old and deleted config keys from the `NetworkRequester` template.
+4. Compiled the project to verify no issues or warnings appeared.
+5. Ran all tests to ensure that the changes did not affect the functionality.
+6. Validated that no leftover code from the old statistics service provider caused any issues.
+
* [Remove `UserAgent` constructor since it's weakly typed](https://github.com/nymtech/nym/pull/4689):
-~~~admonish example collapsible=true title='Testing steps performed'
- 1. Reviewed the changes in `common/http-api-client/src/user_agent.rs` file.
- 2. Verified the removal of the `UserAgent` constructor and ensured that all instances of `UserAgent::new` are updated accordingly.
- 3. Checked the implementation of `UserAgent` struct using `BinaryBuildInformation` and `BinaryBuildInformationOwned`.
- 4. Deployed the updated code across different environments (QA, sandbox, and canary).
- 5. Ran tests to ensure that the `UserAgent` struct functions correctly without the constructor.
- ~~~
+}>
+1. Reviewed the changes in `common/http-api-client/src/user_agent.rs` file.
+2. Verified the removal of the `UserAgent` constructor and ensured that all instances of `UserAgent::new` are updated accordingly.
+3. Checked the implementation of `UserAgent` struct using `BinaryBuildInformation` and `BinaryBuildInformationOwned`.
+4. Deployed the updated code across different environments (QA, sandbox, and canary).
+5. Ran tests to ensure that the `UserAgent` struct functions correctly without the constructor.
+
* [Add mixnodes to self describing api cache](https://github.com/nymtech/nym/pull/4684):
- Abstracts getting the self describing info a bit
- Adds mixnodes to the cache refresher as well
- Adds `role` field to the `NodeDescription` struct, to be able to distinguish between mixnodes and gateways
- Switched to using `NodeStatusCache` instead of `ContractCache`
-~~~admonish example collapsible=true title='Testing steps performed'
+}>
Called the new `/mixnodes/described` endpoint as well as the existing `/gateways/described` endpoint and verified that the data returned for each was correct based on the settings that different nodes have when they are setup.
For gateway endpoint, the “role” for now does not differentiate between entry and exit gateways, this will be implemented in the future.
-~~~
+
* [Move and whole bump of crates to workspace and upgrade some](https://github.com/nymtech/nym/pull/4680):
- Fix cargo warning for `default_features`
@@ -1291,57 +1305,57 @@ For gateway endpoint, the “role” for now does not differentiate between entr
- Use workspace `ed25519-dalek` dep
- Move `itertools` to workspace deps and upgrade
- Move a few partial deps to workspace while preserving versions
-~~~admonish example collapsible=true title='Testing steps performed'
- 1. Reviewed the changes to move and upgrade crates to the workspace.
- 2. Verified the updated dependencies:
- - Moved `dirs` to version 4.0 in the workspace.
- - Updated the `base64` dependency to use the workspace version.
- - Moved `rand_chacha` and `x25519-dalek` to the workspace.
- - Updated `ed25519-dalek` to use the workspace version.
- - Moved and upgraded `itertools` in the workspace.
- - Moved other partial dependencies to the workspace while preserving their versions.
- 3. Ensured the `Cargo.toml` files across the project reflect these changes correctly.
- 4. Compiled the entire project to check for any issues or warnings.
- 5. Verified that all tests pass successfully after the changes.
- ~~~
+}>
+1. Reviewed the changes to move and upgrade crates to the workspace.
+2. Verified the updated dependencies:
+ - Moved `dirs` to version 4.0 in the workspace.
+ - Updated the `base64` dependency to use the workspace version.
+ - Moved `rand_chacha` and `x25519-dalek` to the workspace.
+ - Updated `ed25519-dalek` to use the workspace version.
+ - Moved and upgraded `itertools` in the workspace.
+ - Moved other partial dependencies to the workspace while preserving their versions.
+3. Ensured the `Cargo.toml` files across the project reflect these changes correctly.
+4. Compiled the entire project to check for any issues or warnings.
+5. Verified that all tests pass successfully after the changes.
+
* [Remove `nym-network-statistics`](https://github.com/nymtech/nym/pull/4678): Remove `nym-network-statistics` service provider that is no longer used.
-~~~admonish example collapsible=true title='Testing steps performed'
- 1. Reviewed the project to identify all references to `nym-network-statistics`.
- 2. Removed all code and dependencies associated with `nym-network-statistics`.
- 3. Ensured that no references to `nym-network-statistics` remain in the codebase, including comments, imports, and configuration files.
- 4. Compiled the project to check for any issues or warnings.
- 5. Ran all tests to ensure the removal did not affect the functionality of the project.
- ~~~
+}>
+1. Reviewed the project to identify all references to `nym-network-statistics`.
+2. Removed all code and dependencies associated with `nym-network-statistics`.
+3. Ensured that no references to `nym-network-statistics` remain in the codebase, including comments, imports, and configuration files.
+4. Compiled the project to check for any issues or warnings.
+5. Ran all tests to ensure the removal did not affect the functionality of the project.
+
* [Remove code that refers to removed `nym-network-statistics`](https://github.com/nymtech/nym/pull/4679): Follow up to [\#4678](https://github.com/nymtech/nym/pull/4678) where all code interacting with it is removed.
-~~~admonish example collapsible=true title='Testing steps performed'
- 1. Reviewed the project to identify all references to `nym-network-statistics`.
- 2. Removed all code and dependencies associated with `nym-network-statistics`.
- 3. Ensured that no references to `nym-network-statistics` remain in the codebase, including comments, imports, and configuration files.
- 4. Compiled the project to check for any issues or warnings.
- 5. Ran all tests to ensure the removal did not affect the functionality of the project.
- ~~~
+}>
+1. Reviewed the project to identify all references to `nym-network-statistics`.
+2. Removed all code and dependencies associated with `nym-network-statistics`.
+3. Ensured that no references to `nym-network-statistics` remain in the codebase, including comments, imports, and configuration files.
+4. Compiled the project to check for any issues or warnings.
+5. Ran all tests to ensure the removal did not affect the functionality of the project.
+
* [Create `UserAgent` that can be passed from the binary to the `nym-api` client](https://github.com/nymtech/nym/pull/4677):
- Support setting `UserAgent` for the validator client
- Support setting `UserAgent` in the SDK `MixnetClient`
- - Set `UserAgent` when getting the list of gateways and topology in
+ - Set `UserAgent` when getting the list of gateways and topology in
- `nym-client`
- `nym-socks5-client`
- Standalone `ip-packet-router`
-~~~admonish example collapsible=true title='Testing steps performed'
+}>
Used the nym-vpn-cli to test this, and we can visibly see the `UserAgent`, no issues with the comments mentioned above.
Example of the user agent sent:
`nym-client/1.1.36/x86_64-unknown-linux-gnu/e18bb70`
-
+
Connected with no problems
-~~~
+
* [Add `authenticator`](https://github.com/nymtech/nym/pull/4667)
@@ -1356,11 +1370,11 @@ Connected with no problems
* [Extend ISP list](https://nymtech.net/operators/legal/isp-list.html)
* [Add SSL cert bot block to WSS setup](https://nymtech.net/operators/nodes/proxy-configuration.html#web-secure-socket-setup), [PR here](https://github.com/nymtech/nym/commits/develop/): WSS setup fully works!
* [Correct `HTTP API port` in bonding page](https://nymtech.net/operators/nodes/bonding.html#bond-via-the-desktop-wallet-recommended) , [PR \#4707](https://github.com/nymtech/nym/pull/4707): Change `HTTP API port` to `8080` on every `nym-node` by opening `config.toml` and making sure that your binding addresses and ports are as in the block below. Then go to desktop wallet and open the box called `Show advanced options` and make sure all your ports are set correctly (usually this means to change `HTTP api port` to `8080` for `mixnode` mode).
-~~~admonish example collapsible=true title='snap of binding addresses and ports in `config.toml`'
+
```toml
[host]
public_ips = [
-''
+''
]
[mixnet]
@@ -1376,7 +1390,7 @@ bind_address = '0.0.0.0:1790'
[entry_gateway]
bind_address = '0.0.0.0:9000'
```
-~~~
+
* [Comment our deprecated node pages in `/docs`](https://github.com/nymtech/nym/pull/4727)
- Fixes [issue \#4632](https://github.com/nymtech/nym/issues/4632)
@@ -1388,9 +1402,9 @@ bind_address = '0.0.0.0:9000'
- [Release binaries](https://github.com/nymtech/nym/releases/tag/nym-binaries-v2024.7-doubledecker)
- [Release CHANGELOG.md](https://github.com/nymtech/nym/blob/nym-binaries-v2024.7-doubledecker/CHANGELOG.md)
-- [`nym-node`](nodes/nym-node.md) version `1.1.4`
+- [`nym-node`](nodes/nym-node.mdx) version `1.1.4`
-~~~admonish example collapsible=true title='CHANGELOG.md'
+
- Add an early return in `parse_raw_str_logs` for empty raw log strings. ([#4686])
- Bump braces from 3.0.2 to 3.0.3 in /wasm/mix-fetch/internal-dev ([#4672])
- add expiry returned on import ([#4670])
@@ -1420,7 +1434,7 @@ bind_address = '0.0.0.0:9000'
[#4656]: https://github.com/nymtech/nym/pull/4656
[#4655]: https://github.com/nymtech/nym/pull/4655
[#4639]: https://github.com/nymtech/nym/pull/4639
-~~~
+
### Features
@@ -1452,10 +1466,10 @@ bind_address = '0.0.0.0:9000'
- [Release binaries](https://github.com/nymtech/nym/releases/tag/nym-binaries-v2024.6-chomp)
- [Release CHANGELOG.md](https://github.com/nymtech/nym/blob/nym-binaries-v2024.6-chomp/CHANGELOG.md)
-- [`nym-node`](nodes/nym-node.md) version `1.1.3`
+- [`nym-node`](nodes/nym-node.mdx) version `1.1.3`
- Standalone `nym-gateway` and `nym-mixnode` binaries are no longer released
-~~~admonish example collapsible=true title='CHANGELOG.md'
+
- Remove additional code as part of Ephemera Purge and SP and contracts ([#4650])
- bugfix: make sure nym-api can handle non-cw2 (or without detailed build info) compliant contracts ([#4648])
- introduced a flag to accept toc and exposed it via self-described API ([#4647])
@@ -1493,67 +1507,70 @@ bind_address = '0.0.0.0:9000'
[#4619]: https://github.com/nymtech/nym/pull/4619
[#4607]: https://github.com/nymtech/nym/pull/4607
[#4603]: https://github.com/nymtech/nym/pull/4603
-~~~
+
### Features
- [Make embedded NR/IPR ignore performance of the Gateway](https://github.com/nymtech/nym/pull/4671): fixes bug in relation to scoring issue on nym-nodes operating as exit gateways failing to come online.
- [Introduce a flag to accept Operators Terms and Conditions and exposed it via self-described API](https://github.com/nymtech/nym/pull/4647)
-~~~admonish example collapsible=true title='Testing steps performed'
+}>
- Verify that the `execute` function correctly checks if the `accept_operator_terms` flag is set.
- Test that a warning is displayed when the `accept_operator_terms` flag is not set.
- Confirm that the `NymNode` instance is initialized with `with_accepted_toc(accepted_toc)` when the flag is set.
- Apply the `--accept-toc` flag in the service and confirmed the change by running:
-```
+```sh
curl -s -X 'GET' 'http://18.171.251.41:8080/api/v1/auxiliary-details?output=json' -H 'accept: application/json' | jq .accepted_toc
```
- Verify that the output is `true`.
-~~~
+
- [Rename 'accept-toc' flag and fields into explicit 'accept-operator-terms-and-conditions'](https://github.com/nymtech/nym/pull/4654): makes the `accept-toc` flag more explicit.
- [Validate nym-node public ips on startup](https://github.com/nymtech/nym/pull/4630): makes sure `nym-node` is not run with an empty `public_ips` and that they do not correspond to common misconfigurations like `127.0.0.1` or `0.0.0.0` unless run with `--local` flag.
-~~~admonish example collapsible=true title='Testing steps performed'
+}>
- Use the latest release/chomp binary with nym-node and input a dodgy ip
-
+
+
- Validation:
-
+
+
+
When restarting the node it complains within the service launch file
-~~~
+
- [New node endpoints](https://github.com/nymtech/nym/pull/4635): introduces new endpoints on nym-api (and creates scaffolding for additional ones) for providing **unfiltered** network topology alongside performance score of all nodes.
- - `NymApiTopologyProvider` got modified to use those endpoints alongside (configurable) filtering of nodes with score < 50% (like our current blacklist)
+ - `NymApiTopologyProvider` got modified to use those endpoints alongside (configurable) filtering of nodes with score \< 50% (like our current blacklist)
- Old clients should work as before as no existing endpoint got removed
-~~~admonish example collapsible=true title='Testing steps performed'
+}>
- Validate that the `skimmed` endpoints are working, keeping in mind that they are unstable. The *full-fat* and *semi-skimmed* have not yet been implemented.
-~~~
+
- [Remove stale peers](https://github.com/nymtech/nym/pull/4640)
- [Removed ephemera code](https://github.com/nymtech/nym/pull/4642)
-~~~admonish example collapsible=true title='Testing steps performed'
+}>
- Check references to everything named SP and Ephemera and removed any additional references
-~~~
+
- [Remove additional code as part of Ephemera Purge and SP and contracts](https://github.com/nymtech/nym/pull/4650): in line with [#4642](https://github.com/nymtech/nym/pull/4642) and [#4603](https://github.com/nymtech/nym/pull/4603)
-~~~admonish example collapsible=true title='Testing steps performed'
+}>
- Check references to everything named SP and Ephemera and removed any additional references
-~~~
+
- [Add ci check for PR having an assigned milestone](https://github.com/nymtech/nym/pull/4644): add a CI check for checking that a PR is assigned to a milestone. Can bypassed the check by adding a `no-milestone` label to a PR
-~~~admonish example collapsible=true title='Testing steps performed'
+}>
- CI complains if no milestone is associated with the an issue.
-~~~
+
- [Bump defguard wireguard](https://github.com/nymtech/nym/pull/4625)
- [Add generic wireguard private network routing](https://github.com/nymtech/nym/pull/4636): as defguard wireguard only allows for peer routing modifications, we will configure the entire wireguard private network to be routed to the wg device. Configuring per peer is also not desirable, as the interface doesn't allow removing routes, so unused ip routing won't be cleaned until gateway restart (and it would also pollute to routing table with a lot of rules when many peers are added).
-~~~admonish example collapsible=true title='Testing steps performed'
+}>
- This is a part of a bigger ticket, but initial testing has proven to shown that launching nym-nodes (entry and exit gateways) in WG enable mode to be working
*QA will use this template for the other related WG tickets in this release milestone.*
-~~~
+
- [Standarise `ContractBuildInformation` and add it to all contracts](https://github.com/nymtech/nym/pull/4631): Similarly to `cw2`, we're now saving `ContractBuildInformation` under a constant storage key, i.e. `b"contract_build_info"` that standarises the retrieval by nym-api.
- Also each of our contracts now saves and updates that information upon init and migration.
-~~~admonish example collapsible=true title='Testing steps performed'
+}>
- Use the latest release/chomp contracts and deploy these to QA
- Use the `nym-api` to query for the results of these new contracts
@@ -1564,20 +1581,20 @@ When restarting the node it complains within the service launch file
```
- It returns a detailed view of the contracts and which branch they were built from, alongside rust versions and so forth.
-
-~~~
+
+
- [Update kernel peers on peer modification](https://github.com/nymtech/nym/pull/4622):
-~~~admonish example collapsible=true title='Testing steps performed'
+}>
- This is a part of a bigger ticket, but initial testing has proven to shown that launching nym-nodes (entry and exit gateways) in WG enable mode to be working.
*QA will use this template for the other related WG tickets in this release milestone.*
-~~~
+
- [Handle v6 and v7 requests in the IPR, but reply with v6](https://github.com/nymtech/nym/pull/4620): teach the IPR to read both v6 and v7 requests, but always reply with v6. This is to prepare for bumping to v7 and signed connect/disconnect messages. Follow up PRs will add
- Verify signature
- Send v7 in client with signatures included
- [Purge name service and service provider directory contracts](https://github.com/nymtech/nym/pull/4603): this is a compiler assisted purge of the `nym-name-service` and `nym-service-provider-directory` contracts that were never deployed on mainnet, and will anyhow be superseded by the new mixnode directory that is being worked on.
-~~~admonish example collapsible=true title='Testing steps performed'
+}>
It works insofar that it compiles, we need to deploy and test this on non-mainnet before merging in
- Purge `nym-name-service` contract
@@ -1589,55 +1606,55 @@ It works insofar that it compiles, we need to deploy and test this on non-mainne
Performed:
- Check references to everything named SP and Ephemera and removed any additional references
-~~~
+
### Crypto
- [Update crypto and rand crates](https://github.com/nymtech/nym/pull/4607): Update sphinx crate to `0.1.1` along with 25519 crates and `rand` crates
-~~~admonish example collapsible=true title="Comments"
+}>
This PR contains a test failure due to the update [here](https://github.com/nymtech/nym/blob/b4a0487a41375167b2f481c00917b957b9f89789/common/crypto/src/asymmetric/encryption/mod.rs#L353-L358)
- This is due a change in `x25519-dalek` from `1.1.1` to `2`.
- Crypto operations should be identical, but the byte representation has changed (sphinx clamps at creation, x25519 clamps at use). This cannot be changed in the sphinx crate without breaking changes.
- There is a good chance that this failure doesn't impact anything else, but it has to be tested to see.
- A mix of old and new clients with a mix of old and new mixnodes should do
-~~~
+
### Bugfix
- [Make sure nym-api can handle non-cw2 (or without detailed build info) compliant contracts](https://github.com/nymtech/nym/pull/4648): fixes the issue (even if some contracts aren't uploaded on chain it doesn't prohibit the api from working - caveat, the essential vesting and mixnet contract are required)
-~~~admonish example collapsible=true title='Testing steps performed'
+}>
- Use the latest release/chomp contracts and deploy these to QA
- If the contract was not found, the API would complain of invalid contracts, thus not starting the rest of the operations of the API (network monitor / rewarding etc)
- `Jun 11 16:27:34 qa-v2-nym-api bash[1352642]: 2024-06-11T16:27:34.551Z ERROR nym_api::nym_contract_cache::cache::refresher > Failed to refresh validator cache - Abci query failed with code 6 - address n14y2x8a60knc5jjfeztt84kw8x8l5pwdgnqg256v0p9v4p7t2q6eswxyusw: no such contract: unknown request`
-~~~
+ `Jun 11 16:27:34 qa-v2-nym-api bash[1352642]: 2024-06-11T16:27:34.551Z ERROR nym_api::nym_contract_cache::cache::refresher - Failed to refresh validator cache - Abci query failed with code 6 - address n14y2x8a60knc5jjfeztt84kw8x8l5pwdgnqg256v0p9v4p7t2q6eswxyusw: no such contract: unknown request`
+
- [Make sure to return an error on `nym-node` invalid public ip](https://github.com/nymtech/nym/pull/4646): bugfix for [#4630](https://github.com/nymtech/nym/pull/4630) that interestingly hasn't been detected by clippy.
-~~~admonish example collapsible=true title='Testing steps performed'
+}>
- Use the latest release/chomp binary with nym-node and input a dodgy ip
-
+
- Validation:
-
-~~~
+
+
- [Extend the return error when connecting to gateway fails](https://github.com/nymtech/nym/pull/4626)
-~~~admonish example collapsible=true title='Testing steps performed'
+}>
- Verify that the `establish_connection` function correctly attempts to establish a connection to the gateway.
- Test error handling for `NetworkConnectionFailed` by simulating a failed connection.
- Ensure that the `NetworkConnectionFailed` error includes the `address` and `source` details as expected.
- Checked that `SocketState::Available` is set correctly when a connection is successfully established.
-~~~
+
- [Fix Cargo warnings](https://github.com/nymtech/nym/pull/4624): On every cargo command we have the set warnings:
-~~~admonish example collapsible=true title="Cargo warnings"
+
warning: /home/alice/src/nym/nym/common/dkg/Cargo.toml: `default-features` is ignored for bls12_381, since `default-features` was not specified for `workspace.dependencies.bls12_381`, this could become a hard error in the future warning: /home/alice/src/nym/nym/common/dkg/Cargo.toml: `default-features` is ignored for ff, since `default-features` was not specified for `workspace.dependencies.ff`, this could become a hard error in the future warning: /home/alice/src/nym/nym/common/dkg/Cargo.toml: `default-features` is ignored for group, since `default-features` was not specified for `workspace.dependencies.group`, this could become a hard error in the future warning: /home/alice/src/nym/nym/common/client-libs/validator-client/Cargo.toml: `default-features` is ignored for bip32, since `default-features` was not specified for `workspace.dependencies.bip32`, this could become a hard error in the future warning: /home/alice/src/nym/nym/common/client-libs/validator-client/Cargo.toml: `default-features` is ignored for prost, since `default-features` was not specified for `workspace.dependencies.prost`, this could become a hard error in the future warning: /home/alice/src/nym/nym/common/credentials-interface/Cargo.toml: `default-features` is ignored for bls12_381, since `default-features` was not specified for `workspace.dependencies.bls12_381`, this could become a hard error in the future warning: /home/alice/src/nym/nym/common/credentials/Cargo.toml: `default-features` is ignored for bls12_381, since `default-features` was not specified for `workspace.dependencies.bls12_381`, this could become a hard error in the future warning: /home/alice/src/nym/nym/common/nymcoconut/Cargo.toml: `default-features` is ignored for bls12_381, since `default-features` was not specified for `workspace.dependencies.bls12_381`, this could become a hard error in the future warning: /home/alice/src/nym/nym/common/nymcoconut/Cargo.toml: `default-features` is ignored for ff, since `default-features` was not specified for `workspace.dependencies.ff`, this could become a hard error in the future warning: /home/alice/src/nym/nym/common/nymcoconut/Cargo.toml: `default-features` is ignored for group, since `default-features` was not specified for `workspace.dependencies.group`, this could become a hard error in the future.
-~~~
+
- This PR adds `default-features = false` to the workspace dependencies to fix these. An alternative way would be to remove `default-features = false` in the crates, but we assume these were put there for a good reason. Also we might have other crates outside of the main workspace that depends on these crates having default features disabled.
- We also have the warning `warning: profile package spec nym-wasm-sdk in profile release did not match any packages` which we fix by commenting out the profile settings, since the crate is currently commented out in the workspace crate list.
-~~~admonish example collapsible=true title='Testing steps performed'
+}>
- All binaries have been built and deployed from this branch and no issues have surfaced.
-~~~
+
### Operators Guide updates
@@ -1658,8 +1675,8 @@ warning: /home/alice/src/nym/nym/common/dkg/Cargo.toml: `default-features` is ig
- [Release binaries](https://github.com/nymtech/nym/releases/tag/nym-binaries-v2024.5-ragusa)
- [Release CHANGELOG.md](https://github.com/nymtech/nym/blob/nym-binaries-v2024.5-ragusa/CHANGELOG.md)
-- [`nym-node`](nodes/nym-node.md) version `1.1.2`
-~~~admonish example collapsible=true title='CHANGELOG.md'
+- [`nym-node`](nodes/nym-node.mdx) version `1.1.2`
+
- Feature/nym node api location ([#4605])
- Add optional signature to IPR request/response ([#4604])
- Feature/unstable tested nodes endpoint ([#4601])
@@ -1693,7 +1710,7 @@ warning: /home/alice/src/nym/nym/common/dkg/Cargo.toml: `default-features` is ig
[#4553]: https://github.com/nymtech/nym/pull/4553
[#4552]: https://github.com/nymtech/nym/pull/4552
[#4548]: https://github.com/nymtech/nym/pull/4548
-~~~
+
### Features
@@ -1703,15 +1720,17 @@ warning: /home/alice/src/nym/nym/common/dkg/Cargo.toml: `default-features` is ig
2. For new nodes: Initialise the node with `--location` flag, where they have to provide the country info. Either full country name (e.g. 'Jamaica'), two-letter alpha2 (e.g. 'JM'), three-letter alpha3 (e.g. 'JAM') or three-digit numeric-3 (e.g. '388') can be provided.
3. For existing nodes: It's also possible to use exactly the same `--location` argument as above, but make sure to also provide `--write-changes` (or `-w`) flag to persist those changes!
- [Feature/unstable tested nodes endpoint](https://github.com/nymtech/nym/pull/4601): Adds new data structures (`TestNode`, `TestRoute`, `PartialTestResult`) to handle test results for Mixnodes and Gateways. With the inclusion of pagination to handle large API responses efficiently. Lastly, introducing a new route with the tag `unstable` thus meaning not to be consumed without a user risk, prefixes in endpoints with unstable, are what it says on the tin.
-~~~admonish example collapsible=true title='Testing steps performed'
+}>
- Deploy new api changes to sandbox environment
- Ensure current operations are transactional and standed operations are working
- Run a script to ensure that the new endpoints are working as expected with pagination
- 
-~~~
+
+
+
+
- [`nym-api`: make report/avg_uptime endpoints ignore blacklist](https://github.com/nymtech/nym/pull/4599): When querying for node specific data, it's no longer going to go through the entire list of all cached (and filtered nodes) to find it; instead it will attempt to retrieve a single unfiltered entry.
-~~~admonish example collapsible=true title='Testing steps performed'
+}>
- Build the project and deployed it in a test environment.
- Manually test API endpoints for mixnode and gateway data.
- Verify that the endpoints return the expected data and handle blacklists correctly.
@@ -1721,11 +1740,11 @@ warning: /home/alice/src/nym/nym/common/dkg/Cargo.toml: `default-features` is ig
```sh
curl -X 'GET' 'https://validator.nymtech.net/api/v1/status/gateway/Fo4f4SQLdoyoGkFae5TpVhRVoXCF8UiypLVGtGjujVPf/avg_uptime' -H 'accept: application/json'
```
-~~~
+
- [Use rfc3339 for last_polled in described nym-api endpoint](https://github.com/nymtech/nym/pull/4591): Fix issue where the validator-client can't parse the nym-api response for the described endpoint, in particular the `latest_polled` field that was recently added, by making the field use `rfc3339`
- **Note:** This will require upgrading `nym-api` and everything that depends on the described endpoint.
-~~~admonish example collapsible=true title='Testing steps performed'
+}>
- Update a `nym-api` to the binary built from this branch, then restart the api
- Check the `journalctl` for error messages
- Connected via client and could not see the error messages, this is backwards compatible
@@ -1738,21 +1757,21 @@ cargo run --example simple
thread 'main' panicked at sdk/rust/nym-sdk/examples/simple.rs:9:64:
called Result::unwrap() on an Err value: ClientCoreError(ValidatorClientError(NymAPIError { source: ReqwestClientError { source: reqwest::Error { kind: Request, url: Url { scheme: "https", cannot_be_a_base: false, username: "", password: None,
```
-~~~
+
- [Upgrade `axum` and related dependencies to the most recent version](https://github.com/nymtech/nym/pull/4573)
- [Run cargo autoinherit on the main workspace](https://github.com/nymtech/nym/pull/4553): Move several dependencies to the workspace level using cargo autoinherit, to make it easier to keep our dependencies up to date.
- Run cargo autoinherit in the root
- Merge in the new workspace deps in the main list
- We made sure to not mix in other changes as well - all features flags for all crates should be the same as before
-~~~admonish example collapsible=true title='Testing steps performed'
+}>
- Run `cargo autoinherit` in the root directory to move dependencies to the workspace level
- Merge the new workspace dependencies into the main list
- Ensure no other changes were mixed in during the process
- Verify that all feature flags for all crates remained the same as before
- Build all the binaries from this branch to confirm successful compilation
- Deploy the built binaries across different environments to ensure there were no issues
-~~~
+
- [Add rustls-tls to reqwest in validator-client](https://github.com/nymtech/nym/pull/4552): An attempt to make possible to end up in a situation where use use the validator-client but without functioning TLS support. For the monorepo this is masked by cargo feature unification, but becomes a problem for outside consumers, as as been noticed in many of the vpn client implementations.
- In `validator-client`: `reqwest`, enable `rustls-tls` for `non-wasm32`
@@ -1762,17 +1781,17 @@ called Result::unwrap() on an Err value: ClientCoreError(ValidatorClientError(Ny
#### Crypto
- [Remove blocking for coconut in the final epoch state](https://github.com/nymtech/nym/pull/4598)
-~~~admonish example collapsible=true title='Testing steps performed'
+}>
- Build the project to ensure no compilation errors
- Run tests to verify the functionality of the `issue_credential` function
- Execute integration tests to check the behaviour during an epoch transition.
-~~~
+
- [Allow using explicit admin address for issuing freepasses](https://github.com/nymtech/nym/pull/4595)
- [Explicitly handle constraint unique violation when importing credential](https://github.com/nymtech/nym/pull/4588): Add a strong type for when a duplicate credential is imported so the vpn lib can handle this.
- [Feature/wasm coconut](https://github.com/nymtech/nym/pull/4584): This pull request requires [\#4585](https://github.com/nymtech/nym/pull/4585) to be merged first
- [Feature/nyxd scraper pruning](https://github.com/nymtech/nym/pull/4564): This PR introduces storage pruning to `nyxd` scraper which is then used by the validators rewarder.
-~~~admonish example collapsible=true title='Testing steps performed'
+}>
- Add a `main.rs` file in the `nyxd` scraper dir, underneath `lib.rs`, amend `config.pruning_options.validate()?;` to be `let _ = config.pruning_options.validate();` in the mod.rs file
- Test the different variations of `pruning_options`:
- Check the *default* option: `pruning_options: PruningOptions::default()`
@@ -1780,7 +1799,7 @@ called Result::unwrap() on an Err value: ClientCoreError(ValidatorClientError(Ny
- Check the *custom* option, example: `pruning_options: PruningOptions { keep_recent: (500), interval: (10), strategy: (PruningStrategy::Custom) }`
- Check the pruning *in real life* for the validator rewarder
- Validate that the database table `blocks` was being updated accordingly
-~~~
+
- [Feature/rewarder voucher issuance](https://github.com/nymtech/nym/pull/4548)
- Introduces signature checks on issued credential data
@@ -1791,12 +1810,12 @@ called Result::unwrap() on an Err value: ClientCoreError(ValidatorClientError(Ny
- [`noop` flag for `nym-api` for `nymvisor` compatibility](https://github.com/nymtech/nym/pull/4586)
- The application starts correctly and logs the starting message
- The `--no_banner` flag works as intended, providing compatibility with `nymvisor`
-~~~admonish example collapsible=true title='Testing steps performed'
+}>
- Build the project to ensure no compilation errors
- Run the binary with different command-line arguments to verify the CLI functionality
- Test with and without the `--no_banner` flag to ensure compatibility and expected behavior
- Verify logging setup and configuration file parsing
-~~~
+
### Operators Guide updates
@@ -1810,7 +1829,7 @@ called Result::unwrap() on an Err value: ClientCoreError(ValidatorClientError(Ny
## `v2024.4-nutella`
- [Merged PRs](https://github.com/nymtech/nym/milestone/59?closed=1)
-- [`nym-node`](nodes/nym-node.md) version `1.1.1`
+- [`nym-node`](nodes/nym-node.mdx) version `1.1.1`
- This release also contains: `nym-gateway` and `nym-network-requester` binaries
- core improvements on nym-node configuration
- Nym wallet changes:
@@ -1825,7 +1844,7 @@ called Result::unwrap() on an Err value: ClientCoreError(ValidatorClientError(Ny
## `v2024.3-eclipse`
- Release [Changelog.md](https://github.com/nymtech/nym/blob/nym-binaries-v2024.3-eclipse/CHANGELOG.md)
-- [`nym-node`](nodes/nym-node.md) initial release
+- [`nym-node`](nodes/nym-node.mdx) initial release
- New tool for monitoring Gateways performance [harbourmaster.nymtech.net](https://harbourmaster.nymtech.net)
- New versioning `1.1.0+nymnode` mainly for internal migration testing, not essential for operational use. We aim to correct this in a future release to ensure mixnodes feature correctly in the main API
- New [VPS specs & configuration](nodes/vps-setup.md) page
diff --git a/documentation/docs/pages/operators/nodes/nym-node/setup.mdx b/documentation/docs/pages/operators/nodes/nym-node/setup.mdx
index 083a868b90..f30f7523ad 100644
--- a/documentation/docs/pages/operators/nodes/nym-node/setup.mdx
+++ b/documentation/docs/pages/operators/nodes/nym-node/setup.mdx
@@ -3,7 +3,8 @@ import { Tabs } from 'nextra/components';
import { RunTabs } from 'components/operators/nodes/node-run-command-tabs';
import { VarInfo } from 'components/variable-info.tsx';
import { MigrateTabs } from 'components/operators/nodes/node-migrate-command-tabs';
-import BuildInfo from 'components/outputs/command-outputs/nym-node-build-info.md'
+import BuildInfo from 'components/outputs/command-outputs/nym-node-build-info.md';
+import { AccordionTemplate } from 'components/accordion-template.tsx';
# Nym Node Setup & Run