update gw probe to point @ monorepo (#6194)
* update gw probe to point @ monorepo * add funded nyx account info
This commit is contained in:
mfahampshire
@@ -9,23 +9,21 @@ Nym Node operators running Gateway functionality are already familiar with the m
|
||||
|
||||
## Preparation
|
||||
|
||||
We recommend to have installed all [the prerequisites](../binaries/building-nym.md#prerequisites) needed to build `nym-node` from source including latest [Rust Toolchain](https://www.rust-lang.org/tools/install), **and** make sure to have [Go](https://go.dev/doc/install) installed. Go is necessary as the probe uses the `rust2go` FFI library to use `netstack` when making requests.
|
||||
We recommend to have installed all [the prerequisites](../binaries/building-nym.md#prerequisites) needed to build `nym-node` from source including latest [Rust Toolchain](https://www.rust-lang.org/tools/install), **and** make sure to have [Go](https://go.dev/doc/install) installed. Go is necessary as the probe uses the `rust2go` FFI library to use `netstack` when making requests.
|
||||
|
||||
## Installation
|
||||
|
||||
`nym-gateway-probe` source code is in [`nym-vpn-client`](https://github.com/nymtech/nym-vpn-client) repository. The client needs to be build from source.
|
||||
`nym-gateway-probe` source code is in [`nym` monorepo](https://github.com/nymtech/nym). The probe needs to be built from source.
|
||||
|
||||
1. Clone the repository:
|
||||
|
||||
```sh
|
||||
git clone https://github.com/nymtech/nym-vpn-client.git
|
||||
git clone https://github.com/nymtech/nym.git
|
||||
```
|
||||
|
||||
2. Build `nym-gateway-probe`:
|
||||
|
||||
```sh
|
||||
cd nym-vpn-client/nym-vpn-core
|
||||
|
||||
cargo build --release -p nym-gateway-probe
|
||||
```
|
||||
|
||||
@@ -34,65 +32,71 @@ cargo build --release -p nym-gateway-probe
|
||||
To list all commands and options run the binary with `--help` command:
|
||||
|
||||
```sh
|
||||
./target/release/nym-gateway-probe -h
|
||||
./target/release/nym-gateway-probe -h
|
||||
```
|
||||
|
||||
- Output:
|
||||
|
||||
```sh
|
||||
Usage: nym-gateway-probe [OPTIONS] --mnemonic <MNEMONIC>
|
||||
Usage: nym-gateway-probe [OPTIONS] [COMMAND]
|
||||
|
||||
Options:
|
||||
-c, --config-env-file <CONFIG_ENV_FILE>
|
||||
Path pointing to an env file describing the network
|
||||
-g, --entry-gateway <ENTRY_GATEWAY>
|
||||
The specific gateway specified by ID
|
||||
-n, --node <NODE>
|
||||
Identity of the node to test
|
||||
--min-gateway-mixnet-performance <MIN_GATEWAY_MIXNET_PERFORMANCE>
|
||||
|
||||
--min-gateway-vpn-performance <MIN_GATEWAY_VPN_PERFORMANCE>
|
||||
|
||||
--only-wireguard
|
||||
|
||||
-i, --ignore-egress-epoch-role
|
||||
Disable logging during probe
|
||||
--no-log
|
||||
|
||||
-a, --amnezia-args <AMNEZIA_ARGS>
|
||||
Arguments to be appended to the wireguard config enabling amnezia-wg configuration
|
||||
--netstack-download-timeout-sec <NETSTACK_DOWNLOAD_TIMEOUT_SEC>
|
||||
[default: 180]
|
||||
--netstack-v4-dns <NETSTACK_V4_DNS>
|
||||
[default: 1.1.1.1]
|
||||
--netstack-v6-dns <NETSTACK_V6_DNS>
|
||||
[default: 2606:4700:4700::1111]
|
||||
--netstack-num-ping <NETSTACK_NUM_PING>
|
||||
[default: 5]
|
||||
--netstack-send-timeout-sec <NETSTACK_SEND_TIMEOUT_SEC>
|
||||
[default: 3]
|
||||
--netstack-recv-timeout-sec <NETSTACK_RECV_TIMEOUT_SEC>
|
||||
[default: 3]
|
||||
--netstack-ping-hosts-v4 <NETSTACK_PING_HOSTS_V4>
|
||||
[default: nymtech.net]
|
||||
--netstack-ping-ips-v4 <NETSTACK_PING_IPS_V4>
|
||||
[default: 1.1.1.1]
|
||||
--netstack-ping-hosts-v6 <NETSTACK_PING_HOSTS_V6>
|
||||
[default: ipv6.google.com]
|
||||
--netstack-ping-ips-v6 <NETSTACK_PING_IPS_V6>
|
||||
[default: 2001:4860:4860::8888 2606:4700:4700::1111 2620:fe::fe]
|
||||
--mnemonic <MNEMONIC>
|
||||
|
||||
-h, --help
|
||||
Print help
|
||||
-V, --version
|
||||
Print version
|
||||
Commands:
|
||||
run-local Run the probe locally
|
||||
help Print this message or the help of the given subcommand(s)
|
||||
|
||||
Options:
|
||||
-c, --config-env-file <CONFIG_ENV_FILE>
|
||||
Path pointing to an env file describing the network
|
||||
-g, --entry-gateway <ENTRY_GATEWAY>
|
||||
The specific gateway specified by ID
|
||||
-n, --node <NODE>
|
||||
Identity of the node to test
|
||||
--min-gateway-mixnet-performance <MIN_GATEWAY_MIXNET_PERFORMANCE>
|
||||
|
||||
--only-wireguard
|
||||
|
||||
--ignore-egress-epoch-role
|
||||
Disable logging during probe
|
||||
--no-log
|
||||
|
||||
-a, --amnezia-args <AMNEZIA_ARGS>
|
||||
Arguments to be appended to the wireguard config enabling amnezia-wg configuration
|
||||
--netstack-download-timeout-sec <NETSTACK_DOWNLOAD_TIMEOUT_SEC>
|
||||
[default: 180]
|
||||
--metadata-timeout-sec <METADATA_TIMEOUT_SEC>
|
||||
[default: 30]
|
||||
--netstack-v4-dns <NETSTACK_V4_DNS>
|
||||
[default: 1.1.1.1]
|
||||
--netstack-v6-dns <NETSTACK_V6_DNS>
|
||||
[default: 2606:4700:4700::1111]
|
||||
--netstack-num-ping <NETSTACK_NUM_PING>
|
||||
[default: 5]
|
||||
--netstack-send-timeout-sec <NETSTACK_SEND_TIMEOUT_SEC>
|
||||
[default: 3]
|
||||
--netstack-recv-timeout-sec <NETSTACK_RECV_TIMEOUT_SEC>
|
||||
[default: 3]
|
||||
--netstack-ping-hosts-v4 <NETSTACK_PING_HOSTS_V4>
|
||||
[default: nym.com]
|
||||
--netstack-ping-ips-v4 <NETSTACK_PING_IPS_V4>
|
||||
[default: 1.1.1.1]
|
||||
--netstack-ping-hosts-v6 <NETSTACK_PING_HOSTS_V6>
|
||||
[default: cloudflare.com]
|
||||
--netstack-ping-ips-v6 <NETSTACK_PING_IPS_V6>
|
||||
[default: 2001:4860:4860::8888 2606:4700:4700::1111 2620:fe::fe]
|
||||
--ticket-materials <TICKET_MATERIALS>
|
||||
|
||||
--ticket-materials-revision <TICKET_MATERIALS_REVISION>
|
||||
[default: 1]
|
||||
-h, --help
|
||||
Print help
|
||||
-V, --version
|
||||
Print version
|
||||
```
|
||||
|
||||
To run the client, simply add `-n` flag followed by the ID key of the node you wish to test, as well as the mnemonic of a funded Nyx account; this is required to test the ticketbook generation.
|
||||
To run the client, simply add `-g` flag followed by the ID key of the node you wish to test, as well as the mnemonic of a funded Nyx account; this is required to test the ticketbook generation. **Note that this accout needs to have NYM tokens; you cannot use an account with a NymVPN subscription**. Make sure to have at least a few NYM tokens in there.
|
||||
|
||||
```sh
|
||||
./target/release/nym-gateway-probe -n <GATEWAY_IDENTITY_KEY> --mnemonic <MNEMONIC>
|
||||
./target/release/nym-gateway-probe run-local -g <GATEWAY_IDENTITY_KEY> --mnemonic <MNEMONIC>
|
||||
```
|
||||
|
||||
For any `nym-node --mode exit-gateway` the aim is to have this outcome:
|
||||
@@ -125,4 +129,4 @@ For any `nym-node --mode exit-gateway` the aim is to have this outcome:
|
||||
|
||||
**If your Gateway is blacklisted, the probe will not work.**
|
||||
|
||||
If you don't provide a `-n` flag it will pick a random node to test.
|
||||
If you don't provide a `-g` flag it will pick a random node to test.
|
||||
|
||||
Reference in New Issue
Block a user