Skip to content

Commit

Permalink
fix formatting
Browse files Browse the repository at this point in the history
  • Loading branch information
serinko committed May 22, 2024
1 parent f31f228 commit c4aa92e
Showing 1 changed file with 10 additions and 13 deletions.
23 changes: 10 additions & 13 deletions documentation/operators/src/changelog.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,8 @@ This page displays a full list of all the changes during our release cycle from
## `v2024.5-ragusa`

- [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):
- [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"
- Feature/nym node api location ([#4605])
- Add optional signature to IPR request/response ([#4604])
Expand Down Expand Up @@ -51,34 +52,30 @@ This page displays a full list of all the changes during our release cycle from
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.
- Testing Steps Performed:
1. Deploy new api changes to sandbox environment
2. Ensure current operations are transactional and standed operations are working
3. Run a script to ensure that the new endpoints are working as expected with pagination
- 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

<img width="719" alt="image" src="https://github.com/nymtech/nym/assets/60836166/91285971-e82a-4e5a-8a58-880505ae1be9">

- [`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.
- Tests:
- Testing steps performed:
- Built the project and deployed it in a test environment.
- Manually tested API endpoints for mixnode and gateway data.
- Verified that the endpoints return the expected data and handle blacklists correctly.
- API performance improved due to the efficient `HashMap` lookups
- Data in mainnet will differ from test nets due to the increased amount of gateways and mixnodes in that environment
- Test standard uptime routes:
```sh
curl -X 'GET' 'https://qa-nym-api.qa.nymte.ch/api/v1/status/gateway/3ZmKvV3Fax9A8txxQ3GKh9fUeyTAk68rK4Yn4m3Vdvp9/avg_uptime' -H 'accept: application/json'

curl -X 'GET' 'https://sandbox-nym-api1.nymtech.net/api/v1/status/mixnode/35/avg_uptime' -H 'accept: application/json'
curl -X 'GET' 'https://validator.nymtech.net/api/v1/status/gateway/Fo4f4SQLdoyoGkFae5TpVhRVoXCF8UiypLVGtGjujVPf/avg_uptime' -H 'accept: application/json'
```




### Documentation Updates

- [`nym-gateway-probe`](../testing/gateway-probe.md): A CLI tool to check networking status of any Gateway locally
- [Where to host your `nym-node`?](../legal/isp-list.md): An ISP list by Nym Operators community.
- [`nym-gateway-probe`](testing/gateway-probe.md): A CLI tool to check in-real-time networking status of any Gateway locally.
- [Where to host your `nym-node`?](legal/isp-list.md): A list of Internet Service Providers (ISPs) by Nym Operators community. We invite all operators to add their experiences with different ISPs to strengthen the community knowledge and Nym mixnet performance.

## `v2024.4-nutella`

Expand Down

0 comments on commit c4aa92e

Please sign in to comment.