# README
base58
Package base58 provides an API for encoding and decoding to and from the modified base58 encoding. It also provides an API to do Base58Check encoding, as described here.
A comprehensive suite of tests is provided to ensure proper functionality.
Installation and Updating
$ go get -u github.com/btcsuite/btcutil/base58
Examples
- Decode Example
Demonstrates how to decode modified base58 encoded data. - Encode Example
Demonstrates how to encode data using the modified base58 encoding scheme. - CheckDecode Example
Demonstrates how to decode Base58Check encoded data. - CheckEncode Example
Demonstrates how to encode data using the Base58Check encoding scheme.
License
Package base58 is licensed under the copyfree ISC License.
# Functions
CheckDecode decodes a string that was encoded with CheckEncode and verifies the checksum.
CheckEncode prepends a version byte and appends a four byte checksum.
Decode decodes a modified base58 string to a byte slice.
Encode encodes a byte slice to a modified base58 string.
# Variables
ErrChecksum indicates that the checksum of a check-encoded string does not verify against the checksum.
ErrInvalidFormat indicates that the check-encoded string has an invalid format.