Remove second factor support

cardano-api/internal/Cardano/Api/Keys/Mnemonics.hs

@@ -7,7 +7,6 @@ module Cardano.Api.Keys.Mnemonics
   ( MnemonicSize (..)
   , generateMnemonic
   , MnemonicToSigningStakeKeyError (..)
-  , SecondFactor
   , signingKeyFromMnemonic
   )
 where
@@ -22,11 +21,9 @@ import           Cardano.Address.Derivation (Depth (..), DerivationType (..), Ha
                    Index, XPrv, genMasterKeyFromMnemonic, indexFromWord32)
 import           Cardano.Address.Style.Shelley (Role (..), Shelley (..))
 import           Cardano.Mnemonic (MkSomeMnemonic (mkSomeMnemonic), MkSomeMnemonicError (..),
-                   SomeMnemonic, entropyToMnemonic, genEntropy, mnemonicToText, someMnemonicToBytes)
+                   SomeMnemonic, entropyToMnemonic, genEntropy, mnemonicToText)
 
 import           Control.Monad.IO.Class (MonadIO, liftIO)
-import qualified Data.ByteArray as BA
-import           Data.ByteString (ByteString)
 import           Data.Either.Combinators (mapLeft, maybeToRight)
 import           Data.Either.Extra (maybeToEither)
 import           Data.Text (Text)
@@ -61,26 +58,16 @@ generateMnemonic MS_24 = liftIO (mnemonicToText @24 . entropyToMnemonic <$> genE
 -- using the 'signingStakeKeyFromMnemonic' function.
 data MnemonicToSigningStakeKeyError
   = InvalidMnemonicError String
-  | InvalidSecondFactorMnemonicError String
   | InvalidAccountNumberError Word32
   | InvalidPaymentKeyNoError Word32
   deriving (Eq, Show)
 
 instance Error MnemonicToSigningStakeKeyError where
   prettyError :: MnemonicToSigningStakeKeyError -> Doc ann
   prettyError (InvalidMnemonicError str) = "Invalid mnemonic sentence: " <> pretty str
-  prettyError (InvalidSecondFactorMnemonicError str) = "Invalid second factor mnemonic sentence: " <> pretty str
   prettyError (InvalidAccountNumberError accNo) = "Invalid account number: " <> pretty accNo
   prettyError (InvalidPaymentKeyNoError keyNo) = "Invalid payment key number: " <> pretty keyNo
 
--- | The second factor for the key derivation.
-data SecondFactor
-  = -- | Use a mnemonic sentence as the second factor.
-    FromMnemonic [Text]
-  | -- | Use a raw byte string as the second factor.
-    FromByteString ByteString
-  deriving (Eq, Show)
-
 class ExtendedSigningKeyRole keyrole indexType where
   -- | Derive an extended private key of the keyrole from an account extended private key
   deriveSigningKeyFromAccount
@@ -119,25 +106,21 @@ signingKeyFromMnemonic
   -> [Text]
   -- ^ The mnemonic sentence. The length must be one of 12, 15, 18, 21, or 24.
   -- Each element of the list must be a single word.
-  -> Maybe SecondFactor
-  -- ^ The second factor for the key derivation. If 'Nothing', the key is derived
-  -- without a second factor.
   -> Word32
   -- ^ The account number in the derivation path. First account is 0.
   -> indexType
   -- ^ The payment key number in the derivation path (as 'Word32') if applicable for
   -- the given key role, otherwise '()'. First key is 0.
   -> Either MnemonicToSigningStakeKeyError (SigningKey keyrole)
-signingKeyFromMnemonic role mnemonicWords mSecondFactor accNo payKeyNo = do
+signingKeyFromMnemonic role mnemonicWords accNo payKeyNo = do
   -- Convert raw types to the ones used in the cardano-addresses library
   someMnemonic <- mapLeft InvalidMnemonicError $ wordsToSomeMnemonic mnemonicWords
-  secondFactorBytes <- toSecondFactor mSecondFactor
   accIx <-
     maybeToRight (InvalidAccountNumberError accNo) $
       indexFromWord32 @(Index 'Hardened 'AccountK) (0x80000000 + accNo)
 
   -- Derive the rootk key
-  let rootK = genMasterKeyFromMnemonic someMnemonic secondFactorBytes :: Shelley 'RootK XPrv
+  let rootK = genMasterKeyFromMnemonic someMnemonic mempty :: Shelley 'RootK XPrv
       -- Derive the account key
       accK = deriveAccountPrivateKey rootK accIx
 
@@ -149,12 +132,3 @@ signingKeyFromMnemonic role mnemonicWords mSecondFactor accNo payKeyNo = do
   -- Convert the mnemonic sentence to a SomeMnemonic value
   wordsToSomeMnemonic :: [Text] -> Either String SomeMnemonic
   wordsToSomeMnemonic = mapLeft getMkSomeMnemonicError . mkSomeMnemonic @[12, 15, 18, 21, 24]
-
-  -- Convert the second factor to a ScrubbedBytes value or mempty if none
-  toSecondFactor :: Maybe SecondFactor -> Either MnemonicToSigningStakeKeyError BA.ScrubbedBytes
-  toSecondFactor Nothing = return mempty
-  toSecondFactor (Just (FromMnemonic secondFactorWords)) =
-    someMnemonicToBytes
-      <$> mapLeft InvalidSecondFactorMnemonicError (wordsToSomeMnemonic secondFactorWords)
-  toSecondFactor (Just (FromByteString secondFactorBytes)) =
-    return $ BA.convert secondFactorBytes

cardano-api/src/Cardano/Api.hs

@@ -186,7 +186,6 @@ module Cardano.Api
 
     -- ** Key derivation from mnemonics
   , MnemonicToSigningStakeKeyError (..)
-  , SecondFactor
   , signingKeyFromMnemonic
 
     -- * Payment addresses

cardano-api/test/cardano-api-test/Test/Cardano/Api/Address.hs

@@ -40,7 +40,7 @@ prop_derive_key_from_mnemonic :: Property
 prop_derive_key_from_mnemonic = H.property $ do
   ms <- H.forAll $ H.element [MS_12, MS_15, MS_18, MS_21, MS_24]
   mnemonic <- liftIO $ generateMnemonic ms
-  void $ H.evalEither $ signingKeyFromMnemonic AsStakeExtendedKey mnemonic Nothing 0 (0 :: Word32)
+  void $ H.evalEither $ signingKeyFromMnemonic AsStakeExtendedKey mnemonic 0 (0 :: Word32)
   H.success
 
 exampleMnemonic :: [Text]
@@ -74,7 +74,7 @@ exampleMnemonic =
 prop_payment_derivation_is_accurate :: Property
 prop_payment_derivation_is_accurate = H.propertyOnce $ do
   signingKey <-
-    H.evalEither $ signingKeyFromMnemonic AsPaymentExtendedKey exampleMnemonic Nothing 0 (0 :: Word32)
+    H.evalEither $ signingKeyFromMnemonic AsPaymentExtendedKey exampleMnemonic 0 (0 :: Word32)
   let verificationKey =
         getVerificationKey (signingKey :: SigningKey PaymentExtendedKey)
           :: VerificationKey PaymentExtendedKey
@@ -92,7 +92,7 @@ prop_payment_derivation_is_accurate = H.propertyOnce $ do
 prop_stake_derivation_is_accurate :: Property
 prop_stake_derivation_is_accurate = H.propertyOnce $ do
   signingKey <-
-    H.evalEither $ signingKeyFromMnemonic AsStakeExtendedKey exampleMnemonic Nothing 0 (0 :: Word32)
+    H.evalEither $ signingKeyFromMnemonic AsStakeExtendedKey exampleMnemonic 0 (0 :: Word32)
   let verificationKey =
         getVerificationKey (signingKey :: SigningKey StakeExtendedKey) :: VerificationKey StakeExtendedKey
       addr =
@@ -106,9 +106,9 @@ prop_stake_derivation_is_accurate = H.propertyOnce $ do
 prop_payment_with_stake_derivation_is_accurate :: Property
 prop_payment_with_stake_derivation_is_accurate = H.propertyOnce $ do
   paymentSigningKey <-
-    H.evalEither $ signingKeyFromMnemonic AsPaymentExtendedKey exampleMnemonic Nothing 0 (0 :: Word32)
+    H.evalEither $ signingKeyFromMnemonic AsPaymentExtendedKey exampleMnemonic 0 (0 :: Word32)
   stakeSigningKey <-
-    H.evalEither $ signingKeyFromMnemonic AsStakeExtendedKey exampleMnemonic Nothing 0 (0 :: Word32)
+    H.evalEither $ signingKeyFromMnemonic AsStakeExtendedKey exampleMnemonic 0 (0 :: Word32)
   let paymentVerificationKey =
         getVerificationKey (paymentSigningKey :: SigningKey PaymentExtendedKey)
           :: VerificationKey PaymentExtendedKey