Merge branch 'release/v1.1.23' into feature/v1-1-23-docs

2023-07-03 09:47:55 +00:00
parent 1aad69a527 7a1a7c003e
commit 7bbb10e52c
147 changed files with 4269 additions and 2341 deletions
@@ -8,7 +8,6 @@
 ```

 ## What is this client for?
-
 Many existing applications are able to use either the SOCKS4, SOCKS4A, or SOCKS5 proxy protocols. If you want to send such an application's traffic through the mixnet, you can use the `nym-socks5-client` to bounce network traffic through the Nym network, like this:

 ```
@@ -66,7 +65,6 @@ The `nym-socks5-client` allows you to do the following from your local machine:
 The `nym-network-requester` then reassembles the original TCP stream using the packets' sequence numbers, and make the intended request. It will then chop up the response into Sphinx packets and send them back through the mixnet to your  `nym-socks5-client`. The application will then receive its data, without even noticing that it wasn't talking to a "normal" SOCKS5 proxy!

 ## Client setup
-
 ### Viewing command help

 You can check that your binaries are properly compiled with:
@@ -88,7 +86,6 @@ You can check the necessary parameters for the available commands by running:
 ```

 ### Initialising a new client instance
-
 Before you can use the client, you need to initalise a new instance of it, which can be done with the following command:

 ```
@@ -108,7 +105,6 @@ The `--provider` field needs to be filled with the Nym address of a Network Requ
 Since the nodes on this list are the infrastructure for [Nymconnect](https://nymtech.net/developers/quickstart/nymconnect-gui.html) they will support all apps on the [default whitelist](../nodes/network-requester-setup.md#network-requester-whitelist): Keybase, Telegram, Electrum, Blockstream Green, and Helios.

 #### Choosing a Gateway
-
 By default - as in the example above - your client will choose a random gateway to connect to.

 However, there are several options for choosing a gateway, if you do not want one that is randomly assigned to your client:
@@ -121,7 +117,6 @@ However, there are several options for choosing a gateway, if you do not want on
 > Note this doesn't mean that your client will pick the closest gateway to you, but it will be far more likely to connect to gateway with a 20ms ping rather than 200ms

 ### Configuring your client
-
 When you initalise a client instance, a configuration directory will be generated and stored in `$HOME_DIR/.nym/socks5-clients/<client-name>/`.

 ```
@@ -145,13 +140,14 @@ The `config.toml` file contains client configuration options, while the two `pem
 The generated files contain the client name, public/private keypairs, and gateway address. The name `<client_id>` in the example above is just a local identifier so that you can name your clients.

 #### Configuring your client for Docker
-
 By default, the native client listens to host `127.0.0.1`. However this can be an issue if you wish to run a client in a Dockerized environment, where it can be convenenient to listen on a different host such as `0.0.0.0`.

 You can set this via the `--host` flag during either the `init` or `run` commands.

 Alternatively, a custom host can be set in the `config.toml` file under the `socket` section. If you do this, remember to restart your client process.

+
+
 ### Running the socks5 client

 You can run the initalised client by doing this:
@@ -160,38 +156,6 @@ You can run the initalised client by doing this:
 ./nym-socks5-client run --id docs-example
 ```

-## Automating your socks5 client with systemd
-
-Stop the running process with `CTRL-C`, and create a service file for the socks5 client as we did with our client instance previously at `/etc/systemd/system/nym-socks5-client.service`:
-
-```ini
-[Unit]
-Description=Nym Socks5 Client ({{platform_release_version}})
-StartLimitInterval=350
-StartLimitBurst=10
-
-[Service]
-User=nym # replace this with whatever user you wish
-LimitNOFILE=65536
-ExecStart=/home/nym/nym-socks5-client run --id <your_id>
-KillSignal=SIGINT
-Restart=on-failure
-RestartSec=30
-
-[Install]
-WantedBy=multi-user.target
-```
-
-Now enable and start your socks5 client:
-
-```
-systemctl enable nym-socks5-client.service
-systemctl start nym-socks5-client.service
-
-# you can always check your socks5 client has succesfully started with:
-systemctl status nym-socks5-client.service
-```
-
 ## Using your Socks5 Client

 After completing the steps above, your local Socks5 Client will be listening on `localhost:1080` ready to proxy traffic to the Network Requester set as the `--provider` when initialising.
@@ -7,6 +7,7 @@
 <!-- cmdrun ../../../../target/release/nym-gateway --version | grep "Build Version" | cut -b 21-26  -->
 ```

+
 ## Preliminary steps
 There are a couple of steps that need completing before starting to set up your gateway:

@@ -23,6 +24,7 @@ If you don't already have one, please create a Nym address using the wallet, and

 > Remember that you can **only** use native Cosmos `NYM` tokens to bond your gateway. You **cannot** use ERC20 representations of `NYM` to run a node.

+
 #### Sandbox testnet
 Make sure to download a wallet and create an account as outlined above. Then head to our [token faucet](https://faucet.nymtech.net/) and get some tokens to use to bond it.

@@ -73,12 +75,12 @@ To check available configuration options use:
 The following command returns a gateway on your current IP with the `id` of `supergateway`:

 ```
-./nym-gateway init --id supergateway --host $(curl ifconfig.me)
+./nym-gateway init --id supergateway --host $(curl ifconfig.me) --wallet-address n1eufxdlgt0puwrwptgjfqne8pj4nhy2u5ft62uq
 ```

 ~~~admonish example collapsible=true title="Console output"
 ```
-<!-- cmdrun ../../../../target/release/nym-gateway init --id supergateway --host $(curl ifconfig.me) -->
+<!-- cmdrun ../../../../target/release/nym-gateway init --id supergateway --host $(curl ifconfig.me) --wallet-address n1eufxdlgt0puwrwptgjfqne8pj4nhy2u5ft62uq -->
 ```
 ~~~

@@ -84,15 +84,15 @@ To check available configuration options for initializing your node use:
 ```
 ~~~

-Initalise your mixnode with the following command, replacing the value of `--id` with the moniker you wish to give your mixnode. Your `--host` must be publicly routable on the internet in order to mix packets, and can be either an Ipv4 or IPv6 address. The `$(curl ifconfig.me)` command returns your IP automatically using an external service. If you enter your IP address manually, enter it **without** any port information.
+Initalise your mixnode with the following command, replacing the value of `--id` with the moniker you wish to give your mixnode, and the `--wallet-address` with the Nym address you created earlier. Your `--host` must be publicly routable on the internet in order to mix packets, and can be either an Ipv4 or IPv6 address. The `$(curl ifconfig.me)` command returns your IP automatically using an external service. If you enter your IP address manually, enter it **without** any port information.

 ```
-./nym-mixnode init --id winston-smithnode --host $(curl ifconfig.me)
+./nym-mixnode init --id winston-smithnode --host $(curl ifconfig.me) --wallet-address n1eufxdlgt0puwrwptgjfqne8pj4nhy2u5ft62uq
 ```

 ~~~admonish example collapsible=true title="Console output"
 ```
- <!-- cmdrun ../../../../target/release/nym-mixnode init --id winston-smithnode --host $(curl ifconfig.me) -->
+ <!-- cmdrun ../../../../target/release/nym-mixnode init --id winston-smithnode --host $(curl ifconfig.me) --wallet-address n1eufxdlgt0puwrwptgjfqne8pj4nhy2u5ft62uq -->
 ```
 ~~~

@@ -106,7 +106,7 @@ During the `init` process you will have the option to change the `http_api`, `ve
 From `v1.1.3`, if you unbond your mixnode that means you are leaving the mixnet and you will lose all your delegations (permanently). You can join again with the same identity key, however, you will start with **no delegations**.
 ```

-#### Bond via the Desktop wallet
+#### Bond via the Desktop wallet (recommended)

 You can bond your mix node via the Desktop wallet.

@@ -149,7 +149,7 @@ You can bond your mix node via the Desktop wallet.

 > You are asked to `sign` a transaction on bonding so that the mixnet smart contract is able to map your nym address to your node. This allows us to create a nonce for each account and defend against replay attacks.

-#### Bond via the CLI
+#### Bond via the CLI (power users)
 If you want to bond your mix node via the CLI, then check out the [relevant section in the Nym CLI](../tools/nym-cli.md#bond-a-mix-node) docs.

 ### Running your mix node
@@ -50,7 +50,7 @@ As seen in the example above, the `mixnet::MixnetClientBuilder::new()` function
 If you're integrating mixnet functionality into an existing app and want to integrate saving client configs and keys into your existing storage logic, you can manually perform the actions taken automatically above (`examples/manually_handle_keys_and_config.rs`)

 ```rust,noplayground
-{{#include ../../../../sdk/rust/nym-sdk/examples/manually_handle_storage.rs}}
+{{#include ../../../../sdk/rust/nym-sdk/examples/manually_handle_keys_and_config.rs}}
 ```

 ### Anonymous replies with SURBs
@@ -5,7 +5,7 @@ The Nym Desktop Wallet lets you interact with your Nym node and to delegate stak

 You can download it for Mac, Windows, or Linux.

-[![download nym wallet](../images/download-wallet.png)](https://github.com/nymtech/nym/releases/tag/nym-wallet-{{wallet_release_version}})
+[![download nym wallet](../images/download-wallet.png)](https://github.com/nymtech/nym/releases/tag/nym-wallet-v1.2.4)

 ### Bypassing security warnings