From 276d4318beecdd8eb3a870e4bd6ecbe3edb2f9b0 Mon Sep 17 00:00:00 2001 From: mx <33262279+mfahampshire@users.noreply.github.com> Date: Tue, 22 Oct 2024 19:22:05 +0000 Subject: [PATCH] Max/individual command autodocs (#5015) * auto commit generated command files * added to autodoc.sh: build all binaries before running * autodoc move individual command outputs to components --- documentation/autodoc/.gitignore | 1 - .../nym-api-build-info-help.md | 9 + .../nym-api-build-info.md | 13 + .../nym-api-commands.md | 87 ++ .../nym-api-init-help.md | 25 + .../nym-cli-commands.md | 1105 +++++++++++++++++ .../nym-client-build-info-help.md | 9 + .../nym-client-build-info.md | 13 + .../nym-client-commands.md | 754 +++++++++++ .../nym-client-completions-help.md | 11 + .../nym-client-generate-fig-spec-help.md | 8 + .../nym-client-generate-fig-spec.md | 585 +++++++++ .../nym-client-import-credential-help.md | 15 + .../nym-client-init-help.md | 27 + .../nym-client-list-gateways-help.md | 10 + .../nym-client-run-help.md | 21 + .../nym-client-switch-gateway-help.md | 10 + .../nym-node-bonding-information-help.md | 12 + .../nym-node-bonding-information.md | 3 + .../nym-node-build-info-help.md | 9 + .../nym-node-build-info.md | 13 + .../nym-node-commands.md | 229 ++++ .../nym-node-migrate-help.md | 68 + .../nym-node-node-details-help.md | 11 + .../nym-node-node-details.md | 3 + .../nym-node-sign-help.md | 13 + .../nym-socks5-client-add-gateway-help.md | 15 + .../nym-socks5-client-build-info-help.md | 9 + .../nym-socks5-client-build-info.md | 13 + .../nym-socks5-client-commands.md | 823 ++++++++++++ .../nym-socks5-client-completions-help.md | 11 + ...ym-socks5-client-generate-fig-spec-help.md | 8 + .../nym-socks5-client-generate-fig-spec.md | 619 +++++++++ ...ym-socks5-client-import-credential-help.md | 15 + .../nym-socks5-client-init-help.md | 44 + .../nym-socks5-client-list-gateways-help.md | 10 + .../nym-socks5-client-run-help.md | 34 + .../nymvisor-add-upgrade-help.md | 19 + .../nymvisor-build-info-help.md | 9 + .../nymvisor-build-info.md | 13 + .../nymvisor-commands.md | 154 +++ .../nymvisor-config-help.md | 9 + .../nymvisor-daemon-build-info-help.md | 9 + .../nymvisor-init-help.md | 48 + documentation/autodoc/src/main.rs | 89 ++ .../nym-api-build-info-help.md | 9 + .../command-outputs/nym-api-build-info.md | 13 + .../nym-client-build-info-help.md | 9 + .../command-outputs/nym-client-build-info.md | 13 + .../nym-client-generate-fig-spec-help.md | 8 + .../nym-client-generate-fig-spec.md | 585 +++++++++ .../nym-node-bonding-information-help.md | 12 + .../nym-node-bonding-information.md | 3 + .../nym-node-build-info-help.md | 9 + .../command-outputs/nym-node-build-info.md | 13 + .../nym-node-node-details-help.md | 11 + .../command-outputs/nym-node-node-details.md | 3 + .../nym-socks5-client-build-info-help.md | 9 + .../nym-socks5-client-build-info.md | 13 + ...ym-socks5-client-generate-fig-spec-help.md | 8 + .../nym-socks5-client-generate-fig-spec.md | 619 +++++++++ .../nymvisor-build-info-help.md | 9 + .../command-outputs/nymvisor-build-info.md | 13 + .../developers/clients/socks5/commands.mdx | 8 +- .../developers/clients/websocket/commands.mdx | 8 +- documentation/scripts/next-scripts/autodoc.sh | 23 +- 66 files changed, 6395 insertions(+), 18 deletions(-) delete mode 100644 documentation/autodoc/.gitignore create mode 100644 documentation/autodoc/autodoc-generated-markdown/nym-api-build-info-help.md create mode 100644 documentation/autodoc/autodoc-generated-markdown/nym-api-build-info.md create mode 100644 documentation/autodoc/autodoc-generated-markdown/nym-api-commands.md create mode 100644 documentation/autodoc/autodoc-generated-markdown/nym-api-init-help.md create mode 100644 documentation/autodoc/autodoc-generated-markdown/nym-cli-commands.md create mode 100644 documentation/autodoc/autodoc-generated-markdown/nym-client-build-info-help.md create mode 100644 documentation/autodoc/autodoc-generated-markdown/nym-client-build-info.md create mode 100644 documentation/autodoc/autodoc-generated-markdown/nym-client-commands.md create mode 100644 documentation/autodoc/autodoc-generated-markdown/nym-client-completions-help.md create mode 100644 documentation/autodoc/autodoc-generated-markdown/nym-client-generate-fig-spec-help.md create mode 100644 documentation/autodoc/autodoc-generated-markdown/nym-client-generate-fig-spec.md create mode 100644 documentation/autodoc/autodoc-generated-markdown/nym-client-import-credential-help.md create mode 100644 documentation/autodoc/autodoc-generated-markdown/nym-client-init-help.md create mode 100644 documentation/autodoc/autodoc-generated-markdown/nym-client-list-gateways-help.md create mode 100644 documentation/autodoc/autodoc-generated-markdown/nym-client-run-help.md create mode 100644 documentation/autodoc/autodoc-generated-markdown/nym-client-switch-gateway-help.md create mode 100644 documentation/autodoc/autodoc-generated-markdown/nym-node-bonding-information-help.md create mode 100644 documentation/autodoc/autodoc-generated-markdown/nym-node-bonding-information.md create mode 100644 documentation/autodoc/autodoc-generated-markdown/nym-node-build-info-help.md create mode 100644 documentation/autodoc/autodoc-generated-markdown/nym-node-build-info.md create mode 100644 documentation/autodoc/autodoc-generated-markdown/nym-node-commands.md create mode 100644 documentation/autodoc/autodoc-generated-markdown/nym-node-migrate-help.md create mode 100644 documentation/autodoc/autodoc-generated-markdown/nym-node-node-details-help.md create mode 100644 documentation/autodoc/autodoc-generated-markdown/nym-node-node-details.md create mode 100644 documentation/autodoc/autodoc-generated-markdown/nym-node-sign-help.md create mode 100644 documentation/autodoc/autodoc-generated-markdown/nym-socks5-client-add-gateway-help.md create mode 100644 documentation/autodoc/autodoc-generated-markdown/nym-socks5-client-build-info-help.md create mode 100644 documentation/autodoc/autodoc-generated-markdown/nym-socks5-client-build-info.md create mode 100644 documentation/autodoc/autodoc-generated-markdown/nym-socks5-client-commands.md create mode 100644 documentation/autodoc/autodoc-generated-markdown/nym-socks5-client-completions-help.md create mode 100644 documentation/autodoc/autodoc-generated-markdown/nym-socks5-client-generate-fig-spec-help.md create mode 100644 documentation/autodoc/autodoc-generated-markdown/nym-socks5-client-generate-fig-spec.md create mode 100644 documentation/autodoc/autodoc-generated-markdown/nym-socks5-client-import-credential-help.md create mode 100644 documentation/autodoc/autodoc-generated-markdown/nym-socks5-client-init-help.md create mode 100644 documentation/autodoc/autodoc-generated-markdown/nym-socks5-client-list-gateways-help.md create mode 100644 documentation/autodoc/autodoc-generated-markdown/nym-socks5-client-run-help.md create mode 100644 documentation/autodoc/autodoc-generated-markdown/nymvisor-add-upgrade-help.md create mode 100644 documentation/autodoc/autodoc-generated-markdown/nymvisor-build-info-help.md create mode 100644 documentation/autodoc/autodoc-generated-markdown/nymvisor-build-info.md create mode 100644 documentation/autodoc/autodoc-generated-markdown/nymvisor-commands.md create mode 100644 documentation/autodoc/autodoc-generated-markdown/nymvisor-config-help.md create mode 100644 documentation/autodoc/autodoc-generated-markdown/nymvisor-daemon-build-info-help.md create mode 100644 documentation/autodoc/autodoc-generated-markdown/nymvisor-init-help.md create mode 100644 documentation/docs/components/outputs/command-outputs/nym-api-build-info-help.md create mode 100644 documentation/docs/components/outputs/command-outputs/nym-api-build-info.md create mode 100644 documentation/docs/components/outputs/command-outputs/nym-client-build-info-help.md create mode 100644 documentation/docs/components/outputs/command-outputs/nym-client-build-info.md create mode 100644 documentation/docs/components/outputs/command-outputs/nym-client-generate-fig-spec-help.md create mode 100644 documentation/docs/components/outputs/command-outputs/nym-client-generate-fig-spec.md create mode 100644 documentation/docs/components/outputs/command-outputs/nym-node-bonding-information-help.md create mode 100644 documentation/docs/components/outputs/command-outputs/nym-node-bonding-information.md create mode 100644 documentation/docs/components/outputs/command-outputs/nym-node-build-info-help.md create mode 100644 documentation/docs/components/outputs/command-outputs/nym-node-build-info.md create mode 100644 documentation/docs/components/outputs/command-outputs/nym-node-node-details-help.md create mode 100644 documentation/docs/components/outputs/command-outputs/nym-node-node-details.md create mode 100644 documentation/docs/components/outputs/command-outputs/nym-socks5-client-build-info-help.md create mode 100644 documentation/docs/components/outputs/command-outputs/nym-socks5-client-build-info.md create mode 100644 documentation/docs/components/outputs/command-outputs/nym-socks5-client-generate-fig-spec-help.md create mode 100644 documentation/docs/components/outputs/command-outputs/nym-socks5-client-generate-fig-spec.md create mode 100644 documentation/docs/components/outputs/command-outputs/nymvisor-build-info-help.md create mode 100644 documentation/docs/components/outputs/command-outputs/nymvisor-build-info.md diff --git a/documentation/autodoc/.gitignore b/documentation/autodoc/.gitignore deleted file mode 100644 index 3b29b86939..0000000000 --- a/documentation/autodoc/.gitignore +++ /dev/null @@ -1 +0,0 @@ -/autodoc-generated-markdown/* diff --git a/documentation/autodoc/autodoc-generated-markdown/nym-api-build-info-help.md b/documentation/autodoc/autodoc-generated-markdown/nym-api-build-info-help.md new file mode 100644 index 0000000000..db52a92b4e --- /dev/null +++ b/documentation/autodoc/autodoc-generated-markdown/nym-api-build-info-help.md @@ -0,0 +1,9 @@ +```sh +Show build information of this binary + +Usage: nym-api build-info [OPTIONS] + +Options: + -o, --output [default: text] [possible values: text, json] + -h, --help Print help +``` diff --git a/documentation/autodoc/autodoc-generated-markdown/nym-api-build-info.md b/documentation/autodoc/autodoc-generated-markdown/nym-api-build-info.md new file mode 100644 index 0000000000..c04a06ee09 --- /dev/null +++ b/documentation/autodoc/autodoc-generated-markdown/nym-api-build-info.md @@ -0,0 +1,13 @@ +```sh + +Binary Name: nym-api +Build Timestamp: 2024-10-09T13:56:14.428750844Z +Build Version: 1.1.42 +Commit SHA: fac373c1db4fa5389ba61de7943c77023467bccb +Commit Date: 2024-10-09T14:59:40.000000000+02:00 +Commit Branch: max/new-docs-framework +rustc Version: 1.80.0 +rustc Channel: stable +cargo Profile: release + +``` diff --git a/documentation/autodoc/autodoc-generated-markdown/nym-api-commands.md b/documentation/autodoc/autodoc-generated-markdown/nym-api-commands.md new file mode 100644 index 0000000000..ee83178c62 --- /dev/null +++ b/documentation/autodoc/autodoc-generated-markdown/nym-api-commands.md @@ -0,0 +1,87 @@ +# `nym-api` Binary Commands (Autogenerated) + +These docs are autogenerated by the [`autodocs`](https://github.com/nymtech/nym/tree/max/new-docs-framework/documentation/autodoc) script. +```sh +Usage: nym-api [OPTIONS] + +Commands: + init Initialise a Nym Api instance with persistent config.toml file + run Run the Nym Api with provided configuration optionally overriding set parameters + build-info Show build information of this binary + help Print this message or the help of the given subcommand(s) + +Options: + -c, --config-env-file + Path pointing to an env file that configures the Nym API + --no-banner + A no-op flag included for consistency with other binaries (and compatibility with nymvisor, oops) + -h, --help + Print help + -V, --version + Print version +``` + +### `init` +```sh +Initialise a Nym Api instance with persistent config.toml file + +Usage: nym-api init [OPTIONS] + +Options: + --id + Id of the nym-api we want to initialise. if unspecified, a default value will be used. default: "default" [default: default] + -m, --enable-monitor + Specifies whether network monitoring is enabled on this API default: false + -r, --enable-rewarding + Specifies whether network rewarding is enabled on this API default: false + --nyxd-validator + Endpoint to nyxd instance used for contract information. default: http://localhost:26657 + --mnemonic + Mnemonic of the network monitor used for sending rewarding and zk-nyms transactions default: None + --enable-zk-nym + Flag to indicate whether credential signer authority is enabled on this API default: false + --announce-address + Announced address that is going to be put in the DKG contract where zk-nym clients will connect to obtain their credentials default: None + --monitor-credentials-mode + Set this nym api to work in a enabled credentials that would attempt to use gateway with the bandwidth credential requirement + -h, --help + Print help +``` + +### `run` +```sh +Run the Nym Api with provided configuration optionally overriding set parameters + +Usage: nym-api run [OPTIONS] + +Options: + --id + Id of the nym-api we want to run.if unspecified, a default value will be used. default: "default" [default: default] + -m, --enable-monitor + Specifies whether network monitoring is enabled on this API default: None - config value will be used instead [possible values: true, false] + -r, --enable-rewarding + Specifies whether network rewarding is enabled on this API default: None - config value will be used instead [possible values: true, false] + --nyxd-validator + Endpoint to nyxd instance used for contract information. default: None - config value will be used instead + --mnemonic + Mnemonic of the network monitor used for sending rewarding and zk-nyms transactions default: None - config value will be used instead + --enable-zk-nym + Flag to indicate whether coconut signer authority is enabled on this API default: None - config value will be used instead [possible values: true, false] + --announce-address + Announced address that is going to be put in the DKG contract where zk-nym clients will connect to obtain their credentials default: None - config value will be used instead + --monitor-credentials-mode + Set this nym api to work in a enabled credentials that would attempt to use gateway with the bandwidth credential requirement default: None - config value will be used instead [possible values: true, false] + -h, --help + Print help +``` + +### `build-info` +```sh +Show build information of this binary + +Usage: nym-api build-info [OPTIONS] + +Options: + -o, --output [default: text] [possible values: text, json] + -h, --help Print help +``` diff --git a/documentation/autodoc/autodoc-generated-markdown/nym-api-init-help.md b/documentation/autodoc/autodoc-generated-markdown/nym-api-init-help.md new file mode 100644 index 0000000000..bd4c714a28 --- /dev/null +++ b/documentation/autodoc/autodoc-generated-markdown/nym-api-init-help.md @@ -0,0 +1,25 @@ +```sh +Initialise a Nym Api instance with persistent config.toml file + +Usage: nym-api init [OPTIONS] + +Options: + --id + Id of the nym-api we want to initialise. if unspecified, a default value will be used. default: "default" [default: default] + -m, --enable-monitor + Specifies whether network monitoring is enabled on this API default: false + -r, --enable-rewarding + Specifies whether network rewarding is enabled on this API default: false + --nyxd-validator + Endpoint to nyxd instance used for contract information. default: http://localhost:26657 + --mnemonic + Mnemonic of the network monitor used for sending rewarding and zk-nyms transactions default: None + --enable-zk-nym + Flag to indicate whether credential signer authority is enabled on this API default: false + --announce-address + Announced address that is going to be put in the DKG contract where zk-nym clients will connect to obtain their credentials default: None + --monitor-credentials-mode + Set this nym api to work in a enabled credentials that would attempt to use gateway with the bandwidth credential requirement + -h, --help + Print help +``` diff --git a/documentation/autodoc/autodoc-generated-markdown/nym-cli-commands.md b/documentation/autodoc/autodoc-generated-markdown/nym-cli-commands.md new file mode 100644 index 0000000000..52461f8b7c --- /dev/null +++ b/documentation/autodoc/autodoc-generated-markdown/nym-cli-commands.md @@ -0,0 +1,1105 @@ +# `nym-cli` Binary Commands (Autogenerated) + +These docs are autogenerated by the [`autodocs`](https://github.com/nymtech/nym/tree/max/new-docs-framework/documentation/autodoc) script. +```sh +A client for interacting with Nym smart contracts and the Nyx blockchain + +Usage: nym-cli [OPTIONS] + +Commands: + account Query and manage Nyx blockchain accounts + signature Sign and verify messages + ecash Ecash related stuff + block Query chain blocks + cosmwasm Manage and execute WASM smart contracts + tx Query for transactions + vesting-schedule Create and query for a vesting schedule + mixnet Manage your mixnet infrastructure, delegate stake or query the directory + generate-fig Generates shell completion + help Print this message or the help of the given subcommand(s) + +Options: + --mnemonic + Provide the mnemonic for your account. You can also provide this is an env var called MNEMONIC. + -c, --config-env-file + Overrides configuration as a file of environment variables. Note: individual env vars take precedence over this file. + --nyxd-url + Overrides the nyxd URL provided either as an environment variable NYXD_VALIDATOR or in a config file + --nym-api-url + Overrides the validator API URL provided either as an environment variable API_VALIDATOR or in a config file + --mixnet-contract-address + Overrides the mixnet contract address provided either as an environment variable or in a config file + --vesting-contract-address + Overrides the vesting contract address provided either as an environment variable or in a config file + -h, --help + Print help +``` + +## `account` +```sh +Query and manage Nyx blockchain accounts + +Usage: nym-cli account [OPTIONS] + nym-cli account + +Commands: + create Create a new mnemonic - note, this account does not appear on the chain until the account id is used in a transaction + balance Gets the balance of an account + pub-key Gets the public key of an account + send Sends tokens to another account + send-multiple Batch multiple token sends + help Print this message or the help of the given subcommand(s) + +Options: + --mnemonic + Provide the mnemonic for your account. You can also provide this is an env var called MNEMONIC. + -c, --config-env-file + Overrides configuration as a file of environment variables. Note: individual env vars take precedence over this file. + --nyxd-url + Overrides the nyxd URL provided either as an environment variable NYXD_VALIDATOR or in a config file + --nym-api-url + Overrides the validator API URL provided either as an environment variable API_VALIDATOR or in a config file + --mixnet-contract-address + Overrides the mixnet contract address provided either as an environment variable or in a config file + --vesting-contract-address + Overrides the vesting contract address provided either as an environment variable or in a config file + -h, --help + Print help +``` + +### `account create` +```sh +Create a new mnemonic - note, this account does not appear on the chain until the account id is used in a transaction + +Usage: nym-cli account create [OPTIONS] + +Options: + --mnemonic + Provide the mnemonic for your account. You can also provide this is an env var called MNEMONIC. + --word-count + + -c, --config-env-file + Overrides configuration as a file of environment variables. Note: individual env vars take precedence over this file. + --nyxd-url + Overrides the nyxd URL provided either as an environment variable NYXD_VALIDATOR or in a config file + --nym-api-url + Overrides the validator API URL provided either as an environment variable API_VALIDATOR or in a config file + --mixnet-contract-address + Overrides the mixnet contract address provided either as an environment variable or in a config file + --vesting-contract-address + Overrides the vesting contract address provided either as an environment variable or in a config file + -h, --help + Print help +``` + +### `account balance` +```sh +Gets the balance of an account + +Usage: nym-cli account balance [OPTIONS] [ADDRESS] + +Arguments: + [ADDRESS] The account address to get the balance for + +Options: + --denom + Optional currency to show balance for + --mnemonic + Provide the mnemonic for your account. You can also provide this is an env var called MNEMONIC. + -c, --config-env-file + Overrides configuration as a file of environment variables. Note: individual env vars take precedence over this file. + --hide-denom + Optionally hide the denom + --nyxd-url + Overrides the nyxd URL provided either as an environment variable NYXD_VALIDATOR or in a config file + --raw + Show as a raw value + --nym-api-url + Overrides the validator API URL provided either as an environment variable API_VALIDATOR or in a config file + --mixnet-contract-address + Overrides the mixnet contract address provided either as an environment variable or in a config file + --vesting-contract-address + Overrides the vesting contract address provided either as an environment variable or in a config file + -h, --help + Print help +``` + +### `account pub-key` +```sh +Gets the public key of an account + +Usage: nym-cli account pub-key [OPTIONS] [ADDRESS] + +Arguments: + [ADDRESS] Optionally, show the public key for this account address, otherwise generate the account address from the mnemonic + +Options: + --from-mnemonic + If set, get the public key from the mnemonic, rather than querying for it + --mnemonic + Provide the mnemonic for your account. You can also provide this is an env var called MNEMONIC. + -c, --config-env-file + Overrides configuration as a file of environment variables. Note: individual env vars take precedence over this file. + --nyxd-url + Overrides the nyxd URL provided either as an environment variable NYXD_VALIDATOR or in a config file + --nym-api-url + Overrides the validator API URL provided either as an environment variable API_VALIDATOR or in a config file + --mixnet-contract-address + Overrides the mixnet contract address provided either as an environment variable or in a config file + --vesting-contract-address + Overrides the vesting contract address provided either as an environment variable or in a config file + -h, --help + Print help +``` + +### `account send` +```sh +Sends tokens to another account + +Usage: nym-cli account send [OPTIONS] + +Arguments: + The recipient account address + Amount to transfer in micro denomination (e.g. unym or unyx) + +Options: + --denom + Override the denomination + --mnemonic + Provide the mnemonic for your account. You can also provide this is an env var called MNEMONIC. + -c, --config-env-file + Overrides configuration as a file of environment variables. Note: individual env vars take precedence over this file. + --memo + + --nyxd-url + Overrides the nyxd URL provided either as an environment variable NYXD_VALIDATOR or in a config file + --nym-api-url + Overrides the validator API URL provided either as an environment variable API_VALIDATOR or in a config file + --mixnet-contract-address + Overrides the mixnet contract address provided either as an environment variable or in a config file + --vesting-contract-address + Overrides the vesting contract address provided either as an environment variable or in a config file + -h, --help + Print help +``` + +### `account send-multiple` +```sh +Batch multiple token sends + +Usage: nym-cli account send-multiple [OPTIONS] --input + +Options: + --memo + + --mnemonic + Provide the mnemonic for your account. You can also provide this is an env var called MNEMONIC. + -c, --config-env-file + Overrides configuration as a file of environment variables. Note: individual env vars take precedence over this file. + --input + Input file path (CSV format) with account/amount pairs to send + --nyxd-url + Overrides the nyxd URL provided either as an environment variable NYXD_VALIDATOR or in a config file + --output + An output file path (CSV format) to create or append a log of results to + --nym-api-url + Overrides the validator API URL provided either as an environment variable API_VALIDATOR or in a config file + --mixnet-contract-address + Overrides the mixnet contract address provided either as an environment variable or in a config file + --vesting-contract-address + Overrides the vesting contract address provided either as an environment variable or in a config file + -h, --help + Print help +``` + +## `signature` +```sh +Sign and verify messages + +Usage: nym-cli signature [OPTIONS] + nym-cli signature + +Commands: + sign Sign a message + verify Verify a message + help Print this message or the help of the given subcommand(s) + +Options: + --mnemonic + Provide the mnemonic for your account. You can also provide this is an env var called MNEMONIC. + -c, --config-env-file + Overrides configuration as a file of environment variables. Note: individual env vars take precedence over this file. + --nyxd-url + Overrides the nyxd URL provided either as an environment variable NYXD_VALIDATOR or in a config file + --nym-api-url + Overrides the validator API URL provided either as an environment variable API_VALIDATOR or in a config file + --mixnet-contract-address + Overrides the mixnet contract address provided either as an environment variable or in a config file + --vesting-contract-address + Overrides the vesting contract address provided either as an environment variable or in a config file + -h, --help + Print help +``` + +### `signature sign` +```sh +Sign a message + +Usage: nym-cli signature sign [OPTIONS] + +Arguments: + The message to sign + +Options: + --mnemonic + Provide the mnemonic for your account. You can also provide this is an env var called MNEMONIC. + -c, --config-env-file + Overrides configuration as a file of environment variables. Note: individual env vars take precedence over this file. + --nyxd-url + Overrides the nyxd URL provided either as an environment variable NYXD_VALIDATOR or in a config file + --nym-api-url + Overrides the validator API URL provided either as an environment variable API_VALIDATOR or in a config file + --mixnet-contract-address + Overrides the mixnet contract address provided either as an environment variable or in a config file + --vesting-contract-address + Overrides the vesting contract address provided either as an environment variable or in a config file + -h, --help + Print help +``` + +### `signature verify` +```sh +Verify a message + +Usage: nym-cli signature verify [OPTIONS] + +Arguments: + The public key of the account, or the account id to query for a public key (NOTE: the account must have signed a message stored on the chain for the public key record to exist) + The signature to verify as hex + The message to verify as a string + +Options: + --mnemonic + Provide the mnemonic for your account. You can also provide this is an env var called MNEMONIC. + -c, --config-env-file + Overrides configuration as a file of environment variables. Note: individual env vars take precedence over this file. + --nyxd-url + Overrides the nyxd URL provided either as an environment variable NYXD_VALIDATOR or in a config file + --nym-api-url + Overrides the validator API URL provided either as an environment variable API_VALIDATOR or in a config file + --mixnet-contract-address + Overrides the mixnet contract address provided either as an environment variable or in a config file + --vesting-contract-address + Overrides the vesting contract address provided either as an environment variable or in a config file + -h, --help + Print help +``` + +## `ecash` +```sh +Ecash related stuff + +Usage: nym-cli ecash [OPTIONS] + nym-cli ecash + +Commands: + issue-ticket-book + recover-ticket-book + import-ticket-book + generate-ticket + import-coin-index-signatures + import-expiration-date-signatures + import-master-verification-key + help Print this message or the help of the given subcommand(s) + +Options: + --mnemonic + Provide the mnemonic for your account. You can also provide this is an env var called MNEMONIC. + -c, --config-env-file + Overrides configuration as a file of environment variables. Note: individual env vars take precedence over this file. + --nyxd-url + Overrides the nyxd URL provided either as an environment variable NYXD_VALIDATOR or in a config file + --nym-api-url + Overrides the validator API URL provided either as an environment variable API_VALIDATOR or in a config file + --mixnet-contract-address + Overrides the mixnet contract address provided either as an environment variable or in a config file + --vesting-contract-address + Overrides the vesting contract address provided either as an environment variable or in a config file + -h, --help + Print help +``` + +### `ecash issue-ticket-book` +```sh +Usage: nym-cli ecash issue-ticket-book [OPTIONS] <--client-config |--output-file > + +Options: + --mnemonic + Provide the mnemonic for your account. You can also provide this is an env var called MNEMONIC. + --ticketbook-type + Specify which type of ticketbook should be issued [default: v1-mixnet-entry] + -c, --config-env-file + Overrides configuration as a file of environment variables. Note: individual env vars take precedence over this file. + --client-config + Config file of the client that is supposed to use the credential + --nyxd-url + Overrides the nyxd URL provided either as an environment variable NYXD_VALIDATOR or in a config file + --output-file + Output file for the ticketbook + --bs58-output + Specifies whether the output file should use binary or bs58 encoded data + --nym-api-url + Overrides the validator API URL provided either as an environment variable API_VALIDATOR or in a config file + --include-expiration-date-signatures + Specifies whether the file output should contain expiration date signatures + --mixnet-contract-address + Overrides the mixnet contract address provided either as an environment variable or in a config file + --include-coin-index-signatures + Specifies whether the file output should contain coin index signatures + --vesting-contract-address + Overrides the vesting contract address provided either as an environment variable or in a config file + --include-master-verification-key + Specifies whether the file output should contain master verification key + --bs58-encoded-client-secret + Secret value that's used for deriving underlying ecash keypair + -h, --help + Print help +``` + +### `ecash recover-ticket-book` +```sh +Usage: nym-cli ecash recover-ticket-book [OPTIONS] --client-config + +Options: + --client-config + Config file of the client that is supposed to use the credential + --mnemonic + Provide the mnemonic for your account. You can also provide this is an env var called MNEMONIC. + -c, --config-env-file + Overrides configuration as a file of environment variables. Note: individual env vars take precedence over this file. + --nyxd-url + Overrides the nyxd URL provided either as an environment variable NYXD_VALIDATOR or in a config file + --nym-api-url + Overrides the validator API URL provided either as an environment variable API_VALIDATOR or in a config file + --mixnet-contract-address + Overrides the mixnet contract address provided either as an environment variable or in a config file + --vesting-contract-address + Overrides the vesting contract address provided either as an environment variable or in a config file + -h, --help + Print help +``` + +### `ecash import-ticket-book` +```sh +Usage: nym-cli ecash import-ticket-book [OPTIONS] --client-config <--credential-data |--credential-path > <--standalone|--full> + +Options: + --client-config + Config file of the client that is supposed to use the credential + --mnemonic + Provide the mnemonic for your account. You can also provide this is an env var called MNEMONIC. + -c, --config-env-file + Overrides configuration as a file of environment variables. Note: individual env vars take precedence over this file. + --credential-data + Explicitly provide the encoded credential data (as base58) + --credential-path + Specifies the path to file containing binary credential data + --nyxd-url + Overrides the nyxd URL provided either as an environment variable NYXD_VALIDATOR or in a config file + --nym-api-url + Overrides the validator API URL provided either as an environment variable API_VALIDATOR or in a config file + --standalone + Specifies whether we're attempting to import a standalone ticketbook (i.e. serialised `IssuedTicketBook`) + --full + Specifies whether we're attempting to import full ticketboot (i.e. one that **might** contain required global signatures; that is serialised `ImportableTicketBook`) + --mixnet-contract-address + Overrides the mixnet contract address provided either as an environment variable or in a config file + --vesting-contract-address + Overrides the vesting contract address provided either as an environment variable or in a config file + -h, --help + Print help +``` + +## `coconut` + +### `coconut generate-freepass` + +### `coconut issue-credentials` + +### `coconut recover-credentials` + +### `coconut import-credential` + +## `block` +```sh +Query chain blocks + +Usage: nym-cli block [OPTIONS] + nym-cli block + +Commands: + get Gets a block's details and prints as JSON + time Gets the block time at a height + current-height Gets the current block height + help Print this message or the help of the given subcommand(s) + +Options: + --mnemonic + Provide the mnemonic for your account. You can also provide this is an env var called MNEMONIC. + -c, --config-env-file + Overrides configuration as a file of environment variables. Note: individual env vars take precedence over this file. + --nyxd-url + Overrides the nyxd URL provided either as an environment variable NYXD_VALIDATOR or in a config file + --nym-api-url + Overrides the validator API URL provided either as an environment variable API_VALIDATOR or in a config file + --mixnet-contract-address + Overrides the mixnet contract address provided either as an environment variable or in a config file + --vesting-contract-address + Overrides the vesting contract address provided either as an environment variable or in a config file + -h, --help + Print help +``` + +### `block get` +```sh +Gets a block's details and prints as JSON + +Usage: nym-cli block get [OPTIONS] + +Arguments: + The block height + +Options: + --mnemonic + Provide the mnemonic for your account. You can also provide this is an env var called MNEMONIC. + -c, --config-env-file + Overrides configuration as a file of environment variables. Note: individual env vars take precedence over this file. + --nyxd-url + Overrides the nyxd URL provided either as an environment variable NYXD_VALIDATOR or in a config file + --nym-api-url + Overrides the validator API URL provided either as an environment variable API_VALIDATOR or in a config file + --mixnet-contract-address + Overrides the mixnet contract address provided either as an environment variable or in a config file + --vesting-contract-address + Overrides the vesting contract address provided either as an environment variable or in a config file + -h, --help + Print help +``` + +### `block time` +```sh +Gets the block time at a height + +Usage: nym-cli block time [OPTIONS] + +Arguments: + The block height + +Options: + --mnemonic + Provide the mnemonic for your account. You can also provide this is an env var called MNEMONIC. + -c, --config-env-file + Overrides configuration as a file of environment variables. Note: individual env vars take precedence over this file. + --nyxd-url + Overrides the nyxd URL provided either as an environment variable NYXD_VALIDATOR or in a config file + --nym-api-url + Overrides the validator API URL provided either as an environment variable API_VALIDATOR or in a config file + --mixnet-contract-address + Overrides the mixnet contract address provided either as an environment variable or in a config file + --vesting-contract-address + Overrides the vesting contract address provided either as an environment variable or in a config file + -h, --help + Print help +``` + +### `block current-height` +```sh +Gets the current block height + +Usage: nym-cli block current-height [OPTIONS] + +Options: + --mnemonic + Provide the mnemonic for your account. You can also provide this is an env var called MNEMONIC. + -c, --config-env-file + Overrides configuration as a file of environment variables. Note: individual env vars take precedence over this file. + --nyxd-url + Overrides the nyxd URL provided either as an environment variable NYXD_VALIDATOR or in a config file + --nym-api-url + Overrides the validator API URL provided either as an environment variable API_VALIDATOR or in a config file + --mixnet-contract-address + Overrides the mixnet contract address provided either as an environment variable or in a config file + --vesting-contract-address + Overrides the vesting contract address provided either as an environment variable or in a config file + -h, --help + Print help +``` + +## `cosmwasm` +```sh +Manage and execute WASM smart contracts + +Usage: nym-cli cosmwasm [OPTIONS] + nym-cli cosmwasm + +Commands: + upload Upload a smart contract WASM blob + init Init a WASM smart contract + generate-init-message Generate an instantiate message + migrate Migrate a WASM smart contract + execute Execute a WASM smart contract method + help Print this message or the help of the given subcommand(s) + +Options: + --mnemonic + Provide the mnemonic for your account. You can also provide this is an env var called MNEMONIC. + -c, --config-env-file + Overrides configuration as a file of environment variables. Note: individual env vars take precedence over this file. + --nyxd-url + Overrides the nyxd URL provided either as an environment variable NYXD_VALIDATOR or in a config file + --nym-api-url + Overrides the validator API URL provided either as an environment variable API_VALIDATOR or in a config file + --mixnet-contract-address + Overrides the mixnet contract address provided either as an environment variable or in a config file + --vesting-contract-address + Overrides the vesting contract address provided either as an environment variable or in a config file + -h, --help + Print help +``` + +### `cosmwasm upload` +```sh +Upload a smart contract WASM blob + +Usage: nym-cli cosmwasm upload [OPTIONS] --wasm-path + +Options: + --mnemonic + Provide the mnemonic for your account. You can also provide this is an env var called MNEMONIC. + --wasm-path + + -c, --config-env-file + Overrides configuration as a file of environment variables. Note: individual env vars take precedence over this file. + --memo + + --nyxd-url + Overrides the nyxd URL provided either as an environment variable NYXD_VALIDATOR or in a config file + --nym-api-url + Overrides the validator API URL provided either as an environment variable API_VALIDATOR or in a config file + --mixnet-contract-address + Overrides the mixnet contract address provided either as an environment variable or in a config file + --vesting-contract-address + Overrides the vesting contract address provided either as an environment variable or in a config file + -h, --help + Print help +``` + +### `cosmwasm init` +```sh +Init a WASM smart contract + +Usage: nym-cli cosmwasm init [OPTIONS] --init-message + +Arguments: + + +Options: + --memo + + --mnemonic + Provide the mnemonic for your account. You can also provide this is an env var called MNEMONIC. + -c, --config-env-file + Overrides configuration as a file of environment variables. Note: individual env vars take precedence over this file. + --label