Crypto.Encoding.BIP39

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

To it is associated

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.

this is the Checksum of a given Entropy

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

Number of Words related to a specific entropy size in bits

Corresponding entropy size in bits for a given number of words

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

Get the raw binary associated with the entropy

Get the checksum of the Entropy

Given an entropy of size n, Create a list

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.

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

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

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

Human readable representation of a MnemonicSentence

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

check a given MnemonicPhrase is valid for the given Dictionary

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

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

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

translate the given MnemonicPhrase from one dictionary into another.

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

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.

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

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