mirror of
https://github.com/btcsuite/btcd.git
synced 2024-11-19 09:50:08 +01:00
ba5407615d
The doc formatting changes introduced in the recent go version is increasing the diff for all of the new commits. Formatting it all in this commit will help the readability of future PRs by reducing the diff. |
||
|---|---|---|
| .. | ||
| alphabet.go | ||
| base58_test.go | ||
| base58.go | ||
| base58bench_test.go | ||
| base58check_test.go | ||
| base58check.go | ||
| cov_report.sh | ||
| doc.go | ||
| example_test.go | ||
| genalphabet.go | ||
| README.md | ||
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/btcd/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.