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..d90aef843b --- /dev/null +++ b/documentation/autodoc/autodoc-generated-markdown/nym-api-commands.md @@ -0,0 +1,88 @@ +# `nym-api` Binary Commands + +These docs are autogenerated by the `autodocs` script. + +**TODO add link** +``` +Starting nym api... +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 + -h, --help Print help + -V, --version Print version +``` + +### `init` +``` +Starting nym api... +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` +``` +Starting nym api... +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` +``` +Starting nym api... +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-cli-commands.md b/documentation/autodoc/autodoc-generated-markdown/nym-cli-commands.md new file mode 100644 index 0000000000..8f0ae46705 --- /dev/null +++ b/documentation/autodoc/autodoc-generated-markdown/nym-cli-commands.md @@ -0,0 +1,909 @@ +# `nym-cli` Binary Commands + +These docs are autogenerated by the `autodocs` script. + +**TODO add link** +``` +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 + coconut Coconut 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 create` +``` +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 +``` +``` +suit hat mammal misery someone void domain napkin into false real flower priority limb network spawn sport dawn icon cage tuition shell lottery father +n1sye7xctzwjq9m6w50wh0dnvk9787jryau6wcvu +``` + +### `account balance` +``` +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` +``` +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` +``` +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` +``` +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 sign` +``` +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` +``` +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 +``` +``` +``` + +### `coconut generate-freepass` +``` +Usage: nym-cli coconut generate-freepass [OPTIONS] --output-dir <--expiration-date |--expiration-timestamp > + +Options: + --expiration-date + Specifies the expiration date of the free pass(es) Can't be set to more than a week into the future + --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. + --expiration-timestamp + The expiration of the free pass(es) expresses as unix timestamp. Can't be set to more than a week into the future + --amount + The number of free passes to issue [default: 1] + --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 + --output-dir + Path to the output directory for generated free passes + --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 issue-credentials` +``` +Usage: nym-cli coconut issue-credentials [OPTIONS] --client-config --recovery-dir + +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. + --amount + The amount of utokens the credential will hold [default: 0] + -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 + --recovery-dir + Path to a directory used to store recovery files for unconsumed deposits + --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 +``` +``` +``` + +### `coconut recover-credentials` +``` +Usage: nym-cli coconut recover-credentials [OPTIONS] --client-config --recovery-dir + +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. + --recovery-dir + Path to a directory used to store recovery files for unconsumed deposits + --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 +``` +``` +``` + +### `coconut import-credential` +``` +Usage: nym-cli coconut import-credential [OPTIONS] --client-config <--credential-data |--credential-path > + +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 + --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` +``` +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` +``` +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` +``` +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 +``` +``` +Current block height: +12528833 +``` + +### `cosmwasm upload` +``` +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` +``` +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