kaspad/util/base58/README.md
2020-02-20 17:12:53 +02:00

24 lines
1.1 KiB
Markdown

base58
==========
[![ISC License](http://img.shields.io/badge/license-ISC-blue.svg)](https://choosealicense.com/licenses/isc/)
[![GoDoc](https://img.shields.io/badge/godoc-reference-blue.svg)](http://godoc.org/github.com/kaspanet/kaspad/util/base58)
Package base58 provides an API for encoding and decoding to and from the
modified base58 encoding.
A comprehensive suite of tests is provided to ensure proper functionality.
## Examples
* [Decode Example](http://godoc.org/github.com/kaspanet/kaspad/util/base58#example-Decode)
Demonstrates how to decode modified base58 encoded data.
* [Encode Example](http://godoc.org/github.com/kaspanet/kaspad/util/base58#example-Encode)
Demonstrates how to encode data using the modified base58 encoding scheme.
* [CheckDecode Example](http://godoc.org/github.com/kaspanet/kaspad/util/base58#example-CheckDecode)
Demonstrates how to decode Base58Check encoded data.
* [CheckEncode Example](http://godoc.org/github.com/kaspanet/kaspad/util/base58#example-CheckEncode)
Demonstrates how to encode data using the Base58Check encoding scheme.