From 9fded8f8a06ed7f4a3a8dd22975913f71c5f105a Mon Sep 17 00:00:00 2001 From: hunvy Date: Fri, 29 Mar 2024 00:06:53 +0700 Subject: [PATCH] Feat utils.mdx --- packages/docs/pages/_meta.json | 5 +- .../docs/pages/introduction/quick-start.mdx | 2 + packages/docs/pages/utils.mdx | 114 ++++++++++++++++++ 3 files changed, 119 insertions(+), 2 deletions(-) create mode 100644 packages/docs/pages/utils.mdx diff --git a/packages/docs/pages/_meta.json b/packages/docs/pages/_meta.json index dfd35081..ff68ea17 100644 --- a/packages/docs/pages/_meta.json +++ b/packages/docs/pages/_meta.json @@ -4,5 +4,6 @@ "users": "User Guide", "operators": "Operator Guide", "integrating-with-namada" : "Integration Guide", - "networks": "Networks" -} + "networks": "Networks", + "utils": "Utils" +} \ No newline at end of file diff --git a/packages/docs/pages/introduction/quick-start.mdx b/packages/docs/pages/introduction/quick-start.mdx index b0aa3d08..84d95f98 100644 --- a/packages/docs/pages/introduction/quick-start.mdx +++ b/packages/docs/pages/introduction/quick-start.mdx @@ -20,6 +20,8 @@ If you build from source, and run `make install`, the binaries will be installed See [the networks page](../networks.mdx) for details on how to join a network. The rest of this guide will assume you have joined a network using the `namadac utils join-network --chain-id ` command. +See [all utilities command](../utils.mdx). + ## Run a ledger node We recommend this step with [tmux](https://www.hamvocke.com/blog/a-quick-and-easy-guide-to-tmux/), which allows the node to keep running without needing the terminal to be open indefinitely. If not, skip to the subsequent step. diff --git a/packages/docs/pages/utils.mdx b/packages/docs/pages/utils.mdx new file mode 100644 index 00000000..10c342ad --- /dev/null +++ b/packages/docs/pages/utils.mdx @@ -0,0 +1,114 @@ +# Commands + +Usage: `namadac utils [OPTIONS] ` + +## join-network + +Configure Namada to join an existing network. +See [the networks page](../networks.mdx) for details on how to join a network. +```shell copy +namadac utils join-network --chain-id +``` + +## fetch-wasms + +Ensure pre-built wasms are present. +```shell copy +namadac utils fetch-wasms --chain-id +``` + + +## validate-wasm + +Check that the provided wasm code is valid by the Namada standards. +```shell copy +namadac utils validate-wasm --code-path --chain-id +``` + +## init-network + +Initialize a new test network. + +```shell copy +namadac utils init-network --templates-path --wasm-checksums-path +--chain-prefix --genesis-time --chain-id +``` + +## derive-genesis-addresses + +Derive account addresses from a genesis txs toml file. +```shell copy +namadac utils derive-genesis-addresses --path --chain-id +``` + +## genesis-bond + +Bond to a validator at pre-genesis. +```shell copy +namadac utils genesis-bond --validator --amount --path --chain-id +``` + +## init-genesis-established-account + +Initialize an established account available at genesis. +```shell copy +namadac utils init-genesis-established-account --path --chain-id +``` + +## init-genesis-validator + +Initialize genesis validator's address, consensus key and validator account key and use it in the ledger's node. Appends validator creation and self-bond txs to a .toml file containing an established account tx. +```shell copy +namadac utils init-genesis-validator --alias --address
--path + --net-address --commission-rate --max-commission-rate-change + --self-bond-amount --email --chain-id +``` + +## pk-to-tm + +Convert a validator's consensus public key to a Tendermint address. +```shell copy +namadac utils pk-to-tm --public-key --chain-id +``` + +## default-base-dir + +Print the default base directory that would be used if --base-dir or NAMADA_BASE_DIR were not used to set the base directory. +```shell copy +namadac utils default-base-dir +``` + +## epoch-sleep + +Query for the current epoch, then sleep until the next epoch. +```shell copy +namadac utils epoch-sleep +``` + +## validate-genesis-templates + +Validate genesis templates. +```shell copy +namadac utils validate-genesis-templates --path --chain-id +``` + +## test-genesis + +Dry run genesis files and get a report on problems that may be found. +```shell copy +namadac utils test-genesis --path --chain-id +``` + +## sign-genesis-txs + +Sign genesis transaction(s). +```shell copy +namadac utils sign-genesis-txs --path --chain-id +``` + +## help + +Print this message or the help of the given subcommand(s). +```shell copy +namadac utils [COMMAND] --help +``` \ No newline at end of file