Client: homogenize signer descriptions

src/lib_signer_backends/encrypted.ml

@@ -127,13 +127,14 @@ module Make(C : sig val cctxt: Client_context.prompter end) = struct
     "Built-in signer using encrypted keys."
 
   let description =
-    "If you try to import a secret key without additional argument, you will \
+    "Valid secret key URIs are of the form\n\
-     be asked to either generate a new key, or to import the elements \
+    \ - encrypted:<encrypted_key>\n\
-     from your fundraiser paper wallet.\n\
+     where <encrypted_key> is the encrypted (passphrase protected \
-     If you add an argument when importing a secret key, \
+     using Nacl's cryptobox and pbkdf) secret key, formatted in \
-     the format is the raw Base58-encoded key (starting with 'edsk').\n\
+     unprefixed Base58.\n\
-     The format for importing public keys is the raw Base58-encoded \
+     Valid public key URIs are of the form\n\
-     key (starting with 'edpk')."
+    \ - encrypted:<public_key>\n\
+     where <public_key> is the public key in Base58."
 
   let public_key = Unencrypted.public_key
   let public_key_hash = Unencrypted.public_key_hash

src/lib_signer_backends/ledger.ml

@@ -16,11 +16,14 @@ let title =
   "Built-in signer using Ledger Nano S."
 
 let description =
-  "The format for importing secret and public keys is \
+  "Valid URIs are of the form\n\
-   <root_pkh>/<path> where <root_pkh> is the Base58-encoded public key \
+  \ - ledger://<root_pkh>[/<path>]\n\
-   hash of the key at m/44'/1729' and <path> is a BIP32 path anchored \
+   where <root_pkh> is the Base58-encoded public key hash of the key \
-   at m/44'/1729'. Ledger does not yet support non-hardened path so \
+   at m/44'/1729' and <path> is a BIP32 path anchored at \
-   each node of the path must be hardened."
+   m/44'/1729'. Ledger does not yet support non-hardened path so each \
+   node of the path must be hardened.\n\
+   Use `tezos-client list connected ledgers` to get the <root_pkh> of \
+   all connected devices."
 
 let hard = Int32.logor 0x8000_0000l
 let tezos_root = [hard 44l ; hard 1729l]

src/lib_signer_backends/remote.ml

@@ -23,7 +23,8 @@ module Make(S : sig
     "Built-in tezos-signer using remote wallet."
 
   let description =
-    "Valid locators are of this form: remote://tz1...\n\
+    "Valid locators are of the form\n\
+    \ - remote://tz1...\n\
      The key will be queried to current remote signer, which can be \
      configured with the `--remote-signer` or `-R` options, \
      or by defining the following environment variables:\n\

src/lib_signer_backends/socket.ml

@@ -60,7 +60,8 @@ module Make(P : sig
       "Built-in tezos-signer using remote signer through hardcoded unix socket."
 
     let description =
-      "Valid locators are of this form: unix:///path/to/socket?pkh=tz1..."
+      "Valid locators are of the form\n\
+      \ - unix:///path/to/socket?pkh=tz1..."
 
     let parse uri =
       assert (Uri.scheme uri = Some scheme) ;
@@ -96,7 +97,8 @@ module Make(P : sig
       "Built-in tezos-signer using remote signer through hardcoded tcp socket."
 
     let description =
-      "Valid locators are of this form: tcp://host:port/tz1..."
+      "Valid locators are of the form\n\
+      \ - tcp://host:port/tz1..."
 
     let parse uri =
       assert (Uri.scheme uri = Some scheme) ;

src/lib_signer_backends/unencrypted.ml

@@ -15,12 +15,13 @@ let title =
   "Built-in signer using raw unencrypted keys."
 
 let description =
-  "Do not use this signer except for playing on the test chain.\n\
+  "Please DO NOT USE this signer outside of test environments.\n\
-   The format for importing secret keys is either no argument (will \
+   Valid secret key URIs are of the form\n\
-   generate a key) or the raw Base58-encoded key (starting with \
+  \ - unencrypted:<key>\n\
-   'edsk').\n\
+   where <key> is the secret key in Base58.\n\
-   The format for importing public keys is the raw Base58-encoded \
+   Valid public key URIs are of the form\n\
-   key (starting with 'edpk')."
+  \ - unencrypted:<public_key>\n\
+   where <public_key> is the public key in Base58."
 
 let secret_key sk_uri =
   Lwt.return