Safe Haskell	Safe-Inferred
Language	Haskell2010

Crypto.Encoding.BIP39.Dictionary

Contents

Dictionary

Synopsis

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
data DictionaryError = ErrInvalidDictionaryWord String

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

wordIndex :: Offset String -> WordIndex Source #

unWordIndex :: WordIndex -> Offset String Source #

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 # show :: DictionaryError -> String # showList :: [DictionaryError] -> ShowS #