# `BitcoinElixir.Base58`
[🔗](https://github.com/cashlet-labs/bitcoin-elixir/blob/v0.1.0/lib/bitcoin_elixir/base58.ex#L1)

Base58 and Base58Check, as used by extended keys and legacy addresses.

# `decode`

```elixir
@spec decode(String.t()) :: {:ok, binary()} | {:error, :not_base58}
```

Decode text.

# `decode_check`

```elixir
@spec decode_check(String.t()) :: {:ok, binary()} | {:error, atom()}
```

Decode and verify the checksum.

# `encode`

```elixir
@spec encode(binary()) :: String.t()
```

Encode bytes.

# `encode_check`

```elixir
@spec encode_check(binary()) :: String.t()
```

Encode with a 4-byte double-SHA-256 checksum.

---

*Consult [api-reference.md](api-reference.md) for complete listing*
