electrum-mnemonic-0.1.2: easy to remember mnemonic for a high-entropy value

Safe HaskellSafe-Inferred

Data.Mnemonic.Electrum

Synopsis

Documentation

encode :: Integer -> StringSource

Generate a mnemonic for an arbitrary Integer using the Electrum word list.

Note about Electrum compatability: When encoding, Electrum only operates on inputs in chunks of 8 hex digits. This encoder is more flexible, supporting input Integers of any size (although they cannot be negative). However, it will not always yeild the same result as Electrum's encoder. For that, use encodeHex

decode :: String -> Maybe IntegerSource

Decode an electrum mnemonic

type Hex = StringSource

A string that represents a hexadecimal number.

encodeHex :: Hex -> StringSource

Generates a mnemonic for a hexidecimal string using the Electrum word list. Fully compatable with Electrum.