Move BIP39 module to separate package

From [input-ouput-hk/cardano-wallet#55](cardano-foundation/cardano-wallet#55): > We've moved the wallet into its own repository as a first step towards decoupling. Now, the cardano-wallet uses cardano-sl as a peer dependency and rely on it for quite a few things. However, a few modules in cardano-sl also relies on code inside the wallet. This creates some circular dependencies between both repo. > One of those dependencies is actually the BIP39-ish implementation from the cardano-wallet used in a few scripts and executable currently located on cardano-sl. 1. Creates new package `mnemonic` 2. Moves `BIP39` module & spec from `wallet-new` to `mnemonic` 3. Point BIP39 imports from faucet and wallet-new to the new location 4. Make scripts/generate-mnemonic.hs an executable instead.
jamescheuk91 · Nov 15, 2018 · 7468886 · 7468886
1 parent ad7dc40
commit 7468886
Show file tree

Hide file tree

Showing 19 changed files with 275 additions and 31 deletions.
diff --git a/faucet/cardano-sl-faucet.cabal b/faucet/cardano-sl-faucet.cabal
@@ -23,6 +23,7 @@ library
                     , cardano-sl-core
                     , cardano-sl-crypto
                     , cardano-sl-util
+                    , cardano-sl-mnemonic
                     , cardano-sl-wallet-new
                     , connection
                     , cryptonite

diff --git a/faucet/src/Cardano/Faucet/Init.hs b/faucet/src/Cardano/Faucet/Init.hs
@@ -49,6 +49,7 @@ import qualified System.Metrics.Gauge as Gauge
 import           System.Wlog (CanLog, HasLoggerName, LoggerNameBox (..),
                      liftLogIO, logDebug, logError, logInfo, withSublogger)
 
+import           Cardano.Mnemonic (Mnemonic, entropyToMnemonic, genEntropy)
 import           Cardano.Wallet.API.V1.Types (Account (..), Address,
                      AssuranceLevel (NormalAssurance), BackupPhrase (..),
                      ForceNtpCheck (..), NewWallet (..), NodeInfo (..),
@@ -60,8 +61,6 @@ import           Cardano.Wallet.API.V1.Types (Account (..), Address,
 import           Cardano.Wallet.Client (ClientError (..), WalletClient (..),
                      WalletResponse (..), liftClient)
 import           Cardano.Wallet.Client.Http (mkHttpClient)
-import           Cardano.Wallet.Kernel.BIP39 (Mnemonic, entropyToMnemonic,
-                     genEntropy)
 import           Pos.Core (Coin (..))
 import           Universum
 

diff --git a/faucet/src/Cardano/Faucet/Types/Config.hs b/faucet/src/Cardano/Faucet/Types/Config.hs
@@ -42,10 +42,10 @@ import           System.Metrics.Counter (Counter)
 import           System.Metrics.Gauge (Gauge)
 import           System.Remote.Monitoring.Statsd (StatsdOptions (..))
 
+import           Cardano.Mnemonic (Mnemonic)
 import           Cardano.Wallet.API.V1.Types (AccountIndex, Payment,
                      PaymentSource (..), V1, WalletId (..))
 import           Cardano.Wallet.Client (ClientError (..), WalletClient (..))
-import           Cardano.Wallet.Kernel.BIP39 (Mnemonic)
 import           Pos.Core (Address (..))
 import           Test.QuickCheck (Arbitrary (..), choose)
 import           Test.QuickCheck.Arbitrary.Generic

diff --git a/mnemonic/LICENSE b/mnemonic/LICENSE
@@ -0,0 +1,20 @@
+Copyright (c) 2018 IOHK
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of
+this software and associated documentation files (the "Software"), to deal in
+the Software without restriction, including without limitation the rights to
+use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies
+of the Software, and to permit persons to whom the Software is furnished to
+do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.
+
diff --git a/mnemonic/README.md b/mnemonic/README.md
@@ -0,0 +1,8 @@
+# Cardano-SL-Mnemonic
+Custom Mnemonic module, previously located in cardano-sl-wallet-new (now cardano-wallet).
+
+It includes an executable too:
+```shell
+$ stack exec cardano-sl-generate-mnemonic
+["squirrel","material","silly","twice","direct","slush","pistol","razor","become","junk","kingdom","flee"]
+```
diff --git a/mnemonic/cardano-sl-mnemonic.cabal b/mnemonic/cardano-sl-mnemonic.cabal
@@ -0,0 +1,91 @@
+name:                cardano-sl-mnemonic
+version:             2.0.0
+synopsis:            TODO
+description:         See README
+homepage:            https://github.com/input-output-hk/cardano-sl/mnemonic/README.md
+author:              IOHK Engineering Team
+maintainer:          operations@iohk.io
+copyright:           2018 IOHK
+license:             MIT
+license-file:        LICENSE
+category:            Data
+build-type:          Simple
+extra-source-files:  README.md
+cabal-version:       >=1.10
+
+library
+  default-language:   Haskell2010
+  default-extensions: DeriveGeneric
+                      LambdaCase
+                      NoImplicitPrelude
+                      OverloadedStrings
+                      TupleSections
+                      TypeApplications
+                      ScopedTypeVariables
+
+  hs-source-dirs:     src
+
+  build-depends: base >=4.7 && <5
+               , QuickCheck
+               , aeson
+               , basement
+               , bytestring
+               , cardano-crypto
+               , cardano-sl
+               , cardano-sl-core
+               , cardano-sl-crypto
+               , cardano-sl-infra
+               , cryptonite
+               , data-default
+               , formatting
+               , lens
+               , memory
+               , swagger2
+               , text
+               , time
+               , universum
+
+  exposed-modules: Cardano.Mnemonic
+
+
+test-suite cardano-sl-mnemonic-test
+  default-language:   Haskell2010
+
+  type:               exitcode-stdio-1.0
+  default-extensions: DeriveGeneric
+                      LambdaCase
+                      NoImplicitPrelude
+                      OverloadedStrings
+                      TupleSections
+                      TypeApplications
+                      ScopedTypeVariables
+
+  hs-source-dirs:     test
+  main-is:            Main.hs
+  other-modules:      Cardano.MnemonicSpec
+
+  build-depends:      base
+                    , hspec
+                    , universum
+                    , cardano-sl-mnemonic
+                    , bytestring
+                    , QuickCheck
+                    , cardano-sl-crypto
+                    , data-default
+                    , aeson
+                    , cardano-crypto
+
+
+executable cardano-generate-mnemonic
+  main-is:            Main.hs
+  hs-source-dirs:     generate-mnemonic
+  ghc-options:        -threaded -rtsopts -with-rtsopts=-N -Wall
+  build-depends:
+                      base
+                    , aeson
+                    , cardano-sl-mnemonic
+                    , bytestring
+                    , text
+                    , universum
+  default-language:   Haskell2010
+  default-extensions: NoImplicitPrelude
diff --git a/scripts/generate-mnemonic.hs → mnemonic/generate-mnemonic/Main.hs b/scripts/generate-mnemonic.hs → mnemonic/generate-mnemonic/Main.hs
@@ -1,12 +1,13 @@
-#!/usr/bin/env nix-shell
-#!nix-shell -i runhaskell ../wallet-new/default.nix
 {-# LANGUAGE DataKinds        #-}
 {-# LANGUAGE TypeApplications #-}
-import           Cardano.Wallet.Kernel.BIP39 (EntropySize, Mnemonic,
-                     entropyToMnemonic, genEntropy)
+
+import           Universum
+
+import           Cardano.Mnemonic (Mnemonic, entropyToMnemonic, genEntropy)
 import           Data.Aeson (encode)
 import           Data.ByteString.Lazy.Char8 (unpack)
 
+main :: IO ()
 main = do
     backupPhrase <- generateBackupPhrase
     let backupPhraseString = backupPhraseToString backupPhrase

diff --git a/...et-new/src/Cardano/Wallet/Kernel/BIP39.hs → mnemonic/src/Cardano/Mnemonic.hs b/...et-new/src/Cardano/Wallet/Kernel/BIP39.hs → mnemonic/src/Cardano/Mnemonic.hs
@@ -1,10 +1,14 @@
 -- | Module providing restoring from backup phrase functionality
-{-# LANGUAGE DataKinds      #-}
-{-# LANGUAGE KindSignatures #-}
-{-# LANGUAGE LambdaCase     #-}
+{-# LANGUAGE DataKinds            #-}
+{-# LANGUAGE FlexibleContexts     #-}
+{-# LANGUAGE FlexibleInstances    #-}
+{-# LANGUAGE KindSignatures       #-}
+{-# LANGUAGE LambdaCase           #-}
+{-# LANGUAGE TypeFamilies         #-}
+{-# LANGUAGE UndecidableInstances #-}
 {-# OPTIONS_GHC -fno-warn-orphans #-}
 
-module Cardano.Wallet.Kernel.BIP39
+module Cardano.Mnemonic
        (
        -- * Types
          Mnemonic
@@ -41,16 +45,16 @@ import           Control.Lens ((?~))
 import           Crypto.Encoding.BIP39
 import           Crypto.Hash (Blake2b_256, Digest, hash)
 import           Data.Aeson (FromJSON (..), ToJSON (..))
+import           Data.Aeson.Types (Parser)
 import           Data.ByteArray (constEq, convert)
 import           Data.ByteString (ByteString)
 import           Data.Default (Default (def))
 import           Data.Swagger (NamedSchema (..), ToSchema (..), maxItems,
                      minItems)
-import           Formatting (bprint, build, (%))
+import           Formatting (bprint, build, formatToString, (%))
 import           Test.QuickCheck (Arbitrary (..))
 import           Test.QuickCheck.Gen (vectorOf)
 
-import           Cardano.Wallet.Util (eitherToParser)
 import           Pos.Binary (serialize')
 import           Pos.Crypto (AesKey (..))
 import           Pos.Infra.Util.LogSafe (SecureLog)
@@ -374,3 +378,13 @@ instance (KnownNat mw) => ToSchema (Mnemonic mw) where
         return $ NamedSchema (Just "Mnemonic") schema
             & minItems ?~ fromIntegral mw
             & maxItems ?~ fromIntegral mw
+
+
+--
+--  Miscellaneous
+--
+
+-- | Convert a given Either to an Aeson Parser
+eitherToParser :: Buildable a => Either a b -> Parser b
+eitherToParser =
+    either (fail . formatToString build) pure
diff --git a/...w/test/Cardano/Wallet/Kernel/BIP39Spec.hs → mnemonic/test/Cardano/MnemonicSpec.hs b/...w/test/Cardano/Wallet/Kernel/BIP39Spec.hs → mnemonic/test/Cardano/MnemonicSpec.hs
@@ -1,12 +1,19 @@
-{-# LANGUAGE DataKinds       #-}
-{-# LANGUAGE RecordWildCards #-}
+{-# LANGUAGE DataKinds            #-}
+{-# LANGUAGE FlexibleContexts     #-}
+{-# LANGUAGE FlexibleInstances    #-}
+{-# LANGUAGE KindSignatures       #-}
+{-# LANGUAGE LambdaCase           #-}
+{-# LANGUAGE RecordWildCards      #-}
+{-# LANGUAGE ScopedTypeVariables  #-}
+{-# LANGUAGE TypeFamilies         #-}
+{-# LANGUAGE UndecidableInstances #-}
 {-# OPTIONS_GHC -fno-warn-orphans #-}
 
-module Cardano.Wallet.Kernel.BIP39Spec where
+module Cardano.MnemonicSpec where
 
 import           Universum
 
-import           Cardano.Wallet.Kernel.BIP39
+import           Cardano.Mnemonic
 import           Crypto.Encoding.BIP39 (toEntropy)
 import           Data.Default (def)
 import           Pos.Crypto (AesKey (..))

diff --git a/mnemonic/test/Main.hs b/mnemonic/test/Main.hs
@@ -0,0 +1,12 @@
+module Main where
+
+import           Universum
+
+import           Test.Hspec
+
+import qualified Cardano.MnemonicSpec
+
+
+main :: IO ()
+main = hspec $ do
+    Cardano.MnemonicSpec.spec