Update README.md and cli help

ethereum · Mar 25, 2021 · d089820 · d089820
1 parent a35c09f
commit d089820
Show file tree

Hide file tree

Showing 2 changed files with 3 additions and 1 deletion.
diff --git a/README.md b/README.md
@@ -121,6 +121,7 @@ You can use `new-mnemonic --help` to see all arguments. Note that if there are m
 | `--mnemonic_language` | String. Options: `czech`, `chinese_traditional`, `chinese_simplified`, `english`, `spanish`, `italian`, `korean`. Default to `english` | The mnemonic language |
 | `--folder` | String. Pointing to `./validator_keys` by default | The folder path for the keystore(s) and deposit(s) |
 | `--chain` | String. `mainnet` by default | The chain setting for the signing domain. |
+| `--eth1_withdrawal_address` | String. Eth1 address in hexadecimal encoded form | If this field is set and valid, the given Eth1 address will be used to create the withdrawal credentials. Otherwise, it will generate withdrawal credentials with the mnemonic-derived withdrawal public key. |
 
 ###### `existing-mnemonic` Arguments
 

diff --git a/eth2deposit/cli/generate_keys.py b/eth2deposit/cli/generate_keys.py
@@ -111,7 +111,8 @@ def generate_keys_arguments_decorator(function: Callable[..., Any]) -> Callable[
             default=None,
             callback=validate_eth1_withdrawal_address,
             help=('If this field is set and valid, the given Eth1 address will be used to create the '
-                  'withdrawal credentials.'),
+                  'withdrawal credentials. Otherwise, it will generate withdrawal credentials with the '
+                  'mnemonic-derived withdrawal public key.'),
         ),
     ]
     for decorator in reversed(decorators):