bip39 v0.1.1 Bip39

#Bitcoin #BIP39 #Mnemonic #Elixir

Link to this section Summary

Functions

Convert entropy to mnemonic.

Get word list.

Convert mnemonic to entropy.

Link to this section Functions

Link to this function

entropy_to_mnemonic(entropy, words)

entropy_to_mnemonic(binary(), [String.t()]) :: [String.t()]

Convert entropy to mnemonic.

Parameter
bit_size(entropy) in [128, 160, 192, 224, 256]
length(words) == 2048
Example
iex> Bip39.entropy_to_mnemonic(<<0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0>>, Bip39.get_words(:english))
["abandon", "abandon", "abandon", "abandon", "abandon", "abandon", "abandon", "abandon", "abandon", "abandon", "abandon", "about"]
Link to this function

get_words(lang)

get_words(atom()) :: [String.t()]

Get word list.

Parameter
lang in [:chinese_simplified, :chinese_traditional, :czech, :english, :french, :italian, :japanese, :korean, :spanish]
Example
iex> Bip39.get_words(:english) |> length()
2048
Link to this function

mnemonic_to_entropy(mnemonic, words)

mnemonic_to_entropy([String.t()], [String.t()]) :: binary()

Convert mnemonic to entropy.

Parameter
length(mnemonic) in [12, 15, 18, 21, 24]
length(words) == 2048
Example
iex> Bip39.mnemonic_to_entropy(["abandon", "abandon", "abandon", "abandon", "abandon", "abandon", "abandon", "abandon", "abandon", "abandon", "abandon", "about"], Bip39.get_words(:english))
<<0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0>>