Returns Wallet Import Format (WIF) generated from any arbitrary text (passphrase).

Disclaimer

Using any low entropy text like any text from a book, poem, song or sentence will result in you losing your coins. In other words, if you don’t know what your doing: Don’t use brainwallets. More info at DEF CON 23 - Ryan Castellucci - Cracking CryptoCurrency Brainwallets

Options

It accepts the same options that the function privkey_to_wif/2:

• compressed - Generate a WIF which signals that a compressed public key should be used if true. Default to true.
• network - Specifies the network this private key intended to be used on. Can be :mainnet or :testnet. Default is :mainnet.

Examples

iex> brainwallet_to_wif("correct horse battery staple")
{:ok, %{
  compressed: true, network: :mainnet,
  privkey_bin: <<196, 187, 203, 31, 190, 201, 157, 101, 191, 89, 216, 92, 140, 182, 46, 226, 219, 150, 63, 15, 225, 6, 244, 131, 217, 175, 167, 59, 212, 227, 154, 138>>,
  privkey_hex: "C4BBCB1FBEC99D65BF59D85C8CB62EE2DB963F0FE106F483D9AFA73BD4E39A8A",
  wif: "L3p8oAcQTtuokSCRHQ7i4MhjWc9zornvpJLfmg62sYpLRJF9woSu"}}

Create Wallet Import Format (WIF) private key from raw private key. A raw private key can be presented by a binary of 32 bytes or in 64 hexadecimal characters (0-9a-fA-F)

It assumes you want the compressed WIF version by default. That way you are signalling that the bitcoin address which should be used when imported into a wallet will be also compressed.

Options

• compressed - Generate a WIF which signals that a compressed public key should be used if true. Default to true.
• network - Specifies the network this private key intended to be used on. Can be :mainnet or :testnet. Default is :mainnet.
• case - Ensures the character case to accept when decoding. Valid values are: :upper, :lower, :mixed. Only useful when the raw private key is passed in hex format. If case is not satisfied will return an error. Default is :mixed

Examples

iex> hexprivkey = "0123456789ABCDEF0123456789ABCDEF0123456789ABCDEF0123456789ABCDEF"
iex> privkey_to_wif(hexprivkey)
{:ok, %{
  wif: "KwFvTne98E1t3mTNAr8pKx67eUzFJWdSNPqPSfxMEtrueW7PcQzL",
  privkey_bin: <<1, 35, 69, 103, 137, 171, 205, 239, 1, 35, 69, 103, 137, 171, 205, 239, 1, 35, 69, 103, 137, 171, 205, 239, 1, 35, 69, 103, 137, 171, 205, 239>>,
  privkey_hex: "0123456789ABCDEF0123456789ABCDEF0123456789ABCDEF0123456789ABCDEF",
  compressed: true,
  network: :mainnet
}}
iex> binprivkey = hexprivkey |> Base.decode16!()
<<1, 35, 69, 103, 137, 171, 205, 239, 1, 35, 69, 103, 137, 171, 205, 239, 1, 35, 69, 103, 137, 171, 205, 239, 1, 35, 69, 103, 137, 171, 205, 239>>
iex> privkey_to_wif(binprivkey)
{:ok, %{
  wif: "KwFvTne98E1t3mTNAr8pKx67eUzFJWdSNPqPSfxMEtrueW7PcQzL",
  privkey_bin: <<1, 35, 69, 103, 137, 171, 205, 239, 1, 35, 69, 103, 137, 171, 205, 239, 1, 35, 69, 103, 137, 171, 205, 239, 1, 35, 69, 103, 137, 171, 205, 239>>,
  privkey_hex: "0123456789ABCDEF0123456789ABCDEF0123456789ABCDEF0123456789ABCDEF",
  compressed: true,
  network: :mainnet
}}
iex> privkey_to_wif(binprivkey, compressed: false, network: :testnet)
{:ok, %{
  wif: "91bRE5Duv5h8kYhhTLhYRXijCiXWSpWwFNX6nndfuntBdPV2idD",
  privkey_bin: <<1, 35, 69, 103, 137, 171, 205, 239, 1, 35, 69, 103, 137, 171, 205, 239, 1, 35, 69, 103, 137, 171, 205, 239, 1, 35, 69, 103, 137, 171, 205, 239>>,
  privkey_hex: "0123456789ABCDEF0123456789ABCDEF0123456789ABCDEF0123456789ABCDEF",
  compressed: false,
  network: :testnet
}}

When binary private key has an unexpected length (not 64 bytes for hex format or 32 bytes for binary format) returns error:

iex> privkey_to_wif(<<1, 35, 69>>)
{:error, :incorrect_privkey_length}

When private key is out of recommended range will return error:

iex> maxprivkey = "FFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFEBAAEDCE6AF48A03BBFD25E8CD0364140" |> Base.decode16!()
iex> privkey_to_wif(maxprivkey)
{:error, :ecc_out_range}

When private key is hexadecimal and have an unexpected case:

iex> privkey_to_wif("0123456789ABCDEF0123456789ABCDEF0123456789ABCDEF0123456789ABCDEF", case: :lower)
{:error, :unexpected_hexadecimal_case}

Generate the address corresponding to the Wallet Import Format (WIP) string where to receive funds.

The result will include the address, the type of the address and if public key used was compressed or not.

Options

Available options are:

• type: Which tells the type of address. Currently the only valid value is only :p2pkh. Default value will be the most modern available, so be sure to specify a type if you don’t want your address to suddenly change.

Examples

iex> wif_to_address("L3p8oAcQTtuokSCRHQ7i4MhjWc9zornvpJLfmg62sYpLRJF9woSu")
{:ok, %{
  address: "1C7zdTfnkzmr13HfA2vNm5SJYRK6nEKyq8",
  compressed: true,
  type: :p2pkh}}
iex> wif_to_address("5KJvsngHeMpm884wtkJNzQGaCErckhHJBGFsvd3VyK5qMZXj3hS", type: :p2pkh)
{:ok, %{
  address: "1JwSSubhmg6iPtRjtyqhUYYH7bZg3Lfy1T",
  compressed: false,
  type: :p2pkh}}
iex> wif_to_address("5KJvsngHeMpm884wtkJNzQGaCErckhHJBGFsvd3VyK5qMZXj3hS", type: :wofff)
{:error, :unknown_address_type}

Returns the raw private key from a Wallet Import Format (WIF) string. Including metadata from WIF telling:

• compressed: If when generating the public key, should use compressed format or uncompressed.
• network: Where the private key should be used. In mainnet, or testnet.

Examples

Converts from a WIF string to raw private key.

iex> wif_to_privkey("KwFvTne98E1t3mTNAr8pKx67eUzFJWdSNPqPSfxMEtrueW7PcQzL")
{:ok, %{
  wif: "KwFvTne98E1t3mTNAr8pKx67eUzFJWdSNPqPSfxMEtrueW7PcQzL",
  privkey_bin: <<1, 35, 69, 103, 137, 171, 205, 239, 1, 35, 69, 103, 137, 171, 205, 239, 1, 35, 69, 103, 137, 171, 205, 239, 1, 35, 69, 103, 137, 171, 205, 239>>,
  privkey_hex: "0123456789ABCDEF0123456789ABCDEF0123456789ABCDEF0123456789ABCDEF",
  compressed: true,
  network: :mainnet
}}

Expected errors:

Error if is base58check is another type other from WIF:

iex> wif_to_privkey("1CLrrRUwXswyF2EVAtuXyqdk4qb8DSUHCX")
{:error, :not_wif_version_prefix}

Error if checksum is not valid:

iex> wif_to_privkey("KyFvTne98E1t3mTNAr8pKx67eUzFJWdSNPqPSfxMEtrueW7PcQzL")
{:error, :checksum_incorrect}

Error if using an unvalid base58 character:

iex> wif_to_privkey("10Ol0Ol0Ol0Ol0Ol0Ol0OOlIIIIIII0OlI")
{:error, :incorrect_base58}

Generate public key from a Wallet Import Format string (WIF).

If succesfull, public key is returned in binary and hexadecimal format in a map.

For any private key, its public key can be presented in compressed or uncompressed format. The compressed format is usually the most used. Which one should be used, can be deducted from the WIF string, so this function finds out which one is requested without any user intervention. Returned result will include if public key was compressed or uncompressed.

Note: If you want to generate a public key directly from the binary private key, instead of a WIF string, you can use the function BtcTool.Pubkey.binprivkey_to_binpubkey/2, documented in the source.

Examples

With a compressed a WIF string (starts with K or L):

iex> wif_to_pubkey("KwFvTne98E1t3mTNAr8pKx67eUzFJWdSNPqPSfxMEtrueW7PcQzL")
{:ok, %{
  pubkey_bin: <<3, 70, 70, 174, 80, 71, 49, 107, 66, 48, 208, 8, 108, 138, 206, 198, 135, 240, 11, 28, 217, 209, 220, 99, 79, 108, 179, 88, 172, 10, 154, 143, 255>>,
  pubkey_hex: "034646AE5047316B4230D0086C8ACEC687F00B1CD9D1DC634F6CB358AC0A9A8FFF",
  compressed: true}
}

With a uncompressed WIF string (starts with 5):

iex> wif_to_pubkey("5HpneLQNKrcznVCQpzodYwAmZ4AoHeyjuRf9iAHAa498rP5kuWb")
{:ok, %{
  pubkey_bin: <<4, 70, 70, 174, 80, 71, 49, 107, 66, 48, 208, 8, 108, 138, 206, 198, 135, 240, 11, 28, 217, 209, 220, 99, 79, 108, 179, 88, 172, 10, 154, 143, 255, 254, 119, 180, 221, 10, 75, 251, 149, 133, 31, 59, 115, 85, 199, 129, 221, 96, 248, 65, 143, 200, 166, 93, 20, 144, 122, 255, 71, 201, 3, 165, 89>>,
  pubkey_hex: "044646AE5047316B4230D0086C8ACEC687F00B1CD9D1DC634F6CB358AC0A9A8FFFFE77B4DD0A4BFB95851F3B7355C781DD60F8418FC8A65D14907AFF47C903A559",
  compressed: false}
}

Will return an error and atom if any error is present. Some examples (among other errors):

iex> wif_to_pubkey("Not_a_WIF")
{:error, :incorrect_base58}
iex> wif_to_pubkey("2dqAyxFfwDYds")
{:error, :unexpected_length}