Safe Haskell	None
Language	Haskell2010

Crypto.Encoding.BIP39

Contents

Entropy
Seed
Mnemonic Sentence
- Dictionary
helpers
Errors

Synopsis

data Entropy (n :: Nat )
type ValidEntropySize (n :: Nat ) = ( KnownNat n, NatWithinBound Int n, Elem n '[96, 128, 160, 192, 224, 256])
data Checksum (bits :: Nat )
type ValidChecksumSize (ent :: Nat ) (csz :: Nat ) = ( KnownNat csz, NatWithinBound Int csz, Elem csz '[3, 4, 5, 6, 7, 8], CheckSumBits ent ~ csz)
type family MnemonicWords (n :: Nat ) :: Nat where ...
type family EntropySize (n :: Nat ) :: Nat where ...
toEntropy :: forall n csz ba. ( ValidEntropySize n, ValidChecksumSize n csz, ByteArrayAccess ba) => ba -> Either ( EntropyError csz) ( Entropy n)
entropyRaw :: Entropy n -> ByteString
entropyChecksum :: Entropy n -> Checksum ( CheckSumBits n)
entropyToWords :: forall n csz mw. ConsistentEntropy n mw csz => Entropy n -> MnemonicSentence mw
wordsToEntropy :: forall ent csz mw. ConsistentEntropy ent mw csz => MnemonicSentence mw -> Either ( EntropyError csz) ( Entropy ent)
data Seed
type Passphrase = String
sentenceToSeed :: ValidMnemonicSentence mw => MnemonicSentence mw -> Dictionary -> Passphrase -> Seed
phraseToSeed :: ValidMnemonicSentence mw => MnemonicPhrase mw -> Dictionary -> Passphrase -> Seed
data MnemonicSentence (mw :: Nat )
data MnemonicPhrase (mw :: Nat )
type ValidMnemonicSentence (mw :: Nat ) = ( KnownNat mw, NatWithinBound Int mw, Elem mw '[9, 12, 15, 18, 21, 24])
mnemonicPhrase :: forall mw. ValidMnemonicSentence mw => [ String ] -> Either MnemonicWordsError ( MnemonicPhrase mw)
checkMnemonicPhrase :: forall mw. ValidMnemonicSentence mw => Dictionary -> MnemonicPhrase mw -> Bool
mnemonicPhraseToMnemonicSentence :: forall mw. ValidMnemonicSentence mw => Dictionary -> MnemonicPhrase mw -> Either DictionaryError ( MnemonicSentence mw)
mnemonicSentenceToMnemonicPhrase :: forall mw. ValidMnemonicSentence mw => Dictionary -> MnemonicSentence mw -> MnemonicPhrase mw
mnemonicSentenceToString :: forall mw. ValidMnemonicSentence mw => Dictionary -> MnemonicSentence mw -> String
mnemonicSentenceToListN :: MnemonicSentence mw -> ListN mw WordIndex
mnemonicPhraseToString :: forall mw. ValidMnemonicSentence mw => Dictionary -> MnemonicPhrase mw -> String
translateTo :: forall mw. ValidMnemonicSentence mw => Dictionary -> Dictionary -> MnemonicPhrase mw -> Either DictionaryError ( MnemonicPhrase mw)
data Dictionary = Dictionary {
- dictionaryIndexToWord :: WordIndex -> String
- dictionaryWordToIndex :: String -> Either DictionaryError WordIndex
- dictionaryTestWord :: String -> Bool
- dictionaryWordSeparator :: String
}
data WordIndex
wordIndex :: Offset String -> WordIndex
unWordIndex :: WordIndex -> Offset String
type ConsistentEntropy ent mw csz = ( ValidEntropySize ent, ValidChecksumSize ent csz, ValidMnemonicSentence mw, MnemonicWords ent ~ mw)
type family CheckSumBits (n :: Nat ) :: Nat where ...
type family Elem (e :: Nat ) (l :: [ Nat ]) :: Constraint where ...
data DictionaryError = ErrInvalidDictionaryWord String
data EntropyError csz
- = ErrInvalidEntropyLength Int Int
- | ErrInvalidEntropyChecksum ( Checksum csz) ( Checksum csz)
data MnemonicWordsError = ErrWrongNumberOfWords Int Int

Entropy

data Entropy (n :: Nat ) Source #

BIP39's entropy is a byte array of a given size (in bits, see ValidEntropySize for the valid size).

To it is associated

Instances

Instances details

Eq ( Entropy n) Source #
Instance details Defined in Crypto.Encoding.BIP39 Methods (==) :: Entropy n -> Entropy n -> Bool Source # (/=) :: Entropy n -> Entropy n -> Bool Source #
Show ( Entropy n) Source #
Instance details Defined in Crypto.Encoding.BIP39 Methods showsPrec :: Int -> Entropy n -> ShowS Source # show :: Entropy n -> String Source # showList :: [ Entropy n] -> ShowS Source #
NormalForm ( Entropy n) Source #
Instance details Defined in Crypto.Encoding.BIP39 Methods toNormalForm :: Entropy n -> () Source #
Arbitrary ( Entropy 96) Source #
Instance details Defined in Crypto.Encoding.BIP39 Methods arbitrary :: Gen ( Entropy 96) Source #
Arbitrary ( Entropy 128) Source #
Instance details Defined in Crypto.Encoding.BIP39 Methods arbitrary :: Gen ( Entropy 128) Source #
Arbitrary ( Entropy 160) Source #
Instance details Defined in Crypto.Encoding.BIP39 Methods arbitrary :: Gen ( Entropy 160) Source #
Arbitrary ( Entropy 192) Source #
Instance details Defined in Crypto.Encoding.BIP39 Methods arbitrary :: Gen ( Entropy 192) Source #
Arbitrary ( Entropy 224) Source #
Instance details Defined in Crypto.Encoding.BIP39 Methods arbitrary :: Gen ( Entropy 224) Source #
Arbitrary ( Entropy 256) Source #
Instance details Defined in Crypto.Encoding.BIP39 Methods arbitrary :: Gen ( Entropy 256) Source #

type ValidEntropySize (n :: Nat ) = ( KnownNat n, NatWithinBound Int n, Elem n '[96, 128, 160, 192, 224, 256]) Source #

Type Constraint Alias to check a given Nat is valid for an entropy size

i.e. it must be one of the following: 96, 128, 160, 192, 224, 256.

data Checksum (bits :: Nat ) Source #

this is the Checksum of a given Entropy

the Nat type parameter represent the size, in bits, of this checksum.

Instances

Instances details

Eq ( Checksum bits) Source #
Instance details Defined in Crypto.Encoding.BIP39 Methods (==) :: Checksum bits -> Checksum bits -> Bool Source # (/=) :: Checksum bits -> Checksum bits -> Bool Source #
Show ( Checksum bits) Source #
Instance details Defined in Crypto.Encoding.BIP39 Methods showsPrec :: Int -> Checksum bits -> ShowS Source # show :: Checksum bits -> String Source # showList :: [ Checksum bits] -> ShowS Source #
NormalForm ( Checksum bits) Source #
Instance details Defined in Crypto.Encoding.BIP39 Methods toNormalForm :: Checksum bits -> () Source #

type ValidChecksumSize (ent :: Nat ) (csz :: Nat ) = ( KnownNat csz, NatWithinBound Int csz, Elem csz '[3, 4, 5, 6, 7, 8], CheckSumBits ent ~ csz) Source #

type family MnemonicWords (n :: Nat ) :: Nat where ... Source #

Number of Words related to a specific entropy size in bits

Equations

MnemonicWords 96 = 9
MnemonicWords 128 = 12
MnemonicWords 160 = 15
MnemonicWords 192 = 18
MnemonicWords 224 = 21
MnemonicWords 256 = 24

type family EntropySize (n :: Nat ) :: Nat where ... Source #

Corresponding entropy size in bits for a given number of words

Equations

EntropySize 9 = 96
EntropySize 12 = 128
EntropySize 15 = 160
EntropySize 18 = 192
EntropySize 21 = 224
EntropySize 24 = 256

toEntropy :: forall n csz ba. ( ValidEntropySize n, ValidChecksumSize n csz, ByteArrayAccess ba) => ba -> Either ( EntropyError csz) ( Entropy n) Source #

Create a specific entropy type of known size from a raw bytestring

entropyRaw :: Entropy n -> ByteString Source #

Get the raw binary associated with the entropy

entropyChecksum :: Entropy n -> Checksum ( CheckSumBits n) Source #

Get the checksum of the Entropy

entropyToWords :: forall n csz mw. ConsistentEntropy n mw csz => Entropy n -> MnemonicSentence mw Source #

Given an entropy of size n, Create a list

wordsToEntropy :: forall ent csz mw. ConsistentEntropy ent mw csz => MnemonicSentence mw -> Either ( EntropyError csz) ( Entropy ent) Source #

retrieve the initial entropy from a given MnemonicSentence

This function validate the retrieved Entropy is valid, i.e. that the checksum is correct. This means you should not create a new Entropy from a MnemonicSentence , instead, you should use a Random Number Generator to create a new Entropy .

Seed

data Seed Source #

Instances

Instances details

Eq Seed Source #
Instance details Defined in Crypto.Encoding.BIP39 Methods (==) :: Seed -> Seed -> Bool Source # (/=) :: Seed -> Seed -> Bool Source #
Ord Seed Source #
Instance details Defined in Crypto.Encoding.BIP39 Methods compare :: Seed -> Seed -> Ordering Source # (<) :: Seed -> Seed -> Bool Source # (<=) :: Seed -> Seed -> Bool Source # (>) :: Seed -> Seed -> Bool Source # (>=) :: Seed -> Seed -> Bool Source # max :: Seed -> Seed -> Seed Source # min :: Seed -> Seed -> Seed Source #
Show Seed Source #
Instance details Defined in Crypto.Encoding.BIP39 Methods showsPrec :: Int -> Seed -> ShowS Source # show :: Seed -> String Source # showList :: [ Seed ] -> ShowS Source #
IsString Seed Source #
Instance details Defined in Crypto.Encoding.BIP39 Methods fromString :: String -> Seed Source #
Semigroup Seed Source #
Instance details Defined in Crypto.Encoding.BIP39 Methods (<>) :: Seed -> Seed -> Seed Source # sconcat :: NonEmpty Seed -> Seed Source # stimes :: Integral b => b -> Seed -> Seed Source #
Monoid Seed Source #
Instance details Defined in Crypto.Encoding.BIP39 Methods mempty :: Seed Source # mappend :: Seed -> Seed -> Seed Source # mconcat :: [ Seed ] -> Seed Source #
ByteArray Seed Source #
Instance details Defined in Crypto.Encoding.BIP39 Methods allocRet :: Int -> ( Ptr p -> IO a) -> IO (a, Seed ) Source #
ByteArrayAccess Seed Source #
Instance details Defined in Crypto.Encoding.BIP39 Methods length :: Seed -> Int Source # withByteArray :: Seed -> ( Ptr p -> IO a) -> IO a Source # copyByteArrayToPtr :: Seed -> Ptr p -> IO () Source #

type Passphrase = String Source #

sentenceToSeed Source #

Arguments

:: ValidMnemonicSentence mw
=> MnemonicSentence mw	`MmenomicPhrase` of mw words
-> Dictionary	Dictionary' of words/indexes
-> Passphrase	`Passphrase` used to generate
-> Seed

Create a seed from MmemonicSentence and Passphrase using the BIP39 algorithm.

phraseToSeed Source #

Arguments

:: ValidMnemonicSentence mw
=> MnemonicPhrase mw	`MmenomicPhrase` of mw words
-> Dictionary	Dictionary' of words/indexes
-> Passphrase	`Passphrase` used to generate
-> Seed

Create a seed from MmemonicPhrase and Passphrase using the BIP39 algorithm.

Mnemonic Sentence

data MnemonicSentence (mw :: Nat ) Source #

Mnemonic Sentence is a list of WordIndex .

This is the generic representation of a mnemonic phrase that can be used for transalating to a different dictionary (example: English to Japanese).

This is mainly used to convert from/to the Entropy and for cardanoSlSeed

Instances

Instances details

ValidMnemonicSentence mw => IsList ( MnemonicSentence mw) Source #
Instance details Defined in Crypto.Encoding.BIP39 Associated Types type Item ( MnemonicSentence mw) Source # Methods fromList :: [ Item ( MnemonicSentence mw)] -> MnemonicSentence mw Source # fromListN :: Int -> [ Item ( MnemonicSentence mw)] -> MnemonicSentence mw Source # toList :: MnemonicSentence mw -> [ Item ( MnemonicSentence mw)] Source #
Eq ( MnemonicSentence mw) Source #
Instance details Defined in Crypto.Encoding.BIP39 Methods (==) :: MnemonicSentence mw -> MnemonicSentence mw -> Bool Source # (/=) :: MnemonicSentence mw -> MnemonicSentence mw -> Bool Source #
Ord ( MnemonicSentence mw) Source #
Instance details Defined in Crypto.Encoding.BIP39 Methods compare :: MnemonicSentence mw -> MnemonicSentence mw -> Ordering Source # (<) :: MnemonicSentence mw -> MnemonicSentence mw -> Bool Source # (<=) :: MnemonicSentence mw -> MnemonicSentence mw -> Bool Source # (>) :: MnemonicSentence mw -> MnemonicSentence mw -> Bool Source # (>=) :: MnemonicSentence mw -> MnemonicSentence mw -> Bool Source # max :: MnemonicSentence mw -> MnemonicSentence mw -> MnemonicSentence mw Source # min :: MnemonicSentence mw -> MnemonicSentence mw -> MnemonicSentence mw Source #
Show ( MnemonicSentence mw) Source #
Instance details Defined in Crypto.Encoding.BIP39 Methods showsPrec :: Int -> MnemonicSentence mw -> ShowS Source # show :: MnemonicSentence mw -> String Source # showList :: [ MnemonicSentence mw] -> ShowS Source #
NormalForm ( MnemonicSentence mw) Source #
Instance details Defined in Crypto.Encoding.BIP39 Methods toNormalForm :: MnemonicSentence mw -> () Source #
type Item ( MnemonicSentence mw) Source #
Instance details Defined in Crypto.Encoding.BIP39 type Item ( MnemonicSentence mw) = WordIndex

data MnemonicPhrase (mw :: Nat ) Source #

Human readable representation of a MnemonicSentence

Instances

Instances details

ValidMnemonicSentence mw => IsList ( MnemonicPhrase mw) Source #
Instance details Defined in Crypto.Encoding.BIP39 Associated Types type Item ( MnemonicPhrase mw) Source # Methods fromList :: [ Item ( MnemonicPhrase mw)] -> MnemonicPhrase mw Source # fromListN :: Int -> [ Item ( MnemonicPhrase mw)] -> MnemonicPhrase mw Source # toList :: MnemonicPhrase mw -> [ Item ( MnemonicPhrase mw)] Source #
Eq ( MnemonicPhrase mw) Source #
Instance details Defined in Crypto.Encoding.BIP39 Methods (==) :: MnemonicPhrase mw -> MnemonicPhrase mw -> Bool Source # (/=) :: MnemonicPhrase mw -> MnemonicPhrase mw -> Bool Source #
Ord ( MnemonicPhrase mw) Source #
Instance details Defined in Crypto.Encoding.BIP39 Methods compare :: MnemonicPhrase mw -> MnemonicPhrase mw -> Ordering Source # (<) :: MnemonicPhrase mw -> MnemonicPhrase mw -> Bool Source # (<=) :: MnemonicPhrase mw -> MnemonicPhrase mw -> Bool Source # (>) :: MnemonicPhrase mw -> MnemonicPhrase mw -> Bool Source # (>=) :: MnemonicPhrase mw -> MnemonicPhrase mw -> Bool Source # max :: MnemonicPhrase mw -> MnemonicPhrase mw -> MnemonicPhrase mw Source # min :: MnemonicPhrase mw -> MnemonicPhrase mw -> MnemonicPhrase mw Source #
Show ( MnemonicPhrase mw) Source #
Instance details Defined in Crypto.Encoding.BIP39 Methods showsPrec :: Int -> MnemonicPhrase mw -> ShowS Source # show :: MnemonicPhrase mw -> String Source # showList :: [ MnemonicPhrase mw] -> ShowS Source #
NormalForm ( MnemonicPhrase mw) Source #
Instance details Defined in Crypto.Encoding.BIP39 Methods toNormalForm :: MnemonicPhrase mw -> () Source #
type Item ( MnemonicPhrase mw) Source #
Instance details Defined in Crypto.Encoding.BIP39 type Item ( MnemonicPhrase mw) = String

type ValidMnemonicSentence (mw :: Nat ) = ( KnownNat mw, NatWithinBound Int mw, Elem mw '[9, 12, 15, 18, 21, 24]) Source #

Type Constraint to validate the given Nat is valid for the supported MnemonicSentence

mnemonicPhrase :: forall mw. ValidMnemonicSentence mw => [ String ] -> Either MnemonicWordsError ( MnemonicPhrase mw) Source #

checkMnemonicPhrase :: forall mw. ValidMnemonicSentence mw => Dictionary -> MnemonicPhrase mw -> Bool Source #

check a given MnemonicPhrase is valid for the given Dictionary

mnemonicPhraseToMnemonicSentence :: forall mw. ValidMnemonicSentence mw => Dictionary -> MnemonicPhrase mw -> Either DictionaryError ( MnemonicSentence mw) Source #

convert the given MnemonicPhrase to a generic MnemonicSentence with the given Dictionary .

This function assumes the Dictionary and the MnemonicPhrase are compatible (see checkMnemonicPhrase ).

mnemonicSentenceToMnemonicPhrase :: forall mw. ValidMnemonicSentence mw => Dictionary -> MnemonicSentence mw -> MnemonicPhrase mw Source #

convert the given generic MnemonicSentence to a human readable MnemonicPhrase targetting the language of the given Dictionary .

mnemonicSentenceToString :: forall mw. ValidMnemonicSentence mw => Dictionary -> MnemonicSentence mw -> String Source #

mnemonicSentenceToListN :: MnemonicSentence mw -> ListN mw WordIndex Source #

mnemonicPhraseToString :: forall mw. ValidMnemonicSentence mw => Dictionary -> MnemonicPhrase mw -> String Source #

translateTo Source #

Arguments

:: forall mw. ValidMnemonicSentence mw
=> Dictionary	source dictionary
-> Dictionary	destination dictionary
-> MnemonicPhrase mw
-> Either DictionaryError ( MnemonicPhrase mw)

translate the given MnemonicPhrase from one dictionary into another.

This function assumes the source dictionary is compatible with the given MnemonicPhrase (see checkMnemonicPhrase )

Dictionary

data Dictionary Source #

this discribe the property of the Dictionary and will alllow to convert from a mnemonic phrase to MnemonicSentence

This is especially needed to build the BIP39 Seed

Constructors

Dictionary

Fields

dictionaryIndexToWord :: WordIndex -> String

This function will retrieve the mnemonic word associated to the given WordIndex .
dictionaryWordToIndex :: String -> Either DictionaryError WordIndex

This function will retrieve the WordIndex from a given mnemonic word.
dictionaryTestWord :: String -> Bool

test a given word is in the dictionary
dictionaryWordSeparator :: String

joining string (e.g. space for english)

data WordIndex Source #

Index of the mnemonic word in the Dictionary

WordIndex are within range of [0..2047]

Instances

Instances details

Bounded WordIndex Source #
Instance details Defined in Crypto.Encoding.BIP39.Dictionary Methods minBound :: WordIndex Source # maxBound :: WordIndex Source #
Enum WordIndex Source #
Instance details Defined in Crypto.Encoding.BIP39.Dictionary Methods succ :: WordIndex -> WordIndex Source # pred :: WordIndex -> WordIndex Source # toEnum :: Int -> WordIndex Source # fromEnum :: WordIndex -> Int Source # enumFrom :: WordIndex -> [ WordIndex ] Source # enumFromThen :: WordIndex -> WordIndex -> [ WordIndex ] Source # enumFromTo :: WordIndex -> WordIndex -> [ WordIndex ] Source # enumFromThenTo :: WordIndex -> WordIndex -> WordIndex -> [ WordIndex ] Source #
Eq WordIndex Source #
Instance details Defined in Crypto.Encoding.BIP39.Dictionary Methods (==) :: WordIndex -> WordIndex -> Bool Source # (/=) :: WordIndex -> WordIndex -> Bool Source #
Ord WordIndex Source #
Instance details Defined in Crypto.Encoding.BIP39.Dictionary Methods compare :: WordIndex -> WordIndex -> Ordering Source # (<) :: WordIndex -> WordIndex -> Bool Source # (<=) :: WordIndex -> WordIndex -> Bool Source # (>) :: WordIndex -> WordIndex -> Bool Source # (>=) :: WordIndex -> WordIndex -> Bool Source # max :: WordIndex -> WordIndex -> WordIndex Source # min :: WordIndex -> WordIndex -> WordIndex Source #
Show WordIndex Source #
Instance details Defined in Crypto.Encoding.BIP39.Dictionary Methods showsPrec :: Int -> WordIndex -> ShowS Source # show :: WordIndex -> String Source # showList :: [ WordIndex ] -> ShowS Source #
NormalForm WordIndex Source #
Instance details Defined in Crypto.Encoding.BIP39.Dictionary Methods toNormalForm :: WordIndex -> () Source #
TryFrom Int WordIndex Source #
Instance details Defined in Crypto.Encoding.BIP39.Dictionary Methods tryFrom :: Int -> Maybe WordIndex Source #
TryFrom ( Offset String ) WordIndex Source #
Instance details Defined in Crypto.Encoding.BIP39.Dictionary Methods tryFrom :: Offset String -> Maybe WordIndex Source #

wordIndex :: Offset String -> WordIndex Source #

unWordIndex :: WordIndex -> Offset String Source #

helpers

type ConsistentEntropy ent mw csz = ( ValidEntropySize ent, ValidChecksumSize ent csz, ValidMnemonicSentence mw, MnemonicWords ent ~ mw) Source #

Type Constraint Alias to check the entropy size, the number of mnemonic words and the checksum size is consistent. i.e. that the following is true:

| entropysize | checksumsize | entropysize + checksumsize | mnemonicsize | +---------------+--------------+----------------------------+--------------+ | 96 | 3 | 99 | 9 | | 128 | 4 | 132 | 12 | | 160 | 5 | 165 | 15 | | 192 | 6 | 198 | 18 | | 224 | 7 | 231 | 21 | | 256 | 8 | 264 | 24 |

This type constraint alias also perform all the GHC's cumbersome type level literal handling.

type family CheckSumBits (n :: Nat ) :: Nat where ... Source #

Number of bits of checksum related to a specific entropy size in bits

Equations

CheckSumBits 96 = 3
CheckSumBits 128 = 4
CheckSumBits 160 = 5
CheckSumBits 192 = 6
CheckSumBits 224 = 7
CheckSumBits 256 = 8

type family Elem (e :: Nat ) (l :: [ Nat ]) :: Constraint where ... Source #

convenient type level constraint to validate a given Nat e is an elemnt of the list of Nat l.

Equations

Elem e '[] = TypeError ((' Text "offset: field " :<>: ' ShowType e) :<>: ' Text " not elements of valids values")
Elem e (e ': _) = ()
Elem e (_ ': xs) = Elem e xs

Errors

data DictionaryError Source #

Constructors

ErrInvalidDictionaryWord String

Instances

Instances details

Show DictionaryError Source #
Instance details Defined in Crypto.Encoding.BIP39.Dictionary Methods showsPrec :: Int -> DictionaryError -> ShowS Source # show :: DictionaryError -> String Source # showList :: [ DictionaryError ] -> ShowS Source #

data EntropyError csz Source #

Constructors

ErrInvalidEntropyLength Int Int
ErrInvalidEntropyChecksum ( Checksum csz) ( Checksum csz)

Instances

Instances details

Show ( EntropyError csz) Source #
Instance details Defined in Crypto.Encoding.BIP39 Methods showsPrec :: Int -> EntropyError csz -> ShowS Source # show :: EntropyError csz -> String Source # showList :: [ EntropyError csz] -> ShowS Source #

data MnemonicWordsError Source #

Constructors

ErrWrongNumberOfWords Int Int

Instances

Instances details

Show MnemonicWordsError Source #
Instance details Defined in Crypto.Encoding.BIP39 Methods showsPrec :: Int -> MnemonicWordsError -> ShowS Source # show :: MnemonicWordsError -> String Source # showList :: [ MnemonicWordsError ] -> ShowS Source #