clarify placeholders

anoma · Nov 15, 2023 · f19a688 · f19a688
1 parent 681309a
commit f19a688
Show file tree

Hide file tree

Showing 5 changed files with 31 additions and 9 deletions.
diff --git a/packages/docs/pages/operators/validators/post-genesis-validator-setup.mdx b/packages/docs/pages/operators/validators/post-genesis-validator-setup.mdx
@@ -2,8 +2,12 @@ import { Callout } from 'nextra-theme-docs'
 
 # Generating a validator account
 
+<Callout type="info" emoji="🤡">
+Note that the use of the placeholder `aliace` for the alias parameter. This is a completely configurable parameter, and should just refer to the alias of the key/address generated.
+</Callout>
 ```bash copy
-namada wallet address gen --alias aliace
+KEY_ALIAS="aliace"
+namada wallet address gen --alias $KEY_ALIAS
 ```
 
 Now choose a name for your validator:
@@ -17,8 +21,8 @@ A validator account requires additional keys compared to a user account, so star
 ```bash copy
 namada client init-validator \
   --alias $VALIDATOR_ALIAS \
-  --account-keys aliace \
-  --signing-keys aliace \
+  --account-keys $KEY_ALIAS \
+  --signing-keys $KEY_ALIAS \
   --commission-rate <enter-your-commission-rate> \
   --max-commission-rate-change <enter-decimal-rate>
 ```

diff --git a/packages/docs/pages/operators/validators/staking.mdx b/packages/docs/pages/operators/validators/staking.mdx
@@ -6,6 +6,10 @@ We discuss two types of bonding:
 
 ## Non-self bonding (delegating)
 
+<Callout type="info" emoji="🤡">
+Note that the use of the placeholder `aliace` for the alias parameter. This is a completely configurable parameter, and should just refer to the alias of the key/address used to bond.
+</Callout>
+
 Users can bond to any number of validators at any time. When a user bond tokens, the bonds won't count towards the validator's stake (which in turn determines its voting power) until the beginning of epoch `n + 2` in the current epoch `n` (the literal `2` is set by PoS parameter `pipeline_len`). The bonded tokens will be deducted from the bonder's account immediately, and will be credited to the PoS system's account.
 
 To bond tokens from the source address with alias `aliace` to a validator with alias `validator-1`:

diff --git a/packages/docs/pages/users/fees.mdx b/packages/docs/pages/users/fees.mdx
@@ -5,6 +5,10 @@ In order to settle the market for Namada blockspace demand, fees are coupled wit
 ## How fees are paid
 When explicitly stated, the gas fee is paid by the `--gas-payer` flag. If no `--gas-payer` flag is specified, the gas fee is paid by the first key in the `--signing-keys` flag.
 
+<Callout type="info" emoji="🤡">
+Note that the use of the placeholder `keysha` for the key parameter. This is a completely configurable parameter, and should just refer to the alias of the key signing the transaction (that has a positive nam balance).
+</Callout>
+
 This means that in the transaction 
 ```shell copy
 namada client transfer \
@@ -26,7 +30,7 @@ namada client transfer \
   --token NAM \
   --amount 10 \
   --signing-keys keysha \
-  --gas-payer keysha2
+  --gas-payer accountant
   ```
 
 (Assuming that `keysha2` exists and is in the wallet of the user)
@@ -52,7 +56,7 @@ namadac transfer \
   --token NAM \
   --amount 10 \
   --signing-keys keysha \
-  --gas-payer keysha2 \
+  --gas-payer accountant \
   --dry-run-wrapper
 ```
 
@@ -72,7 +76,7 @@ namadac transfer \
   --token NAM \
   --amount 10 \
   --signing-keys keysha \
-  --gas-payer keysha2 \
+  --gas-payer accountant \
   --gas-limit 2000
 ```
 
@@ -85,7 +89,7 @@ namadac transfer \
   --token NAM \
   --amount 10 \
   --signing-keys keysha \
-  --gas-payer keysha2 \
+  --gas-payer accountant \
   --gas-limit 2000 \
   --gas-price 0.01
 ```

diff --git a/packages/docs/pages/users/transparent-accounts.mdx b/packages/docs/pages/users/transparent-accounts.mdx
@@ -23,8 +23,13 @@ namada wallet key
 
 It is possible to generate keys using the CLI. By doing so, an implicit account address is also derived in the process and added to storage.
 
+<Callout type="info" emoji="🤡">
+Note that the use of the placeholder `keysha` for the key parameter. This is a completely configurable parameter, and should just refer to the alias of the key signing the transaction (that has a positive nam balance).
+</Callout>
+
 ```shell copy
-namada wallet key gen --alias keysha
+KEY_ALIAS="keysha"
+namada wallet key gen --alias $KEY_ALIAS
 ```
 
 <Callout type="info">
@@ -37,7 +42,8 @@ The encryption password is _not_ a part of key generation randomness.
 Namada wallet supports keypair generation using a [mnemonic code](https://github.com/bitcoin/bips/blob/master/bip-0039.mediawiki) and [HD derivation path](https://github.com/bitcoin/bips/blob/master/bip-0044.mediawiki).
 To generate a keypair for a default path use
 ```shell copy
-namada wallet key gen --alias keysha --hd-path default
+KEY_ALIAS="keysha"
+namada wallet key gen --alias $KEY_ALIAS --hd-path default
 ```
 
 <Callout type="info">

diff --git a/packages/docs/pages/users/transparent-accounts/send-and-receive-nam-tokens.mdx b/packages/docs/pages/users/transparent-accounts/send-and-receive-nam-tokens.mdx
@@ -11,6 +11,10 @@ If you already have a key in your wallet, you can skip this step. Otherwise, [ge
 
 Then, send a transaction to initialize your new established account and save its address with the alias `establishment`. The `keysha` public key will be written into the account's storage for authorizing future transactions. We also sign this transaction with `keysha`.
 
+<Callout type="info" emoji="🤡">
+Note that the use of the placeholder `keysha` for the key parameter. This is a completely configurable parameter, and should just refer to the alias of the key signing the transaction (that has a positive nam balance).
+</Callout>
+
 ```shell copy
 namada client init-account \
   --alias establishment \