From 880cd6a3f7916c8bbdbe830fde39347de154c4fb Mon Sep 17 00:00:00 2001 From: brentstone Date: Thu, 8 Aug 2024 14:20:46 -0700 Subject: [PATCH] use shell env var syntax --- .../pages/users/wallet/file-system-wallet.mdx | 10 +++---- packages/docs/pages/utils.mdx | 30 +++++++++---------- 2 files changed, 20 insertions(+), 20 deletions(-) diff --git a/packages/docs/pages/users/wallet/file-system-wallet.mdx b/packages/docs/pages/users/wallet/file-system-wallet.mdx index 189c330d..b9f870da 100644 --- a/packages/docs/pages/users/wallet/file-system-wallet.mdx +++ b/packages/docs/pages/users/wallet/file-system-wallet.mdx @@ -26,7 +26,7 @@ password to encrypt the private key. Afterwards, your mnemonic will be printed t you need to restore your key at a later date. ```bash copy -namadaw gen --alias +namadaw gen --alias $YOUR_ALIAS ``` @@ -48,13 +48,13 @@ namadaw list or, if you only want to search for a specific address: ```bash copy -namadaw find --alias +namadaw find --alias $YOUR_ALIAS ``` ##### Recover an address from a mnemonic You can recover an existing key from a mnemonic and add it to your wallet with: ```bash copy -namadaw derive --alias +namadaw derive --alias $YOUR_ALIAS ``` (You will be prompted to enter the mnemonic). @@ -63,13 +63,13 @@ namadaw derive --alias If you know the raw value of a key or address, you can add it to your wallet under an alias so you can more conveniently refer to it later. ```bash copy -namadaw add --alias --value +namadaw add --alias $YOUR_ALIAS --value ``` #### Removing a key/address You can remove all keys/addresses associated with an alias from your wallet with: ```bash copy -namadaw remove --alias --do-it +namadaw remove --alias $YOUR_ALIAS --do-it ``` #### Using the pre-genesis flag diff --git a/packages/docs/pages/utils.mdx b/packages/docs/pages/utils.mdx index 043dda46..86aae93a 100644 --- a/packages/docs/pages/utils.mdx +++ b/packages/docs/pages/utils.mdx @@ -7,14 +7,14 @@ Usage: `namadac utils [OPTIONS] ` 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 +namadac utils join-network --chain-id $CHAIN_ID ``` ## fetch-wasms Ensure pre-built wasms are present. ```shell copy -namadac utils fetch-wasms --chain-id +namadac utils fetch-wasms --chain-id $CHAIN_ID ``` @@ -22,7 +22,7 @@ namadac utils fetch-wasms --chain-id Check that the provided wasm code is valid by the Namada standards. ```shell copy -namadac utils validate-wasm --code-path --chain-id +namadac utils validate-wasm --code-path $CODE_PATH --chain-id $CHAIN_ID ``` ## init-network @@ -30,45 +30,45 @@ namadac utils validate-wasm --code-path --chain-id Initialize a new test network. ```shell copy -namadac utils init-network --templates-path --wasm-checksums-path ---chain-prefix --genesis-time --chain-id +namadac utils init-network --templates-path $TEMPLATES_PATH --wasm-checksums-path $WASM_CHECKSUMS_PATH +--chain-prefix $CHAIN_PREFIX --genesis-time $GENESIS_TIME --chain-id $CHAIN_ID ``` ## derive-genesis-addresses Derive account addresses from a genesis txs toml file. ```shell copy -namadac utils derive-genesis-addresses --path --chain-id +namadac utils derive-genesis-addresses --path $PATH --chain-id $CHAIN_ID ``` ## genesis-bond Bond to a validator at pre-genesis. ```shell copy -namadac utils genesis-bond --validator --amount --path --chain-id +namadac utils genesis-bond --validator $VALIDATOR --amount $AMOUNT --path $PATH --chain-id $CHAIN_ID ``` ## init-genesis-established-account Initialize an established account available at genesis. ```shell copy -namadac utils init-genesis-established-account --path --chain-id +namadac utils init-genesis-established-account --path $PATH --chain-id $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 +namadac utils init-genesis-validator --alias $ALIAS --address $ADDRESS --path $PATH + --net-address $NET_ADDRESS --commission-rate $COMMISSION_RATE --max-commission-rate-change $MAX_COMMISSION_RATE_CHANGE + --self-bond-amount $SELF_BOND_AMOUNT --email $EMAIL --chain-id $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 +namadac utils pk-to-tm --public-key $PUB_KEY --chain-id $CHAIN_ID ``` ## default-base-dir @@ -89,21 +89,21 @@ namadac utils epoch-sleep Validate genesis templates. ```shell copy -namadac utils validate-genesis-templates --path --chain-id +namadac utils validate-genesis-templates --path $PATH --chain-id $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 +namadac utils test-genesis --path $PATH --chain-id $CHAIN_ID ``` ## sign-genesis-txs Sign genesis transaction(s). ```shell copy -namadac utils sign-genesis-txs --path --chain-id +namadac utils sign-genesis-txs --path $PATH --chain-id $CHAIN_ID ``` ## help