Add mnemonic sentence support #975

palas · 2024-11-20T17:18:49Z

Changelog

- description: |
    Added support for mnemonic sentence generation and extended key derivation from mnemonic sentences.
  type:
  - feature

Context

This PR is associated to: IntersectMBO/cardano-api#678.
It is part of an effort to integrate cardano-addresses functionalities into the cardano-cli.

How to trust this PR

I would look mainly at the logic, the changes in the help golden files, and probably testing it is the best way.

Checklist

Commit sequence broadly makes sense and commits have useful messages
New tests are added if needed and existing tests are updated. See Running tests for more details
Self-reviewed the diff

Jimbo4350

LGTM but I want feedback from the rest of the team before we approve and merge.

Jimbo4350 · 2024-11-20T19:46:27Z

cardano-cli/src/Cardano/CLI/Commands/Key.hs

@@ -52,6 +56,24 @@ data KeyNonExtendedKeyCmdArgs = KeyNonExtendedKeyCmdArgs
  }
  deriving Show

+-- | Get a verification key from a mnemonic. This supports all extended key types.


verification key?

Jimbo4350 · 2024-11-20T19:47:15Z

cardano-cli/src/Cardano/CLI/Commands/Key.hs

+  }
+  deriving Show
+
+data ExtendedSigningType


DerivedExtendedSigningKeyType?

A comment saying something like "This is the key derived from the mnemonic"

Jimbo4350 · 2024-11-20T19:48:50Z

cardano-cli/src/Cardano/CLI/Commands/Key.hs

+-- | Get a verification key from a mnemonic. This supports all extended key types.
+data KeyExtendedSigningKeyFromMnemonicArgs = KeyExtendedSigningKeyFromMnemonicArgs
+  { keyOutputFormat :: !KeyOutputFormat
+  , extendedSigningKeyType :: !ExtendedSigningType


derivedExtendedSigningKeyType?

Jimbo4350 · 2024-11-20T19:51:44Z

cardano-cli/test/cardano-cli-golden/files/golden/help.cli

@@ -64,6 +64,7 @@ Usage: cardano-cli address info --address ADDRESS [--out-file FILEPATH]
 Usage: cardano-cli key 
                         ( verification-key
                         | non-extended-key
+                         | key-from-mnemonic


"signing-key-from-mnemonic"?

Jimbo4350 · 2024-11-20T19:54:35Z

cardano-cli/test/cardano-cli-golden/files/golden/help.cli

@@ -85,6 +86,21 @@ Usage: cardano-cli key non-extended-key --extended-verification-key-file FILEPAT
  Get a non-extended verification key from an extended verification key. This
  supports all extended key types.

+Usage: cardano-cli key key-from-mnemonic [--key-output-format STRING]
+                                           ( --payment-key
+                                             --payment-address-number WORD32


I think we can collapse to a single parser in the case of those with indexes. I.e: --payment-key-address-number instead of --payment-key and --payment-address-number. We can add information in the help text explaining what the address number is.

Jimbo4350 · 2024-11-20T19:59:15Z

cardano-cli/src/Cardano/CLI/Options/Key.hs

+          )
+    )
+ where
+  parseSize :: String -> Maybe MnemonicSize


Why not use ReadM so you can fail with an appropriate error message?

Jimbo4350 · 2024-11-20T20:07:17Z

cardano-cli/src/Cardano/CLI/Run/Key.hs

@@ -205,6 +207,19 @@ runNonExtendedKeyCmd
        writeLazyByteStringFile vkf' $
          textEnvelopeToJSON descr vk

+runGenerateMnemonicCmd :: Cmd.KeyGenerateMnemonicCmdArgs -> ExceptT KeyCmdError IO ()


I think when writing to file we should at least set restrictive permissions. Can you get in touch with the wallet team and ask them what precautions they took when generating mnemonics?

Jimbo4350 · 2024-11-20T20:07:59Z

cardano-cli/src/Cardano/CLI/Run/Key.hs

+    { mnemonicOutputFormat
+    , mnemonicWords
+    } = do
+    mnemonic <- firstExceptT KeyCmdMnemonicError $ generateMnemonic mnemonicWords


An extra validation step where we confirm the correct number of words have been generated also can't hurt here.

Jimbo4350 · 2024-11-20T20:10:51Z

cardano-cli/src/Cardano/CLI/Run/Key.hs

+      return $ map T.pack $ words $ T.unpack fileText
+    readMnemonic Cmd.MnemonicFromInteractivePrompt =
+      liftIO $ do
+        putStrLn ""


unlines would be a good refactor here

Jimbo4350 · 2024-11-20T20:15:06Z

cardano-cli/test/cardano-cli-golden/files/golden/help/key.cli

@@ -1,6 +1,8 @@
 Usage: cardano-cli key 


I am wondering if we should have a new command root-key that has these commands underneath. We need to make a clear distinction between the root key and the derived keys. Putting the commands under key makes this distinction a little less clear IMO.

carbolymer · 2024-11-20T20:20:35Z

cardano-cli/src/Cardano/CLI/Run/Key.hs

+        putStrLn ""
+        putStrLn "Please enter your mnemonic sentence."
+        putStrLn ""
+        putStrLn " - It should consist of either: 12, 15, 18, 21, or 24 words."
+        putStrLn " - To terminate, press enter on an empty line."
+        putStrLn " - To abort you can press CTRL+C."
+        putStrLn ""
+        putStrLn "(If your terminal supports it, you can use the TAB key for word completion.)"
+        putStrLn ""
+        runInputTBehaviorWithPrefs defaultBehavior defaultPrefs settings (inputT ("", "") [])


Looks cool. Can we support non-interactive senario with reading of mnemonic from stdin here? I imagine the following example, when someone stores their mnemonic in bitwarden, and tries to generate key using the following snippet:

bw list items --search 'cardano super secret mnemonic' \ | jq -r '.[0].login.password' \ | cardano-cli latest key key-from-mnemonic ... --signing-key-file key.json

@CarlosLopezDeLara thoughts? do you think this could be useful?

This would actually work with the interactive one as is, I made it with that in mind, and I tested it feeding the output file of the generate-mnemonic command. But it may be a good idea to make one that is explicitly for that, or adding a comment, because the user may not know.

carbolymer · 2024-11-20T20:26:37Z

cardano-cli/src/Cardano/CLI/Run/Key.hs

Those new additions are quite large so I'd suggest adding a new module for them. For example:
cardano-cli/src/Cardano/CLI/Run/Key/Mnemonic.hs

carbolymer · 2024-11-20T20:27:47Z

cardano-cli/test/cardano-cli-golden/files/golden/help/shelley_key_key-from-mnemonic.cli

+  --signing-key-file FILEPATH
+                           Output filepath of the signing key.


Suggested change

--signing-key-file FILEPATH

Output filepath of the signing key.

--out-signing-key-file FILEPATH

Output filepath of the signing key.

I would suggest marking output file so it stands out. It took me a moment to find out the right flag which saves a file.

carbolymer · 2024-11-20T20:32:47Z

cardano-cli/test/cardano-cli-golden/files/golden/help/allegra_key.cli

@@ -1,6 +1,8 @@
 Usage: cardano-cli allegra key 
                                 ( verification-key
                                 | non-extended-key
+                                 | generate-mnemonic
+                                 | key-from-mnemonic


This command feels a little odd: cardano-cli latest key key-from-mnemonic

I think this key prefix seems redundant.

Suggested change

| key-from-mnemonic

| from-mnemonic

Or we can call it derive-from-mnemonic

palas added 4 commits November 19, 2024 18:02

Preliminary implementation

0987f84

Add command to generate mnemonics

7782a13

Read mnemonic from file

018d9b8

Add interactive prompt

678f83c

palas self-assigned this Nov 20, 2024

palas requested review from Jimbo4350, newhoggy, carbolymer, smelc, kevinhammond and disassembler as code owners November 20, 2024 17:18

palas mentioned this pull request Nov 20, 2024

Add mnemonic support IntersectMBO/cardano-api#678

Open

3 tasks

Jimbo4350 reviewed Nov 20, 2024

View reviewed changes

carbolymer reviewed Nov 20, 2024

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add mnemonic sentence support #975

Add mnemonic sentence support #975

palas commented Nov 20, 2024

Jimbo4350 left a comment

Jimbo4350 Nov 20, 2024

palas Nov 21, 2024

Jimbo4350 Nov 20, 2024

Jimbo4350 Nov 20, 2024

Jimbo4350 Nov 20, 2024

Jimbo4350 Nov 20, 2024

Jimbo4350 Nov 20, 2024

Jimbo4350 Nov 20, 2024

Jimbo4350 Nov 20, 2024

Jimbo4350 Nov 20, 2024

Jimbo4350 Nov 20, 2024

Jimbo4350 Nov 20, 2024

carbolymer Nov 20, 2024

palas Nov 20, 2024

carbolymer Nov 20, 2024

carbolymer Nov 20, 2024

carbolymer Nov 20, 2024

palas Nov 21, 2024

		--signing-key-file FILEPATH
		Output filepath of the signing key.

Add mnemonic sentence support #975

Are you sure you want to change the base?

Add mnemonic sentence support #975

Conversation

palas commented Nov 20, 2024

Changelog

Context

How to trust this PR

Checklist

Jimbo4350 left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment