BitcoinLib v0.4.7

View Source BitcoinLib.Key.HD.SeedPhrase.Wordlist (BitcoinLib v0.4.7)

A list of all the words that can be contained in a private key seed phrase

Source: https://raw.githubusercontent.com/bitcoin/bips/master/bip-0039/english.txt

Link to this section Summary

Functions

all()

Get a list of all words in the wordlist

get_indice(word)

Convert a word into an indice from the wordlist

get_indices(words)

Convert a list of words into a list of indices from the wordlist

get_word(index)

Get a single word from the wordlist by index

get_words(indices)

Convert a list of indices into words from the wordlist

Link to this section Functions

Link to this function

all()

View Source 
@spec all() :: [binary()]

Get a list of all words in the wordlist

examples

 Examples 

iex> BitcoinLib.Key.HD.SeedPhrase.Wordlist.all
...> |> Enum.count()
2048
Link to this function

get_indice(word)

View Source 
@spec get_indice(binary()) :: {:found, integer(), binary()} | {:not_found, integer()}

Convert a word into an indice from the wordlist

examples

 Examples 

iex> BitcoinLib.Key.HD.SeedPhrase.Wordlist.get_indice("absurd")
{:found, 8, "absurd"}
Link to this function

get_indices(words)

View Source 
@spec get_indices([binary()]) :: [integer()]

Convert a list of words into a list of indices from the wordlist

examples

 Examples 

iex> ["absurd", "able", "absent"]
...> |> BitcoinLib.Key.HD.SeedPhrase.Wordlist.get_indices()
[8, 2, 5]
Link to this function

get_word(index)

View Source 
@spec get_word(integer()) :: binary()

Get a single word from the wordlist by index

examples

 Examples 

iex> BitcoinLib.Key.HD.SeedPhrase.Wordlist.get_word(8)
"absurd"
Link to this function

get_words(indices)

View Source 
@spec get_words([integer()]) :: [binary()]

Convert a list of indices into words from the wordlist

examples

 Examples 

iex> BitcoinLib.Key.HD.SeedPhrase.Wordlist.get_words([8, 2, 5])
["absurd", "able", "absent"]