Cardano.Crypto.Encoding.Seed

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

To it is associated

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

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.

scramble the given entropy into an entropy slighly larger.

This entropy can then be converted to a mnemonic sentence:

freeze iv mnemonics passphrase = entropyToWords . scramble iv entropy passphrase
  where
    entropy = case wordsToEntropy mnemonics of
        Nothing -> error "mnemonic to entropy failed"
        Just e  -> e

The reverse operation of scramble

This function recovers the original entropy from the given scrambled entropy and the associated password.

recover scrambled passphrase = entropyToWords entropysizeO .
    unscramble entropysizeI entropysizeO entropyScrambled passphrase
  where
    entropyScrambled = case wordsToEntropy entropysizeI scrambled of
        Nothing -> error "mnemonic to entropy failed"
        Just e  -> e

helper function to scramble mnemonics