From c768d39fa4b626bf2f9b3be5a0d0116ab16a21bc Mon Sep 17 00:00:00 2001 From: mfahampshire Date: Wed, 18 Dec 2024 18:26:21 +0100 Subject: [PATCH] auto commit generated command files --- .../command-outputs/nym-api-build-info.md | 8 +-- .../command-outputs/nym-client-build-info.md | 8 +-- .../nym-client-generate-fig-spec.md | 20 ++++++ .../nym-node-bonding-information.md | 2 +- .../command-outputs/nym-node-build-info.md | 8 +-- .../command-outputs/nym-node-migrate-help.md | 68 +------------------ .../command-outputs/nym-node-migrate.md | 6 ++ .../command-outputs/nym-node-node-details.md | 2 +- .../nym-socks5-client-build-info.md | 8 +-- .../nym-socks5-client-generate-fig-spec.md | 20 ++++++ .../command-outputs/nymvisor-build-info.md | 8 +-- .../developers/clients/socks5/commands.mdx | 28 ++++++-- .../developers/clients/websocket/commands.mdx | 28 ++++++-- 13 files changed, 118 insertions(+), 96 deletions(-) create mode 100644 documentation/docs/components/outputs/command-outputs/nym-node-migrate.md diff --git a/documentation/docs/components/outputs/command-outputs/nym-api-build-info.md b/documentation/docs/components/outputs/command-outputs/nym-api-build-info.md index f8b3bc00898..1ef49ea0aaa 100644 --- a/documentation/docs/components/outputs/command-outputs/nym-api-build-info.md +++ b/documentation/docs/components/outputs/command-outputs/nym-api-build-info.md @@ -1,10 +1,10 @@ ```sh Binary Name: nym-api -Build Timestamp: 2024-12-18T10:26:40.905460408Z -Build Version: 1.1.46 -Commit SHA: 62045d76b32265f6a5e6358ab7aebbc827d47dcd -Commit Date: 2024-11-26T11:53:05.000000000+01:00 +Build Timestamp: 2024-12-18T17:18:44.233208652Z +Build Version: 1.1.47 +Commit SHA: b628a5f8148f74c646915292c8b6dc0a46202a27 +Commit Date: 2024-12-13T11:49:27.000000000+01:00 Commit Branch: master rustc Version: 1.84.0-nightly rustc Channel: nightly diff --git a/documentation/docs/components/outputs/command-outputs/nym-client-build-info.md b/documentation/docs/components/outputs/command-outputs/nym-client-build-info.md index e8b6b4e861b..04a6844caf3 100644 --- a/documentation/docs/components/outputs/command-outputs/nym-client-build-info.md +++ b/documentation/docs/components/outputs/command-outputs/nym-client-build-info.md @@ -1,10 +1,10 @@ ```sh Binary Name: nym-client -Build Timestamp: 2024-12-18T10:26:40.905460408Z -Build Version: 1.1.44 -Commit SHA: 62045d76b32265f6a5e6358ab7aebbc827d47dcd -Commit Date: 2024-11-26T11:53:05.000000000+01:00 +Build Timestamp: 2024-12-18T17:18:44.233208652Z +Build Version: 1.1.45 +Commit SHA: b628a5f8148f74c646915292c8b6dc0a46202a27 +Commit Date: 2024-12-13T11:49:27.000000000+01:00 Commit Branch: master rustc Version: 1.84.0-nightly rustc Channel: nightly diff --git a/documentation/docs/components/outputs/command-outputs/nym-client-generate-fig-spec.md b/documentation/docs/components/outputs/command-outputs/nym-client-generate-fig-spec.md index 53d1c326d55..a543beb4adb 100644 --- a/documentation/docs/components/outputs/command-outputs/nym-client-generate-fig-spec.md +++ b/documentation/docs/components/outputs/command-outputs/nym-client-generate-fig-spec.md @@ -68,6 +68,16 @@ const completion: Fig.Spec = { ], }, }, + { + name: "--stats-reporting-address", + description: "Sets the address to report statistics", + hidden: true, + isRepeatable: true, + args: { + name: "stats_reporting_address", + isOptional: true, + }, + }, { name: "--disable-socket", description: "Whether to not start the websocket", @@ -201,6 +211,16 @@ const completion: Fig.Spec = { ], }, }, + { + name: "--stats-reporting-address", + description: "Sets the address to report statistics", + hidden: true, + isRepeatable: true, + args: { + name: "stats_reporting_address", + isOptional: true, + }, + }, { name: "--disable-socket", description: "Whether to not start the websocket", diff --git a/documentation/docs/components/outputs/command-outputs/nym-node-bonding-information.md b/documentation/docs/components/outputs/command-outputs/nym-node-bonding-information.md index 5cda2291e21..f1488f27e7b 100644 --- a/documentation/docs/components/outputs/command-outputs/nym-node-bonding-information.md +++ b/documentation/docs/components/outputs/command-outputs/nym-node-bonding-information.md @@ -1,3 +1,3 @@ ```sh -2024-11-06T12:18:46.723546Z ERROR nym-node/src/config/upgrade_helpers.rs:17: Failed to finish upgrade - failed to load config file using path '/home/m/.nym/nym-nodes/default-nym-node/config/config.toml'. detailed message: No such file or directory (os error 2) +2024-12-18T17:26:21.343400Z ERROR nym-node/src/config/upgrade_helpers.rs:19: Failed to finish upgrade - failed to load config file using path '/home/m/.nym/nym-nodes/default-nym-node/config/config.toml'. detailed message: No such file or directory (os error 2) ``` diff --git a/documentation/docs/components/outputs/command-outputs/nym-node-build-info.md b/documentation/docs/components/outputs/command-outputs/nym-node-build-info.md index 201423087e0..738d3259ba5 100644 --- a/documentation/docs/components/outputs/command-outputs/nym-node-build-info.md +++ b/documentation/docs/components/outputs/command-outputs/nym-node-build-info.md @@ -1,10 +1,10 @@ ```sh Binary Name: nym-node -Build Timestamp: 2024-12-18T10:26:40.905460408Z -Build Version: 1.1.11 -Commit SHA: 62045d76b32265f6a5e6358ab7aebbc827d47dcd -Commit Date: 2024-11-26T11:53:05.000000000+01:00 +Build Timestamp: 2024-12-18T17:18:44.233208652Z +Build Version: 1.2.0 +Commit SHA: b628a5f8148f74c646915292c8b6dc0a46202a27 +Commit Date: 2024-12-13T11:49:27.000000000+01:00 Commit Branch: master rustc Version: 1.84.0-nightly rustc Channel: nightly diff --git a/documentation/docs/components/outputs/command-outputs/nym-node-migrate-help.md b/documentation/docs/components/outputs/command-outputs/nym-node-migrate-help.md index b040590c2ac..c380336b91a 100644 --- a/documentation/docs/components/outputs/command-outputs/nym-node-migrate-help.md +++ b/documentation/docs/components/outputs/command-outputs/nym-node-migrate-help.md @@ -1,72 +1,8 @@ ```sh Attempt to migrate an existing mixnode or gateway into a nym-node -Usage: nym-node migrate [OPTIONS] <--id |--config-file > - -Arguments: - Type of node (mixnode or gateway) to migrate into a nym-node [possible values: mixnode, gateway] +Usage: nym-node migrate Options: - --id - Id of the node that's going to get migrated - --config-file - Path to a configuration file of the node that's going to get migrated - --preserve-id - Specify whether to preserve id of the imported node - --public-ips - Comma separated list of public ip addresses that will be announced to the nym-api and subsequently to the clients. In nearly all circumstances, it's going to be identical to the address you're going to use for bonding [env: NYMNODE_PUBLIC_IPS=] - --hostname - Optional hostname associated with this gateway that will be announced to the nym-api and subsequently to the clients [env: NYMNODE_HOSTNAME=] - --location - Optional **physical** location of this node's server. Either full country name (e.g. 'Poland'), two-letter alpha2 (e.g. 'PL'), three-letter alpha3 (e.g. 'POL') or three-digit numeric-3 (e.g. '616') can be provided [env: NYMNODE_LOCATION=] - --http-bind-address - Socket address this node will use for binding its http API. default: `0.0.0.0:8080` [env: NYMNODE_HTTP_BIND_ADDRESS=] - --landing-page-assets-path - Path to assets directory of custom landing page of this node [env: NYMNODE_HTTP_LANDING_ASSETS=] - --http-access-token - An optional bearer token for accessing certain http endpoints. Currently only used for prometheus metrics [env: NYMNODE_HTTP_ACCESS_TOKEN=] - --expose-system-info - Specify whether basic system information should be exposed. default: true [env: NYMNODE_HTTP_EXPOSE_SYSTEM_INFO=] [possible values: true, false] - --expose-system-hardware - Specify whether basic system hardware information should be exposed. default: true [env: NYMNODE_HTTP_EXPOSE_SYSTEM_HARDWARE=] [possible values: true, false] - --expose-crypto-hardware - Specify whether detailed system crypto hardware information should be exposed. default: true [env: NYMNODE_HTTP_EXPOSE_CRYPTO_HARDWARE=] [possible values: true, false] - --mixnet-bind-address - Address this node will bind to for listening for mixnet packets default: `0.0.0.0:1789` [env: NYMNODE_MIXNET_BIND_ADDRESS=] - --mixnet-announce-port - If applicable, custom port announced in the self-described API that other clients and nodes will use. Useful when the node is behind a proxy [env: NYMNODE_MIXNET_ANNOUNCE_PORT=] - --nym-api-urls - Addresses to nym APIs from which the node gets the view of the network [env: NYMNODE_NYM_APIS=] - --nyxd-urls - Addresses to nyxd chain endpoint which the node will use for chain interactions [env: NYMNODE_NYXD=] - --wireguard-enabled - Specifies whether the wireguard service is enabled on this node [env: NYMNODE_WG_ENABLED=] [possible values: true, false] - --wireguard-bind-address - Socket address this node will use for binding its wireguard interface. default: `0.0.0.0:51822` [env: NYMNODE_WG_BIND_ADDRESS=] - --wireguard-private-ip - Private IP address of the wireguard gateway. default: `10.1.0.1` [env: NYMNODE_WG_IP=] - --wireguard-announced-port - Port announced to external clients wishing to connect to the wireguard interface. Useful in the instances where the node is behind a proxy [env: NYMNODE_WG_ANNOUNCED_PORT=] - --wireguard-private-network-prefix - The prefix denoting the maximum number of the clients that can be connected via Wireguard. The maximum value for IPv4 is 32 and for IPv6 is 128 [env: NYMNODE_WG_PRIVATE_NETWORK_PREFIX=] - --verloc-bind-address - Socket address this node will use for binding its verloc API. default: `0.0.0.0:1790` [env: NYMNODE_VERLOC_BIND_ADDRESS=] - --verloc-announce-port - If applicable, custom port announced in the self-described API that other clients and nodes will use. Useful when the node is behind a proxy [env: NYMNODE_VERLOC_ANNOUNCE_PORT=] - --entry-bind-address - Socket address this node will use for binding its client websocket API. default: `0.0.0.0:9000` [env: NYMNODE_ENTRY_BIND_ADDRESS=] - --announce-ws-port - Custom announced port for listening for websocket client traffic. If unspecified, the value from the `bind_address` will be used instead [env: NYMNODE_ENTRY_ANNOUNCE_WS_PORT=] - --announce-wss-port - If applicable, announced port for listening for secure websocket client traffic [env: NYMNODE_ENTRY_ANNOUNCE_WSS_PORT=] - --enforce-zk-nyms - Indicates whether this gateway is accepting only coconut credentials for accessing the mixnet or if it also accepts non-paying clients [env: NYMNODE_ENFORCE_ZK_NYMS=] [possible values: true, false] - --mnemonic - Custom cosmos wallet mnemonic used for zk-nym redemption. If no value is provided, a fresh mnemonic is going to be generated [env: NYMNODE_MNEMONIC=] - --upstream-exit-policy-url - Specifies the url for an upstream source of the exit policy used by this node [env: NYMNODE_UPSTREAM_EXIT_POLICY=] - --open-proxy - Specifies whether this exit node should run in 'open-proxy' mode and thus would attempt to resolve **ANY** request it receives [env: NYMNODE_OPEN_PROXY=] [possible values: true, false] - -h, --help - Print help + -h, --help Print help ``` diff --git a/documentation/docs/components/outputs/command-outputs/nym-node-migrate.md b/documentation/docs/components/outputs/command-outputs/nym-node-migrate.md new file mode 100644 index 00000000000..cc4df86c173 --- /dev/null +++ b/documentation/docs/components/outputs/command-outputs/nym-node-migrate.md @@ -0,0 +1,6 @@ +```sh +** Attention ** +This binary DOES NOT' support migrating from older mixnode/gateway binaries anymore +please use an older version instead before attempting to use this binary again. + +``` diff --git a/documentation/docs/components/outputs/command-outputs/nym-node-node-details.md b/documentation/docs/components/outputs/command-outputs/nym-node-node-details.md index 37077dda8fe..d95dabfe4f6 100644 --- a/documentation/docs/components/outputs/command-outputs/nym-node-node-details.md +++ b/documentation/docs/components/outputs/command-outputs/nym-node-node-details.md @@ -1,3 +1,3 @@ ```sh -2024-11-06T12:18:46.742880Z ERROR nym-node/src/config/upgrade_helpers.rs:17: Failed to finish upgrade - failed to load config file using path '/home/m/.nym/nym-nodes/default-nym-node/config/config.toml'. detailed message: No such file or directory (os error 2) +2024-12-18T17:26:21.359402Z ERROR nym-node/src/config/upgrade_helpers.rs:19: Failed to finish upgrade - failed to load config file using path '/home/m/.nym/nym-nodes/default-nym-node/config/config.toml'. detailed message: No such file or directory (os error 2) ``` diff --git a/documentation/docs/components/outputs/command-outputs/nym-socks5-client-build-info.md b/documentation/docs/components/outputs/command-outputs/nym-socks5-client-build-info.md index 2727bfe476f..55b76d5c345 100644 --- a/documentation/docs/components/outputs/command-outputs/nym-socks5-client-build-info.md +++ b/documentation/docs/components/outputs/command-outputs/nym-socks5-client-build-info.md @@ -1,10 +1,10 @@ ```sh Binary Name: nym-socks5-client -Build Timestamp: 2024-12-18T10:26:40.905460408Z -Build Version: 1.1.44 -Commit SHA: 62045d76b32265f6a5e6358ab7aebbc827d47dcd -Commit Date: 2024-11-26T11:53:05.000000000+01:00 +Build Timestamp: 2024-12-18T17:18:44.233208652Z +Build Version: 1.1.45 +Commit SHA: b628a5f8148f74c646915292c8b6dc0a46202a27 +Commit Date: 2024-12-13T11:49:27.000000000+01:00 Commit Branch: master rustc Version: 1.84.0-nightly rustc Channel: nightly diff --git a/documentation/docs/components/outputs/command-outputs/nym-socks5-client-generate-fig-spec.md b/documentation/docs/components/outputs/command-outputs/nym-socks5-client-generate-fig-spec.md index 49a1f244a4a..c20d3067a84 100644 --- a/documentation/docs/components/outputs/command-outputs/nym-socks5-client-generate-fig-spec.md +++ b/documentation/docs/components/outputs/command-outputs/nym-socks5-client-generate-fig-spec.md @@ -68,6 +68,16 @@ const completion: Fig.Spec = { ], }, }, + { + name: "--stats-reporting-address", + description: "Sets the address to report statistics", + hidden: true, + isRepeatable: true, + args: { + name: "stats_reporting_address", + isOptional: true, + }, + }, { name: "--provider", description: "Address of the socks5 provider to send messages to", @@ -209,6 +219,16 @@ const completion: Fig.Spec = { ], }, }, + { + name: "--stats-reporting-address", + description: "Sets the address to report statistics", + hidden: true, + isRepeatable: true, + args: { + name: "stats_reporting_address", + isOptional: true, + }, + }, { name: "--use-anonymous-replies", description: "Specifies whether this client is going to use an anonymous sender tag for communication with the service provider. While this is going to hide its actual address information, it will make the actual communication slower and consume nearly double the bandwidth as it will require sending reply SURBs", diff --git a/documentation/docs/components/outputs/command-outputs/nymvisor-build-info.md b/documentation/docs/components/outputs/command-outputs/nymvisor-build-info.md index b5f79a2571d..4ccfc17e839 100644 --- a/documentation/docs/components/outputs/command-outputs/nymvisor-build-info.md +++ b/documentation/docs/components/outputs/command-outputs/nymvisor-build-info.md @@ -1,10 +1,10 @@ ```sh Binary Name: nymvisor -Build Timestamp: 2024-12-18T10:26:40.905460408Z -Build Version: 0.1.9 -Commit SHA: 62045d76b32265f6a5e6358ab7aebbc827d47dcd -Commit Date: 2024-11-26T11:53:05.000000000+01:00 +Build Timestamp: 2024-12-18T17:18:44.233208652Z +Build Version: 0.1.10 +Commit SHA: b628a5f8148f74c646915292c8b6dc0a46202a27 +Commit Date: 2024-12-13T11:49:27.000000000+01:00 Commit Branch: master rustc Version: 1.84.0-nightly rustc Channel: nightly diff --git a/documentation/docs/pages/developers/clients/socks5/commands.mdx b/documentation/docs/pages/developers/clients/socks5/commands.mdx index d48d0f9300c..4aa89f236ca 100644 --- a/documentation/docs/pages/developers/clients/socks5/commands.mdx +++ b/documentation/docs/pages/developers/clients/socks5/commands.mdx @@ -152,10 +152,10 @@ Example output: ```sh Binary Name: nym-socks5-client -Build Timestamp: 2024-12-18T10:26:40.905460408Z -Build Version: 1.1.44 -Commit SHA: 62045d76b32265f6a5e6358ab7aebbc827d47dcd -Commit Date: 2024-11-26T11:53:05.000000000+01:00 +Build Timestamp: 2024-12-18T17:18:44.233208652Z +Build Version: 1.1.45 +Commit SHA: b628a5f8148f74c646915292c8b6dc0a46202a27 +Commit Date: 2024-12-13T11:49:27.000000000+01:00 Commit Branch: master rustc Version: 1.84.0-nightly rustc Channel: nightly @@ -256,6 +256,16 @@ const completion: Fig.Spec = { ], }, }, + { + name: "--stats-reporting-address", + description: "Sets the address to report statistics", + hidden: true, + isRepeatable: true, + args: { + name: "stats_reporting_address", + isOptional: true, + }, + }, { name: "--provider", description: "Address of the socks5 provider to send messages to", @@ -397,6 +407,16 @@ const completion: Fig.Spec = { ], }, }, + { + name: "--stats-reporting-address", + description: "Sets the address to report statistics", + hidden: true, + isRepeatable: true, + args: { + name: "stats_reporting_address", + isOptional: true, + }, + }, { name: "--use-anonymous-replies", description: "Specifies whether this client is going to use an anonymous sender tag for communication with the service provider. While this is going to hide its actual address information, it will make the actual communication slower and consume nearly double the bandwidth as it will require sending reply SURBs", diff --git a/documentation/docs/pages/developers/clients/websocket/commands.mdx b/documentation/docs/pages/developers/clients/websocket/commands.mdx index b7d67e26cd8..c4acbefa6ec 100644 --- a/documentation/docs/pages/developers/clients/websocket/commands.mdx +++ b/documentation/docs/pages/developers/clients/websocket/commands.mdx @@ -117,10 +117,10 @@ Example output: ```sh Binary Name: nym-client -Build Timestamp: 2024-12-18T10:26:40.905460408Z -Build Version: 1.1.44 -Commit SHA: 62045d76b32265f6a5e6358ab7aebbc827d47dcd -Commit Date: 2024-11-26T11:53:05.000000000+01:00 +Build Timestamp: 2024-12-18T17:18:44.233208652Z +Build Version: 1.1.45 +Commit SHA: b628a5f8148f74c646915292c8b6dc0a46202a27 +Commit Date: 2024-12-13T11:49:27.000000000+01:00 Commit Branch: master rustc Version: 1.84.0-nightly rustc Channel: nightly @@ -221,6 +221,16 @@ const completion: Fig.Spec = { ], }, }, + { + name: "--stats-reporting-address", + description: "Sets the address to report statistics", + hidden: true, + isRepeatable: true, + args: { + name: "stats_reporting_address", + isOptional: true, + }, + }, { name: "--disable-socket", description: "Whether to not start the websocket", @@ -354,6 +364,16 @@ const completion: Fig.Spec = { ], }, }, + { + name: "--stats-reporting-address", + description: "Sets the address to report statistics", + hidden: true, + isRepeatable: true, + args: { + name: "stats_reporting_address", + isOptional: true, + }, + }, { name: "--disable-socket", description: "Whether to not start the websocket",