Skip to content

Commit

Permalink
[DOCs]: Add more backup guides, clean up deprecated, fix URLs, add sh…
Browse files Browse the repository at this point in the history
…a verf (#5384)

* fix socks5 syntax

* reshape backup and restore and add proxy

* fix URLS

* remove deprecated node-api-check - archived for when there is time to maintain the tool

* add hash verification step
  • Loading branch information
serinko authored Jan 23, 2025
1 parent 4eadaf8 commit 04fd197
Show file tree
Hide file tree
Showing 18 changed files with 239 additions and 230 deletions.
Original file line number Diff line number Diff line change
@@ -1 +1 @@
44.811
44.332
Original file line number Diff line number Diff line change
@@ -1 +1 @@
Thursday, January 16th 2025, 09:57:52 UTC
Thursday, January 23rd 2025, 10:41:32 UTC
14 changes: 0 additions & 14 deletions documentation/docs/next.config.js
Original file line number Diff line number Diff line change
Expand Up @@ -497,13 +497,6 @@ const config = {
permanent: true,
basePath: false,
},
{
source: "/operators/testing/node-api-check.html",
destination:
"/docs/operators/nodes/performance-and-testing/node-api-check",
permanent: true,
basePath: false,
},
{
source: "/operators/testing/prometheus-grafana.html",
destination:
Expand Down Expand Up @@ -663,13 +656,6 @@ const config = {
permanent: true,
basePath: false,
},
{
source: "/docs/operators/testing/node-api-check",
destination:
"/docs/operators/nodes/performance-and-testing/node-api-check",
permanent: true,
basePath: false,
},
{
source: "/docs/operators/nodes/proxy-configuration",
destination:
Expand Down
2 changes: 1 addition & 1 deletion documentation/docs/pages/apis/explorer-api.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,6 @@

The Explorer API is the backend for the [Mixnet Explorer](https://explorer.nymtech.net/).

**This will soon be deprecated in favour of the [Node Status API](../ns-api).**
**This will soon be deprecated in favour of the [Node Status API](ns-api.mdx).**

The code for this service can be found [in our monorepo](https://github.com/nymtech/nym/tree/develop/explorer).
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ You can check that your binaries are properly compiled with:
You can check the necessary parameters for the available commands by running:

```
./nym-client <COMMAND> --help
./nym-socks5-client <COMMAND> --help
```

## Initialising a new client instance
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
The `nym-cli` binary can be built by running `cargo build --release` in the `nym/tools/nym-cli` directory.

## Usage
See the [commands](./nym-cli/commands.mdx) page for an overview of all command options.
See the [commands](commands.mdx) page for an overview of all command options.

## Staking on someone's behalf (for custodians)

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -17,8 +17,6 @@ Sounds great, are there any catches? Well, there are a few (for now):

- For now, `mixFetch` cannot deal with concurrent requests with the same base URL.

Read [this article](https://blog.nym.com/mixfetch-like-the-fetch-api-but-via-the-mixnet-82acfd435c62) to learn more.

<Callout type="info" emoji="ℹ️">
Right now Gateways are not required to run a Secure Websocket (WSS) listener, so only a subset of nodes running in Gateway mode have configured their nodes to do so.

Expand Down
4 changes: 2 additions & 2 deletions documentation/docs/pages/network/architecture.mdx
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
# Network Components

Core components:
* A **Mixnet**, which mixes Sphinx packet traffic so that it cannot be determined who is communicating with whom. Our mixnet is based on a modified version of the [**Loopix** design](concepts/loopix). This is made up of [Nym nodes](architecture/mixnet/nodes) runnning on servers around the world maintained by a decentralised group of Operators.
* Various [**Nym clients**](architecture/mixnet/clients) which manage sending and receiving Sphinx packets, encrypting/decrypting traffic, and providing [cover traffic](./concepts/cover-traffic) to hide 'real' traffic timing.
* A **Mixnet**, which mixes Sphinx packet traffic so that it cannot be determined who is communicating with whom. Our mixnet is based on a modified version of the [**Loopix** design](concepts/loopix). This is made up of [Nym nodes](architecture/mixnet#nodes) runnning on servers around the world maintained by a decentralised group of Operators.
* Various [**Nym clients**](architecture/mixnet#nym-clients) which manage sending and receiving Sphinx packets, encrypting/decrypting traffic, and providing [cover traffic](./concepts/cover-traffic) to hide 'real' traffic timing.
* A CosmWasm-enabled blockchain called [**Nyx**](architecture/nyx), the home of the various smart contracts used by the mixnet. A subset of Nyx Validators run [NymAPI](./architecture/nyx#nymapi) instances, taking part in also producing and verifying [zk-nym credentials](cryptography/zk-nym).

![arch_overview](/images/network/arch/overall-arch.png)
2 changes: 1 addition & 1 deletion documentation/docs/pages/network/architecture/nyx.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -66,7 +66,7 @@ The Vesting contract has multiple functions:
* Interacting with the Mixnet using vesting (i.e. non-transferable) tokens, allowing users to delegate their unvested tokens.

### Multisig Contract
The multisig contract used by the [NymAPI Quroum](../cryptography/zk-nym/zk-nym-overview) - a subset of the Nyx Validator set taking on the additional work of generating and validating zk-nyms - to execute certain actions in the [zk-nym](./ecash.md) contract.
The multisig contract used by the [NymAPI Quroum](../cryptography/zk-nym/zk-nym-overview) - a subset of the Nyx Validator set taking on the additional work of generating and validating zk-nyms - to execute certain actions in the [zk-nym](../cryptography/zk-nym) contract.

It is essentially an instance of the [canonical](https://github.com/CosmWasm/cw-plus/tree/main/contracts) `cw3-flex-multisig` using the `cw4-group` contract, with one minor change to restrict the addresses allowed to submit proposals.

Expand Down
54 changes: 50 additions & 4 deletions documentation/docs/pages/operators/binaries/pre-built-binaries.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
import { Steps } from 'nextra/components'
import { Steps } from 'nextra/components';
import { VarInfo } from 'components/variable-info.tsx';
import { Tabs } from 'nextra/components';
import { MyTab } from 'components/generic-tabs.tsx';

# Pre-built Binaries

Expand Down Expand Up @@ -27,11 +29,55 @@ In case you want to download binary to your current working directory, drop `<PA

In case you want to download binary to your current working directory, drop `<PATH>` from the command

###### 2. Make the binary executable
###### 2. Verify the binary `sha256sum` hash

<div>
<Tabs items={[
<strong>Manual check</strong>,
<strong>One-liner</strong>,
]} defaultIndex="0">
<MyTab>
To see your binary `sha256sum` hash, run:
```sh
sha256sum <BINARY>
```
```sh
# for example
# sha256sum ./nym-wallet_1.2.15_amd64.AppImage
# or
# sha256sum ./nym-node
```
- Download [`hashes.json`](https://github.com/nymtech/nym/releases) file from the same same *Assets* drop down like your binary
- Open it with your text editor or print its content with `cat hashes.json`
- Check it if your binary `sha256sum` output is in `hashes.json` by using the `sha256sum` and searching for it or using `grep` command:
```
grep -i <SHA_HASH>
```
</MyTab>
<MyTab>
- Download [`hashes.json`](https://github.com/nymtech/nym/releases) file from the same same *Assets* drop down like your binary
- Run this command, substituting `<BINARY>` with your the one you want to check:
```sh
sha256sum <BINARY> | awk '{print $1}' | grep -qF "$(jq -r '.assets | to_entries | .[].value.sha256' hashes.json)" && echo "Hash matches an asset in the JSON file." || echo "Hash does not match any asset in the JSON file."
```
```sh
# for example
# sha256sum ./nym-node | awk '{print $1}' | grep -qF "$(jq -r '.assets | to_entries | .[].value.sha256' hashes.json)" && echo "Hash matches an asset in the JSON file." || echo "Hash does not match any asset in the JSON file."
```
</MyTab>
</Tabs>
</div>

- If your have to extract the binary (it would look like like `<BINARY>.tar.gz`) do it:
```sh
tar -xvzf <BINARY>.tar.gz
```

###### 3. Make the binary executable
- Open terminal in the same directory and run:
```sh
chmod +x <BINARY>
# for example: chmod +x nym-mixnode
chmod u+x <BINARY>
# for example: chmod u+x nym-node
```

</Steps>
Expand Down
12 changes: 6 additions & 6 deletions documentation/docs/pages/operators/changelog.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -525,7 +525,7 @@ cargo Profile: release

- `nym-node` has now implemented [IPv6 support for wireguard](https://github.com/nymtech/nym/pull/5059)

- [`network_tunnel_manager.sh` updated](network): run the commands below to make sure
- [`network_tunnel_manager.sh` updated](https://raw.githubusercontent.com/nymtech/nym/refs/heads/develop/scripts/network_tunnel_manager.sh): run the commands below to make sure

<br />

Expand Down Expand Up @@ -659,7 +659,7 @@ systemctl daemon-reload && service nym-node restart

- Since `v2024.13-magura`, operators do not update their node version in the wallet. [Manual upgrading steps](nodes/maintenance/manual-upgrade.mdx) has been updated accordingly.

- CLI tool [`node_api_check.py`](nodes/performance-and-testing/node-api-check.mdx), helping operators to collect all API values about their nodes locally, is not up to date with the API changes introduced with `v2024.13-magura` release version. Please treat it as unstable before we fix it.
- CLI tool `node_api_check.py`, helping operators to collect all API values about their nodes locally, is not up to date with the API changes introduced with `v2024.13-magura` release version. Please treat it as unstable before we fix it.

#### Error Log

Expand Down Expand Up @@ -967,7 +967,7 @@ Confirm that the deployment workflows work through manual testing
### Operators Updates & Tooling
<Callout type="warning" emoji="⚠️">
**Every operator has to make sure that their nodes [self-described endpoint works](nodes/performance-and-testing/node-api-check#basic-api-usage), otherwise the node will be un-routable and thus won't get any rewards!**
**Every operator has to make sure that their nodes self-described endpoint works, otherwise the node will be un-routable and thus won't get any rewards!**
</Callout>
- **New technical documentation:** All Nym documentation starts from a new entry page [nymtech.net/docs](https://nymtech.net/docs/operators/introduction). To run locally or propose collaboration, start in our [repository](https://github.com/nymtech/nym/tree/develop/documentation)
Expand Down Expand Up @@ -1165,7 +1165,7 @@ Some endpoints got purposely deprecated without any equivalent reimplemented sin
##### Mixnet Contract
<Callout type="warning" emoji="">
**Every operator has to make sure that their nodes [self-described endpoint works](nodes/performance-and-testing/node-api-check#basic-api-usage), otherwise the node will be un-routable and thus won't get any rewards!**
**Every operator has to make sure that their nodes self-described endpoint works, otherwise the node will be un-routable and thus won't get any rewards!**
</Callout>
###### High Level Changes
Expand Down Expand Up @@ -1979,7 +1979,7 @@ done
- Vesting contract functionalities have been purged, users can only remove tokens from vesting
- Migrating from `mixnode` or `gateway` smart contracts to a new unifying `nym-node` smart contract will be available soon using Nym desktop wallet, just like you are used to for bonding and node settings. After this migration all `nym-nodes` will be able to receive delegation and rewards. We will share a step by step guide once this migration will be deployed. No action needed now.
- [Nym API Check CLI](testing/node-api-check.md) is upgraded according to the latest API endpoints, output is cleaner and more concise.
- Nym API Check CLI is upgraded according to the latest API endpoints, output is cleaner and more concise.
#### Operators Tasks
Expand Down Expand Up @@ -2868,7 +2868,7 @@ warning: /home/alice/src/nym/nym/common/dkg/Cargo.toml: `default-features` is ig
- Flow [chart](release-cycle.md#release-flow)
- [Sandbox testnet](sandbox.md) guide: teaching Nym node operators how to run their nodes in Nym Sandbox testnet environment.
- [Terms & Conditions flag](nodes/setup.md#terms--conditions)
- [Node API Check CLI](testing/node-api-check.md)
- Node API Check CLI
- [Pruning VPS `syslog` scripts](troubleshooting/vps-isp.md#pruning-logs)
- [Black-xit: Exiting the blacklist](troubleshooting/nodes.md#my-gateway-is-blacklisted)
Expand Down
Loading

0 comments on commit 04fd197

Please sign in to comment.