diff --git a/documentation/docs/pages/operators/changelog.mdx b/documentation/docs/pages/operators/changelog.mdx index c4c88b6812..85a4d21875 100644 --- a/documentation/docs/pages/operators/changelog.mdx +++ b/documentation/docs/pages/operators/changelog.mdx @@ -47,6 +47,177 @@ This page displays a full list of all the changes during our release cycle from +## `v2025.4-dorina` +- [Release Binaries](https://github.com/nymtech/nym/releases/tag/nym-binaries-v2025.4-dorina) +- [`nym-node`](nodes/nym-node.mdx) version `1.6.0` +```shell +Binary Name: nym-node +Build Timestamp: 2025-03-04T09:03:11.322601809Z +Build Version: 1.6.0 +Commit SHA: 7060fa6dad58f17543f5086c73b1854ad1ceae60 +Commit Date: 2025-03-03T17:24:10.000000000Z +Commit Branch: release/2025.4-dorina +rustc Version: 1.86.0-nightly +rustc Channel: nightly +cargo Profile: release +``` + +### Operators Updates & Tools + +- New advanced [guide to virtualise a dedicated server](nodes/preliminary-steps/vps-setup/advanced), providing steps for experienced operators and aspiring sys-admins who seek for higher optimisation and better efficiency of their work orchestrating multiple nodes. +- New Service Grant program is being implemented by operators setting up new ~150 Exit Gateways following the updated [specs for `nym-node`](nodes#minimum-requirements) + +### Features +- [Feature/chain status api](https://github.com/nymtech/nym/pull/5539): +this PR introduces `/v1/network/chain-status` endpoint on nym api to give basic information about the current block as seen by this API (with some caching) and updates `/health` endpoint to give stall information. + +- [Add SURBs soft threshold](https://github.com/nymtech/nym/pull/5535): the IPR should try to keep a buffer of available SURBs to reduce latency. + +- [Simplify IPR v8](https://github.com/nymtech/nym/pull/5532): purge stuff from IPR v8 to simplify; use protocol field in v8. + +- [Shared instance for DNS AsyncResolver](https://github.com/nymtech/nym/pull/5523): +make the `HickoryDnsResolver` use a shared instance by default to limit fd use. Now the multiple `nym_http_api_client::Client`s that get built should take advantage of a shared connection pool for DNS lookups. If for some reason a client does need an independent AsyncResolver this can still be done with the added `thread_resolver` function. + +- [cherry-pick 17d3ff2d775f61aee381d90a304ed416c08f33fc onto dorina](https://github.com/nymtech/nym/pull/5519) + +- [cherry-pick 6e5d0dac1b75413c5f09122b0d953f8ec6ef48df onto dorina](https://github.com/nymtech/nym/pull/5518) + +- [feat: add config option for maximum number of client connections](https://github.com/nymtech/nym/pull/5513) + +- [IPR request types v8](https://github.com/nymtech/nym/pull/5498): Bump IPR request/response types to v8 + +- [Support static routes for HTTP requests](https://github.com/nymtech/nym/pull/5487) + +- [added missing import to doctest](https://github.com/nymtech/nym/pull/5480) + +- [adjusted TestSetup::new_complex to ensure bonded node's existence](https://github.com/nymtech/nym/pull/5478) + +- [Trigger contracts CI on main workspace Cargo changes](https://github.com/nymtech/nym/pull/5477): since the contracts workspace depends on the common code in the main workspace, and since the contracts are critical to not have regressions in, trigger contracts CI on any changes to the workspace Cargo.toml and lock files. + +- [Run cargo autoinherit](https://github.com/nymtech/nym/pull/5460): run `cargo autoinherit` to move a bunch of dependencies to the workspace level. `Cargo.lock` remains untouched. + +- [Disable debug in wasm and wallet workflows too](https://github.com/nymtech/nym/pull/5459) + +- [Fix clippy::precedence](https://github.com/nymtech/nym/pull/5457): fix clippy warnings for the Rust beta toolchain. + +- [Provide Interval context with node descriptor endpoints](https://github.com/nymtech/nym/pull/5456): add current interval context information to existing enpoints using `build_skimmed_nodes_response` under the hood. This allows clients checking for a refresh to send the `epoch_uid` as a query parameter when fetching updates so the server can tell it that there have been no changes, instead of sending duplicate data over and over. The changes in this PR should be backwards compatible and never interfere with existing clients. The additions to the `NodeParams` are optional, so there is no error if a client does not send them. Old clients will not send `epoch_uid` by accident so they cannot accidentally clear their set of known nodes. In the response the status field is optional so if it is missing (e.g. if a new client talks to an old server) the connection still works. For old clients speaking to new servers, the json parsing will simply ignore extra information not included in the objects json spec. + +}> + + Made a request to the `/api/v1/unstable/nym-nodes/semi-skimmed` endpoint: + - without entering an epoch_id + - with entering the current epoch_id + - with entering an old epoch_id + - with entering a future epoch_id + All results returned the same data, as expected + + + +- [Feature/add gbp currency](https://github.com/nymtech/nym/pull/5453) + +- [Add helper to extract a list of sqlite files with journal files wal/shm](https://github.com/nymtech/nym/pull/5452) + +- [Add a middleware layer to the nym api allowing for data compression](https://github.com/nymtech/nym/pull/5451): after Testing in a minimal example, this does work as expected. Routes still default to plain encoding, however if a client indicates support for a compressed encoding using the `Accept-Encoding` header then the served response will be compressed with the appropriate `Content-Encoding` header. ([Proof-of-Concept](https://gist.github.com/jmwample/c15a983e804fc338fee3d1b037d216b0)) + +}> + Sent requests with and without Accept-Encoding: gzip to observe response behaviour + Verified if responses included content-encoding: gzip when compression was requested + Checked response file output to confirm actual compression occurred + + +- [Condense core API functionalities and enable gzip decompression for reqwest payloads](https://github.com/nymtech/nym/pull/5450): this PR is intended to take out variables from our usage of HTTP requests in the `nym-http-api-client`. To do this the PR: (1) adds the `ApiClientCore` trait with the minimal feature required to send a request, (2) turns all request sending into trait extension automatically implemented for any type that implements `ApiClientCore`. This has the benefit of consistent expected behavior for all clients using `nym-http-api-client`, including features added going forward. FOR EXAMPLE this pr adds a default header `"accept-encoding: gzip;q=1.0, *;q=0.5"` which indicates that compression is preferred whenever available. Other features to keep in mind here are things like configurable retries, domain fallbacks, etc. Note: the `Apiclient` interface could be simplified, but that would require refactoring our downstream usages of the API. For now this isn't necessary as `ApiClient` is implemented automatically so it costs nothing to have it this way. It just allows divergent usage in downstream crates. + +}> + Measured nym-api response times before and after updating the API client using curl + Checked if the client automatically decompressed Gzip responses + + +- [Seedable clients](https://github.com/nymtech/nym/pull/5440): Adds `DerivationMaterial` and accompanying methods to builders. `DerivationMaterial` encapsulates parameters for deterministic key derivation using HKDF (SHA-512). Use the `derive_secret()` method to generate a 32-byte secret. To prepare for a new derivation, call the `next()` method which increments the index. **It is the caller's responsibility to track and persist the derivation index if keys need to be rederived.** + + + + ```rust + let master_key = [0u8; 32]; // your secret master key + let salt = "unique-salt-value".to_string(); + let material = DerivationMaterial::new(master_key, 0, salt.as_bytes()); + + // Derive a secret + let secret = material.derive_secret().expect("Failed to derive secret"); + + // Prepare for the next derivation + let next_material = material.next(); + ``` + + + +- [Remove all recv_with_delay and add shutdown condition to loops in client-core](https://github.com/nymtech/nym/pull/5435): inside client-core we want to prepare the ground for moving a behaviour close to what we have in the vpn client. Remove all the recv_with_delay since we want to just stop. Add shutdown condition to all select loops to guard against the shutdown listener being polled inside the select blocks. Remove unwraps when sending on unbounded channels in case the receiver exits before the sender. Move `TaskClient` to be a member field so make it easier to wrap log errors in a shutdown check. Update all fork names to use underscore consistently, since the task separator is hyphen + +}> + Validated that all binaries including `nym-node`, `nym-client`, `nym-network-requester`, and `nym-socks5-client` are behaving well without indicating the presence of any unexpected errors or crashes + + +- [Disable the test for checking the remaining bandwidth in nym-node-status-api](https://github.com/nymtech/nym/pull/5425): this check fails almost every time on CI, possibly due to rate limiting? It's not good to disable the check, but it's blocking CI as it stands now. Given that we have the check above for locating the ip, we at least have a little coverage. + +- [Dz nym node stats](https://github.com/nymtech/nym/pull/5418): removed obsolete fields from stats (blacklisted mixnodes, blacklisted gateways, bonded mixnodes, bonded gateways). Introduced nym-node scraping, beside just mixnodes. `/mixnodes/stats` now returns data for nym-nodes as well, which results in much more accurate "packets mixed" stats. + +- [Nymnode entrypoint docker](https://github.com/nymtech/nym/pull/5300) + +### Bugfix +- [bugfix: dont query for ecash apis unless necessary when spending ticketbooks](https://github.com/nymtech/nym/pull/5508) + +- [bugfix: bound check when recovering a reply SURB](https://github.com/nymtech/nym/pull/5502) + +- [fix: update fx average rate calcs to ignore 0 values](https://github.com/nymtech/nym/pull/5454) + +### Chore +- [chore: workspace global panic preventing lints](https://github.com/nymtech/nym/pull/5512) + +- [chore: removed all old coconut code](https://github.com/nymtech/nym/pull/5500) + +- [build(deps): bump the patch-updates group across 1 directory with 3 updates](https://github.com/nymtech/nym/pull/5482): updates `clap` from 4.5.28 to 4.5.30, updates `clap` from 4.5.28 to 4.5.30, updates `prost` from 0.13.4 to 0.13.5. + +- [build(deps): bump http from 1.1.0 to 1.2.0](https://github.com/nymtech/nym/pull/5472) + +- [build(deps): bump utoipa-swagger-ui from 8.0.3 to 8.1.0](https://github.com/nymtech/nym/pull/5471) + +- [build(deps): bump colored from 2.1.0 to 2.2.0](https://github.com/nymtech/nym/pull/5470) + +- [build(deps): bump celes from 2.4.0 to 2.5.0](https://github.com/nymtech/nym/pull/5469) + +- [build(deps): bump the patch-updates group with 2 updates](https://github.com/nymtech/nym/pull/5467): updates `clap` from 4.5.28 to 4.5.29, updates `prost` from 0.13.4 to 0.13.5. + +- [build(deps): bump elliptic from 6.5.4 to 6.6.1 in /docker/typescript_client/upload_contract](https://github.com/nymtech/nym/pull/5463): bumps [elliptic](https://github.com/indutny/elliptic) from 6.5.4 to 6.6.1. + +- [build(deps): bump uniffi_build from 0.25.3 to 0.29.0](https://github.com/nymtech/nym/pull/5448) + +- [Upgrade tower to 0.5.2](https://github.com/nymtech/nym/pull/5446) + +- [build(deps): bump hickory-proto from 0.24.2 to 0.24.3 in /nym-wallet](https://github.com/nymtech/nym/pull/5445) + +- [build(deps): bump hickory-proto from 0.24.2 to 0.24.3](https://github.com/nymtech/nym/pull/5444) + +- [build(deps): bump the patch-updates group across 1 directory with 10 updates](https://github.com/nymtech/nym/pull/5439): +Bumps the patch-updates group with 10 updates in the directory: + +| Package | From | To | +| --- | --- | --- | +| [async-trait](https://github.com/dtolnay/async-trait) | `0.1.85` | `0.1.86` | +| [clap](https://github.com/clap-rs/clap) | `4.5.27` | `4.5.28` | +| [comfy-table](https://github.com/nukesor/comfy-table) | `7.1.3` | `7.1.4` | +| [hickory-resolver](https://github.com/hickory-dns/hickory-dns) | `0.24.2` | `0.24.3` | +| [once_cell](https://github.com/matklad/once_cell) | `1.20.2` | `1.20.3` | +| [pin-project](https://github.com/taiki-e/pin-project) | `1.1.8` | `1.1.9` | +| [serde_json_path](https://github.com/hiltontj/serde_json_path) | `0.7.1` | `0.7.2` | +| [toml](https://github.com/toml-rs/toml) | `0.8.19` | `0.8.20` | +| [cosmrs](https://github.com/cosmos/cosmos-rust) | `0.21.0` | `0.21.1` | +| [tokio-postgres](https://github.com/sfackler/rust-postgres) | `0.7.12` | `0.7.13` | + +- [build(deps): bump openssl from 0.10.56 to 0.10.70 in /nym-wallet](https://github.com/nymtech/nym/pull/5422) + +- [build(deps): bump hyper from 1.4.1 to 1.6.0](https://github.com/nymtech/nym/pull/5416) + +- [build(deps): bump publicsuffix from 2.2.3 to 2.3.0](https://github.com/nymtech/nym/pull/5367) + ## `v2025.3-ruta` - [Release Binaries](https://github.com/nymtech/nym/releases/tag/nym-binaries-v2025.3-ruta) @@ -97,7 +268,7 @@ As we announced in [`hu` release notes](#service-grant-program-v2), we are opene ##### Locations -These locations and slots are approximate and constantly change based on new operators submissions. Please keep in mind that we are going to chose people with respect to empty slots in the given location at the time of their submission. In case of competing submissions in the same location we will take the one with better specs vs price ratio. +These locations and slots are approximate and constantly change based on new operators submissions. Please keep in mind that we are going to chose people with respect to empty slots in the given location at the time of their submission. In case of competing submissions in the same location we will take the one with better specs vs price ratio. | LOCATION | SLOTS | | :-- | --: | @@ -151,7 +322,7 @@ These locations and slots are approximate and constantly change based on new ope - [Send shutdown instead of panic when reaching max fail](https://github.com/nymtech/nym/pull/5398): Remove a panic and an unwrap inside `client-core` that is hit occasionally in the vpn client. This is a change that can have wide ranging impact since it changes the task handling and it's inside `client-core`, which is used in many components and services, so preventing regressions is important. -- [Relocate a validator api function](https://github.com/nymtech/nym/pull/5401): Adds a function to the `nym-validator-client` crate that hits the network details endpoint and returns an object parsed from `json`. This was floating loose in the `nym-vpn-client` repo. +- [Relocate a validator api function](https://github.com/nymtech/nym/pull/5401): Adds a function to the `nym-validator-client` crate that hits the network details endpoint and returns an object parsed from `json`. This was floating loose in the `nym-vpn-client` repo. - [Bump the patch-updates group across 1 directory with 9 updates](https://github.com/nymtech/nym/pull/5406) @@ -199,7 +370,7 @@ From `nym-node v1.3.0` operators can technically choose multiple functionalities - Updated maintenance guides to [backup](nodes/maintenance#backup-a-node), [restore](nodes/maintenance#restoring-a-node) and [move](nodes/maintenance#moving-a-node) a node, containing a new and important commands to backup and restore `clients.sqlite` database. -- [New explanation of `nym-node` functionalities](nodes/nym-node/setup#functionality-mode) describing how Gateways get selected in Mixnet mode and Wireguard mode. +- [New explanation of `nym-node` functionalities](nodes/nym-node/setup#functionality-mode) describing how Gateways get selected in Mixnet mode and Wireguard mode. Wireguard nodes route data directly to the open internet. Therefore it exposes IP of operators server (VPS) to abuse complains. Before you decide to run a node with active wireguard routing, please read our [Community Counsel pages](community-counsel/exit-gateway) containing more information and some legal content. @@ -223,7 +394,7 @@ We have been notified that a handful of nodes have been taken down by abuse repo - Join [Community legal counsel](https://nym.com/docs/operators/community-counsel) - our collective knowledge hub. Add your findings by opening a [Pull Request](https://nym.com/docs/operators/add-content) - While we are working on a new list of more friendly providers, consider to move away from these provides as soon as possible: - + - Servinga / VPS2day (AS39378) - Frantech / Ponynet / BuyVM (AS53667) - OVH SAS / OVHcloud (AS16276) @@ -233,7 +404,7 @@ We have been notified that a handful of nodes have been taken down by abuse repo - Psychz Networks (AS40676) - 1337 Services GmbH / RDP.sh (AS210558) -- Backup your nodes to have access to `.nym` directory locally. Follow [node](nodes/maintenance#backup-a-node) and [proxy configuration](nodes/maintenance#backup-proxy-configuration) backup guides to be able to [restore your node](nodes/maintenance#restoring-a-node) later on on another machine, without losing your delegation. +- Backup your nodes to have access to `.nym` directory locally. Follow [node](nodes/maintenance#backup-a-node) and [proxy configuration](nodes/maintenance#backup-proxy-configuration) backup guides to be able to [restore your node](nodes/maintenance#restoring-a-node) later on on another machine, without losing your delegation. - We would like to ask operators who use reverse proxy and a domain (required for Gateways) to start using a common convention starting with `nym-exit` for their nodes URL. The entire address should have this new format: ``` @@ -258,7 +429,7 @@ nym-exit.mysquad.org **The `NYM-EXIT` part in the beginning is what's important.** -- When registering a domain, check [Top Level Domain (TLD)](https://www.techopedia.com/definition/1348/top-level-domain-tld) terms and conditions. For example `.icu` is a no go. Having a wrong TLD may lead to your domain being taken away from you when facing a DMCA report. +- When registering a domain, check [Top Level Domain (TLD)](https://www.techopedia.com/definition/1348/top-level-domain-tld) terms and conditions. For example `.icu` is a no go. Having a wrong TLD may lead to your domain being taken away from you when facing a DMCA report. - Write a message to your provider and introduce your intention to run a Nym Node on their service @@ -322,7 +493,7 @@ Undelegated due to high saturation: #### Service Grant Program v2 -Aside from delegating on top of nodes, Nym runs a Service Grant Program (SGP) to support Exit Gateway operators before they will be rewarded by collecting [zk-nym tickets](../network/cryptography/zk-nym) from users subscription. Operators included in SGP are long term active community members with the highest requirements on the technical setup and upgrading pace. We are about to start a second iteration of SGP very soon (SGPv2). The final slots and locations are yet to be concluded. Priority to participate in SGPv2 will be given to the current operators in SGP. Based on the number of slots, we will then determine how many more operators can sign up. +Aside from delegating on top of nodes, Nym runs a Service Grant Program (SGP) to support Exit Gateway operators before they will be rewarded by collecting [zk-nym tickets](../network/cryptography/zk-nym) from users subscription. Operators included in SGP are long term active community members with the highest requirements on the technical setup and upgrading pace. We are about to start a second iteration of SGP very soon (SGPv2). The final slots and locations are yet to be concluded. Priority to participate in SGPv2 will be given to the current operators in SGP. Based on the number of slots, we will then determine how many more operators can sign up. ##### Rules of SGPv2 @@ -330,7 +501,7 @@ Aside from delegating on top of nodes, Nym runs a Service Grant Program (SGP) to **We will share more info soon in the channels. The rules are not set in stone and could potentially be altered or updated in the future! Do *not* purchase new servers neither migrate your nodes just yet.** -As we finalising last details of *"Project Smoosh"*, where one binary - `nym-node` - can run as an `entry-gateway`, `mixnode` or `exit-gateway` in Mixnet mode as well as `entry-gateway` or `exit-gateway` in Wireguard mode, we plan to step up the game. SGPv2 grants will be higher if operators can meet new requirements. +As we finalising last details of *"Project Smoosh"*, where one binary - `nym-node` - can run as an `entry-gateway`, `mixnode` or `exit-gateway` in Mixnet mode as well as `entry-gateway` or `exit-gateway` in Wireguard mode, we plan to step up the game. SGPv2 grants will be higher if operators can meet new requirements. **Minimum Specs & Requirements** @@ -402,7 +573,7 @@ These are minimum requirements to become a part of SGPv2. We aim to have nodes o - [build(deps): bump criterion from `0.4.0` to `0.5.1`](https://github.com/nymtech/nym/pull/4911): Bumps [criterion](https://github.com/bheisler/criterion.rs) from `0.4.0` to `0.5.1`. -- [NS API: add mixnet scraper](https://github.com/nymtech/nym/pull/5200) +- [NS API: add mixnet scraper](https://github.com/nymtech/nym/pull/5200) - [build(deps): bump http from `1.1.0` to `1.2.0`](https://github.com/nymtech/nym/pull/5228): Bumps [http](https://github.com/hyperium/http) from `1.1.0` to `1.2.0`. @@ -410,41 +581,41 @@ These are minimum requirements to become a part of SGPv2. We aim to have nodes o - [Add windows to CI builds](https://github.com/nymtech/nym/pull/5269) -- [nym topology revamp](https://github.com/nymtech/nym/pull/5271): This PR changes the internals of the `NymTopology` to blur the lines between explicit mixnodes and gateways so that what used to be considered a "mixnode" could be a valid egress point of the network. `NymTopology` is no longer divided into `BTreeMap>` and `Vec`. instead there's information about the current rewarded set (to support future VRF work) and a simple map of `HashMap`. The new features are mostly controlled via 2 new flags/config values: +- [nym topology revamp](https://github.com/nymtech/nym/pull/5271): This PR changes the internals of the `NymTopology` to blur the lines between explicit mixnodes and gateways so that what used to be considered a "mixnode" could be a valid egress point of the network. `NymTopology` is no longer divided into `BTreeMap>` and `Vec`. instead there's information about the current rewarded set (to support future VRF work) and a simple map of `HashMap`. The new features are mostly controlled via 2 new flags/config values: - `use_extended_topology` that tells the client to retrieve **all** network nodes rather than the ones that got assigned "active" mixnode role (or support being a gateway) - `ignore_egress_epoch_role` that tells the client it's fine to construct egress packets to nodes that are **not** assigned entry or exit gateway role - + - [Nyx Chain Watcher](https://github.com/nymtech/nym/pull/5274) - [Include `IPINFO_API_TOKEN` in nightly CI](https://github.com/nymtech/nym/pull/5285) -- [Move tun constants to network defaults](https://github.com/nymtech/nym/pull/5286): +- [Move tun constants to network defaults](https://github.com/nymtech/nym/pull/5286): }> 1. **Regression Testing**: -- Verified no issues arose when running tests for the affected files. -- Tested TUN behaviour with new nym-nodes in the hu branch. - -**Results**: +- Verified no issues arose when running tests for the affected files. +- Tested TUN behaviour with new nym-nodes in the hu branch. -- **No bugs detected**. -- Tunnels are functioning as expected, with traffic routing and IP generation working seamlessly. - +**Results**: + +- **No bugs detected**. +- Tunnels are functioning as expected, with traffic routing and IP generation working seamlessly. + - [Add dependabot assignes for the root cargo ecosystem](https://github.com/nymtech/nym/pull/5297) - [build(deps): bump the patch-updates group across 1 directory with 35 updates](https://github.com/nymtech/nym/pull/5310): Bumps the `patch-updates` group with 33 updates -- [Periodically remove stale gateway messages](https://github.com/nymtech/nym/pull/5312): This PR introduces a simple task that removes gateway messages that haven't been retrieved in (by default) 24h. +- [Periodically remove stale gateway messages](https://github.com/nymtech/nym/pull/5312): This PR introduces a simple task that removes gateway messages that haven't been retrieved in (by default) 24h. }> **Automation Script for Data Cleanup Validation** Test Objective: Validate that the stale message cleanup mechanism in the database correctly removes records older than the configured threshold (24 hours). - + Test Setup: 1. Environment: * SQLite database * Bash script: used to insert data. - + Steps Performed: 1. Ran the insert_data.sh script to populate the database with test data: * Recent records inserted successfully. @@ -452,8 +623,8 @@ Steps Performed: 3. Confirmed that all 20 records (10 recent + 10 stale) were present. 4. Allowed the system to run for 24 hours to trigger the cleanup mechanism. 5. Queried the database again after 24 hours: sqlite3 gateway_storage.db "SELECT * FROM message_store;" -6. - +6. + Expected Result: * All stale records (older than 24 hours) should be removed. * Recent records should remain in the database. @@ -464,18 +635,18 @@ Actual Result: - [Use expect in geodata test to give error message on failure](https://github.com/nymtech/nym/pull/5314): Keep hitting this error on CI, from what I think is network hickup. But it's hard to tell form the log since the error is swallowed. Explicitly unwrap the result so we get a more detailed error output. }> -**Quick Code Review** - -**Summary** +**Quick Code Review** + +**Summary** 1. **CI Workflow**: Adjusted paths to optimise build triggers, avoiding unnecessary CI runs while ensuring coverage for key directories 2. **Geolocation Test**: Improved error handling by replacing assertions with `.expect` for clearer debugging in API regression tests - -**Conclusion** + +**Conclusion** Regression testing confirms everything works as intended. **Approved**. -- [`CancellationToken`-based shutdowns](https://github.com/nymtech/nym/pull/5325): This PR introduces scaffolding for using `CancellationToken` and `TaskTracker` for our graceful shutdowns rather than the existing `TaskClient` and `TaskManager`. +- [`CancellationToken`-based shutdowns](https://github.com/nymtech/nym/pull/5325): This PR introduces scaffolding for using `CancellationToken` and `TaskTracker` for our graceful shutdowns rather than the existing `TaskClient` and `TaskManager`. - [Introduce `/load` endpoint for self-reported quantised Nym Node load](https://github.com/nymtech/nym/pull/5326): This PR introduces a new `/load` endpoint on a `NymNode` to return its current load. It returns the following data: ```rust @@ -505,7 +676,7 @@ The actual values for`NodeLoad` are determined as follows: - Thus we calculate two additional auxiliary `Load` values, for memory usage and swap usage, i.e.: `used_memory / total_memory` and `used_swap / total_swap` respectively. - Then we check whether either of the `MemoryLoad` or `SwapLoad` is bigger than the current base `Load` of the machine we have determined, if so, it's increased by one tier / bucket. For example, say the current machine load is `Load::Low`, but the memory usage is at 90% (`Load::VeryHigh`). that would result in the reported `Load` being bumped up to `Load::Medium` instead. The same logic applies with swap load, **however, only if the total swap > 1GB**. this is to prevent weird edge cases where the machine has hardly any swap. - Finally, the `.total` `Load` uses the same "tier bumping" behaviour using the `.total` and `.network` loads, i.e. `if network > machine`, then `total = machine + 1`. for example if `machine` `Load` is `Load::Low`, but `network` `Load` is `Load::Medium`, then the `total` `Load` is set to `Load::Medium` instead. - + - [Bump the `patch-updates` group with 8 updates](https://github.com/nymtech/nym/pull/5336) @@ -517,29 +688,29 @@ The actual values for`NodeLoad` are determined as follows: - [Bump mikefarah/yq from `4.44.6` to `4.45.1`](https://github.com/nymtech/nym/pull/5342) -- [Update `indexed_db_futures`](https://github.com/nymtech/nym/pull/5347): Updates the `indexed_db_futures` dependency to stop relying on the fork. +- [Update `indexed_db_futures`](https://github.com/nymtech/nym/pull/5347): Updates the `indexed_db_futures` dependency to stop relying on the fork. - [Refresh wasm sdk](https://github.com/nymtech/nym/pull/5353): This PR refreshes the wasm clients to make them usable in the current network - [Client gateway selection](https://github.com/nymtech/nym/pull/5358): Changed how gateway is selected. - For init the target gateway can't support mixing - For egress, unless `ignore_epoch_roles` is specified, the gateway can't be currently assigned to a mixing layer. But it can be standby or inactive - + - [Exposed `NymApiClient` method for obtaining node performance history](https://github.com/nymtech/nym/pull/5360) - [Bind to `[::]` on `nym-node` for both IP versions](https://github.com/nymtech/nym/pull/5361) }> **IPv4 Configuration and Migration Testing** - + Testing Steps: - Initiated and ran a nym-node with version 1.3.1 on an IPv4-only machine, then updated it to the new 'hu', 1.4.0 version. - Initiated and ran a new nym-node with 'hu', 1.4.0 always on a machine with only IPv4. - Initiated and ran a new nym-node with 'hu', 1.4.0 on a machine with both IPv4 and IPv6 for regression testing. - + Results: - No functional issues during version updates. - Logged message on all versions: "no registered client for destination: ff02::2" - + Status: Pass @@ -554,10 +725,10 @@ Status: Pass - Ensured a client is able to select a node which aside from a gateway, can also act as a mixnode - Verified 'ignore_epoch_roles' is the default mode - _note; this is most likely not going to be a permanent solution_ - + **Results:** -- Clients and topology are behaving correctly - +- Clients and topology are behaving correctly + Status: Pass @@ -612,7 +783,7 @@ We are developing a design where operators can enable multiple modes, and let th - Moved top level `authenticator` section to `service_providers` so that it'd live alongside NR and IPR - Added general `debug` section - Added `metrics` section -- All documentation migrated to a new URL [nym.com/docs](https://nym.com/docs) alongside the rebranding of Nym organisation. +- All documentation migrated to a new URL [nym.com/docs](https://nym.com/docs) alongside the rebranding of Nym organisation. - Updated [network architecture diagrams](https://nym.com/docs/network/architecture) - New blow-by-blow mixnet [traffic flow](https://nym.com/docs/network/architecture) section - [Winter Nym Squad League started](https://forum.nym.com/t/nym-squad-league-farewell-fall-welcome-winter/977) @@ -648,11 +819,11 @@ We are developing a design where operators can enable multiple modes, and let th - Everything in `mixnode` directory has been removed because there was nothing really left there. The mixing socket listener was unified in `nym-node` and similarly `verloc` was also moved there - `gateway` directory was similarly reduced in size. Now it also creates appropriate tasks as opposed to the whole gateway process. eventually it might also be further stripped, but today is not that day. - Removed the generic parameter on the `GatewayStorage` to simplify all the generics down the stack. it wasn't used anyway - + CLI: - Added `--modes` argument to specify all node modes with a single command (or `env` variable). for example: `--modes="mixnode,entry"`. Can't be used alongside `--modes` - Extended `--mode` argument to allow specifying it multiple times, for example: `--mode mixnode --mode entry`. can't be used alongside `--mode` - + Config changes: - Replaced `mode` with `modes` to allow setting the node to run with say, `entry` + `mixnode` roles simultaneously - Added `maximum_forward_packet_delay` to `mixnet.debug` section @@ -677,17 +848,17 @@ Config changes: - [Remove unneeded async function annotation](https://github.com/nymtech/nym/pull/5246) - [Add control messages to `GatewayTransciver`](https://github.com/nymtech/nym/pull/5247) }> -**Review and Testing: Forget Me Implementation** +**Review and Testing: Forget Me Implementation** -- Validated the encryption and delivery of `ForgetMe` control messages to the gateway - -**Testing: MixTrafficController Integration** +- Validated the encryption and delivery of `ForgetMe` control messages to the gateway -- Verified that the `MixTrafficController` invokes `ForgetMe` logic correctly during shutdown -- Tested behaviour for gateway transceiver failures while sending control messages - -**Testing: Gateway Storage Updates** -- Confirmed successful deletion of client data (e.g., inbox messages, bandwidth allocations) from persistent storage +**Testing: MixTrafficController Integration** + +- Verified that the `MixTrafficController` invokes `ForgetMe` logic correctly during shutdown +- Tested behaviour for gateway transceiver failures while sending control messages + +**Testing: Gateway Storage Updates** +- Confirmed successful deletion of client data (e.g., inbox messages, bandwidth allocations) from persistent storage - [Add conversion unit tests for auth msg](https://github.com/nymtech/nym/pull/5251) @@ -704,13 +875,13 @@ Config changes: }> 1. **Review File: `common/credential-storage/src/backends/sqlite.rs`** - Verified addition of `close` method for the SQLite backend - + 2. **Review File: `common/credential-storage/src/ephemeral_storage.rs`** - Confirmed addition of `close` method for ephemeral storage with no action required - + 3. **Review File: `common/credential-storage/src/persistent_storage/mod.rs`** - Ensured `close` method integration for persistent storage - + 4. **Review File: `common/credential-storage/src/storage.rs`** - Verified updates to the `Storage` trait to include `close` and `cleanup_expired` methods @@ -719,15 +890,15 @@ Config changes: }> 1. **Review File: `common/network-defaults/src/constants.rs`** - Confirmed updated `mixnet_vpn` constants were added. - + 2. **Review File: `service-providers/ip-packet-router/src/constants.rs`** - Checked replacement of legacy `TUN_*` constants with new `mixnet_vpn` constants. - Validated alignment of routing traffic configurations. - + 3. **Review File: `service-providers/ip-packet-router/src/ip_packet_router.rs`** - Ensured new `nym_network_defaults::constants::mixnet_vpn` constants replaced old references. - Verified `TunDeviceConfig` consistency. - + 4. **Review File: `service-providers/ip-packet-router/src/util/generate_new_ip.rs`** - Confirmed substitution of `TUN_DEVICE_*` constants with `NYM_TUN_DEVICE_*` constants. - Tested functionality for generating random IPs within subnet. @@ -743,54 +914,54 @@ Config changes: - `nym_node_mixnet_ingress_excessive_delay_packets` - `nym_node_mixnet_ingress_forward_hop_packets_dropped` - `nym_node_mixnet_ingress_final_hop_packets_dropped` - + - `nym_node_mixnet_ingress_forward_hop_packets_received_rate` - - `nym_node_mixnet_ingress_final_hop_packets_received_rate` - - `nym_node_mixnet_ingress_malformed_packets_received_rate` - - `nym_node_mixnet_ingress_excessive_delay_packets_rate` + - `nym_node_mixnet_ingress_final_hop_packets_received_rate` + - `nym_node_mixnet_ingress_malformed_packets_received_rate` + - `nym_node_mixnet_ingress_excessive_delay_packets_rate` - `nym_node_mixnet_ingress_forward_hop_packets_dropped_rate` - `nym_node_mixnet_ingress_final_hop_packets_dropped_rate` - + - egress: - `nym_node_mixnet_egress_stored_on_disk_final_hop_packets` - `nym_node_mixnet_egress_forward_hop_packets_sent` - `nym_node_mixnet_egress_ack_packets_sent` - `nym_node_mixnet_egress_forward_hop_packets_dropped` - + - `nym_node_mixnet_egress_forward_hop_packets_sent_rate` - `nym_node_mixnet_egress_ack_packets_sent_rate` - `nym_node_mixnet_egress_forward_hop_packets_dropped_rate` - + - client sessions - `nym_node_entry_client_sessions_unique_users` - `nym_node_entry_client_sessions_sessions_started` - `nym_node_entry_client_sessions_finished_sessions` - `nym_node_entry_client_sessions_durations_{TYP}` (histogram), for example `nym_node_entry_client_sessions_durations_vpn` - + - wireguard: - `nym_node_wireguard_bytes_rx` - `nym_node_wireguard_bytes_tx` - `nym_node_wireguard_bytes_total_peers` - `nym_node_wireguard_bytes_active_peers` - + - `nym_node_wireguard_bytes_rx_rate` - `nym_node_wireguard_bytes_tx_rate` - - + + - network - `nym_node_network_active_ingress_mixnet_connections` - `nym_node_network_active_ingress_web_socket_connections` - `nym_node_network_active_egress_mixnet_connections` - + - process - `nym_node_process_forward_hop_packets_being_delayed` - `nym_node_process_packet_forwarder_queue_size` - `nym_node_process_topology_query_resolution_latency` (histogram) - `nym_node_process_final_hop_packets_pending_delivery` - - `nym_node_process_forward_hop_packets_pending_delivery` + - `nym_node_process_forward_hop_packets_pending_delivery` -- [Amend 250gb limit](https://github.com/nymtech/nym/pull/5313): Change bandwidth cap to 250gb +- [Amend 250gb limit](https://github.com/nymtech/nym/pull/5313): Change bandwidth cap to 250gb - [Warn users if node is run in exit mode only](https://github.com/nymtech/nym/pull/5320): Throws a warning if node is run in "exit" mode only as by default, this will **NOT** enable entry capabilities, i.e. opening the websocket. thus making it ineligible for rewarded set selection (and rewards) - [Reduce log severity for number of packets being delayed](https://github.com/nymtech/nym/pull/5321) - [Apply 1.84 linter suggestions](https://github.com/nymtech/nym/pull/5330) @@ -806,7 +977,7 @@ Config changes: - [Make sure to apply gateway score filtering when choosing initial node](https://github.com/nymtech/nym/pull/5256) - [Fixed client session histogram buckets](https://github.com/nymtech/nym/pull/5316) - [Contract version assignment](https://github.com/nymtech/nym/pull/5318): This PR fixes updates to current nym-node version as well as introduces migration to fix the existing state of the mainnet contract - - [Make sure refresh data key matches bond info](https://github.com/nymtech/nym/pull/5329): This is to forbid operators from reusing the same underlying identity key for multiple nodes by overwriting the describe data. the reported key has to always match what the node has bonded with (and the contract enforces uniqueness) + - [Make sure refresh data key matches bond info](https://github.com/nymtech/nym/pull/5329): This is to forbid operators from reusing the same underlying identity key for multiple nodes by overwriting the describe data. the reported key has to always match what the node has bonded with (and the contract enforces uniqueness) ## Archived Changelog