Merge pull request #678 from IntersectMBO/add-mnemonic-support

Add mnemonic support

Author: palas

cabal.project

@@ -13,7 +13,7 @@ repository cardano-haskell-packages
 -- See CONTRIBUTING for information about these, including some Nix commands
 -- you need to run if you change them
 index-state:
-  , hackage.haskell.org 2025-03-03T01:12:46Z
+  , hackage.haskell.org 2025-03-17T12:01:29Z
   , cardano-haskell-packages 2025-03-03T04:46:42Z
 
 packages:

cardano-api/cardano-api.cabal

@@ -110,8 +110,11 @@ library
     base16-bytestring >=1.0,
     base58-bytestring,
     base64-bytestring,
+    basement,
     bech32 >=1.1.0,
     bytestring,
+    bytestring-trie,
+    cardano-addresses ^>=4.0.0,
     cardano-binary,
     cardano-crypto,
     cardano-crypto-class ^>=2.1.2,
@@ -139,6 +142,7 @@ library
     directory,
     either,
     errors,
+    extra,
     filepath,
     formatting,
     groups,
@@ -161,7 +165,7 @@ library
     ouroboros-network-framework,
     ouroboros-network-protocols,
     parsec,
-    plutus-ledger-api:{plutus-ledger-api, plutus-ledger-api-testlib} ^>=1.37,
+    plutus-ledger-api:{plutus-ledger-api, plutus-ledger-api-testlib} ^>=1.40,
     prettyprinter,
     prettyprinter-ansi-terminal,
     prettyprinter-configurable ^>=1.36,
@@ -222,6 +226,7 @@ library
     Cardano.Api.Internal.Json
     Cardano.Api.Internal.Keys.Byron
     Cardano.Api.Internal.Keys.Class
+    Cardano.Api.Internal.Keys.Mnemonics
     Cardano.Api.Internal.Keys.Praos
     Cardano.Api.Internal.Keys.Read
     Cardano.Api.Internal.Keys.Shelley
@@ -404,7 +409,7 @@ test-suite cardano-api-golden
     hedgehog-extras ^>=0.7,
     microlens,
     parsec,
-    plutus-core ^>=1.37,
+    plutus-core ^>=1.40,
     plutus-ledger-api,
     tasty,
     tasty-hedgehog,

cardano-api/src/Cardano/Api.hs

@@ -179,6 +179,22 @@ module Cardano.Api
   , castHash
   , renderSafeHashAsHex
 
+    -- * Mnemonics
+
+    -- | Functions for working with mnemonics
+    -- ** Mnemonics generation
+  , MnemonicSize (..)
+  , generateMnemonic
+
+    -- ** Key derivation from mnemonics
+  , MnemonicToSigningKeyError (..)
+  , signingKeyFromMnemonic
+  , signingKeyFromMnemonicWithPaymentKeyIndex
+
+    -- ** Mnemonic word queries
+  , findMnemonicWordsWithPrefix
+  , autocompleteMnemonicPrefix
+
     -- * Payment addresses
 
     -- | Constructing and inspecting normal payment addresses
@@ -1124,6 +1140,7 @@ import Cardano.Api.Internal.IPC.Monad
 import Cardano.Api.Internal.InMode
 import Cardano.Api.Internal.Keys.Byron
 import Cardano.Api.Internal.Keys.Class
+import Cardano.Api.Internal.Keys.Mnemonics
 import Cardano.Api.Internal.Keys.Read
 import Cardano.Api.Internal.Keys.Shelley
 import Cardano.Api.Internal.LedgerState