bitcoinex v0.1.8

View Source Bitcoinex.Base58 (bitcoinex v0.1.8)

Includes Base58 serialization and validation.

Some code is inspired by: https://github.com/comboy/bitcoin-elixir/blob/develop/lib/bitcoin/base58_check.ex

Link to this section Summary

Types

address_type()

Base58 encoding is only supported for p2sh and p2pkh address types.

byte_list()

Functions

append_checksum(body)
decode(binary)

Decodes a Base58 encoded string into a byte array and validates checksum.

decode_base!(binary)

Decodes a Base58 encoded string into a byte array.

encode(bin)

Encodes binary into a Base58 encoded string.

encode_base(binary)

Encodes a binary into a Base58 encoded string.

validate_checksum(data)

Validates a Base58 checksum.

Link to this section Types

Link to this type

address_type()

View Source 
@type address_type() :: :p2sh | :p2pkh

Base58 encoding is only supported for p2sh and p2pkh address types.

Link to this type

byte_list()

View Source 
@type byte_list() :: [byte()]

Link to this section Functions

Link to this function

append_checksum(body)

View Source 
@spec append_checksum(binary()) :: binary()
Link to this function

decode(binary)

View Source 
@spec decode(binary()) :: {:ok, binary()} | {:error, atom()}

Decodes a Base58 encoded string into a byte array and validates checksum.

Link to this function

decode_base!(binary)

View Source 
@spec decode_base!(binary()) :: binary()

Decodes a Base58 encoded string into a byte array.

Link to this function

encode(bin)

View Source 
@spec encode(binary()) :: String.t()

Encodes binary into a Base58 encoded string.

Link to this function

encode_base(binary)

View Source 
@spec encode_base(binary()) :: String.t()

Encodes a binary into a Base58 encoded string.

Link to this function

validate_checksum(data)

View Source 
@spec validate_checksum(binary()) :: {:ok, binary()} | {:error, atom()}

Validates a Base58 checksum.