Skip to content

Commit

Permalink
Tweak help text and add error for mnemoni parsing
Browse files Browse the repository at this point in the history
  • Loading branch information
Anviking committed Feb 3, 2020
1 parent d72461e commit 695dbfb
Showing 1 changed file with 39 additions and 37 deletions.
76 changes: 39 additions & 37 deletions lib/cli/src/Cardano/CLI.hs
Original file line number Diff line number Diff line change
Expand Up @@ -120,6 +120,7 @@ import Cardano.Wallet.Primitive.AddressDerivation
( FromMnemonic (..)
, Passphrase (..)
, PassphraseMaxLength
, FromMnemonicError (..)
, keyToHexText
, PassphraseMinLength
, WalletKey (..)
Expand Down Expand Up @@ -295,54 +296,25 @@ runCli = join . customExecParser preferences
preferences = prefs showHelpOnEmpty

{-------------------------------------------------------------------------------
Commands - 'mnemonic'
Commands - 'HD Derivation'
-------------------------------------------------------------------------------}

cmdMnemonic :: Mod CommandFields (IO ())
cmdMnemonic = command "mnemonic" $ info (helper <*> cmds) $ mempty
<> progDesc "Manage mnemonic phrases."
where
cmds = subparser $ mempty
<> cmdMnemonicGenerate
<> cmdMnemonicRewardCredentials

-- | Arguments for 'mnemonic generate' command
newtype MnemonicGenerateArgs = MnemonicGenerateArgs
{ _size :: MnemonicSize
}

cmdMnemonicGenerate :: Mod CommandFields (IO ())
cmdMnemonicGenerate = command "generate" $ info (helper <*> cmd) $ mempty
<> progDesc "Generate English BIP-0039 compatible mnemonic words."
where
cmd = exec . MnemonicGenerateArgs <$> sizeOption
exec (MnemonicGenerateArgs n) = do
m <- case n of
MS_9 -> mnemonicToText @9 . entropyToMnemonic <$> genEntropy
MS_12 -> mnemonicToText @12 . entropyToMnemonic <$> genEntropy
MS_15 -> mnemonicToText @15 . entropyToMnemonic <$> genEntropy
MS_18 -> mnemonicToText @18 . entropyToMnemonic <$> genEntropy
MS_21 -> mnemonicToText @21 . entropyToMnemonic <$> genEntropy
MS_24 -> mnemonicToText @24 . entropyToMnemonic <$> genEntropy
TIO.putStrLn $ T.unwords m

cmdKey :: Mod CommandFields (IO ())
cmdKey = command "key" $ info (helper <*> cmds) $ mempty
<> progDesc "Derive keys from mnemonics"
where
cmds = subparser $ mempty
<> cmdRootKey

data KeyType = Icarus | Trezor | Ledger | Byron
data KeyType = Byron | Icarus | Trezor | Ledger
deriving (Show, Eq, Generic, Bounded, Enum)
deriving (ToText, FromText) via (BoundedEnum 'KebabLowerCase KeyType)


parseKeyType :: Parser (IO KeyType)
parseKeyType = toIO . fromText <$> strOption
( long "type"
<> metavar "KEYTYPE"
<> help "Shelley / Icarus"
<> help "Byron / Icarus / Trezor / Ledger"
)
where
toIO :: Either TextDecodingError KeyType -> IO KeyType
Expand All @@ -351,15 +323,17 @@ parseKeyType = toIO . fromText <$> strOption
toIO (Left (TextDecodingError e)) =
hPutStrLn stderr e >> exitFailure

parseSeedFromMnemonic :: Parser (Passphrase "seed")
parseSeedFromMnemonic :: Parser (IO (Passphrase "seed"))
parseSeedFromMnemonic = toSeed <$> parseWords
where
parseWords = some (argument str (metavar "WORDS..."))
toSeed ws =
-- TODO: Handle errors
-- TODO: Make sure we allow the right lengths for each key type!
-- Maybe that this matches the API.
let Right seed = fromMnemonic @'[15,18,21,24] @"seed" ws in seed
case fromMnemonic @'[15,18,21,24] @"seed" ws of
Right s -> return s
Left (FromMnemonicError e) -> hPutStrLn stderr e >> exitFailure


cmdRootKey :: Mod CommandFields (IO ())
cmdRootKey =
Expand All @@ -371,7 +345,7 @@ cmdRootKey =
keyType <- parseKeyType
seed <- parseSeedFromMnemonic
return $ do
TIO.putStrLn =<< (generateKeyFromSeed <$> (pure seed) <*> keyType)
TIO.putStrLn =<< (generateKeyFromSeed <$> seed <*> keyType)

generateKeyFromSeed
:: Passphrase "seed"
Expand All @@ -388,9 +362,37 @@ generateKeyFromSeed seed = \case
keyToHexText $ Icarus.generateKeyFromSeed seed mempty

{-------------------------------------------------------------------------------
Commands - 'HD Derivation'
Commands - 'mnemonic'
-------------------------------------------------------------------------------}

cmdMnemonic :: Mod CommandFields (IO ())
cmdMnemonic = command "mnemonic" $ info (helper <*> cmds) $ mempty
<> progDesc "Manage mnemonic phrases."
where
cmds = subparser $ mempty
<> cmdMnemonicGenerate
<> cmdMnemonicRewardCredentials

-- | Arguments for 'mnemonic generate' command
newtype MnemonicGenerateArgs = MnemonicGenerateArgs
{ _size :: MnemonicSize
}

cmdMnemonicGenerate :: Mod CommandFields (IO ())
cmdMnemonicGenerate = command "generate" $ info (helper <*> cmd) $ mempty
<> progDesc "Generate English BIP-0039 compatible mnemonic words."
where
cmd = exec . MnemonicGenerateArgs <$> sizeOption
exec (MnemonicGenerateArgs n) = do
m <- case n of
MS_9 -> mnemonicToText @9 . entropyToMnemonic <$> genEntropy
MS_12 -> mnemonicToText @12 . entropyToMnemonic <$> genEntropy
MS_15 -> mnemonicToText @15 . entropyToMnemonic <$> genEntropy
MS_18 -> mnemonicToText @18 . entropyToMnemonic <$> genEntropy
MS_21 -> mnemonicToText @21 . entropyToMnemonic <$> genEntropy
MS_24 -> mnemonicToText @24 . entropyToMnemonic <$> genEntropy
TIO.putStrLn $ T.unwords m

cmdMnemonicRewardCredentials :: Mod CommandFields (IO ())
cmdMnemonicRewardCredentials =
command "reward-credentials" $ info (helper <*> cmd) $ mempty
Expand Down

0 comments on commit 695dbfb

Please sign in to comment.