Safe Haskell	None
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 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 #

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 #